~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Vincent Ladeuil
  • Date: 2011-12-21 14:25:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6397.
  • Revision ID: v.ladeuil+lp@free.fr-20111221142526-pnwau0xnalimujts
Provides MemoryStack to simplify configuration setup in tests

Show diffs side-by-side

added added

removed removed

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