~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Andrew Bennetts
  • Date: 2009-08-07 04:17:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4608.
  • Revision ID: andrew.bennetts@canonical.com-20090807041751-0vhb0y0g7k49hr45
Review comments from John.

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
94
        self._partial_revision_history_cache = []
102
 
        self._tags_bytes = None
103
95
        self._last_revision_info_cache = None
104
 
        self._master_branch_cache = None
105
96
        self._merge_sorted_revisions_cache = None
106
97
        self._open_hook()
107
98
        hooks = Branch.hooks['open']
113
104
 
114
105
    def _activate_fallback_location(self, url):
115
106
        """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
107
        repo = self._get_fallback_repository(url)
124
108
        if repo.has_same_location(self.repository):
125
 
            raise errors.UnstackableLocationError(self.user_url, url)
 
109
            raise errors.UnstackableLocationError(self.base, url)
126
110
        self.repository.add_fallback_repository(repo)
127
111
 
128
112
    def break_lock(self):
165
149
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
166
150
            self._partial_revision_history_cache.pop()
167
151
 
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
152
    @staticmethod
177
153
    def open(base, _unsupported=False, possible_transports=None):
178
154
        """Open the branch rooted at base.
182
158
        """
183
159
        control = bzrdir.BzrDir.open(base, _unsupported,
184
160
                                     possible_transports=possible_transports)
185
 
        return control.open_branch(unsupported=_unsupported)
 
161
        return control.open_branch(_unsupported)
186
162
 
187
163
    @staticmethod
188
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
164
    def open_from_transport(transport, _unsupported=False):
189
165
        """Open the branch rooted at transport"""
190
166
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
191
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
167
        return control.open_branch(_unsupported)
192
168
 
193
169
    @staticmethod
194
170
    def open_containing(url, possible_transports=None):
215
191
        return self.supports_tags() and self.tags.get_tag_dict()
216
192
 
217
193
    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
194
        return BranchConfig(self)
226
195
 
227
196
    def _get_config(self):
239
208
    def _get_fallback_repository(self, url):
240
209
        """Get the repository we fallback to at url."""
241
210
        url = urlutils.join(self.base, url)
242
 
        a_branch = Branch.open(url,
 
211
        a_bzrdir = bzrdir.BzrDir.open(url,
243
212
            possible_transports=[self.bzrdir.root_transport])
244
 
        return a_branch.repository
 
213
        return a_bzrdir.open_branch().repository
245
214
 
246
 
    @needs_read_lock
247
215
    def _get_tags_bytes(self):
248
216
        """Get the bytes of a serialised tags dict.
249
217
 
256
224
        :return: The bytes of the tags file.
257
225
        :seealso: Branch._set_tags_bytes.
258
226
        """
259
 
        if self._tags_bytes is None:
260
 
            self._tags_bytes = self._transport.get_bytes('tags')
261
 
        return self._tags_bytes
 
227
        return self._transport.get_bytes('tags')
262
228
 
263
229
    def _get_nick(self, local=False, possible_transports=None):
264
230
        config = self.get_config()
266
232
        if not local and not config.has_explicit_nickname():
267
233
            try:
268
234
                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
235
                if master is not None:
272
236
                    # return the master branch value
273
237
                    return master.nick
274
 
            except errors.RecursiveBind, e:
275
 
                raise e
276
238
            except errors.BzrError, e:
277
239
                # Silently fall back to local implicit nick if the master is
278
240
                # unavailable
315
277
        new_history.reverse()
316
278
        return new_history
317
279
 
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
 
        """
 
280
    def lock_write(self):
325
281
        raise NotImplementedError(self.lock_write)
326
282
 
327
283
    def lock_read(self):
328
 
        """Lock the branch for read operations.
329
 
 
330
 
        :return: A bzrlib.lock.LogicalLockResult.
331
 
        """
332
284
        raise NotImplementedError(self.lock_read)
333
285
 
334
286
    def unlock(self):
455
407
            after. If None, the rest of history is included.
456
408
        :param stop_rule: if stop_revision_id is not None, the precise rule
457
409
            to use for termination:
458
 
 
459
410
            * 'exclude' - leave the stop revision out of the result (default)
460
411
            * 'include' - the stop revision is the last item in the result
461
412
            * 'with-merges' - include the stop revision and all of its
462
413
              merged revisions in the result
463
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
464
 
              that are in both ancestries
465
414
        :param direction: either 'reverse' or 'forward':
466
 
 
467
415
            * reverse means return the start_revision_id first, i.e.
468
416
              start at the most recent revision and go backwards in history
469
417
            * forward returns tuples in the opposite order to reverse.
490
438
        # start_revision_id.
491
439
        if self._merge_sorted_revisions_cache is None:
492
440
            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)
 
441
            graph = self.repository.get_graph()
 
442
            parent_map = dict(((key, value) for key, value in
 
443
                     graph.iter_ancestry([last_revision]) if value is not None))
 
444
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
445
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
446
                generate_revno=True)
 
447
            # Drop the sequence # before caching
 
448
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
449
 
497
450
        filtered = self._filter_merge_sorted_revisions(
498
451
            self._merge_sorted_revisions_cache, start_revision_id,
499
452
            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
453
        if direction == 'reverse':
504
454
            return filtered
505
455
        if direction == 'forward':
512
462
        """Iterate over an inclusive range of sorted revisions."""
513
463
        rev_iter = iter(merge_sorted_revisions)
514
464
        if start_revision_id is not None:
515
 
            for node in rev_iter:
516
 
                rev_id = node.key
 
465
            for rev_id, depth, revno, end_of_merge in rev_iter:
517
466
                if rev_id != start_revision_id:
518
467
                    continue
519
468
                else:
520
469
                    # The decision to include the start or not
521
470
                    # 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)
 
471
                    rev_iter = chain(
 
472
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
473
                        rev_iter)
524
474
                    break
525
475
        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)
 
476
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
477
                yield rev_id, depth, revno, end_of_merge
531
478
        elif stop_rule == 'exclude':
532
 
            for node in rev_iter:
533
 
                rev_id = node.key
 
479
            for rev_id, depth, revno, end_of_merge in rev_iter:
534
480
                if rev_id == stop_revision_id:
535
481
                    return
536
 
                yield (rev_id, node.merge_depth, node.revno,
537
 
                       node.end_of_merge)
 
482
                yield rev_id, depth, revno, end_of_merge
538
483
        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)
 
484
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
485
                yield rev_id, depth, revno, end_of_merge
543
486
                if rev_id == stop_revision_id:
544
487
                    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
488
        elif stop_rule == 'with-merges':
558
489
            stop_rev = self.repository.get_revision(stop_revision_id)
559
490
            if stop_rev.parent_ids:
560
491
                left_parent = stop_rev.parent_ids[0]
561
492
            else:
562
493
                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
 
494
            for rev_id, depth, revno, end_of_merge in rev_iter:
569
495
                if rev_id == left_parent:
570
 
                    # reached the left parent after the stop_revision
571
496
                    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)
 
497
                yield rev_id, depth, revno, end_of_merge
582
498
        else:
583
499
            raise ValueError('invalid stop_rule %r' % stop_rule)
584
500
 
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
501
    def leave_lock_in_place(self):
631
502
        """Tell this branch object not to release the physical lock when this
632
503
        object is unlocked.
649
520
        :param other: The branch to bind to
650
521
        :type other: Branch
651
522
        """
652
 
        raise errors.UpgradeRequired(self.user_url)
 
523
        raise errors.UpgradeRequired(self.base)
653
524
 
654
525
    def set_append_revisions_only(self, enabled):
655
526
        if not self._format.supports_set_append_revisions_only():
656
 
            raise errors.UpgradeRequired(self.user_url)
 
527
            raise errors.UpgradeRequired(self.base)
657
528
        if enabled:
658
529
            value = 'True'
659
530
        else:
670
541
        raise errors.UnsupportedOperation(self.get_reference_info, self)
671
542
 
672
543
    @needs_write_lock
673
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
544
    def fetch(self, from_branch, last_revision=None, pb=None):
674
545
        """Copy revisions from from_branch into this branch.
675
546
 
676
547
        :param from_branch: Where to copy from.
677
548
        :param last_revision: What revision to stop at (None for at the end
678
549
                              of the branch.
679
 
        :param limit: Optional rough limit of revisions to fetch
 
550
        :param pb: An optional progress bar to use.
680
551
        :return: None
681
552
        """
682
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
553
        if self.base == from_branch.base:
 
554
            return (0, [])
 
555
        if pb is not None:
 
556
            symbol_versioning.warn(
 
557
                symbol_versioning.deprecated_in((1, 14, 0))
 
558
                % "pb parameter to fetch()")
 
559
        from_branch.lock_read()
 
560
        try:
 
561
            if last_revision is None:
 
562
                last_revision = from_branch.last_revision()
 
563
                last_revision = _mod_revision.ensure_null(last_revision)
 
564
            return self.repository.fetch(from_branch.repository,
 
565
                                         revision_id=last_revision,
 
566
                                         pb=pb)
 
567
        finally:
 
568
            from_branch.unlock()
683
569
 
684
570
    def get_bound_location(self):
685
571
        """Return the URL of the branch we are bound to.
692
578
    def get_old_bound_location(self):
693
579
        """Return the URL of the branch we used to be bound to
694
580
        """
695
 
        raise errors.UpgradeRequired(self.user_url)
 
581
        raise errors.UpgradeRequired(self.base)
696
582
 
697
583
    def get_commit_builder(self, parents, config=None, timestamp=None,
698
584
                           timezone=None, committer=None, revprops=None,
699
 
                           revision_id=None, lossy=False):
 
585
                           revision_id=None):
700
586
        """Obtain a CommitBuilder for this branch.
701
587
 
702
588
        :param parents: Revision ids of the parents of the new revision.
706
592
        :param committer: Optional committer to set for commit.
707
593
        :param revprops: Optional dictionary of revision properties.
708
594
        :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
595
        """
712
596
 
713
597
        if config is None:
714
598
            config = self.get_config()
715
599
 
716
600
        return self.repository.get_commit_builder(self, parents, config,
717
 
            timestamp, timezone, committer, revprops, revision_id,
718
 
            lossy)
 
601
            timestamp, timezone, committer, revprops, revision_id)
719
602
 
720
603
    def get_master_branch(self, possible_transports=None):
721
604
        """Return the branch we are bound to.
748
631
        """Print `file` to stdout."""
749
632
        raise NotImplementedError(self.print_file)
750
633
 
751
 
    @deprecated_method(deprecated_in((2, 4, 0)))
752
634
    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)
 
635
        raise NotImplementedError(self.set_revision_history)
798
636
 
799
637
    @needs_write_lock
800
638
    def set_parent(self, url):
824
662
            stacking.
825
663
        """
826
664
        if not self._format.supports_stacking():
827
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
665
            raise errors.UnstackableBranchFormat(self._format, self.base)
828
666
        # XXX: Changing from one fallback repository to another does not check
829
667
        # that all the data you need is present in the new fallback.
830
668
        # Possibly it should.
844
682
 
845
683
    def _unstack(self):
846
684
        """Change a branch to be unstacked, copying data as needed.
847
 
 
 
685
        
848
686
        Don't call this directly, use set_stacked_on_url(None).
849
687
        """
850
688
        pb = ui.ui_factory.nested_progress_bar()
859
697
            old_repository = self.repository
860
698
            if len(old_repository._fallback_repositories) != 1:
861
699
                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()
 
700
                    "of %r" % (self.repository,))
 
701
            # unlock it, including unlocking the fallback
891
702
            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):
 
703
            old_repository.lock_read()
 
704
            try:
 
705
                # Repositories don't offer an interface to remove fallback
 
706
                # repositories today; take the conceptually simpler option and just
 
707
                # reopen it.  We reopen it starting from the URL so that we
 
708
                # get a separate connection for RemoteRepositories and can
 
709
                # stream from one of them to the other.  This does mean doing
 
710
                # separate SSH connection setup, but unstacking is not a
 
711
                # common operation so it's tolerable.
 
712
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
713
                new_repository = new_bzrdir.find_repository()
 
714
                self.repository = new_repository
 
715
                if self.repository._fallback_repositories:
 
716
                    raise AssertionError("didn't expect %r to have "
 
717
                        "fallback_repositories"
 
718
                        % (self.repository,))
 
719
                # this is not paired with an unlock because it's just restoring
 
720
                # the previous state; the lock's released when set_stacked_on_url
 
721
                # returns
910
722
                self.repository.lock_write()
911
 
            # Fetch from the old repository into the new.
912
 
            old_repository.lock_read()
913
 
            try:
914
723
                # XXX: If you unstack a branch while it has a working tree
915
724
                # with a pending merge, the pending-merged revisions will no
916
725
                # 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)
 
726
                #
 
727
                # XXX: This only fetches up to the tip of the repository; it
 
728
                # doesn't bring across any tags.  That's fairly consistent
 
729
                # with how branch works, but perhaps not ideal.
 
730
                self.repository.fetch(old_repository,
 
731
                    revision_id=self.last_revision(),
 
732
                    find_ghosts=True)
925
733
            finally:
926
734
                old_repository.unlock()
927
735
        finally:
932
740
 
933
741
        :seealso: Branch._get_tags_bytes.
934
742
        """
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)
 
743
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
744
            'tags', bytes)
942
745
 
943
746
    def _cache_revision_history(self, rev_history):
944
747
        """Set the cached revision history to rev_history.
971
774
        self._revision_history_cache = None
972
775
        self._revision_id_to_revno_cache = None
973
776
        self._last_revision_info_cache = None
974
 
        self._master_branch_cache = None
975
777
        self._merge_sorted_revisions_cache = None
976
778
        self._partial_revision_history_cache = []
977
779
        self._partial_revision_id_to_revno_cache = {}
978
 
        self._tags_bytes = None
979
780
 
980
781
    def _gen_revision_history(self):
981
782
        """Return sequence of revision hashes on to this branch.
1018
819
 
1019
820
    def unbind(self):
1020
821
        """Older format branches cannot bind or unbind."""
1021
 
        raise errors.UpgradeRequired(self.user_url)
 
822
        raise errors.UpgradeRequired(self.base)
1022
823
 
1023
824
    def last_revision(self):
1024
825
        """Return last revision id, or NULL_REVISION."""
1031
832
        :return: A tuple (revno, revision_id).
1032
833
        """
1033
834
        if self._last_revision_info_cache is None:
1034
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
835
            self._last_revision_info_cache = self._last_revision_info()
1035
836
        return self._last_revision_info_cache
1036
837
 
1037
 
    def _read_last_revision_info(self):
1038
 
        raise NotImplementedError(self._read_last_revision_info)
1039
 
 
1040
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
838
    def _last_revision_info(self):
 
839
        rh = self.revision_history()
 
840
        revno = len(rh)
 
841
        if revno:
 
842
            return (revno, rh[-1])
 
843
        else:
 
844
            return (0, _mod_revision.NULL_REVISION)
 
845
 
 
846
    @deprecated_method(deprecated_in((1, 6, 0)))
 
847
    def missing_revisions(self, other, stop_revision=None):
 
848
        """Return a list of new revisions that would perfectly fit.
 
849
 
 
850
        If self and other have not diverged, return a list of the revisions
 
851
        present in other, but missing from self.
 
852
        """
 
853
        self_history = self.revision_history()
 
854
        self_len = len(self_history)
 
855
        other_history = other.revision_history()
 
856
        other_len = len(other_history)
 
857
        common_index = min(self_len, other_len) -1
 
858
        if common_index >= 0 and \
 
859
            self_history[common_index] != other_history[common_index]:
 
860
            raise errors.DivergedBranches(self, other)
 
861
 
 
862
        if stop_revision is None:
 
863
            stop_revision = other_len
 
864
        else:
 
865
            if stop_revision > other_len:
 
866
                raise errors.NoSuchRevision(self, stop_revision)
 
867
        return other_history[self_len:stop_revision]
 
868
 
 
869
    @needs_write_lock
 
870
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
871
                         graph=None):
 
872
        """Pull in new perfect-fit revisions.
 
873
 
 
874
        :param other: Another Branch to pull from
 
875
        :param stop_revision: Updated until the given revision
 
876
        :param overwrite: Always set the branch pointer, rather than checking
 
877
            to see if it is a proper descendant.
 
878
        :param graph: A Graph object that can be used to query history
 
879
            information. This can be None.
 
880
        :return: None
 
881
        """
 
882
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
883
            overwrite, graph)
 
884
 
1041
885
    def import_last_revision_info(self, source_repo, revno, revid):
1042
886
        """Set the last revision info, importing from another repo if necessary.
1043
887
 
 
888
        This is used by the bound branch code to upload a revision to
 
889
        the master branch first before updating the tip of the local branch.
 
890
 
1044
891
        :param source_repo: Source repository to optionally fetch from
1045
892
        :param revno: Revision number of the new tip
1046
893
        :param revid: Revision id of the new tip
1049
896
            self.repository.fetch(source_repo, revision_id=revid)
1050
897
        self.set_last_revision_info(revno, revid)
1051
898
 
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
899
    def revision_id_to_revno(self, revision_id):
1074
900
        """Given a revision id, return its revno"""
1075
901
        if _mod_revision.is_null(revision_id):
1095
921
            self._extend_partial_history(distance_from_last)
1096
922
        return self._partial_revision_history_cache[distance_from_last]
1097
923
 
 
924
    @needs_write_lock
1098
925
    def pull(self, source, overwrite=False, stop_revision=None,
1099
926
             possible_transports=None, *args, **kwargs):
1100
927
        """Mirror source into this branch.
1107
934
            stop_revision=stop_revision,
1108
935
            possible_transports=possible_transports, *args, **kwargs)
1109
936
 
1110
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1111
 
            *args, **kwargs):
 
937
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
938
        **kwargs):
1112
939
        """Mirror this branch into target.
1113
940
 
1114
941
        This branch is considered to be 'local', having low latency.
1115
942
        """
1116
943
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1117
 
            lossy, *args, **kwargs)
 
944
            *args, **kwargs)
 
945
 
 
946
    def lossy_push(self, target, stop_revision=None):
 
947
        """Push deltas into another branch.
 
948
 
 
949
        :note: This does not, like push, retain the revision ids from 
 
950
            the source branch and will, rather than adding bzr-specific 
 
951
            metadata, push only those semantics of the revision that can be 
 
952
            natively represented by this branch' VCS.
 
953
 
 
954
        :param target: Target branch
 
955
        :param stop_revision: Revision to push, defaults to last revision.
 
956
        :return: BranchPushResult with an extra member revidmap: 
 
957
            A dictionary mapping revision ids from the target branch 
 
958
            to new revision ids in the target branch, for each 
 
959
            revision that was pushed.
 
960
        """
 
961
        inter = InterBranch.get(self, target)
 
962
        lossy_push = getattr(inter, "lossy_push", None)
 
963
        if lossy_push is None:
 
964
            raise errors.LossyPushToSameVCS(self, target)
 
965
        return lossy_push(stop_revision)
1118
966
 
1119
967
    def basis_tree(self):
1120
968
        """Return `Tree` object for last revision."""
1137
985
        try:
1138
986
            return urlutils.join(self.base[:-1], parent)
1139
987
        except errors.InvalidURLJoin, e:
1140
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
988
            raise errors.InaccessibleParent(parent, self.base)
1141
989
 
1142
990
    def _get_parent_location(self):
1143
991
        raise NotImplementedError(self._get_parent_location)
1228
1076
        params = ChangeBranchTipParams(
1229
1077
            self, old_revno, new_revno, old_revid, new_revid)
1230
1078
        for hook in hooks:
1231
 
            hook(params)
 
1079
            try:
 
1080
                hook(params)
 
1081
            except errors.TipChangeRejected:
 
1082
                raise
 
1083
            except Exception:
 
1084
                exc_info = sys.exc_info()
 
1085
                hook_name = Branch.hooks.get_hook_name(hook)
 
1086
                raise errors.HookFailed(
 
1087
                    'pre_change_branch_tip', hook_name, exc_info)
1232
1088
 
1233
1089
    @needs_write_lock
1234
1090
    def update(self):
1275
1131
        return result
1276
1132
 
1277
1133
    @needs_read_lock
1278
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1279
 
            repository=None):
 
1134
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1280
1135
        """Create a new line of development from the branch, into to_bzrdir.
1281
1136
 
1282
1137
        to_bzrdir controls the branch format.
1284
1139
        revision_id: if not None, the revision history in the new branch will
1285
1140
                     be truncated to end with revision_id.
1286
1141
        """
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)
 
1142
        result = to_bzrdir.create_branch()
1291
1143
        result.lock_write()
1292
1144
        try:
1293
1145
            if repository_policy is not None:
1294
1146
                repository_policy.configure_branch(result)
1295
1147
            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)
 
1148
            result.set_parent(self.bzrdir.root_transport.base)
1301
1149
        finally:
1302
1150
            result.unlock()
1303
1151
        return result
1327
1175
                revno = 1
1328
1176
        destination.set_last_revision_info(revno, revision_id)
1329
1177
 
 
1178
    @needs_read_lock
1330
1179
    def copy_content_into(self, destination, revision_id=None):
1331
1180
        """Copy the content of self into destination.
1332
1181
 
1333
1182
        revision_id: if not None, the revision history in the new branch will
1334
1183
                     be truncated to end with revision_id.
1335
1184
        """
1336
 
        return InterBranch.get(self, destination).copy_content_into(
1337
 
            revision_id=revision_id)
 
1185
        self.update_references(destination)
 
1186
        self._synchronize_history(destination, revision_id)
 
1187
        try:
 
1188
            parent = self.get_parent()
 
1189
        except errors.InaccessibleParent, e:
 
1190
            mutter('parent was not accessible to copy: %s', e)
 
1191
        else:
 
1192
            if parent:
 
1193
                destination.set_parent(parent)
 
1194
        if self._push_should_merge_tags():
 
1195
            self.tags.merge_to(destination.tags)
1338
1196
 
1339
1197
    def update_references(self, target):
1340
1198
        if not getattr(self._format, 'supports_reference_locations', False):
1354
1212
        target._set_all_reference_info(target_reference_dict)
1355
1213
 
1356
1214
    @needs_read_lock
1357
 
    def check(self, refs):
 
1215
    def check(self):
1358
1216
        """Check consistency of the branch.
1359
1217
 
1360
1218
        In particular this checks that revisions given in the revision-history
1363
1221
 
1364
1222
        Callers will typically also want to check the repository.
1365
1223
 
1366
 
        :param refs: Calculated refs for this branch as specified by
1367
 
            branch._get_check_refs()
1368
1224
        :return: A BranchCheckResult.
1369
1225
        """
1370
 
        result = BranchCheckResult(self)
 
1226
        ret = BranchCheckResult(self)
 
1227
        mainline_parent_id = None
1371
1228
        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
 
1229
        real_rev_history = []
 
1230
        try:
 
1231
            for revid in self.repository.iter_reverse_revision_history(
 
1232
                last_revision_id):
 
1233
                real_rev_history.append(revid)
 
1234
        except errors.RevisionNotPresent:
 
1235
            ret.ghosts_in_mainline = True
 
1236
        else:
 
1237
            ret.ghosts_in_mainline = False
 
1238
        real_rev_history.reverse()
 
1239
        if len(real_rev_history) != last_revno:
 
1240
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1241
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1242
        # TODO: We should probably also check that real_rev_history actually
 
1243
        #       matches self.revision_history()
 
1244
        for revision_id in real_rev_history:
 
1245
            try:
 
1246
                revision = self.repository.get_revision(revision_id)
 
1247
            except errors.NoSuchRevision, e:
 
1248
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1249
                            % revision_id)
 
1250
            # In general the first entry on the revision history has no parents.
 
1251
            # But it's not illegal for it to have parents listed; this can happen
 
1252
            # in imports from Arch when the parents weren't reachable.
 
1253
            if mainline_parent_id is not None:
 
1254
                if mainline_parent_id not in revision.parent_ids:
 
1255
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1256
                                        "parents of {%s}"
 
1257
                                        % (mainline_parent_id, revision_id))
 
1258
            mainline_parent_id = revision_id
 
1259
        return ret
1383
1260
 
1384
1261
    def _get_checkout_format(self):
1385
1262
        """Return the most suitable metadir for a checkout of this branch.
1386
1263
        Weaves are used if this branch's repository uses weaves.
1387
1264
        """
1388
 
        format = self.repository.bzrdir.checkout_metadir()
1389
 
        format.set_branch_format(self._format)
 
1265
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1266
            from bzrlib.repofmt import weaverepo
 
1267
            format = bzrdir.BzrDirMetaFormat1()
 
1268
            format.repository_format = weaverepo.RepositoryFormat7()
 
1269
        else:
 
1270
            format = self.repository.bzrdir.checkout_metadir()
 
1271
            format.set_branch_format(self._format)
1390
1272
        return format
1391
1273
 
1392
1274
    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):
 
1275
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1395
1276
        """Create a clone of this branch and its bzrdir.
1396
1277
 
1397
1278
        :param to_transport: The transport to clone onto.
1404
1285
        """
1405
1286
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1406
1287
        # 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
1288
        if revision_id is None:
1410
1289
            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)
 
1290
        try:
 
1291
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1292
                revision_id=revision_id, stacked_on=stacked_on,
 
1293
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1294
        except errors.FileExists:
 
1295
            if not use_existing_dir:
 
1296
                raise
 
1297
        except errors.NoSuchFile:
 
1298
            if not create_prefix:
 
1299
                raise
1415
1300
        return dir_to.open_branch()
1416
1301
 
1417
1302
    def create_checkout(self, to_location, revision_id=None,
1422
1307
        :param to_location: The url to produce the checkout at
1423
1308
        :param revision_id: The revision to check out
1424
1309
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1425
 
            produce a bound branch (heavyweight checkout)
 
1310
        produce a bound branch (heavyweight checkout)
1426
1311
        :param accelerator_tree: A tree which can be used for retrieving file
1427
1312
            contents more quickly than the revision tree, i.e. a workingtree.
1428
1313
            The revision tree will be used for cases where accelerator_tree's
1436
1321
        if lightweight:
1437
1322
            format = self._get_checkout_format()
1438
1323
            checkout = format.initialize_on_transport(t)
1439
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1440
 
                target_branch=self)
 
1324
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1441
1325
        else:
1442
1326
            format = self._get_checkout_format()
1443
1327
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1474
1358
 
1475
1359
    def reference_parent(self, file_id, path, possible_transports=None):
1476
1360
        """Return the parent branch for a tree-reference file_id
1477
 
 
1478
1361
        :param file_id: The file_id of the tree reference
1479
1362
        :param path: The path of the file_id in the tree
1480
1363
        :return: A branch associated with the file_id
1486
1369
    def supports_tags(self):
1487
1370
        return self._format.supports_tags()
1488
1371
 
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
1372
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1502
1373
                                         other_branch):
1503
1374
        """Ensure that revision_b is a descendant of revision_a.
1533
1404
        else:
1534
1405
            raise AssertionError("invalid heads: %r" % (heads,))
1535
1406
 
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):
 
1407
 
 
1408
class BranchFormat(object):
1558
1409
    """An encapsulation of the initialization and open routines for a format.
1559
1410
 
1560
1411
    Formats provide three things:
1563
1414
     * an open routine.
1564
1415
 
1565
1416
    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
 
1417
    during branch opening. Its not required that these be instances, they
1567
1418
    can be classes themselves with class methods - it simply depends on
1568
1419
    whether state is needed for a given format or not.
1569
1420
 
1572
1423
    object will be created every time regardless.
1573
1424
    """
1574
1425
 
 
1426
    _default_format = None
 
1427
    """The default format used for new branches."""
 
1428
 
 
1429
    _formats = {}
 
1430
    """The known formats."""
 
1431
 
1575
1432
    can_set_append_revisions_only = True
1576
1433
 
1577
1434
    def __eq__(self, other):
1581
1438
        return not (self == other)
1582
1439
 
1583
1440
    @classmethod
1584
 
    def find_format(klass, a_bzrdir, name=None):
 
1441
    def find_format(klass, a_bzrdir):
1585
1442
        """Return the format for the branch object in a_bzrdir."""
1586
1443
        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)
 
1444
            transport = a_bzrdir.get_branch_transport(None)
 
1445
            format_string = transport.get("format").read()
 
1446
            return klass._formats[format_string]
1590
1447
        except errors.NoSuchFile:
1591
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1448
            raise errors.NotBranchError(path=transport.base)
1592
1449
        except KeyError:
1593
1450
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1594
1451
 
1595
1452
    @classmethod
1596
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1597
1453
    def get_default_format(klass):
1598
1454
        """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):
 
1455
        return klass._default_format
 
1456
 
 
1457
    def get_reference(self, a_bzrdir):
1612
1458
        """Get the target reference of the branch in a_bzrdir.
1613
1459
 
1614
1460
        format probing must have been completed before calling
1616
1462
        in a_bzrdir is correct.
1617
1463
 
1618
1464
        :param a_bzrdir: The bzrdir to get the branch data from.
1619
 
        :param name: Name of the colocated branch to fetch
1620
1465
        :return: None if the branch is not a reference branch.
1621
1466
        """
1622
1467
        return None
1623
1468
 
1624
1469
    @classmethod
1625
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1470
    def set_reference(self, a_bzrdir, to_branch):
1626
1471
        """Set the target reference of the branch in a_bzrdir.
1627
1472
 
1628
1473
        format probing must have been completed before calling
1630
1475
        in a_bzrdir is correct.
1631
1476
 
1632
1477
        :param a_bzrdir: The bzrdir to set the branch reference for.
1633
 
        :param name: Name of colocated branch to set, None for default
1634
1478
        :param to_branch: branch that the checkout is to reference
1635
1479
        """
1636
1480
        raise NotImplementedError(self.set_reference)
1643
1487
        """Return the short format description for this format."""
1644
1488
        raise NotImplementedError(self.get_format_description)
1645
1489
 
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)
 
1490
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1491
                           set_format=True):
 
1492
        """Initialize a branch in a bzrdir, with specified files
1653
1493
 
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.
 
1494
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1495
        :param utf8_files: The files to create as a list of
 
1496
            (filename, content) tuples
 
1497
        :param set_format: If True, set the format with
 
1498
            self.get_format_string.  (BzrBranch4 has its format set
 
1499
            elsewhere)
 
1500
        :return: a branch in this format
1658
1501
        """
 
1502
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1503
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1504
        lock_map = {
 
1505
            'metadir': ('lock', lockdir.LockDir),
 
1506
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1507
        }
 
1508
        lock_name, lock_class = lock_map[lock_type]
 
1509
        control_files = lockable_files.LockableFiles(branch_transport,
 
1510
            lock_name, lock_class)
 
1511
        control_files.create_lock()
 
1512
        try:
 
1513
            control_files.lock_write()
 
1514
        except errors.LockContention:
 
1515
            if lock_type != 'branch4':
 
1516
                raise
 
1517
            lock_taken = False
 
1518
        else:
 
1519
            lock_taken = True
 
1520
        if set_format:
 
1521
            utf8_files += [('format', self.get_format_string())]
 
1522
        try:
 
1523
            for (filename, content) in utf8_files:
 
1524
                branch_transport.put_bytes(
 
1525
                    filename, content,
 
1526
                    mode=a_bzrdir._get_file_mode())
 
1527
        finally:
 
1528
            if lock_taken:
 
1529
                control_files.unlock()
 
1530
        return self.open(a_bzrdir, _found=True)
 
1531
 
 
1532
    def initialize(self, a_bzrdir):
 
1533
        """Create a branch of this format in a_bzrdir."""
1659
1534
        raise NotImplementedError(self.initialize)
1660
1535
 
1661
1536
    def is_supported(self):
1691
1566
        """
1692
1567
        raise NotImplementedError(self.network_name)
1693
1568
 
1694
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1695
 
            found_repository=None):
 
1569
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1696
1570
        """Return the branch object for a_bzrdir
1697
1571
 
1698
1572
        :param a_bzrdir: A BzrDir that contains a branch.
1699
 
        :param name: Name of colocated branch to open
1700
1573
        :param _found: a private parameter, do not use it. It is used to
1701
1574
            indicate if format probing has already be done.
1702
1575
        :param ignore_fallbacks: when set, no fallback branches will be opened
1705
1578
        raise NotImplementedError(self.open)
1706
1579
 
1707
1580
    @classmethod
1708
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1709
1581
    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)
 
1582
        """Register a metadir format."""
 
1583
        klass._formats[format.get_format_string()] = format
 
1584
        # Metadir formats have a network name of their format string, and get
 
1585
        # registered as class factories.
 
1586
        network_format_registry.register(format.get_format_string(), format.__class__)
1716
1587
 
1717
1588
    @classmethod
1718
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1719
1589
    def set_default_format(klass, format):
1720
 
        format_registry.set_default(format)
 
1590
        klass._default_format = format
1721
1591
 
1722
1592
    def supports_set_append_revisions_only(self):
1723
1593
        """True if this format supports set_append_revisions_only."""
1727
1597
        """True if this format records a stacked-on branch."""
1728
1598
        return False
1729
1599
 
1730
 
    def supports_leaving_lock(self):
1731
 
        """True if this format supports leaving locks in place."""
1732
 
        return False # by default
1733
 
 
1734
1600
    @classmethod
1735
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1736
1601
    def unregister_format(klass, format):
1737
 
        format_registry.remove(format)
 
1602
        del klass._formats[format.get_format_string()]
1738
1603
 
1739
1604
    def __str__(self):
1740
1605
        return self.get_format_description().rstrip()
1744
1609
        return False  # by default
1745
1610
 
1746
1611
 
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
1612
class BranchHooks(Hooks):
1776
1613
    """A dictionary mapping hook name to a list of callables for branch hooks.
1777
1614
 
1785
1622
        These are all empty initially, because by default nothing should get
1786
1623
        notified.
1787
1624
        """
1788
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1789
 
        self.add_hook('set_rh',
 
1625
        Hooks.__init__(self)
 
1626
        self.create_hook(HookPoint('set_rh',
1790
1627
            "Invoked whenever the revision history has been set via "
1791
1628
            "set_revision_history. The api signature is (branch, "
1792
1629
            "revision_history), and the branch will be write-locked. "
1793
1630
            "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',
 
1631
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1632
        self.create_hook(HookPoint('open',
1796
1633
            "Called with the Branch object that has been opened after a "
1797
 
            "branch is opened.", (1, 8))
1798
 
        self.add_hook('post_push',
 
1634
            "branch is opened.", (1, 8), None))
 
1635
        self.create_hook(HookPoint('post_push',
1799
1636
            "Called after a push operation completes. post_push is called "
1800
1637
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1801
 
            "bzr client.", (0, 15))
1802
 
        self.add_hook('post_pull',
 
1638
            "bzr client.", (0, 15), None))
 
1639
        self.create_hook(HookPoint('post_pull',
1803
1640
            "Called after a pull operation completes. post_pull is called "
1804
1641
            "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 "
 
1642
            "bzr client.", (0, 15), None))
 
1643
        self.create_hook(HookPoint('pre_commit',
 
1644
            "Called after a commit is calculated but before it is is "
1808
1645
            "completed. pre_commit is called with (local, master, old_revno, "
1809
1646
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1810
1647
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1812
1649
            "basis revision. hooks MUST NOT modify this delta. "
1813
1650
            " future_tree is an in-memory tree obtained from "
1814
1651
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1815
 
            "tree.", (0,91))
1816
 
        self.add_hook('post_commit',
 
1652
            "tree.", (0,91), None))
 
1653
        self.create_hook(HookPoint('post_commit',
1817
1654
            "Called in the bzr client after a commit has completed. "
1818
1655
            "post_commit is called with (local, master, old_revno, old_revid, "
1819
1656
            "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',
 
1657
            "commit to a branch.", (0, 15), None))
 
1658
        self.create_hook(HookPoint('post_uncommit',
1822
1659
            "Called in the bzr client after an uncommit completes. "
1823
1660
            "post_uncommit is called with (local, master, old_revno, "
1824
1661
            "old_revid, new_revno, new_revid) where local is the local branch "
1825
1662
            "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',
 
1663
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1664
        self.create_hook(HookPoint('pre_change_branch_tip',
1828
1665
            "Called in bzr client and server before a change to the tip of a "
1829
1666
            "branch is made. pre_change_branch_tip is called with a "
1830
1667
            "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',
 
1668
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1669
        self.create_hook(HookPoint('post_change_branch_tip',
1833
1670
            "Called in bzr client and server after a change to the tip of a "
1834
1671
            "branch is made. post_change_branch_tip is called with a "
1835
1672
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1836
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1837
 
        self.add_hook('transform_fallback_location',
 
1673
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1674
        self.create_hook(HookPoint('transform_fallback_location',
1838
1675
            "Called when a stacked branch is activating its fallback "
1839
1676
            "locations. transform_fallback_location is called with (branch, "
1840
1677
            "url), and should return a new url. Returning the same url "
1845
1682
            "fallback locations have not been activated. When there are "
1846
1683
            "multiple hooks installed for transform_fallback_location, "
1847
1684
            "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
 
 
 
1685
            "The order is however undefined.", (1, 9), None))
1866
1686
 
1867
1687
 
1868
1688
# install the default hooks into the Branch class.
1870
1690
 
1871
1691
 
1872
1692
class ChangeBranchTipParams(object):
1873
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1693
    """Object holding parameters passed to *_change_branch_tip hooks.
1874
1694
 
1875
1695
    There are 5 fields that hooks may wish to access:
1876
1696
 
1907
1727
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1908
1728
 
1909
1729
 
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)
 
1730
class BzrBranchFormat4(BranchFormat):
 
1731
    """Bzr branch format 4.
 
1732
 
 
1733
    This format has:
 
1734
     - a revision-history file.
 
1735
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1736
    """
 
1737
 
 
1738
    def get_format_description(self):
 
1739
        """See BranchFormat.get_format_description()."""
 
1740
        return "Branch format 4"
 
1741
 
 
1742
    def initialize(self, a_bzrdir):
 
1743
        """Create a branch of this format in a_bzrdir."""
 
1744
        utf8_files = [('revision-history', ''),
 
1745
                      ('branch-name', ''),
 
1746
                      ]
 
1747
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1748
                                       lock_type='branch4', set_format=False)
 
1749
 
 
1750
    def __init__(self):
 
1751
        super(BzrBranchFormat4, self).__init__()
 
1752
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1753
 
 
1754
    def network_name(self):
 
1755
        """The network name for this format is the control dirs disk label."""
 
1756
        return self._matchingbzrdir.get_format_string()
 
1757
 
 
1758
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1759
        """See BranchFormat.open()."""
 
1760
        if not _found:
 
1761
            # we are being called directly and must probe.
 
1762
            raise NotImplementedError
 
1763
        return BzrBranch(_format=self,
 
1764
                         _control_files=a_bzrdir._control_files,
 
1765
                         a_bzrdir=a_bzrdir,
 
1766
                         _repository=a_bzrdir.open_repository())
 
1767
 
 
1768
    def __str__(self):
 
1769
        return "Bazaar-NG branch format 4"
1981
1770
 
1982
1771
 
1983
1772
class BranchFormatMetadir(BranchFormat):
1987
1776
        """What class to instantiate on open calls."""
1988
1777
        raise NotImplementedError(self._branch_class)
1989
1778
 
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
1779
    def network_name(self):
2020
1780
        """A simple byte string uniquely identifying this format for RPC calls.
2021
1781
 
2023
1783
        """
2024
1784
        return self.get_format_string()
2025
1785
 
2026
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2027
 
            found_repository=None):
 
1786
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
2028
1787
        """See BranchFormat.open()."""
2029
1788
        if not _found:
2030
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1789
            format = BranchFormat.find_format(a_bzrdir)
2031
1790
            if format.__class__ != self.__class__:
2032
1791
                raise AssertionError("wrong format %r found for %r" %
2033
1792
                    (format, self))
2034
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2035
1793
        try:
 
1794
            transport = a_bzrdir.get_branch_transport(None)
2036
1795
            control_files = lockable_files.LockableFiles(transport, 'lock',
2037
1796
                                                         lockdir.LockDir)
2038
 
            if found_repository is None:
2039
 
                found_repository = a_bzrdir.find_repository()
2040
1797
            return self._branch_class()(_format=self,
2041
1798
                              _control_files=control_files,
2042
 
                              name=name,
2043
1799
                              a_bzrdir=a_bzrdir,
2044
 
                              _repository=found_repository,
 
1800
                              _repository=a_bzrdir.find_repository(),
2045
1801
                              ignore_fallbacks=ignore_fallbacks)
2046
1802
        except errors.NoSuchFile:
2047
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1803
            raise errors.NotBranchError(path=transport.base)
2048
1804
 
2049
1805
    def __init__(self):
2050
1806
        super(BranchFormatMetadir, self).__init__()
2054
1810
    def supports_tags(self):
2055
1811
        return True
2056
1812
 
2057
 
    def supports_leaving_lock(self):
2058
 
        return True
2059
 
 
2060
1813
 
2061
1814
class BzrBranchFormat5(BranchFormatMetadir):
2062
1815
    """Bzr branch format 5.
2082
1835
        """See BranchFormat.get_format_description()."""
2083
1836
        return "Branch format 5"
2084
1837
 
2085
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1838
    def initialize(self, a_bzrdir):
2086
1839
        """Create a branch of this format in a_bzrdir."""
2087
1840
        utf8_files = [('revision-history', ''),
2088
1841
                      ('branch-name', ''),
2089
1842
                      ]
2090
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1843
        return self._initialize_helper(a_bzrdir, utf8_files)
2091
1844
 
2092
1845
    def supports_tags(self):
2093
1846
        return False
2115
1868
        """See BranchFormat.get_format_description()."""
2116
1869
        return "Branch format 6"
2117
1870
 
2118
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1871
    def initialize(self, a_bzrdir):
2119
1872
        """Create a branch of this format in a_bzrdir."""
2120
1873
        utf8_files = [('last-revision', '0 null:\n'),
2121
1874
                      ('branch.conf', ''),
2122
1875
                      ('tags', ''),
2123
1876
                      ]
2124
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1877
        return self._initialize_helper(a_bzrdir, utf8_files)
2125
1878
 
2126
1879
    def make_tags(self, branch):
2127
1880
        """See bzrlib.branch.BranchFormat.make_tags()."""
2145
1898
        """See BranchFormat.get_format_description()."""
2146
1899
        return "Branch format 8"
2147
1900
 
2148
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1901
    def initialize(self, a_bzrdir):
2149
1902
        """Create a branch of this format in a_bzrdir."""
2150
1903
        utf8_files = [('last-revision', '0 null:\n'),
2151
1904
                      ('branch.conf', ''),
2152
1905
                      ('tags', ''),
2153
1906
                      ('references', '')
2154
1907
                      ]
2155
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1908
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1909
 
 
1910
    def __init__(self):
 
1911
        super(BzrBranchFormat8, self).__init__()
 
1912
        self._matchingbzrdir.repository_format = \
 
1913
            RepositoryFormatKnitPack5RichRoot()
2156
1914
 
2157
1915
    def make_tags(self, branch):
2158
1916
        """See bzrlib.branch.BranchFormat.make_tags()."""
2167
1925
    supports_reference_locations = True
2168
1926
 
2169
1927
 
2170
 
class BzrBranchFormat7(BranchFormatMetadir):
 
1928
class BzrBranchFormat7(BzrBranchFormat8):
2171
1929
    """Branch format with last-revision, tags, and a stacked location pointer.
2172
1930
 
2173
1931
    The stacked location pointer is passed down to the repository and requires
2176
1934
    This format was introduced in bzr 1.6.
2177
1935
    """
2178
1936
 
2179
 
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1937
    def initialize(self, a_bzrdir):
2180
1938
        """Create a branch of this format in a_bzrdir."""
2181
1939
        utf8_files = [('last-revision', '0 null:\n'),
2182
1940
                      ('branch.conf', ''),
2183
1941
                      ('tags', ''),
2184
1942
                      ]
2185
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
1943
        return self._initialize_helper(a_bzrdir, utf8_files)
2186
1944
 
2187
1945
    def _branch_class(self):
2188
1946
        return BzrBranch7
2198
1956
    def supports_set_append_revisions_only(self):
2199
1957
        return True
2200
1958
 
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
1959
    supports_reference_locations = False
2209
1960
 
2210
1961
 
2227
1978
        """See BranchFormat.get_format_description()."""
2228
1979
        return "Checkout reference format 1"
2229
1980
 
2230
 
    def get_reference(self, a_bzrdir, name=None):
 
1981
    def get_reference(self, a_bzrdir):
2231
1982
        """See BranchFormat.get_reference()."""
2232
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
2233
 
        return transport.get_bytes('location')
 
1983
        transport = a_bzrdir.get_branch_transport(None)
 
1984
        return transport.get('location').read()
2234
1985
 
2235
 
    def set_reference(self, a_bzrdir, name, to_branch):
 
1986
    def set_reference(self, a_bzrdir, to_branch):
2236
1987
        """See BranchFormat.set_reference()."""
2237
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
 
1988
        transport = a_bzrdir.get_branch_transport(None)
2238
1989
        location = transport.put_bytes('location', to_branch.base)
2239
1990
 
2240
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2241
 
            repository=None):
 
1991
    def initialize(self, a_bzrdir, target_branch=None):
2242
1992
        """Create a branch of this format in a_bzrdir."""
2243
1993
        if target_branch is None:
2244
1994
            # this format does not implement branch itself, thus the implicit
2245
1995
            # creation contract must see it as uninitializable
2246
1996
            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)
 
1997
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1998
        branch_transport = a_bzrdir.get_branch_transport(self)
2249
1999
        branch_transport.put_bytes('location',
2250
 
            target_branch.bzrdir.user_url)
 
2000
            target_branch.bzrdir.root_transport.base)
2251
2001
        branch_transport.put_bytes('format', self.get_format_string())
2252
 
        branch = self.open(
2253
 
            a_bzrdir, name, _found=True,
 
2002
        return self.open(
 
2003
            a_bzrdir, _found=True,
2254
2004
            possible_transports=[target_branch.bzrdir.root_transport])
2255
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2256
 
        return branch
2257
2005
 
2258
2006
    def __init__(self):
2259
2007
        super(BranchReferenceFormat, self).__init__()
2265
2013
        def clone(to_bzrdir, revision_id=None,
2266
2014
            repository_policy=None):
2267
2015
            """See Branch.clone()."""
2268
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
2016
            return format.initialize(to_bzrdir, a_branch)
2269
2017
            # cannot obey revision_id limits when cloning a reference ...
2270
2018
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2271
2019
            # emit some sort of warning/error to the caller ?!
2272
2020
        return clone
2273
2021
 
2274
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2275
 
             possible_transports=None, ignore_fallbacks=False,
2276
 
             found_repository=None):
 
2022
    def open(self, a_bzrdir, _found=False, location=None,
 
2023
             possible_transports=None, ignore_fallbacks=False):
2277
2024
        """Return the branch that the branch reference in a_bzrdir points at.
2278
2025
 
2279
2026
        :param a_bzrdir: A BzrDir that contains a branch.
2280
 
        :param name: Name of colocated branch to open, if any
2281
2027
        :param _found: a private parameter, do not use it. It is used to
2282
2028
            indicate if format probing has already be done.
2283
2029
        :param ignore_fallbacks: when set, no fallback branches will be opened
2288
2034
        :param possible_transports: An optional reusable transports list.
2289
2035
        """
2290
2036
        if not _found:
2291
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
2037
            format = BranchFormat.find_format(a_bzrdir)
2292
2038
            if format.__class__ != self.__class__:
2293
2039
                raise AssertionError("wrong format %r found for %r" %
2294
2040
                    (format, self))
2295
2041
        if location is None:
2296
 
            location = self.get_reference(a_bzrdir, name)
 
2042
            location = self.get_reference(a_bzrdir)
2297
2043
        real_bzrdir = bzrdir.BzrDir.open(
2298
2044
            location, possible_transports=possible_transports)
2299
 
        result = real_bzrdir.open_branch(name=name, 
2300
 
            ignore_fallbacks=ignore_fallbacks)
 
2045
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2301
2046
        # this changes the behaviour of result.clone to create a new reference
2302
2047
        # rather than a copy of the content of the branch.
2303
2048
        # I did not use a proxy object because that needs much more extensive
2310
2055
        return result
2311
2056
 
2312
2057
 
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
2058
network_format_registry = registry.FormatRegistry()
2328
2059
"""Registry of formats indexed by their network name.
2329
2060
 
2332
2063
BranchFormat.network_name() for more detail.
2333
2064
"""
2334
2065
 
2335
 
format_registry = BranchFormatRegistry(network_format_registry)
2336
 
 
2337
2066
 
2338
2067
# formats which have no format string are not discoverable
2339
2068
# and not independently creatable, so are not registered.
2341
2070
__format6 = BzrBranchFormat6()
2342
2071
__format7 = BzrBranchFormat7()
2343
2072
__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):
 
2073
BranchFormat.register_format(__format5)
 
2074
BranchFormat.register_format(BranchReferenceFormat())
 
2075
BranchFormat.register_format(__format6)
 
2076
BranchFormat.register_format(__format7)
 
2077
BranchFormat.register_format(__format8)
 
2078
BranchFormat.set_default_format(__format6)
 
2079
_legacy_formats = [BzrBranchFormat4(),
 
2080
    ]
 
2081
network_format_registry.register(
 
2082
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2083
 
 
2084
 
 
2085
class BzrBranch(Branch):
2370
2086
    """A branch stored in the actual filesystem.
2371
2087
 
2372
2088
    Note that it's "local" in the context of the filesystem; it doesn't
2378
2094
    :ivar repository: Repository for this branch.
2379
2095
    :ivar base: The url of the base directory for this branch; the one
2380
2096
        containing the .bzr directory.
2381
 
    :ivar name: Optional colocated branch name as it exists in the control
2382
 
        directory.
2383
2097
    """
2384
2098
 
2385
2099
    def __init__(self, _format=None,
2386
 
                 _control_files=None, a_bzrdir=None, name=None,
2387
 
                 _repository=None, ignore_fallbacks=False):
 
2100
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2101
                 ignore_fallbacks=False):
2388
2102
        """Create new branch object at a particular location."""
2389
2103
        if a_bzrdir is None:
2390
2104
            raise ValueError('a_bzrdir must be supplied')
2391
2105
        else:
2392
2106
            self.bzrdir = a_bzrdir
2393
2107
        self._base = self.bzrdir.transport.clone('..').base
2394
 
        self.name = name
2395
2108
        # XXX: We should be able to just do
2396
2109
        #   self.base = self.bzrdir.root_transport.base
2397
2110
        # but this does not quite work yet -- mbp 20080522
2404
2117
        Branch.__init__(self)
2405
2118
 
2406
2119
    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)
 
2120
        return '%s(%r)' % (self.__class__.__name__, self.base)
2412
2121
 
2413
2122
    __repr__ = __str__
2414
2123
 
2425
2134
        return self.control_files.is_locked()
2426
2135
 
2427
2136
    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
2137
        # All-in-one needs to always unlock/lock.
2437
2138
        repo_control = getattr(self.repository, 'control_files', None)
2438
2139
        if self.control_files == repo_control or not self.is_locked():
2439
 
            self.repository._warn_if_deprecated(self)
2440
2140
            self.repository.lock_write()
2441
2141
            took_lock = True
2442
2142
        else:
2443
2143
            took_lock = False
2444
2144
        try:
2445
 
            return BranchWriteLockResult(self.unlock,
2446
 
                self.control_files.lock_write(token=token))
 
2145
            return self.control_files.lock_write(token=token)
2447
2146
        except:
2448
2147
            if took_lock:
2449
2148
                self.repository.unlock()
2450
2149
            raise
2451
2150
 
2452
2151
    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
2152
        # All-in-one needs to always unlock/lock.
2460
2153
        repo_control = getattr(self.repository, 'control_files', None)
2461
2154
        if self.control_files == repo_control or not self.is_locked():
2462
 
            self.repository._warn_if_deprecated(self)
2463
2155
            self.repository.lock_read()
2464
2156
            took_lock = True
2465
2157
        else:
2466
2158
            took_lock = False
2467
2159
        try:
2468
2160
            self.control_files.lock_read()
2469
 
            return LogicalLockResult(self.unlock)
2470
2161
        except:
2471
2162
            if took_lock:
2472
2163
                self.repository.unlock()
2473
2164
            raise
2474
2165
 
2475
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2476
2166
    def unlock(self):
2477
2167
        try:
2478
2168
            self.control_files.unlock()
2500
2190
        """See Branch.print_file."""
2501
2191
        return self.repository.print_file(file, revision_id)
2502
2192
 
 
2193
    def _write_revision_history(self, history):
 
2194
        """Factored out of set_revision_history.
 
2195
 
 
2196
        This performs the actual writing to disk.
 
2197
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2198
        self._transport.put_bytes(
 
2199
            'revision-history', '\n'.join(history),
 
2200
            mode=self.bzrdir._get_file_mode())
 
2201
 
 
2202
    @needs_write_lock
 
2203
    def set_revision_history(self, rev_history):
 
2204
        """See Branch.set_revision_history."""
 
2205
        if 'evil' in debug.debug_flags:
 
2206
            mutter_callsite(3, "set_revision_history scales with history.")
 
2207
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2208
        for rev_id in rev_history:
 
2209
            check_not_reserved_id(rev_id)
 
2210
        if Branch.hooks['post_change_branch_tip']:
 
2211
            # Don't calculate the last_revision_info() if there are no hooks
 
2212
            # that will use it.
 
2213
            old_revno, old_revid = self.last_revision_info()
 
2214
        if len(rev_history) == 0:
 
2215
            revid = _mod_revision.NULL_REVISION
 
2216
        else:
 
2217
            revid = rev_history[-1]
 
2218
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2219
        self._write_revision_history(rev_history)
 
2220
        self._clear_cached_state()
 
2221
        self._cache_revision_history(rev_history)
 
2222
        for hook in Branch.hooks['set_rh']:
 
2223
            hook(self, rev_history)
 
2224
        if Branch.hooks['post_change_branch_tip']:
 
2225
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2226
 
 
2227
    def _synchronize_history(self, destination, revision_id):
 
2228
        """Synchronize last revision and revision history between branches.
 
2229
 
 
2230
        This version is most efficient when the destination is also a
 
2231
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2232
        history is the true lefthand parent history, and all of the revisions
 
2233
        are in the destination's repository.  If not, set_revision_history
 
2234
        will fail.
 
2235
 
 
2236
        :param destination: The branch to copy the history into
 
2237
        :param revision_id: The revision-id to truncate history at.  May
 
2238
          be None to copy complete history.
 
2239
        """
 
2240
        if not isinstance(destination._format, BzrBranchFormat5):
 
2241
            super(BzrBranch, self)._synchronize_history(
 
2242
                destination, revision_id)
 
2243
            return
 
2244
        if revision_id == _mod_revision.NULL_REVISION:
 
2245
            new_history = []
 
2246
        else:
 
2247
            new_history = self.revision_history()
 
2248
        if revision_id is not None and new_history != []:
 
2249
            try:
 
2250
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2251
            except ValueError:
 
2252
                rev = self.repository.get_revision(revision_id)
 
2253
                new_history = rev.get_history(self.repository)[1:]
 
2254
        destination.set_revision_history(new_history)
 
2255
 
2503
2256
    @needs_write_lock
2504
2257
    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)
 
2258
        """Set the last revision of this branch.
 
2259
 
 
2260
        The caller is responsible for checking that the revno is correct
 
2261
        for this revision id.
 
2262
 
 
2263
        It may be possible to set the branch last revision to an id not
 
2264
        present in the repository.  However, branches can also be
 
2265
        configured to check constraints on history, in which case this may not
 
2266
        be permitted.
 
2267
        """
2507
2268
        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)
 
2269
        # this old format stores the full history, but this api doesn't
 
2270
        # provide it, so we must generate, and might as well check it's
 
2271
        # correct
 
2272
        history = self._lefthand_history(revision_id)
 
2273
        if len(history) != revno:
 
2274
            raise AssertionError('%d != %d' % (len(history), revno))
 
2275
        self.set_revision_history(history)
 
2276
 
 
2277
    def _gen_revision_history(self):
 
2278
        history = self._transport.get_bytes('revision-history').split('\n')
 
2279
        if history[-1:] == ['']:
 
2280
            # There shouldn't be a trailing newline, but just in case.
 
2281
            history.pop()
 
2282
        return history
 
2283
 
 
2284
    @needs_write_lock
 
2285
    def generate_revision_history(self, revision_id, last_rev=None,
 
2286
        other_branch=None):
 
2287
        """Create a new revision history that will finish with revision_id.
 
2288
 
 
2289
        :param revision_id: the new tip to use.
 
2290
        :param last_rev: The previous last_revision. If not None, then this
 
2291
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2292
        :param other_branch: The other branch that DivergedBranches should
 
2293
            raise with respect to.
 
2294
        """
 
2295
        self.set_revision_history(self._lefthand_history(revision_id,
 
2296
            last_rev, other_branch))
2516
2297
 
2517
2298
    def basis_tree(self):
2518
2299
        """See Branch.basis_tree."""
2527
2308
                pass
2528
2309
        return None
2529
2310
 
 
2311
    def _basic_push(self, target, overwrite, stop_revision):
 
2312
        """Basic implementation of push without bound branches or hooks.
 
2313
 
 
2314
        Must be called with source read locked and target write locked.
 
2315
        """
 
2316
        result = BranchPushResult()
 
2317
        result.source_branch = self
 
2318
        result.target_branch = target
 
2319
        result.old_revno, result.old_revid = target.last_revision_info()
 
2320
        self.update_references(target)
 
2321
        if result.old_revid != self.last_revision():
 
2322
            # We assume that during 'push' this repository is closer than
 
2323
            # the target.
 
2324
            graph = self.repository.get_graph(target.repository)
 
2325
            target.update_revisions(self, stop_revision,
 
2326
                overwrite=overwrite, graph=graph)
 
2327
        if self._push_should_merge_tags():
 
2328
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2329
                overwrite)
 
2330
        result.new_revno, result.new_revid = target.last_revision_info()
 
2331
        return result
 
2332
 
2530
2333
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2334
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2335
 
2533
2336
    def set_push_location(self, location):
2534
2337
        """See Branch.set_push_location."""
2543
2346
            self._transport.put_bytes('parent', url + '\n',
2544
2347
                mode=self.bzrdir._get_file_mode())
2545
2348
 
 
2349
 
 
2350
class BzrBranch5(BzrBranch):
 
2351
    """A format 5 branch. This supports new features over plain branches.
 
2352
 
 
2353
    It has support for a master_branch which is the data for bound branches.
 
2354
    """
 
2355
 
 
2356
    def get_bound_location(self):
 
2357
        try:
 
2358
            return self._transport.get_bytes('bound')[:-1]
 
2359
        except errors.NoSuchFile:
 
2360
            return None
 
2361
 
 
2362
    @needs_read_lock
 
2363
    def get_master_branch(self, possible_transports=None):
 
2364
        """Return the branch we are bound to.
 
2365
 
 
2366
        :return: Either a Branch, or None
 
2367
 
 
2368
        This could memoise the branch, but if thats done
 
2369
        it must be revalidated on each new lock.
 
2370
        So for now we just don't memoise it.
 
2371
        # RBC 20060304 review this decision.
 
2372
        """
 
2373
        bound_loc = self.get_bound_location()
 
2374
        if not bound_loc:
 
2375
            return None
 
2376
        try:
 
2377
            return Branch.open(bound_loc,
 
2378
                               possible_transports=possible_transports)
 
2379
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2380
            raise errors.BoundBranchConnectionFailure(
 
2381
                    self, bound_loc, e)
 
2382
 
2546
2383
    @needs_write_lock
2547
 
    def unbind(self):
2548
 
        """If bound, unbind"""
2549
 
        return self.set_bound_location(None)
 
2384
    def set_bound_location(self, location):
 
2385
        """Set the target where this branch is bound to.
 
2386
 
 
2387
        :param location: URL to the target branch
 
2388
        """
 
2389
        if location:
 
2390
            self._transport.put_bytes('bound', location+'\n',
 
2391
                mode=self.bzrdir._get_file_mode())
 
2392
        else:
 
2393
            try:
 
2394
                self._transport.delete('bound')
 
2395
            except errors.NoSuchFile:
 
2396
                return False
 
2397
            return True
2550
2398
 
2551
2399
    @needs_write_lock
2552
2400
    def bind(self, other):
2574
2422
        # history around
2575
2423
        self.set_bound_location(other.base)
2576
2424
 
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
2425
    @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
 
2426
    def unbind(self):
 
2427
        """If bound, unbind"""
 
2428
        return self.set_bound_location(None)
2621
2429
 
2622
2430
    @needs_write_lock
2623
2431
    def update(self, possible_transports=None):
2636
2444
            return old_tip
2637
2445
        return None
2638
2446
 
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):
 
2447
 
 
2448
class BzrBranch8(BzrBranch5):
2768
2449
    """A branch that stores tree-reference locations."""
2769
2450
 
2770
2451
    def _open_hook(self):
2796
2477
        self._last_revision_info_cache = None
2797
2478
        self._reference_info = None
2798
2479
 
 
2480
    def _last_revision_info(self):
 
2481
        revision_string = self._transport.get_bytes('last-revision')
 
2482
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2483
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2484
        revno = int(revno)
 
2485
        return revno, revision_id
 
2486
 
 
2487
    def _write_last_revision_info(self, revno, revision_id):
 
2488
        """Simply write out the revision id, with no checks.
 
2489
 
 
2490
        Use set_last_revision_info to perform this safely.
 
2491
 
 
2492
        Does not update the revision_history cache.
 
2493
        Intended to be called by set_last_revision_info and
 
2494
        _write_revision_history.
 
2495
        """
 
2496
        revision_id = _mod_revision.ensure_null(revision_id)
 
2497
        out_string = '%d %s\n' % (revno, revision_id)
 
2498
        self._transport.put_bytes('last-revision', out_string,
 
2499
            mode=self.bzrdir._get_file_mode())
 
2500
 
 
2501
    @needs_write_lock
 
2502
    def set_last_revision_info(self, revno, revision_id):
 
2503
        revision_id = _mod_revision.ensure_null(revision_id)
 
2504
        old_revno, old_revid = self.last_revision_info()
 
2505
        if self._get_append_revisions_only():
 
2506
            self._check_history_violation(revision_id)
 
2507
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2508
        self._write_last_revision_info(revno, revision_id)
 
2509
        self._clear_cached_state()
 
2510
        self._last_revision_info_cache = revno, revision_id
 
2511
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2512
 
 
2513
    def _synchronize_history(self, destination, revision_id):
 
2514
        """Synchronize last revision and revision history between branches.
 
2515
 
 
2516
        :see: Branch._synchronize_history
 
2517
        """
 
2518
        # XXX: The base Branch has a fast implementation of this method based
 
2519
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2520
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2521
        # but wants the fast implementation, so it calls
 
2522
        # Branch._synchronize_history directly.
 
2523
        Branch._synchronize_history(self, destination, revision_id)
 
2524
 
2799
2525
    def _check_history_violation(self, revision_id):
2800
 
        current_revid = self.last_revision()
2801
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2526
        last_revision = _mod_revision.ensure_null(self.last_revision())
2802
2527
        if _mod_revision.is_null(last_revision):
2803
2528
            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)
 
2529
        if last_revision not in self._lefthand_history(revision_id):
 
2530
            raise errors.AppendRevisionsOnlyViolation(self.base)
2809
2531
 
2810
2532
    def _gen_revision_history(self):
2811
2533
        """Generate the revision history from last revision
2814
2536
        self._extend_partial_history(stop_index=last_revno-1)
2815
2537
        return list(reversed(self._partial_revision_history_cache))
2816
2538
 
 
2539
    def _write_revision_history(self, history):
 
2540
        """Factored out of set_revision_history.
 
2541
 
 
2542
        This performs the actual writing to disk, with format-specific checks.
 
2543
        It is intended to be called by BzrBranch5.set_revision_history.
 
2544
        """
 
2545
        if len(history) == 0:
 
2546
            last_revision = 'null:'
 
2547
        else:
 
2548
            if history != self._lefthand_history(history[-1]):
 
2549
                raise errors.NotLefthandHistory(history)
 
2550
            last_revision = history[-1]
 
2551
        if self._get_append_revisions_only():
 
2552
            self._check_history_violation(last_revision)
 
2553
        self._write_last_revision_info(len(history), last_revision)
 
2554
 
2817
2555
    @needs_write_lock
2818
2556
    def _set_parent_location(self, url):
2819
2557
        """Set the parent branch"""
2895
2633
        if branch_location is None:
2896
2634
            return Branch.reference_parent(self, file_id, path,
2897
2635
                                           possible_transports)
2898
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2636
        branch_location = urlutils.join(self.base, branch_location)
2899
2637
        return Branch.open(branch_location,
2900
2638
                           possible_transports=possible_transports)
2901
2639
 
2905
2643
 
2906
2644
    def set_bound_location(self, location):
2907
2645
        """See Branch.set_push_location."""
2908
 
        self._master_branch_cache = None
2909
2646
        result = None
2910
2647
        config = self.get_config()
2911
2648
        if location is None:
2942
2679
        # you can always ask for the URL; but you might not be able to use it
2943
2680
        # if the repo can't support stacking.
2944
2681
        ## 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)
 
2682
        stacked_url = self._get_config_location('stacked_on_location')
2950
2683
        if stacked_url is None:
2951
2684
            raise errors.NotStacked(self)
2952
2685
        return stacked_url
2953
2686
 
2954
2687
    def _get_append_revisions_only(self):
2955
 
        return self.get_config(
2956
 
            ).get_user_option_as_bool('append_revisions_only')
 
2688
        value = self.get_config().get_user_option('append_revisions_only')
 
2689
        return value == 'True'
 
2690
 
 
2691
    @needs_write_lock
 
2692
    def generate_revision_history(self, revision_id, last_rev=None,
 
2693
                                  other_branch=None):
 
2694
        """See BzrBranch5.generate_revision_history"""
 
2695
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2696
        revno = len(history)
 
2697
        self.set_last_revision_info(revno, revision_id)
2957
2698
 
2958
2699
    @needs_read_lock
2959
2700
    def get_rev_id(self, revno, history=None):
2984
2725
        try:
2985
2726
            index = self._partial_revision_history_cache.index(revision_id)
2986
2727
        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)
 
2728
            self._extend_partial_history(stop_revision=revision_id)
2991
2729
            index = len(self._partial_revision_history_cache) - 1
2992
2730
            if self._partial_revision_history_cache[index] != revision_id:
2993
2731
                raise errors.NoSuchRevision(self, revision_id)
3016
2754
    """
3017
2755
 
3018
2756
    def get_stacked_on_url(self):
3019
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2757
        raise errors.UnstackableBranchFormat(self._format, self.base)
3020
2758
 
3021
2759
 
3022
2760
######################################################################
3048
2786
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3049
2787
    """
3050
2788
 
3051
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3052
2789
    def __int__(self):
3053
 
        """Return the relative change in revno.
3054
 
 
3055
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3056
 
        """
 
2790
        # DEPRECATED: pull used to return the change in revno
3057
2791
        return self.new_revno - self.old_revno
3058
2792
 
3059
2793
    def report(self, to_file):
3084
2818
        target, otherwise it will be None.
3085
2819
    """
3086
2820
 
3087
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3088
2821
    def __int__(self):
3089
 
        """Return the relative change in revno.
3090
 
 
3091
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3092
 
        """
 
2822
        # DEPRECATED: push used to return the change in revno
3093
2823
        return self.new_revno - self.old_revno
3094
2824
 
3095
2825
    def report(self, to_file):
3109
2839
 
3110
2840
    def __init__(self, branch):
3111
2841
        self.branch = branch
3112
 
        self.errors = []
 
2842
        self.ghosts_in_mainline = False
3113
2843
 
3114
2844
    def report_results(self, verbose):
3115
2845
        """Report the check results via trace.note.
3117
2847
        :param verbose: Requests more detailed display of what was checked,
3118
2848
            if any.
3119
2849
        """
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)
 
2850
        note('checked branch %s format %s',
 
2851
             self.branch.base,
 
2852
             self.branch._format)
 
2853
        if self.ghosts_in_mainline:
 
2854
            note('branch contains ghosts in mainline')
3124
2855
 
3125
2856
 
3126
2857
class Converter5to6(object):
3174
2905
        branch._transport.put_bytes('format', format.get_format_string())
3175
2906
 
3176
2907
 
 
2908
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
2909
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
2910
    duration.
 
2911
 
 
2912
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
2913
 
 
2914
    If an exception is raised by callable, then that exception *will* be
 
2915
    propagated, even if the unlock attempt raises its own error.  Thus
 
2916
    _run_with_write_locked_target should be preferred to simply doing::
 
2917
 
 
2918
        target.lock_write()
 
2919
        try:
 
2920
            return callable(*args, **kwargs)
 
2921
        finally:
 
2922
            target.unlock()
 
2923
 
 
2924
    """
 
2925
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
2926
    # should share code?
 
2927
    target.lock_write()
 
2928
    try:
 
2929
        result = callable(*args, **kwargs)
 
2930
    except:
 
2931
        exc_info = sys.exc_info()
 
2932
        try:
 
2933
            target.unlock()
 
2934
        finally:
 
2935
            raise exc_info[0], exc_info[1], exc_info[2]
 
2936
    else:
 
2937
        target.unlock()
 
2938
        return result
 
2939
 
 
2940
 
3177
2941
class InterBranch(InterObject):
3178
2942
    """This class represents operations taking place between two branches.
3179
2943
 
3185
2949
    _optimisers = []
3186
2950
    """The available optimised InterBranch types."""
3187
2951
 
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)
 
2952
    @staticmethod
 
2953
    def _get_branch_formats_to_test():
 
2954
        """Return a tuple with the Branch formats to use when testing."""
 
2955
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3197
2956
 
3198
 
    @needs_write_lock
3199
2957
    def pull(self, overwrite=False, stop_revision=None,
3200
2958
             possible_transports=None, local=False):
3201
2959
        """Mirror source into target branch.
3206
2964
        """
3207
2965
        raise NotImplementedError(self.pull)
3208
2966
 
3209
 
    @needs_write_lock
3210
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
2967
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2968
                         graph=None):
 
2969
        """Pull in new perfect-fit revisions.
 
2970
 
 
2971
        :param stop_revision: Updated until the given revision
 
2972
        :param overwrite: Always set the branch pointer, rather than checking
 
2973
            to see if it is a proper descendant.
 
2974
        :param graph: A Graph object that can be used to query history
 
2975
            information. This can be None.
 
2976
        :return: None
 
2977
        """
 
2978
        raise NotImplementedError(self.update_revisions)
 
2979
 
 
2980
    def push(self, overwrite=False, stop_revision=None,
3211
2981
             _override_hook_source_branch=None):
3212
2982
        """Mirror the source branch into the target branch.
3213
2983
 
3215
2985
        """
3216
2986
        raise NotImplementedError(self.push)
3217
2987
 
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
2988
 
3237
2989
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, [])
 
2990
    """InterBranch implementation that uses public Branch functions.
 
2991
    """
 
2992
 
 
2993
    @staticmethod
 
2994
    def _get_branch_formats_to_test():
 
2995
        return BranchFormat._default_format, BranchFormat._default_format
 
2996
 
 
2997
    def update_revisions(self, stop_revision=None, overwrite=False,
 
2998
        graph=None):
 
2999
        """See InterBranch.update_revisions()."""
3279
3000
        self.source.lock_read()
3280
3001
        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)
 
3002
            other_revno, other_last_revision = self.source.last_revision_info()
 
3003
            stop_revno = None # unknown
 
3004
            if stop_revision is None:
 
3005
                stop_revision = other_last_revision
 
3006
                if _mod_revision.is_null(stop_revision):
 
3007
                    # if there are no commits, we're done.
 
3008
                    return
 
3009
                stop_revno = other_revno
 
3010
 
 
3011
            # what's the current last revision, before we fetch [and change it
 
3012
            # possibly]
 
3013
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3014
            # we fetch here so that we don't process data twice in the common
 
3015
            # case of having something to pull, and so that the check for
 
3016
            # already merged can operate on the just fetched graph, which will
 
3017
            # be cached in memory.
 
3018
            self.target.fetch(self.source, stop_revision)
 
3019
            # Check to see if one is an ancestor of the other
 
3020
            if not overwrite:
 
3021
                if graph is None:
 
3022
                    graph = self.target.repository.get_graph()
 
3023
                if self.target._check_if_descendant_or_diverged(
 
3024
                        stop_revision, last_rev, graph, self.source):
 
3025
                    # stop_revision is a descendant of last_rev, but we aren't
 
3026
                    # overwriting, so we're done.
 
3027
                    return
 
3028
            if stop_revno is None:
 
3029
                if graph is None:
 
3030
                    graph = self.target.repository.get_graph()
 
3031
                this_revno, this_last_revision = \
 
3032
                        self.target.last_revision_info()
 
3033
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3034
                                [(other_last_revision, other_revno),
 
3035
                                 (this_last_revision, this_revno)])
 
3036
            self.target.set_last_revision_info(stop_revno, stop_revision)
3291
3037
        finally:
3292
3038
            self.source.unlock()
3293
3039
 
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
3040
    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
3041
             possible_transports=None, _hook_master=None, run_hooks=True,
3452
 
             _override_hook_target=None, local=False,
3453
 
             merge_tags_to_master=True):
 
3042
             _override_hook_target=None, local=False):
3454
3043
        """See Branch.pull.
3455
3044
 
3456
 
        This function is the core worker, used by GenericInterBranch.pull to
3457
 
        avoid duplication when pulling source->master and source->local.
3458
 
 
3459
3045
        :param _hook_master: Private parameter - set the branch to
3460
3046
            be supplied as the master to pull hooks.
3461
3047
        :param run_hooks: Private parameter - if false, this branch
3462
3048
            is being called because it's the master of the primary branch,
3463
3049
            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
3050
        :param _override_hook_target: Private parameter - set the branch to be
3467
3051
            supplied as the target_branch to pull hooks.
3468
3052
        :param local: Only update the local branch, and not the bound branch.
3487
3071
            # -- JRV20090506
3488
3072
            result.old_revno, result.old_revid = \
3489
3073
                self.target.last_revision_info()
3490
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3491
 
                graph=graph)
 
3074
            self.target.update_revisions(self.source, stop_revision,
 
3075
                overwrite=overwrite, graph=graph)
3492
3076
            # TODO: The old revid should be specified when merging tags, 
3493
3077
            # so a tags implementation that versions tags can only 
3494
3078
            # pull in the most recent changes. -- JRV20090506
3495
3079
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3496
 
                overwrite, ignore_master=not merge_tags_to_master)
 
3080
                overwrite)
3497
3081
            result.new_revno, result.new_revid = self.target.last_revision_info()
3498
3082
            if _hook_master:
3499
3083
                result.master_branch = _hook_master
3508
3092
            self.source.unlock()
3509
3093
        return result
3510
3094
 
 
3095
    def push(self, overwrite=False, stop_revision=None,
 
3096
             _override_hook_source_branch=None):
 
3097
        """See InterBranch.push.
 
3098
 
 
3099
        This is the basic concrete implementation of push()
 
3100
 
 
3101
        :param _override_hook_source_branch: If specified, run
 
3102
        the hooks passing this Branch as the source, rather than self.
 
3103
        This is for use of RemoteBranch, where push is delegated to the
 
3104
        underlying vfs-based Branch.
 
3105
        """
 
3106
        # TODO: Public option to disable running hooks - should be trivial but
 
3107
        # needs tests.
 
3108
        self.source.lock_read()
 
3109
        try:
 
3110
            return _run_with_write_locked_target(
 
3111
                self.target, self._push_with_bound_branches, overwrite,
 
3112
                stop_revision,
 
3113
                _override_hook_source_branch=_override_hook_source_branch)
 
3114
        finally:
 
3115
            self.source.unlock()
 
3116
 
 
3117
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3118
            _override_hook_source_branch=None):
 
3119
        """Push from source into target, and into target's master if any.
 
3120
        """
 
3121
        def _run_hooks():
 
3122
            if _override_hook_source_branch:
 
3123
                result.source_branch = _override_hook_source_branch
 
3124
            for hook in Branch.hooks['post_push']:
 
3125
                hook(result)
 
3126
 
 
3127
        bound_location = self.target.get_bound_location()
 
3128
        if bound_location and self.target.base != bound_location:
 
3129
            # there is a master branch.
 
3130
            #
 
3131
            # XXX: Why the second check?  Is it even supported for a branch to
 
3132
            # be bound to itself? -- mbp 20070507
 
3133
            master_branch = self.target.get_master_branch()
 
3134
            master_branch.lock_write()
 
3135
            try:
 
3136
                # push into the master from the source branch.
 
3137
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3138
                # and push into the target branch from the source. Note that we
 
3139
                # push from the source branch again, because its considered the
 
3140
                # highest bandwidth repository.
 
3141
                result = self.source._basic_push(self.target, overwrite,
 
3142
                    stop_revision)
 
3143
                result.master_branch = master_branch
 
3144
                result.local_branch = self.target
 
3145
                _run_hooks()
 
3146
                return result
 
3147
            finally:
 
3148
                master_branch.unlock()
 
3149
        else:
 
3150
            # no master branch
 
3151
            result = self.source._basic_push(self.target, overwrite,
 
3152
                stop_revision)
 
3153
            # TODO: Why set master_branch and local_branch if there's no
 
3154
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3155
            # 20070504
 
3156
            result.master_branch = self.target
 
3157
            result.local_branch = None
 
3158
            _run_hooks()
 
3159
            return result
 
3160
 
 
3161
    @classmethod
 
3162
    def is_compatible(self, source, target):
 
3163
        # GenericBranch uses the public API, so always compatible
 
3164
        return True
 
3165
 
 
3166
 
 
3167
class InterToBranch5(GenericInterBranch):
 
3168
 
 
3169
    @staticmethod
 
3170
    def _get_branch_formats_to_test():
 
3171
        return BranchFormat._default_format, BzrBranchFormat5()
 
3172
 
 
3173
    def pull(self, overwrite=False, stop_revision=None,
 
3174
             possible_transports=None, run_hooks=True,
 
3175
             _override_hook_target=None, local=False):
 
3176
        """Pull from source into self, updating my master if any.
 
3177
 
 
3178
        :param run_hooks: Private parameter - if false, this branch
 
3179
            is being called because it's the master of the primary branch,
 
3180
            so it should not run its hooks.
 
3181
        """
 
3182
        bound_location = self.target.get_bound_location()
 
3183
        if local and not bound_location:
 
3184
            raise errors.LocalRequiresBoundBranch()
 
3185
        master_branch = None
 
3186
        if not local and bound_location and self.source.base != bound_location:
 
3187
            # not pulling from master, so we need to update master.
 
3188
            master_branch = self.target.get_master_branch(possible_transports)
 
3189
            master_branch.lock_write()
 
3190
        try:
 
3191
            if master_branch:
 
3192
                # pull from source into master.
 
3193
                master_branch.pull(self.source, overwrite, stop_revision,
 
3194
                    run_hooks=False)
 
3195
            return super(InterToBranch5, self).pull(overwrite,
 
3196
                stop_revision, _hook_master=master_branch,
 
3197
                run_hooks=run_hooks,
 
3198
                _override_hook_target=_override_hook_target)
 
3199
        finally:
 
3200
            if master_branch:
 
3201
                master_branch.unlock()
 
3202
 
3511
3203
 
3512
3204
InterBranch.register_optimiser(GenericInterBranch)
 
3205
InterBranch.register_optimiser(InterToBranch5)