~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Johan Walles
  • Date: 2009-05-07 05:08:46 UTC
  • mfrom: (4342 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4343.
  • Revision ID: johan.walles@gmail.com-20090507050846-nkwvcyauf1eh653q
Merge from upstream.

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