~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Benoît Pierre
  • Date: 2009-11-02 22:24:29 UTC
  • mto: (4634.96.1 integration-2.0)
  • mto: This revision was merged to the branch mainline in revision 4798.
  • Revision ID: benoit.pierre@gmail.com-20091102222429-xqdyo6n8odh3xbbd
Small fix for handling of short option names in shellcomplete_on_options.

Show diffs side-by-side

added added

removed removed

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