~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-06-02 18:59:18 UTC
  • mto: This revision was merged to the branch mainline in revision 4469.
  • Revision ID: john@arbash-meinel.com-20090602185918-86l9eljnn8z2iljk
Add a VersionedFile.add_text() api.

Similar to VF.add_lines() except it takes a string for the content, rather
than a list of lines.

For now, it just thunks over to VF.add_lines(), but it will be special
cased in the future.

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
1313
1085
        source_revno, source_revision_id = self.last_revision_info()
1314
1086
        if revision_id is None:
1315
1087
            revno, revision_id = source_revno, source_revision_id
 
1088
        elif source_revision_id == revision_id:
 
1089
            # we know the revno without needing to walk all of history
 
1090
            revno = source_revno
1316
1091
        else:
1317
 
            graph = self.repository.get_graph()
1318
 
            try:
1319
 
                revno = graph.find_distance_to_null(revision_id, 
1320
 
                    [(source_revision_id, source_revno)])
1321
 
            except errors.GhostRevisionsHaveNoRevno:
1322
 
                # Default to 1, if we can't find anything else
1323
 
                revno = 1
 
1092
            # To figure out the revno for a random revision, we need to build
 
1093
            # the revision history, and count its length.
 
1094
            # We don't care about the order, just how long it is.
 
1095
            # Alternatively, we could start at the current location, and count
 
1096
            # backwards. But there is no guarantee that we will find it since
 
1097
            # it may be a merged revision.
 
1098
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1099
                                                                revision_id)))
1324
1100
        destination.set_last_revision_info(revno, revision_id)
1325
1101
 
 
1102
    @needs_read_lock
1326
1103
    def copy_content_into(self, destination, revision_id=None):
1327
1104
        """Copy the content of self into destination.
1328
1105
 
1329
1106
        revision_id: if not None, the revision history in the new branch will
1330
1107
                     be truncated to end with revision_id.
1331
1108
        """
1332
 
        return InterBranch.get(self, destination).copy_content_into(
1333
 
            revision_id=revision_id)
 
1109
        self.update_references(destination)
 
1110
        self._synchronize_history(destination, revision_id)
 
1111
        try:
 
1112
            parent = self.get_parent()
 
1113
        except errors.InaccessibleParent, e:
 
1114
            mutter('parent was not accessible to copy: %s', e)
 
1115
        else:
 
1116
            if parent:
 
1117
                destination.set_parent(parent)
 
1118
        if self._push_should_merge_tags():
 
1119
            self.tags.merge_to(destination.tags)
1334
1120
 
1335
1121
    def update_references(self, target):
1336
1122
        if not getattr(self._format, 'supports_reference_locations', False):
1350
1136
        target._set_all_reference_info(target_reference_dict)
1351
1137
 
1352
1138
    @needs_read_lock
1353
 
    def check(self, refs):
 
1139
    def check(self):
1354
1140
        """Check consistency of the branch.
1355
1141
 
1356
1142
        In particular this checks that revisions given in the revision-history
1359
1145
 
1360
1146
        Callers will typically also want to check the repository.
1361
1147
 
1362
 
        :param refs: Calculated refs for this branch as specified by
1363
 
            branch._get_check_refs()
1364
1148
        :return: A BranchCheckResult.
1365
1149
        """
1366
 
        result = BranchCheckResult(self)
 
1150
        mainline_parent_id = None
1367
1151
        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
 
1152
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1153
                                last_revision_id))
 
1154
        real_rev_history.reverse()
 
1155
        if len(real_rev_history) != last_revno:
 
1156
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1157
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1158
        # TODO: We should probably also check that real_rev_history actually
 
1159
        #       matches self.revision_history()
 
1160
        for revision_id in real_rev_history:
 
1161
            try:
 
1162
                revision = self.repository.get_revision(revision_id)
 
1163
            except errors.NoSuchRevision, e:
 
1164
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1165
                            % revision_id)
 
1166
            # In general the first entry on the revision history has no parents.
 
1167
            # But it's not illegal for it to have parents listed; this can happen
 
1168
            # in imports from Arch when the parents weren't reachable.
 
1169
            if mainline_parent_id is not None:
 
1170
                if mainline_parent_id not in revision.parent_ids:
 
1171
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1172
                                        "parents of {%s}"
 
1173
                                        % (mainline_parent_id, revision_id))
 
1174
            mainline_parent_id = revision_id
 
1175
        return BranchCheckResult(self)
1379
1176
 
1380
1177
    def _get_checkout_format(self):
1381
1178
        """Return the most suitable metadir for a checkout of this branch.
1382
1179
        Weaves are used if this branch's repository uses weaves.
1383
1180
        """
1384
 
        format = self.repository.bzrdir.checkout_metadir()
1385
 
        format.set_branch_format(self._format)
 
1181
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1182
            from bzrlib.repofmt import weaverepo
 
1183
            format = bzrdir.BzrDirMetaFormat1()
 
1184
            format.repository_format = weaverepo.RepositoryFormat7()
 
1185
        else:
 
1186
            format = self.repository.bzrdir.checkout_metadir()
 
1187
            format.set_branch_format(self._format)
1386
1188
        return format
1387
1189
 
1388
1190
    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):
 
1191
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1391
1192
        """Create a clone of this branch and its bzrdir.
1392
1193
 
1393
1194
        :param to_transport: The transport to clone onto.
1400
1201
        """
1401
1202
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1402
1203
        # 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
1204
        if revision_id is None:
1406
1205
            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)
 
1206
        try:
 
1207
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1208
                revision_id=revision_id, stacked_on=stacked_on,
 
1209
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1210
        except errors.FileExists:
 
1211
            if not use_existing_dir:
 
1212
                raise
 
1213
        except errors.NoSuchFile:
 
1214
            if not create_prefix:
 
1215
                raise
1411
1216
        return dir_to.open_branch()
1412
1217
 
1413
1218
    def create_checkout(self, to_location, revision_id=None,
1418
1223
        :param to_location: The url to produce the checkout at
1419
1224
        :param revision_id: The revision to check out
1420
1225
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1421
 
            produce a bound branch (heavyweight checkout)
 
1226
        produce a bound branch (heavyweight checkout)
1422
1227
        :param accelerator_tree: A tree which can be used for retrieving file
1423
1228
            contents more quickly than the revision tree, i.e. a workingtree.
1424
1229
            The revision tree will be used for cases where accelerator_tree's
1432
1237
        if lightweight:
1433
1238
            format = self._get_checkout_format()
1434
1239
            checkout = format.initialize_on_transport(t)
1435
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1436
 
                target_branch=self)
 
1240
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1437
1241
        else:
1438
1242
            format = self._get_checkout_format()
1439
1243
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1470
1274
 
1471
1275
    def reference_parent(self, file_id, path, possible_transports=None):
1472
1276
        """Return the parent branch for a tree-reference file_id
1473
 
 
1474
1277
        :param file_id: The file_id of the tree reference
1475
1278
        :param path: The path of the file_id in the tree
1476
1279
        :return: A branch associated with the file_id
1482
1285
    def supports_tags(self):
1483
1286
        return self._format.supports_tags()
1484
1287
 
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
1288
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1498
1289
                                         other_branch):
1499
1290
        """Ensure that revision_b is a descendant of revision_a.
1529
1320
        else:
1530
1321
            raise AssertionError("invalid heads: %r" % (heads,))
1531
1322
 
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):
 
1323
 
 
1324
class BranchFormat(object):
1559
1325
    """An encapsulation of the initialization and open routines for a format.
1560
1326
 
1561
1327
    Formats provide three things:
1564
1330
     * an open routine.
1565
1331
 
1566
1332
    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
 
1333
    during branch opening. Its not required that these be instances, they
1568
1334
    can be classes themselves with class methods - it simply depends on
1569
1335
    whether state is needed for a given format or not.
1570
1336
 
1573
1339
    object will be created every time regardless.
1574
1340
    """
1575
1341
 
1576
 
    can_set_append_revisions_only = True
 
1342
    _default_format = None
 
1343
    """The default format used for new branches."""
 
1344
 
 
1345
    _formats = {}
 
1346
    """The known formats."""
1577
1347
 
1578
1348
    def __eq__(self, other):
1579
1349
        return self.__class__ is other.__class__
1582
1352
        return not (self == other)
1583
1353
 
1584
1354
    @classmethod
1585
 
    def find_format(klass, a_bzrdir, name=None):
 
1355
    def find_format(klass, a_bzrdir):
1586
1356
        """Return the format for the branch object in a_bzrdir."""
1587
1357
        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)
 
1358
            transport = a_bzrdir.get_branch_transport(None)
 
1359
            format_string = transport.get("format").read()
 
1360
            return klass._formats[format_string]
1591
1361
        except errors.NoSuchFile:
1592
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1362
            raise errors.NotBranchError(path=transport.base)
1593
1363
        except KeyError:
1594
1364
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1595
1365
 
1596
1366
    @classmethod
1597
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1598
1367
    def get_default_format(klass):
1599
1368
        """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):
 
1369
        return klass._default_format
 
1370
 
 
1371
    def get_reference(self, a_bzrdir):
1613
1372
        """Get the target reference of the branch in a_bzrdir.
1614
1373
 
1615
1374
        format probing must have been completed before calling
1617
1376
        in a_bzrdir is correct.
1618
1377
 
1619
1378
        :param a_bzrdir: The bzrdir to get the branch data from.
1620
 
        :param name: Name of the colocated branch to fetch
1621
1379
        :return: None if the branch is not a reference branch.
1622
1380
        """
1623
1381
        return None
1624
1382
 
1625
1383
    @classmethod
1626
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1384
    def set_reference(self, a_bzrdir, to_branch):
1627
1385
        """Set the target reference of the branch in a_bzrdir.
1628
1386
 
1629
1387
        format probing must have been completed before calling
1631
1389
        in a_bzrdir is correct.
1632
1390
 
1633
1391
        :param a_bzrdir: The bzrdir to set the branch reference for.
1634
 
        :param name: Name of colocated branch to set, None for default
1635
1392
        :param to_branch: branch that the checkout is to reference
1636
1393
        """
1637
1394
        raise NotImplementedError(self.set_reference)
1644
1401
        """Return the short format description for this format."""
1645
1402
        raise NotImplementedError(self.get_format_description)
1646
1403
 
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)
 
1404
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1405
                           set_format=True):
 
1406
        """Initialize a branch in a bzrdir, with specified files
1654
1407
 
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.
 
1408
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1409
        :param utf8_files: The files to create as a list of
 
1410
            (filename, content) tuples
 
1411
        :param set_format: If True, set the format with
 
1412
            self.get_format_string.  (BzrBranch4 has its format set
 
1413
            elsewhere)
 
1414
        :return: a branch in this format
1659
1415
        """
 
1416
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1417
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1418
        lock_map = {
 
1419
            'metadir': ('lock', lockdir.LockDir),
 
1420
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1421
        }
 
1422
        lock_name, lock_class = lock_map[lock_type]
 
1423
        control_files = lockable_files.LockableFiles(branch_transport,
 
1424
            lock_name, lock_class)
 
1425
        control_files.create_lock()
 
1426
        try:
 
1427
            control_files.lock_write()
 
1428
        except errors.LockContention:
 
1429
            if lock_type != 'branch4':
 
1430
                raise
 
1431
            lock_taken = False
 
1432
        else:
 
1433
            lock_taken = True
 
1434
        if set_format:
 
1435
            utf8_files += [('format', self.get_format_string())]
 
1436
        try:
 
1437
            for (filename, content) in utf8_files:
 
1438
                branch_transport.put_bytes(
 
1439
                    filename, content,
 
1440
                    mode=a_bzrdir._get_file_mode())
 
1441
        finally:
 
1442
            if lock_taken:
 
1443
                control_files.unlock()
 
1444
        return self.open(a_bzrdir, _found=True)
 
1445
 
 
1446
    def initialize(self, a_bzrdir):
 
1447
        """Create a branch of this format in a_bzrdir."""
1660
1448
        raise NotImplementedError(self.initialize)
1661
1449
 
1662
1450
    def is_supported(self):
1692
1480
        """
1693
1481
        raise NotImplementedError(self.network_name)
1694
1482
 
1695
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1696
 
            found_repository=None):
 
1483
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1697
1484
        """Return the branch object for a_bzrdir
1698
1485
 
1699
1486
        :param a_bzrdir: A BzrDir that contains a branch.
1700
 
        :param name: Name of colocated branch to open
1701
1487
        :param _found: a private parameter, do not use it. It is used to
1702
1488
            indicate if format probing has already be done.
1703
1489
        :param ignore_fallbacks: when set, no fallback branches will be opened
1706
1492
        raise NotImplementedError(self.open)
1707
1493
 
1708
1494
    @classmethod
1709
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1710
1495
    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)
 
1496
        """Register a metadir format."""
 
1497
        klass._formats[format.get_format_string()] = format
 
1498
        # Metadir formats have a network name of their format string, and get
 
1499
        # registered as class factories.
 
1500
        network_format_registry.register(format.get_format_string(), format.__class__)
1717
1501
 
1718
1502
    @classmethod
1719
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1720
1503
    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
 
1504
        klass._default_format = format
1726
1505
 
1727
1506
    def supports_stacking(self):
1728
1507
        """True if this format records a stacked-on branch."""
1729
1508
        return False
1730
1509
 
1731
 
    def supports_leaving_lock(self):
1732
 
        """True if this format supports leaving locks in place."""
1733
 
        return False # by default
1734
 
 
1735
1510
    @classmethod
1736
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1737
1511
    def unregister_format(klass, format):
1738
 
        format_registry.remove(format)
 
1512
        del klass._formats[format.get_format_string()]
1739
1513
 
1740
1514
    def __str__(self):
1741
1515
        return self.get_format_description().rstrip()
1745
1519
        return False  # by default
1746
1520
 
1747
1521
 
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
1522
class BranchHooks(Hooks):
1777
1523
    """A dictionary mapping hook name to a list of callables for branch hooks.
1778
1524
 
1786
1532
        These are all empty initially, because by default nothing should get
1787
1533
        notified.
1788
1534
        """
1789
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1790
 
        self.add_hook('set_rh',
 
1535
        Hooks.__init__(self)
 
1536
        self.create_hook(HookPoint('set_rh',
1791
1537
            "Invoked whenever the revision history has been set via "
1792
1538
            "set_revision_history. The api signature is (branch, "
1793
1539
            "revision_history), and the branch will be write-locked. "
1794
1540
            "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',
 
1541
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1542
        self.create_hook(HookPoint('open',
1797
1543
            "Called with the Branch object that has been opened after a "
1798
 
            "branch is opened.", (1, 8))
1799
 
        self.add_hook('post_push',
 
1544
            "branch is opened.", (1, 8), None))
 
1545
        self.create_hook(HookPoint('post_push',
1800
1546
            "Called after a push operation completes. post_push is called "
1801
1547
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1802
 
            "bzr client.", (0, 15))
1803
 
        self.add_hook('post_pull',
 
1548
            "bzr client.", (0, 15), None))
 
1549
        self.create_hook(HookPoint('post_pull',
1804
1550
            "Called after a pull operation completes. post_pull is called "
1805
1551
            "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 "
 
1552
            "bzr client.", (0, 15), None))
 
1553
        self.create_hook(HookPoint('pre_commit',
 
1554
            "Called after a commit is calculated but before it is is "
1809
1555
            "completed. pre_commit is called with (local, master, old_revno, "
1810
1556
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1811
1557
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1813
1559
            "basis revision. hooks MUST NOT modify this delta. "
1814
1560
            " future_tree is an in-memory tree obtained from "
1815
1561
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1816
 
            "tree.", (0,91))
1817
 
        self.add_hook('post_commit',
 
1562
            "tree.", (0,91), None))
 
1563
        self.create_hook(HookPoint('post_commit',
1818
1564
            "Called in the bzr client after a commit has completed. "
1819
1565
            "post_commit is called with (local, master, old_revno, old_revid, "
1820
1566
            "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',
 
1567
            "commit to a branch.", (0, 15), None))
 
1568
        self.create_hook(HookPoint('post_uncommit',
1823
1569
            "Called in the bzr client after an uncommit completes. "
1824
1570
            "post_uncommit is called with (local, master, old_revno, "
1825
1571
            "old_revid, new_revno, new_revid) where local is the local branch "
1826
1572
            "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',
 
1573
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1574
        self.create_hook(HookPoint('pre_change_branch_tip',
1829
1575
            "Called in bzr client and server before a change to the tip of a "
1830
1576
            "branch is made. pre_change_branch_tip is called with a "
1831
1577
            "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',
 
1578
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1579
        self.create_hook(HookPoint('post_change_branch_tip',
1834
1580
            "Called in bzr client and server after a change to the tip of a "
1835
1581
            "branch is made. post_change_branch_tip is called with a "
1836
1582
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1837
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1838
 
        self.add_hook('transform_fallback_location',
 
1583
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1584
        self.create_hook(HookPoint('transform_fallback_location',
1839
1585
            "Called when a stacked branch is activating its fallback "
1840
1586
            "locations. transform_fallback_location is called with (branch, "
1841
1587
            "url), and should return a new url. Returning the same url "
1846
1592
            "fallback locations have not been activated. When there are "
1847
1593
            "multiple hooks installed for transform_fallback_location, "
1848
1594
            "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
 
 
 
1595
            "The order is however undefined.", (1, 9), None))
1867
1596
 
1868
1597
 
1869
1598
# install the default hooks into the Branch class.
1871
1600
 
1872
1601
 
1873
1602
class ChangeBranchTipParams(object):
1874
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1603
    """Object holding parameters passed to *_change_branch_tip hooks.
1875
1604
 
1876
1605
    There are 5 fields that hooks may wish to access:
1877
1606
 
1908
1637
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1909
1638
 
1910
1639
 
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)
 
1640
class BzrBranchFormat4(BranchFormat):
 
1641
    """Bzr branch format 4.
 
1642
 
 
1643
    This format has:
 
1644
     - a revision-history file.
 
1645
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1646
    """
 
1647
 
 
1648
    def get_format_description(self):
 
1649
        """See BranchFormat.get_format_description()."""
 
1650
        return "Branch format 4"
 
1651
 
 
1652
    def initialize(self, a_bzrdir):
 
1653
        """Create a branch of this format in a_bzrdir."""
 
1654
        utf8_files = [('revision-history', ''),
 
1655
                      ('branch-name', ''),
 
1656
                      ]
 
1657
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1658
                                       lock_type='branch4', set_format=False)
 
1659
 
 
1660
    def __init__(self):
 
1661
        super(BzrBranchFormat4, self).__init__()
 
1662
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1663
 
 
1664
    def network_name(self):
 
1665
        """The network name for this format is the control dirs disk label."""
 
1666
        return self._matchingbzrdir.get_format_string()
 
1667
 
 
1668
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1669
        """See BranchFormat.open()."""
 
1670
        if not _found:
 
1671
            # we are being called directly and must probe.
 
1672
            raise NotImplementedError
 
1673
        return BzrBranch(_format=self,
 
1674
                         _control_files=a_bzrdir._control_files,
 
1675
                         a_bzrdir=a_bzrdir,
 
1676
                         _repository=a_bzrdir.open_repository())
 
1677
 
 
1678
    def __str__(self):
 
1679
        return "Bazaar-NG branch format 4"
1982
1680
 
1983
1681
 
1984
1682
class BranchFormatMetadir(BranchFormat):
1988
1686
        """What class to instantiate on open calls."""
1989
1687
        raise NotImplementedError(self._branch_class)
1990
1688
 
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
1689
    def network_name(self):
2021
1690
        """A simple byte string uniquely identifying this format for RPC calls.
2022
1691
 
2024
1693
        """
2025
1694
        return self.get_format_string()
2026
1695
 
2027
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2028
 
            found_repository=None):
 
1696
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2029
1697
        """See BranchFormat.open()."""
2030
1698
        if not _found:
2031
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1699
            format = BranchFormat.find_format(a_bzrdir)
2032
1700
            if format.__class__ != self.__class__:
2033
1701
                raise AssertionError("wrong format %r found for %r" %
2034
1702
                    (format, self))
2035
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2036
1703
        try:
 
1704
            transport = a_bzrdir.get_branch_transport(None)
2037
1705
            control_files = lockable_files.LockableFiles(transport, 'lock',
2038
1706
                                                         lockdir.LockDir)
2039
 
            if found_repository is None:
2040
 
                found_repository = a_bzrdir.find_repository()
2041
1707
            return self._branch_class()(_format=self,
2042
1708
                              _control_files=control_files,
2043
 
                              name=name,
2044
1709
                              a_bzrdir=a_bzrdir,
2045
 
                              _repository=found_repository,
 
1710
                              _repository=a_bzrdir.find_repository(),
2046
1711
                              ignore_fallbacks=ignore_fallbacks)
2047
1712
        except errors.NoSuchFile:
2048
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1713
            raise errors.NotBranchError(path=transport.base)
2049
1714
 
2050
1715
    def __init__(self):
2051
1716
        super(BranchFormatMetadir, self).__init__()
2055
1720
    def supports_tags(self):
2056
1721
        return True
2057
1722
 
2058
 
    def supports_leaving_lock(self):
2059
 
        return True
2060
 
 
2061
1723
 
2062
1724
class BzrBranchFormat5(BranchFormatMetadir):
2063
1725
    """Bzr branch format 5.
2083
1745
        """See BranchFormat.get_format_description()."""
2084
1746
        return "Branch format 5"
2085
1747
 
2086
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1748
    def initialize(self, a_bzrdir):
2087
1749
        """Create a branch of this format in a_bzrdir."""
2088
1750
        utf8_files = [('revision-history', ''),
2089
1751
                      ('branch-name', ''),
2090
1752
                      ]
2091
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1753
        return self._initialize_helper(a_bzrdir, utf8_files)
2092
1754
 
2093
1755
    def supports_tags(self):
2094
1756
        return False
2116
1778
        """See BranchFormat.get_format_description()."""
2117
1779
        return "Branch format 6"
2118
1780
 
2119
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1781
    def initialize(self, a_bzrdir):
2120
1782
        """Create a branch of this format in a_bzrdir."""
2121
1783
        utf8_files = [('last-revision', '0 null:\n'),
2122
1784
                      ('branch.conf', ''),
2123
1785
                      ('tags', ''),
2124
1786
                      ]
2125
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1787
        return self._initialize_helper(a_bzrdir, utf8_files)
2126
1788
 
2127
1789
    def make_tags(self, branch):
2128
1790
        """See bzrlib.branch.BranchFormat.make_tags()."""
2129
1791
        return BasicTags(branch)
2130
1792
 
2131
 
    def supports_set_append_revisions_only(self):
2132
 
        return True
2133
1793
 
2134
1794
 
2135
1795
class BzrBranchFormat8(BranchFormatMetadir):
2146
1806
        """See BranchFormat.get_format_description()."""
2147
1807
        return "Branch format 8"
2148
1808
 
2149
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1809
    def initialize(self, a_bzrdir):
2150
1810
        """Create a branch of this format in a_bzrdir."""
2151
1811
        utf8_files = [('last-revision', '0 null:\n'),
2152
1812
                      ('branch.conf', ''),
2153
1813
                      ('tags', ''),
2154
1814
                      ('references', '')
2155
1815
                      ]
2156
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1816
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1817
 
 
1818
    def __init__(self):
 
1819
        super(BzrBranchFormat8, self).__init__()
 
1820
        self._matchingbzrdir.repository_format = \
 
1821
            RepositoryFormatKnitPack5RichRoot()
2157
1822
 
2158
1823
    def make_tags(self, branch):
2159
1824
        """See bzrlib.branch.BranchFormat.make_tags()."""
2160
1825
        return BasicTags(branch)
2161
1826
 
2162
 
    def supports_set_append_revisions_only(self):
2163
 
        return True
2164
 
 
2165
1827
    def supports_stacking(self):
2166
1828
        return True
2167
1829
 
2168
1830
    supports_reference_locations = True
2169
1831
 
2170
1832
 
2171
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1833
class BzrBranchFormat7(BzrBranchFormat8):
2172
1834
    """Branch format with last-revision, tags, and a stacked location pointer.
2173
1835
 
2174
1836
    The stacked location pointer is passed down to the repository and requires
2177
1839
    This format was introduced in bzr 1.6.
2178
1840
    """
2179
1841
 
2180
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1842
    def initialize(self, a_bzrdir):
2181
1843
        """Create a branch of this format in a_bzrdir."""
2182
1844
        utf8_files = [('last-revision', '0 null:\n'),
2183
1845
                      ('branch.conf', ''),
2184
1846
                      ('tags', ''),
2185
1847
                      ]
2186
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1848
        return self._initialize_helper(a_bzrdir, utf8_files)
2187
1849
 
2188
1850
    def _branch_class(self):
2189
1851
        return BzrBranch7
2196
1858
        """See BranchFormat.get_format_description()."""
2197
1859
        return "Branch format 7"
2198
1860
 
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
1861
    supports_reference_locations = False
2210
1862
 
2211
1863
 
2228
1880
        """See BranchFormat.get_format_description()."""
2229
1881
        return "Checkout reference format 1"
2230
1882
 
2231
 
    def get_reference(self, a_bzrdir, name=None):
 
1883
    def get_reference(self, a_bzrdir):
2232
1884
        """See BranchFormat.get_reference()."""
2233
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2234
 
        return transport.get_bytes('location')
 
1885
        transport = a_bzrdir.get_branch_transport(None)
 
1886
        return transport.get('location').read()
2235
1887
 
2236
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1888
    def set_reference(self, a_bzrdir, to_branch):
2237
1889
        """See BranchFormat.set_reference()."""
2238
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1890
        transport = a_bzrdir.get_branch_transport(None)
2239
1891
        location = transport.put_bytes('location', to_branch.base)
2240
1892
 
2241
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2242
 
            repository=None):
 
1893
    def initialize(self, a_bzrdir, target_branch=None):
2243
1894
        """Create a branch of this format in a_bzrdir."""
2244
1895
        if target_branch is None:
2245
1896
            # this format does not implement branch itself, thus the implicit
2246
1897
            # creation contract must see it as uninitializable
2247
1898
            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)
 
1899
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1900
        branch_transport = a_bzrdir.get_branch_transport(self)
2250
1901
        branch_transport.put_bytes('location',
2251
 
            target_branch.bzrdir.user_url)
 
1902
            target_branch.bzrdir.root_transport.base)
2252
1903
        branch_transport.put_bytes('format', self.get_format_string())
2253
 
        branch = self.open(
2254
 
            a_bzrdir, name, _found=True,
 
1904
        return self.open(
 
1905
            a_bzrdir, _found=True,
2255
1906
            possible_transports=[target_branch.bzrdir.root_transport])
2256
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2257
 
        return branch
2258
1907
 
2259
1908
    def __init__(self):
2260
1909
        super(BranchReferenceFormat, self).__init__()
2266
1915
        def clone(to_bzrdir, revision_id=None,
2267
1916
            repository_policy=None):
2268
1917
            """See Branch.clone()."""
2269
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1918
            return format.initialize(to_bzrdir, a_branch)
2270
1919
            # cannot obey revision_id limits when cloning a reference ...
2271
1920
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2272
1921
            # emit some sort of warning/error to the caller ?!
2273
1922
        return clone
2274
1923
 
2275
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2276
 
             possible_transports=None, ignore_fallbacks=False,
2277
 
             found_repository=None):
 
1924
    def open(self, a_bzrdir, _found=False, location=None,
 
1925
             possible_transports=None, ignore_fallbacks=False):
2278
1926
        """Return the branch that the branch reference in a_bzrdir points at.
2279
1927
 
2280
1928
        :param a_bzrdir: A BzrDir that contains a branch.
2281
 
        :param name: Name of colocated branch to open, if any
2282
1929
        :param _found: a private parameter, do not use it. It is used to
2283
1930
            indicate if format probing has already be done.
2284
1931
        :param ignore_fallbacks: when set, no fallback branches will be opened
2289
1936
        :param possible_transports: An optional reusable transports list.
2290
1937
        """
2291
1938
        if not _found:
2292
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1939
            format = BranchFormat.find_format(a_bzrdir)
2293
1940
            if format.__class__ != self.__class__:
2294
1941
                raise AssertionError("wrong format %r found for %r" %
2295
1942
                    (format, self))
2296
1943
        if location is None:
2297
 
            location = self.get_reference(a_bzrdir, name)
 
1944
            location = self.get_reference(a_bzrdir)
2298
1945
        real_bzrdir = bzrdir.BzrDir.open(
2299
1946
            location, possible_transports=possible_transports)
2300
 
        result = real_bzrdir.open_branch(name=name, 
2301
 
            ignore_fallbacks=ignore_fallbacks)
 
1947
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2302
1948
        # this changes the behaviour of result.clone to create a new reference
2303
1949
        # rather than a copy of the content of the branch.
2304
1950
        # I did not use a proxy object because that needs much more extensive
2311
1957
        return result
2312
1958
 
2313
1959
 
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
1960
network_format_registry = registry.FormatRegistry()
2329
1961
"""Registry of formats indexed by their network name.
2330
1962
 
2333
1965
BranchFormat.network_name() for more detail.
2334
1966
"""
2335
1967
 
2336
 
format_registry = BranchFormatRegistry(network_format_registry)
2337
 
 
2338
1968
 
2339
1969
# formats which have no format string are not discoverable
2340
1970
# and not independently creatable, so are not registered.
2342
1972
__format6 = BzrBranchFormat6()
2343
1973
__format7 = BzrBranchFormat7()
2344
1974
__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):
 
1975
BranchFormat.register_format(__format5)
 
1976
BranchFormat.register_format(BranchReferenceFormat())
 
1977
BranchFormat.register_format(__format6)
 
1978
BranchFormat.register_format(__format7)
 
1979
BranchFormat.register_format(__format8)
 
1980
BranchFormat.set_default_format(__format6)
 
1981
_legacy_formats = [BzrBranchFormat4(),
 
1982
    ]
 
1983
network_format_registry.register(
 
1984
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
1985
 
 
1986
 
 
1987
class BzrBranch(Branch):
2371
1988
    """A branch stored in the actual filesystem.
2372
1989
 
2373
1990
    Note that it's "local" in the context of the filesystem; it doesn't
2379
1996
    :ivar repository: Repository for this branch.
2380
1997
    :ivar base: The url of the base directory for this branch; the one
2381
1998
        containing the .bzr directory.
2382
 
    :ivar name: Optional colocated branch name as it exists in the control
2383
 
        directory.
2384
1999
    """
2385
2000
 
2386
2001
    def __init__(self, _format=None,
2387
 
                 _control_files=None, a_bzrdir=None, name=None,
2388
 
                 _repository=None, ignore_fallbacks=False):
 
2002
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2003
                 ignore_fallbacks=False):
2389
2004
        """Create new branch object at a particular location."""
2390
2005
        if a_bzrdir is None:
2391
2006
            raise ValueError('a_bzrdir must be supplied')
2392
2007
        else:
2393
2008
            self.bzrdir = a_bzrdir
2394
2009
        self._base = self.bzrdir.transport.clone('..').base
2395
 
        self.name = name
2396
2010
        # XXX: We should be able to just do
2397
2011
        #   self.base = self.bzrdir.root_transport.base
2398
2012
        # but this does not quite work yet -- mbp 20080522
2405
2019
        Branch.__init__(self)
2406
2020
 
2407
2021
    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)
 
2022
        return '%s(%r)' % (self.__class__.__name__, self.base)
2413
2023
 
2414
2024
    __repr__ = __str__
2415
2025
 
2426
2036
        return self.control_files.is_locked()
2427
2037
 
2428
2038
    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
2039
        # All-in-one needs to always unlock/lock.
2438
2040
        repo_control = getattr(self.repository, 'control_files', None)
2439
2041
        if self.control_files == repo_control or not self.is_locked():
2440
 
            self.repository._warn_if_deprecated(self)
2441
2042
            self.repository.lock_write()
2442
2043
            took_lock = True
2443
2044
        else:
2444
2045
            took_lock = False
2445
2046
        try:
2446
 
            return BranchWriteLockResult(self.unlock,
2447
 
                self.control_files.lock_write(token=token))
 
2047
            return self.control_files.lock_write(token=token)
2448
2048
        except:
2449
2049
            if took_lock:
2450
2050
                self.repository.unlock()
2451
2051
            raise
2452
2052
 
2453
2053
    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
2054
        # All-in-one needs to always unlock/lock.
2461
2055
        repo_control = getattr(self.repository, 'control_files', None)
2462
2056
        if self.control_files == repo_control or not self.is_locked():
2463
 
            self.repository._warn_if_deprecated(self)
2464
2057
            self.repository.lock_read()
2465
2058
            took_lock = True
2466
2059
        else:
2467
2060
            took_lock = False
2468
2061
        try:
2469
2062
            self.control_files.lock_read()
2470
 
            return LogicalLockResult(self.unlock)
2471
2063
        except:
2472
2064
            if took_lock:
2473
2065
                self.repository.unlock()
2474
2066
            raise
2475
2067
 
2476
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2477
2068
    def unlock(self):
2478
2069
        try:
2479
2070
            self.control_files.unlock()
2501
2092
        """See Branch.print_file."""
2502
2093
        return self.repository.print_file(file, revision_id)
2503
2094
 
 
2095
    def _write_revision_history(self, history):
 
2096
        """Factored out of set_revision_history.
 
2097
 
 
2098
        This performs the actual writing to disk.
 
2099
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2100
        self._transport.put_bytes(
 
2101
            'revision-history', '\n'.join(history),
 
2102
            mode=self.bzrdir._get_file_mode())
 
2103
 
 
2104
    @needs_write_lock
 
2105
    def set_revision_history(self, rev_history):
 
2106
        """See Branch.set_revision_history."""
 
2107
        if 'evil' in debug.debug_flags:
 
2108
            mutter_callsite(3, "set_revision_history scales with history.")
 
2109
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2110
        for rev_id in rev_history:
 
2111
            check_not_reserved_id(rev_id)
 
2112
        if Branch.hooks['post_change_branch_tip']:
 
2113
            # Don't calculate the last_revision_info() if there are no hooks
 
2114
            # that will use it.
 
2115
            old_revno, old_revid = self.last_revision_info()
 
2116
        if len(rev_history) == 0:
 
2117
            revid = _mod_revision.NULL_REVISION
 
2118
        else:
 
2119
            revid = rev_history[-1]
 
2120
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2121
        self._write_revision_history(rev_history)
 
2122
        self._clear_cached_state()
 
2123
        self._cache_revision_history(rev_history)
 
2124
        for hook in Branch.hooks['set_rh']:
 
2125
            hook(self, rev_history)
 
2126
        if Branch.hooks['post_change_branch_tip']:
 
2127
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2128
 
 
2129
    def _synchronize_history(self, destination, revision_id):
 
2130
        """Synchronize last revision and revision history between branches.
 
2131
 
 
2132
        This version is most efficient when the destination is also a
 
2133
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2134
        history is the true lefthand parent history, and all of the revisions
 
2135
        are in the destination's repository.  If not, set_revision_history
 
2136
        will fail.
 
2137
 
 
2138
        :param destination: The branch to copy the history into
 
2139
        :param revision_id: The revision-id to truncate history at.  May
 
2140
          be None to copy complete history.
 
2141
        """
 
2142
        if not isinstance(destination._format, BzrBranchFormat5):
 
2143
            super(BzrBranch, self)._synchronize_history(
 
2144
                destination, revision_id)
 
2145
            return
 
2146
        if revision_id == _mod_revision.NULL_REVISION:
 
2147
            new_history = []
 
2148
        else:
 
2149
            new_history = self.revision_history()
 
2150
        if revision_id is not None and new_history != []:
 
2151
            try:
 
2152
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2153
            except ValueError:
 
2154
                rev = self.repository.get_revision(revision_id)
 
2155
                new_history = rev.get_history(self.repository)[1:]
 
2156
        destination.set_revision_history(new_history)
 
2157
 
2504
2158
    @needs_write_lock
2505
2159
    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)
 
2160
        """Set the last revision of this branch.
 
2161
 
 
2162
        The caller is responsible for checking that the revno is correct
 
2163
        for this revision id.
 
2164
 
 
2165
        It may be possible to set the branch last revision to an id not
 
2166
        present in the repository.  However, branches can also be
 
2167
        configured to check constraints on history, in which case this may not
 
2168
        be permitted.
 
2169
        """
2508
2170
        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)
 
2171
        # this old format stores the full history, but this api doesn't
 
2172
        # provide it, so we must generate, and might as well check it's
 
2173
        # correct
 
2174
        history = self._lefthand_history(revision_id)
 
2175
        if len(history) != revno:
 
2176
            raise AssertionError('%d != %d' % (len(history), revno))
 
2177
        self.set_revision_history(history)
 
2178
 
 
2179
    def _gen_revision_history(self):
 
2180
        history = self._transport.get_bytes('revision-history').split('\n')
 
2181
        if history[-1:] == ['']:
 
2182
            # There shouldn't be a trailing newline, but just in case.
 
2183
            history.pop()
 
2184
        return history
 
2185
 
 
2186
    @needs_write_lock
 
2187
    def generate_revision_history(self, revision_id, last_rev=None,
 
2188
        other_branch=None):
 
2189
        """Create a new revision history that will finish with revision_id.
 
2190
 
 
2191
        :param revision_id: the new tip to use.
 
2192
        :param last_rev: The previous last_revision. If not None, then this
 
2193
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2194
        :param other_branch: The other branch that DivergedBranches should
 
2195
            raise with respect to.
 
2196
        """
 
2197
        self.set_revision_history(self._lefthand_history(revision_id,
 
2198
            last_rev, other_branch))
2517
2199
 
2518
2200
    def basis_tree(self):
2519
2201
        """See Branch.basis_tree."""
2528
2210
                pass
2529
2211
        return None
2530
2212
 
 
2213
    def _basic_push(self, target, overwrite, stop_revision):
 
2214
        """Basic implementation of push without bound branches or hooks.
 
2215
 
 
2216
        Must be called with source read locked and target write locked.
 
2217
        """
 
2218
        result = BranchPushResult()
 
2219
        result.source_branch = self
 
2220
        result.target_branch = target
 
2221
        result.old_revno, result.old_revid = target.last_revision_info()
 
2222
        self.update_references(target)
 
2223
        if result.old_revid != self.last_revision():
 
2224
            # We assume that during 'push' this repository is closer than
 
2225
            # the target.
 
2226
            graph = self.repository.get_graph(target.repository)
 
2227
            target.update_revisions(self, stop_revision,
 
2228
                overwrite=overwrite, graph=graph)
 
2229
        if self._push_should_merge_tags():
 
2230
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2231
                overwrite)
 
2232
        result.new_revno, result.new_revid = target.last_revision_info()
 
2233
        return result
 
2234
 
2531
2235
    def get_stacked_on_url(self):
2532
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2236
        raise errors.UnstackableBranchFormat(self._format, self.base)
2533
2237
 
2534
2238
    def set_push_location(self, location):
2535
2239
        """See Branch.set_push_location."""
2544
2248
            self._transport.put_bytes('parent', url + '\n',
2545
2249
                mode=self.bzrdir._get_file_mode())
2546
2250
 
 
2251
 
 
2252
class BzrBranch5(BzrBranch):
 
2253
    """A format 5 branch. This supports new features over plain branches.
 
2254
 
 
2255
    It has support for a master_branch which is the data for bound branches.
 
2256
    """
 
2257
 
 
2258
    def get_bound_location(self):
 
2259
        try:
 
2260
            return self._transport.get_bytes('bound')[:-1]
 
2261
        except errors.NoSuchFile:
 
2262
            return None
 
2263
 
 
2264
    @needs_read_lock
 
2265
    def get_master_branch(self, possible_transports=None):
 
2266
        """Return the branch we are bound to.
 
2267
 
 
2268
        :return: Either a Branch, or None
 
2269
 
 
2270
        This could memoise the branch, but if thats done
 
2271
        it must be revalidated on each new lock.
 
2272
        So for now we just don't memoise it.
 
2273
        # RBC 20060304 review this decision.
 
2274
        """
 
2275
        bound_loc = self.get_bound_location()
 
2276
        if not bound_loc:
 
2277
            return None
 
2278
        try:
 
2279
            return Branch.open(bound_loc,
 
2280
                               possible_transports=possible_transports)
 
2281
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2282
            raise errors.BoundBranchConnectionFailure(
 
2283
                    self, bound_loc, e)
 
2284
 
2547
2285
    @needs_write_lock
2548
 
    def unbind(self):
2549
 
        """If bound, unbind"""
2550
 
        return self.set_bound_location(None)
 
2286
    def set_bound_location(self, location):
 
2287
        """Set the target where this branch is bound to.
 
2288
 
 
2289
        :param location: URL to the target branch
 
2290
        """
 
2291
        if location:
 
2292
            self._transport.put_bytes('bound', location+'\n',
 
2293
                mode=self.bzrdir._get_file_mode())
 
2294
        else:
 
2295
            try:
 
2296
                self._transport.delete('bound')
 
2297
            except errors.NoSuchFile:
 
2298
                return False
 
2299
            return True
2551
2300
 
2552
2301
    @needs_write_lock
2553
2302
    def bind(self, other):
2575
2324
        # history around
2576
2325
        self.set_bound_location(other.base)
2577
2326
 
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
2327
    @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
 
2328
    def unbind(self):
 
2329
        """If bound, unbind"""
 
2330
        return self.set_bound_location(None)
2622
2331
 
2623
2332
    @needs_write_lock
2624
2333
    def update(self, possible_transports=None):
2637
2346
            return old_tip
2638
2347
        return None
2639
2348
 
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):
 
2349
 
 
2350
class BzrBranch8(BzrBranch5):
2769
2351
    """A branch that stores tree-reference locations."""
2770
2352
 
2771
2353
    def _open_hook(self):
2790
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2791
2373
        super(BzrBranch8, self).__init__(*args, **kwargs)
2792
2374
        self._last_revision_info_cache = None
 
2375
        self._partial_revision_history_cache = []
2793
2376
        self._reference_info = None
2794
2377
 
2795
2378
    def _clear_cached_state(self):
2796
2379
        super(BzrBranch8, self)._clear_cached_state()
2797
2380
        self._last_revision_info_cache = None
 
2381
        self._partial_revision_history_cache = []
2798
2382
        self._reference_info = None
2799
2383
 
 
2384
    def _last_revision_info(self):
 
2385
        revision_string = self._transport.get_bytes('last-revision')
 
2386
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2387
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2388
        revno = int(revno)
 
2389
        return revno, revision_id
 
2390
 
 
2391
    def _write_last_revision_info(self, revno, revision_id):
 
2392
        """Simply write out the revision id, with no checks.
 
2393
 
 
2394
        Use set_last_revision_info to perform this safely.
 
2395
 
 
2396
        Does not update the revision_history cache.
 
2397
        Intended to be called by set_last_revision_info and
 
2398
        _write_revision_history.
 
2399
        """
 
2400
        revision_id = _mod_revision.ensure_null(revision_id)
 
2401
        out_string = '%d %s\n' % (revno, revision_id)
 
2402
        self._transport.put_bytes('last-revision', out_string,
 
2403
            mode=self.bzrdir._get_file_mode())
 
2404
 
 
2405
    @needs_write_lock
 
2406
    def set_last_revision_info(self, revno, revision_id):
 
2407
        revision_id = _mod_revision.ensure_null(revision_id)
 
2408
        old_revno, old_revid = self.last_revision_info()
 
2409
        if self._get_append_revisions_only():
 
2410
            self._check_history_violation(revision_id)
 
2411
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2412
        self._write_last_revision_info(revno, revision_id)
 
2413
        self._clear_cached_state()
 
2414
        self._last_revision_info_cache = revno, revision_id
 
2415
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2416
 
 
2417
    def _synchronize_history(self, destination, revision_id):
 
2418
        """Synchronize last revision and revision history between branches.
 
2419
 
 
2420
        :see: Branch._synchronize_history
 
2421
        """
 
2422
        # XXX: The base Branch has a fast implementation of this method based
 
2423
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2424
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2425
        # but wants the fast implementation, so it calls
 
2426
        # Branch._synchronize_history directly.
 
2427
        Branch._synchronize_history(self, destination, revision_id)
 
2428
 
2800
2429
    def _check_history_violation(self, revision_id):
2801
 
        current_revid = self.last_revision()
2802
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2430
        last_revision = _mod_revision.ensure_null(self.last_revision())
2803
2431
        if _mod_revision.is_null(last_revision):
2804
2432
            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)
 
2433
        if last_revision not in self._lefthand_history(revision_id):
 
2434
            raise errors.AppendRevisionsOnlyViolation(self.base)
2810
2435
 
2811
2436
    def _gen_revision_history(self):
2812
2437
        """Generate the revision history from last revision
2815
2440
        self._extend_partial_history(stop_index=last_revno-1)
2816
2441
        return list(reversed(self._partial_revision_history_cache))
2817
2442
 
 
2443
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2444
        """Extend the partial history to include a given index
 
2445
 
 
2446
        If a stop_index is supplied, stop when that index has been reached.
 
2447
        If a stop_revision is supplied, stop when that revision is
 
2448
        encountered.  Otherwise, stop when the beginning of history is
 
2449
        reached.
 
2450
 
 
2451
        :param stop_index: The index which should be present.  When it is
 
2452
            present, history extension will stop.
 
2453
        :param revision_id: The revision id which should be present.  When
 
2454
            it is encountered, history extension will stop.
 
2455
        """
 
2456
        repo = self.repository
 
2457
        if len(self._partial_revision_history_cache) == 0:
 
2458
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2459
        else:
 
2460
            start_revision = self._partial_revision_history_cache[-1]
 
2461
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2462
            #skip the last revision in the list
 
2463
            next_revision = iterator.next()
 
2464
        for revision_id in iterator:
 
2465
            self._partial_revision_history_cache.append(revision_id)
 
2466
            if (stop_index is not None and
 
2467
                len(self._partial_revision_history_cache) > stop_index):
 
2468
                break
 
2469
            if revision_id == stop_revision:
 
2470
                break
 
2471
 
 
2472
    def _write_revision_history(self, history):
 
2473
        """Factored out of set_revision_history.
 
2474
 
 
2475
        This performs the actual writing to disk, with format-specific checks.
 
2476
        It is intended to be called by BzrBranch5.set_revision_history.
 
2477
        """
 
2478
        if len(history) == 0:
 
2479
            last_revision = 'null:'
 
2480
        else:
 
2481
            if history != self._lefthand_history(history[-1]):
 
2482
                raise errors.NotLefthandHistory(history)
 
2483
            last_revision = history[-1]
 
2484
        if self._get_append_revisions_only():
 
2485
            self._check_history_violation(last_revision)
 
2486
        self._write_last_revision_info(len(history), last_revision)
 
2487
 
2818
2488
    @needs_write_lock
2819
2489
    def _set_parent_location(self, url):
2820
2490
        """Set the parent branch"""
2896
2566
        if branch_location is None:
2897
2567
            return Branch.reference_parent(self, file_id, path,
2898
2568
                                           possible_transports)
2899
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2569
        branch_location = urlutils.join(self.base, branch_location)
2900
2570
        return Branch.open(branch_location,
2901
2571
                           possible_transports=possible_transports)
2902
2572
 
2906
2576
 
2907
2577
    def set_bound_location(self, location):
2908
2578
        """See Branch.set_push_location."""
2909
 
        self._master_branch_cache = None
2910
2579
        result = None
2911
2580
        config = self.get_config()
2912
2581
        if location is None:
2943
2612
        # you can always ask for the URL; but you might not be able to use it
2944
2613
        # if the repo can't support stacking.
2945
2614
        ## 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)
 
2615
        stacked_url = self._get_config_location('stacked_on_location')
2951
2616
        if stacked_url is None:
2952
2617
            raise errors.NotStacked(self)
2953
2618
        return stacked_url
2954
2619
 
 
2620
    def set_append_revisions_only(self, enabled):
 
2621
        if enabled:
 
2622
            value = 'True'
 
2623
        else:
 
2624
            value = 'False'
 
2625
        self.get_config().set_user_option('append_revisions_only', value,
 
2626
            warn_masked=True)
 
2627
 
2955
2628
    def _get_append_revisions_only(self):
2956
 
        return self.get_config(
2957
 
            ).get_user_option_as_bool('append_revisions_only')
 
2629
        value = self.get_config().get_user_option('append_revisions_only')
 
2630
        return value == 'True'
 
2631
 
 
2632
    @needs_write_lock
 
2633
    def generate_revision_history(self, revision_id, last_rev=None,
 
2634
                                  other_branch=None):
 
2635
        """See BzrBranch5.generate_revision_history"""
 
2636
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2637
        revno = len(history)
 
2638
        self.set_last_revision_info(revno, revision_id)
2958
2639
 
2959
2640
    @needs_read_lock
2960
2641
    def get_rev_id(self, revno, history=None):
2985
2666
        try:
2986
2667
            index = self._partial_revision_history_cache.index(revision_id)
2987
2668
        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)
 
2669
            self._extend_partial_history(stop_revision=revision_id)
2992
2670
            index = len(self._partial_revision_history_cache) - 1
2993
2671
            if self._partial_revision_history_cache[index] != revision_id:
2994
2672
                raise errors.NoSuchRevision(self, revision_id)
3017
2695
    """
3018
2696
 
3019
2697
    def get_stacked_on_url(self):
3020
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2698
        raise errors.UnstackableBranchFormat(self._format, self.base)
3021
2699
 
3022
2700
 
3023
2701
######################################################################
3049
2727
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3050
2728
    """
3051
2729
 
3052
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3053
2730
    def __int__(self):
3054
 
        """Return the relative change in revno.
3055
 
 
3056
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3057
 
        """
 
2731
        # DEPRECATED: pull used to return the change in revno
3058
2732
        return self.new_revno - self.old_revno
3059
2733
 
3060
2734
    def report(self, to_file):
3085
2759
        target, otherwise it will be None.
3086
2760
    """
3087
2761
 
3088
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3089
2762
    def __int__(self):
3090
 
        """Return the relative change in revno.
3091
 
 
3092
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3093
 
        """
 
2763
        # DEPRECATED: push used to return the change in revno
3094
2764
        return self.new_revno - self.old_revno
3095
2765
 
3096
2766
    def report(self, to_file):
3110
2780
 
3111
2781
    def __init__(self, branch):
3112
2782
        self.branch = branch
3113
 
        self.errors = []
3114
2783
 
3115
2784
    def report_results(self, verbose):
3116
2785
        """Report the check results via trace.note.
3118
2787
        :param verbose: Requests more detailed display of what was checked,
3119
2788
            if any.
3120
2789
        """
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)
 
2790
        note('checked branch %s format %s',
 
2791
             self.branch.base,
 
2792
             self.branch._format)
3125
2793
 
3126
2794
 
3127
2795
class Converter5to6(object):
3166
2834
 
3167
2835
 
3168
2836
class Converter7to8(object):
3169
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
2837
    """Perform an in-place upgrade of format 6 to format 7"""
3170
2838
 
3171
2839
    def convert(self, branch):
3172
2840
        format = BzrBranchFormat8()
3175
2843
        branch._transport.put_bytes('format', format.get_format_string())
3176
2844
 
3177
2845
 
 
2846
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2847
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2848
    duration.
 
2849
 
 
2850
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2851
 
 
2852
    If an exception is raised by callable, then that exception *will* be
 
2853
    propagated, even if the unlock attempt raises its own error.  Thus
 
2854
    _run_with_write_locked_target should be preferred to simply doing::
 
2855
 
 
2856
        target.lock_write()
 
2857
        try:
 
2858
            return callable(*args, **kwargs)
 
2859
        finally:
 
2860
            target.unlock()
 
2861
 
 
2862
    """
 
2863
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2864
    # should share code?
 
2865
    target.lock_write()
 
2866
    try:
 
2867
        result = callable(*args, **kwargs)
 
2868
    except:
 
2869
        exc_info = sys.exc_info()
 
2870
        try:
 
2871
            target.unlock()
 
2872
        finally:
 
2873
            raise exc_info[0], exc_info[1], exc_info[2]
 
2874
    else:
 
2875
        target.unlock()
 
2876
        return result
 
2877
 
 
2878
 
3178
2879
class InterBranch(InterObject):
3179
2880
    """This class represents operations taking place between two branches.
3180
2881
 
3186
2887
    _optimisers = []
3187
2888
    """The available optimised InterBranch types."""
3188
2889
 
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)
 
2890
    @staticmethod
 
2891
    def _get_branch_formats_to_test():
 
2892
        """Return a tuple with the Branch formats to use when testing."""
 
2893
        raise NotImplementedError(self._get_branch_formats_to_test)
3198
2894
 
3199
 
    @needs_write_lock
3200
2895
    def pull(self, overwrite=False, stop_revision=None,
3201
2896
             possible_transports=None, local=False):
3202
2897
        """Mirror source into target branch.
3207
2902
        """
3208
2903
        raise NotImplementedError(self.pull)
3209
2904
 
3210
 
    @needs_write_lock
3211
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2905
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2906
                         graph=None):
 
2907
        """Pull in new perfect-fit revisions.
 
2908
 
 
2909
        :param stop_revision: Updated until the given revision
 
2910
        :param overwrite: Always set the branch pointer, rather than checking
 
2911
            to see if it is a proper descendant.
 
2912
        :param graph: A Graph object that can be used to query history
 
2913
            information. This can be None.
 
2914
        :return: None
 
2915
        """
 
2916
        raise NotImplementedError(self.update_revisions)
 
2917
 
 
2918
    def push(self, overwrite=False, stop_revision=None,
3212
2919
             _override_hook_source_branch=None):
3213
2920
        """Mirror the source branch into the target branch.
3214
2921
 
3216
2923
        """
3217
2924
        raise NotImplementedError(self.push)
3218
2925
 
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
2926
 
3238
2927
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, [])
 
2928
    """InterBranch implementation that uses public Branch functions.
 
2929
    """
 
2930
 
 
2931
    @staticmethod
 
2932
    def _get_branch_formats_to_test():
 
2933
        return BranchFormat._default_format, BranchFormat._default_format
 
2934
 
 
2935
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2936
        graph=None):
 
2937
        """See InterBranch.update_revisions()."""
3280
2938
        self.source.lock_read()
3281
2939
        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)
 
2940
            other_revno, other_last_revision = self.source.last_revision_info()
 
2941
            stop_revno = None # unknown
 
2942
            if stop_revision is None:
 
2943
                stop_revision = other_last_revision
 
2944
                if _mod_revision.is_null(stop_revision):
 
2945
                    # if there are no commits, we're done.
 
2946
                    return
 
2947
                stop_revno = other_revno
 
2948
 
 
2949
            # what's the current last revision, before we fetch [and change it
 
2950
            # possibly]
 
2951
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
2952
            # we fetch here so that we don't process data twice in the common
 
2953
            # case of having something to pull, and so that the check for
 
2954
            # already merged can operate on the just fetched graph, which will
 
2955
            # be cached in memory.
 
2956
            self.target.fetch(self.source, stop_revision)
 
2957
            # Check to see if one is an ancestor of the other
 
2958
            if not overwrite:
 
2959
                if graph is None:
 
2960
                    graph = self.target.repository.get_graph()
 
2961
                if self.target._check_if_descendant_or_diverged(
 
2962
                        stop_revision, last_rev, graph, self.source):
 
2963
                    # stop_revision is a descendant of last_rev, but we aren't
 
2964
                    # overwriting, so we're done.
 
2965
                    return
 
2966
            if stop_revno is None:
 
2967
                if graph is None:
 
2968
                    graph = self.target.repository.get_graph()
 
2969
                this_revno, this_last_revision = \
 
2970
                        self.target.last_revision_info()
 
2971
                stop_revno = graph.find_distance_to_null(stop_revision,
 
2972
                                [(other_last_revision, other_revno),
 
2973
                                 (this_last_revision, this_revno)])
 
2974
            self.target.set_last_revision_info(stop_revno, stop_revision)
3292
2975
        finally:
3293
2976
            self.source.unlock()
3294
2977
 
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
2978
    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
2979
             possible_transports=None, _hook_master=None, run_hooks=True,
3462
 
             _override_hook_target=None, local=False,
3463
 
             merge_tags_to_master=True):
 
2980
             _override_hook_target=None, local=False):
3464
2981
        """See Branch.pull.
3465
2982
 
3466
 
        This function is the core worker, used by GenericInterBranch.pull to
3467
 
        avoid duplication when pulling source->master and source->local.
3468
 
 
3469
2983
        :param _hook_master: Private parameter - set the branch to
3470
2984
            be supplied as the master to pull hooks.
3471
2985
        :param run_hooks: Private parameter - if false, this branch
3472
2986
            is being called because it's the master of the primary branch,
3473
2987
            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
2988
        :param _override_hook_target: Private parameter - set the branch to be
3477
2989
            supplied as the target_branch to pull hooks.
3478
2990
        :param local: Only update the local branch, and not the bound branch.
3497
3009
            # -- JRV20090506
3498
3010
            result.old_revno, result.old_revid = \
3499
3011
                self.target.last_revision_info()
3500
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3501
 
                graph=graph)
 
3012
            self.target.update_revisions(self.source, stop_revision,
 
3013
                overwrite=overwrite, graph=graph)
3502
3014
            # TODO: The old revid should be specified when merging tags, 
3503
3015
            # so a tags implementation that versions tags can only 
3504
3016
            # pull in the most recent changes. -- JRV20090506
3505
3017
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3506
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3018
                overwrite)
3507
3019
            result.new_revno, result.new_revid = self.target.last_revision_info()
3508
3020
            if _hook_master:
3509
3021
                result.master_branch = _hook_master
3518
3030
            self.source.unlock()
3519
3031
        return result
3520
3032
 
 
3033
    def push(self, overwrite=False, stop_revision=None,
 
3034
             _override_hook_source_branch=None):
 
3035
        """See InterBranch.push.
 
3036
 
 
3037
        This is the basic concrete implementation of push()
 
3038
 
 
3039
        :param _override_hook_source_branch: If specified, run
 
3040
        the hooks passing this Branch as the source, rather than self.
 
3041
        This is for use of RemoteBranch, where push is delegated to the
 
3042
        underlying vfs-based Branch.
 
3043
        """
 
3044
        # TODO: Public option to disable running hooks - should be trivial but
 
3045
        # needs tests.
 
3046
        self.source.lock_read()
 
3047
        try:
 
3048
            return _run_with_write_locked_target(
 
3049
                self.target, self._push_with_bound_branches, overwrite,
 
3050
                stop_revision,
 
3051
                _override_hook_source_branch=_override_hook_source_branch)
 
3052
        finally:
 
3053
            self.source.unlock()
 
3054
        return result
 
3055
 
 
3056
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3057
            _override_hook_source_branch=None):
 
3058
        """Push from source into target, and into target's master if any.
 
3059
        """
 
3060
        def _run_hooks():
 
3061
            if _override_hook_source_branch:
 
3062
                result.source_branch = _override_hook_source_branch
 
3063
            for hook in Branch.hooks['post_push']:
 
3064
                hook(result)
 
3065
 
 
3066
        bound_location = self.target.get_bound_location()
 
3067
        if bound_location and self.target.base != bound_location:
 
3068
            # there is a master branch.
 
3069
            #
 
3070
            # XXX: Why the second check?  Is it even supported for a branch to
 
3071
            # be bound to itself? -- mbp 20070507
 
3072
            master_branch = self.target.get_master_branch()
 
3073
            master_branch.lock_write()
 
3074
            try:
 
3075
                # push into the master from the source branch.
 
3076
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3077
                # and push into the target branch from the source. Note that we
 
3078
                # push from the source branch again, because its considered the
 
3079
                # highest bandwidth repository.
 
3080
                result = self.source._basic_push(self.target, overwrite,
 
3081
                    stop_revision)
 
3082
                result.master_branch = master_branch
 
3083
                result.local_branch = self.target
 
3084
                _run_hooks()
 
3085
                return result
 
3086
            finally:
 
3087
                master_branch.unlock()
 
3088
        else:
 
3089
            # no master branch
 
3090
            result = self.source._basic_push(self.target, overwrite,
 
3091
                stop_revision)
 
3092
            # TODO: Why set master_branch and local_branch if there's no
 
3093
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3094
            # 20070504
 
3095
            result.master_branch = self.target
 
3096
            result.local_branch = None
 
3097
            _run_hooks()
 
3098
            return result
 
3099
 
 
3100
    @classmethod
 
3101
    def is_compatible(self, source, target):
 
3102
        # GenericBranch uses the public API, so always compatible
 
3103
        return True
 
3104
 
 
3105
 
 
3106
class InterToBranch5(GenericInterBranch):
 
3107
 
 
3108
    @staticmethod
 
3109
    def _get_branch_formats_to_test():
 
3110
        return BranchFormat._default_format, BzrBranchFormat5()
 
3111
 
 
3112
    def pull(self, overwrite=False, stop_revision=None,
 
3113
             possible_transports=None, run_hooks=True,
 
3114
             _override_hook_target=None, local=False):
 
3115
        """Pull from source into self, updating my master if any.
 
3116
 
 
3117
        :param run_hooks: Private parameter - if false, this branch
 
3118
            is being called because it's the master of the primary branch,
 
3119
            so it should not run its hooks.
 
3120
        """
 
3121
        bound_location = self.target.get_bound_location()
 
3122
        if local and not bound_location:
 
3123
            raise errors.LocalRequiresBoundBranch()
 
3124
        master_branch = None
 
3125
        if not local and bound_location and self.source.base != bound_location:
 
3126
            # not pulling from master, so we need to update master.
 
3127
            master_branch = self.target.get_master_branch(possible_transports)
 
3128
            master_branch.lock_write()
 
3129
        try:
 
3130
            if master_branch:
 
3131
                # pull from source into master.
 
3132
                master_branch.pull(self.source, overwrite, stop_revision,
 
3133
                    run_hooks=False)
 
3134
            return super(InterToBranch5, self).pull(overwrite,
 
3135
                stop_revision, _hook_master=master_branch,
 
3136
                run_hooks=run_hooks,
 
3137
                _override_hook_target=_override_hook_target)
 
3138
        finally:
 
3139
            if master_branch:
 
3140
                master_branch.unlock()
 
3141
 
3521
3142
 
3522
3143
InterBranch.register_optimiser(GenericInterBranch)
 
3144
InterBranch.register_optimiser(InterToBranch5)