~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-03-25 00:02:51 UTC
  • mfrom: (5106.1.1 version-bump)
  • Revision ID: pqm@pqm.ubuntu.com-20100325000251-bwsv5c5d3l9x3lnn
(Jelmer) Bump API version for 2.2.0.

Show diffs side-by-side

added added

removed removed

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