/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: Jelmer Vernooij
  • Date: 2011-12-16 19:18:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6391.
  • Revision ID: jelmer@samba.org-20111216191839-eg681lxqibi1qxu1
Fix remaining tests.

Show diffs side-by-side

added added

removed removed

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