/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: Jelmer Vernooij
  • Date: 2017-06-10 01:39:46 UTC
  • mto: This revision was merged to the branch mainline in revision 6690.
  • Revision ID: jelmer@jelmer.uk-20170610013946-08donzxbo8iv0ewz
Fix more imports.

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