~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2009-06-09 00:59:51 UTC
  • mto: (4443.1.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4444.
  • Revision ID: jelmer@samba.org-20090609005951-apv900cdk35o2ygh
Move squashing of XML-invalid characters to XMLSerializer.

Show diffs side-by-side

added added

removed removed

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