~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2012 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
20
17
 
21
18
from cStringIO import StringIO
 
19
import sys
22
20
 
23
21
from bzrlib.lazy_import import lazy_import
24
22
lazy_import(globals(), """
25
 
import itertools
 
23
from itertools import chain
26
24
from bzrlib import (
27
 
    bzrdir,
28
 
    controldir,
29
 
    cache_utf8,
30
 
    cleanup,
31
 
    config as _mod_config,
32
 
    debug,
33
 
    errors,
34
 
    fetch,
35
 
    graph as _mod_graph,
36
 
    lockdir,
37
 
    lockable_files,
38
 
    remote,
39
 
    repository,
40
 
    revision as _mod_revision,
41
 
    rio,
42
 
    shelf,
43
 
    tag as _mod_tag,
44
 
    transport,
45
 
    ui,
46
 
    urlutils,
47
 
    vf_search,
 
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,
48
46
    )
49
 
from bzrlib.i18n import gettext, ngettext
50
47
""")
51
48
 
52
 
# Explicitly import bzrlib.bzrdir so that the BzrProber
53
 
# is guaranteed to be registered.
54
 
import bzrlib.bzrdir
55
 
 
56
 
from bzrlib import (
57
 
    bzrdir,
58
 
    controldir,
59
 
    )
60
 
from bzrlib.decorators import (
61
 
    needs_read_lock,
62
 
    needs_write_lock,
63
 
    only_raises,
64
 
    )
65
 
from bzrlib.hooks import Hooks
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
50
from bzrlib.hooks import HookPoint, Hooks
66
51
from bzrlib.inter import InterObject
67
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
52
from bzrlib.lock import _RelockDebugMixin
68
53
from bzrlib import registry
69
54
from bzrlib.symbol_versioning import (
70
55
    deprecated_in,
73
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
74
59
 
75
60
 
76
 
class Branch(controldir.ControlComponent):
 
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):
77
67
    """Branch holding a history of revisions.
78
68
 
79
69
    :ivar base:
80
70
        Base directory/url of the branch; using control_url and
81
71
        control_transport is more standardized.
82
 
    :ivar hooks: An instance of BranchHooks.
83
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
84
 
        _clear_cached_state.
 
72
 
 
73
    hooks: An instance of BranchHooks.
85
74
    """
86
75
    # this is really an instance variable - FIXME move it there
87
76
    # - RBC 20060112
95
84
    def user_transport(self):
96
85
        return self.bzrdir.user_transport
97
86
 
98
 
    def __init__(self, possible_transports=None):
 
87
    def __init__(self, *ignored, **ignored_too):
99
88
        self.tags = self._format.make_tags(self)
100
89
        self._revision_history_cache = None
101
90
        self._revision_id_to_revno_cache = None
102
91
        self._partial_revision_id_to_revno_cache = {}
103
92
        self._partial_revision_history_cache = []
104
 
        self._tags_bytes = None
105
93
        self._last_revision_info_cache = None
106
 
        self._master_branch_cache = None
107
94
        self._merge_sorted_revisions_cache = None
108
 
        self._open_hook(possible_transports)
 
95
        self._open_hook()
109
96
        hooks = Branch.hooks['open']
110
97
        for hook in hooks:
111
98
            hook(self)
112
99
 
113
 
    def _open_hook(self, possible_transports):
 
100
    def _open_hook(self):
114
101
        """Called by init to allow simpler extension of the base class."""
115
102
 
116
 
    def _activate_fallback_location(self, url, possible_transports):
 
103
    def _activate_fallback_location(self, url):
117
104
        """Activate the branch/repository from url as a fallback repository."""
118
 
        for existing_fallback_repo in self.repository._fallback_repositories:
119
 
            if existing_fallback_repo.user_url == url:
120
 
                # This fallback is already configured.  This probably only
121
 
                # happens because ControlDir.sprout is a horrible mess.  To avoid
122
 
                # confusing _unstack we don't add this a second time.
123
 
                mutter('duplicate activation of fallback %r on %r', url, self)
124
 
                return
125
 
        repo = self._get_fallback_repository(url, possible_transports)
 
105
        repo = self._get_fallback_repository(url)
126
106
        if repo.has_same_location(self.repository):
127
107
            raise errors.UnstackableLocationError(self.user_url, url)
128
108
        self.repository.add_fallback_repository(repo)
182
162
        For instance, if the branch is at URL/.bzr/branch,
183
163
        Branch.open(URL) -> a Branch instance.
184
164
        """
185
 
        control = controldir.ControlDir.open(base,
186
 
            possible_transports=possible_transports, _unsupported=_unsupported)
187
 
        return control.open_branch(unsupported=_unsupported,
188
 
            possible_transports=possible_transports)
 
165
        control = bzrdir.BzrDir.open(base, _unsupported,
 
166
                                     possible_transports=possible_transports)
 
167
        return control.open_branch(unsupported=_unsupported)
189
168
 
190
169
    @staticmethod
191
 
    def open_from_transport(transport, name=None, _unsupported=False,
192
 
            possible_transports=None):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
193
171
        """Open the branch rooted at transport"""
194
 
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
195
 
        return control.open_branch(name=name, unsupported=_unsupported,
196
 
            possible_transports=possible_transports)
 
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
197
174
 
198
175
    @staticmethod
199
176
    def open_containing(url, possible_transports=None):
207
184
        format, UnknownFormatError or UnsupportedFormatError are raised.
208
185
        If there is one, it is returned, along with the unused portion of url.
209
186
        """
210
 
        control, relpath = controldir.ControlDir.open_containing(url,
 
187
        control, relpath = bzrdir.BzrDir.open_containing(url,
211
188
                                                         possible_transports)
212
 
        branch = control.open_branch(possible_transports=possible_transports)
213
 
        return (branch, relpath)
 
189
        return control.open_branch(), relpath
214
190
 
215
191
    def _push_should_merge_tags(self):
216
192
        """Should _basic_push merge this branch's tags into the target?
221
197
        return self.supports_tags() and self.tags.get_tag_dict()
222
198
 
223
199
    def get_config(self):
224
 
        """Get a bzrlib.config.BranchConfig for this Branch.
225
 
 
226
 
        This can then be used to get and set configuration options for the
227
 
        branch.
228
 
 
229
 
        :return: A bzrlib.config.BranchConfig.
230
 
        """
231
 
        return _mod_config.BranchConfig(self)
232
 
 
233
 
    def get_config_stack(self):
234
 
        """Get a bzrlib.config.BranchStack for this Branch.
235
 
 
236
 
        This can then be used to get and set configuration options for the
237
 
        branch.
238
 
 
239
 
        :return: A bzrlib.config.BranchStack.
240
 
        """
241
 
        return _mod_config.BranchStack(self)
 
200
        return BranchConfig(self)
242
201
 
243
202
    def _get_config(self):
244
203
        """Get the concrete config for just the config in this branch.
252
211
        """
253
212
        raise NotImplementedError(self._get_config)
254
213
 
255
 
    def store_uncommitted(self, creator):
256
 
        """Store uncommitted changes from a ShelfCreator.
257
 
 
258
 
        :param creator: The ShelfCreator containing uncommitted changes, or
259
 
            None to delete any stored changes.
260
 
        :raises: ChangesAlreadyStored if the branch already has changes.
261
 
        """
262
 
        raise NotImplementedError(self.store_uncommitted)
263
 
 
264
 
    def get_unshelver(self, tree):
265
 
        """Return a shelf.Unshelver for this branch and tree.
266
 
 
267
 
        :param tree: The tree to use to construct the Unshelver.
268
 
        :return: an Unshelver or None if no changes are stored.
269
 
        """
270
 
        raise NotImplementedError(self.get_unshelver)
271
 
 
272
 
    def _get_fallback_repository(self, url, possible_transports):
 
214
    def _get_fallback_repository(self, url):
273
215
        """Get the repository we fallback to at url."""
274
216
        url = urlutils.join(self.base, url)
275
 
        a_branch = Branch.open(url, possible_transports=possible_transports)
 
217
        a_branch = Branch.open(url,
 
218
            possible_transports=[self.bzrdir.root_transport])
276
219
        return a_branch.repository
277
220
 
278
 
    @needs_read_lock
279
221
    def _get_tags_bytes(self):
280
222
        """Get the bytes of a serialised tags dict.
281
223
 
288
230
        :return: The bytes of the tags file.
289
231
        :seealso: Branch._set_tags_bytes.
290
232
        """
291
 
        if self._tags_bytes is None:
292
 
            self._tags_bytes = self._transport.get_bytes('tags')
293
 
        return self._tags_bytes
 
233
        return self._transport.get_bytes('tags')
294
234
 
295
235
    def _get_nick(self, local=False, possible_transports=None):
296
236
        config = self.get_config()
298
238
        if not local and not config.has_explicit_nickname():
299
239
            try:
300
240
                master = self.get_master_branch(possible_transports)
301
 
                if master and self.user_url == master.user_url:
302
 
                    raise errors.RecursiveBind(self.user_url)
303
241
                if master is not None:
304
242
                    # return the master branch value
305
243
                    return master.nick
306
 
            except errors.RecursiveBind, e:
307
 
                raise e
308
244
            except errors.BzrError, e:
309
245
                # Silently fall back to local implicit nick if the master is
310
246
                # unavailable
347
283
        new_history.reverse()
348
284
        return new_history
349
285
 
350
 
    def lock_write(self, token=None):
351
 
        """Lock the branch for write operations.
352
 
 
353
 
        :param token: A token to permit reacquiring a previously held and
354
 
            preserved lock.
355
 
        :return: A BranchWriteLockResult.
356
 
        """
 
286
    def lock_write(self):
357
287
        raise NotImplementedError(self.lock_write)
358
288
 
359
289
    def lock_read(self):
360
 
        """Lock the branch for read operations.
361
 
 
362
 
        :return: A bzrlib.lock.LogicalLockResult.
363
 
        """
364
290
        raise NotImplementedError(self.lock_read)
365
291
 
366
292
    def unlock(self):
487
413
            after. If None, the rest of history is included.
488
414
        :param stop_rule: if stop_revision_id is not None, the precise rule
489
415
            to use for termination:
490
 
 
491
416
            * 'exclude' - leave the stop revision out of the result (default)
492
417
            * 'include' - the stop revision is the last item in the result
493
418
            * 'with-merges' - include the stop revision and all of its
495
420
            * 'with-merges-without-common-ancestry' - filter out revisions 
496
421
              that are in both ancestries
497
422
        :param direction: either 'reverse' or 'forward':
498
 
 
499
423
            * reverse means return the start_revision_id first, i.e.
500
424
              start at the most recent revision and go backwards in history
501
425
            * forward returns tuples in the opposite order to reverse.
545
469
        rev_iter = iter(merge_sorted_revisions)
546
470
        if start_revision_id is not None:
547
471
            for node in rev_iter:
548
 
                rev_id = node.key
 
472
                rev_id = node.key[-1]
549
473
                if rev_id != start_revision_id:
550
474
                    continue
551
475
                else:
552
476
                    # The decision to include the start or not
553
477
                    # depends on the stop_rule if a stop is provided
554
478
                    # so pop this node back into the iterator
555
 
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
479
                    rev_iter = chain(iter([node]), rev_iter)
556
480
                    break
557
481
        if stop_revision_id is None:
558
482
            # Yield everything
559
483
            for node in rev_iter:
560
 
                rev_id = node.key
 
484
                rev_id = node.key[-1]
561
485
                yield (rev_id, node.merge_depth, node.revno,
562
486
                       node.end_of_merge)
563
487
        elif stop_rule == 'exclude':
564
488
            for node in rev_iter:
565
 
                rev_id = node.key
 
489
                rev_id = node.key[-1]
566
490
                if rev_id == stop_revision_id:
567
491
                    return
568
492
                yield (rev_id, node.merge_depth, node.revno,
569
493
                       node.end_of_merge)
570
494
        elif stop_rule == 'include':
571
495
            for node in rev_iter:
572
 
                rev_id = node.key
 
496
                rev_id = node.key[-1]
573
497
                yield (rev_id, node.merge_depth, node.revno,
574
498
                       node.end_of_merge)
575
499
                if rev_id == stop_revision_id:
581
505
            ancestors = graph.find_unique_ancestors(start_revision_id,
582
506
                                                    [stop_revision_id])
583
507
            for node in rev_iter:
584
 
                rev_id = node.key
 
508
                rev_id = node.key[-1]
585
509
                if rev_id not in ancestors:
586
510
                    continue
587
511
                yield (rev_id, node.merge_depth, node.revno,
597
521
            reached_stop_revision_id = False
598
522
            revision_id_whitelist = []
599
523
            for node in rev_iter:
600
 
                rev_id = node.key
 
524
                rev_id = node.key[-1]
601
525
                if rev_id == left_parent:
602
526
                    # reached the left parent after the stop_revision
603
527
                    return
683
607
        """
684
608
        raise errors.UpgradeRequired(self.user_url)
685
609
 
686
 
    def get_append_revisions_only(self):
687
 
        """Whether it is only possible to append revisions to the history.
688
 
        """
689
 
        if not self._format.supports_set_append_revisions_only():
690
 
            return False
691
 
        return self.get_config_stack().get('append_revisions_only')
692
 
 
693
610
    def set_append_revisions_only(self, enabled):
694
611
        if not self._format.supports_set_append_revisions_only():
695
612
            raise errors.UpgradeRequired(self.user_url)
696
 
        self.get_config_stack().set('append_revisions_only', enabled)
 
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)
697
619
 
698
620
    def set_reference_info(self, file_id, tree_path, branch_location):
699
621
        """Set the branch location to use for a tree reference."""
704
626
        raise errors.UnsupportedOperation(self.get_reference_info, self)
705
627
 
706
628
    @needs_write_lock
707
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
629
    def fetch(self, from_branch, last_revision=None, pb=None):
708
630
        """Copy revisions from from_branch into this branch.
709
631
 
710
632
        :param from_branch: Where to copy from.
711
633
        :param last_revision: What revision to stop at (None for at the end
712
634
                              of the branch.
713
 
        :param limit: Optional rough limit of revisions to fetch
 
635
        :param pb: An optional progress bar to use.
714
636
        :return: None
715
637
        """
716
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
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()
717
654
 
718
655
    def get_bound_location(self):
719
656
        """Return the URL of the branch we are bound to.
728
665
        """
729
666
        raise errors.UpgradeRequired(self.user_url)
730
667
 
731
 
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
 
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
732
669
                           timezone=None, committer=None, revprops=None,
733
 
                           revision_id=None, lossy=False):
 
670
                           revision_id=None):
734
671
        """Obtain a CommitBuilder for this branch.
735
672
 
736
673
        :param parents: Revision ids of the parents of the new revision.
740
677
        :param committer: Optional committer to set for commit.
741
678
        :param revprops: Optional dictionary of revision properties.
742
679
        :param revision_id: Optional revision id.
743
 
        :param lossy: Whether to discard data that can not be natively
744
 
            represented, when pushing to a foreign VCS 
745
680
        """
746
681
 
747
 
        if config_stack is None:
748
 
            config_stack = self.get_config_stack()
 
682
        if config is None:
 
683
            config = self.get_config()
749
684
 
750
 
        return self.repository.get_commit_builder(self, parents, config_stack,
751
 
            timestamp, timezone, committer, revprops, revision_id,
752
 
            lossy)
 
685
        return self.repository.get_commit_builder(self, parents, config,
 
686
            timestamp, timezone, committer, revprops, revision_id)
753
687
 
754
688
    def get_master_branch(self, possible_transports=None):
755
689
        """Return the branch we are bound to.
758
692
        """
759
693
        return None
760
694
 
761
 
    @deprecated_method(deprecated_in((2, 5, 0)))
762
695
    def get_revision_delta(self, revno):
763
696
        """Return the delta for one revision.
764
697
 
765
698
        The delta is relative to its mainline predecessor, or the
766
699
        empty tree for revision 1.
767
700
        """
768
 
        try:
769
 
            revid = self.get_rev_id(revno)
770
 
        except errors.NoSuchRevision:
 
701
        rh = self.revision_history()
 
702
        if not (1 <= revno <= len(rh)):
771
703
            raise errors.InvalidRevisionNumber(revno)
772
 
        return self.repository.get_revision_delta(revid)
 
704
        return self.repository.get_revision_delta(rh[revno-1])
773
705
 
774
706
    def get_stacked_on_url(self):
775
707
        """Get the URL this branch is stacked against.
784
716
        """Print `file` to stdout."""
785
717
        raise NotImplementedError(self.print_file)
786
718
 
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)
 
719
    def set_revision_history(self, rev_history):
 
720
        raise NotImplementedError(self.set_revision_history)
817
721
 
818
722
    @needs_write_lock
819
723
    def set_parent(self, url):
856
760
                return
857
761
            self._unstack()
858
762
        else:
859
 
            self._activate_fallback_location(url,
860
 
                possible_transports=[self.bzrdir.root_transport])
 
763
            self._activate_fallback_location(url)
861
764
        # write this out after the repository is stacked to avoid setting a
862
765
        # stacked config that doesn't work.
863
766
        self._set_config_location('stacked_on_location', url)
864
767
 
865
768
    def _unstack(self):
866
769
        """Change a branch to be unstacked, copying data as needed.
867
 
 
 
770
        
868
771
        Don't call this directly, use set_stacked_on_url(None).
869
772
        """
870
773
        pb = ui.ui_factory.nested_progress_bar()
871
774
        try:
872
 
            pb.update(gettext("Unstacking"))
 
775
            pb.update("Unstacking")
873
776
            # The basic approach here is to fetch the tip of the branch,
874
777
            # including all available ghosts, from the existing stacked
875
778
            # repository into a new repository object without the fallbacks. 
879
782
            old_repository = self.repository
880
783
            if len(old_repository._fallback_repositories) != 1:
881
784
                raise AssertionError("can't cope with fallback repositories "
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()
 
785
                    "of %r" % (self.repository,))
 
786
            # unlock it, including unlocking the fallback
912
787
            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):
 
788
            old_repository.lock_read()
 
789
            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
931
807
                self.repository.lock_write()
932
 
            # Fetch from the old repository into the new.
933
 
            old_repository.lock_read()
934
 
            try:
935
808
                # XXX: If you unstack a branch while it has a working tree
936
809
                # with a pending merge, the pending-merged revisions will no
937
810
                # longer be present.  You can (probably) revert and remerge.
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)
 
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)
946
818
            finally:
947
819
                old_repository.unlock()
948
820
        finally:
953
825
 
954
826
        :seealso: Branch._get_tags_bytes.
955
827
        """
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)
 
828
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
829
            'tags', bytes)
963
830
 
964
831
    def _cache_revision_history(self, rev_history):
965
832
        """Set the cached revision history to rev_history.
986
853
        This means the next call to revision_history will need to call
987
854
        _gen_revision_history.
988
855
 
989
 
        This API is semi-public; it is only for use by subclasses, all other
990
 
        code should consider it to be private.
 
856
        This API is semi-public; it only for use by subclasses, all other code
 
857
        should consider it to be private.
991
858
        """
992
859
        self._revision_history_cache = None
993
860
        self._revision_id_to_revno_cache = None
994
861
        self._last_revision_info_cache = None
995
 
        self._master_branch_cache = None
996
862
        self._merge_sorted_revisions_cache = None
997
863
        self._partial_revision_history_cache = []
998
864
        self._partial_revision_id_to_revno_cache = {}
999
 
        self._tags_bytes = None
1000
865
 
1001
866
    def _gen_revision_history(self):
1002
867
        """Return sequence of revision hashes on to this branch.
1013
878
        """
1014
879
        raise NotImplementedError(self._gen_revision_history)
1015
880
 
1016
 
    def _revision_history(self):
 
881
    @needs_read_lock
 
882
    def revision_history(self):
 
883
        """Return sequence of revision ids on this branch.
 
884
 
 
885
        This method will cache the revision history for as long as it is safe to
 
886
        do so.
 
887
        """
1017
888
        if 'evil' in debug.debug_flags:
1018
889
            mutter_callsite(3, "revision_history scales with history.")
1019
890
        if self._revision_history_cache is not None:
1046
917
        :return: A tuple (revno, revision_id).
1047
918
        """
1048
919
        if self._last_revision_info_cache is None:
1049
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
920
            self._last_revision_info_cache = self._last_revision_info()
1050
921
        return self._last_revision_info_cache
1051
922
 
1052
 
    def _read_last_revision_info(self):
1053
 
        raise NotImplementedError(self._read_last_revision_info)
1054
 
 
1055
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1056
 
                                           lossy=False):
 
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
 
 
970
    def import_last_revision_info(self, source_repo, revno, revid):
1057
971
        """Set the last revision info, importing from another repo if necessary.
1058
972
 
1059
973
        This is used by the bound branch code to upload a revision to
1060
974
        the master branch first before updating the tip of the local branch.
1061
 
        Revisions referenced by source's tags are also transferred.
1062
975
 
1063
 
        :param source: Source branch to optionally fetch from
 
976
        :param source_repo: Source repository to optionally fetch from
1064
977
        :param revno: Revision number of the new tip
1065
978
        :param revid: Revision id of the new tip
1066
 
        :param lossy: Whether to discard metadata that can not be
1067
 
            natively represented
1068
 
        :return: Tuple with the new revision number and revision id
1069
 
            (should only be different from the arguments when lossy=True)
1070
979
        """
1071
 
        if not self.repository.has_same_location(source.repository):
1072
 
            self.fetch(source, revid)
 
980
        if not self.repository.has_same_location(source_repo):
 
981
            self.repository.fetch(source_repo, revision_id=revid)
1073
982
        self.set_last_revision_info(revno, revid)
1074
 
        return (revno, revid)
1075
983
 
1076
984
    def revision_id_to_revno(self, revision_id):
1077
985
        """Given a revision id, return its revno"""
1078
986
        if _mod_revision.is_null(revision_id):
1079
987
            return 0
1080
 
        history = self._revision_history()
 
988
        history = self.revision_history()
1081
989
        try:
1082
990
            return history.index(revision_id) + 1
1083
991
        except ValueError:
1098
1006
            self._extend_partial_history(distance_from_last)
1099
1007
        return self._partial_revision_history_cache[distance_from_last]
1100
1008
 
 
1009
    @needs_write_lock
1101
1010
    def pull(self, source, overwrite=False, stop_revision=None,
1102
1011
             possible_transports=None, *args, **kwargs):
1103
1012
        """Mirror source into this branch.
1110
1019
            stop_revision=stop_revision,
1111
1020
            possible_transports=possible_transports, *args, **kwargs)
1112
1021
 
1113
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1114
 
            *args, **kwargs):
 
1022
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1023
        **kwargs):
1115
1024
        """Mirror this branch into target.
1116
1025
 
1117
1026
        This branch is considered to be 'local', having low latency.
1118
1027
        """
1119
1028
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1120
 
            lossy, *args, **kwargs)
 
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)
1121
1051
 
1122
1052
    def basis_tree(self):
1123
1053
        """Return `Tree` object for last revision."""
1148
1078
    def _set_config_location(self, name, url, config=None,
1149
1079
                             make_relative=False):
1150
1080
        if config is None:
1151
 
            config = self.get_config_stack()
 
1081
            config = self.get_config()
1152
1082
        if url is None:
1153
1083
            url = ''
1154
1084
        elif make_relative:
1155
1085
            url = urlutils.relative_url(self.base, url)
1156
 
        config.set(name, url)
 
1086
        config.set_user_option(name, url, warn_masked=True)
1157
1087
 
1158
1088
    def _get_config_location(self, name, config=None):
1159
1089
        if config is None:
1160
 
            config = self.get_config_stack()
1161
 
        location = config.get(name)
 
1090
            config = self.get_config()
 
1091
        location = config.get_user_option(name)
1162
1092
        if location == '':
1163
1093
            location = None
1164
1094
        return location
1165
1095
 
1166
1096
    def get_child_submit_format(self):
1167
1097
        """Return the preferred format of submissions to this branch."""
1168
 
        return self.get_config_stack().get('child_submit_format')
 
1098
        return self.get_config().get_user_option("child_submit_format")
1169
1099
 
1170
1100
    def get_submit_branch(self):
1171
1101
        """Return the submit location of the branch.
1174
1104
        pattern is that the user can override it by specifying a
1175
1105
        location.
1176
1106
        """
1177
 
        return self.get_config_stack().get('submit_branch')
 
1107
        return self.get_config().get_user_option('submit_branch')
1178
1108
 
1179
1109
    def set_submit_branch(self, location):
1180
1110
        """Return the submit location of the branch.
1183
1113
        pattern is that the user can override it by specifying a
1184
1114
        location.
1185
1115
        """
1186
 
        self.get_config_stack().set('submit_branch', location)
 
1116
        self.get_config().set_user_option('submit_branch', location,
 
1117
            warn_masked=True)
1187
1118
 
1188
1119
    def get_public_branch(self):
1189
1120
        """Return the public location of the branch.
1202
1133
        self._set_config_location('public_branch', location)
1203
1134
 
1204
1135
    def get_push_location(self):
1205
 
        """Return None or the location to push this branch to."""
1206
 
        return self.get_config_stack().get('push_location')
 
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
1207
1139
 
1208
1140
    def set_push_location(self, location):
1209
1141
        """Set a new push location for this branch."""
1276
1208
        return result
1277
1209
 
1278
1210
    @needs_read_lock
1279
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1280
 
            repository=None):
 
1211
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1281
1212
        """Create a new line of development from the branch, into to_bzrdir.
1282
1213
 
1283
1214
        to_bzrdir controls the branch format.
1288
1219
        if (repository_policy is not None and
1289
1220
            repository_policy.requires_stacking()):
1290
1221
            to_bzrdir._format.require_stacking(_skip_repo=True)
1291
 
        result = to_bzrdir.create_branch(repository=repository)
 
1222
        result = to_bzrdir.create_branch()
1292
1223
        result.lock_write()
1293
1224
        try:
1294
1225
            if repository_policy is not None:
1295
1226
                repository_policy.configure_branch(result)
1296
1227
            self.copy_content_into(result, revision_id=revision_id)
1297
 
            master_url = self.get_bound_location()
1298
 
            if master_url is None:
1299
 
                result.set_parent(self.bzrdir.root_transport.base)
1300
 
            else:
1301
 
                result.set_parent(master_url)
 
1228
            result.set_parent(self.bzrdir.root_transport.base)
1302
1229
        finally:
1303
1230
            result.unlock()
1304
1231
        return result
1328
1255
                revno = 1
1329
1256
        destination.set_last_revision_info(revno, revision_id)
1330
1257
 
 
1258
    @needs_read_lock
1331
1259
    def copy_content_into(self, destination, revision_id=None):
1332
1260
        """Copy the content of self into destination.
1333
1261
 
1334
1262
        revision_id: if not None, the revision history in the new branch will
1335
1263
                     be truncated to end with revision_id.
1336
1264
        """
1337
 
        return InterBranch.get(self, destination).copy_content_into(
1338
 
            revision_id=revision_id)
 
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)
1339
1276
 
1340
1277
    def update_references(self, target):
1341
1278
        if not getattr(self._format, 'supports_reference_locations', False):
1378
1315
        # TODO: We should probably also check that self.revision_history
1379
1316
        # matches the repository for older branch formats.
1380
1317
        # If looking for the code that cross-checks repository parents against
1381
 
        # the Graph.iter_lefthand_ancestry output, that is now a repository
 
1318
        # the iter_reverse_revision_history output, that is now a repository
1382
1319
        # specific check.
1383
1320
        return result
1384
1321
 
1385
 
    def _get_checkout_format(self, lightweight=False):
 
1322
    def _get_checkout_format(self):
1386
1323
        """Return the most suitable metadir for a checkout of this branch.
1387
1324
        Weaves are used if this branch's repository uses weaves.
1388
1325
        """
1389
 
        format = self.repository.bzrdir.checkout_metadir()
1390
 
        format.set_branch_format(self._format)
 
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)
1391
1333
        return format
1392
1334
 
1393
1335
    def create_clone_on_transport(self, to_transport, revision_id=None,
1394
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1395
 
        no_tree=None):
 
1336
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1396
1337
        """Create a clone of this branch and its bzrdir.
1397
1338
 
1398
1339
        :param to_transport: The transport to clone onto.
1405
1346
        """
1406
1347
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1407
1348
        # clone call. Or something. 20090224 RBC/spiv.
1408
 
        # XXX: Should this perhaps clone colocated branches as well, 
1409
 
        # rather than just the default branch? 20100319 JRV
1410
1349
        if revision_id is None:
1411
1350
            revision_id = self.last_revision()
1412
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1413
1352
            revision_id=revision_id, stacked_on=stacked_on,
1414
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1415
 
            no_tree=no_tree)
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1416
1354
        return dir_to.open_branch()
1417
1355
 
1418
1356
    def create_checkout(self, to_location, revision_id=None,
1423
1361
        :param to_location: The url to produce the checkout at
1424
1362
        :param revision_id: The revision to check out
1425
1363
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1426
 
            produce a bound branch (heavyweight checkout)
 
1364
        produce a bound branch (heavyweight checkout)
1427
1365
        :param accelerator_tree: A tree which can be used for retrieving file
1428
1366
            contents more quickly than the revision tree, i.e. a workingtree.
1429
1367
            The revision tree will be used for cases where accelerator_tree's
1434
1372
        """
1435
1373
        t = transport.get_transport(to_location)
1436
1374
        t.ensure_base()
1437
 
        format = self._get_checkout_format(lightweight=lightweight)
1438
 
        try:
 
1375
        if lightweight:
 
1376
            format = self._get_checkout_format()
1439
1377
            checkout = format.initialize_on_transport(t)
1440
 
        except errors.AlreadyControlDirError:
1441
 
            # It's fine if the control directory already exists,
1442
 
            # as long as there is no existing branch and working tree.
1443
 
            checkout = controldir.ControlDir.open_from_transport(t)
1444
 
            try:
1445
 
                checkout.open_branch()
1446
 
            except errors.NotBranchError:
1447
 
                pass
1448
 
            else:
1449
 
                raise errors.AlreadyControlDirError(t.base)
1450
 
            if checkout.control_transport.base == self.bzrdir.control_transport.base:
1451
 
                # When checking out to the same control directory,
1452
 
                # always create a lightweight checkout
1453
 
                lightweight = True
1454
 
 
1455
 
        if lightweight:
1456
 
            from_branch = checkout.set_branch_reference(target_branch=self)
 
1378
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1379
                target_branch=self)
1457
1380
        else:
1458
 
            policy = checkout.determine_repository_policy()
1459
 
            repo = policy.acquire_repository()[0]
1460
 
            checkout_branch = checkout.create_branch()
 
1381
            format = self._get_checkout_format()
 
1382
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
 
1383
                to_location, force_new_tree=False, format=format)
 
1384
            checkout = checkout_branch.bzrdir
1461
1385
            checkout_branch.bind(self)
1462
1386
            # pull up to the specified revision_id to set the initial
1463
1387
            # branch tip correctly, and seed it with history.
1464
1388
            checkout_branch.pull(self, stop_revision=revision_id)
1465
 
            from_branch = None
 
1389
            from_branch=None
1466
1390
        tree = checkout.create_workingtree(revision_id,
1467
1391
                                           from_branch=from_branch,
1468
1392
                                           accelerator_tree=accelerator_tree,
1489
1413
 
1490
1414
    def reference_parent(self, file_id, path, possible_transports=None):
1491
1415
        """Return the parent branch for a tree-reference file_id
1492
 
 
1493
1416
        :param file_id: The file_id of the tree reference
1494
1417
        :param path: The path of the file_id in the tree
1495
1418
        :return: A branch associated with the file_id
1548
1471
        else:
1549
1472
            raise AssertionError("invalid heads: %r" % (heads,))
1550
1473
 
1551
 
    def heads_to_fetch(self):
1552
 
        """Return the heads that must and that should be fetched to copy this
1553
 
        branch into another repo.
1554
 
 
1555
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1556
 
            set of heads that must be fetched.  if_present_fetch is a set of
1557
 
            heads that must be fetched if present, but no error is necessary if
1558
 
            they are not present.
1559
 
        """
1560
 
        # For bzr native formats must_fetch is just the tip, and
1561
 
        # if_present_fetch are the tags.
1562
 
        must_fetch = set([self.last_revision()])
1563
 
        if_present_fetch = set()
1564
 
        if self.get_config_stack().get('branch.fetch_tags'):
1565
 
            try:
1566
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1567
 
            except errors.TagsNotSupported:
1568
 
                pass
1569
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1570
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1571
 
        return must_fetch, if_present_fetch
1572
 
 
1573
 
 
1574
 
class BranchFormat(controldir.ControlComponentFormat):
 
1474
 
 
1475
class BranchFormat(object):
1575
1476
    """An encapsulation of the initialization and open routines for a format.
1576
1477
 
1577
1478
    Formats provide three things:
1578
1479
     * An initialization routine,
1579
 
     * a format description
 
1480
     * a format string,
1580
1481
     * an open routine.
1581
1482
 
1582
1483
    Formats are placed in an dict by their format string for reference
1583
 
    during branch opening. It's not required that these be instances, they
 
1484
    during branch opening. Its not required that these be instances, they
1584
1485
    can be classes themselves with class methods - it simply depends on
1585
1486
    whether state is needed for a given format or not.
1586
1487
 
1589
1490
    object will be created every time regardless.
1590
1491
    """
1591
1492
 
 
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
 
1592
1501
    def __eq__(self, other):
1593
1502
        return self.__class__ is other.__class__
1594
1503
 
1595
1504
    def __ne__(self, other):
1596
1505
        return not (self == other)
1597
1506
 
1598
 
    def get_reference(self, controldir, name=None):
1599
 
        """Get the target reference of the branch in controldir.
 
1507
    @classmethod
 
1508
    def find_format(klass, a_bzrdir, name=None):
 
1509
        """Return the format for the branch object in a_bzrdir."""
 
1510
        try:
 
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1512
            format_string = transport.get_bytes("format")
 
1513
            return klass._formats[format_string]
 
1514
        except errors.NoSuchFile:
 
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1516
        except KeyError:
 
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
 
1518
 
 
1519
    @classmethod
 
1520
    def get_default_format(klass):
 
1521
        """Return the current default format."""
 
1522
        return klass._default_format
 
1523
 
 
1524
    def get_reference(self, a_bzrdir):
 
1525
        """Get the target reference of the branch in a_bzrdir.
1600
1526
 
1601
1527
        format probing must have been completed before calling
1602
1528
        this method - it is assumed that the format of the branch
1603
 
        in controldir is correct.
 
1529
        in a_bzrdir is correct.
1604
1530
 
1605
 
        :param controldir: The controldir to get the branch data from.
1606
 
        :param name: Name of the colocated branch to fetch
 
1531
        :param a_bzrdir: The bzrdir to get the branch data from.
1607
1532
        :return: None if the branch is not a reference branch.
1608
1533
        """
1609
1534
        return None
1610
1535
 
1611
1536
    @classmethod
1612
 
    def set_reference(self, controldir, name, to_branch):
1613
 
        """Set the target reference of the branch in controldir.
 
1537
    def set_reference(self, a_bzrdir, to_branch):
 
1538
        """Set the target reference of the branch in a_bzrdir.
1614
1539
 
1615
1540
        format probing must have been completed before calling
1616
1541
        this method - it is assumed that the format of the branch
1617
 
        in controldir is correct.
 
1542
        in a_bzrdir is correct.
1618
1543
 
1619
 
        :param controldir: The controldir to set the branch reference for.
1620
 
        :param name: Name of colocated branch to set, None for default
 
1544
        :param a_bzrdir: The bzrdir to set the branch reference for.
1621
1545
        :param to_branch: branch that the checkout is to reference
1622
1546
        """
1623
1547
        raise NotImplementedError(self.set_reference)
1624
1548
 
 
1549
    def get_format_string(self):
 
1550
        """Return the ASCII format string that identifies this format."""
 
1551
        raise NotImplementedError(self.get_format_string)
 
1552
 
1625
1553
    def get_format_description(self):
1626
1554
        """Return the short format description for this format."""
1627
1555
        raise NotImplementedError(self.get_format_description)
1628
1556
 
1629
 
    def _run_post_branch_init_hooks(self, controldir, name, branch):
 
1557
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1630
1558
        hooks = Branch.hooks['post_branch_init']
1631
1559
        if not hooks:
1632
1560
            return
1633
 
        params = BranchInitHookParams(self, controldir, name, branch)
 
1561
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1634
1562
        for hook in hooks:
1635
1563
            hook(params)
1636
1564
 
1637
 
    def initialize(self, controldir, name=None, repository=None,
1638
 
                   append_revisions_only=None):
1639
 
        """Create a branch of this format in controldir.
1640
 
 
 
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
        
1641
1613
        :param name: Name of the colocated branch to create.
1642
1614
        """
1643
1615
        raise NotImplementedError(self.initialize)
1663
1635
        Note that it is normal for branch to be a RemoteBranch when using tags
1664
1636
        on a RemoteBranch.
1665
1637
        """
1666
 
        return _mod_tag.DisabledTags(branch)
 
1638
        return DisabledTags(branch)
1667
1639
 
1668
1640
    def network_name(self):
1669
1641
        """A simple byte string uniquely identifying this format for RPC calls.
1675
1647
        """
1676
1648
        raise NotImplementedError(self.network_name)
1677
1649
 
1678
 
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
1679
 
            found_repository=None, possible_transports=None):
1680
 
        """Return the branch object for controldir.
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1651
        """Return the branch object for a_bzrdir
1681
1652
 
1682
 
        :param controldir: A ControlDir that contains a branch.
 
1653
        :param a_bzrdir: A BzrDir that contains a branch.
1683
1654
        :param name: Name of colocated branch to open
1684
1655
        :param _found: a private parameter, do not use it. It is used to
1685
1656
            indicate if format probing has already be done.
1688
1659
        """
1689
1660
        raise NotImplementedError(self.open)
1690
1661
 
 
1662
    @classmethod
 
1663
    def register_format(klass, format):
 
1664
        """Register a metadir format."""
 
1665
        klass._formats[format.get_format_string()] = format
 
1666
        # Metadir formats have a network name of their format string, and get
 
1667
        # registered as class factories.
 
1668
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1669
 
 
1670
    @classmethod
 
1671
    def set_default_format(klass, format):
 
1672
        klass._default_format = format
 
1673
 
1691
1674
    def supports_set_append_revisions_only(self):
1692
1675
        """True if this format supports set_append_revisions_only."""
1693
1676
        return False
1696
1679
        """True if this format records a stacked-on branch."""
1697
1680
        return False
1698
1681
 
1699
 
    def supports_leaving_lock(self):
1700
 
        """True if this format supports leaving locks in place."""
1701
 
        return False # by default
 
1682
    @classmethod
 
1683
    def unregister_format(klass, format):
 
1684
        del klass._formats[format.get_format_string()]
1702
1685
 
1703
1686
    def __str__(self):
1704
1687
        return self.get_format_description().rstrip()
1707
1690
        """True if this format supports tags stored in the branch"""
1708
1691
        return False  # by default
1709
1692
 
1710
 
    def tags_are_versioned(self):
1711
 
        """Whether the tag container for this branch versions tags."""
1712
 
        return False
1713
 
 
1714
 
    def supports_tags_referencing_ghosts(self):
1715
 
        """True if tags can reference ghost revisions."""
1716
 
        return True
1717
 
 
1718
 
 
1719
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1720
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1721
 
    
1722
 
    While none of the built in BranchFormats are lazy registered yet,
1723
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1724
 
    use it, and the bzr-loom plugin uses it as well (see
1725
 
    bzrlib.plugins.loom.formats).
1726
 
    """
1727
 
 
1728
 
    def __init__(self, format_string, module_name, member_name):
1729
 
        """Create a MetaDirBranchFormatFactory.
1730
 
 
1731
 
        :param format_string: The format string the format has.
1732
 
        :param module_name: Module to load the format class from.
1733
 
        :param member_name: Attribute name within the module for the format class.
1734
 
        """
1735
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1736
 
        self._format_string = format_string
1737
 
 
1738
 
    def get_format_string(self):
1739
 
        """See BranchFormat.get_format_string."""
1740
 
        return self._format_string
1741
 
 
1742
 
    def __call__(self):
1743
 
        """Used for network_format_registry support."""
1744
 
        return self.get_obj()()
1745
 
 
1746
1693
 
1747
1694
class BranchHooks(Hooks):
1748
1695
    """A dictionary mapping hook name to a list of callables for branch hooks.
1749
1696
 
1750
 
    e.g. ['post_push'] Is the list of items to be called when the
1751
 
    push function is invoked.
 
1697
    e.g. ['set_rh'] Is the list of items to be called when the
 
1698
    set_revision_history function is invoked.
1752
1699
    """
1753
1700
 
1754
1701
    def __init__(self):
1757
1704
        These are all empty initially, because by default nothing should get
1758
1705
        notified.
1759
1706
        """
1760
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1761
 
        self.add_hook('open',
 
1707
        Hooks.__init__(self)
 
1708
        self.create_hook(HookPoint('set_rh',
 
1709
            "Invoked whenever the revision history has been set via "
 
1710
            "set_revision_history. The api signature is (branch, "
 
1711
            "revision_history), and the branch will be write-locked. "
 
1712
            "The set_rh hook can be expensive for bzr to trigger, a better "
 
1713
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1714
        self.create_hook(HookPoint('open',
1762
1715
            "Called with the Branch object that has been opened after a "
1763
 
            "branch is opened.", (1, 8))
1764
 
        self.add_hook('post_push',
 
1716
            "branch is opened.", (1, 8), None))
 
1717
        self.create_hook(HookPoint('post_push',
1765
1718
            "Called after a push operation completes. post_push is called "
1766
1719
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1767
 
            "bzr client.", (0, 15))
1768
 
        self.add_hook('post_pull',
 
1720
            "bzr client.", (0, 15), None))
 
1721
        self.create_hook(HookPoint('post_pull',
1769
1722
            "Called after a pull operation completes. post_pull is called "
1770
1723
            "with a bzrlib.branch.PullResult object and only runs in the "
1771
 
            "bzr client.", (0, 15))
1772
 
        self.add_hook('pre_commit',
1773
 
            "Called after a commit is calculated but before it is "
 
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 "
1774
1727
            "completed. pre_commit is called with (local, master, old_revno, "
1775
1728
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1776
1729
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1778
1731
            "basis revision. hooks MUST NOT modify this delta. "
1779
1732
            " future_tree is an in-memory tree obtained from "
1780
1733
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1781
 
            "tree.", (0,91))
1782
 
        self.add_hook('post_commit',
 
1734
            "tree.", (0,91), None))
 
1735
        self.create_hook(HookPoint('post_commit',
1783
1736
            "Called in the bzr client after a commit has completed. "
1784
1737
            "post_commit is called with (local, master, old_revno, old_revid, "
1785
1738
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1786
 
            "commit to a branch.", (0, 15))
1787
 
        self.add_hook('post_uncommit',
 
1739
            "commit to a branch.", (0, 15), None))
 
1740
        self.create_hook(HookPoint('post_uncommit',
1788
1741
            "Called in the bzr client after an uncommit completes. "
1789
1742
            "post_uncommit is called with (local, master, old_revno, "
1790
1743
            "old_revid, new_revno, new_revid) where local is the local branch "
1791
1744
            "or None, master is the target branch, and an empty branch "
1792
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1793
 
        self.add_hook('pre_change_branch_tip',
 
1745
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1746
        self.create_hook(HookPoint('pre_change_branch_tip',
1794
1747
            "Called in bzr client and server before a change to the tip of a "
1795
1748
            "branch is made. pre_change_branch_tip is called with a "
1796
1749
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1797
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1798
 
        self.add_hook('post_change_branch_tip',
 
1750
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1751
        self.create_hook(HookPoint('post_change_branch_tip',
1799
1752
            "Called in bzr client and server after a change to the tip of a "
1800
1753
            "branch is made. post_change_branch_tip is called with a "
1801
1754
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1802
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1803
 
        self.add_hook('transform_fallback_location',
 
1755
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1756
        self.create_hook(HookPoint('transform_fallback_location',
1804
1757
            "Called when a stacked branch is activating its fallback "
1805
1758
            "locations. transform_fallback_location is called with (branch, "
1806
1759
            "url), and should return a new url. Returning the same url "
1811
1764
            "fallback locations have not been activated. When there are "
1812
1765
            "multiple hooks installed for transform_fallback_location, "
1813
1766
            "all are called with the url returned from the previous hook."
1814
 
            "The order is however undefined.", (1, 9))
1815
 
        self.add_hook('automatic_tag_name',
1816
 
            "Called to determine an automatic tag name for a revision. "
 
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."
1817
1770
            "automatic_tag_name is called with (branch, revision_id) and "
1818
1771
            "should return a tag name or None if no tag name could be "
1819
1772
            "determined. The first non-None tag name returned will be used.",
1820
 
            (2, 2))
1821
 
        self.add_hook('post_branch_init',
 
1773
            (2, 2), None))
 
1774
        self.create_hook(HookPoint('post_branch_init',
1822
1775
            "Called after new branch initialization completes. "
1823
1776
            "post_branch_init is called with a "
1824
1777
            "bzrlib.branch.BranchInitHookParams. "
1825
1778
            "Note that init, branch and checkout (both heavyweight and "
1826
 
            "lightweight) will all trigger this hook.", (2, 2))
1827
 
        self.add_hook('post_switch',
 
1779
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1780
        self.create_hook(HookPoint('post_switch',
1828
1781
            "Called after a checkout switches branch. "
1829
1782
            "post_switch is called with a "
1830
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1783
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1831
1784
 
1832
1785
 
1833
1786
 
1836
1789
 
1837
1790
 
1838
1791
class ChangeBranchTipParams(object):
1839
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1792
    """Object holding parameters passed to *_change_branch_tip hooks.
1840
1793
 
1841
1794
    There are 5 fields that hooks may wish to access:
1842
1795
 
1874
1827
 
1875
1828
 
1876
1829
class BranchInitHookParams(object):
1877
 
    """Object holding parameters passed to `*_branch_init` hooks.
 
1830
    """Object holding parameters passed to *_branch_init hooks.
1878
1831
 
1879
1832
    There are 4 fields that hooks may wish to access:
1880
1833
 
1881
1834
    :ivar format: the branch format
1882
 
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
 
1835
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1883
1836
    :ivar name: name of colocated branch, if any (or None)
1884
1837
    :ivar branch: the branch created
1885
1838
 
1888
1841
    branch, which refer to the original branch.
1889
1842
    """
1890
1843
 
1891
 
    def __init__(self, format, controldir, name, branch):
 
1844
    def __init__(self, format, a_bzrdir, name, branch):
1892
1845
        """Create a group of BranchInitHook parameters.
1893
1846
 
1894
1847
        :param format: the branch format
1895
 
        :param controldir: the ControlDir where the branch will be/has been
 
1848
        :param a_bzrdir: the BzrDir where the branch will be/has been
1896
1849
            initialized
1897
1850
        :param name: name of colocated branch, if any (or None)
1898
1851
        :param branch: the branch created
1902
1855
        in branch, which refer to the original branch.
1903
1856
        """
1904
1857
        self.format = format
1905
 
        self.bzrdir = controldir
 
1858
        self.bzrdir = a_bzrdir
1906
1859
        self.name = name
1907
1860
        self.branch = branch
1908
1861
 
1910
1863
        return self.__dict__ == other.__dict__
1911
1864
 
1912
1865
    def __repr__(self):
1913
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
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)
1914
1872
 
1915
1873
 
1916
1874
class SwitchHookParams(object):
1917
 
    """Object holding parameters passed to `*_switch` hooks.
 
1875
    """Object holding parameters passed to *_switch hooks.
1918
1876
 
1919
1877
    There are 4 fields that hooks may wish to access:
1920
1878
 
1921
 
    :ivar control_dir: ControlDir of the checkout to change
 
1879
    :ivar control_dir: BzrDir of the checkout to change
1922
1880
    :ivar to_branch: branch that the checkout is to reference
1923
1881
    :ivar force: skip the check for local commits in a heavy checkout
1924
1882
    :ivar revision_id: revision ID to switch to (or None)
1927
1885
    def __init__(self, control_dir, to_branch, force, revision_id):
1928
1886
        """Create a group of SwitchHook parameters.
1929
1887
 
1930
 
        :param control_dir: ControlDir of the checkout to change
 
1888
        :param control_dir: BzrDir of the checkout to change
1931
1889
        :param to_branch: branch that the checkout is to reference
1932
1890
        :param force: skip the check for local commits in a heavy checkout
1933
1891
        :param revision_id: revision ID to switch to (or None)
1946
1904
            self.revision_id)
1947
1905
 
1948
1906
 
1949
 
class BranchFormatMetadir(bzrdir.BzrFormat, BranchFormat):
1950
 
    """Base class for branch formats that live in meta directories.
 
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 ]
1951
1913
    """
1952
1914
 
 
1915
    def get_format_description(self):
 
1916
        """See BranchFormat.get_format_description()."""
 
1917
        return "Branch format 4"
 
1918
 
 
1919
    def initialize(self, a_bzrdir, name=None):
 
1920
        """Create a branch of this format in a_bzrdir."""
 
1921
        utf8_files = [('revision-history', ''),
 
1922
                      ('branch-name', ''),
 
1923
                      ]
 
1924
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1925
                                       lock_type='branch4', set_format=False)
 
1926
 
1953
1927
    def __init__(self):
1954
 
        BranchFormat.__init__(self)
1955
 
        bzrdir.BzrFormat.__init__(self)
1956
 
 
1957
 
    @classmethod
1958
 
    def find_format(klass, controldir, name=None):
1959
 
        """Return the format for the branch object in controldir."""
1960
 
        try:
1961
 
            transport = controldir.get_branch_transport(None, name=name)
1962
 
        except errors.NoSuchFile:
1963
 
            raise errors.NotBranchError(path=name, bzrdir=controldir)
1964
 
        try:
1965
 
            format_string = transport.get_bytes("format")
1966
 
        except errors.NoSuchFile:
1967
 
            raise errors.NotBranchError(path=transport.base, bzrdir=controldir)
1968
 
        return klass._find_format(format_registry, 'branch', format_string)
 
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."""
1969
1952
 
1970
1953
    def _branch_class(self):
1971
1954
        """What class to instantiate on open calls."""
1972
1955
        raise NotImplementedError(self._branch_class)
1973
1956
 
1974
 
    def _get_initial_config(self, append_revisions_only=None):
1975
 
        if append_revisions_only:
1976
 
            return "append_revisions_only = True\n"
1977
 
        else:
1978
 
            # Avoid writing anything if append_revisions_only is disabled,
1979
 
            # as that is the default.
1980
 
            return ""
1981
 
 
1982
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1983
 
                           repository=None):
1984
 
        """Initialize a branch in a control dir, with specified files
1985
 
 
1986
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1987
 
        :param utf8_files: The files to create as a list of
1988
 
            (filename, content) tuples
1989
 
        :param name: Name of colocated branch to create, if any
1990
 
        :return: a branch in this format
 
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.
1991
1961
        """
1992
 
        if name is None:
1993
 
            name = a_bzrdir._get_selected_branch()
1994
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1995
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1996
 
        control_files = lockable_files.LockableFiles(branch_transport,
1997
 
            'lock', lockdir.LockDir)
1998
 
        control_files.create_lock()
1999
 
        control_files.lock_write()
2000
 
        try:
2001
 
            utf8_files += [('format', self.as_string())]
2002
 
            for (filename, content) in utf8_files:
2003
 
                branch_transport.put_bytes(
2004
 
                    filename, content,
2005
 
                    mode=a_bzrdir._get_file_mode())
2006
 
        finally:
2007
 
            control_files.unlock()
2008
 
        branch = self.open(a_bzrdir, name, _found=True,
2009
 
                found_repository=repository)
2010
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2011
 
        return branch
 
1962
        return self.get_format_string()
2012
1963
 
2013
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2014
 
            found_repository=None, possible_transports=None):
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2015
1965
        """See BranchFormat.open()."""
2016
 
        if name is None:
2017
 
            name = a_bzrdir._get_selected_branch()
2018
1966
        if not _found:
2019
 
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
2020
1968
            if format.__class__ != self.__class__:
2021
1969
                raise AssertionError("wrong format %r found for %r" %
2022
1970
                    (format, self))
2024
1972
        try:
2025
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
2026
1974
                                                         lockdir.LockDir)
2027
 
            if found_repository is None:
2028
 
                found_repository = a_bzrdir.find_repository()
2029
1975
            return self._branch_class()(_format=self,
2030
1976
                              _control_files=control_files,
2031
1977
                              name=name,
2032
1978
                              a_bzrdir=a_bzrdir,
2033
 
                              _repository=found_repository,
2034
 
                              ignore_fallbacks=ignore_fallbacks,
2035
 
                              possible_transports=possible_transports)
 
1979
                              _repository=a_bzrdir.find_repository(),
 
1980
                              ignore_fallbacks=ignore_fallbacks)
2036
1981
        except errors.NoSuchFile:
2037
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2038
1983
 
2039
 
    @property
2040
 
    def _matchingbzrdir(self):
2041
 
        ret = bzrdir.BzrDirMetaFormat1()
2042
 
        ret.set_branch_format(self)
2043
 
        return ret
2044
 
 
2045
 
    def supports_tags(self):
2046
 
        return True
2047
 
 
2048
 
    def supports_leaving_lock(self):
2049
 
        return True
2050
 
 
2051
 
    def check_support_status(self, allow_unsupported, recommend_upgrade=True,
2052
 
            basedir=None):
2053
 
        BranchFormat.check_support_status(self,
2054
 
            allow_unsupported=allow_unsupported, recommend_upgrade=recommend_upgrade,
2055
 
            basedir=basedir)
2056
 
        bzrdir.BzrFormat.check_support_status(self, allow_unsupported=allow_unsupported,
2057
 
            recommend_upgrade=recommend_upgrade, basedir=basedir)
 
1984
    def __init__(self):
 
1985
        super(BranchFormatMetadir, self).__init__()
 
1986
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
1987
        self._matchingbzrdir.set_branch_format(self)
 
1988
 
 
1989
    def supports_tags(self):
 
1990
        return True
 
1991
 
 
1992
 
 
1993
class BzrBranchFormat5(BranchFormatMetadir):
 
1994
    """Bzr branch format 5.
 
1995
 
 
1996
    This format has:
 
1997
     - a revision-history file.
 
1998
     - a format string
 
1999
     - a lock dir guarding the branch itself
 
2000
     - all of this stored in a branch/ subdirectory
 
2001
     - works with shared repositories.
 
2002
 
 
2003
    This format is new in bzr 0.8.
 
2004
    """
 
2005
 
 
2006
    def _branch_class(self):
 
2007
        return BzrBranch5
 
2008
 
 
2009
    def get_format_string(self):
 
2010
        """See BranchFormat.get_format_string()."""
 
2011
        return "Bazaar-NG branch format 5\n"
 
2012
 
 
2013
    def get_format_description(self):
 
2014
        """See BranchFormat.get_format_description()."""
 
2015
        return "Branch format 5"
 
2016
 
 
2017
    def initialize(self, a_bzrdir, name=None):
 
2018
        """Create a branch of this format in a_bzrdir."""
 
2019
        utf8_files = [('revision-history', ''),
 
2020
                      ('branch-name', ''),
 
2021
                      ]
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2023
 
 
2024
    def supports_tags(self):
 
2025
        return False
2058
2026
 
2059
2027
 
2060
2028
class BzrBranchFormat6(BranchFormatMetadir):
2071
2039
    def _branch_class(self):
2072
2040
        return BzrBranch6
2073
2041
 
2074
 
    @classmethod
2075
 
    def get_format_string(cls):
 
2042
    def get_format_string(self):
2076
2043
        """See BranchFormat.get_format_string()."""
2077
2044
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2078
2045
 
2080
2047
        """See BranchFormat.get_format_description()."""
2081
2048
        return "Branch format 6"
2082
2049
 
2083
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2084
 
                   append_revisions_only=None):
 
2050
    def initialize(self, a_bzrdir, name=None):
2085
2051
        """Create a branch of this format in a_bzrdir."""
2086
2052
        utf8_files = [('last-revision', '0 null:\n'),
2087
 
                      ('branch.conf',
2088
 
                          self._get_initial_config(append_revisions_only)),
 
2053
                      ('branch.conf', ''),
2089
2054
                      ('tags', ''),
2090
2055
                      ]
2091
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2092
2057
 
2093
2058
    def make_tags(self, branch):
2094
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
2095
 
        return _mod_tag.BasicTags(branch)
 
2060
        return BasicTags(branch)
2096
2061
 
2097
2062
    def supports_set_append_revisions_only(self):
2098
2063
        return True
2104
2069
    def _branch_class(self):
2105
2070
        return BzrBranch8
2106
2071
 
2107
 
    @classmethod
2108
 
    def get_format_string(cls):
 
2072
    def get_format_string(self):
2109
2073
        """See BranchFormat.get_format_string()."""
2110
2074
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2111
2075
 
2113
2077
        """See BranchFormat.get_format_description()."""
2114
2078
        return "Branch format 8"
2115
2079
 
2116
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2117
 
                   append_revisions_only=None):
 
2080
    def initialize(self, a_bzrdir, name=None):
2118
2081
        """Create a branch of this format in a_bzrdir."""
2119
2082
        utf8_files = [('last-revision', '0 null:\n'),
2120
 
                      ('branch.conf',
2121
 
                          self._get_initial_config(append_revisions_only)),
 
2083
                      ('branch.conf', ''),
2122
2084
                      ('tags', ''),
2123
2085
                      ('references', '')
2124
2086
                      ]
2125
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
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()
2126
2093
 
2127
2094
    def make_tags(self, branch):
2128
2095
        """See bzrlib.branch.BranchFormat.make_tags()."""
2129
 
        return _mod_tag.BasicTags(branch)
 
2096
        return BasicTags(branch)
2130
2097
 
2131
2098
    def supports_set_append_revisions_only(self):
2132
2099
        return True
2137
2104
    supports_reference_locations = True
2138
2105
 
2139
2106
 
2140
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2107
class BzrBranchFormat7(BzrBranchFormat8):
2141
2108
    """Branch format with last-revision, tags, and a stacked location pointer.
2142
2109
 
2143
2110
    The stacked location pointer is passed down to the repository and requires
2146
2113
    This format was introduced in bzr 1.6.
2147
2114
    """
2148
2115
 
2149
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2150
 
                   append_revisions_only=None):
 
2116
    def initialize(self, a_bzrdir, name=None):
2151
2117
        """Create a branch of this format in a_bzrdir."""
2152
2118
        utf8_files = [('last-revision', '0 null:\n'),
2153
 
                      ('branch.conf',
2154
 
                          self._get_initial_config(append_revisions_only)),
 
2119
                      ('branch.conf', ''),
2155
2120
                      ('tags', ''),
2156
2121
                      ]
2157
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2158
2123
 
2159
2124
    def _branch_class(self):
2160
2125
        return BzrBranch7
2161
2126
 
2162
 
    @classmethod
2163
 
    def get_format_string(cls):
 
2127
    def get_format_string(self):
2164
2128
        """See BranchFormat.get_format_string()."""
2165
2129
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2166
2130
 
2171
2135
    def supports_set_append_revisions_only(self):
2172
2136
        return True
2173
2137
 
2174
 
    def supports_stacking(self):
2175
 
        return True
2176
 
 
2177
 
    def make_tags(self, branch):
2178
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2179
 
        return _mod_tag.BasicTags(branch)
2180
 
 
2181
2138
    supports_reference_locations = False
2182
2139
 
2183
2140
 
2184
 
class BranchReferenceFormat(BranchFormatMetadir):
 
2141
class BranchReferenceFormat(BranchFormat):
2185
2142
    """Bzr branch reference format.
2186
2143
 
2187
2144
    Branch references are used in implementing checkouts, they
2192
2149
     - a format string
2193
2150
    """
2194
2151
 
2195
 
    @classmethod
2196
 
    def get_format_string(cls):
 
2152
    def get_format_string(self):
2197
2153
        """See BranchFormat.get_format_string()."""
2198
2154
        return "Bazaar-NG Branch Reference Format 1\n"
2199
2155
 
2201
2157
        """See BranchFormat.get_format_description()."""
2202
2158
        return "Checkout reference format 1"
2203
2159
 
2204
 
    def get_reference(self, a_bzrdir, name=None):
 
2160
    def get_reference(self, a_bzrdir):
2205
2161
        """See BranchFormat.get_reference()."""
2206
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2162
        transport = a_bzrdir.get_branch_transport(None)
2207
2163
        return transport.get_bytes('location')
2208
2164
 
2209
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
2165
    def set_reference(self, a_bzrdir, to_branch):
2210
2166
        """See BranchFormat.set_reference()."""
2211
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
2167
        transport = a_bzrdir.get_branch_transport(None)
2212
2168
        location = transport.put_bytes('location', to_branch.base)
2213
2169
 
2214
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2215
 
            repository=None, append_revisions_only=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2216
2171
        """Create a branch of this format in a_bzrdir."""
2217
2172
        if target_branch is None:
2218
2173
            # this format does not implement branch itself, thus the implicit
2219
2174
            # creation contract must see it as uninitializable
2220
2175
            raise errors.UninitializableFormat(self)
2221
2176
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2222
 
        if a_bzrdir._format.fixed_components:
2223
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2224
 
        if name is None:
2225
 
            name = a_bzrdir._get_selected_branch()
2226
2177
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2227
2178
        branch_transport.put_bytes('location',
2228
 
            target_branch.user_url)
2229
 
        branch_transport.put_bytes('format', self.as_string())
2230
 
        branch = self.open(a_bzrdir, name, _found=True,
 
2179
            target_branch.bzrdir.user_url)
 
2180
        branch_transport.put_bytes('format', self.get_format_string())
 
2181
        branch = self.open(
 
2182
            a_bzrdir, name, _found=True,
2231
2183
            possible_transports=[target_branch.bzrdir.root_transport])
2232
2184
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2233
2185
        return branch
2234
2186
 
 
2187
    def __init__(self):
 
2188
        super(BranchReferenceFormat, self).__init__()
 
2189
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
 
2190
        self._matchingbzrdir.set_branch_format(self)
 
2191
 
2235
2192
    def _make_reference_clone_function(format, a_branch):
2236
2193
        """Create a clone() routine for a branch dynamically."""
2237
2194
        def clone(to_bzrdir, revision_id=None,
2244
2201
        return clone
2245
2202
 
2246
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2247
 
             possible_transports=None, ignore_fallbacks=False,
2248
 
             found_repository=None):
 
2204
             possible_transports=None, ignore_fallbacks=False):
2249
2205
        """Return the branch that the branch reference in a_bzrdir points at.
2250
2206
 
2251
2207
        :param a_bzrdir: A BzrDir that contains a branch.
2259
2215
            a_bzrdir.
2260
2216
        :param possible_transports: An optional reusable transports list.
2261
2217
        """
2262
 
        if name is None:
2263
 
            name = a_bzrdir._get_selected_branch()
2264
2218
        if not _found:
2265
 
            format = BranchFormatMetadir.find_format(a_bzrdir, name=name)
 
2219
            format = BranchFormat.find_format(a_bzrdir, name=name)
2266
2220
            if format.__class__ != self.__class__:
2267
2221
                raise AssertionError("wrong format %r found for %r" %
2268
2222
                    (format, self))
2269
2223
        if location is None:
2270
 
            location = self.get_reference(a_bzrdir, name)
2271
 
        real_bzrdir = controldir.ControlDir.open(
 
2224
            location = self.get_reference(a_bzrdir)
 
2225
        real_bzrdir = bzrdir.BzrDir.open(
2272
2226
            location, possible_transports=possible_transports)
2273
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks,
2274
 
            possible_transports=possible_transports)
 
2227
        result = real_bzrdir.open_branch(name=name, 
 
2228
            ignore_fallbacks=ignore_fallbacks)
2275
2229
        # this changes the behaviour of result.clone to create a new reference
2276
2230
        # rather than a copy of the content of the branch.
2277
2231
        # I did not use a proxy object because that needs much more extensive
2284
2238
        return result
2285
2239
 
2286
2240
 
2287
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2288
 
    """Branch format registry."""
2289
 
 
2290
 
    def __init__(self, other_registry=None):
2291
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2292
 
        self._default_format = None
2293
 
 
2294
 
    def set_default(self, format):
2295
 
        self._default_format = format
2296
 
 
2297
 
    def get_default(self):
2298
 
        return self._default_format
2299
 
 
2300
 
 
2301
2241
network_format_registry = registry.FormatRegistry()
2302
2242
"""Registry of formats indexed by their network name.
2303
2243
 
2306
2246
BranchFormat.network_name() for more detail.
2307
2247
"""
2308
2248
 
2309
 
format_registry = BranchFormatRegistry(network_format_registry)
2310
 
 
2311
2249
 
2312
2250
# formats which have no format string are not discoverable
2313
2251
# and not independently creatable, so are not registered.
 
2252
__format5 = BzrBranchFormat5()
2314
2253
__format6 = BzrBranchFormat6()
2315
2254
__format7 = BzrBranchFormat7()
2316
2255
__format8 = BzrBranchFormat8()
2317
 
format_registry.register_lazy(
2318
 
    "Bazaar-NG branch format 5\n", "bzrlib.branchfmt.fullhistory", "BzrBranchFormat5")
2319
 
format_registry.register(BranchReferenceFormat())
2320
 
format_registry.register(__format6)
2321
 
format_registry.register(__format7)
2322
 
format_registry.register(__format8)
2323
 
format_registry.set_default(__format7)
2324
 
 
2325
 
 
2326
 
class BranchWriteLockResult(LogicalLockResult):
2327
 
    """The result of write locking a branch.
2328
 
 
2329
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2330
 
        None.
2331
 
    :ivar unlock: A callable which will unlock the lock.
2332
 
    """
2333
 
 
2334
 
    def __init__(self, unlock, branch_token):
2335
 
        LogicalLockResult.__init__(self, unlock)
2336
 
        self.branch_token = branch_token
2337
 
 
2338
 
    def __repr__(self):
2339
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2340
 
            self.unlock)
 
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__)
2341
2266
 
2342
2267
 
2343
2268
class BzrBranch(Branch, _RelockDebugMixin):
2358
2283
 
2359
2284
    def __init__(self, _format=None,
2360
2285
                 _control_files=None, a_bzrdir=None, name=None,
2361
 
                 _repository=None, ignore_fallbacks=False,
2362
 
                 possible_transports=None):
 
2286
                 _repository=None, ignore_fallbacks=False):
2363
2287
        """Create new branch object at a particular location."""
2364
2288
        if a_bzrdir is None:
2365
2289
            raise ValueError('a_bzrdir must be supplied')
2366
 
        if name is None:
2367
 
            raise ValueError('name must be supplied')
2368
 
        self.bzrdir = a_bzrdir
2369
 
        self._user_transport = self.bzrdir.transport.clone('..')
2370
 
        if name != "":
2371
 
            self._user_transport.set_segment_parameter(
2372
 
                "branch", urlutils.escape(name))
2373
 
        self._base = self._user_transport.base
 
2290
        else:
 
2291
            self.bzrdir = a_bzrdir
 
2292
        self._base = self.bzrdir.transport.clone('..').base
2374
2293
        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
2375
2297
        self._format = _format
2376
2298
        if _control_files is None:
2377
2299
            raise ValueError('BzrBranch _control_files is None')
2378
2300
        self.control_files = _control_files
2379
2301
        self._transport = _control_files._transport
2380
2302
        self.repository = _repository
2381
 
        self.conf_store = None
2382
 
        Branch.__init__(self, possible_transports)
 
2303
        Branch.__init__(self)
2383
2304
 
2384
2305
    def __str__(self):
2385
 
        return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
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)
2386
2311
 
2387
2312
    __repr__ = __str__
2388
2313
 
2392
2317
 
2393
2318
    base = property(_get_base, doc="The URL for the root of this branch.")
2394
2319
 
2395
 
    @property
2396
 
    def user_transport(self):
2397
 
        return self._user_transport
2398
 
 
2399
2320
    def _get_config(self):
2400
 
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2401
 
 
2402
 
    def _get_config_store(self):
2403
 
        if self.conf_store is None:
2404
 
            self.conf_store =  _mod_config.BranchStore(self)
2405
 
        return self.conf_store
2406
 
 
2407
 
    def _uncommitted_branch(self):
2408
 
        """Return the branch that may contain uncommitted changes."""
2409
 
        master = self.get_master_branch()
2410
 
        if master is not None:
2411
 
            return master
2412
 
        else:
2413
 
            return self
2414
 
 
2415
 
    def store_uncommitted(self, creator):
2416
 
        """Store uncommitted changes from a ShelfCreator.
2417
 
 
2418
 
        :param creator: The ShelfCreator containing uncommitted changes, or
2419
 
            None to delete any stored changes.
2420
 
        :raises: ChangesAlreadyStored if the branch already has changes.
2421
 
        """
2422
 
        branch = self._uncommitted_branch()
2423
 
        if creator is None:
2424
 
            branch._transport.delete('stored-transform')
2425
 
            return
2426
 
        if branch._transport.has('stored-transform'):
2427
 
            raise errors.ChangesAlreadyStored
2428
 
        transform = StringIO()
2429
 
        creator.write_shelf(transform)
2430
 
        transform.seek(0)
2431
 
        branch._transport.put_file('stored-transform', transform)
2432
 
 
2433
 
    def get_unshelver(self, tree):
2434
 
        """Return a shelf.Unshelver for this branch and tree.
2435
 
 
2436
 
        :param tree: The tree to use to construct the Unshelver.
2437
 
        :return: an Unshelver or None if no changes are stored.
2438
 
        """
2439
 
        branch = self._uncommitted_branch()
2440
 
        try:
2441
 
            transform = branch._transport.get('stored-transform')
2442
 
        except errors.NoSuchFile:
2443
 
            return None
2444
 
        return shelf.Unshelver.from_tree_and_shelf(tree, transform)
 
2321
        return TransportConfig(self._transport, 'branch.conf')
2445
2322
 
2446
2323
    def is_locked(self):
2447
2324
        return self.control_files.is_locked()
2448
2325
 
2449
2326
    def lock_write(self, token=None):
2450
 
        """Lock the branch for write operations.
2451
 
 
2452
 
        :param token: A token to permit reacquiring a previously held and
2453
 
            preserved lock.
2454
 
        :return: A BranchWriteLockResult.
2455
 
        """
2456
2327
        if not self.is_locked():
2457
2328
            self._note_lock('w')
 
2329
        # All-in-one needs to always unlock/lock.
 
2330
        repo_control = getattr(self.repository, 'control_files', None)
 
2331
        if self.control_files == repo_control or not self.is_locked():
2458
2332
            self.repository._warn_if_deprecated(self)
2459
2333
            self.repository.lock_write()
2460
2334
            took_lock = True
2461
2335
        else:
2462
2336
            took_lock = False
2463
2337
        try:
2464
 
            return BranchWriteLockResult(self.unlock,
2465
 
                self.control_files.lock_write(token=token))
 
2338
            return self.control_files.lock_write(token=token)
2466
2339
        except:
2467
2340
            if took_lock:
2468
2341
                self.repository.unlock()
2469
2342
            raise
2470
2343
 
2471
2344
    def lock_read(self):
2472
 
        """Lock the branch for read operations.
2473
 
 
2474
 
        :return: A bzrlib.lock.LogicalLockResult.
2475
 
        """
2476
2345
        if not self.is_locked():
2477
2346
            self._note_lock('r')
 
2347
        # All-in-one needs to always unlock/lock.
 
2348
        repo_control = getattr(self.repository, 'control_files', None)
 
2349
        if self.control_files == repo_control or not self.is_locked():
2478
2350
            self.repository._warn_if_deprecated(self)
2479
2351
            self.repository.lock_read()
2480
2352
            took_lock = True
2482
2354
            took_lock = False
2483
2355
        try:
2484
2356
            self.control_files.lock_read()
2485
 
            return LogicalLockResult(self.unlock)
2486
2357
        except:
2487
2358
            if took_lock:
2488
2359
                self.repository.unlock()
2490
2361
 
2491
2362
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2492
2363
    def unlock(self):
2493
 
        if self.control_files._lock_count == 1 and self.conf_store is not None:
2494
 
            self.conf_store.save_changes()
2495
2364
        try:
2496
2365
            self.control_files.unlock()
2497
2366
        finally:
 
2367
            # All-in-one needs to always unlock/lock.
 
2368
            repo_control = getattr(self.repository, 'control_files', None)
 
2369
            if (self.control_files == repo_control or
 
2370
                not self.control_files.is_locked()):
 
2371
                self.repository.unlock()
2498
2372
            if not self.control_files.is_locked():
2499
 
                self.repository.unlock()
2500
2373
                # we just released the lock
2501
2374
                self._clear_cached_state()
2502
2375
 
2514
2387
        """See Branch.print_file."""
2515
2388
        return self.repository.print_file(file, revision_id)
2516
2389
 
 
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
 
2517
2453
    @needs_write_lock
2518
2454
    def set_last_revision_info(self, revno, revision_id):
2519
 
        if not revision_id or not isinstance(revision_id, basestring):
2520
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
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
        """
2521
2465
        revision_id = _mod_revision.ensure_null(revision_id)
2522
 
        old_revno, old_revid = self.last_revision_info()
2523
 
        if self.get_append_revisions_only():
2524
 
            self._check_history_violation(revision_id)
2525
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2526
 
        self._write_last_revision_info(revno, revision_id)
2527
 
        self._clear_cached_state()
2528
 
        self._last_revision_info_cache = revno, revision_id
2529
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
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))
2530
2494
 
2531
2495
    def basis_tree(self):
2532
2496
        """See Branch.basis_tree."""
2541
2505
                pass
2542
2506
        return None
2543
2507
 
 
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
 
2544
2530
    def get_stacked_on_url(self):
2545
2531
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2546
2532
 
2557
2543
            self._transport.put_bytes('parent', url + '\n',
2558
2544
                mode=self.bzrdir._get_file_mode())
2559
2545
 
 
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
 
2560
2580
    @needs_write_lock
2561
 
    def unbind(self):
2562
 
        """If bound, unbind"""
2563
 
        return self.set_bound_location(None)
 
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
2564
2595
 
2565
2596
    @needs_write_lock
2566
2597
    def bind(self, other):
2588
2619
        # history around
2589
2620
        self.set_bound_location(other.base)
2590
2621
 
2591
 
    def get_bound_location(self):
2592
 
        try:
2593
 
            return self._transport.get_bytes('bound')[:-1]
2594
 
        except errors.NoSuchFile:
2595
 
            return None
2596
 
 
2597
 
    @needs_read_lock
2598
 
    def get_master_branch(self, possible_transports=None):
2599
 
        """Return the branch we are bound to.
2600
 
 
2601
 
        :return: Either a Branch, or None
2602
 
        """
2603
 
        if self._master_branch_cache is None:
2604
 
            self._master_branch_cache = self._get_master_branch(
2605
 
                possible_transports)
2606
 
        return self._master_branch_cache
2607
 
 
2608
 
    def _get_master_branch(self, possible_transports):
2609
 
        bound_loc = self.get_bound_location()
2610
 
        if not bound_loc:
2611
 
            return None
2612
 
        try:
2613
 
            return Branch.open(bound_loc,
2614
 
                               possible_transports=possible_transports)
2615
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2616
 
            raise errors.BoundBranchConnectionFailure(
2617
 
                    self, bound_loc, e)
2618
 
 
2619
2622
    @needs_write_lock
2620
 
    def set_bound_location(self, location):
2621
 
        """Set the target where this branch is bound to.
2622
 
 
2623
 
        :param location: URL to the target branch
2624
 
        """
2625
 
        self._master_branch_cache = None
2626
 
        if location:
2627
 
            self._transport.put_bytes('bound', location+'\n',
2628
 
                mode=self.bzrdir._get_file_mode())
2629
 
        else:
2630
 
            try:
2631
 
                self._transport.delete('bound')
2632
 
            except errors.NoSuchFile:
2633
 
                return False
2634
 
            return True
 
2623
    def unbind(self):
 
2624
        """If bound, unbind"""
 
2625
        return self.set_bound_location(None)
2635
2626
 
2636
2627
    @needs_write_lock
2637
2628
    def update(self, possible_transports=None):
2650
2641
            return old_tip
2651
2642
        return None
2652
2643
 
2653
 
    def _read_last_revision_info(self):
2654
 
        revision_string = self._transport.get_bytes('last-revision')
2655
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2656
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2657
 
        revno = int(revno)
2658
 
        return revno, revision_id
2659
 
 
2660
 
    def _write_last_revision_info(self, revno, revision_id):
2661
 
        """Simply write out the revision id, with no checks.
2662
 
 
2663
 
        Use set_last_revision_info to perform this safely.
2664
 
 
2665
 
        Does not update the revision_history cache.
2666
 
        """
2667
 
        revision_id = _mod_revision.ensure_null(revision_id)
2668
 
        out_string = '%d %s\n' % (revno, revision_id)
2669
 
        self._transport.put_bytes('last-revision', out_string,
2670
 
            mode=self.bzrdir._get_file_mode())
2671
 
 
2672
 
    @needs_write_lock
2673
 
    def update_feature_flags(self, updated_flags):
2674
 
        """Update the feature flags for this branch.
2675
 
 
2676
 
        :param updated_flags: Dictionary mapping feature names to necessities
2677
 
            A necessity can be None to indicate the feature should be removed
2678
 
        """
2679
 
        self._format._update_feature_flags(updated_flags)
2680
 
        self.control_transport.put_bytes('format', self._format.as_string())
2681
 
 
2682
 
 
2683
 
class BzrBranch8(BzrBranch):
 
2644
 
 
2645
class BzrBranch8(BzrBranch5):
2684
2646
    """A branch that stores tree-reference locations."""
2685
2647
 
2686
 
    def _open_hook(self, possible_transports=None):
 
2648
    def _open_hook(self):
2687
2649
        if self._ignore_fallbacks:
2688
2650
            return
2689
 
        if possible_transports is None:
2690
 
            possible_transports = [self.bzrdir.root_transport]
2691
2651
        try:
2692
2652
            url = self.get_stacked_on_url()
2693
2653
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2701
2661
                    raise AssertionError(
2702
2662
                        "'transform_fallback_location' hook %s returned "
2703
2663
                        "None, not a URL." % hook_name)
2704
 
            self._activate_fallback_location(url,
2705
 
                possible_transports=possible_transports)
 
2664
            self._activate_fallback_location(url)
2706
2665
 
2707
2666
    def __init__(self, *args, **kwargs):
2708
2667
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2715
2674
        self._last_revision_info_cache = None
2716
2675
        self._reference_info = None
2717
2676
 
 
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
 
2718
2722
    def _check_history_violation(self, revision_id):
2719
 
        current_revid = self.last_revision()
2720
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2723
        last_revision = _mod_revision.ensure_null(self.last_revision())
2721
2724
        if _mod_revision.is_null(last_revision):
2722
2725
            return
2723
 
        graph = self.repository.get_graph()
2724
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2725
 
            if lh_ancestor == current_revid:
2726
 
                return
2727
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2726
        if last_revision not in self._lefthand_history(revision_id):
 
2727
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2728
 
2729
2729
    def _gen_revision_history(self):
2730
2730
        """Generate the revision history from last revision
2733
2733
        self._extend_partial_history(stop_index=last_revno-1)
2734
2734
        return list(reversed(self._partial_revision_history_cache))
2735
2735
 
 
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
 
2736
2752
    @needs_write_lock
2737
2753
    def _set_parent_location(self, url):
2738
2754
        """Set the parent branch"""
2824
2840
 
2825
2841
    def set_bound_location(self, location):
2826
2842
        """See Branch.set_push_location."""
2827
 
        self._master_branch_cache = None
2828
2843
        result = None
2829
 
        conf = self.get_config_stack()
 
2844
        config = self.get_config()
2830
2845
        if location is None:
2831
 
            if not conf.get('bound'):
 
2846
            if config.get_user_option('bound') != 'True':
2832
2847
                return False
2833
2848
            else:
2834
 
                conf.set('bound', 'False')
 
2849
                config.set_user_option('bound', 'False', warn_masked=True)
2835
2850
                return True
2836
2851
        else:
2837
2852
            self._set_config_location('bound_location', location,
2838
 
                                      config=conf)
2839
 
            conf.set('bound', 'True')
 
2853
                                      config=config)
 
2854
            config.set_user_option('bound', 'True', warn_masked=True)
2840
2855
        return True
2841
2856
 
2842
2857
    def _get_bound_location(self, bound):
2843
2858
        """Return the bound location in the config file.
2844
2859
 
2845
2860
        Return None if the bound parameter does not match"""
2846
 
        conf = self.get_config_stack()
2847
 
        if conf.get('bound') != bound:
 
2861
        config = self.get_config()
 
2862
        config_bound = (config.get_user_option('bound') == 'True')
 
2863
        if config_bound != bound:
2848
2864
            return None
2849
 
        return self._get_config_location('bound_location', config=conf)
 
2865
        return self._get_config_location('bound_location', config=config)
2850
2866
 
2851
2867
    def get_bound_location(self):
2852
 
        """See Branch.get_bound_location."""
 
2868
        """See Branch.set_push_location."""
2853
2869
        return self._get_bound_location(True)
2854
2870
 
2855
2871
    def get_old_bound_location(self):
2860
2876
        # you can always ask for the URL; but you might not be able to use it
2861
2877
        # if the repo can't support stacking.
2862
2878
        ## self._check_stackable_repo()
2863
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2864
 
        # waste effort reading the whole stack of config files.
2865
 
        conf = _mod_config.BranchOnlyStack(self)
2866
 
        stacked_url = self._get_config_location('stacked_on_location',
2867
 
                                                config=conf)
 
2879
        stacked_url = self._get_config_location('stacked_on_location')
2868
2880
        if stacked_url is None:
2869
2881
            raise errors.NotStacked(self)
2870
 
        return stacked_url.encode('utf-8')
 
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)
2871
2895
 
2872
2896
    @needs_read_lock
2873
2897
    def get_rev_id(self, revno, history=None):
2898
2922
        try:
2899
2923
            index = self._partial_revision_history_cache.index(revision_id)
2900
2924
        except ValueError:
2901
 
            try:
2902
 
                self._extend_partial_history(stop_revision=revision_id)
2903
 
            except errors.RevisionNotPresent, e:
2904
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2925
            self._extend_partial_history(stop_revision=revision_id)
2905
2926
            index = len(self._partial_revision_history_cache) - 1
2906
 
            if index < 0:
2907
 
                raise errors.NoSuchRevision(self, revision_id)
2908
2927
            if self._partial_revision_history_cache[index] != revision_id:
2909
2928
                raise errors.NoSuchRevision(self, revision_id)
2910
2929
        return self.revno() - index
2962
2981
    :ivar local_branch: target branch if there is a Master, else None
2963
2982
    :ivar target_branch: Target/destination branch object. (write locked)
2964
2983
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2965
 
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2966
2984
    """
2967
2985
 
 
2986
    def __int__(self):
 
2987
        # DEPRECATED: pull used to return the change in revno
 
2988
        return self.new_revno - self.old_revno
 
2989
 
2968
2990
    def report(self, to_file):
2969
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
2970
 
        tag_updates = getattr(self, "tag_updates", None)
2971
2991
        if not is_quiet():
2972
 
            if self.old_revid != self.new_revid:
 
2992
            if self.old_revid == self.new_revid:
 
2993
                to_file.write('No revisions to pull.\n')
 
2994
            else:
2973
2995
                to_file.write('Now on revision %d.\n' % self.new_revno)
2974
 
            if tag_updates:
2975
 
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
2976
 
            if self.old_revid == self.new_revid and not tag_updates:
2977
 
                if not tag_conflicts:
2978
 
                    to_file.write('No revisions or tags to pull.\n')
2979
 
                else:
2980
 
                    to_file.write('No revisions to pull.\n')
2981
2996
        self._show_tag_conficts(to_file)
2982
2997
 
2983
2998
 
3000
3015
        target, otherwise it will be None.
3001
3016
    """
3002
3017
 
 
3018
    def __int__(self):
 
3019
        # DEPRECATED: push used to return the change in revno
 
3020
        return self.new_revno - self.old_revno
 
3021
 
3003
3022
    def report(self, to_file):
3004
 
        # TODO: This function gets passed a to_file, but then
3005
 
        # ignores it and calls note() instead. This is also
3006
 
        # inconsistent with PullResult(), which writes to stdout.
3007
 
        # -- JRV20110901, bug #838853
3008
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3009
 
        tag_updates = getattr(self, "tag_updates", None)
3010
 
        if not is_quiet():
3011
 
            if self.old_revid != self.new_revid:
3012
 
                note(gettext('Pushed up to revision %d.') % self.new_revno)
3013
 
            if tag_updates:
3014
 
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
3015
 
            if self.old_revid == self.new_revid and not tag_updates:
3016
 
                if not tag_conflicts:
3017
 
                    note(gettext('No new revisions or tags to push.'))
3018
 
                else:
3019
 
                    note(gettext('No new revisions to push.'))
 
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)
3020
3028
        self._show_tag_conficts(to_file)
3021
3029
 
3022
3030
 
3036
3044
        :param verbose: Requests more detailed display of what was checked,
3037
3045
            if any.
3038
3046
        """
3039
 
        note(gettext('checked branch {0} format {1}').format(
3040
 
                                self.branch.user_url, self.branch._format))
 
3047
        note('checked branch %s format %s', self.branch.user_url,
 
3048
            self.branch._format)
3041
3049
        for error in self.errors:
3042
 
            note(gettext('found error:%s'), error)
 
3050
            note('found error:%s', error)
3043
3051
 
3044
3052
 
3045
3053
class Converter5to6(object):
3052
3060
 
3053
3061
        # Copy source data into target
3054
3062
        new_branch._write_last_revision_info(*branch.last_revision_info())
3055
 
        new_branch.lock_write()
3056
 
        try:
3057
 
            new_branch.set_parent(branch.get_parent())
3058
 
            new_branch.set_bound_location(branch.get_bound_location())
3059
 
            new_branch.set_push_location(branch.get_push_location())
3060
 
        finally:
3061
 
            new_branch.unlock()
 
3063
        new_branch.set_parent(branch.get_parent())
 
3064
        new_branch.set_bound_location(branch.get_bound_location())
 
3065
        new_branch.set_push_location(branch.get_push_location())
3062
3066
 
3063
3067
        # New branch has no tags by default
3064
3068
        new_branch.tags._set_tag_dict({})
3065
3069
 
3066
3070
        # Copying done; now update target format
3067
3071
        new_branch._transport.put_bytes('format',
3068
 
            format.as_string(),
 
3072
            format.get_format_string(),
3069
3073
            mode=new_branch.bzrdir._get_file_mode())
3070
3074
 
3071
3075
        # Clean up old files
3072
3076
        new_branch._transport.delete('revision-history')
3073
 
        branch.lock_write()
3074
3077
        try:
3075
 
            try:
3076
 
                branch.set_parent(None)
3077
 
            except errors.NoSuchFile:
3078
 
                pass
3079
 
            branch.set_bound_location(None)
3080
 
        finally:
3081
 
            branch.unlock()
 
3078
            branch.set_parent(None)
 
3079
        except errors.NoSuchFile:
 
3080
            pass
 
3081
        branch.set_bound_location(None)
3082
3082
 
3083
3083
 
3084
3084
class Converter6to7(object):
3088
3088
        format = BzrBranchFormat7()
3089
3089
        branch._set_config_location('stacked_on_location', '')
3090
3090
        # update target format
3091
 
        branch._transport.put_bytes('format', format.as_string())
 
3091
        branch._transport.put_bytes('format', format.get_format_string())
3092
3092
 
3093
3093
 
3094
3094
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
3095
    """Perform an in-place upgrade of format 6 to format 7"""
3096
3096
 
3097
3097
    def convert(self, branch):
3098
3098
        format = BzrBranchFormat8()
3099
3099
        branch._transport.put_bytes('references', '')
3100
3100
        # update target format
3101
 
        branch._transport.put_bytes('format', format.as_string())
 
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
3102
3135
 
3103
3136
 
3104
3137
class InterBranch(InterObject):
3112
3145
    _optimisers = []
3113
3146
    """The available optimised InterBranch types."""
3114
3147
 
3115
 
    @classmethod
3116
 
    def _get_branch_formats_to_test(klass):
3117
 
        """Return an iterable of format tuples for testing.
3118
 
        
3119
 
        :return: An iterable of (from_format, to_format) to use when testing
3120
 
            this InterBranch class. Each InterBranch class should define this
3121
 
            method itself.
3122
 
        """
3123
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
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)
3124
3152
 
3125
 
    @needs_write_lock
3126
3153
    def pull(self, overwrite=False, stop_revision=None,
3127
3154
             possible_transports=None, local=False):
3128
3155
        """Mirror source into target branch.
3133
3160
        """
3134
3161
        raise NotImplementedError(self.pull)
3135
3162
 
3136
 
    @needs_write_lock
3137
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
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,
3138
3177
             _override_hook_source_branch=None):
3139
3178
        """Mirror the source branch into the target branch.
3140
3179
 
3142
3181
        """
3143
3182
        raise NotImplementedError(self.push)
3144
3183
 
3145
 
    @needs_write_lock
3146
 
    def copy_content_into(self, revision_id=None):
3147
 
        """Copy the content of source into target
3148
 
 
3149
 
        revision_id: if not None, the revision history in the new branch will
3150
 
                     be truncated to end with revision_id.
3151
 
        """
3152
 
        raise NotImplementedError(self.copy_content_into)
3153
 
 
3154
 
    @needs_write_lock
3155
 
    def fetch(self, stop_revision=None, limit=None):
3156
 
        """Fetch revisions.
3157
 
 
3158
 
        :param stop_revision: Last revision to fetch
3159
 
        :param limit: Optional rough limit of revisions to fetch
3160
 
        """
3161
 
        raise NotImplementedError(self.fetch)
3162
 
 
3163
 
 
3164
 
def _fix_overwrite_type(overwrite):
3165
 
    if isinstance(overwrite, bool):
3166
 
        if overwrite:
3167
 
            return ["history", "tags"]
3168
 
        else:
3169
 
            return []
3170
 
    return overwrite
3171
 
 
3172
3184
 
3173
3185
class GenericInterBranch(InterBranch):
3174
 
    """InterBranch implementation that uses public Branch functions."""
3175
 
 
3176
 
    @classmethod
3177
 
    def is_compatible(klass, source, target):
3178
 
        # GenericBranch uses the public API, so always compatible
3179
 
        return True
3180
 
 
3181
 
    @classmethod
3182
 
    def _get_branch_formats_to_test(klass):
3183
 
        return [(format_registry.get_default(), format_registry.get_default())]
3184
 
 
3185
 
    @classmethod
3186
 
    def unwrap_format(klass, format):
3187
 
        if isinstance(format, remote.RemoteBranchFormat):
3188
 
            format._ensure_real()
3189
 
            return format._custom_format
3190
 
        return format
3191
 
 
3192
 
    @needs_write_lock
3193
 
    def copy_content_into(self, revision_id=None):
3194
 
        """Copy the content of source into target
3195
 
 
3196
 
        revision_id: if not None, the revision history in the new branch will
3197
 
                     be truncated to end with revision_id.
3198
 
        """
3199
 
        self.source.update_references(self.target)
3200
 
        self.source._synchronize_history(self.target, revision_id)
3201
 
        try:
3202
 
            parent = self.source.get_parent()
3203
 
        except errors.InaccessibleParent, e:
3204
 
            mutter('parent was not accessible to copy: %s', e)
3205
 
        else:
3206
 
            if parent:
3207
 
                self.target.set_parent(parent)
3208
 
        if self.source._push_should_merge_tags():
3209
 
            self.source.tags.merge_to(self.target.tags)
3210
 
 
3211
 
    @needs_write_lock
3212
 
    def fetch(self, stop_revision=None, limit=None):
3213
 
        if self.target.base == self.source.base:
3214
 
            return (0, [])
 
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()."""
3215
3196
        self.source.lock_read()
3216
3197
        try:
3217
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3218
 
            fetch_spec_factory.source_branch = self.source
3219
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3220
 
            fetch_spec_factory.source_repo = self.source.repository
3221
 
            fetch_spec_factory.target_repo = self.target.repository
3222
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3223
 
            fetch_spec_factory.limit = limit
3224
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3225
 
            return self.target.repository.fetch(self.source.repository,
3226
 
                fetch_spec=fetch_spec)
 
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)
3227
3233
        finally:
3228
3234
            self.source.unlock()
3229
3235
 
3230
 
    @needs_write_lock
3231
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3232
 
            graph=None):
3233
 
        other_revno, other_last_revision = self.source.last_revision_info()
3234
 
        stop_revno = None # unknown
3235
 
        if stop_revision is None:
3236
 
            stop_revision = other_last_revision
3237
 
            if _mod_revision.is_null(stop_revision):
3238
 
                # if there are no commits, we're done.
3239
 
                return
3240
 
            stop_revno = other_revno
3241
 
 
3242
 
        # what's the current last revision, before we fetch [and change it
3243
 
        # possibly]
3244
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3245
 
        # we fetch here so that we don't process data twice in the common
3246
 
        # case of having something to pull, and so that the check for
3247
 
        # already merged can operate on the just fetched graph, which will
3248
 
        # be cached in memory.
3249
 
        self.fetch(stop_revision=stop_revision)
3250
 
        # Check to see if one is an ancestor of the other
3251
 
        if not overwrite:
3252
 
            if graph is None:
3253
 
                graph = self.target.repository.get_graph()
3254
 
            if self.target._check_if_descendant_or_diverged(
3255
 
                    stop_revision, last_rev, graph, self.source):
3256
 
                # stop_revision is a descendant of last_rev, but we aren't
3257
 
                # overwriting, so we're done.
3258
 
                return
3259
 
        if stop_revno is None:
3260
 
            if graph is None:
3261
 
                graph = self.target.repository.get_graph()
3262
 
            this_revno, this_last_revision = \
3263
 
                    self.target.last_revision_info()
3264
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3265
 
                            [(other_last_revision, other_revno),
3266
 
                             (this_last_revision, this_revno)])
3267
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3268
 
 
3269
 
    @needs_write_lock
3270
3236
    def pull(self, overwrite=False, stop_revision=None,
3271
 
             possible_transports=None, run_hooks=True,
3272
 
             _override_hook_target=None, local=False):
3273
 
        """Pull from source into self, updating my master if any.
3274
 
 
3275
 
        :param run_hooks: Private parameter - if false, this branch
3276
 
            is being called because it's the master of the primary branch,
3277
 
            so it should not run its hooks.
3278
 
        """
3279
 
        bound_location = self.target.get_bound_location()
3280
 
        if local and not bound_location:
3281
 
            raise errors.LocalRequiresBoundBranch()
3282
 
        master_branch = None
3283
 
        source_is_master = False
3284
 
        if bound_location:
3285
 
            # bound_location comes from a config file, some care has to be
3286
 
            # taken to relate it to source.user_url
3287
 
            normalized = urlutils.normalize_url(bound_location)
3288
 
            try:
3289
 
                relpath = self.source.user_transport.relpath(normalized)
3290
 
                source_is_master = (relpath == '')
3291
 
            except (errors.PathNotChild, errors.InvalidURL):
3292
 
                source_is_master = False
3293
 
        if not local and bound_location and not source_is_master:
3294
 
            # not pulling from master, so we need to update master.
3295
 
            master_branch = self.target.get_master_branch(possible_transports)
3296
 
            master_branch.lock_write()
3297
 
        try:
3298
 
            if master_branch:
3299
 
                # pull from source into master.
3300
 
                master_branch.pull(self.source, overwrite, stop_revision,
3301
 
                    run_hooks=False)
3302
 
            return self._pull(overwrite,
3303
 
                stop_revision, _hook_master=master_branch,
3304
 
                run_hooks=run_hooks,
3305
 
                _override_hook_target=_override_hook_target,
3306
 
                merge_tags_to_master=not source_is_master)
3307
 
        finally:
3308
 
            if master_branch:
3309
 
                master_branch.unlock()
3310
 
 
3311
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3312
 
             _override_hook_source_branch=None):
3313
 
        """See InterBranch.push.
3314
 
 
3315
 
        This is the basic concrete implementation of push()
3316
 
 
3317
 
        :param _override_hook_source_branch: If specified, run the hooks
3318
 
            passing this Branch as the source, rather than self.  This is for
3319
 
            use of RemoteBranch, where push is delegated to the underlying
3320
 
            vfs-based Branch.
3321
 
        """
3322
 
        if lossy:
3323
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3324
 
        # TODO: Public option to disable running hooks - should be trivial but
3325
 
        # needs tests.
3326
 
 
3327
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3328
 
        op.add_cleanup(self.source.lock_read().unlock)
3329
 
        op.add_cleanup(self.target.lock_write().unlock)
3330
 
        return op.run(overwrite, stop_revision,
3331
 
            _override_hook_source_branch=_override_hook_source_branch)
3332
 
 
3333
 
    def _basic_push(self, overwrite, stop_revision):
3334
 
        """Basic implementation of push without bound branches or hooks.
3335
 
 
3336
 
        Must be called with source read locked and target write locked.
3337
 
        """
3338
 
        result = BranchPushResult()
3339
 
        result.source_branch = self.source
3340
 
        result.target_branch = self.target
3341
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3342
 
        self.source.update_references(self.target)
3343
 
        overwrite = _fix_overwrite_type(overwrite)
3344
 
        if result.old_revid != stop_revision:
3345
 
            # We assume that during 'push' this repository is closer than
3346
 
            # the target.
3347
 
            graph = self.source.repository.get_graph(self.target.repository)
3348
 
            self._update_revisions(stop_revision,
3349
 
                overwrite=("history" in overwrite),
3350
 
                graph=graph)
3351
 
        if self.source._push_should_merge_tags():
3352
 
            result.tag_updates, result.tag_conflicts = (
3353
 
                self.source.tags.merge_to(
3354
 
                self.target.tags, "tags" in overwrite))
3355
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3356
 
        return result
3357
 
 
3358
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3359
 
            _override_hook_source_branch=None):
3360
 
        """Push from source into target, and into target's master if any.
3361
 
        """
3362
 
        def _run_hooks():
3363
 
            if _override_hook_source_branch:
3364
 
                result.source_branch = _override_hook_source_branch
3365
 
            for hook in Branch.hooks['post_push']:
3366
 
                hook(result)
3367
 
 
3368
 
        bound_location = self.target.get_bound_location()
3369
 
        if bound_location and self.target.base != bound_location:
3370
 
            # there is a master branch.
3371
 
            #
3372
 
            # XXX: Why the second check?  Is it even supported for a branch to
3373
 
            # be bound to itself? -- mbp 20070507
3374
 
            master_branch = self.target.get_master_branch()
3375
 
            master_branch.lock_write()
3376
 
            operation.add_cleanup(master_branch.unlock)
3377
 
            # push into the master from the source branch.
3378
 
            master_inter = InterBranch.get(self.source, master_branch)
3379
 
            master_inter._basic_push(overwrite, stop_revision)
3380
 
            # and push into the target branch from the source. Note that
3381
 
            # we push from the source branch again, because it's considered
3382
 
            # the highest bandwidth repository.
3383
 
            result = self._basic_push(overwrite, stop_revision)
3384
 
            result.master_branch = master_branch
3385
 
            result.local_branch = self.target
3386
 
        else:
3387
 
            master_branch = None
3388
 
            # no master branch
3389
 
            result = self._basic_push(overwrite, stop_revision)
3390
 
            # TODO: Why set master_branch and local_branch if there's no
3391
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3392
 
            # 20070504
3393
 
            result.master_branch = self.target
3394
 
            result.local_branch = None
3395
 
        _run_hooks()
3396
 
        return result
3397
 
 
3398
 
    def _pull(self, overwrite=False, stop_revision=None,
3399
3237
             possible_transports=None, _hook_master=None, run_hooks=True,
3400
 
             _override_hook_target=None, local=False,
3401
 
             merge_tags_to_master=True):
 
3238
             _override_hook_target=None, local=False):
3402
3239
        """See Branch.pull.
3403
3240
 
3404
 
        This function is the core worker, used by GenericInterBranch.pull to
3405
 
        avoid duplication when pulling source->master and source->local.
3406
 
 
3407
3241
        :param _hook_master: Private parameter - set the branch to
3408
3242
            be supplied as the master to pull hooks.
3409
3243
        :param run_hooks: Private parameter - if false, this branch
3410
3244
            is being called because it's the master of the primary branch,
3411
3245
            so it should not run its hooks.
3412
 
            is being called because it's the master of the primary branch,
3413
 
            so it should not run its hooks.
3414
3246
        :param _override_hook_target: Private parameter - set the branch to be
3415
3247
            supplied as the target_branch to pull hooks.
3416
3248
        :param local: Only update the local branch, and not the bound branch.
3435
3267
            # -- JRV20090506
3436
3268
            result.old_revno, result.old_revid = \
3437
3269
                self.target.last_revision_info()
3438
 
            overwrite = _fix_overwrite_type(overwrite)
3439
 
            self._update_revisions(stop_revision,
3440
 
                overwrite=("history" in overwrite),
3441
 
                graph=graph)
 
3270
            self.target.update_revisions(self.source, stop_revision,
 
3271
                overwrite=overwrite, graph=graph)
3442
3272
            # TODO: The old revid should be specified when merging tags, 
3443
3273
            # so a tags implementation that versions tags can only 
3444
3274
            # pull in the most recent changes. -- JRV20090506
3445
 
            result.tag_updates, result.tag_conflicts = (
3446
 
                self.source.tags.merge_to(self.target.tags,
3447
 
                    "tags" in overwrite,
3448
 
                    ignore_master=not merge_tags_to_master))
 
3275
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3276
                overwrite)
3449
3277
            result.new_revno, result.new_revid = self.target.last_revision_info()
3450
3278
            if _hook_master:
3451
3279
                result.master_branch = _hook_master
3460
3288
            self.source.unlock()
3461
3289
        return result
3462
3290
 
 
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
 
3463
3399
 
3464
3400
InterBranch.register_optimiser(GenericInterBranch)
 
3401
InterBranch.register_optimiser(InterToBranch5)