/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-19 10:58:39 UTC
  • mfrom: (6383 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219105839-uji05ck4rkm1mj4j
Merge bzr.dev.

Show diffs side-by-side

added added

removed removed

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