~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Wouter van Heyst
  • Date: 2012-01-25 21:13:15 UTC
  • mto: (6437.3.27 2.5)
  • mto: This revision was merged to the branch mainline in revision 6451.
  • Revision ID: larstiq@larstiq.dyndns.org-20120125211315-ch74doua37bqet0i
mechanically replace file().write() pattern with a with-keyword version

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