~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-04-02 00:59:52 UTC
  • mfrom: (5622.4.4 uninstall-hook)
  • Revision ID: pqm@pqm.ubuntu.com-20110402005952-kxcwbwdk6jagtfwm
(jelmer) Add Hooks.uninstall_named_hook(). (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
27
27
        config as _mod_config,
28
28
        debug,
29
29
        errors,
 
30
        fetch,
 
31
        graph as _mod_graph,
30
32
        lockdir,
31
33
        lockable_files,
 
34
        remote,
32
35
        repository,
33
36
        revision as _mod_revision,
34
37
        rio,
46
49
    )
47
50
""")
48
51
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
52
from bzrlib import (
 
53
    controldir,
 
54
    )
 
55
from bzrlib.decorators import (
 
56
    needs_read_lock,
 
57
    needs_write_lock,
 
58
    only_raises,
 
59
    )
 
60
from bzrlib.hooks import Hooks
51
61
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
62
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
63
from bzrlib import registry
54
64
from bzrlib.symbol_versioning import (
55
65
    deprecated_in,
63
73
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
74
 
65
75
 
66
 
# TODO: Maybe include checks for common corruption of newlines, etc?
67
 
 
68
 
# TODO: Some operations like log might retrieve the same revisions
69
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
70
 
# cache in memory to make this faster.  In general anything can be
71
 
# cached in memory between lock and unlock operations. .. nb thats
72
 
# what the transaction identity map provides
73
 
 
74
 
 
75
 
######################################################################
76
 
# branch objects
77
 
 
78
 
class Branch(object):
 
76
class Branch(controldir.ControlComponent):
79
77
    """Branch holding a history of revisions.
80
78
 
81
 
    base
82
 
        Base directory/url of the branch.
83
 
 
84
 
    hooks: An instance of BranchHooks.
 
79
    :ivar base:
 
80
        Base directory/url of the branch; using control_url and
 
81
        control_transport is more standardized.
 
82
    :ivar hooks: An instance of BranchHooks.
 
83
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
84
        _clear_cached_state.
85
85
    """
86
86
    # this is really an instance variable - FIXME move it there
87
87
    # - RBC 20060112
88
88
    base = None
89
89
 
 
90
    @property
 
91
    def control_transport(self):
 
92
        return self._transport
 
93
 
 
94
    @property
 
95
    def user_transport(self):
 
96
        return self.bzrdir.user_transport
 
97
 
90
98
    def __init__(self, *ignored, **ignored_too):
91
99
        self.tags = self._format.make_tags(self)
92
100
        self._revision_history_cache = None
93
101
        self._revision_id_to_revno_cache = None
94
102
        self._partial_revision_id_to_revno_cache = {}
95
103
        self._partial_revision_history_cache = []
 
104
        self._tags_bytes = None
96
105
        self._last_revision_info_cache = None
 
106
        self._master_branch_cache = None
97
107
        self._merge_sorted_revisions_cache = None
98
108
        self._open_hook()
99
109
        hooks = Branch.hooks['open']
105
115
 
106
116
    def _activate_fallback_location(self, url):
107
117
        """Activate the branch/repository from url as a fallback repository."""
 
118
        for existing_fallback_repo in self.repository._fallback_repositories:
 
119
            if existing_fallback_repo.user_url == url:
 
120
                # This fallback is already configured.  This probably only
 
121
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
122
                # confusing _unstack we don't add this a second time.
 
123
                mutter('duplicate activation of fallback %r on %r', url, self)
 
124
                return
108
125
        repo = self._get_fallback_repository(url)
109
126
        if repo.has_same_location(self.repository):
110
 
            raise errors.UnstackableLocationError(self.base, url)
 
127
            raise errors.UnstackableLocationError(self.user_url, url)
111
128
        self.repository.add_fallback_repository(repo)
112
129
 
113
130
    def break_lock(self):
167
184
        """
168
185
        control = bzrdir.BzrDir.open(base, _unsupported,
169
186
                                     possible_transports=possible_transports)
170
 
        return control.open_branch(_unsupported)
 
187
        return control.open_branch(unsupported=_unsupported)
171
188
 
172
189
    @staticmethod
173
 
    def open_from_transport(transport, _unsupported=False):
 
190
    def open_from_transport(transport, name=None, _unsupported=False):
174
191
        """Open the branch rooted at transport"""
175
192
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
 
        return control.open_branch(_unsupported)
 
193
        return control.open_branch(name=name, unsupported=_unsupported)
177
194
 
178
195
    @staticmethod
179
196
    def open_containing(url, possible_transports=None):
200
217
        return self.supports_tags() and self.tags.get_tag_dict()
201
218
 
202
219
    def get_config(self):
 
220
        """Get a bzrlib.config.BranchConfig for this Branch.
 
221
 
 
222
        This can then be used to get and set configuration options for the
 
223
        branch.
 
224
 
 
225
        :return: A bzrlib.config.BranchConfig.
 
226
        """
203
227
        return BranchConfig(self)
204
228
 
205
229
    def _get_config(self):
217
241
    def _get_fallback_repository(self, url):
218
242
        """Get the repository we fallback to at url."""
219
243
        url = urlutils.join(self.base, url)
220
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
244
        a_branch = Branch.open(url,
221
245
            possible_transports=[self.bzrdir.root_transport])
222
 
        return a_bzrdir.open_branch().repository
 
246
        return a_branch.repository
223
247
 
 
248
    @needs_read_lock
224
249
    def _get_tags_bytes(self):
225
250
        """Get the bytes of a serialised tags dict.
226
251
 
233
258
        :return: The bytes of the tags file.
234
259
        :seealso: Branch._set_tags_bytes.
235
260
        """
236
 
        return self._transport.get_bytes('tags')
 
261
        if self._tags_bytes is None:
 
262
            self._tags_bytes = self._transport.get_bytes('tags')
 
263
        return self._tags_bytes
237
264
 
238
265
    def _get_nick(self, local=False, possible_transports=None):
239
266
        config = self.get_config()
241
268
        if not local and not config.has_explicit_nickname():
242
269
            try:
243
270
                master = self.get_master_branch(possible_transports)
 
271
                if master and self.user_url == master.user_url:
 
272
                    raise errors.RecursiveBind(self.user_url)
244
273
                if master is not None:
245
274
                    # return the master branch value
246
275
                    return master.nick
 
276
            except errors.RecursiveBind, e:
 
277
                raise e
247
278
            except errors.BzrError, e:
248
279
                # Silently fall back to local implicit nick if the master is
249
280
                # unavailable
286
317
        new_history.reverse()
287
318
        return new_history
288
319
 
289
 
    def lock_write(self):
 
320
    def lock_write(self, token=None):
 
321
        """Lock the branch for write operations.
 
322
 
 
323
        :param token: A token to permit reacquiring a previously held and
 
324
            preserved lock.
 
325
        :return: A BranchWriteLockResult.
 
326
        """
290
327
        raise NotImplementedError(self.lock_write)
291
328
 
292
329
    def lock_read(self):
 
330
        """Lock the branch for read operations.
 
331
 
 
332
        :return: A bzrlib.lock.LogicalLockResult.
 
333
        """
293
334
        raise NotImplementedError(self.lock_read)
294
335
 
295
336
    def unlock(self):
420
461
            * 'include' - the stop revision is the last item in the result
421
462
            * 'with-merges' - include the stop revision and all of its
422
463
              merged revisions in the result
 
464
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
465
              that are in both ancestries
423
466
        :param direction: either 'reverse' or 'forward':
424
467
            * reverse means return the start_revision_id first, i.e.
425
468
              start at the most recent revision and go backwards in history
447
490
        # start_revision_id.
448
491
        if self._merge_sorted_revisions_cache is None:
449
492
            last_revision = self.last_revision()
450
 
            last_key = (last_revision,)
451
 
            known_graph = self.repository.revisions.get_known_graph_ancestry(
452
 
                [last_key])
 
493
            known_graph = self.repository.get_known_graph_ancestry(
 
494
                [last_revision])
453
495
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
 
                last_key)
 
496
                last_revision)
455
497
        filtered = self._filter_merge_sorted_revisions(
456
498
            self._merge_sorted_revisions_cache, start_revision_id,
457
499
            stop_revision_id, stop_rule)
 
500
        # Make sure we don't return revisions that are not part of the
 
501
        # start_revision_id ancestry.
 
502
        filtered = self._filter_start_non_ancestors(filtered)
458
503
        if direction == 'reverse':
459
504
            return filtered
460
505
        if direction == 'forward':
497
542
                       node.end_of_merge)
498
543
                if rev_id == stop_revision_id:
499
544
                    return
 
545
        elif stop_rule == 'with-merges-without-common-ancestry':
 
546
            # We want to exclude all revisions that are already part of the
 
547
            # stop_revision_id ancestry.
 
548
            graph = self.repository.get_graph()
 
549
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
550
                                                    [stop_revision_id])
 
551
            for node in rev_iter:
 
552
                rev_id = node.key[-1]
 
553
                if rev_id not in ancestors:
 
554
                    continue
 
555
                yield (rev_id, node.merge_depth, node.revno,
 
556
                       node.end_of_merge)
500
557
        elif stop_rule == 'with-merges':
501
558
            stop_rev = self.repository.get_revision(stop_revision_id)
502
559
            if stop_rev.parent_ids:
525
582
        else:
526
583
            raise ValueError('invalid stop_rule %r' % stop_rule)
527
584
 
 
585
    def _filter_start_non_ancestors(self, rev_iter):
 
586
        # If we started from a dotted revno, we want to consider it as a tip
 
587
        # and don't want to yield revisions that are not part of its
 
588
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
589
        # uninteresting descendants of the first parent of our tip before the
 
590
        # tip itself.
 
591
        first = rev_iter.next()
 
592
        (rev_id, merge_depth, revno, end_of_merge) = first
 
593
        yield first
 
594
        if not merge_depth:
 
595
            # We start at a mainline revision so by definition, all others
 
596
            # revisions in rev_iter are ancestors
 
597
            for node in rev_iter:
 
598
                yield node
 
599
 
 
600
        clean = False
 
601
        whitelist = set()
 
602
        pmap = self.repository.get_parent_map([rev_id])
 
603
        parents = pmap.get(rev_id, [])
 
604
        if parents:
 
605
            whitelist.update(parents)
 
606
        else:
 
607
            # If there is no parents, there is nothing of interest left
 
608
 
 
609
            # FIXME: It's hard to test this scenario here as this code is never
 
610
            # called in that case. -- vila 20100322
 
611
            return
 
612
 
 
613
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
614
            if not clean:
 
615
                if rev_id in whitelist:
 
616
                    pmap = self.repository.get_parent_map([rev_id])
 
617
                    parents = pmap.get(rev_id, [])
 
618
                    whitelist.remove(rev_id)
 
619
                    whitelist.update(parents)
 
620
                    if merge_depth == 0:
 
621
                        # We've reached the mainline, there is nothing left to
 
622
                        # filter
 
623
                        clean = True
 
624
                else:
 
625
                    # A revision that is not part of the ancestry of our
 
626
                    # starting revision.
 
627
                    continue
 
628
            yield (rev_id, merge_depth, revno, end_of_merge)
 
629
 
528
630
    def leave_lock_in_place(self):
529
631
        """Tell this branch object not to release the physical lock when this
530
632
        object is unlocked.
547
649
        :param other: The branch to bind to
548
650
        :type other: Branch
549
651
        """
550
 
        raise errors.UpgradeRequired(self.base)
 
652
        raise errors.UpgradeRequired(self.user_url)
551
653
 
552
654
    def set_append_revisions_only(self, enabled):
553
655
        if not self._format.supports_set_append_revisions_only():
554
 
            raise errors.UpgradeRequired(self.base)
 
656
            raise errors.UpgradeRequired(self.user_url)
555
657
        if enabled:
556
658
            value = 'True'
557
659
        else:
568
670
        raise errors.UnsupportedOperation(self.get_reference_info, self)
569
671
 
570
672
    @needs_write_lock
571
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
673
    def fetch(self, from_branch, last_revision=None, fetch_spec=None):
572
674
        """Copy revisions from from_branch into this branch.
573
675
 
574
676
        :param from_branch: Where to copy from.
575
677
        :param last_revision: What revision to stop at (None for at the end
576
678
                              of the branch.
577
 
        :param pb: An optional progress bar to use.
 
679
        :param fetch_spec: If specified, a SearchResult or
 
680
            PendingAncestryResult that describes which revisions to copy.  This
 
681
            allows copying multiple heads at once.  Mutually exclusive with
 
682
            last_revision.
578
683
        :return: None
579
684
        """
580
 
        if self.base == from_branch.base:
581
 
            return (0, [])
582
 
        if pb is not None:
583
 
            symbol_versioning.warn(
584
 
                symbol_versioning.deprecated_in((1, 14, 0))
585
 
                % "pb parameter to fetch()")
586
 
        from_branch.lock_read()
587
 
        try:
588
 
            if last_revision is None:
589
 
                last_revision = from_branch.last_revision()
590
 
                last_revision = _mod_revision.ensure_null(last_revision)
591
 
            return self.repository.fetch(from_branch.repository,
592
 
                                         revision_id=last_revision,
593
 
                                         pb=pb)
594
 
        finally:
595
 
            from_branch.unlock()
 
685
        return InterBranch.get(from_branch, self).fetch(last_revision,
 
686
            fetch_spec)
596
687
 
597
688
    def get_bound_location(self):
598
689
        """Return the URL of the branch we are bound to.
605
696
    def get_old_bound_location(self):
606
697
        """Return the URL of the branch we used to be bound to
607
698
        """
608
 
        raise errors.UpgradeRequired(self.base)
 
699
        raise errors.UpgradeRequired(self.user_url)
609
700
 
610
701
    def get_commit_builder(self, parents, config=None, timestamp=None,
611
702
                           timezone=None, committer=None, revprops=None,
689
780
            stacking.
690
781
        """
691
782
        if not self._format.supports_stacking():
692
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
783
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
693
784
        # XXX: Changing from one fallback repository to another does not check
694
785
        # that all the data you need is present in the new fallback.
695
786
        # Possibly it should.
709
800
 
710
801
    def _unstack(self):
711
802
        """Change a branch to be unstacked, copying data as needed.
712
 
        
 
803
 
713
804
        Don't call this directly, use set_stacked_on_url(None).
714
805
        """
715
806
        pb = ui.ui_factory.nested_progress_bar()
724
815
            old_repository = self.repository
725
816
            if len(old_repository._fallback_repositories) != 1:
726
817
                raise AssertionError("can't cope with fallback repositories "
727
 
                    "of %r" % (self.repository,))
728
 
            # unlock it, including unlocking the fallback
 
818
                    "of %r (fallbacks: %r)" % (old_repository,
 
819
                        old_repository._fallback_repositories))
 
820
            # Open the new repository object.
 
821
            # Repositories don't offer an interface to remove fallback
 
822
            # repositories today; take the conceptually simpler option and just
 
823
            # reopen it.  We reopen it starting from the URL so that we
 
824
            # get a separate connection for RemoteRepositories and can
 
825
            # stream from one of them to the other.  This does mean doing
 
826
            # separate SSH connection setup, but unstacking is not a
 
827
            # common operation so it's tolerable.
 
828
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
829
            new_repository = new_bzrdir.find_repository()
 
830
            if new_repository._fallback_repositories:
 
831
                raise AssertionError("didn't expect %r to have "
 
832
                    "fallback_repositories"
 
833
                    % (self.repository,))
 
834
            # Replace self.repository with the new repository.
 
835
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
836
            # lock count) of self.repository to the new repository.
 
837
            lock_token = old_repository.lock_write().repository_token
 
838
            self.repository = new_repository
 
839
            if isinstance(self, remote.RemoteBranch):
 
840
                # Remote branches can have a second reference to the old
 
841
                # repository that need to be replaced.
 
842
                if self._real_branch is not None:
 
843
                    self._real_branch.repository = new_repository
 
844
            self.repository.lock_write(token=lock_token)
 
845
            if lock_token is not None:
 
846
                old_repository.leave_lock_in_place()
729
847
            old_repository.unlock()
 
848
            if lock_token is not None:
 
849
                # XXX: self.repository.leave_lock_in_place() before this
 
850
                # function will not be preserved.  Fortunately that doesn't
 
851
                # affect the current default format (2a), and would be a
 
852
                # corner-case anyway.
 
853
                #  - Andrew Bennetts, 2010/06/30
 
854
                self.repository.dont_leave_lock_in_place()
 
855
            old_lock_count = 0
 
856
            while True:
 
857
                try:
 
858
                    old_repository.unlock()
 
859
                except errors.LockNotHeld:
 
860
                    break
 
861
                old_lock_count += 1
 
862
            if old_lock_count == 0:
 
863
                raise AssertionError(
 
864
                    'old_repository should have been locked at least once.')
 
865
            for i in range(old_lock_count-1):
 
866
                self.repository.lock_write()
 
867
            # Fetch from the old repository into the new.
730
868
            old_repository.lock_read()
731
869
            try:
732
 
                # Repositories don't offer an interface to remove fallback
733
 
                # repositories today; take the conceptually simpler option and just
734
 
                # reopen it.  We reopen it starting from the URL so that we
735
 
                # get a separate connection for RemoteRepositories and can
736
 
                # stream from one of them to the other.  This does mean doing
737
 
                # separate SSH connection setup, but unstacking is not a
738
 
                # common operation so it's tolerable.
739
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
 
                new_repository = new_bzrdir.find_repository()
741
 
                self.repository = new_repository
742
 
                if self.repository._fallback_repositories:
743
 
                    raise AssertionError("didn't expect %r to have "
744
 
                        "fallback_repositories"
745
 
                        % (self.repository,))
746
 
                # this is not paired with an unlock because it's just restoring
747
 
                # the previous state; the lock's released when set_stacked_on_url
748
 
                # returns
749
 
                self.repository.lock_write()
750
870
                # XXX: If you unstack a branch while it has a working tree
751
871
                # with a pending merge, the pending-merged revisions will no
752
872
                # longer be present.  You can (probably) revert and remerge.
753
 
                #
754
 
                # XXX: This only fetches up to the tip of the repository; it
755
 
                # doesn't bring across any tags.  That's fairly consistent
756
 
                # with how branch works, but perhaps not ideal.
757
 
                self.repository.fetch(old_repository,
758
 
                    revision_id=self.last_revision(),
759
 
                    find_ghosts=True)
 
873
                try:
 
874
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
875
                except errors.TagsNotSupported:
 
876
                    tags_to_fetch = set()
 
877
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
878
                    old_repository, required_ids=[self.last_revision()],
 
879
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
880
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
760
881
            finally:
761
882
                old_repository.unlock()
762
883
        finally:
767
888
 
768
889
        :seealso: Branch._get_tags_bytes.
769
890
        """
770
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
771
 
            'tags', bytes)
 
891
        return _run_with_write_locked_target(self, self._set_tags_bytes_locked,
 
892
                bytes)
 
893
 
 
894
    def _set_tags_bytes_locked(self, bytes):
 
895
        self._tags_bytes = bytes
 
896
        return self._transport.put_bytes('tags', bytes)
772
897
 
773
898
    def _cache_revision_history(self, rev_history):
774
899
        """Set the cached revision history to rev_history.
801
926
        self._revision_history_cache = None
802
927
        self._revision_id_to_revno_cache = None
803
928
        self._last_revision_info_cache = None
 
929
        self._master_branch_cache = None
804
930
        self._merge_sorted_revisions_cache = None
805
931
        self._partial_revision_history_cache = []
806
932
        self._partial_revision_id_to_revno_cache = {}
 
933
        self._tags_bytes = None
807
934
 
808
935
    def _gen_revision_history(self):
809
936
        """Return sequence of revision hashes on to this branch.
846
973
 
847
974
    def unbind(self):
848
975
        """Older format branches cannot bind or unbind."""
849
 
        raise errors.UpgradeRequired(self.base)
 
976
        raise errors.UpgradeRequired(self.user_url)
850
977
 
851
978
    def last_revision(self):
852
979
        """Return last revision id, or NULL_REVISION."""
870
997
        else:
871
998
            return (0, _mod_revision.NULL_REVISION)
872
999
 
873
 
    @deprecated_method(deprecated_in((1, 6, 0)))
874
 
    def missing_revisions(self, other, stop_revision=None):
875
 
        """Return a list of new revisions that would perfectly fit.
876
 
 
877
 
        If self and other have not diverged, return a list of the revisions
878
 
        present in other, but missing from self.
879
 
        """
880
 
        self_history = self.revision_history()
881
 
        self_len = len(self_history)
882
 
        other_history = other.revision_history()
883
 
        other_len = len(other_history)
884
 
        common_index = min(self_len, other_len) -1
885
 
        if common_index >= 0 and \
886
 
            self_history[common_index] != other_history[common_index]:
887
 
            raise errors.DivergedBranches(self, other)
888
 
 
889
 
        if stop_revision is None:
890
 
            stop_revision = other_len
891
 
        else:
892
 
            if stop_revision > other_len:
893
 
                raise errors.NoSuchRevision(self, stop_revision)
894
 
        return other_history[self_len:stop_revision]
895
 
 
896
 
    @needs_write_lock
897
1000
    def update_revisions(self, other, stop_revision=None, overwrite=False,
898
 
                         graph=None):
 
1001
                         graph=None, fetch_tags=True):
899
1002
        """Pull in new perfect-fit revisions.
900
1003
 
901
1004
        :param other: Another Branch to pull from
904
1007
            to see if it is a proper descendant.
905
1008
        :param graph: A Graph object that can be used to query history
906
1009
            information. This can be None.
 
1010
        :param fetch_tags: Flag that specifies if tags from other should be
 
1011
            fetched too.
907
1012
        :return: None
908
1013
        """
909
1014
        return InterBranch.get(other, self).update_revisions(stop_revision,
910
 
            overwrite, graph)
 
1015
            overwrite, graph, fetch_tags=fetch_tags)
911
1016
 
 
1017
    @deprecated_method(deprecated_in((2, 4, 0)))
912
1018
    def import_last_revision_info(self, source_repo, revno, revid):
913
1019
        """Set the last revision info, importing from another repo if necessary.
914
1020
 
915
 
        This is used by the bound branch code to upload a revision to
916
 
        the master branch first before updating the tip of the local branch.
917
 
 
918
1021
        :param source_repo: Source repository to optionally fetch from
919
1022
        :param revno: Revision number of the new tip
920
1023
        :param revid: Revision id of the new tip
923
1026
            self.repository.fetch(source_repo, revision_id=revid)
924
1027
        self.set_last_revision_info(revno, revid)
925
1028
 
 
1029
    def import_last_revision_info_and_tags(self, source, revno, revid):
 
1030
        """Set the last revision info, importing from another repo if necessary.
 
1031
 
 
1032
        This is used by the bound branch code to upload a revision to
 
1033
        the master branch first before updating the tip of the local branch.
 
1034
        Revisions referenced by source's tags are also transferred.
 
1035
 
 
1036
        :param source: Source branch to optionally fetch from
 
1037
        :param revno: Revision number of the new tip
 
1038
        :param revid: Revision id of the new tip
 
1039
        """
 
1040
        if not self.repository.has_same_location(source.repository):
 
1041
            try:
 
1042
                tags_to_fetch = set(source.tags.get_reverse_tag_dict())
 
1043
            except errors.TagsNotSupported:
 
1044
                tags_to_fetch = set()
 
1045
            fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
1046
                source.repository, [revid],
 
1047
                if_present_ids=tags_to_fetch).execute()
 
1048
            self.repository.fetch(source.repository, fetch_spec=fetch_spec)
 
1049
        self.set_last_revision_info(revno, revid)
 
1050
 
926
1051
    def revision_id_to_revno(self, revision_id):
927
1052
        """Given a revision id, return its revno"""
928
1053
        if _mod_revision.is_null(revision_id):
948
1073
            self._extend_partial_history(distance_from_last)
949
1074
        return self._partial_revision_history_cache[distance_from_last]
950
1075
 
951
 
    @needs_write_lock
952
1076
    def pull(self, source, overwrite=False, stop_revision=None,
953
1077
             possible_transports=None, *args, **kwargs):
954
1078
        """Mirror source into this branch.
1012
1136
        try:
1013
1137
            return urlutils.join(self.base[:-1], parent)
1014
1138
        except errors.InvalidURLJoin, e:
1015
 
            raise errors.InaccessibleParent(parent, self.base)
 
1139
            raise errors.InaccessibleParent(parent, self.user_url)
1016
1140
 
1017
1141
    def _get_parent_location(self):
1018
1142
        raise NotImplementedError(self._get_parent_location)
1150
1274
        return result
1151
1275
 
1152
1276
    @needs_read_lock
1153
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1277
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1278
            repository=None):
1154
1279
        """Create a new line of development from the branch, into to_bzrdir.
1155
1280
 
1156
1281
        to_bzrdir controls the branch format.
1161
1286
        if (repository_policy is not None and
1162
1287
            repository_policy.requires_stacking()):
1163
1288
            to_bzrdir._format.require_stacking(_skip_repo=True)
1164
 
        result = to_bzrdir.create_branch()
 
1289
        result = to_bzrdir.create_branch(repository=repository)
1165
1290
        result.lock_write()
1166
1291
        try:
1167
1292
            if repository_policy is not None:
1197
1322
                revno = 1
1198
1323
        destination.set_last_revision_info(revno, revision_id)
1199
1324
 
1200
 
    @needs_read_lock
1201
1325
    def copy_content_into(self, destination, revision_id=None):
1202
1326
        """Copy the content of self into destination.
1203
1327
 
1204
1328
        revision_id: if not None, the revision history in the new branch will
1205
1329
                     be truncated to end with revision_id.
1206
1330
        """
1207
 
        self.update_references(destination)
1208
 
        self._synchronize_history(destination, revision_id)
1209
 
        try:
1210
 
            parent = self.get_parent()
1211
 
        except errors.InaccessibleParent, e:
1212
 
            mutter('parent was not accessible to copy: %s', e)
1213
 
        else:
1214
 
            if parent:
1215
 
                destination.set_parent(parent)
1216
 
        if self._push_should_merge_tags():
1217
 
            self.tags.merge_to(destination.tags)
 
1331
        return InterBranch.get(self, destination).copy_content_into(
 
1332
            revision_id=revision_id)
1218
1333
 
1219
1334
    def update_references(self, target):
1220
1335
        if not getattr(self._format, 'supports_reference_locations', False):
1265
1380
        """Return the most suitable metadir for a checkout of this branch.
1266
1381
        Weaves are used if this branch's repository uses weaves.
1267
1382
        """
1268
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1269
 
            from bzrlib.repofmt import weaverepo
1270
 
            format = bzrdir.BzrDirMetaFormat1()
1271
 
            format.repository_format = weaverepo.RepositoryFormat7()
1272
 
        else:
1273
 
            format = self.repository.bzrdir.checkout_metadir()
1274
 
            format.set_branch_format(self._format)
 
1383
        format = self.repository.bzrdir.checkout_metadir()
 
1384
        format.set_branch_format(self._format)
1275
1385
        return format
1276
1386
 
1277
1387
    def create_clone_on_transport(self, to_transport, revision_id=None,
1278
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1388
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1389
        no_tree=None):
1279
1390
        """Create a clone of this branch and its bzrdir.
1280
1391
 
1281
1392
        :param to_transport: The transport to clone onto.
1288
1399
        """
1289
1400
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1290
1401
        # clone call. Or something. 20090224 RBC/spiv.
 
1402
        # XXX: Should this perhaps clone colocated branches as well, 
 
1403
        # rather than just the default branch? 20100319 JRV
1291
1404
        if revision_id is None:
1292
1405
            revision_id = self.last_revision()
1293
1406
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
1407
            revision_id=revision_id, stacked_on=stacked_on,
1295
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1408
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1409
            no_tree=no_tree)
1296
1410
        return dir_to.open_branch()
1297
1411
 
1298
1412
    def create_checkout(self, to_location, revision_id=None,
1317
1431
        if lightweight:
1318
1432
            format = self._get_checkout_format()
1319
1433
            checkout = format.initialize_on_transport(t)
1320
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1434
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1435
                target_branch=self)
1321
1436
        else:
1322
1437
            format = self._get_checkout_format()
1323
1438
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1365
1480
    def supports_tags(self):
1366
1481
        return self._format.supports_tags()
1367
1482
 
 
1483
    def automatic_tag_name(self, revision_id):
 
1484
        """Try to automatically find the tag name for a revision.
 
1485
 
 
1486
        :param revision_id: Revision id of the revision.
 
1487
        :return: A tag name or None if no tag name could be determined.
 
1488
        """
 
1489
        for hook in Branch.hooks['automatic_tag_name']:
 
1490
            ret = hook(self, revision_id)
 
1491
            if ret is not None:
 
1492
                return ret
 
1493
        return None
 
1494
 
1368
1495
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1369
1496
                                         other_branch):
1370
1497
        """Ensure that revision_b is a descendant of revision_a.
1400
1527
        else:
1401
1528
            raise AssertionError("invalid heads: %r" % (heads,))
1402
1529
 
1403
 
 
1404
 
class BranchFormat(object):
 
1530
    def heads_to_fetch(self):
 
1531
        """Return the heads that must and that should be fetched to copy this
 
1532
        branch into another repo.
 
1533
 
 
1534
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1535
            set of heads that must be fetched.  if_present_fetch is a set of
 
1536
            heads that must be fetched if present, but no error is necessary if
 
1537
            they are not present.
 
1538
        """
 
1539
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1540
        # are the tags.
 
1541
        must_fetch = set([self.last_revision()])
 
1542
        try:
 
1543
            if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1544
        except errors.TagsNotSupported:
 
1545
            if_present_fetch = set()
 
1546
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1547
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1548
        return must_fetch, if_present_fetch
 
1549
 
 
1550
 
 
1551
class BranchFormat(controldir.ControlComponentFormat):
1405
1552
    """An encapsulation of the initialization and open routines for a format.
1406
1553
 
1407
1554
    Formats provide three things:
1410
1557
     * an open routine.
1411
1558
 
1412
1559
    Formats are placed in an dict by their format string for reference
1413
 
    during branch opening. Its not required that these be instances, they
 
1560
    during branch opening. It's not required that these be instances, they
1414
1561
    can be classes themselves with class methods - it simply depends on
1415
1562
    whether state is needed for a given format or not.
1416
1563
 
1419
1566
    object will be created every time regardless.
1420
1567
    """
1421
1568
 
1422
 
    _default_format = None
1423
 
    """The default format used for new branches."""
1424
 
 
1425
 
    _formats = {}
1426
 
    """The known formats."""
1427
 
 
1428
1569
    can_set_append_revisions_only = True
1429
1570
 
1430
1571
    def __eq__(self, other):
1434
1575
        return not (self == other)
1435
1576
 
1436
1577
    @classmethod
1437
 
    def find_format(klass, a_bzrdir):
 
1578
    def find_format(klass, a_bzrdir, name=None):
1438
1579
        """Return the format for the branch object in a_bzrdir."""
1439
1580
        try:
1440
 
            transport = a_bzrdir.get_branch_transport(None)
 
1581
            transport = a_bzrdir.get_branch_transport(None, name=name)
1441
1582
            format_string = transport.get_bytes("format")
1442
 
            return klass._formats[format_string]
 
1583
            return format_registry.get(format_string)
1443
1584
        except errors.NoSuchFile:
1444
1585
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1445
1586
        except KeyError:
1446
1587
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1447
1588
 
1448
1589
    @classmethod
 
1590
    @deprecated_method(deprecated_in((2, 4, 0)))
1449
1591
    def get_default_format(klass):
1450
1592
        """Return the current default format."""
1451
 
        return klass._default_format
1452
 
 
1453
 
    def get_reference(self, a_bzrdir):
 
1593
        return format_registry.get_default()
 
1594
 
 
1595
    @classmethod
 
1596
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1597
    def get_formats(klass):
 
1598
        """Get all the known formats.
 
1599
 
 
1600
        Warning: This triggers a load of all lazy registered formats: do not
 
1601
        use except when that is desireed.
 
1602
        """
 
1603
        return format_registry._get_all()
 
1604
 
 
1605
    def get_reference(self, a_bzrdir, name=None):
1454
1606
        """Get the target reference of the branch in a_bzrdir.
1455
1607
 
1456
1608
        format probing must have been completed before calling
1458
1610
        in a_bzrdir is correct.
1459
1611
 
1460
1612
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1613
        :param name: Name of the colocated branch to fetch
1461
1614
        :return: None if the branch is not a reference branch.
1462
1615
        """
1463
1616
        return None
1464
1617
 
1465
1618
    @classmethod
1466
 
    def set_reference(self, a_bzrdir, to_branch):
 
1619
    def set_reference(self, a_bzrdir, name, to_branch):
1467
1620
        """Set the target reference of the branch in a_bzrdir.
1468
1621
 
1469
1622
        format probing must have been completed before calling
1471
1624
        in a_bzrdir is correct.
1472
1625
 
1473
1626
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1627
        :param name: Name of colocated branch to set, None for default
1474
1628
        :param to_branch: branch that the checkout is to reference
1475
1629
        """
1476
1630
        raise NotImplementedError(self.set_reference)
1483
1637
        """Return the short format description for this format."""
1484
1638
        raise NotImplementedError(self.get_format_description)
1485
1639
 
1486
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1487
 
                           set_format=True):
 
1640
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1641
        hooks = Branch.hooks['post_branch_init']
 
1642
        if not hooks:
 
1643
            return
 
1644
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1645
        for hook in hooks:
 
1646
            hook(params)
 
1647
 
 
1648
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1649
                           repository=None):
1488
1650
        """Initialize a branch in a bzrdir, with specified files
1489
1651
 
1490
1652
        :param a_bzrdir: The bzrdir to initialize the branch in
1491
1653
        :param utf8_files: The files to create as a list of
1492
1654
            (filename, content) tuples
1493
 
        :param set_format: If True, set the format with
1494
 
            self.get_format_string.  (BzrBranch4 has its format set
1495
 
            elsewhere)
 
1655
        :param name: Name of colocated branch to create, if any
1496
1656
        :return: a branch in this format
1497
1657
        """
1498
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1500
 
        lock_map = {
1501
 
            'metadir': ('lock', lockdir.LockDir),
1502
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1503
 
        }
1504
 
        lock_name, lock_class = lock_map[lock_type]
 
1658
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1659
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1505
1660
        control_files = lockable_files.LockableFiles(branch_transport,
1506
 
            lock_name, lock_class)
 
1661
            'lock', lockdir.LockDir)
1507
1662
        control_files.create_lock()
 
1663
        control_files.lock_write()
1508
1664
        try:
1509
 
            control_files.lock_write()
1510
 
        except errors.LockContention:
1511
 
            if lock_type != 'branch4':
1512
 
                raise
1513
 
            lock_taken = False
1514
 
        else:
1515
 
            lock_taken = True
1516
 
        if set_format:
1517
1665
            utf8_files += [('format', self.get_format_string())]
1518
 
        try:
1519
1666
            for (filename, content) in utf8_files:
1520
1667
                branch_transport.put_bytes(
1521
1668
                    filename, content,
1522
1669
                    mode=a_bzrdir._get_file_mode())
1523
1670
        finally:
1524
 
            if lock_taken:
1525
 
                control_files.unlock()
1526
 
        return self.open(a_bzrdir, _found=True)
 
1671
            control_files.unlock()
 
1672
        branch = self.open(a_bzrdir, name, _found=True,
 
1673
                found_repository=repository)
 
1674
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1675
        return branch
1527
1676
 
1528
 
    def initialize(self, a_bzrdir):
1529
 
        """Create a branch of this format in a_bzrdir."""
 
1677
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1678
        """Create a branch of this format in a_bzrdir.
 
1679
        
 
1680
        :param name: Name of the colocated branch to create.
 
1681
        """
1530
1682
        raise NotImplementedError(self.initialize)
1531
1683
 
1532
1684
    def is_supported(self):
1562
1714
        """
1563
1715
        raise NotImplementedError(self.network_name)
1564
1716
 
1565
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1717
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1718
            found_repository=None):
1566
1719
        """Return the branch object for a_bzrdir
1567
1720
 
1568
1721
        :param a_bzrdir: A BzrDir that contains a branch.
 
1722
        :param name: Name of colocated branch to open
1569
1723
        :param _found: a private parameter, do not use it. It is used to
1570
1724
            indicate if format probing has already be done.
1571
1725
        :param ignore_fallbacks: when set, no fallback branches will be opened
1574
1728
        raise NotImplementedError(self.open)
1575
1729
 
1576
1730
    @classmethod
 
1731
    @deprecated_method(deprecated_in((2, 4, 0)))
1577
1732
    def register_format(klass, format):
1578
 
        """Register a metadir format."""
1579
 
        klass._formats[format.get_format_string()] = format
1580
 
        # Metadir formats have a network name of their format string, and get
1581
 
        # registered as class factories.
1582
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1733
        """Register a metadir format.
 
1734
 
 
1735
        See MetaDirBranchFormatFactory for the ability to register a format
 
1736
        without loading the code the format needs until it is actually used.
 
1737
        """
 
1738
        format_registry.register(format)
1583
1739
 
1584
1740
    @classmethod
 
1741
    @deprecated_method(deprecated_in((2, 4, 0)))
1585
1742
    def set_default_format(klass, format):
1586
 
        klass._default_format = format
 
1743
        format_registry.set_default(format)
1587
1744
 
1588
1745
    def supports_set_append_revisions_only(self):
1589
1746
        """True if this format supports set_append_revisions_only."""
1593
1750
        """True if this format records a stacked-on branch."""
1594
1751
        return False
1595
1752
 
 
1753
    def supports_leaving_lock(self):
 
1754
        """True if this format supports leaving locks in place."""
 
1755
        return False # by default
 
1756
 
1596
1757
    @classmethod
 
1758
    @deprecated_method(deprecated_in((2, 4, 0)))
1597
1759
    def unregister_format(klass, format):
1598
 
        del klass._formats[format.get_format_string()]
 
1760
        format_registry.remove(format)
1599
1761
 
1600
1762
    def __str__(self):
1601
1763
        return self.get_format_description().rstrip()
1605
1767
        return False  # by default
1606
1768
 
1607
1769
 
 
1770
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1771
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1772
    
 
1773
    While none of the built in BranchFormats are lazy registered yet,
 
1774
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1775
    use it, and the bzr-loom plugin uses it as well (see
 
1776
    bzrlib.plugins.loom.formats).
 
1777
    """
 
1778
 
 
1779
    def __init__(self, format_string, module_name, member_name):
 
1780
        """Create a MetaDirBranchFormatFactory.
 
1781
 
 
1782
        :param format_string: The format string the format has.
 
1783
        :param module_name: Module to load the format class from.
 
1784
        :param member_name: Attribute name within the module for the format class.
 
1785
        """
 
1786
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1787
        self._format_string = format_string
 
1788
        
 
1789
    def get_format_string(self):
 
1790
        """See BranchFormat.get_format_string."""
 
1791
        return self._format_string
 
1792
 
 
1793
    def __call__(self):
 
1794
        """Used for network_format_registry support."""
 
1795
        return self.get_obj()()
 
1796
 
 
1797
 
1608
1798
class BranchHooks(Hooks):
1609
1799
    """A dictionary mapping hook name to a list of callables for branch hooks.
1610
1800
 
1618
1808
        These are all empty initially, because by default nothing should get
1619
1809
        notified.
1620
1810
        """
1621
 
        Hooks.__init__(self)
1622
 
        self.create_hook(HookPoint('set_rh',
 
1811
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1812
        self.add_hook('set_rh',
1623
1813
            "Invoked whenever the revision history has been set via "
1624
1814
            "set_revision_history. The api signature is (branch, "
1625
1815
            "revision_history), and the branch will be write-locked. "
1626
1816
            "The set_rh hook can be expensive for bzr to trigger, a better "
1627
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
 
        self.create_hook(HookPoint('open',
 
1817
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1818
        self.add_hook('open',
1629
1819
            "Called with the Branch object that has been opened after a "
1630
 
            "branch is opened.", (1, 8), None))
1631
 
        self.create_hook(HookPoint('post_push',
 
1820
            "branch is opened.", (1, 8))
 
1821
        self.add_hook('post_push',
1632
1822
            "Called after a push operation completes. post_push is called "
1633
1823
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
 
            "bzr client.", (0, 15), None))
1635
 
        self.create_hook(HookPoint('post_pull',
 
1824
            "bzr client.", (0, 15))
 
1825
        self.add_hook('post_pull',
1636
1826
            "Called after a pull operation completes. post_pull is called "
1637
1827
            "with a bzrlib.branch.PullResult object and only runs in the "
1638
 
            "bzr client.", (0, 15), None))
1639
 
        self.create_hook(HookPoint('pre_commit',
1640
 
            "Called after a commit is calculated but before it is is "
 
1828
            "bzr client.", (0, 15))
 
1829
        self.add_hook('pre_commit',
 
1830
            "Called after a commit is calculated but before it is "
1641
1831
            "completed. pre_commit is called with (local, master, old_revno, "
1642
1832
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
1833
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1645
1835
            "basis revision. hooks MUST NOT modify this delta. "
1646
1836
            " future_tree is an in-memory tree obtained from "
1647
1837
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
 
            "tree.", (0,91), None))
1649
 
        self.create_hook(HookPoint('post_commit',
 
1838
            "tree.", (0,91))
 
1839
        self.add_hook('post_commit',
1650
1840
            "Called in the bzr client after a commit has completed. "
1651
1841
            "post_commit is called with (local, master, old_revno, old_revid, "
1652
1842
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
 
            "commit to a branch.", (0, 15), None))
1654
 
        self.create_hook(HookPoint('post_uncommit',
 
1843
            "commit to a branch.", (0, 15))
 
1844
        self.add_hook('post_uncommit',
1655
1845
            "Called in the bzr client after an uncommit completes. "
1656
1846
            "post_uncommit is called with (local, master, old_revno, "
1657
1847
            "old_revid, new_revno, new_revid) where local is the local branch "
1658
1848
            "or None, master is the target branch, and an empty branch "
1659
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1849
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1850
        self.add_hook('pre_change_branch_tip',
1661
1851
            "Called in bzr client and server before a change to the tip of a "
1662
1852
            "branch is made. pre_change_branch_tip is called with a "
1663
1853
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1665
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1854
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1855
        self.add_hook('post_change_branch_tip',
1666
1856
            "Called in bzr client and server after a change to the tip of a "
1667
1857
            "branch is made. post_change_branch_tip is called with a "
1668
1858
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1670
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1859
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1860
        self.add_hook('transform_fallback_location',
1671
1861
            "Called when a stacked branch is activating its fallback "
1672
1862
            "locations. transform_fallback_location is called with (branch, "
1673
1863
            "url), and should return a new url. Returning the same url "
1678
1868
            "fallback locations have not been activated. When there are "
1679
1869
            "multiple hooks installed for transform_fallback_location, "
1680
1870
            "all are called with the url returned from the previous hook."
1681
 
            "The order is however undefined.", (1, 9), None))
 
1871
            "The order is however undefined.", (1, 9))
 
1872
        self.add_hook('automatic_tag_name',
 
1873
            "Called to determine an automatic tag name for a revision. "
 
1874
            "automatic_tag_name is called with (branch, revision_id) and "
 
1875
            "should return a tag name or None if no tag name could be "
 
1876
            "determined. The first non-None tag name returned will be used.",
 
1877
            (2, 2))
 
1878
        self.add_hook('post_branch_init',
 
1879
            "Called after new branch initialization completes. "
 
1880
            "post_branch_init is called with a "
 
1881
            "bzrlib.branch.BranchInitHookParams. "
 
1882
            "Note that init, branch and checkout (both heavyweight and "
 
1883
            "lightweight) will all trigger this hook.", (2, 2))
 
1884
        self.add_hook('post_switch',
 
1885
            "Called after a checkout switches branch. "
 
1886
            "post_switch is called with a "
 
1887
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1888
 
1682
1889
 
1683
1890
 
1684
1891
# install the default hooks into the Branch class.
1723
1930
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1724
1931
 
1725
1932
 
1726
 
class BzrBranchFormat4(BranchFormat):
1727
 
    """Bzr branch format 4.
1728
 
 
1729
 
    This format has:
1730
 
     - a revision-history file.
1731
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1732
 
    """
1733
 
 
1734
 
    def get_format_description(self):
1735
 
        """See BranchFormat.get_format_description()."""
1736
 
        return "Branch format 4"
1737
 
 
1738
 
    def initialize(self, a_bzrdir):
1739
 
        """Create a branch of this format in a_bzrdir."""
1740
 
        utf8_files = [('revision-history', ''),
1741
 
                      ('branch-name', ''),
1742
 
                      ]
1743
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1744
 
                                       lock_type='branch4', set_format=False)
1745
 
 
1746
 
    def __init__(self):
1747
 
        super(BzrBranchFormat4, self).__init__()
1748
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1749
 
 
1750
 
    def network_name(self):
1751
 
        """The network name for this format is the control dirs disk label."""
1752
 
        return self._matchingbzrdir.get_format_string()
1753
 
 
1754
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
 
        """See BranchFormat.open()."""
1756
 
        if not _found:
1757
 
            # we are being called directly and must probe.
1758
 
            raise NotImplementedError
1759
 
        return BzrBranch(_format=self,
1760
 
                         _control_files=a_bzrdir._control_files,
1761
 
                         a_bzrdir=a_bzrdir,
1762
 
                         _repository=a_bzrdir.open_repository())
1763
 
 
1764
 
    def __str__(self):
1765
 
        return "Bazaar-NG branch format 4"
 
1933
class BranchInitHookParams(object):
 
1934
    """Object holding parameters passed to *_branch_init hooks.
 
1935
 
 
1936
    There are 4 fields that hooks may wish to access:
 
1937
 
 
1938
    :ivar format: the branch format
 
1939
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1940
    :ivar name: name of colocated branch, if any (or None)
 
1941
    :ivar branch: the branch created
 
1942
 
 
1943
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1944
    the checkout, hence they are different from the corresponding fields in
 
1945
    branch, which refer to the original branch.
 
1946
    """
 
1947
 
 
1948
    def __init__(self, format, a_bzrdir, name, branch):
 
1949
        """Create a group of BranchInitHook parameters.
 
1950
 
 
1951
        :param format: the branch format
 
1952
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1953
            initialized
 
1954
        :param name: name of colocated branch, if any (or None)
 
1955
        :param branch: the branch created
 
1956
 
 
1957
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1958
        to the checkout, hence they are different from the corresponding fields
 
1959
        in branch, which refer to the original branch.
 
1960
        """
 
1961
        self.format = format
 
1962
        self.bzrdir = a_bzrdir
 
1963
        self.name = name
 
1964
        self.branch = branch
 
1965
 
 
1966
    def __eq__(self, other):
 
1967
        return self.__dict__ == other.__dict__
 
1968
 
 
1969
    def __repr__(self):
 
1970
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1971
 
 
1972
 
 
1973
class SwitchHookParams(object):
 
1974
    """Object holding parameters passed to *_switch hooks.
 
1975
 
 
1976
    There are 4 fields that hooks may wish to access:
 
1977
 
 
1978
    :ivar control_dir: BzrDir of the checkout to change
 
1979
    :ivar to_branch: branch that the checkout is to reference
 
1980
    :ivar force: skip the check for local commits in a heavy checkout
 
1981
    :ivar revision_id: revision ID to switch to (or None)
 
1982
    """
 
1983
 
 
1984
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1985
        """Create a group of SwitchHook parameters.
 
1986
 
 
1987
        :param control_dir: BzrDir of the checkout to change
 
1988
        :param to_branch: branch that the checkout is to reference
 
1989
        :param force: skip the check for local commits in a heavy checkout
 
1990
        :param revision_id: revision ID to switch to (or None)
 
1991
        """
 
1992
        self.control_dir = control_dir
 
1993
        self.to_branch = to_branch
 
1994
        self.force = force
 
1995
        self.revision_id = revision_id
 
1996
 
 
1997
    def __eq__(self, other):
 
1998
        return self.__dict__ == other.__dict__
 
1999
 
 
2000
    def __repr__(self):
 
2001
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
2002
            self.control_dir, self.to_branch,
 
2003
            self.revision_id)
1766
2004
 
1767
2005
 
1768
2006
class BranchFormatMetadir(BranchFormat):
1779
2017
        """
1780
2018
        return self.get_format_string()
1781
2019
 
1782
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
2020
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2021
            found_repository=None):
1783
2022
        """See BranchFormat.open()."""
1784
2023
        if not _found:
1785
 
            format = BranchFormat.find_format(a_bzrdir)
 
2024
            format = BranchFormat.find_format(a_bzrdir, name=name)
1786
2025
            if format.__class__ != self.__class__:
1787
2026
                raise AssertionError("wrong format %r found for %r" %
1788
2027
                    (format, self))
 
2028
        transport = a_bzrdir.get_branch_transport(None, name=name)
1789
2029
        try:
1790
 
            transport = a_bzrdir.get_branch_transport(None)
1791
2030
            control_files = lockable_files.LockableFiles(transport, 'lock',
1792
2031
                                                         lockdir.LockDir)
 
2032
            if found_repository is None:
 
2033
                found_repository = a_bzrdir.find_repository()
1793
2034
            return self._branch_class()(_format=self,
1794
2035
                              _control_files=control_files,
 
2036
                              name=name,
1795
2037
                              a_bzrdir=a_bzrdir,
1796
 
                              _repository=a_bzrdir.find_repository(),
 
2038
                              _repository=found_repository,
1797
2039
                              ignore_fallbacks=ignore_fallbacks)
1798
2040
        except errors.NoSuchFile:
1799
2041
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1806
2048
    def supports_tags(self):
1807
2049
        return True
1808
2050
 
 
2051
    def supports_leaving_lock(self):
 
2052
        return True
 
2053
 
1809
2054
 
1810
2055
class BzrBranchFormat5(BranchFormatMetadir):
1811
2056
    """Bzr branch format 5.
1831
2076
        """See BranchFormat.get_format_description()."""
1832
2077
        return "Branch format 5"
1833
2078
 
1834
 
    def initialize(self, a_bzrdir):
 
2079
    def initialize(self, a_bzrdir, name=None, repository=None):
1835
2080
        """Create a branch of this format in a_bzrdir."""
1836
2081
        utf8_files = [('revision-history', ''),
1837
2082
                      ('branch-name', ''),
1838
2083
                      ]
1839
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2084
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1840
2085
 
1841
2086
    def supports_tags(self):
1842
2087
        return False
1864
2109
        """See BranchFormat.get_format_description()."""
1865
2110
        return "Branch format 6"
1866
2111
 
1867
 
    def initialize(self, a_bzrdir):
 
2112
    def initialize(self, a_bzrdir, name=None, repository=None):
1868
2113
        """Create a branch of this format in a_bzrdir."""
1869
2114
        utf8_files = [('last-revision', '0 null:\n'),
1870
2115
                      ('branch.conf', ''),
1871
2116
                      ('tags', ''),
1872
2117
                      ]
1873
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2118
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1874
2119
 
1875
2120
    def make_tags(self, branch):
1876
2121
        """See bzrlib.branch.BranchFormat.make_tags()."""
1894
2139
        """See BranchFormat.get_format_description()."""
1895
2140
        return "Branch format 8"
1896
2141
 
1897
 
    def initialize(self, a_bzrdir):
 
2142
    def initialize(self, a_bzrdir, name=None, repository=None):
1898
2143
        """Create a branch of this format in a_bzrdir."""
1899
2144
        utf8_files = [('last-revision', '0 null:\n'),
1900
2145
                      ('branch.conf', ''),
1901
2146
                      ('tags', ''),
1902
2147
                      ('references', '')
1903
2148
                      ]
1904
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2149
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1905
2150
 
1906
2151
    def __init__(self):
1907
2152
        super(BzrBranchFormat8, self).__init__()
1930
2175
    This format was introduced in bzr 1.6.
1931
2176
    """
1932
2177
 
1933
 
    def initialize(self, a_bzrdir):
 
2178
    def initialize(self, a_bzrdir, name=None, repository=None):
1934
2179
        """Create a branch of this format in a_bzrdir."""
1935
2180
        utf8_files = [('last-revision', '0 null:\n'),
1936
2181
                      ('branch.conf', ''),
1937
2182
                      ('tags', ''),
1938
2183
                      ]
1939
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2184
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1940
2185
 
1941
2186
    def _branch_class(self):
1942
2187
        return BzrBranch7
1974
2219
        """See BranchFormat.get_format_description()."""
1975
2220
        return "Checkout reference format 1"
1976
2221
 
1977
 
    def get_reference(self, a_bzrdir):
 
2222
    def get_reference(self, a_bzrdir, name=None):
1978
2223
        """See BranchFormat.get_reference()."""
1979
 
        transport = a_bzrdir.get_branch_transport(None)
 
2224
        transport = a_bzrdir.get_branch_transport(None, name=name)
1980
2225
        return transport.get_bytes('location')
1981
2226
 
1982
 
    def set_reference(self, a_bzrdir, to_branch):
 
2227
    def set_reference(self, a_bzrdir, name, to_branch):
1983
2228
        """See BranchFormat.set_reference()."""
1984
 
        transport = a_bzrdir.get_branch_transport(None)
 
2229
        transport = a_bzrdir.get_branch_transport(None, name=name)
1985
2230
        location = transport.put_bytes('location', to_branch.base)
1986
2231
 
1987
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2232
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2233
            repository=None):
1988
2234
        """Create a branch of this format in a_bzrdir."""
1989
2235
        if target_branch is None:
1990
2236
            # this format does not implement branch itself, thus the implicit
1991
2237
            # creation contract must see it as uninitializable
1992
2238
            raise errors.UninitializableFormat(self)
1993
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2239
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2240
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
2241
        branch_transport.put_bytes('location',
1996
 
            target_branch.bzrdir.root_transport.base)
 
2242
            target_branch.bzrdir.user_url)
1997
2243
        branch_transport.put_bytes('format', self.get_format_string())
1998
 
        return self.open(
1999
 
            a_bzrdir, _found=True,
 
2244
        branch = self.open(
 
2245
            a_bzrdir, name, _found=True,
2000
2246
            possible_transports=[target_branch.bzrdir.root_transport])
 
2247
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2248
        return branch
2001
2249
 
2002
2250
    def __init__(self):
2003
2251
        super(BranchReferenceFormat, self).__init__()
2009
2257
        def clone(to_bzrdir, revision_id=None,
2010
2258
            repository_policy=None):
2011
2259
            """See Branch.clone()."""
2012
 
            return format.initialize(to_bzrdir, a_branch)
 
2260
            return format.initialize(to_bzrdir, target_branch=a_branch)
2013
2261
            # cannot obey revision_id limits when cloning a reference ...
2014
2262
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2015
2263
            # emit some sort of warning/error to the caller ?!
2016
2264
        return clone
2017
2265
 
2018
 
    def open(self, a_bzrdir, _found=False, location=None,
2019
 
             possible_transports=None, ignore_fallbacks=False):
 
2266
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2267
             possible_transports=None, ignore_fallbacks=False,
 
2268
             found_repository=None):
2020
2269
        """Return the branch that the branch reference in a_bzrdir points at.
2021
2270
 
2022
2271
        :param a_bzrdir: A BzrDir that contains a branch.
 
2272
        :param name: Name of colocated branch to open, if any
2023
2273
        :param _found: a private parameter, do not use it. It is used to
2024
2274
            indicate if format probing has already be done.
2025
2275
        :param ignore_fallbacks: when set, no fallback branches will be opened
2030
2280
        :param possible_transports: An optional reusable transports list.
2031
2281
        """
2032
2282
        if not _found:
2033
 
            format = BranchFormat.find_format(a_bzrdir)
 
2283
            format = BranchFormat.find_format(a_bzrdir, name=name)
2034
2284
            if format.__class__ != self.__class__:
2035
2285
                raise AssertionError("wrong format %r found for %r" %
2036
2286
                    (format, self))
2037
2287
        if location is None:
2038
 
            location = self.get_reference(a_bzrdir)
 
2288
            location = self.get_reference(a_bzrdir, name)
2039
2289
        real_bzrdir = bzrdir.BzrDir.open(
2040
2290
            location, possible_transports=possible_transports)
2041
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2291
        result = real_bzrdir.open_branch(name=name, 
 
2292
            ignore_fallbacks=ignore_fallbacks)
2042
2293
        # this changes the behaviour of result.clone to create a new reference
2043
2294
        # rather than a copy of the content of the branch.
2044
2295
        # I did not use a proxy object because that needs much more extensive
2051
2302
        return result
2052
2303
 
2053
2304
 
 
2305
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2306
    """Branch format registry."""
 
2307
 
 
2308
    def __init__(self, other_registry=None):
 
2309
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2310
        self._default_format = None
 
2311
 
 
2312
    def set_default(self, format):
 
2313
        self._default_format = format
 
2314
 
 
2315
    def get_default(self):
 
2316
        return self._default_format
 
2317
 
 
2318
 
2054
2319
network_format_registry = registry.FormatRegistry()
2055
2320
"""Registry of formats indexed by their network name.
2056
2321
 
2059
2324
BranchFormat.network_name() for more detail.
2060
2325
"""
2061
2326
 
 
2327
format_registry = BranchFormatRegistry(network_format_registry)
 
2328
 
2062
2329
 
2063
2330
# formats which have no format string are not discoverable
2064
2331
# and not independently creatable, so are not registered.
2066
2333
__format6 = BzrBranchFormat6()
2067
2334
__format7 = BzrBranchFormat7()
2068
2335
__format8 = BzrBranchFormat8()
2069
 
BranchFormat.register_format(__format5)
2070
 
BranchFormat.register_format(BranchReferenceFormat())
2071
 
BranchFormat.register_format(__format6)
2072
 
BranchFormat.register_format(__format7)
2073
 
BranchFormat.register_format(__format8)
2074
 
BranchFormat.set_default_format(__format7)
2075
 
_legacy_formats = [BzrBranchFormat4(),
2076
 
    ]
2077
 
network_format_registry.register(
2078
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2336
format_registry.register(__format5)
 
2337
format_registry.register(BranchReferenceFormat())
 
2338
format_registry.register(__format6)
 
2339
format_registry.register(__format7)
 
2340
format_registry.register(__format8)
 
2341
format_registry.set_default(__format7)
 
2342
 
 
2343
 
 
2344
class BranchWriteLockResult(LogicalLockResult):
 
2345
    """The result of write locking a branch.
 
2346
 
 
2347
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2348
        None.
 
2349
    :ivar unlock: A callable which will unlock the lock.
 
2350
    """
 
2351
 
 
2352
    def __init__(self, unlock, branch_token):
 
2353
        LogicalLockResult.__init__(self, unlock)
 
2354
        self.branch_token = branch_token
 
2355
 
 
2356
    def __repr__(self):
 
2357
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2358
            self.unlock)
2079
2359
 
2080
2360
 
2081
2361
class BzrBranch(Branch, _RelockDebugMixin):
2090
2370
    :ivar repository: Repository for this branch.
2091
2371
    :ivar base: The url of the base directory for this branch; the one
2092
2372
        containing the .bzr directory.
 
2373
    :ivar name: Optional colocated branch name as it exists in the control
 
2374
        directory.
2093
2375
    """
2094
2376
 
2095
2377
    def __init__(self, _format=None,
2096
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2097
 
                 ignore_fallbacks=False):
 
2378
                 _control_files=None, a_bzrdir=None, name=None,
 
2379
                 _repository=None, ignore_fallbacks=False):
2098
2380
        """Create new branch object at a particular location."""
2099
2381
        if a_bzrdir is None:
2100
2382
            raise ValueError('a_bzrdir must be supplied')
2101
2383
        else:
2102
2384
            self.bzrdir = a_bzrdir
2103
2385
        self._base = self.bzrdir.transport.clone('..').base
 
2386
        self.name = name
2104
2387
        # XXX: We should be able to just do
2105
2388
        #   self.base = self.bzrdir.root_transport.base
2106
2389
        # but this does not quite work yet -- mbp 20080522
2113
2396
        Branch.__init__(self)
2114
2397
 
2115
2398
    def __str__(self):
2116
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2399
        if self.name is None:
 
2400
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2401
        else:
 
2402
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
 
2403
                self.name)
2117
2404
 
2118
2405
    __repr__ = __str__
2119
2406
 
2130
2417
        return self.control_files.is_locked()
2131
2418
 
2132
2419
    def lock_write(self, token=None):
 
2420
        """Lock the branch for write operations.
 
2421
 
 
2422
        :param token: A token to permit reacquiring a previously held and
 
2423
            preserved lock.
 
2424
        :return: A BranchWriteLockResult.
 
2425
        """
2133
2426
        if not self.is_locked():
2134
2427
            self._note_lock('w')
2135
2428
        # All-in-one needs to always unlock/lock.
2141
2434
        else:
2142
2435
            took_lock = False
2143
2436
        try:
2144
 
            return self.control_files.lock_write(token=token)
 
2437
            return BranchWriteLockResult(self.unlock,
 
2438
                self.control_files.lock_write(token=token))
2145
2439
        except:
2146
2440
            if took_lock:
2147
2441
                self.repository.unlock()
2148
2442
            raise
2149
2443
 
2150
2444
    def lock_read(self):
 
2445
        """Lock the branch for read operations.
 
2446
 
 
2447
        :return: A bzrlib.lock.LogicalLockResult.
 
2448
        """
2151
2449
        if not self.is_locked():
2152
2450
            self._note_lock('r')
2153
2451
        # All-in-one needs to always unlock/lock.
2160
2458
            took_lock = False
2161
2459
        try:
2162
2460
            self.control_files.lock_read()
 
2461
            return LogicalLockResult(self.unlock)
2163
2462
        except:
2164
2463
            if took_lock:
2165
2464
                self.repository.unlock()
2321
2620
        result.target_branch = target
2322
2621
        result.old_revno, result.old_revid = target.last_revision_info()
2323
2622
        self.update_references(target)
2324
 
        if result.old_revid != self.last_revision():
 
2623
        if result.old_revid != stop_revision:
2325
2624
            # We assume that during 'push' this repository is closer than
2326
2625
            # the target.
2327
2626
            graph = self.repository.get_graph(target.repository)
2328
2627
            target.update_revisions(self, stop_revision,
2329
2628
                overwrite=overwrite, graph=graph)
2330
2629
        if self._push_should_merge_tags():
2331
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2332
 
                overwrite)
 
2630
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2333
2631
        result.new_revno, result.new_revid = target.last_revision_info()
2334
2632
        return result
2335
2633
 
2336
2634
    def get_stacked_on_url(self):
2337
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2635
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2338
2636
 
2339
2637
    def set_push_location(self, location):
2340
2638
        """See Branch.set_push_location."""
2367
2665
        """Return the branch we are bound to.
2368
2666
 
2369
2667
        :return: Either a Branch, or None
2370
 
 
2371
 
        This could memoise the branch, but if thats done
2372
 
        it must be revalidated on each new lock.
2373
 
        So for now we just don't memoise it.
2374
 
        # RBC 20060304 review this decision.
2375
2668
        """
 
2669
        if self._master_branch_cache is None:
 
2670
            self._master_branch_cache = self._get_master_branch(
 
2671
                possible_transports)
 
2672
        return self._master_branch_cache
 
2673
 
 
2674
    def _get_master_branch(self, possible_transports):
2376
2675
        bound_loc = self.get_bound_location()
2377
2676
        if not bound_loc:
2378
2677
            return None
2389
2688
 
2390
2689
        :param location: URL to the target branch
2391
2690
        """
 
2691
        self._master_branch_cache = None
2392
2692
        if location:
2393
2693
            self._transport.put_bytes('bound', location+'\n',
2394
2694
                mode=self.bzrdir._get_file_mode())
2530
2830
        if _mod_revision.is_null(last_revision):
2531
2831
            return
2532
2832
        if last_revision not in self._lefthand_history(revision_id):
2533
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2833
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2534
2834
 
2535
2835
    def _gen_revision_history(self):
2536
2836
        """Generate the revision history from last revision
2636
2936
        if branch_location is None:
2637
2937
            return Branch.reference_parent(self, file_id, path,
2638
2938
                                           possible_transports)
2639
 
        branch_location = urlutils.join(self.base, branch_location)
 
2939
        branch_location = urlutils.join(self.user_url, branch_location)
2640
2940
        return Branch.open(branch_location,
2641
2941
                           possible_transports=possible_transports)
2642
2942
 
2646
2946
 
2647
2947
    def set_bound_location(self, location):
2648
2948
        """See Branch.set_push_location."""
 
2949
        self._master_branch_cache = None
2649
2950
        result = None
2650
2951
        config = self.get_config()
2651
2952
        if location is None:
2688
2989
        return stacked_url
2689
2990
 
2690
2991
    def _get_append_revisions_only(self):
2691
 
        value = self.get_config().get_user_option('append_revisions_only')
2692
 
        return value == 'True'
 
2992
        return self.get_config(
 
2993
            ).get_user_option_as_bool('append_revisions_only')
2693
2994
 
2694
2995
    @needs_write_lock
2695
2996
    def generate_revision_history(self, revision_id, last_rev=None,
2728
3029
        try:
2729
3030
            index = self._partial_revision_history_cache.index(revision_id)
2730
3031
        except ValueError:
2731
 
            self._extend_partial_history(stop_revision=revision_id)
 
3032
            try:
 
3033
                self._extend_partial_history(stop_revision=revision_id)
 
3034
            except errors.RevisionNotPresent, e:
 
3035
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2732
3036
            index = len(self._partial_revision_history_cache) - 1
2733
3037
            if self._partial_revision_history_cache[index] != revision_id:
2734
3038
                raise errors.NoSuchRevision(self, revision_id)
2757
3061
    """
2758
3062
 
2759
3063
    def get_stacked_on_url(self):
2760
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
3064
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2761
3065
 
2762
3066
 
2763
3067
######################################################################
2789
3093
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2790
3094
    """
2791
3095
 
 
3096
    @deprecated_method(deprecated_in((2, 3, 0)))
2792
3097
    def __int__(self):
2793
 
        # DEPRECATED: pull used to return the change in revno
 
3098
        """Return the relative change in revno.
 
3099
 
 
3100
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3101
        """
2794
3102
        return self.new_revno - self.old_revno
2795
3103
 
2796
3104
    def report(self, to_file):
2821
3129
        target, otherwise it will be None.
2822
3130
    """
2823
3131
 
 
3132
    @deprecated_method(deprecated_in((2, 3, 0)))
2824
3133
    def __int__(self):
2825
 
        # DEPRECATED: push used to return the change in revno
 
3134
        """Return the relative change in revno.
 
3135
 
 
3136
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3137
        """
2826
3138
        return self.new_revno - self.old_revno
2827
3139
 
2828
3140
    def report(self, to_file):
2850
3162
        :param verbose: Requests more detailed display of what was checked,
2851
3163
            if any.
2852
3164
        """
2853
 
        note('checked branch %s format %s', self.branch.base,
 
3165
        note('checked branch %s format %s', self.branch.user_url,
2854
3166
            self.branch._format)
2855
3167
        for error in self.errors:
2856
3168
            note('found error:%s', error)
2951
3263
    _optimisers = []
2952
3264
    """The available optimised InterBranch types."""
2953
3265
 
2954
 
    @staticmethod
2955
 
    def _get_branch_formats_to_test():
2956
 
        """Return a tuple with the Branch formats to use when testing."""
2957
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3266
    @classmethod
 
3267
    def _get_branch_formats_to_test(klass):
 
3268
        """Return an iterable of format tuples for testing.
 
3269
        
 
3270
        :return: An iterable of (from_format, to_format) to use when testing
 
3271
            this InterBranch class. Each InterBranch class should define this
 
3272
            method itself.
 
3273
        """
 
3274
        raise NotImplementedError(klass._get_branch_formats_to_test)
2958
3275
 
 
3276
    @needs_write_lock
2959
3277
    def pull(self, overwrite=False, stop_revision=None,
2960
3278
             possible_transports=None, local=False):
2961
3279
        """Mirror source into target branch.
2966
3284
        """
2967
3285
        raise NotImplementedError(self.pull)
2968
3286
 
 
3287
    @needs_write_lock
2969
3288
    def update_revisions(self, stop_revision=None, overwrite=False,
2970
 
                         graph=None):
 
3289
                         graph=None, fetch_tags=True):
2971
3290
        """Pull in new perfect-fit revisions.
2972
3291
 
2973
3292
        :param stop_revision: Updated until the given revision
2975
3294
            to see if it is a proper descendant.
2976
3295
        :param graph: A Graph object that can be used to query history
2977
3296
            information. This can be None.
 
3297
        :param fetch_tags: Flag that specifies if tags from source should be
 
3298
            fetched too.
2978
3299
        :return: None
2979
3300
        """
2980
3301
        raise NotImplementedError(self.update_revisions)
2981
3302
 
 
3303
    @needs_write_lock
2982
3304
    def push(self, overwrite=False, stop_revision=None,
2983
3305
             _override_hook_source_branch=None):
2984
3306
        """Mirror the source branch into the target branch.
2987
3309
        """
2988
3310
        raise NotImplementedError(self.push)
2989
3311
 
 
3312
    @needs_write_lock
 
3313
    def copy_content_into(self, revision_id=None):
 
3314
        """Copy the content of source into target
 
3315
 
 
3316
        revision_id: if not None, the revision history in the new branch will
 
3317
                     be truncated to end with revision_id.
 
3318
        """
 
3319
        raise NotImplementedError(self.copy_content_into)
 
3320
 
 
3321
    @needs_write_lock
 
3322
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3323
        """Fetch revisions.
 
3324
 
 
3325
        :param stop_revision: Last revision to fetch
 
3326
        :param fetch_spec: Fetch spec.
 
3327
        """
 
3328
        raise NotImplementedError(self.fetch)
 
3329
 
2990
3330
 
2991
3331
class GenericInterBranch(InterBranch):
2992
 
    """InterBranch implementation that uses public Branch functions.
2993
 
    """
2994
 
 
2995
 
    @staticmethod
2996
 
    def _get_branch_formats_to_test():
2997
 
        return BranchFormat._default_format, BranchFormat._default_format
2998
 
 
 
3332
    """InterBranch implementation that uses public Branch functions."""
 
3333
 
 
3334
    @classmethod
 
3335
    def is_compatible(klass, source, target):
 
3336
        # GenericBranch uses the public API, so always compatible
 
3337
        return True
 
3338
 
 
3339
    @classmethod
 
3340
    def _get_branch_formats_to_test(klass):
 
3341
        return [(format_registry.get_default(), format_registry.get_default())]
 
3342
 
 
3343
    @classmethod
 
3344
    def unwrap_format(klass, format):
 
3345
        if isinstance(format, remote.RemoteBranchFormat):
 
3346
            format._ensure_real()
 
3347
            return format._custom_format
 
3348
        return format
 
3349
 
 
3350
    @needs_write_lock
 
3351
    def copy_content_into(self, revision_id=None):
 
3352
        """Copy the content of source into target
 
3353
 
 
3354
        revision_id: if not None, the revision history in the new branch will
 
3355
                     be truncated to end with revision_id.
 
3356
        """
 
3357
        self.source.update_references(self.target)
 
3358
        self.source._synchronize_history(self.target, revision_id)
 
3359
        try:
 
3360
            parent = self.source.get_parent()
 
3361
        except errors.InaccessibleParent, e:
 
3362
            mutter('parent was not accessible to copy: %s', e)
 
3363
        else:
 
3364
            if parent:
 
3365
                self.target.set_parent(parent)
 
3366
        if self.source._push_should_merge_tags():
 
3367
            self.source.tags.merge_to(self.target.tags)
 
3368
 
 
3369
    @needs_write_lock
 
3370
    def fetch(self, stop_revision=None, fetch_spec=None):
 
3371
        if fetch_spec is not None and stop_revision is not None:
 
3372
            raise AssertionError(
 
3373
                "fetch_spec and last_revision are mutually exclusive.")
 
3374
        if self.target.base == self.source.base:
 
3375
            return (0, [])
 
3376
        self.source.lock_read()
 
3377
        try:
 
3378
            if stop_revision is None and fetch_spec is None:
 
3379
                stop_revision = self.source.last_revision()
 
3380
                stop_revision = _mod_revision.ensure_null(stop_revision)
 
3381
            return self.target.repository.fetch(self.source.repository,
 
3382
                revision_id=stop_revision, fetch_spec=fetch_spec)
 
3383
        finally:
 
3384
            self.source.unlock()
 
3385
 
 
3386
    @needs_write_lock
2999
3387
    def update_revisions(self, stop_revision=None, overwrite=False,
3000
 
        graph=None):
 
3388
        graph=None, fetch_tags=True):
3001
3389
        """See InterBranch.update_revisions()."""
3002
 
        self.source.lock_read()
3003
 
        try:
3004
 
            other_revno, other_last_revision = self.source.last_revision_info()
3005
 
            stop_revno = None # unknown
3006
 
            if stop_revision is None:
3007
 
                stop_revision = other_last_revision
3008
 
                if _mod_revision.is_null(stop_revision):
3009
 
                    # if there are no commits, we're done.
3010
 
                    return
3011
 
                stop_revno = other_revno
3012
 
 
3013
 
            # what's the current last revision, before we fetch [and change it
3014
 
            # possibly]
3015
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
 
            # we fetch here so that we don't process data twice in the common
3017
 
            # case of having something to pull, and so that the check for
3018
 
            # already merged can operate on the just fetched graph, which will
3019
 
            # be cached in memory.
3020
 
            self.target.fetch(self.source, stop_revision)
3021
 
            # Check to see if one is an ancestor of the other
3022
 
            if not overwrite:
3023
 
                if graph is None:
3024
 
                    graph = self.target.repository.get_graph()
3025
 
                if self.target._check_if_descendant_or_diverged(
3026
 
                        stop_revision, last_rev, graph, self.source):
3027
 
                    # stop_revision is a descendant of last_rev, but we aren't
3028
 
                    # overwriting, so we're done.
3029
 
                    return
3030
 
            if stop_revno is None:
3031
 
                if graph is None:
3032
 
                    graph = self.target.repository.get_graph()
3033
 
                this_revno, this_last_revision = \
3034
 
                        self.target.last_revision_info()
3035
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3036
 
                                [(other_last_revision, other_revno),
3037
 
                                 (this_last_revision, this_revno)])
3038
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
3039
 
        finally:
3040
 
            self.source.unlock()
3041
 
 
 
3390
        other_revno, other_last_revision = self.source.last_revision_info()
 
3391
        stop_revno = None # unknown
 
3392
        if stop_revision is None:
 
3393
            stop_revision = other_last_revision
 
3394
            if _mod_revision.is_null(stop_revision):
 
3395
                # if there are no commits, we're done.
 
3396
                return
 
3397
            stop_revno = other_revno
 
3398
 
 
3399
        # what's the current last revision, before we fetch [and change it
 
3400
        # possibly]
 
3401
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3402
        # we fetch here so that we don't process data twice in the common
 
3403
        # case of having something to pull, and so that the check for
 
3404
        # already merged can operate on the just fetched graph, which will
 
3405
        # be cached in memory.
 
3406
        if fetch_tags:
 
3407
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3408
            fetch_spec_factory.source_branch = self.source
 
3409
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3410
            fetch_spec_factory.source_repo = self.source.repository
 
3411
            fetch_spec_factory.target_repo = self.target.repository
 
3412
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3413
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3414
        else:
 
3415
            fetch_spec = _mod_graph.NotInOtherForRevs(self.target.repository,
 
3416
                self.source.repository, revision_ids=[stop_revision]).execute()
 
3417
        self.target.fetch(self.source, fetch_spec=fetch_spec)
 
3418
        # Check to see if one is an ancestor of the other
 
3419
        if not overwrite:
 
3420
            if graph is None:
 
3421
                graph = self.target.repository.get_graph()
 
3422
            if self.target._check_if_descendant_or_diverged(
 
3423
                    stop_revision, last_rev, graph, self.source):
 
3424
                # stop_revision is a descendant of last_rev, but we aren't
 
3425
                # overwriting, so we're done.
 
3426
                return
 
3427
        if stop_revno is None:
 
3428
            if graph is None:
 
3429
                graph = self.target.repository.get_graph()
 
3430
            this_revno, this_last_revision = \
 
3431
                    self.target.last_revision_info()
 
3432
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3433
                            [(other_last_revision, other_revno),
 
3434
                             (this_last_revision, this_revno)])
 
3435
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3436
 
 
3437
    @needs_write_lock
3042
3438
    def pull(self, overwrite=False, stop_revision=None,
3043
 
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3439
             possible_transports=None, run_hooks=True,
3044
3440
             _override_hook_target=None, local=False):
3045
 
        """See Branch.pull.
 
3441
        """Pull from source into self, updating my master if any.
3046
3442
 
3047
 
        :param _hook_master: Private parameter - set the branch to
3048
 
            be supplied as the master to pull hooks.
3049
3443
        :param run_hooks: Private parameter - if false, this branch
3050
3444
            is being called because it's the master of the primary branch,
3051
3445
            so it should not run its hooks.
3052
 
        :param _override_hook_target: Private parameter - set the branch to be
3053
 
            supplied as the target_branch to pull hooks.
3054
 
        :param local: Only update the local branch, and not the bound branch.
3055
3446
        """
3056
 
        # This type of branch can't be bound.
3057
 
        if local:
 
3447
        bound_location = self.target.get_bound_location()
 
3448
        if local and not bound_location:
3058
3449
            raise errors.LocalRequiresBoundBranch()
3059
 
        result = PullResult()
3060
 
        result.source_branch = self.source
3061
 
        if _override_hook_target is None:
3062
 
            result.target_branch = self.target
3063
 
        else:
3064
 
            result.target_branch = _override_hook_target
3065
 
        self.source.lock_read()
 
3450
        master_branch = None
 
3451
        source_is_master = (self.source.user_url == bound_location)
 
3452
        if not local and bound_location and not source_is_master:
 
3453
            # not pulling from master, so we need to update master.
 
3454
            master_branch = self.target.get_master_branch(possible_transports)
 
3455
            master_branch.lock_write()
3066
3456
        try:
3067
 
            # We assume that during 'pull' the target repository is closer than
3068
 
            # the source one.
3069
 
            self.source.update_references(self.target)
3070
 
            graph = self.target.repository.get_graph(self.source.repository)
3071
 
            # TODO: Branch formats should have a flag that indicates 
3072
 
            # that revno's are expensive, and pull() should honor that flag.
3073
 
            # -- JRV20090506
3074
 
            result.old_revno, result.old_revid = \
3075
 
                self.target.last_revision_info()
3076
 
            self.target.update_revisions(self.source, stop_revision,
3077
 
                overwrite=overwrite, graph=graph)
3078
 
            # TODO: The old revid should be specified when merging tags, 
3079
 
            # so a tags implementation that versions tags can only 
3080
 
            # pull in the most recent changes. -- JRV20090506
3081
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3082
 
                overwrite)
3083
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3084
 
            if _hook_master:
3085
 
                result.master_branch = _hook_master
3086
 
                result.local_branch = result.target_branch
3087
 
            else:
3088
 
                result.master_branch = result.target_branch
3089
 
                result.local_branch = None
3090
 
            if run_hooks:
3091
 
                for hook in Branch.hooks['post_pull']:
3092
 
                    hook(result)
 
3457
            if master_branch:
 
3458
                # pull from source into master.
 
3459
                master_branch.pull(self.source, overwrite, stop_revision,
 
3460
                    run_hooks=False)
 
3461
            return self._pull(overwrite,
 
3462
                stop_revision, _hook_master=master_branch,
 
3463
                run_hooks=run_hooks,
 
3464
                _override_hook_target=_override_hook_target,
 
3465
                merge_tags_to_master=not source_is_master)
3093
3466
        finally:
3094
 
            self.source.unlock()
3095
 
        return result
 
3467
            if master_branch:
 
3468
                master_branch.unlock()
3096
3469
 
3097
3470
    def push(self, overwrite=False, stop_revision=None,
3098
3471
             _override_hook_source_branch=None):
3138
3511
                # push into the master from the source branch.
3139
3512
                self.source._basic_push(master_branch, overwrite, stop_revision)
3140
3513
                # and push into the target branch from the source. Note that we
3141
 
                # push from the source branch again, because its considered the
 
3514
                # push from the source branch again, because it's considered the
3142
3515
                # highest bandwidth repository.
3143
3516
                result = self.source._basic_push(self.target, overwrite,
3144
3517
                    stop_revision)
3160
3533
            _run_hooks()
3161
3534
            return result
3162
3535
 
3163
 
    @classmethod
3164
 
    def is_compatible(self, source, target):
3165
 
        # GenericBranch uses the public API, so always compatible
3166
 
        return True
3167
 
 
3168
 
 
3169
 
class InterToBranch5(GenericInterBranch):
3170
 
 
3171
 
    @staticmethod
3172
 
    def _get_branch_formats_to_test():
3173
 
        return BranchFormat._default_format, BzrBranchFormat5()
3174
 
 
3175
 
    def pull(self, overwrite=False, stop_revision=None,
3176
 
             possible_transports=None, run_hooks=True,
3177
 
             _override_hook_target=None, local=False):
3178
 
        """Pull from source into self, updating my master if any.
3179
 
 
 
3536
    def _pull(self, overwrite=False, stop_revision=None,
 
3537
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3538
             _override_hook_target=None, local=False,
 
3539
             merge_tags_to_master=True):
 
3540
        """See Branch.pull.
 
3541
 
 
3542
        This function is the core worker, used by GenericInterBranch.pull to
 
3543
        avoid duplication when pulling source->master and source->local.
 
3544
 
 
3545
        :param _hook_master: Private parameter - set the branch to
 
3546
            be supplied as the master to pull hooks.
3180
3547
        :param run_hooks: Private parameter - if false, this branch
3181
3548
            is being called because it's the master of the primary branch,
3182
3549
            so it should not run its hooks.
 
3550
            is being called because it's the master of the primary branch,
 
3551
            so it should not run its hooks.
 
3552
        :param _override_hook_target: Private parameter - set the branch to be
 
3553
            supplied as the target_branch to pull hooks.
 
3554
        :param local: Only update the local branch, and not the bound branch.
3183
3555
        """
3184
 
        bound_location = self.target.get_bound_location()
3185
 
        if local and not bound_location:
 
3556
        # This type of branch can't be bound.
 
3557
        if local:
3186
3558
            raise errors.LocalRequiresBoundBranch()
3187
 
        master_branch = None
3188
 
        if not local and bound_location and self.source.base != bound_location:
3189
 
            # not pulling from master, so we need to update master.
3190
 
            master_branch = self.target.get_master_branch(possible_transports)
3191
 
            master_branch.lock_write()
 
3559
        result = PullResult()
 
3560
        result.source_branch = self.source
 
3561
        if _override_hook_target is None:
 
3562
            result.target_branch = self.target
 
3563
        else:
 
3564
            result.target_branch = _override_hook_target
 
3565
        self.source.lock_read()
3192
3566
        try:
3193
 
            if master_branch:
3194
 
                # pull from source into master.
3195
 
                master_branch.pull(self.source, overwrite, stop_revision,
3196
 
                    run_hooks=False)
3197
 
            return super(InterToBranch5, self).pull(overwrite,
3198
 
                stop_revision, _hook_master=master_branch,
3199
 
                run_hooks=run_hooks,
3200
 
                _override_hook_target=_override_hook_target)
 
3567
            # We assume that during 'pull' the target repository is closer than
 
3568
            # the source one.
 
3569
            self.source.update_references(self.target)
 
3570
            graph = self.target.repository.get_graph(self.source.repository)
 
3571
            # TODO: Branch formats should have a flag that indicates 
 
3572
            # that revno's are expensive, and pull() should honor that flag.
 
3573
            # -- JRV20090506
 
3574
            result.old_revno, result.old_revid = \
 
3575
                self.target.last_revision_info()
 
3576
            self.target.update_revisions(self.source, stop_revision,
 
3577
                overwrite=overwrite, graph=graph)
 
3578
            # TODO: The old revid should be specified when merging tags, 
 
3579
            # so a tags implementation that versions tags can only 
 
3580
            # pull in the most recent changes. -- JRV20090506
 
3581
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3582
                overwrite, ignore_master=not merge_tags_to_master)
 
3583
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3584
            if _hook_master:
 
3585
                result.master_branch = _hook_master
 
3586
                result.local_branch = result.target_branch
 
3587
            else:
 
3588
                result.master_branch = result.target_branch
 
3589
                result.local_branch = None
 
3590
            if run_hooks:
 
3591
                for hook in Branch.hooks['post_pull']:
 
3592
                    hook(result)
3201
3593
        finally:
3202
 
            if master_branch:
3203
 
                master_branch.unlock()
 
3594
            self.source.unlock()
 
3595
        return result
3204
3596
 
3205
3597
 
3206
3598
InterBranch.register_optimiser(GenericInterBranch)
3207
 
InterBranch.register_optimiser(InterToBranch5)