/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 16:57:16 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719165716-b4iupzkb17b9l9wx
Avoid branch write lock to preserve VFS call count.

Show diffs side-by-side

added added

removed removed

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