~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-10-14 13:56:45 UTC
  • mfrom: (6215 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20111014135645-phc3q3y21k2ks0s2
Merge bzr.dev.

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