/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/branch.py

  • Committer: Martin
  • Date: 2017-06-05 20:48:31 UTC
  • mto: This revision was merged to the branch mainline in revision 6658.
  • Revision ID: gzlist@googlemail.com-20170605204831-20accykspjcrx0a8
Apply 2to3 dict fixer and clean up resulting mess using view helpers

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