~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-06 22:44:57 UTC
  • mfrom: (6436 +trunk)
  • mto: (6437.3.11 2.5)
  • mto: This revision was merged to the branch mainline in revision 6444.
  • Revision ID: jelmer@samba.org-20120106224457-re0pcy0fz31xob77
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
 
17
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
 
 
769
    @deprecated_method(deprecated_in((2, 4, 0)))
719
770
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
771
        """See Branch.set_revision_history."""
 
772
        self._set_revision_history(rev_history)
 
773
 
 
774
    @needs_write_lock
 
775
    def _set_revision_history(self, rev_history):
 
776
        if len(rev_history) == 0:
 
777
            revid = _mod_revision.NULL_REVISION
 
778
        else:
 
779
            revid = rev_history[-1]
 
780
        if rev_history != self._lefthand_history(revid):
 
781
            raise errors.NotLefthandHistory(rev_history)
 
782
        self.set_last_revision_info(len(rev_history), revid)
 
783
        self._cache_revision_history(rev_history)
 
784
        for hook in Branch.hooks['set_rh']:
 
785
            hook(self, rev_history)
 
786
 
 
787
    @needs_write_lock
 
788
    def set_last_revision_info(self, revno, revision_id):
 
789
        """Set the last revision of this branch.
 
790
 
 
791
        The caller is responsible for checking that the revno is correct
 
792
        for this revision id.
 
793
 
 
794
        It may be possible to set the branch last revision to an id not
 
795
        present in the repository.  However, branches can also be
 
796
        configured to check constraints on history, in which case this may not
 
797
        be permitted.
 
798
        """
 
799
        raise NotImplementedError(self.set_last_revision_info)
 
800
 
 
801
    @needs_write_lock
 
802
    def generate_revision_history(self, revision_id, last_rev=None,
 
803
                                  other_branch=None):
 
804
        """See Branch.generate_revision_history"""
 
805
        graph = self.repository.get_graph()
 
806
        (last_revno, last_revid) = self.last_revision_info()
 
807
        known_revision_ids = [
 
808
            (last_revid, last_revno),
 
809
            (_mod_revision.NULL_REVISION, 0),
 
810
            ]
 
811
        if last_rev is not None:
 
812
            if not graph.is_ancestor(last_rev, revision_id):
 
813
                # our previous tip is not merged into stop_revision
 
814
                raise errors.DivergedBranches(self, other_branch)
 
815
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
816
        self.set_last_revision_info(revno, revision_id)
721
817
 
722
818
    @needs_write_lock
723
819
    def set_parent(self, url):
760
856
                return
761
857
            self._unstack()
762
858
        else:
763
 
            self._activate_fallback_location(url)
 
859
            self._activate_fallback_location(url,
 
860
                possible_transports=[self.bzrdir.root_transport])
764
861
        # write this out after the repository is stacked to avoid setting a
765
862
        # stacked config that doesn't work.
766
863
        self._set_config_location('stacked_on_location', url)
767
864
 
768
865
    def _unstack(self):
769
866
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
867
 
771
868
        Don't call this directly, use set_stacked_on_url(None).
772
869
        """
773
870
        pb = ui.ui_factory.nested_progress_bar()
774
871
        try:
775
 
            pb.update("Unstacking")
 
872
            pb.update(gettext("Unstacking"))
776
873
            # The basic approach here is to fetch the tip of the branch,
777
874
            # including all available ghosts, from the existing stacked
778
875
            # repository into a new repository object without the fallbacks. 
782
879
            old_repository = self.repository
783
880
            if len(old_repository._fallback_repositories) != 1:
784
881
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
882
                    "of %r (fallbacks: %r)" % (old_repository,
 
883
                        old_repository._fallback_repositories))
 
884
            # Open the new repository object.
 
885
            # Repositories don't offer an interface to remove fallback
 
886
            # repositories today; take the conceptually simpler option and just
 
887
            # reopen it.  We reopen it starting from the URL so that we
 
888
            # get a separate connection for RemoteRepositories and can
 
889
            # stream from one of them to the other.  This does mean doing
 
890
            # separate SSH connection setup, but unstacking is not a
 
891
            # common operation so it's tolerable.
 
892
            new_bzrdir = controldir.ControlDir.open(
 
893
                self.bzrdir.root_transport.base)
 
894
            new_repository = new_bzrdir.find_repository()
 
895
            if new_repository._fallback_repositories:
 
896
                raise AssertionError("didn't expect %r to have "
 
897
                    "fallback_repositories"
 
898
                    % (self.repository,))
 
899
            # Replace self.repository with the new repository.
 
900
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
901
            # lock count) of self.repository to the new repository.
 
902
            lock_token = old_repository.lock_write().repository_token
 
903
            self.repository = new_repository
 
904
            if isinstance(self, remote.RemoteBranch):
 
905
                # Remote branches can have a second reference to the old
 
906
                # repository that need to be replaced.
 
907
                if self._real_branch is not None:
 
908
                    self._real_branch.repository = new_repository
 
909
            self.repository.lock_write(token=lock_token)
 
910
            if lock_token is not None:
 
911
                old_repository.leave_lock_in_place()
787
912
            old_repository.unlock()
 
913
            if lock_token is not None:
 
914
                # XXX: self.repository.leave_lock_in_place() before this
 
915
                # function will not be preserved.  Fortunately that doesn't
 
916
                # affect the current default format (2a), and would be a
 
917
                # corner-case anyway.
 
918
                #  - Andrew Bennetts, 2010/06/30
 
919
                self.repository.dont_leave_lock_in_place()
 
920
            old_lock_count = 0
 
921
            while True:
 
922
                try:
 
923
                    old_repository.unlock()
 
924
                except errors.LockNotHeld:
 
925
                    break
 
926
                old_lock_count += 1
 
927
            if old_lock_count == 0:
 
928
                raise AssertionError(
 
929
                    'old_repository should have been locked at least once.')
 
930
            for i in range(old_lock_count-1):
 
931
                self.repository.lock_write()
 
932
            # Fetch from the old repository into the new.
788
933
            old_repository.lock_read()
789
934
            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
935
                # XXX: If you unstack a branch while it has a working tree
809
936
                # with a pending merge, the pending-merged revisions will no
810
937
                # 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)
 
938
                try:
 
939
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
940
                except errors.TagsNotSupported:
 
941
                    tags_to_fetch = set()
 
942
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
 
943
                    old_repository, required_ids=[self.last_revision()],
 
944
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
945
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
946
            finally:
819
947
                old_repository.unlock()
820
948
        finally:
825
953
 
826
954
        :seealso: Branch._get_tags_bytes.
827
955
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
956
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
957
        op.add_cleanup(self.lock_write().unlock)
 
958
        return op.run_simple(bytes)
 
959
 
 
960
    def _set_tags_bytes_locked(self, bytes):
 
961
        self._tags_bytes = bytes
 
962
        return self._transport.put_bytes('tags', bytes)
830
963
 
831
964
    def _cache_revision_history(self, rev_history):
832
965
        """Set the cached revision history to rev_history.
859
992
        self._revision_history_cache = None
860
993
        self._revision_id_to_revno_cache = None
861
994
        self._last_revision_info_cache = None
 
995
        self._master_branch_cache = None
862
996
        self._merge_sorted_revisions_cache = None
863
997
        self._partial_revision_history_cache = []
864
998
        self._partial_revision_id_to_revno_cache = {}
 
999
        self._tags_bytes = None
865
1000
 
866
1001
    def _gen_revision_history(self):
867
1002
        """Return sequence of revision hashes on to this branch.
878
1013
        """
879
1014
        raise NotImplementedError(self._gen_revision_history)
880
1015
 
 
1016
    @deprecated_method(deprecated_in((2, 5, 0)))
881
1017
    @needs_read_lock
882
1018
    def revision_history(self):
883
1019
        """Return sequence of revision ids on this branch.
885
1021
        This method will cache the revision history for as long as it is safe to
886
1022
        do so.
887
1023
        """
 
1024
        return self._revision_history()
 
1025
 
 
1026
    def _revision_history(self):
888
1027
        if 'evil' in debug.debug_flags:
889
1028
            mutter_callsite(3, "revision_history scales with history.")
890
1029
        if self._revision_history_cache is not None:
917
1056
        :return: A tuple (revno, revision_id).
918
1057
        """
919
1058
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1059
            self._last_revision_info_cache = self._read_last_revision_info()
921
1060
        return self._last_revision_info_cache
922
1061
 
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
 
 
 
1062
    def _read_last_revision_info(self):
 
1063
        raise NotImplementedError(self._read_last_revision_info)
 
1064
 
 
1065
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1066
    def import_last_revision_info(self, source_repo, revno, revid):
971
1067
        """Set the last revision info, importing from another repo if necessary.
972
1068
 
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
1069
        :param source_repo: Source repository to optionally fetch from
977
1070
        :param revno: Revision number of the new tip
978
1071
        :param revid: Revision id of the new tip
981
1074
            self.repository.fetch(source_repo, revision_id=revid)
982
1075
        self.set_last_revision_info(revno, revid)
983
1076
 
 
1077
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1078
                                           lossy=False):
 
1079
        """Set the last revision info, importing from another repo if necessary.
 
1080
 
 
1081
        This is used by the bound branch code to upload a revision to
 
1082
        the master branch first before updating the tip of the local branch.
 
1083
        Revisions referenced by source's tags are also transferred.
 
1084
 
 
1085
        :param source: Source branch to optionally fetch from
 
1086
        :param revno: Revision number of the new tip
 
1087
        :param revid: Revision id of the new tip
 
1088
        :param lossy: Whether to discard metadata that can not be
 
1089
            natively represented
 
1090
        :return: Tuple with the new revision number and revision id
 
1091
            (should only be different from the arguments when lossy=True)
 
1092
        """
 
1093
        if not self.repository.has_same_location(source.repository):
 
1094
            self.fetch(source, revid)
 
1095
        self.set_last_revision_info(revno, revid)
 
1096
        return (revno, revid)
 
1097
 
984
1098
    def revision_id_to_revno(self, revision_id):
985
1099
        """Given a revision id, return its revno"""
986
1100
        if _mod_revision.is_null(revision_id):
987
1101
            return 0
988
 
        history = self.revision_history()
 
1102
        history = self._revision_history()
989
1103
        try:
990
1104
            return history.index(revision_id) + 1
991
1105
        except ValueError:
1006
1120
            self._extend_partial_history(distance_from_last)
1007
1121
        return self._partial_revision_history_cache[distance_from_last]
1008
1122
 
1009
 
    @needs_write_lock
1010
1123
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1124
             possible_transports=None, *args, **kwargs):
1012
1125
        """Mirror source into this branch.
1019
1132
            stop_revision=stop_revision,
1020
1133
            possible_transports=possible_transports, *args, **kwargs)
1021
1134
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1135
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1136
            *args, **kwargs):
1024
1137
        """Mirror this branch into target.
1025
1138
 
1026
1139
        This branch is considered to be 'local', having low latency.
1027
1140
        """
1028
1141
        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)
 
1142
            lossy, *args, **kwargs)
1051
1143
 
1052
1144
    def basis_tree(self):
1053
1145
        """Return `Tree` object for last revision."""
1078
1170
    def _set_config_location(self, name, url, config=None,
1079
1171
                             make_relative=False):
1080
1172
        if config is None:
1081
 
            config = self.get_config()
 
1173
            config = self.get_config_stack()
1082
1174
        if url is None:
1083
1175
            url = ''
1084
1176
        elif make_relative:
1085
1177
            url = urlutils.relative_url(self.base, url)
1086
 
        config.set_user_option(name, url, warn_masked=True)
 
1178
        config.set(name, url)
1087
1179
 
1088
1180
    def _get_config_location(self, name, config=None):
1089
1181
        if config is None:
1090
 
            config = self.get_config()
1091
 
        location = config.get_user_option(name)
 
1182
            config = self.get_config_stack()
 
1183
        location = config.get(name)
1092
1184
        if location == '':
1093
1185
            location = None
1094
1186
        return location
1095
1187
 
1096
1188
    def get_child_submit_format(self):
1097
1189
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
 
1190
        return self.get_config_stack().get('child_submit_format')
1099
1191
 
1100
1192
    def get_submit_branch(self):
1101
1193
        """Return the submit location of the branch.
1104
1196
        pattern is that the user can override it by specifying a
1105
1197
        location.
1106
1198
        """
1107
 
        return self.get_config().get_user_option('submit_branch')
 
1199
        return self.get_config_stack().get('submit_branch')
1108
1200
 
1109
1201
    def set_submit_branch(self, location):
1110
1202
        """Return the submit location of the branch.
1113
1205
        pattern is that the user can override it by specifying a
1114
1206
        location.
1115
1207
        """
1116
 
        self.get_config().set_user_option('submit_branch', location,
1117
 
            warn_masked=True)
 
1208
        self.get_config_stack().set('submit_branch', location)
1118
1209
 
1119
1210
    def get_public_branch(self):
1120
1211
        """Return the public location of the branch.
1133
1224
        self._set_config_location('public_branch', location)
1134
1225
 
1135
1226
    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
 
1227
        """Return None or the location to push this branch to."""
 
1228
        return self.get_config_stack().get('push_location')
1139
1229
 
1140
1230
    def set_push_location(self, location):
1141
1231
        """Set a new push location for this branch."""
1208
1298
        return result
1209
1299
 
1210
1300
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1301
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1302
            repository=None):
1212
1303
        """Create a new line of development from the branch, into to_bzrdir.
1213
1304
 
1214
1305
        to_bzrdir controls the branch format.
1219
1310
        if (repository_policy is not None and
1220
1311
            repository_policy.requires_stacking()):
1221
1312
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1313
        result = to_bzrdir.create_branch(repository=repository)
1223
1314
        result.lock_write()
1224
1315
        try:
1225
1316
            if repository_policy is not None:
1226
1317
                repository_policy.configure_branch(result)
1227
1318
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1319
            master_url = self.get_bound_location()
 
1320
            if master_url is None:
 
1321
                result.set_parent(self.bzrdir.root_transport.base)
 
1322
            else:
 
1323
                result.set_parent(master_url)
1229
1324
        finally:
1230
1325
            result.unlock()
1231
1326
        return result
1255
1350
                revno = 1
1256
1351
        destination.set_last_revision_info(revno, revision_id)
1257
1352
 
1258
 
    @needs_read_lock
1259
1353
    def copy_content_into(self, destination, revision_id=None):
1260
1354
        """Copy the content of self into destination.
1261
1355
 
1262
1356
        revision_id: if not None, the revision history in the new branch will
1263
1357
                     be truncated to end with revision_id.
1264
1358
        """
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)
 
1359
        return InterBranch.get(self, destination).copy_content_into(
 
1360
            revision_id=revision_id)
1276
1361
 
1277
1362
    def update_references(self, target):
1278
1363
        if not getattr(self._format, 'supports_reference_locations', False):
1315
1400
        # TODO: We should probably also check that self.revision_history
1316
1401
        # matches the repository for older branch formats.
1317
1402
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
 
1403
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1319
1404
        # specific check.
1320
1405
        return result
1321
1406
 
1322
 
    def _get_checkout_format(self):
 
1407
    def _get_checkout_format(self, lightweight=False):
1323
1408
        """Return the most suitable metadir for a checkout of this branch.
1324
1409
        Weaves are used if this branch's repository uses weaves.
1325
1410
        """
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)
 
1411
        format = self.repository.bzrdir.checkout_metadir()
 
1412
        format.set_branch_format(self._format)
1333
1413
        return format
1334
1414
 
1335
1415
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1416
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1417
        no_tree=None):
1337
1418
        """Create a clone of this branch and its bzrdir.
1338
1419
 
1339
1420
        :param to_transport: The transport to clone onto.
1346
1427
        """
1347
1428
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1429
        # clone call. Or something. 20090224 RBC/spiv.
 
1430
        # XXX: Should this perhaps clone colocated branches as well, 
 
1431
        # rather than just the default branch? 20100319 JRV
1349
1432
        if revision_id is None:
1350
1433
            revision_id = self.last_revision()
1351
1434
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1435
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1436
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1437
            no_tree=no_tree)
1354
1438
        return dir_to.open_branch()
1355
1439
 
1356
1440
    def create_checkout(self, to_location, revision_id=None,
1361
1445
        :param to_location: The url to produce the checkout at
1362
1446
        :param revision_id: The revision to check out
1363
1447
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1448
            produce a bound branch (heavyweight checkout)
1365
1449
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1450
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1451
            The revision tree will be used for cases where accelerator_tree's
1372
1456
        """
1373
1457
        t = transport.get_transport(to_location)
1374
1458
        t.ensure_base()
 
1459
        format = self._get_checkout_format(lightweight=lightweight)
1375
1460
        if lightweight:
1376
 
            format = self._get_checkout_format()
1377
1461
            checkout = format.initialize_on_transport(t)
1378
1462
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
1463
                target_branch=self)
1380
1464
        else:
1381
 
            format = self._get_checkout_format()
1382
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
1465
            checkout_branch = controldir.ControlDir.create_branch_convenience(
1383
1466
                to_location, force_new_tree=False, format=format)
1384
1467
            checkout = checkout_branch.bzrdir
1385
1468
            checkout_branch.bind(self)
1413
1496
 
1414
1497
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1498
        """Return the parent branch for a tree-reference file_id
 
1499
 
1416
1500
        :param file_id: The file_id of the tree reference
1417
1501
        :param path: The path of the file_id in the tree
1418
1502
        :return: A branch associated with the file_id
1471
1555
        else:
1472
1556
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1557
 
1474
 
 
1475
 
class BranchFormat(object):
 
1558
    def heads_to_fetch(self):
 
1559
        """Return the heads that must and that should be fetched to copy this
 
1560
        branch into another repo.
 
1561
 
 
1562
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1563
            set of heads that must be fetched.  if_present_fetch is a set of
 
1564
            heads that must be fetched if present, but no error is necessary if
 
1565
            they are not present.
 
1566
        """
 
1567
        # For bzr native formats must_fetch is just the tip, and
 
1568
        # if_present_fetch are the tags.
 
1569
        must_fetch = set([self.last_revision()])
 
1570
        if_present_fetch = set()
 
1571
        if self.get_config_stack().get('branch.fetch_tags'):
 
1572
            try:
 
1573
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1574
            except errors.TagsNotSupported:
 
1575
                pass
 
1576
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1577
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1578
        return must_fetch, if_present_fetch
 
1579
 
 
1580
 
 
1581
class BranchFormat(controldir.ControlComponentFormat):
1476
1582
    """An encapsulation of the initialization and open routines for a format.
1477
1583
 
1478
1584
    Formats provide three things:
1479
1585
     * An initialization routine,
1480
 
     * a format string,
 
1586
     * a format description
1481
1587
     * an open routine.
1482
1588
 
1483
1589
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1590
    during branch opening. It's not required that these be instances, they
1485
1591
    can be classes themselves with class methods - it simply depends on
1486
1592
    whether state is needed for a given format or not.
1487
1593
 
1490
1596
    object will be created every time regardless.
1491
1597
    """
1492
1598
 
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
1599
    def __eq__(self, other):
1502
1600
        return self.__class__ is other.__class__
1503
1601
 
1505
1603
        return not (self == other)
1506
1604
 
1507
1605
    @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
 
1606
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1607
    def get_default_format(klass):
1521
1608
        """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.
 
1609
        return format_registry.get_default()
 
1610
 
 
1611
    @classmethod
 
1612
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1613
    def get_formats(klass):
 
1614
        """Get all the known formats.
 
1615
 
 
1616
        Warning: This triggers a load of all lazy registered formats: do not
 
1617
        use except when that is desireed.
 
1618
        """
 
1619
        return format_registry._get_all()
 
1620
 
 
1621
    def get_reference(self, controldir, name=None):
 
1622
        """Get the target reference of the branch in controldir.
1526
1623
 
1527
1624
        format probing must have been completed before calling
1528
1625
        this method - it is assumed that the format of the branch
1529
 
        in a_bzrdir is correct.
 
1626
        in controldir is correct.
1530
1627
 
1531
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1628
        :param controldir: The controldir to get the branch data from.
 
1629
        :param name: Name of the colocated branch to fetch
1532
1630
        :return: None if the branch is not a reference branch.
1533
1631
        """
1534
1632
        return None
1535
1633
 
1536
1634
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
1538
 
        """Set the target reference of the branch in a_bzrdir.
 
1635
    def set_reference(self, controldir, name, to_branch):
 
1636
        """Set the target reference of the branch in controldir.
1539
1637
 
1540
1638
        format probing must have been completed before calling
1541
1639
        this method - it is assumed that the format of the branch
1542
 
        in a_bzrdir is correct.
 
1640
        in controldir is correct.
1543
1641
 
1544
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1642
        :param controldir: The controldir to set the branch reference for.
 
1643
        :param name: Name of colocated branch to set, None for default
1545
1644
        :param to_branch: branch that the checkout is to reference
1546
1645
        """
1547
1646
        raise NotImplementedError(self.set_reference)
1548
1647
 
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
1648
    def get_format_description(self):
1554
1649
        """Return the short format description for this format."""
1555
1650
        raise NotImplementedError(self.get_format_description)
1556
1651
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1652
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1558
1653
        hooks = Branch.hooks['post_branch_init']
1559
1654
        if not hooks:
1560
1655
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1656
        params = BranchInitHookParams(self, controldir, name, branch)
1562
1657
        for hook in hooks:
1563
1658
            hook(params)
1564
1659
 
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
 
        
 
1660
    def initialize(self, controldir, name=None, repository=None,
 
1661
                   append_revisions_only=None):
 
1662
        """Create a branch of this format in controldir.
 
1663
 
1613
1664
        :param name: Name of the colocated branch to create.
1614
1665
        """
1615
1666
        raise NotImplementedError(self.initialize)
1635
1686
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
1687
        on a RemoteBranch.
1637
1688
        """
1638
 
        return DisabledTags(branch)
 
1689
        return _mod_tag.DisabledTags(branch)
1639
1690
 
1640
1691
    def network_name(self):
1641
1692
        """A simple byte string uniquely identifying this format for RPC calls.
1647
1698
        """
1648
1699
        raise NotImplementedError(self.network_name)
1649
1700
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1651
 
        """Return the branch object for a_bzrdir
 
1701
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1702
            found_repository=None, possible_transports=None):
 
1703
        """Return the branch object for controldir.
1652
1704
 
1653
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1705
        :param controldir: A ControlDir that contains a branch.
1654
1706
        :param name: Name of colocated branch to open
1655
1707
        :param _found: a private parameter, do not use it. It is used to
1656
1708
            indicate if format probing has already be done.
1660
1712
        raise NotImplementedError(self.open)
1661
1713
 
1662
1714
    @classmethod
 
1715
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1716
    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__)
 
1717
        """Register a metadir format.
 
1718
 
 
1719
        See MetaDirBranchFormatFactory for the ability to register a format
 
1720
        without loading the code the format needs until it is actually used.
 
1721
        """
 
1722
        format_registry.register(format)
1669
1723
 
1670
1724
    @classmethod
 
1725
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1726
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1727
        format_registry.set_default(format)
1673
1728
 
1674
1729
    def supports_set_append_revisions_only(self):
1675
1730
        """True if this format supports set_append_revisions_only."""
1679
1734
        """True if this format records a stacked-on branch."""
1680
1735
        return False
1681
1736
 
 
1737
    def supports_leaving_lock(self):
 
1738
        """True if this format supports leaving locks in place."""
 
1739
        return False # by default
 
1740
 
1682
1741
    @classmethod
 
1742
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1743
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1744
        format_registry.remove(format)
1685
1745
 
1686
1746
    def __str__(self):
1687
1747
        return self.get_format_description().rstrip()
1690
1750
        """True if this format supports tags stored in the branch"""
1691
1751
        return False  # by default
1692
1752
 
 
1753
    def tags_are_versioned(self):
 
1754
        """Whether the tag container for this branch versions tags."""
 
1755
        return False
 
1756
 
 
1757
    def supports_tags_referencing_ghosts(self):
 
1758
        """True if tags can reference ghost revisions."""
 
1759
        return True
 
1760
 
 
1761
 
 
1762
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1763
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1764
    
 
1765
    While none of the built in BranchFormats are lazy registered yet,
 
1766
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1767
    use it, and the bzr-loom plugin uses it as well (see
 
1768
    bzrlib.plugins.loom.formats).
 
1769
    """
 
1770
 
 
1771
    def __init__(self, format_string, module_name, member_name):
 
1772
        """Create a MetaDirBranchFormatFactory.
 
1773
 
 
1774
        :param format_string: The format string the format has.
 
1775
        :param module_name: Module to load the format class from.
 
1776
        :param member_name: Attribute name within the module for the format class.
 
1777
        """
 
1778
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1779
        self._format_string = format_string
 
1780
 
 
1781
    def get_format_string(self):
 
1782
        """See BranchFormat.get_format_string."""
 
1783
        return self._format_string
 
1784
 
 
1785
    def __call__(self):
 
1786
        """Used for network_format_registry support."""
 
1787
        return self.get_obj()()
 
1788
 
1693
1789
 
1694
1790
class BranchHooks(Hooks):
1695
1791
    """A dictionary mapping hook name to a list of callables for branch hooks.
1704
1800
        These are all empty initially, because by default nothing should get
1705
1801
        notified.
1706
1802
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1803
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1804
        self.add_hook('set_rh',
1709
1805
            "Invoked whenever the revision history has been set via "
1710
1806
            "set_revision_history. The api signature is (branch, "
1711
1807
            "revision_history), and the branch will be write-locked. "
1712
1808
            "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',
 
1809
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1810
        self.add_hook('open',
1715
1811
            "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',
 
1812
            "branch is opened.", (1, 8))
 
1813
        self.add_hook('post_push',
1718
1814
            "Called after a push operation completes. post_push is called "
1719
1815
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1816
            "bzr client.", (0, 15))
 
1817
        self.add_hook('post_pull',
1722
1818
            "Called after a pull operation completes. post_pull is called "
1723
1819
            "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 "
 
1820
            "bzr client.", (0, 15))
 
1821
        self.add_hook('pre_commit',
 
1822
            "Called after a commit is calculated but before it is "
1727
1823
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1824
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1825
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1827
            "basis revision. hooks MUST NOT modify this delta. "
1732
1828
            " future_tree is an in-memory tree obtained from "
1733
1829
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1830
            "tree.", (0,91))
 
1831
        self.add_hook('post_commit',
1736
1832
            "Called in the bzr client after a commit has completed. "
1737
1833
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1834
            "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',
 
1835
            "commit to a branch.", (0, 15))
 
1836
        self.add_hook('post_uncommit',
1741
1837
            "Called in the bzr client after an uncommit completes. "
1742
1838
            "post_uncommit is called with (local, master, old_revno, "
1743
1839
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1840
            "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',
 
1841
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1842
        self.add_hook('pre_change_branch_tip',
1747
1843
            "Called in bzr client and server before a change to the tip of a "
1748
1844
            "branch is made. pre_change_branch_tip is called with a "
1749
1845
            "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',
 
1846
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1847
        self.add_hook('post_change_branch_tip',
1752
1848
            "Called in bzr client and server after a change to the tip of a "
1753
1849
            "branch is made. post_change_branch_tip is called with a "
1754
1850
            "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',
 
1851
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1852
        self.add_hook('transform_fallback_location',
1757
1853
            "Called when a stacked branch is activating its fallback "
1758
1854
            "locations. transform_fallback_location is called with (branch, "
1759
1855
            "url), and should return a new url. Returning the same url "
1764
1860
            "fallback locations have not been activated. When there are "
1765
1861
            "multiple hooks installed for transform_fallback_location, "
1766
1862
            "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."
 
1863
            "The order is however undefined.", (1, 9))
 
1864
        self.add_hook('automatic_tag_name',
 
1865
            "Called to determine an automatic tag name for a revision. "
1770
1866
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1867
            "should return a tag name or None if no tag name could be "
1772
1868
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1869
            (2, 2))
 
1870
        self.add_hook('post_branch_init',
1775
1871
            "Called after new branch initialization completes. "
1776
1872
            "post_branch_init is called with a "
1777
1873
            "bzrlib.branch.BranchInitHookParams. "
1778
1874
            "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',
 
1875
            "lightweight) will all trigger this hook.", (2, 2))
 
1876
        self.add_hook('post_switch',
1781
1877
            "Called after a checkout switches branch. "
1782
1878
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1879
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1880
 
1785
1881
 
1786
1882
 
1789
1885
 
1790
1886
 
1791
1887
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1888
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1889
 
1794
1890
    There are 5 fields that hooks may wish to access:
1795
1891
 
1827
1923
 
1828
1924
 
1829
1925
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1926
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1927
 
1832
1928
    There are 4 fields that hooks may wish to access:
1833
1929
 
1834
1930
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1931
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1836
1932
    :ivar name: name of colocated branch, if any (or None)
1837
1933
    :ivar branch: the branch created
1838
1934
 
1841
1937
    branch, which refer to the original branch.
1842
1938
    """
1843
1939
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1940
    def __init__(self, format, controldir, name, branch):
1845
1941
        """Create a group of BranchInitHook parameters.
1846
1942
 
1847
1943
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1944
        :param controldir: the ControlDir where the branch will be/has been
1849
1945
            initialized
1850
1946
        :param name: name of colocated branch, if any (or None)
1851
1947
        :param branch: the branch created
1855
1951
        in branch, which refer to the original branch.
1856
1952
        """
1857
1953
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
 
1954
        self.bzrdir = controldir
1859
1955
        self.name = name
1860
1956
        self.branch = branch
1861
1957
 
1863
1959
        return self.__dict__ == other.__dict__
1864
1960
 
1865
1961
    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)
 
1962
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1963
 
1873
1964
 
1874
1965
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1966
    """Object holding parameters passed to `*_switch` hooks.
1876
1967
 
1877
1968
    There are 4 fields that hooks may wish to access:
1878
1969
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
 
1970
    :ivar control_dir: ControlDir of the checkout to change
1880
1971
    :ivar to_branch: branch that the checkout is to reference
1881
1972
    :ivar force: skip the check for local commits in a heavy checkout
1882
1973
    :ivar revision_id: revision ID to switch to (or None)
1885
1976
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
1977
        """Create a group of SwitchHook parameters.
1887
1978
 
1888
 
        :param control_dir: BzrDir of the checkout to change
 
1979
        :param control_dir: ControlDir of the checkout to change
1889
1980
        :param to_branch: branch that the checkout is to reference
1890
1981
        :param force: skip the check for local commits in a heavy checkout
1891
1982
        :param revision_id: revision ID to switch to (or None)
1904
1995
            self.revision_id)
1905
1996
 
1906
1997
 
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 ]
 
1998
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
 
1999
    """Base class for branch formats that live in meta directories.
1913
2000
    """
1914
2001
 
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
2002
    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."""
 
2003
        BranchFormat.__init__(self)
 
2004
        bzrdir.BzrFormat.__init__(self)
 
2005
 
 
2006
    @classmethod
 
2007
    def find_format(klass, controldir, name=None):
 
2008
        """Return the format for the branch object in controldir."""
 
2009
        try:
 
2010
            transport = controldir.get_branch_transport(None, name=name)
 
2011
        except errors.NoSuchFile:
 
2012
            raise errors.NotBranchError(path=name, bzrdir=controldir)
 
2013
        try:
 
2014
            format_string = transport.get_bytes("format")
 
2015
        except errors.NoSuchFile:
 
2016
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
 
2017
        return klass._find_format(format_registry, 'branch', format_string)
1952
2018
 
1953
2019
    def _branch_class(self):
1954
2020
        """What class to instantiate on open calls."""
1955
2021
        raise NotImplementedError(self._branch_class)
1956
2022
 
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.
 
2023
    def _get_initial_config(self, append_revisions_only=None):
 
2024
        if append_revisions_only:
 
2025
            return "append_revisions_only = True\n"
 
2026
        else:
 
2027
            # Avoid writing anything if append_revisions_only is disabled,
 
2028
            # as that is the default.
 
2029
            return ""
 
2030
 
 
2031
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2032
                           repository=None):
 
2033
        """Initialize a branch in a bzrdir, with specified files
 
2034
 
 
2035
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2036
        :param utf8_files: The files to create as a list of
 
2037
            (filename, content) tuples
 
2038
        :param name: Name of colocated branch to create, if any
 
2039
        :return: a branch in this format
1961
2040
        """
1962
 
        return self.get_format_string()
 
2041
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2042
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2043
        control_files = lockable_files.LockableFiles(branch_transport,
 
2044
            'lock', lockdir.LockDir)
 
2045
        control_files.create_lock()
 
2046
        control_files.lock_write()
 
2047
        try:
 
2048
            utf8_files += [('format', self.as_string())]
 
2049
            for (filename, content) in utf8_files:
 
2050
                branch_transport.put_bytes(
 
2051
                    filename, content,
 
2052
                    mode=a_bzrdir._get_file_mode())
 
2053
        finally:
 
2054
            control_files.unlock()
 
2055
        branch = self.open(a_bzrdir, name, _found=True,
 
2056
                found_repository=repository)
 
2057
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2058
        return branch
1963
2059
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2060
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2061
            found_repository=None, possible_transports=None):
1965
2062
        """See BranchFormat.open()."""
1966
2063
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2064
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
1968
2065
            if format.__class__ != self.__class__:
1969
2066
                raise AssertionError("wrong format %r found for %r" %
1970
2067
                    (format, self))
1972
2069
        try:
1973
2070
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2071
                                                         lockdir.LockDir)
 
2072
            if found_repository is None:
 
2073
                found_repository = a_bzrdir.find_repository()
1975
2074
            return self._branch_class()(_format=self,
1976
2075
                              _control_files=control_files,
1977
2076
                              name=name,
1978
2077
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
1980
 
                              ignore_fallbacks=ignore_fallbacks)
 
2078
                              _repository=found_repository,
 
2079
                              ignore_fallbacks=ignore_fallbacks,
 
2080
                              possible_transports=possible_transports)
1981
2081
        except errors.NoSuchFile:
1982
2082
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1983
2083
 
1984
 
    def __init__(self):
1985
 
        super(BranchFormatMetadir, self).__init__()
1986
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
1987
 
        self._matchingbzrdir.set_branch_format(self)
 
2084
    @property
 
2085
    def _matchingbzrdir(self):
 
2086
        ret = bzrdir.BzrDirMetaFormat1()
 
2087
        ret.set_branch_format(self)
 
2088
        return ret
1988
2089
 
1989
2090
    def supports_tags(self):
1990
2091
        return True
1991
2092
 
 
2093
    def supports_leaving_lock(self):
 
2094
        return True
 
2095
 
 
2096
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
 
2097
            basedir=None):
 
2098
        BranchFormat.check_support_status(self,
 
2099
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
 
2100
            basedir=basedir)
 
2101
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
 
2102
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
2103
 
1992
2104
 
1993
2105
class BzrBranchFormat5(BranchFormatMetadir):
1994
2106
    """Bzr branch format 5.
2006
2118
    def _branch_class(self):
2007
2119
        return BzrBranch5
2008
2120
 
2009
 
    def get_format_string(self):
 
2121
    @classmethod
 
2122
    def get_format_string(cls):
2010
2123
        """See BranchFormat.get_format_string()."""
2011
2124
        return "Bazaar-NG branch format 5\n"
2012
2125
 
2014
2127
        """See BranchFormat.get_format_description()."""
2015
2128
        return "Branch format 5"
2016
2129
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2130
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2131
                   append_revisions_only=None):
2018
2132
        """Create a branch of this format in a_bzrdir."""
 
2133
        if append_revisions_only:
 
2134
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2019
2135
        utf8_files = [('revision-history', ''),
2020
2136
                      ('branch-name', ''),
2021
2137
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2138
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2139
 
2024
2140
    def supports_tags(self):
2025
2141
        return False
2039
2155
    def _branch_class(self):
2040
2156
        return BzrBranch6
2041
2157
 
2042
 
    def get_format_string(self):
 
2158
    @classmethod
 
2159
    def get_format_string(cls):
2043
2160
        """See BranchFormat.get_format_string()."""
2044
2161
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2045
2162
 
2047
2164
        """See BranchFormat.get_format_description()."""
2048
2165
        return "Branch format 6"
2049
2166
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2167
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2168
                   append_revisions_only=None):
2051
2169
        """Create a branch of this format in a_bzrdir."""
2052
2170
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
 
2171
                      ('branch.conf',
 
2172
                          self._get_initial_config(append_revisions_only)),
2054
2173
                      ('tags', ''),
2055
2174
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2175
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2176
 
2058
2177
    def make_tags(self, branch):
2059
2178
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
 
2179
        return _mod_tag.BasicTags(branch)
2061
2180
 
2062
2181
    def supports_set_append_revisions_only(self):
2063
2182
        return True
2069
2188
    def _branch_class(self):
2070
2189
        return BzrBranch8
2071
2190
 
2072
 
    def get_format_string(self):
 
2191
    @classmethod
 
2192
    def get_format_string(cls):
2073
2193
        """See BranchFormat.get_format_string()."""
2074
2194
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
2195
 
2077
2197
        """See BranchFormat.get_format_description()."""
2078
2198
        return "Branch format 8"
2079
2199
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2200
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2201
                   append_revisions_only=None):
2081
2202
        """Create a branch of this format in a_bzrdir."""
2082
2203
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
 
2204
                      ('branch.conf',
 
2205
                          self._get_initial_config(append_revisions_only)),
2084
2206
                      ('tags', ''),
2085
2207
                      ('references', '')
2086
2208
                      ]
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()
 
2209
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2210
 
2094
2211
    def make_tags(self, branch):
2095
2212
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
 
2213
        return _mod_tag.BasicTags(branch)
2097
2214
 
2098
2215
    def supports_set_append_revisions_only(self):
2099
2216
        return True
2104
2221
    supports_reference_locations = True
2105
2222
 
2106
2223
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2224
class BzrBranchFormat7(BranchFormatMetadir):
2108
2225
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2226
 
2110
2227
    The stacked location pointer is passed down to the repository and requires
2113
2230
    This format was introduced in bzr 1.6.
2114
2231
    """
2115
2232
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2233
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2234
                   append_revisions_only=None):
2117
2235
        """Create a branch of this format in a_bzrdir."""
2118
2236
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
 
2237
                      ('branch.conf',
 
2238
                          self._get_initial_config(append_revisions_only)),
2120
2239
                      ('tags', ''),
2121
2240
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2241
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2242
 
2124
2243
    def _branch_class(self):
2125
2244
        return BzrBranch7
2126
2245
 
2127
 
    def get_format_string(self):
 
2246
    @classmethod
 
2247
    def get_format_string(cls):
2128
2248
        """See BranchFormat.get_format_string()."""
2129
2249
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2130
2250
 
2135
2255
    def supports_set_append_revisions_only(self):
2136
2256
        return True
2137
2257
 
 
2258
    def supports_stacking(self):
 
2259
        return True
 
2260
 
 
2261
    def make_tags(self, branch):
 
2262
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2263
        return _mod_tag.BasicTags(branch)
 
2264
 
2138
2265
    supports_reference_locations = False
2139
2266
 
2140
2267
 
2141
 
class BranchReferenceFormat(BranchFormat):
 
2268
class BranchReferenceFormat(BranchFormatMetadir):
2142
2269
    """Bzr branch reference format.
2143
2270
 
2144
2271
    Branch references are used in implementing checkouts, they
2149
2276
     - a format string
2150
2277
    """
2151
2278
 
2152
 
    def get_format_string(self):
 
2279
    @classmethod
 
2280
    def get_format_string(cls):
2153
2281
        """See BranchFormat.get_format_string()."""
2154
2282
        return "Bazaar-NG Branch Reference Format 1\n"
2155
2283
 
2157
2285
        """See BranchFormat.get_format_description()."""
2158
2286
        return "Checkout reference format 1"
2159
2287
 
2160
 
    def get_reference(self, a_bzrdir):
 
2288
    def get_reference(self, a_bzrdir, name=None):
2161
2289
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2290
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2291
        return transport.get_bytes('location')
2164
2292
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2293
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2294
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2295
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2296
        location = transport.put_bytes('location', to_branch.base)
2169
2297
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2298
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2299
            repository=None, append_revisions_only=None):
2171
2300
        """Create a branch of this format in a_bzrdir."""
2172
2301
        if target_branch is None:
2173
2302
            # this format does not implement branch itself, thus the implicit
2174
2303
            # creation contract must see it as uninitializable
2175
2304
            raise errors.UninitializableFormat(self)
2176
2305
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2306
        if a_bzrdir._format.fixed_components:
 
2307
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2177
2308
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2309
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
2180
 
        branch_transport.put_bytes('format', self.get_format_string())
 
2310
            target_branch.user_url)
 
2311
        branch_transport.put_bytes('format', self.as_string())
2181
2312
        branch = self.open(
2182
2313
            a_bzrdir, name, _found=True,
2183
2314
            possible_transports=[target_branch.bzrdir.root_transport])
2184
2315
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
2316
        return branch
2186
2317
 
2187
 
    def __init__(self):
2188
 
        super(BranchReferenceFormat, self).__init__()
2189
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2190
 
        self._matchingbzrdir.set_branch_format(self)
2191
 
 
2192
2318
    def _make_reference_clone_function(format, a_branch):
2193
2319
        """Create a clone() routine for a branch dynamically."""
2194
2320
        def clone(to_bzrdir, revision_id=None,
2201
2327
        return clone
2202
2328
 
2203
2329
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2330
             possible_transports=None, ignore_fallbacks=False,
 
2331
             found_repository=None):
2205
2332
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2333
 
2207
2334
        :param a_bzrdir: A BzrDir that contains a branch.
2216
2343
        :param possible_transports: An optional reusable transports list.
2217
2344
        """
2218
2345
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2346
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
2220
2347
            if format.__class__ != self.__class__:
2221
2348
                raise AssertionError("wrong format %r found for %r" %
2222
2349
                    (format, self))
2223
2350
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
2225
 
        real_bzrdir = bzrdir.BzrDir.open(
 
2351
            location = self.get_reference(a_bzrdir, name)
 
2352
        real_bzrdir = controldir.ControlDir.open(
2226
2353
            location, possible_transports=possible_transports)
2227
2354
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
2355
            ignore_fallbacks=ignore_fallbacks,
 
2356
            possible_transports=possible_transports)
2229
2357
        # this changes the behaviour of result.clone to create a new reference
2230
2358
        # rather than a copy of the content of the branch.
2231
2359
        # I did not use a proxy object because that needs much more extensive
2238
2366
        return result
2239
2367
 
2240
2368
 
 
2369
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2370
    """Branch format registry."""
 
2371
 
 
2372
    def __init__(self, other_registry=None):
 
2373
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2374
        self._default_format = None
 
2375
 
 
2376
    def set_default(self, format):
 
2377
        self._default_format = format
 
2378
 
 
2379
    def get_default(self):
 
2380
        return self._default_format
 
2381
 
 
2382
 
2241
2383
network_format_registry = registry.FormatRegistry()
2242
2384
"""Registry of formats indexed by their network name.
2243
2385
 
2246
2388
BranchFormat.network_name() for more detail.
2247
2389
"""
2248
2390
 
 
2391
format_registry = BranchFormatRegistry(network_format_registry)
 
2392
 
2249
2393
 
2250
2394
# formats which have no format string are not discoverable
2251
2395
# and not independently creatable, so are not registered.
2253
2397
__format6 = BzrBranchFormat6()
2254
2398
__format7 = BzrBranchFormat7()
2255
2399
__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__)
 
2400
format_registry.register(__format5)
 
2401
format_registry.register(BranchReferenceFormat())
 
2402
format_registry.register(__format6)
 
2403
format_registry.register(__format7)
 
2404
format_registry.register(__format8)
 
2405
format_registry.set_default(__format7)
 
2406
 
 
2407
 
 
2408
class BranchWriteLockResult(LogicalLockResult):
 
2409
    """The result of write locking a branch.
 
2410
 
 
2411
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2412
        None.
 
2413
    :ivar unlock: A callable which will unlock the lock.
 
2414
    """
 
2415
 
 
2416
    def __init__(self, unlock, branch_token):
 
2417
        LogicalLockResult.__init__(self, unlock)
 
2418
        self.branch_token = branch_token
 
2419
 
 
2420
    def __repr__(self):
 
2421
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2422
            self.unlock)
2266
2423
 
2267
2424
 
2268
2425
class BzrBranch(Branch, _RelockDebugMixin):
2283
2440
 
2284
2441
    def __init__(self, _format=None,
2285
2442
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
2443
                 _repository=None, ignore_fallbacks=False,
 
2444
                 possible_transports=None):
2287
2445
        """Create new branch object at a particular location."""
2288
2446
        if a_bzrdir is None:
2289
2447
            raise ValueError('a_bzrdir must be supplied')
2290
2448
        else:
2291
2449
            self.bzrdir = a_bzrdir
2292
 
        self._base = self.bzrdir.transport.clone('..').base
 
2450
        self._user_transport = self.bzrdir.transport.clone('..')
 
2451
        if name is not None:
 
2452
            self._user_transport.set_segment_parameter(
 
2453
                "branch", urlutils.escape(name))
 
2454
        self._base = self._user_transport.base
2293
2455
        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
2456
        self._format = _format
2298
2457
        if _control_files is None:
2299
2458
            raise ValueError('BzrBranch _control_files is None')
2300
2459
        self.control_files = _control_files
2301
2460
        self._transport = _control_files._transport
2302
2461
        self.repository = _repository
2303
 
        Branch.__init__(self)
 
2462
        Branch.__init__(self, possible_transports)
2304
2463
 
2305
2464
    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)
 
2465
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
2311
2466
 
2312
2467
    __repr__ = __str__
2313
2468
 
2317
2472
 
2318
2473
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
2474
 
 
2475
    @property
 
2476
    def user_transport(self):
 
2477
        return self._user_transport
 
2478
 
2320
2479
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
 
2480
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2481
 
 
2482
    def _get_config_store(self):
 
2483
        return _mod_config.BranchStore(self)
2322
2484
 
2323
2485
    def is_locked(self):
2324
2486
        return self.control_files.is_locked()
2325
2487
 
2326
2488
    def lock_write(self, token=None):
 
2489
        """Lock the branch for write operations.
 
2490
 
 
2491
        :param token: A token to permit reacquiring a previously held and
 
2492
            preserved lock.
 
2493
        :return: A BranchWriteLockResult.
 
2494
        """
2327
2495
        if not self.is_locked():
2328
2496
            self._note_lock('w')
2329
2497
        # All-in-one needs to always unlock/lock.
2335
2503
        else:
2336
2504
            took_lock = False
2337
2505
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2506
            return BranchWriteLockResult(self.unlock,
 
2507
                self.control_files.lock_write(token=token))
2339
2508
        except:
2340
2509
            if took_lock:
2341
2510
                self.repository.unlock()
2342
2511
            raise
2343
2512
 
2344
2513
    def lock_read(self):
 
2514
        """Lock the branch for read operations.
 
2515
 
 
2516
        :return: A bzrlib.lock.LogicalLockResult.
 
2517
        """
2345
2518
        if not self.is_locked():
2346
2519
            self._note_lock('r')
2347
2520
        # All-in-one needs to always unlock/lock.
2354
2527
            took_lock = False
2355
2528
        try:
2356
2529
            self.control_files.lock_read()
 
2530
            return LogicalLockResult(self.unlock)
2357
2531
        except:
2358
2532
            if took_lock:
2359
2533
                self.repository.unlock()
2387
2561
        """See Branch.print_file."""
2388
2562
        return self.repository.print_file(file, revision_id)
2389
2563
 
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
2564
    @needs_write_lock
2454
2565
    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
 
        """
 
2566
        if not revision_id or not isinstance(revision_id, basestring):
 
2567
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2568
        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))
 
2569
        old_revno, old_revid = self.last_revision_info()
 
2570
        if self.get_append_revisions_only():
 
2571
            self._check_history_violation(revision_id)
 
2572
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2573
        self._write_last_revision_info(revno, revision_id)
 
2574
        self._clear_cached_state()
 
2575
        self._last_revision_info_cache = revno, revision_id
 
2576
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2577
 
2495
2578
    def basis_tree(self):
2496
2579
        """See Branch.basis_tree."""
2505
2588
                pass
2506
2589
        return None
2507
2590
 
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
2591
    def get_stacked_on_url(self):
2531
2592
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2593
 
2543
2604
            self._transport.put_bytes('parent', url + '\n',
2544
2605
                mode=self.bzrdir._get_file_mode())
2545
2606
 
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
2607
    @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
 
2608
    def unbind(self):
 
2609
        """If bound, unbind"""
 
2610
        return self.set_bound_location(None)
2595
2611
 
2596
2612
    @needs_write_lock
2597
2613
    def bind(self, other):
2619
2635
        # history around
2620
2636
        self.set_bound_location(other.base)
2621
2637
 
 
2638
    def get_bound_location(self):
 
2639
        try:
 
2640
            return self._transport.get_bytes('bound')[:-1]
 
2641
        except errors.NoSuchFile:
 
2642
            return None
 
2643
 
 
2644
    @needs_read_lock
 
2645
    def get_master_branch(self, possible_transports=None):
 
2646
        """Return the branch we are bound to.
 
2647
 
 
2648
        :return: Either a Branch, or None
 
2649
        """
 
2650
        if self._master_branch_cache is None:
 
2651
            self._master_branch_cache = self._get_master_branch(
 
2652
                possible_transports)
 
2653
        return self._master_branch_cache
 
2654
 
 
2655
    def _get_master_branch(self, possible_transports):
 
2656
        bound_loc = self.get_bound_location()
 
2657
        if not bound_loc:
 
2658
            return None
 
2659
        try:
 
2660
            return Branch.open(bound_loc,
 
2661
                               possible_transports=possible_transports)
 
2662
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2663
            raise errors.BoundBranchConnectionFailure(
 
2664
                    self, bound_loc, e)
 
2665
 
2622
2666
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2667
    def set_bound_location(self, location):
 
2668
        """Set the target where this branch is bound to.
 
2669
 
 
2670
        :param location: URL to the target branch
 
2671
        """
 
2672
        self._master_branch_cache = None
 
2673
        if location:
 
2674
            self._transport.put_bytes('bound', location+'\n',
 
2675
                mode=self.bzrdir._get_file_mode())
 
2676
        else:
 
2677
            try:
 
2678
                self._transport.delete('bound')
 
2679
            except errors.NoSuchFile:
 
2680
                return False
 
2681
            return True
2626
2682
 
2627
2683
    @needs_write_lock
2628
2684
    def update(self, possible_transports=None):
2641
2697
            return old_tip
2642
2698
        return None
2643
2699
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2700
    def _read_last_revision_info(self):
 
2701
        revision_string = self._transport.get_bytes('last-revision')
 
2702
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2703
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2704
        revno = int(revno)
 
2705
        return revno, revision_id
 
2706
 
 
2707
    def _write_last_revision_info(self, revno, revision_id):
 
2708
        """Simply write out the revision id, with no checks.
 
2709
 
 
2710
        Use set_last_revision_info to perform this safely.
 
2711
 
 
2712
        Does not update the revision_history cache.
 
2713
        """
 
2714
        revision_id = _mod_revision.ensure_null(revision_id)
 
2715
        out_string = '%d %s\n' % (revno, revision_id)
 
2716
        self._transport.put_bytes('last-revision', out_string,
 
2717
            mode=self.bzrdir._get_file_mode())
 
2718
 
 
2719
    @needs_write_lock
 
2720
    def update_feature_flags(self, updated_flags):
 
2721
        """Update the feature flags for this branch.
 
2722
 
 
2723
        :param updated_flags: Dictionary mapping feature names to necessities
 
2724
            A necessity can be None to indicate the feature should be removed
 
2725
        """
 
2726
        self._format._update_feature_flags(updated_flags)
 
2727
        self.control_transport.put_bytes('format', self._format.as_string())
 
2728
 
 
2729
 
 
2730
class FullHistoryBzrBranch(BzrBranch):
 
2731
    """Bzr branch which contains the full revision history."""
 
2732
 
 
2733
    @needs_write_lock
 
2734
    def set_last_revision_info(self, revno, revision_id):
 
2735
        if not revision_id or not isinstance(revision_id, basestring):
 
2736
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2737
        revision_id = _mod_revision.ensure_null(revision_id)
 
2738
        # this old format stores the full history, but this api doesn't
 
2739
        # provide it, so we must generate, and might as well check it's
 
2740
        # correct
 
2741
        history = self._lefthand_history(revision_id)
 
2742
        if len(history) != revno:
 
2743
            raise AssertionError('%d != %d' % (len(history), revno))
 
2744
        self._set_revision_history(history)
 
2745
 
 
2746
    def _read_last_revision_info(self):
 
2747
        rh = self._revision_history()
 
2748
        revno = len(rh)
 
2749
        if revno:
 
2750
            return (revno, rh[-1])
 
2751
        else:
 
2752
            return (0, _mod_revision.NULL_REVISION)
 
2753
 
 
2754
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2755
    @needs_write_lock
 
2756
    def set_revision_history(self, rev_history):
 
2757
        """See Branch.set_revision_history."""
 
2758
        self._set_revision_history(rev_history)
 
2759
 
 
2760
    def _set_revision_history(self, rev_history):
 
2761
        if 'evil' in debug.debug_flags:
 
2762
            mutter_callsite(3, "set_revision_history scales with history.")
 
2763
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2764
        for rev_id in rev_history:
 
2765
            check_not_reserved_id(rev_id)
 
2766
        if Branch.hooks['post_change_branch_tip']:
 
2767
            # Don't calculate the last_revision_info() if there are no hooks
 
2768
            # that will use it.
 
2769
            old_revno, old_revid = self.last_revision_info()
 
2770
        if len(rev_history) == 0:
 
2771
            revid = _mod_revision.NULL_REVISION
 
2772
        else:
 
2773
            revid = rev_history[-1]
 
2774
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2775
        self._write_revision_history(rev_history)
 
2776
        self._clear_cached_state()
 
2777
        self._cache_revision_history(rev_history)
 
2778
        for hook in Branch.hooks['set_rh']:
 
2779
            hook(self, rev_history)
 
2780
        if Branch.hooks['post_change_branch_tip']:
 
2781
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2782
 
 
2783
    def _write_revision_history(self, history):
 
2784
        """Factored out of set_revision_history.
 
2785
 
 
2786
        This performs the actual writing to disk.
 
2787
        It is intended to be called by set_revision_history."""
 
2788
        self._transport.put_bytes(
 
2789
            'revision-history', '\n'.join(history),
 
2790
            mode=self.bzrdir._get_file_mode())
 
2791
 
 
2792
    def _gen_revision_history(self):
 
2793
        history = self._transport.get_bytes('revision-history').split('\n')
 
2794
        if history[-1:] == ['']:
 
2795
            # There shouldn't be a trailing newline, but just in case.
 
2796
            history.pop()
 
2797
        return history
 
2798
 
 
2799
    def _synchronize_history(self, destination, revision_id):
 
2800
        if not isinstance(destination, FullHistoryBzrBranch):
 
2801
            super(BzrBranch, self)._synchronize_history(
 
2802
                destination, revision_id)
 
2803
            return
 
2804
        if revision_id == _mod_revision.NULL_REVISION:
 
2805
            new_history = []
 
2806
        else:
 
2807
            new_history = self._revision_history()
 
2808
        if revision_id is not None and new_history != []:
 
2809
            try:
 
2810
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2811
            except ValueError:
 
2812
                rev = self.repository.get_revision(revision_id)
 
2813
                new_history = rev.get_history(self.repository)[1:]
 
2814
        destination._set_revision_history(new_history)
 
2815
 
 
2816
    @needs_write_lock
 
2817
    def generate_revision_history(self, revision_id, last_rev=None,
 
2818
        other_branch=None):
 
2819
        """Create a new revision history that will finish with revision_id.
 
2820
 
 
2821
        :param revision_id: the new tip to use.
 
2822
        :param last_rev: The previous last_revision. If not None, then this
 
2823
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2824
        :param other_branch: The other branch that DivergedBranches should
 
2825
            raise with respect to.
 
2826
        """
 
2827
        self._set_revision_history(self._lefthand_history(revision_id,
 
2828
            last_rev, other_branch))
 
2829
 
 
2830
 
 
2831
class BzrBranch5(FullHistoryBzrBranch):
 
2832
    """A format 5 branch. This supports new features over plain branches.
 
2833
 
 
2834
    It has support for a master_branch which is the data for bound branches.
 
2835
    """
 
2836
 
 
2837
 
 
2838
class BzrBranch8(BzrBranch):
2646
2839
    """A branch that stores tree-reference locations."""
2647
2840
 
2648
 
    def _open_hook(self):
 
2841
    def _open_hook(self, possible_transports=None):
2649
2842
        if self._ignore_fallbacks:
2650
2843
            return
 
2844
        if possible_transports is None:
 
2845
            possible_transports = [self.bzrdir.root_transport]
2651
2846
        try:
2652
2847
            url = self.get_stacked_on_url()
2653
2848
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2661
2856
                    raise AssertionError(
2662
2857
                        "'transform_fallback_location' hook %s returned "
2663
2858
                        "None, not a URL." % hook_name)
2664
 
            self._activate_fallback_location(url)
 
2859
            self._activate_fallback_location(url,
 
2860
                possible_transports=possible_transports)
2665
2861
 
2666
2862
    def __init__(self, *args, **kwargs):
2667
2863
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2674
2870
        self._last_revision_info_cache = None
2675
2871
        self._reference_info = None
2676
2872
 
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
2873
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2874
        current_revid = self.last_revision()
 
2875
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2876
        if _mod_revision.is_null(last_revision):
2725
2877
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2878
        graph = self.repository.get_graph()
 
2879
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2880
            if lh_ancestor == current_revid:
 
2881
                return
 
2882
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2883
 
2729
2884
    def _gen_revision_history(self):
2730
2885
        """Generate the revision history from last revision
2733
2888
        self._extend_partial_history(stop_index=last_revno-1)
2734
2889
        return list(reversed(self._partial_revision_history_cache))
2735
2890
 
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
2891
    @needs_write_lock
2753
2892
    def _set_parent_location(self, url):
2754
2893
        """Set the parent branch"""
2840
2979
 
2841
2980
    def set_bound_location(self, location):
2842
2981
        """See Branch.set_push_location."""
 
2982
        self._master_branch_cache = None
2843
2983
        result = None
2844
 
        config = self.get_config()
 
2984
        conf = self.get_config_stack()
2845
2985
        if location is None:
2846
 
            if config.get_user_option('bound') != 'True':
 
2986
            if not conf.get('bound'):
2847
2987
                return False
2848
2988
            else:
2849
 
                config.set_user_option('bound', 'False', warn_masked=True)
 
2989
                conf.set('bound', 'False')
2850
2990
                return True
2851
2991
        else:
2852
2992
            self._set_config_location('bound_location', location,
2853
 
                                      config=config)
2854
 
            config.set_user_option('bound', 'True', warn_masked=True)
 
2993
                                      config=conf)
 
2994
            conf.set('bound', 'True')
2855
2995
        return True
2856
2996
 
2857
2997
    def _get_bound_location(self, bound):
2858
2998
        """Return the bound location in the config file.
2859
2999
 
2860
3000
        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:
 
3001
        conf = self.get_config_stack()
 
3002
        if conf.get('bound') != bound:
2864
3003
            return None
2865
 
        return self._get_config_location('bound_location', config=config)
 
3004
        return self._get_config_location('bound_location', config=conf)
2866
3005
 
2867
3006
    def get_bound_location(self):
2868
 
        """See Branch.set_push_location."""
 
3007
        """See Branch.get_bound_location."""
2869
3008
        return self._get_bound_location(True)
2870
3009
 
2871
3010
    def get_old_bound_location(self):
2876
3015
        # you can always ask for the URL; but you might not be able to use it
2877
3016
        # if the repo can't support stacking.
2878
3017
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
3018
        # stacked_on_location is only ever defined in branch.conf, so don't
 
3019
        # waste effort reading the whole stack of config files.
 
3020
        conf = _mod_config.BranchOnlyStack(self)
 
3021
        stacked_url = self._get_config_location('stacked_on_location',
 
3022
                                                config=conf)
2880
3023
        if stacked_url is None:
2881
3024
            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)
 
3025
        return stacked_url.encode('utf-8')
2895
3026
 
2896
3027
    @needs_read_lock
2897
3028
    def get_rev_id(self, revno, history=None):
2922
3053
        try:
2923
3054
            index = self._partial_revision_history_cache.index(revision_id)
2924
3055
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3056
            try:
 
3057
                self._extend_partial_history(stop_revision=revision_id)
 
3058
            except errors.RevisionNotPresent, e:
 
3059
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3060
            index = len(self._partial_revision_history_cache) - 1
 
3061
            if index < 0:
 
3062
                raise errors.NoSuchRevision(self, revision_id)
2927
3063
            if self._partial_revision_history_cache[index] != revision_id:
2928
3064
                raise errors.NoSuchRevision(self, revision_id)
2929
3065
        return self.revno() - index
2981
3117
    :ivar local_branch: target branch if there is a Master, else None
2982
3118
    :ivar target_branch: Target/destination branch object. (write locked)
2983
3119
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3120
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2984
3121
    """
2985
3122
 
 
3123
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3124
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3125
        """Return the relative change in revno.
 
3126
 
 
3127
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3128
        """
2988
3129
        return self.new_revno - self.old_revno
2989
3130
 
2990
3131
    def report(self, to_file):
 
3132
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3133
        tag_updates = getattr(self, "tag_updates", None)
2991
3134
        if not is_quiet():
2992
 
            if self.old_revid == self.new_revid:
2993
 
                to_file.write('No revisions to pull.\n')
2994
 
            else:
 
3135
            if self.old_revid != self.new_revid:
2995
3136
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3137
            if tag_updates:
 
3138
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3139
            if self.old_revid == self.new_revid and not tag_updates:
 
3140
                if not tag_conflicts:
 
3141
                    to_file.write('No revisions or tags to pull.\n')
 
3142
                else:
 
3143
                    to_file.write('No revisions to pull.\n')
2996
3144
        self._show_tag_conficts(to_file)
2997
3145
 
2998
3146
 
3015
3163
        target, otherwise it will be None.
3016
3164
    """
3017
3165
 
 
3166
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3167
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3168
        """Return the relative change in revno.
 
3169
 
 
3170
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3171
        """
3020
3172
        return self.new_revno - self.old_revno
3021
3173
 
3022
3174
    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)
 
3175
        # TODO: This function gets passed a to_file, but then
 
3176
        # ignores it and calls note() instead. This is also
 
3177
        # inconsistent with PullResult(), which writes to stdout.
 
3178
        # -- JRV20110901, bug #838853
 
3179
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3180
        tag_updates = getattr(self, "tag_updates", None)
 
3181
        if not is_quiet():
 
3182
            if self.old_revid != self.new_revid:
 
3183
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3184
            if tag_updates:
 
3185
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3186
            if self.old_revid == self.new_revid and not tag_updates:
 
3187
                if not tag_conflicts:
 
3188
                    note(gettext('No new revisions or tags to push.'))
 
3189
                else:
 
3190
                    note(gettext('No new revisions to push.'))
3028
3191
        self._show_tag_conficts(to_file)
3029
3192
 
3030
3193
 
3044
3207
        :param verbose: Requests more detailed display of what was checked,
3045
3208
            if any.
3046
3209
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
 
3210
        note(gettext('checked branch {0} format {1}').format(
 
3211
                                self.branch.user_url, self.branch._format))
3049
3212
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
3213
            note(gettext('found error:%s'), error)
3051
3214
 
3052
3215
 
3053
3216
class Converter5to6(object):
3069
3232
 
3070
3233
        # Copying done; now update target format
3071
3234
        new_branch._transport.put_bytes('format',
3072
 
            format.get_format_string(),
 
3235
            format.as_string(),
3073
3236
            mode=new_branch.bzrdir._get_file_mode())
3074
3237
 
3075
3238
        # Clean up old files
3088
3251
        format = BzrBranchFormat7()
3089
3252
        branch._set_config_location('stacked_on_location', '')
3090
3253
        # update target format
3091
 
        branch._transport.put_bytes('format', format.get_format_string())
 
3254
        branch._transport.put_bytes('format', format.as_string())
3092
3255
 
3093
3256
 
3094
3257
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3258
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3259
 
3097
3260
    def convert(self, branch):
3098
3261
        format = BzrBranchFormat8()
3099
3262
        branch._transport.put_bytes('references', '')
3100
3263
        # 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
 
3264
        branch._transport.put_bytes('format', format.as_string())
3135
3265
 
3136
3266
 
3137
3267
class InterBranch(InterObject):
3145
3275
    _optimisers = []
3146
3276
    """The available optimised InterBranch types."""
3147
3277
 
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)
 
3278
    @classmethod
 
3279
    def _get_branch_formats_to_test(klass):
 
3280
        """Return an iterable of format tuples for testing.
 
3281
        
 
3282
        :return: An iterable of (from_format, to_format) to use when testing
 
3283
            this InterBranch class. Each InterBranch class should define this
 
3284
            method itself.
 
3285
        """
 
3286
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3287
 
 
3288
    @needs_write_lock
3153
3289
    def pull(self, overwrite=False, stop_revision=None,
3154
3290
             possible_transports=None, local=False):
3155
3291
        """Mirror source into target branch.
3160
3296
        """
3161
3297
        raise NotImplementedError(self.pull)
3162
3298
 
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,
 
3299
    @needs_write_lock
 
3300
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3301
             _override_hook_source_branch=None):
3178
3302
        """Mirror the source branch into the target branch.
3179
3303
 
3181
3305
        """
3182
3306
        raise NotImplementedError(self.push)
3183
3307
 
 
3308
    @needs_write_lock
 
3309
    def copy_content_into(self, revision_id=None):
 
3310
        """Copy the content of source into target
 
3311
 
 
3312
        revision_id: if not None, the revision history in the new branch will
 
3313
                     be truncated to end with revision_id.
 
3314
        """
 
3315
        raise NotImplementedError(self.copy_content_into)
 
3316
 
 
3317
    @needs_write_lock
 
3318
    def fetch(self, stop_revision=None, limit=None):
 
3319
        """Fetch revisions.
 
3320
 
 
3321
        :param stop_revision: Last revision to fetch
 
3322
        :param limit: Optional rough limit of revisions to fetch
 
3323
        """
 
3324
        raise NotImplementedError(self.fetch)
 
3325
 
3184
3326
 
3185
3327
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()."""
 
3328
    """InterBranch implementation that uses public Branch functions."""
 
3329
 
 
3330
    @classmethod
 
3331
    def is_compatible(klass, source, target):
 
3332
        # GenericBranch uses the public API, so always compatible
 
3333
        return True
 
3334
 
 
3335
    @classmethod
 
3336
    def _get_branch_formats_to_test(klass):
 
3337
        return [(format_registry.get_default(), format_registry.get_default())]
 
3338
 
 
3339
    @classmethod
 
3340
    def unwrap_format(klass, format):
 
3341
        if isinstance(format, remote.RemoteBranchFormat):
 
3342
            format._ensure_real()
 
3343
            return format._custom_format
 
3344
        return format
 
3345
 
 
3346
    @needs_write_lock
 
3347
    def copy_content_into(self, revision_id=None):
 
3348
        """Copy the content of source into target
 
3349
 
 
3350
        revision_id: if not None, the revision history in the new branch will
 
3351
                     be truncated to end with revision_id.
 
3352
        """
 
3353
        self.source.update_references(self.target)
 
3354
        self.source._synchronize_history(self.target, revision_id)
 
3355
        try:
 
3356
            parent = self.source.get_parent()
 
3357
        except errors.InaccessibleParent, e:
 
3358
            mutter('parent was not accessible to copy: %s', e)
 
3359
        else:
 
3360
            if parent:
 
3361
                self.target.set_parent(parent)
 
3362
        if self.source._push_should_merge_tags():
 
3363
            self.source.tags.merge_to(self.target.tags)
 
3364
 
 
3365
    @needs_write_lock
 
3366
    def fetch(self, stop_revision=None, limit=None):
 
3367
        if self.target.base == self.source.base:
 
3368
            return (0, [])
3196
3369
        self.source.lock_read()
3197
3370
        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)
 
3371
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3372
            fetch_spec_factory.source_branch = self.source
 
3373
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3374
            fetch_spec_factory.source_repo = self.source.repository
 
3375
            fetch_spec_factory.target_repo = self.target.repository
 
3376
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3377
            fetch_spec_factory.limit = limit
 
3378
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3379
            return self.target.repository.fetch(self.source.repository,
 
3380
                fetch_spec=fetch_spec)
3233
3381
        finally:
3234
3382
            self.source.unlock()
3235
3383
 
 
3384
    @needs_write_lock
 
3385
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3386
            graph=None):
 
3387
        other_revno, other_last_revision = self.source.last_revision_info()
 
3388
        stop_revno = None # unknown
 
3389
        if stop_revision is None:
 
3390
            stop_revision = other_last_revision
 
3391
            if _mod_revision.is_null(stop_revision):
 
3392
                # if there are no commits, we're done.
 
3393
                return
 
3394
            stop_revno = other_revno
 
3395
 
 
3396
        # what's the current last revision, before we fetch [and change it
 
3397
        # possibly]
 
3398
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3399
        # we fetch here so that we don't process data twice in the common
 
3400
        # case of having something to pull, and so that the check for
 
3401
        # already merged can operate on the just fetched graph, which will
 
3402
        # be cached in memory.
 
3403
        self.fetch(stop_revision=stop_revision)
 
3404
        # Check to see if one is an ancestor of the other
 
3405
        if not overwrite:
 
3406
            if graph is None:
 
3407
                graph = self.target.repository.get_graph()
 
3408
            if self.target._check_if_descendant_or_diverged(
 
3409
                    stop_revision, last_rev, graph, self.source):
 
3410
                # stop_revision is a descendant of last_rev, but we aren't
 
3411
                # overwriting, so we're done.
 
3412
                return
 
3413
        if stop_revno is None:
 
3414
            if graph is None:
 
3415
                graph = self.target.repository.get_graph()
 
3416
            this_revno, this_last_revision = \
 
3417
                    self.target.last_revision_info()
 
3418
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3419
                            [(other_last_revision, other_revno),
 
3420
                             (this_last_revision, this_revno)])
 
3421
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3422
 
 
3423
    @needs_write_lock
3236
3424
    def pull(self, overwrite=False, stop_revision=None,
 
3425
             possible_transports=None, run_hooks=True,
 
3426
             _override_hook_target=None, local=False):
 
3427
        """Pull from source into self, updating my master if any.
 
3428
 
 
3429
        :param run_hooks: Private parameter - if false, this branch
 
3430
            is being called because it's the master of the primary branch,
 
3431
            so it should not run its hooks.
 
3432
        """
 
3433
        bound_location = self.target.get_bound_location()
 
3434
        if local and not bound_location:
 
3435
            raise errors.LocalRequiresBoundBranch()
 
3436
        master_branch = None
 
3437
        source_is_master = False
 
3438
        if bound_location:
 
3439
            # bound_location comes from a config file, some care has to be
 
3440
            # taken to relate it to source.user_url
 
3441
            normalized = urlutils.normalize_url(bound_location)
 
3442
            try:
 
3443
                relpath = self.source.user_transport.relpath(normalized)
 
3444
                source_is_master = (relpath == '')
 
3445
            except (errors.PathNotChild, errors.InvalidURL):
 
3446
                source_is_master = False
 
3447
        if not local and bound_location and not source_is_master:
 
3448
            # not pulling from master, so we need to update master.
 
3449
            master_branch = self.target.get_master_branch(possible_transports)
 
3450
            master_branch.lock_write()
 
3451
        try:
 
3452
            if master_branch:
 
3453
                # pull from source into master.
 
3454
                master_branch.pull(self.source, overwrite, stop_revision,
 
3455
                    run_hooks=False)
 
3456
            return self._pull(overwrite,
 
3457
                stop_revision, _hook_master=master_branch,
 
3458
                run_hooks=run_hooks,
 
3459
                _override_hook_target=_override_hook_target,
 
3460
                merge_tags_to_master=not source_is_master)
 
3461
        finally:
 
3462
            if master_branch:
 
3463
                master_branch.unlock()
 
3464
 
 
3465
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3466
             _override_hook_source_branch=None):
 
3467
        """See InterBranch.push.
 
3468
 
 
3469
        This is the basic concrete implementation of push()
 
3470
 
 
3471
        :param _override_hook_source_branch: If specified, run the hooks
 
3472
            passing this Branch as the source, rather than self.  This is for
 
3473
            use of RemoteBranch, where push is delegated to the underlying
 
3474
            vfs-based Branch.
 
3475
        """
 
3476
        if lossy:
 
3477
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3478
        # TODO: Public option to disable running hooks - should be trivial but
 
3479
        # needs tests.
 
3480
 
 
3481
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3482
        op.add_cleanup(self.source.lock_read().unlock)
 
3483
        op.add_cleanup(self.target.lock_write().unlock)
 
3484
        return op.run(overwrite, stop_revision,
 
3485
            _override_hook_source_branch=_override_hook_source_branch)
 
3486
 
 
3487
    def _basic_push(self, overwrite, stop_revision):
 
3488
        """Basic implementation of push without bound branches or hooks.
 
3489
 
 
3490
        Must be called with source read locked and target write locked.
 
3491
        """
 
3492
        result = BranchPushResult()
 
3493
        result.source_branch = self.source
 
3494
        result.target_branch = self.target
 
3495
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3496
        self.source.update_references(self.target)
 
3497
        if result.old_revid != stop_revision:
 
3498
            # We assume that during 'push' this repository is closer than
 
3499
            # the target.
 
3500
            graph = self.source.repository.get_graph(self.target.repository)
 
3501
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3502
                    graph=graph)
 
3503
        if self.source._push_should_merge_tags():
 
3504
            result.tag_updates, result.tag_conflicts = (
 
3505
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3506
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3507
        return result
 
3508
 
 
3509
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3510
            _override_hook_source_branch=None):
 
3511
        """Push from source into target, and into target's master if any.
 
3512
        """
 
3513
        def _run_hooks():
 
3514
            if _override_hook_source_branch:
 
3515
                result.source_branch = _override_hook_source_branch
 
3516
            for hook in Branch.hooks['post_push']:
 
3517
                hook(result)
 
3518
 
 
3519
        bound_location = self.target.get_bound_location()
 
3520
        if bound_location and self.target.base != bound_location:
 
3521
            # there is a master branch.
 
3522
            #
 
3523
            # XXX: Why the second check?  Is it even supported for a branch to
 
3524
            # be bound to itself? -- mbp 20070507
 
3525
            master_branch = self.target.get_master_branch()
 
3526
            master_branch.lock_write()
 
3527
            operation.add_cleanup(master_branch.unlock)
 
3528
            # push into the master from the source branch.
 
3529
            master_inter = InterBranch.get(self.source, master_branch)
 
3530
            master_inter._basic_push(overwrite, stop_revision)
 
3531
            # and push into the target branch from the source. Note that
 
3532
            # we push from the source branch again, because it's considered
 
3533
            # the highest bandwidth repository.
 
3534
            result = self._basic_push(overwrite, stop_revision)
 
3535
            result.master_branch = master_branch
 
3536
            result.local_branch = self.target
 
3537
        else:
 
3538
            master_branch = None
 
3539
            # no master branch
 
3540
            result = self._basic_push(overwrite, stop_revision)
 
3541
            # TODO: Why set master_branch and local_branch if there's no
 
3542
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3543
            # 20070504
 
3544
            result.master_branch = self.target
 
3545
            result.local_branch = None
 
3546
        _run_hooks()
 
3547
        return result
 
3548
 
 
3549
    def _pull(self, overwrite=False, stop_revision=None,
3237
3550
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3551
             _override_hook_target=None, local=False,
 
3552
             merge_tags_to_master=True):
3239
3553
        """See Branch.pull.
3240
3554
 
 
3555
        This function is the core worker, used by GenericInterBranch.pull to
 
3556
        avoid duplication when pulling source->master and source->local.
 
3557
 
3241
3558
        :param _hook_master: Private parameter - set the branch to
3242
3559
            be supplied as the master to pull hooks.
3243
3560
        :param run_hooks: Private parameter - if false, this branch
3244
3561
            is being called because it's the master of the primary branch,
3245
3562
            so it should not run its hooks.
 
3563
            is being called because it's the master of the primary branch,
 
3564
            so it should not run its hooks.
3246
3565
        :param _override_hook_target: Private parameter - set the branch to be
3247
3566
            supplied as the target_branch to pull hooks.
3248
3567
        :param local: Only update the local branch, and not the bound branch.
3267
3586
            # -- JRV20090506
3268
3587
            result.old_revno, result.old_revid = \
3269
3588
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3589
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3590
                graph=graph)
3272
3591
            # TODO: The old revid should be specified when merging tags, 
3273
3592
            # so a tags implementation that versions tags can only 
3274
3593
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3594
            result.tag_updates, result.tag_conflicts = (
 
3595
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3596
                    ignore_master=not merge_tags_to_master))
3277
3597
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3598
            if _hook_master:
3279
3599
                result.master_branch = _hook_master
3288
3608
            self.source.unlock()
3289
3609
        return result
3290
3610
 
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
3611
 
3400
3612
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)