/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 breezy/branch.py

  • Committer: Martin
  • Date: 2017-06-11 01:12:29 UTC
  • mto: This revision was merged to the branch mainline in revision 6685.
  • Revision ID: gzlist@googlemail.com-20170611011229-somdjbalby8m7vlw
Make _chunks_to_lines pass for Python 3

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
 
18
 
from cStringIO import StringIO
19
 
import sys
20
 
 
21
 
from bzrlib.lazy_import import lazy_import
 
17
from __future__ import absolute_import
 
18
 
 
19
from . import errors
 
20
 
 
21
from .lazy_import import lazy_import
22
22
lazy_import(globals(), """
23
 
from itertools import chain
24
 
from bzrlib import (
25
 
        bzrdir,
26
 
        cache_utf8,
27
 
        config as _mod_config,
28
 
        debug,
29
 
        errors,
30
 
        lockdir,
31
 
        lockable_files,
32
 
        repository,
33
 
        revision as _mod_revision,
34
 
        rio,
35
 
        symbol_versioning,
36
 
        transport,
37
 
        tsort,
38
 
        ui,
39
 
        urlutils,
40
 
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
 
from bzrlib.tag import (
44
 
    BasicTags,
45
 
    DisabledTags,
 
23
import itertools
 
24
from breezy import (
 
25
    cleanup,
 
26
    config as _mod_config,
 
27
    debug,
 
28
    fetch,
 
29
    remote,
 
30
    repository,
 
31
    revision as _mod_revision,
 
32
    tag as _mod_tag,
 
33
    transport,
 
34
    ui,
 
35
    urlutils,
 
36
    vf_search,
46
37
    )
 
38
from breezy.i18n import gettext, ngettext
47
39
""")
48
40
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
51
 
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
 
from bzrlib import registry
54
 
from bzrlib.symbol_versioning import (
55
 
    deprecated_in,
56
 
    deprecated_method,
57
 
    )
58
 
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
59
 
 
60
 
 
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):
 
41
from . import (
 
42
    controldir,
 
43
    registry,
 
44
    )
 
45
from .decorators import (
 
46
    needs_read_lock,
 
47
    needs_write_lock,
 
48
    only_raises,
 
49
    )
 
50
from .hooks import Hooks
 
51
from .inter import InterObject
 
52
from .lock import LogicalLockResult
 
53
from .sixish import (
 
54
    BytesIO,
 
55
    viewitems,
 
56
    )
 
57
from .trace import mutter, mutter_callsite, note, is_quiet
 
58
 
 
59
 
 
60
class Branch(controldir.ControlComponent):
67
61
    """Branch holding a history of revisions.
68
62
 
69
63
    :ivar base:
70
64
        Base directory/url of the branch; using control_url and
71
65
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
66
    :ivar hooks: An instance of BranchHooks.
 
67
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
68
        _clear_cached_state.
74
69
    """
75
70
    # this is really an instance variable - FIXME move it there
76
71
    # - RBC 20060112
82
77
 
83
78
    @property
84
79
    def user_transport(self):
85
 
        return self.bzrdir.user_transport
 
80
        return self.controldir.user_transport
86
81
 
87
 
    def __init__(self, *ignored, **ignored_too):
 
82
    def __init__(self, possible_transports=None):
88
83
        self.tags = self._format.make_tags(self)
89
84
        self._revision_history_cache = None
90
85
        self._revision_id_to_revno_cache = None
91
86
        self._partial_revision_id_to_revno_cache = {}
92
87
        self._partial_revision_history_cache = []
 
88
        self._tags_bytes = None
93
89
        self._last_revision_info_cache = None
 
90
        self._master_branch_cache = None
94
91
        self._merge_sorted_revisions_cache = None
95
 
        self._open_hook()
 
92
        self._open_hook(possible_transports)
96
93
        hooks = Branch.hooks['open']
97
94
        for hook in hooks:
98
95
            hook(self)
99
96
 
100
 
    def _open_hook(self):
 
97
    def _open_hook(self, possible_transports):
101
98
        """Called by init to allow simpler extension of the base class."""
102
99
 
103
 
    def _activate_fallback_location(self, url):
 
100
    def _activate_fallback_location(self, url, possible_transports):
104
101
        """Activate the branch/repository from url as a fallback repository."""
105
 
        repo = self._get_fallback_repository(url)
 
102
        for existing_fallback_repo in self.repository._fallback_repositories:
 
103
            if existing_fallback_repo.user_url == url:
 
104
                # This fallback is already configured.  This probably only
 
105
                # happens because ControlDir.sprout is a horrible mess.  To
 
106
                # avoid confusing _unstack we don't add this a second time.
 
107
                mutter('duplicate activation of fallback %r on %r', url, self)
 
108
                return
 
109
        repo = self._get_fallback_repository(url, possible_transports)
106
110
        if repo.has_same_location(self.repository):
107
111
            raise errors.UnstackableLocationError(self.user_url, url)
108
112
        self.repository.add_fallback_repository(repo)
123
127
 
124
128
    def _check_stackable_repo(self):
125
129
        if not self.repository._format.supports_external_lookups:
126
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
 
                self.repository.base)
 
130
            raise errors.UnstackableRepositoryFormat(
 
131
                self.repository._format, self.repository.base)
128
132
 
129
133
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
130
134
        """Extend the partial history to include a given index
150
154
    def _get_check_refs(self):
151
155
        """Get the references needed for check().
152
156
 
153
 
        See bzrlib.check.
 
157
        See breezy.check.
154
158
        """
155
159
        revid = self.last_revision()
156
160
        return [('revision-existence', revid), ('lefthand-distance', revid)]
162
166
        For instance, if the branch is at URL/.bzr/branch,
163
167
        Branch.open(URL) -> a Branch instance.
164
168
        """
165
 
        control = bzrdir.BzrDir.open(base, _unsupported,
166
 
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
169
        control = controldir.ControlDir.open(base,
 
170
            possible_transports=possible_transports, _unsupported=_unsupported)
 
171
        return control.open_branch(unsupported=_unsupported,
 
172
            possible_transports=possible_transports)
168
173
 
169
174
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
175
    def open_from_transport(transport, name=None, _unsupported=False,
 
176
            possible_transports=None):
171
177
        """Open the branch rooted at transport"""
172
 
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
178
        control = controldir.ControlDir.open_from_transport(transport, _unsupported)
 
179
        return control.open_branch(name=name, unsupported=_unsupported,
 
180
            possible_transports=possible_transports)
174
181
 
175
182
    @staticmethod
176
183
    def open_containing(url, possible_transports=None):
184
191
        format, UnknownFormatError or UnsupportedFormatError are raised.
185
192
        If there is one, it is returned, along with the unused portion of url.
186
193
        """
187
 
        control, relpath = bzrdir.BzrDir.open_containing(url,
 
194
        control, relpath = controldir.ControlDir.open_containing(url,
188
195
                                                         possible_transports)
189
 
        return control.open_branch(), relpath
 
196
        branch = control.open_branch(possible_transports=possible_transports)
 
197
        return (branch, relpath)
190
198
 
191
199
    def _push_should_merge_tags(self):
192
200
        """Should _basic_push merge this branch's tags into the target?
197
205
        return self.supports_tags() and self.tags.get_tag_dict()
198
206
 
199
207
    def get_config(self):
200
 
        return BranchConfig(self)
 
208
        """Get a breezy.config.BranchConfig for this Branch.
 
209
 
 
210
        This can then be used to get and set configuration options for the
 
211
        branch.
 
212
 
 
213
        :return: A breezy.config.BranchConfig.
 
214
        """
 
215
        return _mod_config.BranchConfig(self)
 
216
 
 
217
    def get_config_stack(self):
 
218
        """Get a breezy.config.BranchStack for this Branch.
 
219
 
 
220
        This can then be used to get and set configuration options for the
 
221
        branch.
 
222
 
 
223
        :return: A breezy.config.BranchStack.
 
224
        """
 
225
        return _mod_config.BranchStack(self)
201
226
 
202
227
    def _get_config(self):
203
228
        """Get the concrete config for just the config in this branch.
211
236
        """
212
237
        raise NotImplementedError(self._get_config)
213
238
 
214
 
    def _get_fallback_repository(self, url):
 
239
    def store_uncommitted(self, creator):
 
240
        """Store uncommitted changes from a ShelfCreator.
 
241
 
 
242
        :param creator: The ShelfCreator containing uncommitted changes, or
 
243
            None to delete any stored changes.
 
244
        :raises: ChangesAlreadyStored if the branch already has changes.
 
245
        """
 
246
        raise NotImplementedError(self.store_uncommitted)
 
247
 
 
248
    def get_unshelver(self, tree):
 
249
        """Return a shelf.Unshelver for this branch and tree.
 
250
 
 
251
        :param tree: The tree to use to construct the Unshelver.
 
252
        :return: an Unshelver or None if no changes are stored.
 
253
        """
 
254
        raise NotImplementedError(self.get_unshelver)
 
255
 
 
256
    def _get_fallback_repository(self, url, possible_transports):
215
257
        """Get the repository we fallback to at url."""
216
258
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
218
 
            possible_transports=[self.bzrdir.root_transport])
 
259
        a_branch = Branch.open(url, possible_transports=possible_transports)
219
260
        return a_branch.repository
220
261
 
 
262
    @needs_read_lock
221
263
    def _get_tags_bytes(self):
222
264
        """Get the bytes of a serialised tags dict.
223
265
 
230
272
        :return: The bytes of the tags file.
231
273
        :seealso: Branch._set_tags_bytes.
232
274
        """
233
 
        return self._transport.get_bytes('tags')
 
275
        if self._tags_bytes is None:
 
276
            self._tags_bytes = self._transport.get_bytes('tags')
 
277
        return self._tags_bytes
234
278
 
235
279
    def _get_nick(self, local=False, possible_transports=None):
236
280
        config = self.get_config()
238
282
        if not local and not config.has_explicit_nickname():
239
283
            try:
240
284
                master = self.get_master_branch(possible_transports)
 
285
                if master and self.user_url == master.user_url:
 
286
                    raise errors.RecursiveBind(self.user_url)
241
287
                if master is not None:
242
288
                    # return the master branch value
243
289
                    return master.nick
244
 
            except errors.BzrError, e:
 
290
            except errors.RecursiveBind as e:
 
291
                raise e
 
292
            except errors.BzrError as e:
245
293
                # Silently fall back to local implicit nick if the master is
246
294
                # unavailable
247
295
                mutter("Could not connect to bound branch, "
295
343
    def lock_read(self):
296
344
        """Lock the branch for read operations.
297
345
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
 
346
        :return: A breezy.lock.LogicalLockResult.
299
347
        """
300
348
        raise NotImplementedError(self.lock_read)
301
349
 
336
384
            return self.get_rev_id(revno[0])
337
385
        revision_id_to_revno = self.get_revision_id_to_revno_map()
338
386
        revision_ids = [revision_id for revision_id, this_revno
339
 
                        in revision_id_to_revno.iteritems()
 
387
                        in viewitems(revision_id_to_revno)
340
388
                        if revno == this_revno]
341
389
        if len(revision_ids) == 1:
342
390
            return revision_ids[0]
423
471
            after. If None, the rest of history is included.
424
472
        :param stop_rule: if stop_revision_id is not None, the precise rule
425
473
            to use for termination:
 
474
 
426
475
            * 'exclude' - leave the stop revision out of the result (default)
427
476
            * 'include' - the stop revision is the last item in the result
428
477
            * 'with-merges' - include the stop revision and all of its
430
479
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
480
              that are in both ancestries
432
481
        :param direction: either 'reverse' or 'forward':
 
482
 
433
483
            * reverse means return the start_revision_id first, i.e.
434
484
              start at the most recent revision and go backwards in history
435
485
            * forward returns tuples in the opposite order to reverse.
479
529
        rev_iter = iter(merge_sorted_revisions)
480
530
        if start_revision_id is not None:
481
531
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
532
                rev_id = node.key
483
533
                if rev_id != start_revision_id:
484
534
                    continue
485
535
                else:
486
536
                    # The decision to include the start or not
487
537
                    # depends on the stop_rule if a stop is provided
488
538
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
539
                    rev_iter = itertools.chain(iter([node]), rev_iter)
490
540
                    break
491
541
        if stop_revision_id is None:
492
542
            # Yield everything
493
543
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
 
544
                rev_id = node.key
495
545
                yield (rev_id, node.merge_depth, node.revno,
496
546
                       node.end_of_merge)
497
547
        elif stop_rule == 'exclude':
498
548
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
549
                rev_id = node.key
500
550
                if rev_id == stop_revision_id:
501
551
                    return
502
552
                yield (rev_id, node.merge_depth, node.revno,
503
553
                       node.end_of_merge)
504
554
        elif stop_rule == 'include':
505
555
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
 
556
                rev_id = node.key
507
557
                yield (rev_id, node.merge_depth, node.revno,
508
558
                       node.end_of_merge)
509
559
                if rev_id == stop_revision_id:
515
565
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
566
                                                    [stop_revision_id])
517
567
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
 
568
                rev_id = node.key
519
569
                if rev_id not in ancestors:
520
570
                    continue
521
571
                yield (rev_id, node.merge_depth, node.revno,
531
581
            reached_stop_revision_id = False
532
582
            revision_id_whitelist = []
533
583
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
584
                rev_id = node.key
535
585
                if rev_id == left_parent:
536
586
                    # reached the left parent after the stop_revision
537
587
                    return
554
604
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
605
        # uninteresting descendants of the first parent of our tip before the
556
606
        # tip itself.
557
 
        first = rev_iter.next()
 
607
        first = next(rev_iter)
558
608
        (rev_id, merge_depth, revno, end_of_merge) = first
559
609
        yield first
560
610
        if not merge_depth:
617
667
        """
618
668
        raise errors.UpgradeRequired(self.user_url)
619
669
 
 
670
    def get_append_revisions_only(self):
 
671
        """Whether it is only possible to append revisions to the history.
 
672
        """
 
673
        if not self._format.supports_set_append_revisions_only():
 
674
            return False
 
675
        return self.get_config_stack().get('append_revisions_only')
 
676
 
620
677
    def set_append_revisions_only(self, enabled):
621
678
        if not self._format.supports_set_append_revisions_only():
622
679
            raise errors.UpgradeRequired(self.user_url)
623
 
        if enabled:
624
 
            value = 'True'
625
 
        else:
626
 
            value = 'False'
627
 
        self.get_config().set_user_option('append_revisions_only', value,
628
 
            warn_masked=True)
 
680
        self.get_config_stack().set('append_revisions_only', enabled)
629
681
 
630
682
    def set_reference_info(self, file_id, tree_path, branch_location):
631
683
        """Set the branch location to use for a tree reference."""
636
688
        raise errors.UnsupportedOperation(self.get_reference_info, self)
637
689
 
638
690
    @needs_write_lock
639
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
691
    def fetch(self, from_branch, last_revision=None, limit=None):
640
692
        """Copy revisions from from_branch into this branch.
641
693
 
642
694
        :param from_branch: Where to copy from.
643
695
        :param last_revision: What revision to stop at (None for at the end
644
696
                              of the branch.
645
 
        :param pb: An optional progress bar to use.
 
697
        :param limit: Optional rough limit of revisions to fetch
646
698
        :return: None
647
699
        """
648
 
        if self.base == from_branch.base:
649
 
            return (0, [])
650
 
        if pb is not None:
651
 
            symbol_versioning.warn(
652
 
                symbol_versioning.deprecated_in((1, 14, 0))
653
 
                % "pb parameter to fetch()")
654
 
        from_branch.lock_read()
655
 
        try:
656
 
            if last_revision is None:
657
 
                last_revision = from_branch.last_revision()
658
 
                last_revision = _mod_revision.ensure_null(last_revision)
659
 
            return self.repository.fetch(from_branch.repository,
660
 
                                         revision_id=last_revision,
661
 
                                         pb=pb)
662
 
        finally:
663
 
            from_branch.unlock()
 
700
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
664
701
 
665
702
    def get_bound_location(self):
666
703
        """Return the URL of the branch we are bound to.
675
712
        """
676
713
        raise errors.UpgradeRequired(self.user_url)
677
714
 
678
 
    def get_commit_builder(self, parents, config=None, timestamp=None,
 
715
    def get_commit_builder(self, parents, config_stack=None, timestamp=None,
679
716
                           timezone=None, committer=None, revprops=None,
680
 
                           revision_id=None):
 
717
                           revision_id=None, lossy=False):
681
718
        """Obtain a CommitBuilder for this branch.
682
719
 
683
720
        :param parents: Revision ids of the parents of the new revision.
687
724
        :param committer: Optional committer to set for commit.
688
725
        :param revprops: Optional dictionary of revision properties.
689
726
        :param revision_id: Optional revision id.
 
727
        :param lossy: Whether to discard data that can not be natively
 
728
            represented, when pushing to a foreign VCS 
690
729
        """
691
730
 
692
 
        if config is None:
693
 
            config = self.get_config()
 
731
        if config_stack is None:
 
732
            config_stack = self.get_config_stack()
694
733
 
695
 
        return self.repository.get_commit_builder(self, parents, config,
696
 
            timestamp, timezone, committer, revprops, revision_id)
 
734
        return self.repository.get_commit_builder(self, parents, config_stack,
 
735
            timestamp, timezone, committer, revprops, revision_id,
 
736
            lossy)
697
737
 
698
738
    def get_master_branch(self, possible_transports=None):
699
739
        """Return the branch we are bound to.
702
742
        """
703
743
        return None
704
744
 
705
 
    def get_revision_delta(self, revno):
706
 
        """Return the delta for one revision.
707
 
 
708
 
        The delta is relative to its mainline predecessor, or the
709
 
        empty tree for revision 1.
710
 
        """
711
 
        rh = self.revision_history()
712
 
        if not (1 <= revno <= len(rh)):
713
 
            raise errors.InvalidRevisionNumber(revno)
714
 
        return self.repository.get_revision_delta(rh[revno-1])
715
 
 
716
745
    def get_stacked_on_url(self):
717
746
        """Get the URL this branch is stacked against.
718
747
 
726
755
        """Print `file` to stdout."""
727
756
        raise NotImplementedError(self.print_file)
728
757
 
729
 
    def set_revision_history(self, rev_history):
730
 
        raise NotImplementedError(self.set_revision_history)
 
758
    @needs_write_lock
 
759
    def set_last_revision_info(self, revno, revision_id):
 
760
        """Set the last revision of this branch.
 
761
 
 
762
        The caller is responsible for checking that the revno is correct
 
763
        for this revision id.
 
764
 
 
765
        It may be possible to set the branch last revision to an id not
 
766
        present in the repository.  However, branches can also be
 
767
        configured to check constraints on history, in which case this may not
 
768
        be permitted.
 
769
        """
 
770
        raise NotImplementedError(self.set_last_revision_info)
 
771
 
 
772
    @needs_write_lock
 
773
    def generate_revision_history(self, revision_id, last_rev=None,
 
774
                                  other_branch=None):
 
775
        """See Branch.generate_revision_history"""
 
776
        graph = self.repository.get_graph()
 
777
        (last_revno, last_revid) = self.last_revision_info()
 
778
        known_revision_ids = [
 
779
            (last_revid, last_revno),
 
780
            (_mod_revision.NULL_REVISION, 0),
 
781
            ]
 
782
        if last_rev is not None:
 
783
            if not graph.is_ancestor(last_rev, revision_id):
 
784
                # our previous tip is not merged into stop_revision
 
785
                raise errors.DivergedBranches(self, other_branch)
 
786
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
787
        self.set_last_revision_info(revno, revision_id)
731
788
 
732
789
    @needs_write_lock
733
790
    def set_parent(self, url):
743
800
                except UnicodeEncodeError:
744
801
                    raise errors.InvalidURL(url,
745
802
                        "Urls must be 7-bit ascii, "
746
 
                        "use bzrlib.urlutils.escape")
 
803
                        "use breezy.urlutils.escape")
747
804
            url = urlutils.relative_url(self.base, url)
748
805
        self._set_parent_location(url)
749
806
 
770
827
                return
771
828
            self._unstack()
772
829
        else:
773
 
            self._activate_fallback_location(url)
 
830
            self._activate_fallback_location(url,
 
831
                possible_transports=[self.controldir.root_transport])
774
832
        # write this out after the repository is stacked to avoid setting a
775
833
        # stacked config that doesn't work.
776
834
        self._set_config_location('stacked_on_location', url)
777
835
 
778
836
    def _unstack(self):
779
837
        """Change a branch to be unstacked, copying data as needed.
780
 
        
 
838
 
781
839
        Don't call this directly, use set_stacked_on_url(None).
782
840
        """
783
841
        pb = ui.ui_factory.nested_progress_bar()
784
842
        try:
785
 
            pb.update("Unstacking")
 
843
            pb.update(gettext("Unstacking"))
786
844
            # The basic approach here is to fetch the tip of the branch,
787
845
            # including all available ghosts, from the existing stacked
788
846
            # repository into a new repository object without the fallbacks. 
792
850
            old_repository = self.repository
793
851
            if len(old_repository._fallback_repositories) != 1:
794
852
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
 
853
                    "of %r (fallbacks: %r)" % (old_repository,
 
854
                        old_repository._fallback_repositories))
 
855
            # Open the new repository object.
 
856
            # Repositories don't offer an interface to remove fallback
 
857
            # repositories today; take the conceptually simpler option and just
 
858
            # reopen it.  We reopen it starting from the URL so that we
 
859
            # get a separate connection for RemoteRepositories and can
 
860
            # stream from one of them to the other.  This does mean doing
 
861
            # separate SSH connection setup, but unstacking is not a
 
862
            # common operation so it's tolerable.
 
863
            new_bzrdir = controldir.ControlDir.open(
 
864
                self.controldir.root_transport.base)
 
865
            new_repository = new_bzrdir.find_repository()
 
866
            if new_repository._fallback_repositories:
 
867
                raise AssertionError("didn't expect %r to have "
 
868
                    "fallback_repositories"
 
869
                    % (self.repository,))
 
870
            # Replace self.repository with the new repository.
 
871
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
872
            # lock count) of self.repository to the new repository.
 
873
            lock_token = old_repository.lock_write().repository_token
 
874
            self.repository = new_repository
 
875
            if isinstance(self, remote.RemoteBranch):
 
876
                # Remote branches can have a second reference to the old
 
877
                # repository that need to be replaced.
 
878
                if self._real_branch is not None:
 
879
                    self._real_branch.repository = new_repository
 
880
            self.repository.lock_write(token=lock_token)
 
881
            if lock_token is not None:
 
882
                old_repository.leave_lock_in_place()
797
883
            old_repository.unlock()
 
884
            if lock_token is not None:
 
885
                # XXX: self.repository.leave_lock_in_place() before this
 
886
                # function will not be preserved.  Fortunately that doesn't
 
887
                # affect the current default format (2a), and would be a
 
888
                # corner-case anyway.
 
889
                #  - Andrew Bennetts, 2010/06/30
 
890
                self.repository.dont_leave_lock_in_place()
 
891
            old_lock_count = 0
 
892
            while True:
 
893
                try:
 
894
                    old_repository.unlock()
 
895
                except errors.LockNotHeld:
 
896
                    break
 
897
                old_lock_count += 1
 
898
            if old_lock_count == 0:
 
899
                raise AssertionError(
 
900
                    'old_repository should have been locked at least once.')
 
901
            for i in range(old_lock_count-1):
 
902
                self.repository.lock_write()
 
903
            # Fetch from the old repository into the new.
798
904
            old_repository.lock_read()
799
905
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
906
                # XXX: If you unstack a branch while it has a working tree
819
907
                # with a pending merge, the pending-merged revisions will no
820
908
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
 
909
                try:
 
910
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
911
                except errors.TagsNotSupported:
 
912
                    tags_to_fetch = set()
 
913
                fetch_spec = vf_search.NotInOtherForRevs(self.repository,
 
914
                    old_repository, required_ids=[self.last_revision()],
 
915
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
916
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
828
917
            finally:
829
918
                old_repository.unlock()
830
919
        finally:
835
924
 
836
925
        :seealso: Branch._get_tags_bytes.
837
926
        """
838
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
839
 
            'tags', bytes)
 
927
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
928
        op.add_cleanup(self.lock_write().unlock)
 
929
        return op.run_simple(bytes)
 
930
 
 
931
    def _set_tags_bytes_locked(self, bytes):
 
932
        self._tags_bytes = bytes
 
933
        return self._transport.put_bytes('tags', bytes)
840
934
 
841
935
    def _cache_revision_history(self, rev_history):
842
936
        """Set the cached revision history to rev_history.
863
957
        This means the next call to revision_history will need to call
864
958
        _gen_revision_history.
865
959
 
866
 
        This API is semi-public; it only for use by subclasses, all other code
867
 
        should consider it to be private.
 
960
        This API is semi-public; it is only for use by subclasses, all other
 
961
        code should consider it to be private.
868
962
        """
869
963
        self._revision_history_cache = None
870
964
        self._revision_id_to_revno_cache = None
871
965
        self._last_revision_info_cache = None
 
966
        self._master_branch_cache = None
872
967
        self._merge_sorted_revisions_cache = None
873
968
        self._partial_revision_history_cache = []
874
969
        self._partial_revision_id_to_revno_cache = {}
 
970
        self._tags_bytes = None
875
971
 
876
972
    def _gen_revision_history(self):
877
973
        """Return sequence of revision hashes on to this branch.
888
984
        """
889
985
        raise NotImplementedError(self._gen_revision_history)
890
986
 
891
 
    @needs_read_lock
892
 
    def revision_history(self):
893
 
        """Return sequence of revision ids on this branch.
894
 
 
895
 
        This method will cache the revision history for as long as it is safe to
896
 
        do so.
897
 
        """
 
987
    def _revision_history(self):
898
988
        if 'evil' in debug.debug_flags:
899
989
            mutter_callsite(3, "revision_history scales with history.")
900
990
        if self._revision_history_cache is not None:
927
1017
        :return: A tuple (revno, revision_id).
928
1018
        """
929
1019
        if self._last_revision_info_cache is None:
930
 
            self._last_revision_info_cache = self._last_revision_info()
 
1020
            self._last_revision_info_cache = self._read_last_revision_info()
931
1021
        return self._last_revision_info_cache
932
1022
 
933
 
    def _last_revision_info(self):
934
 
        rh = self.revision_history()
935
 
        revno = len(rh)
936
 
        if revno:
937
 
            return (revno, rh[-1])
938
 
        else:
939
 
            return (0, _mod_revision.NULL_REVISION)
940
 
 
941
 
    @deprecated_method(deprecated_in((1, 6, 0)))
942
 
    def missing_revisions(self, other, stop_revision=None):
943
 
        """Return a list of new revisions that would perfectly fit.
944
 
 
945
 
        If self and other have not diverged, return a list of the revisions
946
 
        present in other, but missing from self.
947
 
        """
948
 
        self_history = self.revision_history()
949
 
        self_len = len(self_history)
950
 
        other_history = other.revision_history()
951
 
        other_len = len(other_history)
952
 
        common_index = min(self_len, other_len) -1
953
 
        if common_index >= 0 and \
954
 
            self_history[common_index] != other_history[common_index]:
955
 
            raise errors.DivergedBranches(self, other)
956
 
 
957
 
        if stop_revision is None:
958
 
            stop_revision = other_len
959
 
        else:
960
 
            if stop_revision > other_len:
961
 
                raise errors.NoSuchRevision(self, stop_revision)
962
 
        return other_history[self_len:stop_revision]
963
 
 
964
 
    @needs_write_lock
965
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
966
 
                         graph=None):
967
 
        """Pull in new perfect-fit revisions.
968
 
 
969
 
        :param other: Another Branch to pull from
970
 
        :param stop_revision: Updated until the given revision
971
 
        :param overwrite: Always set the branch pointer, rather than checking
972
 
            to see if it is a proper descendant.
973
 
        :param graph: A Graph object that can be used to query history
974
 
            information. This can be None.
975
 
        :return: None
976
 
        """
977
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
978
 
            overwrite, graph)
979
 
 
980
 
    def import_last_revision_info(self, source_repo, revno, revid):
 
1023
    def _read_last_revision_info(self):
 
1024
        raise NotImplementedError(self._read_last_revision_info)
 
1025
 
 
1026
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1027
                                           lossy=False):
981
1028
        """Set the last revision info, importing from another repo if necessary.
982
1029
 
983
1030
        This is used by the bound branch code to upload a revision to
984
1031
        the master branch first before updating the tip of the local branch.
 
1032
        Revisions referenced by source's tags are also transferred.
985
1033
 
986
 
        :param source_repo: Source repository to optionally fetch from
 
1034
        :param source: Source branch to optionally fetch from
987
1035
        :param revno: Revision number of the new tip
988
1036
        :param revid: Revision id of the new tip
 
1037
        :param lossy: Whether to discard metadata that can not be
 
1038
            natively represented
 
1039
        :return: Tuple with the new revision number and revision id
 
1040
            (should only be different from the arguments when lossy=True)
989
1041
        """
990
 
        if not self.repository.has_same_location(source_repo):
991
 
            self.repository.fetch(source_repo, revision_id=revid)
 
1042
        if not self.repository.has_same_location(source.repository):
 
1043
            self.fetch(source, revid)
992
1044
        self.set_last_revision_info(revno, revid)
 
1045
        return (revno, revid)
993
1046
 
994
1047
    def revision_id_to_revno(self, revision_id):
995
1048
        """Given a revision id, return its revno"""
996
1049
        if _mod_revision.is_null(revision_id):
997
1050
            return 0
998
 
        history = self.revision_history()
 
1051
        history = self._revision_history()
999
1052
        try:
1000
1053
            return history.index(revision_id) + 1
1001
1054
        except ValueError:
1016
1069
            self._extend_partial_history(distance_from_last)
1017
1070
        return self._partial_revision_history_cache[distance_from_last]
1018
1071
 
1019
 
    @needs_write_lock
1020
1072
    def pull(self, source, overwrite=False, stop_revision=None,
1021
1073
             possible_transports=None, *args, **kwargs):
1022
1074
        """Mirror source into this branch.
1029
1081
            stop_revision=stop_revision,
1030
1082
            possible_transports=possible_transports, *args, **kwargs)
1031
1083
 
1032
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1033
 
        **kwargs):
 
1084
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1085
            *args, **kwargs):
1034
1086
        """Mirror this branch into target.
1035
1087
 
1036
1088
        This branch is considered to be 'local', having low latency.
1037
1089
        """
1038
1090
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1039
 
            *args, **kwargs)
1040
 
 
1041
 
    def lossy_push(self, target, stop_revision=None):
1042
 
        """Push deltas into another branch.
1043
 
 
1044
 
        :note: This does not, like push, retain the revision ids from 
1045
 
            the source branch and will, rather than adding bzr-specific 
1046
 
            metadata, push only those semantics of the revision that can be 
1047
 
            natively represented by this branch' VCS.
1048
 
 
1049
 
        :param target: Target branch
1050
 
        :param stop_revision: Revision to push, defaults to last revision.
1051
 
        :return: BranchPushResult with an extra member revidmap: 
1052
 
            A dictionary mapping revision ids from the target branch 
1053
 
            to new revision ids in the target branch, for each 
1054
 
            revision that was pushed.
1055
 
        """
1056
 
        inter = InterBranch.get(self, target)
1057
 
        lossy_push = getattr(inter, "lossy_push", None)
1058
 
        if lossy_push is None:
1059
 
            raise errors.LossyPushToSameVCS(self, target)
1060
 
        return lossy_push(stop_revision)
 
1091
            lossy, *args, **kwargs)
1061
1092
 
1062
1093
    def basis_tree(self):
1063
1094
        """Return `Tree` object for last revision."""
1079
1110
            parent = urlutils.local_path_to_url(parent.decode('utf8'))
1080
1111
        try:
1081
1112
            return urlutils.join(self.base[:-1], parent)
1082
 
        except errors.InvalidURLJoin, e:
 
1113
        except errors.InvalidURLJoin as e:
1083
1114
            raise errors.InaccessibleParent(parent, self.user_url)
1084
1115
 
1085
1116
    def _get_parent_location(self):
1088
1119
    def _set_config_location(self, name, url, config=None,
1089
1120
                             make_relative=False):
1090
1121
        if config is None:
1091
 
            config = self.get_config()
 
1122
            config = self.get_config_stack()
1092
1123
        if url is None:
1093
1124
            url = ''
1094
1125
        elif make_relative:
1095
1126
            url = urlutils.relative_url(self.base, url)
1096
 
        config.set_user_option(name, url, warn_masked=True)
 
1127
        config.set(name, url)
1097
1128
 
1098
1129
    def _get_config_location(self, name, config=None):
1099
1130
        if config is None:
1100
 
            config = self.get_config()
1101
 
        location = config.get_user_option(name)
 
1131
            config = self.get_config_stack()
 
1132
        location = config.get(name)
1102
1133
        if location == '':
1103
1134
            location = None
1104
1135
        return location
1105
1136
 
1106
1137
    def get_child_submit_format(self):
1107
1138
        """Return the preferred format of submissions to this branch."""
1108
 
        return self.get_config().get_user_option("child_submit_format")
 
1139
        return self.get_config_stack().get('child_submit_format')
1109
1140
 
1110
1141
    def get_submit_branch(self):
1111
1142
        """Return the submit location of the branch.
1114
1145
        pattern is that the user can override it by specifying a
1115
1146
        location.
1116
1147
        """
1117
 
        return self.get_config().get_user_option('submit_branch')
 
1148
        return self.get_config_stack().get('submit_branch')
1118
1149
 
1119
1150
    def set_submit_branch(self, location):
1120
1151
        """Return the submit location of the branch.
1123
1154
        pattern is that the user can override it by specifying a
1124
1155
        location.
1125
1156
        """
1126
 
        self.get_config().set_user_option('submit_branch', location,
1127
 
            warn_masked=True)
 
1157
        self.get_config_stack().set('submit_branch', location)
1128
1158
 
1129
1159
    def get_public_branch(self):
1130
1160
        """Return the public location of the branch.
1143
1173
        self._set_config_location('public_branch', location)
1144
1174
 
1145
1175
    def get_push_location(self):
1146
 
        """Return the None or the location to push this branch to."""
1147
 
        push_loc = self.get_config().get_user_option('push_location')
1148
 
        return push_loc
 
1176
        """Return None or the location to push this branch to."""
 
1177
        return self.get_config_stack().get('push_location')
1149
1178
 
1150
1179
    def set_push_location(self, location):
1151
1180
        """Set a new push location for this branch."""
1198
1227
            raise errors.InvalidRevisionNumber(revno)
1199
1228
 
1200
1229
    @needs_read_lock
1201
 
    def clone(self, to_bzrdir, revision_id=None, repository_policy=None):
1202
 
        """Clone this branch into to_bzrdir preserving all semantic values.
 
1230
    def clone(self, to_controldir, revision_id=None, repository_policy=None):
 
1231
        """Clone this branch into to_controldir preserving all semantic values.
1203
1232
 
1204
1233
        Most API users will want 'create_clone_on_transport', which creates a
1205
1234
        new bzrdir and branch on the fly.
1207
1236
        revision_id: if not None, the revision history in the new branch will
1208
1237
                     be truncated to end with revision_id.
1209
1238
        """
1210
 
        result = to_bzrdir.create_branch()
 
1239
        result = to_controldir.create_branch()
1211
1240
        result.lock_write()
1212
1241
        try:
1213
1242
            if repository_policy is not None:
1218
1247
        return result
1219
1248
 
1220
1249
    @needs_read_lock
1221
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1222
 
        """Create a new line of development from the branch, into to_bzrdir.
 
1250
    def sprout(self, to_controldir, revision_id=None, repository_policy=None,
 
1251
            repository=None):
 
1252
        """Create a new line of development from the branch, into to_controldir.
1223
1253
 
1224
 
        to_bzrdir controls the branch format.
 
1254
        to_controldir controls the branch format.
1225
1255
 
1226
1256
        revision_id: if not None, the revision history in the new branch will
1227
1257
                     be truncated to end with revision_id.
1228
1258
        """
1229
1259
        if (repository_policy is not None and
1230
1260
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
 
        result = to_bzrdir.create_branch()
 
1261
            to_controldir._format.require_stacking(_skip_repo=True)
 
1262
        result = to_controldir.create_branch(repository=repository)
1233
1263
        result.lock_write()
1234
1264
        try:
1235
1265
            if repository_policy is not None:
1236
1266
                repository_policy.configure_branch(result)
1237
1267
            self.copy_content_into(result, revision_id=revision_id)
1238
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1268
            master_url = self.get_bound_location()
 
1269
            if master_url is None:
 
1270
                result.set_parent(self.controldir.root_transport.base)
 
1271
            else:
 
1272
                result.set_parent(master_url)
1239
1273
        finally:
1240
1274
            result.unlock()
1241
1275
        return result
1265
1299
                revno = 1
1266
1300
        destination.set_last_revision_info(revno, revision_id)
1267
1301
 
1268
 
    @needs_read_lock
1269
1302
    def copy_content_into(self, destination, revision_id=None):
1270
1303
        """Copy the content of self into destination.
1271
1304
 
1272
1305
        revision_id: if not None, the revision history in the new branch will
1273
1306
                     be truncated to end with revision_id.
1274
1307
        """
1275
 
        self.update_references(destination)
1276
 
        self._synchronize_history(destination, revision_id)
1277
 
        try:
1278
 
            parent = self.get_parent()
1279
 
        except errors.InaccessibleParent, e:
1280
 
            mutter('parent was not accessible to copy: %s', e)
1281
 
        else:
1282
 
            if parent:
1283
 
                destination.set_parent(parent)
1284
 
        if self._push_should_merge_tags():
1285
 
            self.tags.merge_to(destination.tags)
 
1308
        return InterBranch.get(self, destination).copy_content_into(
 
1309
            revision_id=revision_id)
1286
1310
 
1287
1311
    def update_references(self, target):
1288
1312
        if not getattr(self._format, 'supports_reference_locations', False):
1293
1317
        old_base = self.base
1294
1318
        new_base = target.base
1295
1319
        target_reference_dict = target._get_all_reference_info()
1296
 
        for file_id, (tree_path, branch_location) in (
1297
 
            reference_dict.items()):
 
1320
        for file_id, (tree_path, branch_location) in viewitems(reference_dict):
1298
1321
            branch_location = urlutils.rebase_url(branch_location,
1299
1322
                                                  old_base, new_base)
1300
1323
            target_reference_dict.setdefault(
1325
1348
        # TODO: We should probably also check that self.revision_history
1326
1349
        # matches the repository for older branch formats.
1327
1350
        # If looking for the code that cross-checks repository parents against
1328
 
        # the iter_reverse_revision_history output, that is now a repository
 
1351
        # the Graph.iter_lefthand_ancestry output, that is now a repository
1329
1352
        # specific check.
1330
1353
        return result
1331
1354
 
1332
 
    def _get_checkout_format(self):
 
1355
    def _get_checkout_format(self, lightweight=False):
1333
1356
        """Return the most suitable metadir for a checkout of this branch.
1334
1357
        Weaves are used if this branch's repository uses weaves.
1335
1358
        """
1336
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1337
 
            from bzrlib.repofmt import weaverepo
1338
 
            format = bzrdir.BzrDirMetaFormat1()
1339
 
            format.repository_format = weaverepo.RepositoryFormat7()
1340
 
        else:
1341
 
            format = self.repository.bzrdir.checkout_metadir()
1342
 
            format.set_branch_format(self._format)
 
1359
        format = self.repository.controldir.checkout_metadir()
 
1360
        format.set_branch_format(self._format)
1343
1361
        return format
1344
1362
 
1345
1363
    def create_clone_on_transport(self, to_transport, revision_id=None,
1346
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1364
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1365
        no_tree=None):
1347
1366
        """Create a clone of this branch and its bzrdir.
1348
1367
 
1349
1368
        :param to_transport: The transport to clone onto.
1360
1379
        # rather than just the default branch? 20100319 JRV
1361
1380
        if revision_id is None:
1362
1381
            revision_id = self.last_revision()
1363
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1382
        dir_to = self.controldir.clone_on_transport(to_transport,
1364
1383
            revision_id=revision_id, stacked_on=stacked_on,
1365
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1384
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1385
            no_tree=no_tree)
1366
1386
        return dir_to.open_branch()
1367
1387
 
1368
1388
    def create_checkout(self, to_location, revision_id=None,
1373
1393
        :param to_location: The url to produce the checkout at
1374
1394
        :param revision_id: The revision to check out
1375
1395
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1376
 
        produce a bound branch (heavyweight checkout)
 
1396
            produce a bound branch (heavyweight checkout)
1377
1397
        :param accelerator_tree: A tree which can be used for retrieving file
1378
1398
            contents more quickly than the revision tree, i.e. a workingtree.
1379
1399
            The revision tree will be used for cases where accelerator_tree's
1384
1404
        """
1385
1405
        t = transport.get_transport(to_location)
1386
1406
        t.ensure_base()
 
1407
        format = self._get_checkout_format(lightweight=lightweight)
 
1408
        try:
 
1409
            checkout = format.initialize_on_transport(t)
 
1410
        except errors.AlreadyControlDirError:
 
1411
            # It's fine if the control directory already exists,
 
1412
            # as long as there is no existing branch and working tree.
 
1413
            checkout = controldir.ControlDir.open_from_transport(t)
 
1414
            try:
 
1415
                checkout.open_branch()
 
1416
            except errors.NotBranchError:
 
1417
                pass
 
1418
            else:
 
1419
                raise errors.AlreadyControlDirError(t.base)
 
1420
            if checkout.control_transport.base == self.controldir.control_transport.base:
 
1421
                # When checking out to the same control directory,
 
1422
                # always create a lightweight checkout
 
1423
                lightweight = True
 
1424
 
1387
1425
        if lightweight:
1388
 
            format = self._get_checkout_format()
1389
 
            checkout = format.initialize_on_transport(t)
1390
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1391
 
                target_branch=self)
 
1426
            from_branch = checkout.set_branch_reference(target_branch=self)
1392
1427
        else:
1393
 
            format = self._get_checkout_format()
1394
 
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1395
 
                to_location, force_new_tree=False, format=format)
1396
 
            checkout = checkout_branch.bzrdir
 
1428
            policy = checkout.determine_repository_policy()
 
1429
            repo = policy.acquire_repository()[0]
 
1430
            checkout_branch = checkout.create_branch()
1397
1431
            checkout_branch.bind(self)
1398
1432
            # pull up to the specified revision_id to set the initial
1399
1433
            # branch tip correctly, and seed it with history.
1400
1434
            checkout_branch.pull(self, stop_revision=revision_id)
1401
 
            from_branch=None
 
1435
            from_branch = None
1402
1436
        tree = checkout.create_workingtree(revision_id,
1403
1437
                                           from_branch=from_branch,
1404
1438
                                           accelerator_tree=accelerator_tree,
1418
1452
    @needs_write_lock
1419
1453
    def reconcile(self, thorough=True):
1420
1454
        """Make sure the data stored in this branch is consistent."""
1421
 
        from bzrlib.reconcile import BranchReconciler
 
1455
        from breezy.reconcile import BranchReconciler
1422
1456
        reconciler = BranchReconciler(self, thorough=thorough)
1423
1457
        reconciler.reconcile()
1424
1458
        return reconciler
1425
1459
 
1426
1460
    def reference_parent(self, file_id, path, possible_transports=None):
1427
1461
        """Return the parent branch for a tree-reference file_id
 
1462
 
1428
1463
        :param file_id: The file_id of the tree reference
1429
1464
        :param path: The path of the file_id in the tree
1430
1465
        :return: A branch associated with the file_id
1431
1466
        """
1432
1467
        # FIXME should provide multiple branches, based on config
1433
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
 
1468
        return Branch.open(self.controldir.root_transport.clone(path).base,
1434
1469
                           possible_transports=possible_transports)
1435
1470
 
1436
1471
    def supports_tags(self):
1473
1508
        :returns: One of: 'a_descends_from_b', 'b_descends_from_a', 'diverged'
1474
1509
        """
1475
1510
        heads = graph.heads([revision_a, revision_b])
1476
 
        if heads == set([revision_b]):
 
1511
        if heads == {revision_b}:
1477
1512
            return 'b_descends_from_a'
1478
 
        elif heads == set([revision_a, revision_b]):
 
1513
        elif heads == {revision_a, revision_b}:
1479
1514
            # These branches have diverged
1480
1515
            return 'diverged'
1481
 
        elif heads == set([revision_a]):
 
1516
        elif heads == {revision_a}:
1482
1517
            return 'a_descends_from_b'
1483
1518
        else:
1484
1519
            raise AssertionError("invalid heads: %r" % (heads,))
1485
1520
 
1486
 
 
1487
 
class BranchFormat(object):
 
1521
    def heads_to_fetch(self):
 
1522
        """Return the heads that must and that should be fetched to copy this
 
1523
        branch into another repo.
 
1524
 
 
1525
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1526
            set of heads that must be fetched.  if_present_fetch is a set of
 
1527
            heads that must be fetched if present, but no error is necessary if
 
1528
            they are not present.
 
1529
        """
 
1530
        # For bzr native formats must_fetch is just the tip, and
 
1531
        # if_present_fetch are the tags.
 
1532
        must_fetch = {self.last_revision()}
 
1533
        if_present_fetch = set()
 
1534
        if self.get_config_stack().get('branch.fetch_tags'):
 
1535
            try:
 
1536
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1537
            except errors.TagsNotSupported:
 
1538
                pass
 
1539
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1540
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1541
        return must_fetch, if_present_fetch
 
1542
 
 
1543
 
 
1544
class BranchFormat(controldir.ControlComponentFormat):
1488
1545
    """An encapsulation of the initialization and open routines for a format.
1489
1546
 
1490
1547
    Formats provide three things:
1491
1548
     * An initialization routine,
1492
 
     * a format string,
 
1549
     * a format description
1493
1550
     * an open routine.
1494
1551
 
1495
1552
    Formats are placed in an dict by their format string for reference
1496
 
    during branch opening. Its not required that these be instances, they
 
1553
    during branch opening. It's not required that these be instances, they
1497
1554
    can be classes themselves with class methods - it simply depends on
1498
1555
    whether state is needed for a given format or not.
1499
1556
 
1502
1559
    object will be created every time regardless.
1503
1560
    """
1504
1561
 
1505
 
    _default_format = None
1506
 
    """The default format used for new branches."""
1507
 
 
1508
 
    _formats = {}
1509
 
    """The known formats."""
1510
 
 
1511
 
    can_set_append_revisions_only = True
1512
 
 
1513
1562
    def __eq__(self, other):
1514
1563
        return self.__class__ is other.__class__
1515
1564
 
1516
1565
    def __ne__(self, other):
1517
1566
        return not (self == other)
1518
1567
 
1519
 
    @classmethod
1520
 
    def find_format(klass, a_bzrdir, name=None):
1521
 
        """Return the format for the branch object in a_bzrdir."""
1522
 
        try:
1523
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1524
 
            format_string = transport.get_bytes("format")
1525
 
            return klass._formats[format_string]
1526
 
        except errors.NoSuchFile:
1527
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1528
 
        except KeyError:
1529
 
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1530
 
 
1531
 
    @classmethod
1532
 
    def get_default_format(klass):
1533
 
        """Return the current default format."""
1534
 
        return klass._default_format
1535
 
 
1536
 
    def get_reference(self, a_bzrdir, name=None):
1537
 
        """Get the target reference of the branch in a_bzrdir.
 
1568
    def get_reference(self, controldir, name=None):
 
1569
        """Get the target reference of the branch in controldir.
1538
1570
 
1539
1571
        format probing must have been completed before calling
1540
1572
        this method - it is assumed that the format of the branch
1541
 
        in a_bzrdir is correct.
 
1573
        in controldir is correct.
1542
1574
 
1543
 
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1575
        :param controldir: The controldir to get the branch data from.
1544
1576
        :param name: Name of the colocated branch to fetch
1545
1577
        :return: None if the branch is not a reference branch.
1546
1578
        """
1547
1579
        return None
1548
1580
 
1549
1581
    @classmethod
1550
 
    def set_reference(self, a_bzrdir, name, to_branch):
1551
 
        """Set the target reference of the branch in a_bzrdir.
 
1582
    def set_reference(self, controldir, name, to_branch):
 
1583
        """Set the target reference of the branch in controldir.
1552
1584
 
1553
1585
        format probing must have been completed before calling
1554
1586
        this method - it is assumed that the format of the branch
1555
 
        in a_bzrdir is correct.
 
1587
        in controldir is correct.
1556
1588
 
1557
 
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1589
        :param controldir: The controldir to set the branch reference for.
1558
1590
        :param name: Name of colocated branch to set, None for default
1559
1591
        :param to_branch: branch that the checkout is to reference
1560
1592
        """
1561
1593
        raise NotImplementedError(self.set_reference)
1562
1594
 
1563
 
    def get_format_string(self):
1564
 
        """Return the ASCII format string that identifies this format."""
1565
 
        raise NotImplementedError(self.get_format_string)
1566
 
 
1567
1595
    def get_format_description(self):
1568
1596
        """Return the short format description for this format."""
1569
1597
        raise NotImplementedError(self.get_format_description)
1570
1598
 
1571
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1599
    def _run_post_branch_init_hooks(self, controldir, name, branch):
1572
1600
        hooks = Branch.hooks['post_branch_init']
1573
1601
        if not hooks:
1574
1602
            return
1575
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1603
        params = BranchInitHookParams(self, controldir, name, branch)
1576
1604
        for hook in hooks:
1577
1605
            hook(params)
1578
1606
 
1579
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1580
 
                           lock_type='metadir', set_format=True):
1581
 
        """Initialize a branch in a bzrdir, with specified files
1582
 
 
1583
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1584
 
        :param utf8_files: The files to create as a list of
1585
 
            (filename, content) tuples
1586
 
        :param name: Name of colocated branch to create, if any
1587
 
        :param set_format: If True, set the format with
1588
 
            self.get_format_string.  (BzrBranch4 has its format set
1589
 
            elsewhere)
1590
 
        :return: a branch in this format
1591
 
        """
1592
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1593
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1594
 
        lock_map = {
1595
 
            'metadir': ('lock', lockdir.LockDir),
1596
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1597
 
        }
1598
 
        lock_name, lock_class = lock_map[lock_type]
1599
 
        control_files = lockable_files.LockableFiles(branch_transport,
1600
 
            lock_name, lock_class)
1601
 
        control_files.create_lock()
1602
 
        try:
1603
 
            control_files.lock_write()
1604
 
        except errors.LockContention:
1605
 
            if lock_type != 'branch4':
1606
 
                raise
1607
 
            lock_taken = False
1608
 
        else:
1609
 
            lock_taken = True
1610
 
        if set_format:
1611
 
            utf8_files += [('format', self.get_format_string())]
1612
 
        try:
1613
 
            for (filename, content) in utf8_files:
1614
 
                branch_transport.put_bytes(
1615
 
                    filename, content,
1616
 
                    mode=a_bzrdir._get_file_mode())
1617
 
        finally:
1618
 
            if lock_taken:
1619
 
                control_files.unlock()
1620
 
        branch = self.open(a_bzrdir, name, _found=True)
1621
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1622
 
        return branch
1623
 
 
1624
 
    def initialize(self, a_bzrdir, name=None):
1625
 
        """Create a branch of this format in a_bzrdir.
1626
 
        
 
1607
    def initialize(self, controldir, name=None, repository=None,
 
1608
                   append_revisions_only=None):
 
1609
        """Create a branch of this format in controldir.
 
1610
 
1627
1611
        :param name: Name of the colocated branch to create.
1628
1612
        """
1629
1613
        raise NotImplementedError(self.initialize)
1649
1633
        Note that it is normal for branch to be a RemoteBranch when using tags
1650
1634
        on a RemoteBranch.
1651
1635
        """
1652
 
        return DisabledTags(branch)
 
1636
        return _mod_tag.DisabledTags(branch)
1653
1637
 
1654
1638
    def network_name(self):
1655
1639
        """A simple byte string uniquely identifying this format for RPC calls.
1661
1645
        """
1662
1646
        raise NotImplementedError(self.network_name)
1663
1647
 
1664
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1665
 
        """Return the branch object for a_bzrdir
 
1648
    def open(self, controldir, name=None, _found=False, ignore_fallbacks=False,
 
1649
            found_repository=None, possible_transports=None):
 
1650
        """Return the branch object for controldir.
1666
1651
 
1667
 
        :param a_bzrdir: A BzrDir that contains a branch.
 
1652
        :param controldir: A ControlDir that contains a branch.
1668
1653
        :param name: Name of colocated branch to open
1669
1654
        :param _found: a private parameter, do not use it. It is used to
1670
1655
            indicate if format probing has already be done.
1673
1658
        """
1674
1659
        raise NotImplementedError(self.open)
1675
1660
 
1676
 
    @classmethod
1677
 
    def register_format(klass, format):
1678
 
        """Register a metadir format."""
1679
 
        klass._formats[format.get_format_string()] = format
1680
 
        # Metadir formats have a network name of their format string, and get
1681
 
        # registered as class factories.
1682
 
        network_format_registry.register(format.get_format_string(), format.__class__)
1683
 
 
1684
 
    @classmethod
1685
 
    def set_default_format(klass, format):
1686
 
        klass._default_format = format
1687
 
 
1688
1661
    def supports_set_append_revisions_only(self):
1689
1662
        """True if this format supports set_append_revisions_only."""
1690
1663
        return False
1693
1666
        """True if this format records a stacked-on branch."""
1694
1667
        return False
1695
1668
 
1696
 
    @classmethod
1697
 
    def unregister_format(klass, format):
1698
 
        del klass._formats[format.get_format_string()]
 
1669
    def supports_leaving_lock(self):
 
1670
        """True if this format supports leaving locks in place."""
 
1671
        return False # by default
1699
1672
 
1700
1673
    def __str__(self):
1701
1674
        return self.get_format_description().rstrip()
1704
1677
        """True if this format supports tags stored in the branch"""
1705
1678
        return False  # by default
1706
1679
 
 
1680
    def tags_are_versioned(self):
 
1681
        """Whether the tag container for this branch versions tags."""
 
1682
        return False
 
1683
 
 
1684
    def supports_tags_referencing_ghosts(self):
 
1685
        """True if tags can reference ghost revisions."""
 
1686
        return True
 
1687
 
1707
1688
 
1708
1689
class BranchHooks(Hooks):
1709
1690
    """A dictionary mapping hook name to a list of callables for branch hooks.
1710
1691
 
1711
 
    e.g. ['set_rh'] Is the list of items to be called when the
1712
 
    set_revision_history function is invoked.
 
1692
    e.g. ['post_push'] Is the list of items to be called when the
 
1693
    push function is invoked.
1713
1694
    """
1714
1695
 
1715
1696
    def __init__(self):
1718
1699
        These are all empty initially, because by default nothing should get
1719
1700
        notified.
1720
1701
        """
1721
 
        Hooks.__init__(self)
1722
 
        self.create_hook(HookPoint('set_rh',
1723
 
            "Invoked whenever the revision history has been set via "
1724
 
            "set_revision_history. The api signature is (branch, "
1725
 
            "revision_history), and the branch will be write-locked. "
1726
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1727
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1728
 
        self.create_hook(HookPoint('open',
 
1702
        Hooks.__init__(self, "breezy.branch", "Branch.hooks")
 
1703
        self.add_hook('open',
1729
1704
            "Called with the Branch object that has been opened after a "
1730
 
            "branch is opened.", (1, 8), None))
1731
 
        self.create_hook(HookPoint('post_push',
 
1705
            "branch is opened.", (1, 8))
 
1706
        self.add_hook('post_push',
1732
1707
            "Called after a push operation completes. post_push is called "
1733
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1734
 
            "bzr client.", (0, 15), None))
1735
 
        self.create_hook(HookPoint('post_pull',
 
1708
            "with a breezy.branch.BranchPushResult object and only runs in the "
 
1709
            "bzr client.", (0, 15))
 
1710
        self.add_hook('post_pull',
1736
1711
            "Called after a pull operation completes. post_pull is called "
1737
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1738
 
            "bzr client.", (0, 15), None))
1739
 
        self.create_hook(HookPoint('pre_commit',
1740
 
            "Called after a commit is calculated but before it is is "
 
1712
            "with a breezy.branch.PullResult object and only runs in the "
 
1713
            "bzr client.", (0, 15))
 
1714
        self.add_hook('pre_commit',
 
1715
            "Called after a commit is calculated but before it is "
1741
1716
            "completed. pre_commit is called with (local, master, old_revno, "
1742
1717
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1743
1718
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1745
1720
            "basis revision. hooks MUST NOT modify this delta. "
1746
1721
            " future_tree is an in-memory tree obtained from "
1747
1722
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1748
 
            "tree.", (0,91), None))
1749
 
        self.create_hook(HookPoint('post_commit',
 
1723
            "tree.", (0,91))
 
1724
        self.add_hook('post_commit',
1750
1725
            "Called in the bzr client after a commit has completed. "
1751
1726
            "post_commit is called with (local, master, old_revno, old_revid, "
1752
1727
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1753
 
            "commit to a branch.", (0, 15), None))
1754
 
        self.create_hook(HookPoint('post_uncommit',
 
1728
            "commit to a branch.", (0, 15))
 
1729
        self.add_hook('post_uncommit',
1755
1730
            "Called in the bzr client after an uncommit completes. "
1756
1731
            "post_uncommit is called with (local, master, old_revno, "
1757
1732
            "old_revid, new_revno, new_revid) where local is the local branch "
1758
1733
            "or None, master is the target branch, and an empty branch "
1759
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1760
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1734
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1735
        self.add_hook('pre_change_branch_tip',
1761
1736
            "Called in bzr client and server before a change to the tip of a "
1762
1737
            "branch is made. pre_change_branch_tip is called with a "
1763
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1764
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1765
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1738
            "breezy.branch.ChangeBranchTipParams. Note that push, pull, "
 
1739
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1740
        self.add_hook('post_change_branch_tip',
1766
1741
            "Called in bzr client and server after a change to the tip of a "
1767
1742
            "branch is made. post_change_branch_tip is called with a "
1768
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1769
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1770
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1743
            "breezy.branch.ChangeBranchTipParams. Note that push, pull, "
 
1744
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1745
        self.add_hook('transform_fallback_location',
1771
1746
            "Called when a stacked branch is activating its fallback "
1772
1747
            "locations. transform_fallback_location is called with (branch, "
1773
1748
            "url), and should return a new url. Returning the same url "
1778
1753
            "fallback locations have not been activated. When there are "
1779
1754
            "multiple hooks installed for transform_fallback_location, "
1780
1755
            "all are called with the url returned from the previous hook."
1781
 
            "The order is however undefined.", (1, 9), None))
1782
 
        self.create_hook(HookPoint('automatic_tag_name',
1783
 
            "Called to determine an automatic tag name for a revision."
 
1756
            "The order is however undefined.", (1, 9))
 
1757
        self.add_hook('automatic_tag_name',
 
1758
            "Called to determine an automatic tag name for a revision. "
1784
1759
            "automatic_tag_name is called with (branch, revision_id) and "
1785
1760
            "should return a tag name or None if no tag name could be "
1786
1761
            "determined. The first non-None tag name returned will be used.",
1787
 
            (2, 2), None))
1788
 
        self.create_hook(HookPoint('post_branch_init',
 
1762
            (2, 2))
 
1763
        self.add_hook('post_branch_init',
1789
1764
            "Called after new branch initialization completes. "
1790
1765
            "post_branch_init is called with a "
1791
 
            "bzrlib.branch.BranchInitHookParams. "
 
1766
            "breezy.branch.BranchInitHookParams. "
1792
1767
            "Note that init, branch and checkout (both heavyweight and "
1793
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1794
 
        self.create_hook(HookPoint('post_switch',
 
1768
            "lightweight) will all trigger this hook.", (2, 2))
 
1769
        self.add_hook('post_switch',
1795
1770
            "Called after a checkout switches branch. "
1796
1771
            "post_switch is called with a "
1797
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1772
            "breezy.branch.SwitchHookParams.", (2, 2))
1798
1773
 
1799
1774
 
1800
1775
 
1803
1778
 
1804
1779
 
1805
1780
class ChangeBranchTipParams(object):
1806
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1781
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1807
1782
 
1808
1783
    There are 5 fields that hooks may wish to access:
1809
1784
 
1841
1816
 
1842
1817
 
1843
1818
class BranchInitHookParams(object):
1844
 
    """Object holding parameters passed to *_branch_init hooks.
 
1819
    """Object holding parameters passed to `*_branch_init` hooks.
1845
1820
 
1846
1821
    There are 4 fields that hooks may wish to access:
1847
1822
 
1848
1823
    :ivar format: the branch format
1849
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1824
    :ivar bzrdir: the ControlDir where the branch will be/has been initialized
1850
1825
    :ivar name: name of colocated branch, if any (or None)
1851
1826
    :ivar branch: the branch created
1852
1827
 
1855
1830
    branch, which refer to the original branch.
1856
1831
    """
1857
1832
 
1858
 
    def __init__(self, format, a_bzrdir, name, branch):
 
1833
    def __init__(self, format, controldir, name, branch):
1859
1834
        """Create a group of BranchInitHook parameters.
1860
1835
 
1861
1836
        :param format: the branch format
1862
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1837
        :param controldir: the ControlDir where the branch will be/has been
1863
1838
            initialized
1864
1839
        :param name: name of colocated branch, if any (or None)
1865
1840
        :param branch: the branch created
1869
1844
        in branch, which refer to the original branch.
1870
1845
        """
1871
1846
        self.format = format
1872
 
        self.bzrdir = a_bzrdir
 
1847
        self.controldir = controldir
1873
1848
        self.name = name
1874
1849
        self.branch = branch
1875
1850
 
1877
1852
        return self.__dict__ == other.__dict__
1878
1853
 
1879
1854
    def __repr__(self):
1880
 
        if self.branch:
1881
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1882
 
        else:
1883
 
            return "<%s of format:%s bzrdir:%s>" % (
1884
 
                self.__class__.__name__, self.branch,
1885
 
                self.format, self.bzrdir)
 
1855
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1886
1856
 
1887
1857
 
1888
1858
class SwitchHookParams(object):
1889
 
    """Object holding parameters passed to *_switch hooks.
 
1859
    """Object holding parameters passed to `*_switch` hooks.
1890
1860
 
1891
1861
    There are 4 fields that hooks may wish to access:
1892
1862
 
1893
 
    :ivar control_dir: BzrDir of the checkout to change
 
1863
    :ivar control_dir: ControlDir of the checkout to change
1894
1864
    :ivar to_branch: branch that the checkout is to reference
1895
1865
    :ivar force: skip the check for local commits in a heavy checkout
1896
1866
    :ivar revision_id: revision ID to switch to (or None)
1899
1869
    def __init__(self, control_dir, to_branch, force, revision_id):
1900
1870
        """Create a group of SwitchHook parameters.
1901
1871
 
1902
 
        :param control_dir: BzrDir of the checkout to change
 
1872
        :param control_dir: ControlDir of the checkout to change
1903
1873
        :param to_branch: branch that the checkout is to reference
1904
1874
        :param force: skip the check for local commits in a heavy checkout
1905
1875
        :param revision_id: revision ID to switch to (or None)
1918
1888
            self.revision_id)
1919
1889
 
1920
1890
 
1921
 
class BzrBranchFormat4(BranchFormat):
1922
 
    """Bzr branch format 4.
1923
 
 
1924
 
    This format has:
1925
 
     - a revision-history file.
1926
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1927
 
    """
1928
 
 
1929
 
    def get_format_description(self):
1930
 
        """See BranchFormat.get_format_description()."""
1931
 
        return "Branch format 4"
1932
 
 
1933
 
    def initialize(self, a_bzrdir, name=None):
1934
 
        """Create a branch of this format in a_bzrdir."""
1935
 
        utf8_files = [('revision-history', ''),
1936
 
                      ('branch-name', ''),
1937
 
                      ]
1938
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1939
 
                                       lock_type='branch4', set_format=False)
1940
 
 
1941
 
    def __init__(self):
1942
 
        super(BzrBranchFormat4, self).__init__()
1943
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1944
 
 
1945
 
    def network_name(self):
1946
 
        """The network name for this format is the control dirs disk label."""
1947
 
        return self._matchingbzrdir.get_format_string()
1948
 
 
1949
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1950
 
        """See BranchFormat.open()."""
1951
 
        if not _found:
1952
 
            # we are being called directly and must probe.
1953
 
            raise NotImplementedError
1954
 
        return BzrBranch(_format=self,
1955
 
                         _control_files=a_bzrdir._control_files,
1956
 
                         a_bzrdir=a_bzrdir,
1957
 
                         name=name,
1958
 
                         _repository=a_bzrdir.open_repository())
1959
 
 
1960
 
    def __str__(self):
1961
 
        return "Bazaar-NG branch format 4"
1962
 
 
1963
 
 
1964
 
class BranchFormatMetadir(BranchFormat):
1965
 
    """Common logic for meta-dir based branch formats."""
1966
 
 
1967
 
    def _branch_class(self):
1968
 
        """What class to instantiate on open calls."""
1969
 
        raise NotImplementedError(self._branch_class)
1970
 
 
1971
 
    def network_name(self):
1972
 
        """A simple byte string uniquely identifying this format for RPC calls.
1973
 
 
1974
 
        Metadir branch formats use their format string.
1975
 
        """
1976
 
        return self.get_format_string()
1977
 
 
1978
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1979
 
        """See BranchFormat.open()."""
1980
 
        if not _found:
1981
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
1982
 
            if format.__class__ != self.__class__:
1983
 
                raise AssertionError("wrong format %r found for %r" %
1984
 
                    (format, self))
1985
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1986
 
        try:
1987
 
            control_files = lockable_files.LockableFiles(transport, 'lock',
1988
 
                                                         lockdir.LockDir)
1989
 
            return self._branch_class()(_format=self,
1990
 
                              _control_files=control_files,
1991
 
                              name=name,
1992
 
                              a_bzrdir=a_bzrdir,
1993
 
                              _repository=a_bzrdir.find_repository(),
1994
 
                              ignore_fallbacks=ignore_fallbacks)
1995
 
        except errors.NoSuchFile:
1996
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1997
 
 
1998
 
    def __init__(self):
1999
 
        super(BranchFormatMetadir, self).__init__()
2000
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2001
 
        self._matchingbzrdir.set_branch_format(self)
2002
 
 
2003
 
    def supports_tags(self):
2004
 
        return True
2005
 
 
2006
 
 
2007
 
class BzrBranchFormat5(BranchFormatMetadir):
2008
 
    """Bzr branch format 5.
2009
 
 
2010
 
    This format has:
2011
 
     - a revision-history file.
2012
 
     - a format string
2013
 
     - a lock dir guarding the branch itself
2014
 
     - all of this stored in a branch/ subdirectory
2015
 
     - works with shared repositories.
2016
 
 
2017
 
    This format is new in bzr 0.8.
2018
 
    """
2019
 
 
2020
 
    def _branch_class(self):
2021
 
        return BzrBranch5
2022
 
 
2023
 
    def get_format_string(self):
2024
 
        """See BranchFormat.get_format_string()."""
2025
 
        return "Bazaar-NG branch format 5\n"
2026
 
 
2027
 
    def get_format_description(self):
2028
 
        """See BranchFormat.get_format_description()."""
2029
 
        return "Branch format 5"
2030
 
 
2031
 
    def initialize(self, a_bzrdir, name=None):
2032
 
        """Create a branch of this format in a_bzrdir."""
2033
 
        utf8_files = [('revision-history', ''),
2034
 
                      ('branch-name', ''),
2035
 
                      ]
2036
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2037
 
 
2038
 
    def supports_tags(self):
2039
 
        return False
2040
 
 
2041
 
 
2042
 
class BzrBranchFormat6(BranchFormatMetadir):
2043
 
    """Branch format with last-revision and tags.
2044
 
 
2045
 
    Unlike previous formats, this has no explicit revision history. Instead,
2046
 
    this just stores the last-revision, and the left-hand history leading
2047
 
    up to there is the history.
2048
 
 
2049
 
    This format was introduced in bzr 0.15
2050
 
    and became the default in 0.91.
2051
 
    """
2052
 
 
2053
 
    def _branch_class(self):
2054
 
        return BzrBranch6
2055
 
 
2056
 
    def get_format_string(self):
2057
 
        """See BranchFormat.get_format_string()."""
2058
 
        return "Bazaar Branch Format 6 (bzr 0.15)\n"
2059
 
 
2060
 
    def get_format_description(self):
2061
 
        """See BranchFormat.get_format_description()."""
2062
 
        return "Branch format 6"
2063
 
 
2064
 
    def initialize(self, a_bzrdir, name=None):
2065
 
        """Create a branch of this format in a_bzrdir."""
2066
 
        utf8_files = [('last-revision', '0 null:\n'),
2067
 
                      ('branch.conf', ''),
2068
 
                      ('tags', ''),
2069
 
                      ]
2070
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2071
 
 
2072
 
    def make_tags(self, branch):
2073
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2074
 
        return BasicTags(branch)
2075
 
 
2076
 
    def supports_set_append_revisions_only(self):
2077
 
        return True
2078
 
 
2079
 
 
2080
 
class BzrBranchFormat8(BranchFormatMetadir):
2081
 
    """Metadir format supporting storing locations of subtree branches."""
2082
 
 
2083
 
    def _branch_class(self):
2084
 
        return BzrBranch8
2085
 
 
2086
 
    def get_format_string(self):
2087
 
        """See BranchFormat.get_format_string()."""
2088
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2089
 
 
2090
 
    def get_format_description(self):
2091
 
        """See BranchFormat.get_format_description()."""
2092
 
        return "Branch format 8"
2093
 
 
2094
 
    def initialize(self, a_bzrdir, name=None):
2095
 
        """Create a branch of this format in a_bzrdir."""
2096
 
        utf8_files = [('last-revision', '0 null:\n'),
2097
 
                      ('branch.conf', ''),
2098
 
                      ('tags', ''),
2099
 
                      ('references', '')
2100
 
                      ]
2101
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2102
 
 
2103
 
    def __init__(self):
2104
 
        super(BzrBranchFormat8, self).__init__()
2105
 
        self._matchingbzrdir.repository_format = \
2106
 
            RepositoryFormatKnitPack5RichRoot()
2107
 
 
2108
 
    def make_tags(self, branch):
2109
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2110
 
        return BasicTags(branch)
2111
 
 
2112
 
    def supports_set_append_revisions_only(self):
2113
 
        return True
2114
 
 
2115
 
    def supports_stacking(self):
2116
 
        return True
2117
 
 
2118
 
    supports_reference_locations = True
2119
 
 
2120
 
 
2121
 
class BzrBranchFormat7(BzrBranchFormat8):
2122
 
    """Branch format with last-revision, tags, and a stacked location pointer.
2123
 
 
2124
 
    The stacked location pointer is passed down to the repository and requires
2125
 
    a repository format with supports_external_lookups = True.
2126
 
 
2127
 
    This format was introduced in bzr 1.6.
2128
 
    """
2129
 
 
2130
 
    def initialize(self, a_bzrdir, name=None):
2131
 
        """Create a branch of this format in a_bzrdir."""
2132
 
        utf8_files = [('last-revision', '0 null:\n'),
2133
 
                      ('branch.conf', ''),
2134
 
                      ('tags', ''),
2135
 
                      ]
2136
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2137
 
 
2138
 
    def _branch_class(self):
2139
 
        return BzrBranch7
2140
 
 
2141
 
    def get_format_string(self):
2142
 
        """See BranchFormat.get_format_string()."""
2143
 
        return "Bazaar Branch Format 7 (needs bzr 1.6)\n"
2144
 
 
2145
 
    def get_format_description(self):
2146
 
        """See BranchFormat.get_format_description()."""
2147
 
        return "Branch format 7"
2148
 
 
2149
 
    def supports_set_append_revisions_only(self):
2150
 
        return True
2151
 
 
2152
 
    supports_reference_locations = False
2153
 
 
2154
 
 
2155
 
class BranchReferenceFormat(BranchFormat):
2156
 
    """Bzr branch reference format.
2157
 
 
2158
 
    Branch references are used in implementing checkouts, they
2159
 
    act as an alias to the real branch which is at some other url.
2160
 
 
2161
 
    This format has:
2162
 
     - A location file
2163
 
     - a format string
2164
 
    """
2165
 
 
2166
 
    def get_format_string(self):
2167
 
        """See BranchFormat.get_format_string()."""
2168
 
        return "Bazaar-NG Branch Reference Format 1\n"
2169
 
 
2170
 
    def get_format_description(self):
2171
 
        """See BranchFormat.get_format_description()."""
2172
 
        return "Checkout reference format 1"
2173
 
 
2174
 
    def get_reference(self, a_bzrdir, name=None):
2175
 
        """See BranchFormat.get_reference()."""
2176
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2177
 
        return transport.get_bytes('location')
2178
 
 
2179
 
    def set_reference(self, a_bzrdir, name, to_branch):
2180
 
        """See BranchFormat.set_reference()."""
2181
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2182
 
        location = transport.put_bytes('location', to_branch.base)
2183
 
 
2184
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2185
 
        """Create a branch of this format in a_bzrdir."""
2186
 
        if target_branch is None:
2187
 
            # this format does not implement branch itself, thus the implicit
2188
 
            # creation contract must see it as uninitializable
2189
 
            raise errors.UninitializableFormat(self)
2190
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2191
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2192
 
        branch_transport.put_bytes('location',
2193
 
            target_branch.bzrdir.user_url)
2194
 
        branch_transport.put_bytes('format', self.get_format_string())
2195
 
        branch = self.open(
2196
 
            a_bzrdir, name, _found=True,
2197
 
            possible_transports=[target_branch.bzrdir.root_transport])
2198
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2199
 
        return branch
2200
 
 
2201
 
    def __init__(self):
2202
 
        super(BranchReferenceFormat, self).__init__()
2203
 
        self._matchingbzrdir = bzrdir.BzrDirMetaFormat1()
2204
 
        self._matchingbzrdir.set_branch_format(self)
2205
 
 
2206
 
    def _make_reference_clone_function(format, a_branch):
2207
 
        """Create a clone() routine for a branch dynamically."""
2208
 
        def clone(to_bzrdir, revision_id=None,
2209
 
            repository_policy=None):
2210
 
            """See Branch.clone()."""
2211
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
2212
 
            # cannot obey revision_id limits when cloning a reference ...
2213
 
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2214
 
            # emit some sort of warning/error to the caller ?!
2215
 
        return clone
2216
 
 
2217
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2218
 
             possible_transports=None, ignore_fallbacks=False):
2219
 
        """Return the branch that the branch reference in a_bzrdir points at.
2220
 
 
2221
 
        :param a_bzrdir: A BzrDir that contains a branch.
2222
 
        :param name: Name of colocated branch to open, if any
2223
 
        :param _found: a private parameter, do not use it. It is used to
2224
 
            indicate if format probing has already be done.
2225
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2226
 
            (if there are any).  Default is to open fallbacks.
2227
 
        :param location: The location of the referenced branch.  If
2228
 
            unspecified, this will be determined from the branch reference in
2229
 
            a_bzrdir.
2230
 
        :param possible_transports: An optional reusable transports list.
2231
 
        """
2232
 
        if not _found:
2233
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
2234
 
            if format.__class__ != self.__class__:
2235
 
                raise AssertionError("wrong format %r found for %r" %
2236
 
                    (format, self))
2237
 
        if location is None:
2238
 
            location = self.get_reference(a_bzrdir, name)
2239
 
        real_bzrdir = bzrdir.BzrDir.open(
2240
 
            location, possible_transports=possible_transports)
2241
 
        result = real_bzrdir.open_branch(name=name, 
2242
 
            ignore_fallbacks=ignore_fallbacks)
2243
 
        # this changes the behaviour of result.clone to create a new reference
2244
 
        # rather than a copy of the content of the branch.
2245
 
        # I did not use a proxy object because that needs much more extensive
2246
 
        # testing, and we are only changing one behaviour at the moment.
2247
 
        # If we decide to alter more behaviours - i.e. the implicit nickname
2248
 
        # then this should be refactored to introduce a tested proxy branch
2249
 
        # and a subclass of that for use in overriding clone() and ....
2250
 
        # - RBC 20060210
2251
 
        result.clone = self._make_reference_clone_function(result)
2252
 
        return result
 
1891
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
1892
    """Branch format registry."""
 
1893
 
 
1894
    def __init__(self, other_registry=None):
 
1895
        super(BranchFormatRegistry, self).__init__(other_registry)
 
1896
        self._default_format = None
 
1897
        self._default_format_key = None
 
1898
 
 
1899
    def get_default(self):
 
1900
        """Return the current default format."""
 
1901
        if (self._default_format_key is not None and
 
1902
            self._default_format is None):
 
1903
            self._default_format = self.get(self._default_format_key)
 
1904
        return self._default_format
 
1905
 
 
1906
    def set_default(self, format):
 
1907
        """Set the default format."""
 
1908
        self._default_format = format
 
1909
        self._default_format_key = None
 
1910
 
 
1911
    def set_default_key(self, format_string):
 
1912
        """Set the default format by its format string."""
 
1913
        self._default_format_key = format_string
 
1914
        self._default_format = None
2253
1915
 
2254
1916
 
2255
1917
network_format_registry = registry.FormatRegistry()
2260
1922
BranchFormat.network_name() for more detail.
2261
1923
"""
2262
1924
 
 
1925
format_registry = BranchFormatRegistry(network_format_registry)
 
1926
 
2263
1927
 
2264
1928
# formats which have no format string are not discoverable
2265
1929
# and not independently creatable, so are not registered.
2266
 
__format5 = BzrBranchFormat5()
2267
 
__format6 = BzrBranchFormat6()
2268
 
__format7 = BzrBranchFormat7()
2269
 
__format8 = BzrBranchFormat8()
2270
 
BranchFormat.register_format(__format5)
2271
 
BranchFormat.register_format(BranchReferenceFormat())
2272
 
BranchFormat.register_format(__format6)
2273
 
BranchFormat.register_format(__format7)
2274
 
BranchFormat.register_format(__format8)
2275
 
BranchFormat.set_default_format(__format7)
2276
 
_legacy_formats = [BzrBranchFormat4(),
2277
 
    ]
2278
 
network_format_registry.register(
2279
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
1930
format_registry.register_lazy(
 
1931
    "Bazaar-NG branch format 5\n", "breezy.branchfmt.fullhistory",
 
1932
    "BzrBranchFormat5")
 
1933
format_registry.register_lazy(
 
1934
    "Bazaar Branch Format 6 (bzr 0.15)\n",
 
1935
    "breezy.bzrbranch", "BzrBranchFormat6")
 
1936
format_registry.register_lazy(
 
1937
    "Bazaar Branch Format 7 (needs bzr 1.6)\n",
 
1938
    "breezy.bzrbranch", "BzrBranchFormat7")
 
1939
format_registry.register_lazy(
 
1940
    "Bazaar Branch Format 8 (needs bzr 1.15)\n",
 
1941
    "breezy.bzrbranch", "BzrBranchFormat8")
 
1942
format_registry.register_lazy(
 
1943
    "Bazaar-NG Branch Reference Format 1\n",
 
1944
    "breezy.bzrbranch", "BranchReferenceFormat")
 
1945
 
 
1946
format_registry.set_default_key("Bazaar Branch Format 7 (needs bzr 1.6)\n")
2280
1947
 
2281
1948
 
2282
1949
class BranchWriteLockResult(LogicalLockResult):
2296
1963
            self.unlock)
2297
1964
 
2298
1965
 
2299
 
class BzrBranch(Branch, _RelockDebugMixin):
2300
 
    """A branch stored in the actual filesystem.
2301
 
 
2302
 
    Note that it's "local" in the context of the filesystem; it doesn't
2303
 
    really matter if it's on an nfs/smb/afs/coda/... share, as long as
2304
 
    it's writable, and can be accessed via the normal filesystem API.
2305
 
 
2306
 
    :ivar _transport: Transport for file operations on this branch's
2307
 
        control files, typically pointing to the .bzr/branch directory.
2308
 
    :ivar repository: Repository for this branch.
2309
 
    :ivar base: The url of the base directory for this branch; the one
2310
 
        containing the .bzr directory.
2311
 
    :ivar name: Optional colocated branch name as it exists in the control
2312
 
        directory.
2313
 
    """
2314
 
 
2315
 
    def __init__(self, _format=None,
2316
 
                 _control_files=None, a_bzrdir=None, name=None,
2317
 
                 _repository=None, ignore_fallbacks=False):
2318
 
        """Create new branch object at a particular location."""
2319
 
        if a_bzrdir is None:
2320
 
            raise ValueError('a_bzrdir must be supplied')
2321
 
        else:
2322
 
            self.bzrdir = a_bzrdir
2323
 
        self._base = self.bzrdir.transport.clone('..').base
2324
 
        self.name = name
2325
 
        # XXX: We should be able to just do
2326
 
        #   self.base = self.bzrdir.root_transport.base
2327
 
        # but this does not quite work yet -- mbp 20080522
2328
 
        self._format = _format
2329
 
        if _control_files is None:
2330
 
            raise ValueError('BzrBranch _control_files is None')
2331
 
        self.control_files = _control_files
2332
 
        self._transport = _control_files._transport
2333
 
        self.repository = _repository
2334
 
        Branch.__init__(self)
2335
 
 
2336
 
    def __str__(self):
2337
 
        if self.name is None:
2338
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2339
 
        else:
2340
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2341
 
                self.name)
2342
 
 
2343
 
    __repr__ = __str__
2344
 
 
2345
 
    def _get_base(self):
2346
 
        """Returns the directory containing the control directory."""
2347
 
        return self._base
2348
 
 
2349
 
    base = property(_get_base, doc="The URL for the root of this branch.")
2350
 
 
2351
 
    def _get_config(self):
2352
 
        return TransportConfig(self._transport, 'branch.conf')
2353
 
 
2354
 
    def is_locked(self):
2355
 
        return self.control_files.is_locked()
2356
 
 
2357
 
    def lock_write(self, token=None):
2358
 
        """Lock the branch for write operations.
2359
 
 
2360
 
        :param token: A token to permit reacquiring a previously held and
2361
 
            preserved lock.
2362
 
        :return: A BranchWriteLockResult.
2363
 
        """
2364
 
        if not self.is_locked():
2365
 
            self._note_lock('w')
2366
 
        # All-in-one needs to always unlock/lock.
2367
 
        repo_control = getattr(self.repository, 'control_files', None)
2368
 
        if self.control_files == repo_control or not self.is_locked():
2369
 
            self.repository._warn_if_deprecated(self)
2370
 
            self.repository.lock_write()
2371
 
            took_lock = True
2372
 
        else:
2373
 
            took_lock = False
2374
 
        try:
2375
 
            return BranchWriteLockResult(self.unlock,
2376
 
                self.control_files.lock_write(token=token))
2377
 
        except:
2378
 
            if took_lock:
2379
 
                self.repository.unlock()
2380
 
            raise
2381
 
 
2382
 
    def lock_read(self):
2383
 
        """Lock the branch for read operations.
2384
 
 
2385
 
        :return: A bzrlib.lock.LogicalLockResult.
2386
 
        """
2387
 
        if not self.is_locked():
2388
 
            self._note_lock('r')
2389
 
        # All-in-one needs to always unlock/lock.
2390
 
        repo_control = getattr(self.repository, 'control_files', None)
2391
 
        if self.control_files == repo_control or not self.is_locked():
2392
 
            self.repository._warn_if_deprecated(self)
2393
 
            self.repository.lock_read()
2394
 
            took_lock = True
2395
 
        else:
2396
 
            took_lock = False
2397
 
        try:
2398
 
            self.control_files.lock_read()
2399
 
            return LogicalLockResult(self.unlock)
2400
 
        except:
2401
 
            if took_lock:
2402
 
                self.repository.unlock()
2403
 
            raise
2404
 
 
2405
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2406
 
    def unlock(self):
2407
 
        try:
2408
 
            self.control_files.unlock()
2409
 
        finally:
2410
 
            # All-in-one needs to always unlock/lock.
2411
 
            repo_control = getattr(self.repository, 'control_files', None)
2412
 
            if (self.control_files == repo_control or
2413
 
                not self.control_files.is_locked()):
2414
 
                self.repository.unlock()
2415
 
            if not self.control_files.is_locked():
2416
 
                # we just released the lock
2417
 
                self._clear_cached_state()
2418
 
 
2419
 
    def peek_lock_mode(self):
2420
 
        if self.control_files._lock_count == 0:
2421
 
            return None
2422
 
        else:
2423
 
            return self.control_files._lock_mode
2424
 
 
2425
 
    def get_physical_lock_status(self):
2426
 
        return self.control_files.get_physical_lock_status()
2427
 
 
2428
 
    @needs_read_lock
2429
 
    def print_file(self, file, revision_id):
2430
 
        """See Branch.print_file."""
2431
 
        return self.repository.print_file(file, revision_id)
2432
 
 
2433
 
    def _write_revision_history(self, history):
2434
 
        """Factored out of set_revision_history.
2435
 
 
2436
 
        This performs the actual writing to disk.
2437
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2438
 
        self._transport.put_bytes(
2439
 
            'revision-history', '\n'.join(history),
2440
 
            mode=self.bzrdir._get_file_mode())
2441
 
 
2442
 
    @needs_write_lock
2443
 
    def set_revision_history(self, rev_history):
2444
 
        """See Branch.set_revision_history."""
2445
 
        if 'evil' in debug.debug_flags:
2446
 
            mutter_callsite(3, "set_revision_history scales with history.")
2447
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2448
 
        for rev_id in rev_history:
2449
 
            check_not_reserved_id(rev_id)
2450
 
        if Branch.hooks['post_change_branch_tip']:
2451
 
            # Don't calculate the last_revision_info() if there are no hooks
2452
 
            # that will use it.
2453
 
            old_revno, old_revid = self.last_revision_info()
2454
 
        if len(rev_history) == 0:
2455
 
            revid = _mod_revision.NULL_REVISION
2456
 
        else:
2457
 
            revid = rev_history[-1]
2458
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2459
 
        self._write_revision_history(rev_history)
2460
 
        self._clear_cached_state()
2461
 
        self._cache_revision_history(rev_history)
2462
 
        for hook in Branch.hooks['set_rh']:
2463
 
            hook(self, rev_history)
2464
 
        if Branch.hooks['post_change_branch_tip']:
2465
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2466
 
 
2467
 
    def _synchronize_history(self, destination, revision_id):
2468
 
        """Synchronize last revision and revision history between branches.
2469
 
 
2470
 
        This version is most efficient when the destination is also a
2471
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2472
 
        history is the true lefthand parent history, and all of the revisions
2473
 
        are in the destination's repository.  If not, set_revision_history
2474
 
        will fail.
2475
 
 
2476
 
        :param destination: The branch to copy the history into
2477
 
        :param revision_id: The revision-id to truncate history at.  May
2478
 
          be None to copy complete history.
2479
 
        """
2480
 
        if not isinstance(destination._format, BzrBranchFormat5):
2481
 
            super(BzrBranch, self)._synchronize_history(
2482
 
                destination, revision_id)
2483
 
            return
2484
 
        if revision_id == _mod_revision.NULL_REVISION:
2485
 
            new_history = []
2486
 
        else:
2487
 
            new_history = self.revision_history()
2488
 
        if revision_id is not None and new_history != []:
2489
 
            try:
2490
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2491
 
            except ValueError:
2492
 
                rev = self.repository.get_revision(revision_id)
2493
 
                new_history = rev.get_history(self.repository)[1:]
2494
 
        destination.set_revision_history(new_history)
2495
 
 
2496
 
    @needs_write_lock
2497
 
    def set_last_revision_info(self, revno, revision_id):
2498
 
        """Set the last revision of this branch.
2499
 
 
2500
 
        The caller is responsible for checking that the revno is correct
2501
 
        for this revision id.
2502
 
 
2503
 
        It may be possible to set the branch last revision to an id not
2504
 
        present in the repository.  However, branches can also be
2505
 
        configured to check constraints on history, in which case this may not
2506
 
        be permitted.
2507
 
        """
2508
 
        revision_id = _mod_revision.ensure_null(revision_id)
2509
 
        # this old format stores the full history, but this api doesn't
2510
 
        # provide it, so we must generate, and might as well check it's
2511
 
        # correct
2512
 
        history = self._lefthand_history(revision_id)
2513
 
        if len(history) != revno:
2514
 
            raise AssertionError('%d != %d' % (len(history), revno))
2515
 
        self.set_revision_history(history)
2516
 
 
2517
 
    def _gen_revision_history(self):
2518
 
        history = self._transport.get_bytes('revision-history').split('\n')
2519
 
        if history[-1:] == ['']:
2520
 
            # There shouldn't be a trailing newline, but just in case.
2521
 
            history.pop()
2522
 
        return history
2523
 
 
2524
 
    @needs_write_lock
2525
 
    def generate_revision_history(self, revision_id, last_rev=None,
2526
 
        other_branch=None):
2527
 
        """Create a new revision history that will finish with revision_id.
2528
 
 
2529
 
        :param revision_id: the new tip to use.
2530
 
        :param last_rev: The previous last_revision. If not None, then this
2531
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2532
 
        :param other_branch: The other branch that DivergedBranches should
2533
 
            raise with respect to.
2534
 
        """
2535
 
        self.set_revision_history(self._lefthand_history(revision_id,
2536
 
            last_rev, other_branch))
2537
 
 
2538
 
    def basis_tree(self):
2539
 
        """See Branch.basis_tree."""
2540
 
        return self.repository.revision_tree(self.last_revision())
2541
 
 
2542
 
    def _get_parent_location(self):
2543
 
        _locs = ['parent', 'pull', 'x-pull']
2544
 
        for l in _locs:
2545
 
            try:
2546
 
                return self._transport.get_bytes(l).strip('\n')
2547
 
            except errors.NoSuchFile:
2548
 
                pass
2549
 
        return None
2550
 
 
2551
 
    def _basic_push(self, target, overwrite, stop_revision):
2552
 
        """Basic implementation of push without bound branches or hooks.
2553
 
 
2554
 
        Must be called with source read locked and target write locked.
2555
 
        """
2556
 
        result = BranchPushResult()
2557
 
        result.source_branch = self
2558
 
        result.target_branch = target
2559
 
        result.old_revno, result.old_revid = target.last_revision_info()
2560
 
        self.update_references(target)
2561
 
        if result.old_revid != self.last_revision():
2562
 
            # We assume that during 'push' this repository is closer than
2563
 
            # the target.
2564
 
            graph = self.repository.get_graph(target.repository)
2565
 
            target.update_revisions(self, stop_revision,
2566
 
                overwrite=overwrite, graph=graph)
2567
 
        if self._push_should_merge_tags():
2568
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2569
 
                overwrite)
2570
 
        result.new_revno, result.new_revid = target.last_revision_info()
2571
 
        return result
2572
 
 
2573
 
    def get_stacked_on_url(self):
2574
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2575
 
 
2576
 
    def set_push_location(self, location):
2577
 
        """See Branch.set_push_location."""
2578
 
        self.get_config().set_user_option(
2579
 
            'push_location', location,
2580
 
            store=_mod_config.STORE_LOCATION_NORECURSE)
2581
 
 
2582
 
    def _set_parent_location(self, url):
2583
 
        if url is None:
2584
 
            self._transport.delete('parent')
2585
 
        else:
2586
 
            self._transport.put_bytes('parent', url + '\n',
2587
 
                mode=self.bzrdir._get_file_mode())
2588
 
 
2589
 
 
2590
 
class BzrBranch5(BzrBranch):
2591
 
    """A format 5 branch. This supports new features over plain branches.
2592
 
 
2593
 
    It has support for a master_branch which is the data for bound branches.
2594
 
    """
2595
 
 
2596
 
    def get_bound_location(self):
2597
 
        try:
2598
 
            return self._transport.get_bytes('bound')[:-1]
2599
 
        except errors.NoSuchFile:
2600
 
            return None
2601
 
 
2602
 
    @needs_read_lock
2603
 
    def get_master_branch(self, possible_transports=None):
2604
 
        """Return the branch we are bound to.
2605
 
 
2606
 
        :return: Either a Branch, or None
2607
 
 
2608
 
        This could memoise the branch, but if thats done
2609
 
        it must be revalidated on each new lock.
2610
 
        So for now we just don't memoise it.
2611
 
        # RBC 20060304 review this decision.
2612
 
        """
2613
 
        bound_loc = self.get_bound_location()
2614
 
        if not bound_loc:
2615
 
            return None
2616
 
        try:
2617
 
            return Branch.open(bound_loc,
2618
 
                               possible_transports=possible_transports)
2619
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2620
 
            raise errors.BoundBranchConnectionFailure(
2621
 
                    self, bound_loc, e)
2622
 
 
2623
 
    @needs_write_lock
2624
 
    def set_bound_location(self, location):
2625
 
        """Set the target where this branch is bound to.
2626
 
 
2627
 
        :param location: URL to the target branch
2628
 
        """
2629
 
        if location:
2630
 
            self._transport.put_bytes('bound', location+'\n',
2631
 
                mode=self.bzrdir._get_file_mode())
2632
 
        else:
2633
 
            try:
2634
 
                self._transport.delete('bound')
2635
 
            except errors.NoSuchFile:
2636
 
                return False
2637
 
            return True
2638
 
 
2639
 
    @needs_write_lock
2640
 
    def bind(self, other):
2641
 
        """Bind this branch to the branch other.
2642
 
 
2643
 
        This does not push or pull data between the branches, though it does
2644
 
        check for divergence to raise an error when the branches are not
2645
 
        either the same, or one a prefix of the other. That behaviour may not
2646
 
        be useful, so that check may be removed in future.
2647
 
 
2648
 
        :param other: The branch to bind to
2649
 
        :type other: Branch
2650
 
        """
2651
 
        # TODO: jam 20051230 Consider checking if the target is bound
2652
 
        #       It is debatable whether you should be able to bind to
2653
 
        #       a branch which is itself bound.
2654
 
        #       Committing is obviously forbidden,
2655
 
        #       but binding itself may not be.
2656
 
        #       Since we *have* to check at commit time, we don't
2657
 
        #       *need* to check here
2658
 
 
2659
 
        # we want to raise diverged if:
2660
 
        # last_rev is not in the other_last_rev history, AND
2661
 
        # other_last_rev is not in our history, and do it without pulling
2662
 
        # history around
2663
 
        self.set_bound_location(other.base)
2664
 
 
2665
 
    @needs_write_lock
2666
 
    def unbind(self):
2667
 
        """If bound, unbind"""
2668
 
        return self.set_bound_location(None)
2669
 
 
2670
 
    @needs_write_lock
2671
 
    def update(self, possible_transports=None):
2672
 
        """Synchronise this branch with the master branch if any.
2673
 
 
2674
 
        :return: None or the last_revision that was pivoted out during the
2675
 
                 update.
2676
 
        """
2677
 
        master = self.get_master_branch(possible_transports)
2678
 
        if master is not None:
2679
 
            old_tip = _mod_revision.ensure_null(self.last_revision())
2680
 
            self.pull(master, overwrite=True)
2681
 
            if self.repository.get_graph().is_ancestor(old_tip,
2682
 
                _mod_revision.ensure_null(self.last_revision())):
2683
 
                return None
2684
 
            return old_tip
2685
 
        return None
2686
 
 
2687
 
 
2688
 
class BzrBranch8(BzrBranch5):
2689
 
    """A branch that stores tree-reference locations."""
2690
 
 
2691
 
    def _open_hook(self):
2692
 
        if self._ignore_fallbacks:
2693
 
            return
2694
 
        try:
2695
 
            url = self.get_stacked_on_url()
2696
 
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2697
 
            errors.UnstackableBranchFormat):
2698
 
            pass
2699
 
        else:
2700
 
            for hook in Branch.hooks['transform_fallback_location']:
2701
 
                url = hook(self, url)
2702
 
                if url is None:
2703
 
                    hook_name = Branch.hooks.get_hook_name(hook)
2704
 
                    raise AssertionError(
2705
 
                        "'transform_fallback_location' hook %s returned "
2706
 
                        "None, not a URL." % hook_name)
2707
 
            self._activate_fallback_location(url)
2708
 
 
2709
 
    def __init__(self, *args, **kwargs):
2710
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2711
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
2712
 
        self._last_revision_info_cache = None
2713
 
        self._reference_info = None
2714
 
 
2715
 
    def _clear_cached_state(self):
2716
 
        super(BzrBranch8, self)._clear_cached_state()
2717
 
        self._last_revision_info_cache = None
2718
 
        self._reference_info = None
2719
 
 
2720
 
    def _last_revision_info(self):
2721
 
        revision_string = self._transport.get_bytes('last-revision')
2722
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2723
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2724
 
        revno = int(revno)
2725
 
        return revno, revision_id
2726
 
 
2727
 
    def _write_last_revision_info(self, revno, revision_id):
2728
 
        """Simply write out the revision id, with no checks.
2729
 
 
2730
 
        Use set_last_revision_info to perform this safely.
2731
 
 
2732
 
        Does not update the revision_history cache.
2733
 
        Intended to be called by set_last_revision_info and
2734
 
        _write_revision_history.
2735
 
        """
2736
 
        revision_id = _mod_revision.ensure_null(revision_id)
2737
 
        out_string = '%d %s\n' % (revno, revision_id)
2738
 
        self._transport.put_bytes('last-revision', out_string,
2739
 
            mode=self.bzrdir._get_file_mode())
2740
 
 
2741
 
    @needs_write_lock
2742
 
    def set_last_revision_info(self, revno, revision_id):
2743
 
        revision_id = _mod_revision.ensure_null(revision_id)
2744
 
        old_revno, old_revid = self.last_revision_info()
2745
 
        if self._get_append_revisions_only():
2746
 
            self._check_history_violation(revision_id)
2747
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2748
 
        self._write_last_revision_info(revno, revision_id)
2749
 
        self._clear_cached_state()
2750
 
        self._last_revision_info_cache = revno, revision_id
2751
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2752
 
 
2753
 
    def _synchronize_history(self, destination, revision_id):
2754
 
        """Synchronize last revision and revision history between branches.
2755
 
 
2756
 
        :see: Branch._synchronize_history
2757
 
        """
2758
 
        # XXX: The base Branch has a fast implementation of this method based
2759
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2760
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2761
 
        # but wants the fast implementation, so it calls
2762
 
        # Branch._synchronize_history directly.
2763
 
        Branch._synchronize_history(self, destination, revision_id)
2764
 
 
2765
 
    def _check_history_violation(self, revision_id):
2766
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
2767
 
        if _mod_revision.is_null(last_revision):
2768
 
            return
2769
 
        if last_revision not in self._lefthand_history(revision_id):
2770
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2771
 
 
2772
 
    def _gen_revision_history(self):
2773
 
        """Generate the revision history from last revision
2774
 
        """
2775
 
        last_revno, last_revision = self.last_revision_info()
2776
 
        self._extend_partial_history(stop_index=last_revno-1)
2777
 
        return list(reversed(self._partial_revision_history_cache))
2778
 
 
2779
 
    def _write_revision_history(self, history):
2780
 
        """Factored out of set_revision_history.
2781
 
 
2782
 
        This performs the actual writing to disk, with format-specific checks.
2783
 
        It is intended to be called by BzrBranch5.set_revision_history.
2784
 
        """
2785
 
        if len(history) == 0:
2786
 
            last_revision = 'null:'
2787
 
        else:
2788
 
            if history != self._lefthand_history(history[-1]):
2789
 
                raise errors.NotLefthandHistory(history)
2790
 
            last_revision = history[-1]
2791
 
        if self._get_append_revisions_only():
2792
 
            self._check_history_violation(last_revision)
2793
 
        self._write_last_revision_info(len(history), last_revision)
2794
 
 
2795
 
    @needs_write_lock
2796
 
    def _set_parent_location(self, url):
2797
 
        """Set the parent branch"""
2798
 
        self._set_config_location('parent_location', url, make_relative=True)
2799
 
 
2800
 
    @needs_read_lock
2801
 
    def _get_parent_location(self):
2802
 
        """Set the parent branch"""
2803
 
        return self._get_config_location('parent_location')
2804
 
 
2805
 
    @needs_write_lock
2806
 
    def _set_all_reference_info(self, info_dict):
2807
 
        """Replace all reference info stored in a branch.
2808
 
 
2809
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2810
 
        """
2811
 
        s = StringIO()
2812
 
        writer = rio.RioWriter(s)
2813
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2814
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2815
 
                                branch_location=branch_location)
2816
 
            writer.write_stanza(stanza)
2817
 
        self._transport.put_bytes('references', s.getvalue())
2818
 
        self._reference_info = info_dict
2819
 
 
2820
 
    @needs_read_lock
2821
 
    def _get_all_reference_info(self):
2822
 
        """Return all the reference info stored in a branch.
2823
 
 
2824
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2825
 
        """
2826
 
        if self._reference_info is not None:
2827
 
            return self._reference_info
2828
 
        rio_file = self._transport.get('references')
2829
 
        try:
2830
 
            stanzas = rio.read_stanzas(rio_file)
2831
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2832
 
                             s['branch_location'])) for s in stanzas)
2833
 
        finally:
2834
 
            rio_file.close()
2835
 
        self._reference_info = info_dict
2836
 
        return info_dict
2837
 
 
2838
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2839
 
        """Set the branch location to use for a tree reference.
2840
 
 
2841
 
        :param file_id: The file-id of the tree reference.
2842
 
        :param tree_path: The path of the tree reference in the tree.
2843
 
        :param branch_location: The location of the branch to retrieve tree
2844
 
            references from.
2845
 
        """
2846
 
        info_dict = self._get_all_reference_info()
2847
 
        info_dict[file_id] = (tree_path, branch_location)
2848
 
        if None in (tree_path, branch_location):
2849
 
            if tree_path is not None:
2850
 
                raise ValueError('tree_path must be None when branch_location'
2851
 
                                 ' is None.')
2852
 
            if branch_location is not None:
2853
 
                raise ValueError('branch_location must be None when tree_path'
2854
 
                                 ' is None.')
2855
 
            del info_dict[file_id]
2856
 
        self._set_all_reference_info(info_dict)
2857
 
 
2858
 
    def get_reference_info(self, file_id):
2859
 
        """Get the tree_path and branch_location for a tree reference.
2860
 
 
2861
 
        :return: a tuple of (tree_path, branch_location)
2862
 
        """
2863
 
        return self._get_all_reference_info().get(file_id, (None, None))
2864
 
 
2865
 
    def reference_parent(self, file_id, path, possible_transports=None):
2866
 
        """Return the parent branch for a tree-reference file_id.
2867
 
 
2868
 
        :param file_id: The file_id of the tree reference
2869
 
        :param path: The path of the file_id in the tree
2870
 
        :return: A branch associated with the file_id
2871
 
        """
2872
 
        branch_location = self.get_reference_info(file_id)[1]
2873
 
        if branch_location is None:
2874
 
            return Branch.reference_parent(self, file_id, path,
2875
 
                                           possible_transports)
2876
 
        branch_location = urlutils.join(self.user_url, branch_location)
2877
 
        return Branch.open(branch_location,
2878
 
                           possible_transports=possible_transports)
2879
 
 
2880
 
    def set_push_location(self, location):
2881
 
        """See Branch.set_push_location."""
2882
 
        self._set_config_location('push_location', location)
2883
 
 
2884
 
    def set_bound_location(self, location):
2885
 
        """See Branch.set_push_location."""
2886
 
        result = None
2887
 
        config = self.get_config()
2888
 
        if location is None:
2889
 
            if config.get_user_option('bound') != 'True':
2890
 
                return False
2891
 
            else:
2892
 
                config.set_user_option('bound', 'False', warn_masked=True)
2893
 
                return True
2894
 
        else:
2895
 
            self._set_config_location('bound_location', location,
2896
 
                                      config=config)
2897
 
            config.set_user_option('bound', 'True', warn_masked=True)
2898
 
        return True
2899
 
 
2900
 
    def _get_bound_location(self, bound):
2901
 
        """Return the bound location in the config file.
2902
 
 
2903
 
        Return None if the bound parameter does not match"""
2904
 
        config = self.get_config()
2905
 
        config_bound = (config.get_user_option('bound') == 'True')
2906
 
        if config_bound != bound:
2907
 
            return None
2908
 
        return self._get_config_location('bound_location', config=config)
2909
 
 
2910
 
    def get_bound_location(self):
2911
 
        """See Branch.set_push_location."""
2912
 
        return self._get_bound_location(True)
2913
 
 
2914
 
    def get_old_bound_location(self):
2915
 
        """See Branch.get_old_bound_location"""
2916
 
        return self._get_bound_location(False)
2917
 
 
2918
 
    def get_stacked_on_url(self):
2919
 
        # you can always ask for the URL; but you might not be able to use it
2920
 
        # if the repo can't support stacking.
2921
 
        ## self._check_stackable_repo()
2922
 
        stacked_url = self._get_config_location('stacked_on_location')
2923
 
        if stacked_url is None:
2924
 
            raise errors.NotStacked(self)
2925
 
        return stacked_url
2926
 
 
2927
 
    def _get_append_revisions_only(self):
2928
 
        return self.get_config(
2929
 
            ).get_user_option_as_bool('append_revisions_only')
2930
 
 
2931
 
    @needs_write_lock
2932
 
    def generate_revision_history(self, revision_id, last_rev=None,
2933
 
                                  other_branch=None):
2934
 
        """See BzrBranch5.generate_revision_history"""
2935
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2936
 
        revno = len(history)
2937
 
        self.set_last_revision_info(revno, revision_id)
2938
 
 
2939
 
    @needs_read_lock
2940
 
    def get_rev_id(self, revno, history=None):
2941
 
        """Find the revision id of the specified revno."""
2942
 
        if revno == 0:
2943
 
            return _mod_revision.NULL_REVISION
2944
 
 
2945
 
        last_revno, last_revision_id = self.last_revision_info()
2946
 
        if revno <= 0 or revno > last_revno:
2947
 
            raise errors.NoSuchRevision(self, revno)
2948
 
 
2949
 
        if history is not None:
2950
 
            return history[revno - 1]
2951
 
 
2952
 
        index = last_revno - revno
2953
 
        if len(self._partial_revision_history_cache) <= index:
2954
 
            self._extend_partial_history(stop_index=index)
2955
 
        if len(self._partial_revision_history_cache) > index:
2956
 
            return self._partial_revision_history_cache[index]
2957
 
        else:
2958
 
            raise errors.NoSuchRevision(self, revno)
2959
 
 
2960
 
    @needs_read_lock
2961
 
    def revision_id_to_revno(self, revision_id):
2962
 
        """Given a revision id, return its revno"""
2963
 
        if _mod_revision.is_null(revision_id):
2964
 
            return 0
2965
 
        try:
2966
 
            index = self._partial_revision_history_cache.index(revision_id)
2967
 
        except ValueError:
2968
 
            self._extend_partial_history(stop_revision=revision_id)
2969
 
            index = len(self._partial_revision_history_cache) - 1
2970
 
            if self._partial_revision_history_cache[index] != revision_id:
2971
 
                raise errors.NoSuchRevision(self, revision_id)
2972
 
        return self.revno() - index
2973
 
 
2974
 
 
2975
 
class BzrBranch7(BzrBranch8):
2976
 
    """A branch with support for a fallback repository."""
2977
 
 
2978
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2979
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2980
 
 
2981
 
    def get_reference_info(self, file_id):
2982
 
        Branch.get_reference_info(self, file_id)
2983
 
 
2984
 
    def reference_parent(self, file_id, path, possible_transports=None):
2985
 
        return Branch.reference_parent(self, file_id, path,
2986
 
                                       possible_transports)
2987
 
 
2988
 
 
2989
 
class BzrBranch6(BzrBranch7):
2990
 
    """See BzrBranchFormat6 for the capabilities of this branch.
2991
 
 
2992
 
    This subclass of BzrBranch7 disables the new features BzrBranch7 added,
2993
 
    i.e. stacking.
2994
 
    """
2995
 
 
2996
 
    def get_stacked_on_url(self):
2997
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2998
 
 
2999
 
 
3000
1966
######################################################################
3001
1967
# results of operations
3002
1968
 
3024
1990
    :ivar local_branch: target branch if there is a Master, else None
3025
1991
    :ivar target_branch: Target/destination branch object. (write locked)
3026
1992
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
1993
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3027
1994
    """
3028
1995
 
3029
 
    def __int__(self):
3030
 
        # DEPRECATED: pull used to return the change in revno
3031
 
        return self.new_revno - self.old_revno
3032
 
 
3033
1996
    def report(self, to_file):
 
1997
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
1998
        tag_updates = getattr(self, "tag_updates", None)
3034
1999
        if not is_quiet():
3035
 
            if self.old_revid == self.new_revid:
3036
 
                to_file.write('No revisions to pull.\n')
3037
 
            else:
 
2000
            if self.old_revid != self.new_revid:
3038
2001
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
2002
            if tag_updates:
 
2003
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
2004
            if self.old_revid == self.new_revid and not tag_updates:
 
2005
                if not tag_conflicts:
 
2006
                    to_file.write('No revisions or tags to pull.\n')
 
2007
                else:
 
2008
                    to_file.write('No revisions to pull.\n')
3039
2009
        self._show_tag_conficts(to_file)
3040
2010
 
3041
2011
 
3058
2028
        target, otherwise it will be None.
3059
2029
    """
3060
2030
 
3061
 
    def __int__(self):
3062
 
        # DEPRECATED: push used to return the change in revno
3063
 
        return self.new_revno - self.old_revno
3064
 
 
3065
2031
    def report(self, to_file):
3066
 
        """Write a human-readable description of the result."""
3067
 
        if self.old_revid == self.new_revid:
3068
 
            note('No new revisions to push.')
3069
 
        else:
3070
 
            note('Pushed up to revision %d.' % self.new_revno)
 
2032
        # TODO: This function gets passed a to_file, but then
 
2033
        # ignores it and calls note() instead. This is also
 
2034
        # inconsistent with PullResult(), which writes to stdout.
 
2035
        # -- JRV20110901, bug #838853
 
2036
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
2037
        tag_updates = getattr(self, "tag_updates", None)
 
2038
        if not is_quiet():
 
2039
            if self.old_revid != self.new_revid:
 
2040
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
2041
            if tag_updates:
 
2042
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
2043
            if self.old_revid == self.new_revid and not tag_updates:
 
2044
                if not tag_conflicts:
 
2045
                    note(gettext('No new revisions or tags to push.'))
 
2046
                else:
 
2047
                    note(gettext('No new revisions to push.'))
3071
2048
        self._show_tag_conficts(to_file)
3072
2049
 
3073
2050
 
3087
2064
        :param verbose: Requests more detailed display of what was checked,
3088
2065
            if any.
3089
2066
        """
3090
 
        note('checked branch %s format %s', self.branch.user_url,
3091
 
            self.branch._format)
 
2067
        note(gettext('checked branch {0} format {1}').format(
 
2068
                                self.branch.user_url, self.branch._format))
3092
2069
        for error in self.errors:
3093
 
            note('found error:%s', error)
3094
 
 
3095
 
 
3096
 
class Converter5to6(object):
3097
 
    """Perform an in-place upgrade of format 5 to format 6"""
3098
 
 
3099
 
    def convert(self, branch):
3100
 
        # Data for 5 and 6 can peacefully coexist.
3101
 
        format = BzrBranchFormat6()
3102
 
        new_branch = format.open(branch.bzrdir, _found=True)
3103
 
 
3104
 
        # Copy source data into target
3105
 
        new_branch._write_last_revision_info(*branch.last_revision_info())
3106
 
        new_branch.set_parent(branch.get_parent())
3107
 
        new_branch.set_bound_location(branch.get_bound_location())
3108
 
        new_branch.set_push_location(branch.get_push_location())
3109
 
 
3110
 
        # New branch has no tags by default
3111
 
        new_branch.tags._set_tag_dict({})
3112
 
 
3113
 
        # Copying done; now update target format
3114
 
        new_branch._transport.put_bytes('format',
3115
 
            format.get_format_string(),
3116
 
            mode=new_branch.bzrdir._get_file_mode())
3117
 
 
3118
 
        # Clean up old files
3119
 
        new_branch._transport.delete('revision-history')
3120
 
        try:
3121
 
            branch.set_parent(None)
3122
 
        except errors.NoSuchFile:
3123
 
            pass
3124
 
        branch.set_bound_location(None)
3125
 
 
3126
 
 
3127
 
class Converter6to7(object):
3128
 
    """Perform an in-place upgrade of format 6 to format 7"""
3129
 
 
3130
 
    def convert(self, branch):
3131
 
        format = BzrBranchFormat7()
3132
 
        branch._set_config_location('stacked_on_location', '')
3133
 
        # update target format
3134
 
        branch._transport.put_bytes('format', format.get_format_string())
3135
 
 
3136
 
 
3137
 
class Converter7to8(object):
3138
 
    """Perform an in-place upgrade of format 6 to format 7"""
3139
 
 
3140
 
    def convert(self, branch):
3141
 
        format = BzrBranchFormat8()
3142
 
        branch._transport.put_bytes('references', '')
3143
 
        # update target format
3144
 
        branch._transport.put_bytes('format', format.get_format_string())
3145
 
 
3146
 
 
3147
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3148
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3149
 
    duration.
3150
 
 
3151
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3152
 
 
3153
 
    If an exception is raised by callable, then that exception *will* be
3154
 
    propagated, even if the unlock attempt raises its own error.  Thus
3155
 
    _run_with_write_locked_target should be preferred to simply doing::
3156
 
 
3157
 
        target.lock_write()
3158
 
        try:
3159
 
            return callable(*args, **kwargs)
3160
 
        finally:
3161
 
            target.unlock()
3162
 
 
3163
 
    """
3164
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3165
 
    # should share code?
3166
 
    target.lock_write()
3167
 
    try:
3168
 
        result = callable(*args, **kwargs)
3169
 
    except:
3170
 
        exc_info = sys.exc_info()
3171
 
        try:
3172
 
            target.unlock()
3173
 
        finally:
3174
 
            raise exc_info[0], exc_info[1], exc_info[2]
3175
 
    else:
3176
 
        target.unlock()
3177
 
        return result
 
2070
            note(gettext('found error:%s'), error)
3178
2071
 
3179
2072
 
3180
2073
class InterBranch(InterObject):
3188
2081
    _optimisers = []
3189
2082
    """The available optimised InterBranch types."""
3190
2083
 
3191
 
    @staticmethod
3192
 
    def _get_branch_formats_to_test():
3193
 
        """Return a tuple with the Branch formats to use when testing."""
3194
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2084
    @classmethod
 
2085
    def _get_branch_formats_to_test(klass):
 
2086
        """Return an iterable of format tuples for testing.
 
2087
        
 
2088
        :return: An iterable of (from_format, to_format) to use when testing
 
2089
            this InterBranch class. Each InterBranch class should define this
 
2090
            method itself.
 
2091
        """
 
2092
        raise NotImplementedError(klass._get_branch_formats_to_test)
3195
2093
 
 
2094
    @needs_write_lock
3196
2095
    def pull(self, overwrite=False, stop_revision=None,
3197
2096
             possible_transports=None, local=False):
3198
2097
        """Mirror source into target branch.
3203
2102
        """
3204
2103
        raise NotImplementedError(self.pull)
3205
2104
 
3206
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3207
 
                         graph=None):
3208
 
        """Pull in new perfect-fit revisions.
3209
 
 
3210
 
        :param stop_revision: Updated until the given revision
3211
 
        :param overwrite: Always set the branch pointer, rather than checking
3212
 
            to see if it is a proper descendant.
3213
 
        :param graph: A Graph object that can be used to query history
3214
 
            information. This can be None.
3215
 
        :return: None
3216
 
        """
3217
 
        raise NotImplementedError(self.update_revisions)
3218
 
 
3219
 
    def push(self, overwrite=False, stop_revision=None,
 
2105
    @needs_write_lock
 
2106
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3220
2107
             _override_hook_source_branch=None):
3221
2108
        """Mirror the source branch into the target branch.
3222
2109
 
3224
2111
        """
3225
2112
        raise NotImplementedError(self.push)
3226
2113
 
 
2114
    @needs_write_lock
 
2115
    def copy_content_into(self, revision_id=None):
 
2116
        """Copy the content of source into target
 
2117
 
 
2118
        revision_id: if not None, the revision history in the new branch will
 
2119
                     be truncated to end with revision_id.
 
2120
        """
 
2121
        raise NotImplementedError(self.copy_content_into)
 
2122
 
 
2123
    @needs_write_lock
 
2124
    def fetch(self, stop_revision=None, limit=None):
 
2125
        """Fetch revisions.
 
2126
 
 
2127
        :param stop_revision: Last revision to fetch
 
2128
        :param limit: Optional rough limit of revisions to fetch
 
2129
        """
 
2130
        raise NotImplementedError(self.fetch)
 
2131
 
 
2132
 
 
2133
def _fix_overwrite_type(overwrite):
 
2134
    if isinstance(overwrite, bool):
 
2135
        if overwrite:
 
2136
            return ["history", "tags"]
 
2137
        else:
 
2138
            return []
 
2139
    return overwrite
 
2140
 
3227
2141
 
3228
2142
class GenericInterBranch(InterBranch):
3229
 
    """InterBranch implementation that uses public Branch functions.
3230
 
    """
3231
 
 
3232
 
    @staticmethod
3233
 
    def _get_branch_formats_to_test():
3234
 
        return BranchFormat._default_format, BranchFormat._default_format
3235
 
 
3236
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3237
 
        graph=None):
3238
 
        """See InterBranch.update_revisions()."""
 
2143
    """InterBranch implementation that uses public Branch functions."""
 
2144
 
 
2145
    @classmethod
 
2146
    def is_compatible(klass, source, target):
 
2147
        # GenericBranch uses the public API, so always compatible
 
2148
        return True
 
2149
 
 
2150
    @classmethod
 
2151
    def _get_branch_formats_to_test(klass):
 
2152
        return [(format_registry.get_default(), format_registry.get_default())]
 
2153
 
 
2154
    @classmethod
 
2155
    def unwrap_format(klass, format):
 
2156
        if isinstance(format, remote.RemoteBranchFormat):
 
2157
            format._ensure_real()
 
2158
            return format._custom_format
 
2159
        return format
 
2160
 
 
2161
    @needs_write_lock
 
2162
    def copy_content_into(self, revision_id=None):
 
2163
        """Copy the content of source into target
 
2164
 
 
2165
        revision_id: if not None, the revision history in the new branch will
 
2166
                     be truncated to end with revision_id.
 
2167
        """
 
2168
        self.source.update_references(self.target)
 
2169
        self.source._synchronize_history(self.target, revision_id)
 
2170
        try:
 
2171
            parent = self.source.get_parent()
 
2172
        except errors.InaccessibleParent as e:
 
2173
            mutter('parent was not accessible to copy: %s', e)
 
2174
        else:
 
2175
            if parent:
 
2176
                self.target.set_parent(parent)
 
2177
        if self.source._push_should_merge_tags():
 
2178
            self.source.tags.merge_to(self.target.tags)
 
2179
 
 
2180
    @needs_write_lock
 
2181
    def fetch(self, stop_revision=None, limit=None):
 
2182
        if self.target.base == self.source.base:
 
2183
            return (0, [])
3239
2184
        self.source.lock_read()
3240
2185
        try:
3241
 
            other_revno, other_last_revision = self.source.last_revision_info()
3242
 
            stop_revno = None # unknown
3243
 
            if stop_revision is None:
3244
 
                stop_revision = other_last_revision
3245
 
                if _mod_revision.is_null(stop_revision):
3246
 
                    # if there are no commits, we're done.
3247
 
                    return
3248
 
                stop_revno = other_revno
3249
 
 
3250
 
            # what's the current last revision, before we fetch [and change it
3251
 
            # possibly]
3252
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3253
 
            # we fetch here so that we don't process data twice in the common
3254
 
            # case of having something to pull, and so that the check for
3255
 
            # already merged can operate on the just fetched graph, which will
3256
 
            # be cached in memory.
3257
 
            self.target.fetch(self.source, stop_revision)
3258
 
            # Check to see if one is an ancestor of the other
3259
 
            if not overwrite:
3260
 
                if graph is None:
3261
 
                    graph = self.target.repository.get_graph()
3262
 
                if self.target._check_if_descendant_or_diverged(
3263
 
                        stop_revision, last_rev, graph, self.source):
3264
 
                    # stop_revision is a descendant of last_rev, but we aren't
3265
 
                    # overwriting, so we're done.
3266
 
                    return
3267
 
            if stop_revno is None:
3268
 
                if graph is None:
3269
 
                    graph = self.target.repository.get_graph()
3270
 
                this_revno, this_last_revision = \
3271
 
                        self.target.last_revision_info()
3272
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3273
 
                                [(other_last_revision, other_revno),
3274
 
                                 (this_last_revision, this_revno)])
3275
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
2186
            fetch_spec_factory = fetch.FetchSpecFactory()
 
2187
            fetch_spec_factory.source_branch = self.source
 
2188
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
2189
            fetch_spec_factory.source_repo = self.source.repository
 
2190
            fetch_spec_factory.target_repo = self.target.repository
 
2191
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
2192
            fetch_spec_factory.limit = limit
 
2193
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
2194
            return self.target.repository.fetch(self.source.repository,
 
2195
                fetch_spec=fetch_spec)
3276
2196
        finally:
3277
2197
            self.source.unlock()
3278
2198
 
 
2199
    @needs_write_lock
 
2200
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
2201
            graph=None):
 
2202
        other_revno, other_last_revision = self.source.last_revision_info()
 
2203
        stop_revno = None # unknown
 
2204
        if stop_revision is None:
 
2205
            stop_revision = other_last_revision
 
2206
            if _mod_revision.is_null(stop_revision):
 
2207
                # if there are no commits, we're done.
 
2208
                return
 
2209
            stop_revno = other_revno
 
2210
 
 
2211
        # what's the current last revision, before we fetch [and change it
 
2212
        # possibly]
 
2213
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2214
        # we fetch here so that we don't process data twice in the common
 
2215
        # case of having something to pull, and so that the check for
 
2216
        # already merged can operate on the just fetched graph, which will
 
2217
        # be cached in memory.
 
2218
        self.fetch(stop_revision=stop_revision)
 
2219
        # Check to see if one is an ancestor of the other
 
2220
        if not overwrite:
 
2221
            if graph is None:
 
2222
                graph = self.target.repository.get_graph()
 
2223
            if self.target._check_if_descendant_or_diverged(
 
2224
                    stop_revision, last_rev, graph, self.source):
 
2225
                # stop_revision is a descendant of last_rev, but we aren't
 
2226
                # overwriting, so we're done.
 
2227
                return
 
2228
        if stop_revno is None:
 
2229
            if graph is None:
 
2230
                graph = self.target.repository.get_graph()
 
2231
            this_revno, this_last_revision = \
 
2232
                    self.target.last_revision_info()
 
2233
            stop_revno = graph.find_distance_to_null(stop_revision,
 
2234
                            [(other_last_revision, other_revno),
 
2235
                             (this_last_revision, this_revno)])
 
2236
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
2237
 
 
2238
    @needs_write_lock
3279
2239
    def pull(self, overwrite=False, stop_revision=None,
 
2240
             possible_transports=None, run_hooks=True,
 
2241
             _override_hook_target=None, local=False):
 
2242
        """Pull from source into self, updating my master if any.
 
2243
 
 
2244
        :param run_hooks: Private parameter - if false, this branch
 
2245
            is being called because it's the master of the primary branch,
 
2246
            so it should not run its hooks.
 
2247
        """
 
2248
        bound_location = self.target.get_bound_location()
 
2249
        if local and not bound_location:
 
2250
            raise errors.LocalRequiresBoundBranch()
 
2251
        master_branch = None
 
2252
        source_is_master = False
 
2253
        if bound_location:
 
2254
            # bound_location comes from a config file, some care has to be
 
2255
            # taken to relate it to source.user_url
 
2256
            normalized = urlutils.normalize_url(bound_location)
 
2257
            try:
 
2258
                relpath = self.source.user_transport.relpath(normalized)
 
2259
                source_is_master = (relpath == '')
 
2260
            except (errors.PathNotChild, errors.InvalidURL):
 
2261
                source_is_master = False
 
2262
        if not local and bound_location and not source_is_master:
 
2263
            # not pulling from master, so we need to update master.
 
2264
            master_branch = self.target.get_master_branch(possible_transports)
 
2265
            master_branch.lock_write()
 
2266
        try:
 
2267
            if master_branch:
 
2268
                # pull from source into master.
 
2269
                master_branch.pull(self.source, overwrite, stop_revision,
 
2270
                    run_hooks=False)
 
2271
            return self._pull(overwrite,
 
2272
                stop_revision, _hook_master=master_branch,
 
2273
                run_hooks=run_hooks,
 
2274
                _override_hook_target=_override_hook_target,
 
2275
                merge_tags_to_master=not source_is_master)
 
2276
        finally:
 
2277
            if master_branch:
 
2278
                master_branch.unlock()
 
2279
 
 
2280
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2281
             _override_hook_source_branch=None):
 
2282
        """See InterBranch.push.
 
2283
 
 
2284
        This is the basic concrete implementation of push()
 
2285
 
 
2286
        :param _override_hook_source_branch: If specified, run the hooks
 
2287
            passing this Branch as the source, rather than self.  This is for
 
2288
            use of RemoteBranch, where push is delegated to the underlying
 
2289
            vfs-based Branch.
 
2290
        """
 
2291
        if lossy:
 
2292
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
2293
        # TODO: Public option to disable running hooks - should be trivial but
 
2294
        # needs tests.
 
2295
 
 
2296
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
2297
        op.add_cleanup(self.source.lock_read().unlock)
 
2298
        op.add_cleanup(self.target.lock_write().unlock)
 
2299
        return op.run(overwrite, stop_revision,
 
2300
            _override_hook_source_branch=_override_hook_source_branch)
 
2301
 
 
2302
    def _basic_push(self, overwrite, stop_revision):
 
2303
        """Basic implementation of push without bound branches or hooks.
 
2304
 
 
2305
        Must be called with source read locked and target write locked.
 
2306
        """
 
2307
        result = BranchPushResult()
 
2308
        result.source_branch = self.source
 
2309
        result.target_branch = self.target
 
2310
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
2311
        self.source.update_references(self.target)
 
2312
        overwrite = _fix_overwrite_type(overwrite)
 
2313
        if result.old_revid != stop_revision:
 
2314
            # We assume that during 'push' this repository is closer than
 
2315
            # the target.
 
2316
            graph = self.source.repository.get_graph(self.target.repository)
 
2317
            self._update_revisions(stop_revision,
 
2318
                overwrite=("history" in overwrite),
 
2319
                graph=graph)
 
2320
        if self.source._push_should_merge_tags():
 
2321
            result.tag_updates, result.tag_conflicts = (
 
2322
                self.source.tags.merge_to(
 
2323
                self.target.tags, "tags" in overwrite))
 
2324
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
2325
        return result
 
2326
 
 
2327
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
2328
            _override_hook_source_branch=None):
 
2329
        """Push from source into target, and into target's master if any.
 
2330
        """
 
2331
        def _run_hooks():
 
2332
            if _override_hook_source_branch:
 
2333
                result.source_branch = _override_hook_source_branch
 
2334
            for hook in Branch.hooks['post_push']:
 
2335
                hook(result)
 
2336
 
 
2337
        bound_location = self.target.get_bound_location()
 
2338
        if bound_location and self.target.base != bound_location:
 
2339
            # there is a master branch.
 
2340
            #
 
2341
            # XXX: Why the second check?  Is it even supported for a branch to
 
2342
            # be bound to itself? -- mbp 20070507
 
2343
            master_branch = self.target.get_master_branch()
 
2344
            master_branch.lock_write()
 
2345
            operation.add_cleanup(master_branch.unlock)
 
2346
            # push into the master from the source branch.
 
2347
            master_inter = InterBranch.get(self.source, master_branch)
 
2348
            master_inter._basic_push(overwrite, stop_revision)
 
2349
            # and push into the target branch from the source. Note that
 
2350
            # we push from the source branch again, because it's considered
 
2351
            # the highest bandwidth repository.
 
2352
            result = self._basic_push(overwrite, stop_revision)
 
2353
            result.master_branch = master_branch
 
2354
            result.local_branch = self.target
 
2355
        else:
 
2356
            master_branch = None
 
2357
            # no master branch
 
2358
            result = self._basic_push(overwrite, stop_revision)
 
2359
            # TODO: Why set master_branch and local_branch if there's no
 
2360
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2361
            # 20070504
 
2362
            result.master_branch = self.target
 
2363
            result.local_branch = None
 
2364
        _run_hooks()
 
2365
        return result
 
2366
 
 
2367
    def _pull(self, overwrite=False, stop_revision=None,
3280
2368
             possible_transports=None, _hook_master=None, run_hooks=True,
3281
 
             _override_hook_target=None, local=False):
 
2369
             _override_hook_target=None, local=False,
 
2370
             merge_tags_to_master=True):
3282
2371
        """See Branch.pull.
3283
2372
 
 
2373
        This function is the core worker, used by GenericInterBranch.pull to
 
2374
        avoid duplication when pulling source->master and source->local.
 
2375
 
3284
2376
        :param _hook_master: Private parameter - set the branch to
3285
2377
            be supplied as the master to pull hooks.
3286
2378
        :param run_hooks: Private parameter - if false, this branch
3287
2379
            is being called because it's the master of the primary branch,
3288
2380
            so it should not run its hooks.
 
2381
            is being called because it's the master of the primary branch,
 
2382
            so it should not run its hooks.
3289
2383
        :param _override_hook_target: Private parameter - set the branch to be
3290
2384
            supplied as the target_branch to pull hooks.
3291
2385
        :param local: Only update the local branch, and not the bound branch.
3310
2404
            # -- JRV20090506
3311
2405
            result.old_revno, result.old_revid = \
3312
2406
                self.target.last_revision_info()
3313
 
            self.target.update_revisions(self.source, stop_revision,
3314
 
                overwrite=overwrite, graph=graph)
 
2407
            overwrite = _fix_overwrite_type(overwrite)
 
2408
            self._update_revisions(stop_revision,
 
2409
                overwrite=("history" in overwrite),
 
2410
                graph=graph)
3315
2411
            # TODO: The old revid should be specified when merging tags, 
3316
2412
            # so a tags implementation that versions tags can only 
3317
2413
            # pull in the most recent changes. -- JRV20090506
3318
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3319
 
                overwrite)
 
2414
            result.tag_updates, result.tag_conflicts = (
 
2415
                self.source.tags.merge_to(self.target.tags,
 
2416
                    "tags" in overwrite,
 
2417
                    ignore_master=not merge_tags_to_master))
3320
2418
            result.new_revno, result.new_revid = self.target.last_revision_info()
3321
2419
            if _hook_master:
3322
2420
                result.master_branch = _hook_master
3331
2429
            self.source.unlock()
3332
2430
        return result
3333
2431
 
3334
 
    def push(self, overwrite=False, stop_revision=None,
3335
 
             _override_hook_source_branch=None):
3336
 
        """See InterBranch.push.
3337
 
 
3338
 
        This is the basic concrete implementation of push()
3339
 
 
3340
 
        :param _override_hook_source_branch: If specified, run
3341
 
        the hooks passing this Branch as the source, rather than self.
3342
 
        This is for use of RemoteBranch, where push is delegated to the
3343
 
        underlying vfs-based Branch.
3344
 
        """
3345
 
        # TODO: Public option to disable running hooks - should be trivial but
3346
 
        # needs tests.
3347
 
        self.source.lock_read()
3348
 
        try:
3349
 
            return _run_with_write_locked_target(
3350
 
                self.target, self._push_with_bound_branches, overwrite,
3351
 
                stop_revision,
3352
 
                _override_hook_source_branch=_override_hook_source_branch)
3353
 
        finally:
3354
 
            self.source.unlock()
3355
 
 
3356
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3357
 
            _override_hook_source_branch=None):
3358
 
        """Push from source into target, and into target's master if any.
3359
 
        """
3360
 
        def _run_hooks():
3361
 
            if _override_hook_source_branch:
3362
 
                result.source_branch = _override_hook_source_branch
3363
 
            for hook in Branch.hooks['post_push']:
3364
 
                hook(result)
3365
 
 
3366
 
        bound_location = self.target.get_bound_location()
3367
 
        if bound_location and self.target.base != bound_location:
3368
 
            # there is a master branch.
3369
 
            #
3370
 
            # XXX: Why the second check?  Is it even supported for a branch to
3371
 
            # be bound to itself? -- mbp 20070507
3372
 
            master_branch = self.target.get_master_branch()
3373
 
            master_branch.lock_write()
3374
 
            try:
3375
 
                # push into the master from the source branch.
3376
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3377
 
                # and push into the target branch from the source. Note that we
3378
 
                # push from the source branch again, because its considered the
3379
 
                # highest bandwidth repository.
3380
 
                result = self.source._basic_push(self.target, overwrite,
3381
 
                    stop_revision)
3382
 
                result.master_branch = master_branch
3383
 
                result.local_branch = self.target
3384
 
                _run_hooks()
3385
 
                return result
3386
 
            finally:
3387
 
                master_branch.unlock()
3388
 
        else:
3389
 
            # no master branch
3390
 
            result = self.source._basic_push(self.target, overwrite,
3391
 
                stop_revision)
3392
 
            # TODO: Why set master_branch and local_branch if there's no
3393
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3394
 
            # 20070504
3395
 
            result.master_branch = self.target
3396
 
            result.local_branch = None
3397
 
            _run_hooks()
3398
 
            return result
3399
 
 
3400
 
    @classmethod
3401
 
    def is_compatible(self, source, target):
3402
 
        # GenericBranch uses the public API, so always compatible
3403
 
        return True
3404
 
 
3405
 
 
3406
 
class InterToBranch5(GenericInterBranch):
3407
 
 
3408
 
    @staticmethod
3409
 
    def _get_branch_formats_to_test():
3410
 
        return BranchFormat._default_format, BzrBranchFormat5()
3411
 
 
3412
 
    def pull(self, overwrite=False, stop_revision=None,
3413
 
             possible_transports=None, run_hooks=True,
3414
 
             _override_hook_target=None, local=False):
3415
 
        """Pull from source into self, updating my master if any.
3416
 
 
3417
 
        :param run_hooks: Private parameter - if false, this branch
3418
 
            is being called because it's the master of the primary branch,
3419
 
            so it should not run its hooks.
3420
 
        """
3421
 
        bound_location = self.target.get_bound_location()
3422
 
        if local and not bound_location:
3423
 
            raise errors.LocalRequiresBoundBranch()
3424
 
        master_branch = None
3425
 
        if not local and bound_location and self.source.user_url != bound_location:
3426
 
            # not pulling from master, so we need to update master.
3427
 
            master_branch = self.target.get_master_branch(possible_transports)
3428
 
            master_branch.lock_write()
3429
 
        try:
3430
 
            if master_branch:
3431
 
                # pull from source into master.
3432
 
                master_branch.pull(self.source, overwrite, stop_revision,
3433
 
                    run_hooks=False)
3434
 
            return super(InterToBranch5, self).pull(overwrite,
3435
 
                stop_revision, _hook_master=master_branch,
3436
 
                run_hooks=run_hooks,
3437
 
                _override_hook_target=_override_hook_target)
3438
 
        finally:
3439
 
            if master_branch:
3440
 
                master_branch.unlock()
3441
 
 
3442
2432
 
3443
2433
InterBranch.register_optimiser(GenericInterBranch)
3444
 
InterBranch.register_optimiser(InterToBranch5)