~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-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
24
24
from bzrlib import (
25
25
        bzrdir,
26
26
        cache_utf8,
 
27
        cleanup,
27
28
        config as _mod_config,
28
29
        debug,
29
30
        errors,
 
31
        fetch,
 
32
        graph as _mod_graph,
30
33
        lockdir,
31
34
        lockable_files,
 
35
        remote,
32
36
        repository,
33
37
        revision as _mod_revision,
34
38
        rio,
35
 
        symbol_versioning,
36
39
        transport,
37
 
        tsort,
38
40
        ui,
39
41
        urlutils,
40
42
        )
41
43
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
44
from bzrlib.tag import (
44
45
    BasicTags,
45
46
    DisabledTags,
46
47
    )
47
48
""")
48
49
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
50
from bzrlib import (
 
51
    controldir,
 
52
    )
 
53
from bzrlib.decorators import (
 
54
    needs_read_lock,
 
55
    needs_write_lock,
 
56
    only_raises,
 
57
    )
 
58
from bzrlib.hooks import Hooks
51
59
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
60
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
61
from bzrlib import registry
54
62
from bzrlib.symbol_versioning import (
55
63
    deprecated_in,
58
66
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
59
67
 
60
68
 
61
 
BZR_BRANCH_FORMAT_4 = "Bazaar-NG branch, format 0.0.4\n"
62
 
BZR_BRANCH_FORMAT_5 = "Bazaar-NG branch, format 5\n"
63
 
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
 
 
65
 
 
66
 
class Branch(bzrdir.ControlComponent):
 
69
class Branch(controldir.ControlComponent):
67
70
    """Branch holding a history of revisions.
68
71
 
69
72
    :ivar base:
70
73
        Base directory/url of the branch; using control_url and
71
74
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
75
    :ivar hooks: An instance of BranchHooks.
 
76
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
77
        _clear_cached_state.
74
78
    """
75
79
    # this is really an instance variable - FIXME move it there
76
80
    # - RBC 20060112
90
94
        self._revision_id_to_revno_cache = None
91
95
        self._partial_revision_id_to_revno_cache = {}
92
96
        self._partial_revision_history_cache = []
 
97
        self._tags_bytes = None
93
98
        self._last_revision_info_cache = None
 
99
        self._master_branch_cache = None
94
100
        self._merge_sorted_revisions_cache = None
95
101
        self._open_hook()
96
102
        hooks = Branch.hooks['open']
102
108
 
103
109
    def _activate_fallback_location(self, url):
104
110
        """Activate the branch/repository from url as a fallback repository."""
 
111
        for existing_fallback_repo in self.repository._fallback_repositories:
 
112
            if existing_fallback_repo.user_url == url:
 
113
                # This fallback is already configured.  This probably only
 
114
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
115
                # confusing _unstack we don't add this a second time.
 
116
                mutter('duplicate activation of fallback %r on %r', url, self)
 
117
                return
105
118
        repo = self._get_fallback_repository(url)
106
119
        if repo.has_same_location(self.repository):
107
120
            raise errors.UnstackableLocationError(self.user_url, url)
197
210
        return self.supports_tags() and self.tags.get_tag_dict()
198
211
 
199
212
    def get_config(self):
 
213
        """Get a bzrlib.config.BranchConfig for this Branch.
 
214
 
 
215
        This can then be used to get and set configuration options for the
 
216
        branch.
 
217
 
 
218
        :return: A bzrlib.config.BranchConfig.
 
219
        """
200
220
        return BranchConfig(self)
201
221
 
202
222
    def _get_config(self):
218
238
            possible_transports=[self.bzrdir.root_transport])
219
239
        return a_branch.repository
220
240
 
 
241
    @needs_read_lock
221
242
    def _get_tags_bytes(self):
222
243
        """Get the bytes of a serialised tags dict.
223
244
 
230
251
        :return: The bytes of the tags file.
231
252
        :seealso: Branch._set_tags_bytes.
232
253
        """
233
 
        return self._transport.get_bytes('tags')
 
254
        if self._tags_bytes is None:
 
255
            self._tags_bytes = self._transport.get_bytes('tags')
 
256
        return self._tags_bytes
234
257
 
235
258
    def _get_nick(self, local=False, possible_transports=None):
236
259
        config = self.get_config()
238
261
        if not local and not config.has_explicit_nickname():
239
262
            try:
240
263
                master = self.get_master_branch(possible_transports)
 
264
                if master and self.user_url == master.user_url:
 
265
                    raise errors.RecursiveBind(self.user_url)
241
266
                if master is not None:
242
267
                    # return the master branch value
243
268
                    return master.nick
 
269
            except errors.RecursiveBind, e:
 
270
                raise e
244
271
            except errors.BzrError, e:
245
272
                # Silently fall back to local implicit nick if the master is
246
273
                # unavailable
283
310
        new_history.reverse()
284
311
        return new_history
285
312
 
286
 
    def lock_write(self):
 
313
    def lock_write(self, token=None):
 
314
        """Lock the branch for write operations.
 
315
 
 
316
        :param token: A token to permit reacquiring a previously held and
 
317
            preserved lock.
 
318
        :return: A BranchWriteLockResult.
 
319
        """
287
320
        raise NotImplementedError(self.lock_write)
288
321
 
289
322
    def lock_read(self):
 
323
        """Lock the branch for read operations.
 
324
 
 
325
        :return: A bzrlib.lock.LogicalLockResult.
 
326
        """
290
327
        raise NotImplementedError(self.lock_read)
291
328
 
292
329
    def unlock(self):
413
450
            after. If None, the rest of history is included.
414
451
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
452
            to use for termination:
 
453
 
416
454
            * 'exclude' - leave the stop revision out of the result (default)
417
455
            * 'include' - the stop revision is the last item in the result
418
456
            * 'with-merges' - include the stop revision and all of its
420
458
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
459
              that are in both ancestries
422
460
        :param direction: either 'reverse' or 'forward':
 
461
 
423
462
            * reverse means return the start_revision_id first, i.e.
424
463
              start at the most recent revision and go backwards in history
425
464
            * forward returns tuples in the opposite order to reverse.
469
508
        rev_iter = iter(merge_sorted_revisions)
470
509
        if start_revision_id is not None:
471
510
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
511
                rev_id = node.key
473
512
                if rev_id != start_revision_id:
474
513
                    continue
475
514
                else:
481
520
        if stop_revision_id is None:
482
521
            # Yield everything
483
522
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
 
523
                rev_id = node.key
485
524
                yield (rev_id, node.merge_depth, node.revno,
486
525
                       node.end_of_merge)
487
526
        elif stop_rule == 'exclude':
488
527
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
528
                rev_id = node.key
490
529
                if rev_id == stop_revision_id:
491
530
                    return
492
531
                yield (rev_id, node.merge_depth, node.revno,
493
532
                       node.end_of_merge)
494
533
        elif stop_rule == 'include':
495
534
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
 
535
                rev_id = node.key
497
536
                yield (rev_id, node.merge_depth, node.revno,
498
537
                       node.end_of_merge)
499
538
                if rev_id == stop_revision_id:
505
544
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
545
                                                    [stop_revision_id])
507
546
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
 
547
                rev_id = node.key
509
548
                if rev_id not in ancestors:
510
549
                    continue
511
550
                yield (rev_id, node.merge_depth, node.revno,
521
560
            reached_stop_revision_id = False
522
561
            revision_id_whitelist = []
523
562
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
563
                rev_id = node.key
525
564
                if rev_id == left_parent:
526
565
                    # reached the left parent after the stop_revision
527
566
                    return
626
665
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
666
 
628
667
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
668
    def fetch(self, from_branch, last_revision=None, limit=None):
630
669
        """Copy revisions from from_branch into this branch.
631
670
 
632
671
        :param from_branch: Where to copy from.
633
672
        :param last_revision: What revision to stop at (None for at the end
634
673
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
674
        :param limit: Optional rough limit of revisions to fetch
636
675
        :return: None
637
676
        """
638
 
        if self.base == from_branch.base:
639
 
            return (0, [])
640
 
        if pb is not None:
641
 
            symbol_versioning.warn(
642
 
                symbol_versioning.deprecated_in((1, 14, 0))
643
 
                % "pb parameter to fetch()")
644
 
        from_branch.lock_read()
645
 
        try:
646
 
            if last_revision is None:
647
 
                last_revision = from_branch.last_revision()
648
 
                last_revision = _mod_revision.ensure_null(last_revision)
649
 
            return self.repository.fetch(from_branch.repository,
650
 
                                         revision_id=last_revision,
651
 
                                         pb=pb)
652
 
        finally:
653
 
            from_branch.unlock()
 
677
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
678
 
655
679
    def get_bound_location(self):
656
680
        """Return the URL of the branch we are bound to.
667
691
 
668
692
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
693
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
694
                           revision_id=None, lossy=False):
671
695
        """Obtain a CommitBuilder for this branch.
672
696
 
673
697
        :param parents: Revision ids of the parents of the new revision.
677
701
        :param committer: Optional committer to set for commit.
678
702
        :param revprops: Optional dictionary of revision properties.
679
703
        :param revision_id: Optional revision id.
 
704
        :param lossy: Whether to discard data that can not be natively
 
705
            represented, when pushing to a foreign VCS 
680
706
        """
681
707
 
682
708
        if config is None:
683
709
            config = self.get_config()
684
710
 
685
711
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
712
            timestamp, timezone, committer, revprops, revision_id,
 
713
            lossy)
687
714
 
688
715
    def get_master_branch(self, possible_transports=None):
689
716
        """Return the branch we are bound to.
716
743
        """Print `file` to stdout."""
717
744
        raise NotImplementedError(self.print_file)
718
745
 
 
746
    @deprecated_method(deprecated_in((2, 4, 0)))
719
747
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
748
        """See Branch.set_revision_history."""
 
749
        self._set_revision_history(rev_history)
 
750
 
 
751
    @needs_write_lock
 
752
    def _set_revision_history(self, rev_history):
 
753
        if len(rev_history) == 0:
 
754
            revid = _mod_revision.NULL_REVISION
 
755
        else:
 
756
            revid = rev_history[-1]
 
757
        if rev_history != self._lefthand_history(revid):
 
758
            raise errors.NotLefthandHistory(rev_history)
 
759
        self.set_last_revision_info(len(rev_history), revid)
 
760
        self._cache_revision_history(rev_history)
 
761
        for hook in Branch.hooks['set_rh']:
 
762
            hook(self, rev_history)
 
763
 
 
764
    @needs_write_lock
 
765
    def set_last_revision_info(self, revno, revision_id):
 
766
        """Set the last revision of this branch.
 
767
 
 
768
        The caller is responsible for checking that the revno is correct
 
769
        for this revision id.
 
770
 
 
771
        It may be possible to set the branch last revision to an id not
 
772
        present in the repository.  However, branches can also be
 
773
        configured to check constraints on history, in which case this may not
 
774
        be permitted.
 
775
        """
 
776
        raise NotImplementedError(self.set_last_revision_info)
 
777
 
 
778
    @needs_write_lock
 
779
    def generate_revision_history(self, revision_id, last_rev=None,
 
780
                                  other_branch=None):
 
781
        """See Branch.generate_revision_history"""
 
782
        graph = self.repository.get_graph()
 
783
        (last_revno, last_revid) = self.last_revision_info()
 
784
        known_revision_ids = [
 
785
            (last_revid, last_revno),
 
786
            (_mod_revision.NULL_REVISION, 0),
 
787
            ]
 
788
        if last_rev is not None:
 
789
            if not graph.is_ancestor(last_rev, revision_id):
 
790
                # our previous tip is not merged into stop_revision
 
791
                raise errors.DivergedBranches(self, other_branch)
 
792
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
793
        self.set_last_revision_info(revno, revision_id)
721
794
 
722
795
    @needs_write_lock
723
796
    def set_parent(self, url):
767
840
 
768
841
    def _unstack(self):
769
842
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
843
 
771
844
        Don't call this directly, use set_stacked_on_url(None).
772
845
        """
773
846
        pb = ui.ui_factory.nested_progress_bar()
782
855
            old_repository = self.repository
783
856
            if len(old_repository._fallback_repositories) != 1:
784
857
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
858
                    "of %r (fallbacks: %r)" % (old_repository,
 
859
                        old_repository._fallback_repositories))
 
860
            # Open the new repository object.
 
861
            # Repositories don't offer an interface to remove fallback
 
862
            # repositories today; take the conceptually simpler option and just
 
863
            # reopen it.  We reopen it starting from the URL so that we
 
864
            # get a separate connection for RemoteRepositories and can
 
865
            # stream from one of them to the other.  This does mean doing
 
866
            # separate SSH connection setup, but unstacking is not a
 
867
            # common operation so it's tolerable.
 
868
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
869
            new_repository = new_bzrdir.find_repository()
 
870
            if new_repository._fallback_repositories:
 
871
                raise AssertionError("didn't expect %r to have "
 
872
                    "fallback_repositories"
 
873
                    % (self.repository,))
 
874
            # Replace self.repository with the new repository.
 
875
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
876
            # lock count) of self.repository to the new repository.
 
877
            lock_token = old_repository.lock_write().repository_token
 
878
            self.repository = new_repository
 
879
            if isinstance(self, remote.RemoteBranch):
 
880
                # Remote branches can have a second reference to the old
 
881
                # repository that need to be replaced.
 
882
                if self._real_branch is not None:
 
883
                    self._real_branch.repository = new_repository
 
884
            self.repository.lock_write(token=lock_token)
 
885
            if lock_token is not None:
 
886
                old_repository.leave_lock_in_place()
787
887
            old_repository.unlock()
 
888
            if lock_token is not None:
 
889
                # XXX: self.repository.leave_lock_in_place() before this
 
890
                # function will not be preserved.  Fortunately that doesn't
 
891
                # affect the current default format (2a), and would be a
 
892
                # corner-case anyway.
 
893
                #  - Andrew Bennetts, 2010/06/30
 
894
                self.repository.dont_leave_lock_in_place()
 
895
            old_lock_count = 0
 
896
            while True:
 
897
                try:
 
898
                    old_repository.unlock()
 
899
                except errors.LockNotHeld:
 
900
                    break
 
901
                old_lock_count += 1
 
902
            if old_lock_count == 0:
 
903
                raise AssertionError(
 
904
                    'old_repository should have been locked at least once.')
 
905
            for i in range(old_lock_count-1):
 
906
                self.repository.lock_write()
 
907
            # Fetch from the old repository into the new.
788
908
            old_repository.lock_read()
789
909
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
910
                # XXX: If you unstack a branch while it has a working tree
809
911
                # with a pending merge, the pending-merged revisions will no
810
912
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
 
913
                try:
 
914
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
915
                except errors.TagsNotSupported:
 
916
                    tags_to_fetch = set()
 
917
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
918
                    old_repository, required_ids=[self.last_revision()],
 
919
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
920
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
921
            finally:
819
922
                old_repository.unlock()
820
923
        finally:
825
928
 
826
929
        :seealso: Branch._get_tags_bytes.
827
930
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
931
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
932
        op.add_cleanup(self.lock_write().unlock)
 
933
        return op.run_simple(bytes)
 
934
 
 
935
    def _set_tags_bytes_locked(self, bytes):
 
936
        self._tags_bytes = bytes
 
937
        return self._transport.put_bytes('tags', bytes)
830
938
 
831
939
    def _cache_revision_history(self, rev_history):
832
940
        """Set the cached revision history to rev_history.
859
967
        self._revision_history_cache = None
860
968
        self._revision_id_to_revno_cache = None
861
969
        self._last_revision_info_cache = None
 
970
        self._master_branch_cache = None
862
971
        self._merge_sorted_revisions_cache = None
863
972
        self._partial_revision_history_cache = []
864
973
        self._partial_revision_id_to_revno_cache = {}
 
974
        self._tags_bytes = None
865
975
 
866
976
    def _gen_revision_history(self):
867
977
        """Return sequence of revision hashes on to this branch.
917
1027
        :return: A tuple (revno, revision_id).
918
1028
        """
919
1029
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1030
            self._last_revision_info_cache = self._read_last_revision_info()
921
1031
        return self._last_revision_info_cache
922
1032
 
923
 
    def _last_revision_info(self):
924
 
        rh = self.revision_history()
925
 
        revno = len(rh)
926
 
        if revno:
927
 
            return (revno, rh[-1])
928
 
        else:
929
 
            return (0, _mod_revision.NULL_REVISION)
930
 
 
931
 
    @deprecated_method(deprecated_in((1, 6, 0)))
932
 
    def missing_revisions(self, other, stop_revision=None):
933
 
        """Return a list of new revisions that would perfectly fit.
934
 
 
935
 
        If self and other have not diverged, return a list of the revisions
936
 
        present in other, but missing from self.
937
 
        """
938
 
        self_history = self.revision_history()
939
 
        self_len = len(self_history)
940
 
        other_history = other.revision_history()
941
 
        other_len = len(other_history)
942
 
        common_index = min(self_len, other_len) -1
943
 
        if common_index >= 0 and \
944
 
            self_history[common_index] != other_history[common_index]:
945
 
            raise errors.DivergedBranches(self, other)
946
 
 
947
 
        if stop_revision is None:
948
 
            stop_revision = other_len
949
 
        else:
950
 
            if stop_revision > other_len:
951
 
                raise errors.NoSuchRevision(self, stop_revision)
952
 
        return other_history[self_len:stop_revision]
953
 
 
954
 
    @needs_write_lock
955
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
957
 
        """Pull in new perfect-fit revisions.
958
 
 
959
 
        :param other: Another Branch to pull from
960
 
        :param stop_revision: Updated until the given revision
961
 
        :param overwrite: Always set the branch pointer, rather than checking
962
 
            to see if it is a proper descendant.
963
 
        :param graph: A Graph object that can be used to query history
964
 
            information. This can be None.
965
 
        :return: None
966
 
        """
967
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
969
 
 
 
1033
    def _read_last_revision_info(self):
 
1034
        raise NotImplementedError(self._read_last_revision_info)
 
1035
 
 
1036
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1037
    def import_last_revision_info(self, source_repo, revno, revid):
971
1038
        """Set the last revision info, importing from another repo if necessary.
972
1039
 
973
 
        This is used by the bound branch code to upload a revision to
974
 
        the master branch first before updating the tip of the local branch.
975
 
 
976
1040
        :param source_repo: Source repository to optionally fetch from
977
1041
        :param revno: Revision number of the new tip
978
1042
        :param revid: Revision id of the new tip
981
1045
            self.repository.fetch(source_repo, revision_id=revid)
982
1046
        self.set_last_revision_info(revno, revid)
983
1047
 
 
1048
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1049
                                           lossy=False):
 
1050
        """Set the last revision info, importing from another repo if necessary.
 
1051
 
 
1052
        This is used by the bound branch code to upload a revision to
 
1053
        the master branch first before updating the tip of the local branch.
 
1054
        Revisions referenced by source's tags are also transferred.
 
1055
 
 
1056
        :param source: Source branch to optionally fetch from
 
1057
        :param revno: Revision number of the new tip
 
1058
        :param revid: Revision id of the new tip
 
1059
        :param lossy: Whether to discard metadata that can not be
 
1060
            natively represented
 
1061
        :return: Tuple with the new revision number and revision id
 
1062
            (should only be different from the arguments when lossy=True)
 
1063
        """
 
1064
        if not self.repository.has_same_location(source.repository):
 
1065
            self.fetch(source, revid)
 
1066
        self.set_last_revision_info(revno, revid)
 
1067
        return (revno, revid)
 
1068
 
984
1069
    def revision_id_to_revno(self, revision_id):
985
1070
        """Given a revision id, return its revno"""
986
1071
        if _mod_revision.is_null(revision_id):
1006
1091
            self._extend_partial_history(distance_from_last)
1007
1092
        return self._partial_revision_history_cache[distance_from_last]
1008
1093
 
1009
 
    @needs_write_lock
1010
1094
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1095
             possible_transports=None, *args, **kwargs):
1012
1096
        """Mirror source into this branch.
1019
1103
            stop_revision=stop_revision,
1020
1104
            possible_transports=possible_transports, *args, **kwargs)
1021
1105
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1106
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1107
            *args, **kwargs):
1024
1108
        """Mirror this branch into target.
1025
1109
 
1026
1110
        This branch is considered to be 'local', having low latency.
1027
1111
        """
1028
1112
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
1113
            lossy, *args, **kwargs)
1051
1114
 
1052
1115
    def basis_tree(self):
1053
1116
        """Return `Tree` object for last revision."""
1208
1271
        return result
1209
1272
 
1210
1273
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1274
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1275
            repository=None):
1212
1276
        """Create a new line of development from the branch, into to_bzrdir.
1213
1277
 
1214
1278
        to_bzrdir controls the branch format.
1219
1283
        if (repository_policy is not None and
1220
1284
            repository_policy.requires_stacking()):
1221
1285
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1286
        result = to_bzrdir.create_branch(repository=repository)
1223
1287
        result.lock_write()
1224
1288
        try:
1225
1289
            if repository_policy is not None:
1226
1290
                repository_policy.configure_branch(result)
1227
1291
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1292
            master_url = self.get_bound_location()
 
1293
            if master_url is None:
 
1294
                result.set_parent(self.bzrdir.root_transport.base)
 
1295
            else:
 
1296
                result.set_parent(master_url)
1229
1297
        finally:
1230
1298
            result.unlock()
1231
1299
        return result
1255
1323
                revno = 1
1256
1324
        destination.set_last_revision_info(revno, revision_id)
1257
1325
 
1258
 
    @needs_read_lock
1259
1326
    def copy_content_into(self, destination, revision_id=None):
1260
1327
        """Copy the content of self into destination.
1261
1328
 
1262
1329
        revision_id: if not None, the revision history in the new branch will
1263
1330
                     be truncated to end with revision_id.
1264
1331
        """
1265
 
        self.update_references(destination)
1266
 
        self._synchronize_history(destination, revision_id)
1267
 
        try:
1268
 
            parent = self.get_parent()
1269
 
        except errors.InaccessibleParent, e:
1270
 
            mutter('parent was not accessible to copy: %s', e)
1271
 
        else:
1272
 
            if parent:
1273
 
                destination.set_parent(parent)
1274
 
        if self._push_should_merge_tags():
1275
 
            self.tags.merge_to(destination.tags)
 
1332
        return InterBranch.get(self, destination).copy_content_into(
 
1333
            revision_id=revision_id)
1276
1334
 
1277
1335
    def update_references(self, target):
1278
1336
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1381
        """Return the most suitable metadir for a checkout of this branch.
1324
1382
        Weaves are used if this branch's repository uses weaves.
1325
1383
        """
1326
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1327
 
            from bzrlib.repofmt import weaverepo
1328
 
            format = bzrdir.BzrDirMetaFormat1()
1329
 
            format.repository_format = weaverepo.RepositoryFormat7()
1330
 
        else:
1331
 
            format = self.repository.bzrdir.checkout_metadir()
1332
 
            format.set_branch_format(self._format)
 
1384
        format = self.repository.bzrdir.checkout_metadir()
 
1385
        format.set_branch_format(self._format)
1333
1386
        return format
1334
1387
 
1335
1388
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1389
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1390
        no_tree=None):
1337
1391
        """Create a clone of this branch and its bzrdir.
1338
1392
 
1339
1393
        :param to_transport: The transport to clone onto.
1346
1400
        """
1347
1401
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1402
        # clone call. Or something. 20090224 RBC/spiv.
 
1403
        # XXX: Should this perhaps clone colocated branches as well, 
 
1404
        # rather than just the default branch? 20100319 JRV
1349
1405
        if revision_id is None:
1350
1406
            revision_id = self.last_revision()
1351
1407
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1408
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1409
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1410
            no_tree=no_tree)
1354
1411
        return dir_to.open_branch()
1355
1412
 
1356
1413
    def create_checkout(self, to_location, revision_id=None,
1361
1418
        :param to_location: The url to produce the checkout at
1362
1419
        :param revision_id: The revision to check out
1363
1420
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1421
            produce a bound branch (heavyweight checkout)
1365
1422
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1423
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1424
            The revision tree will be used for cases where accelerator_tree's
1413
1470
 
1414
1471
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1472
        """Return the parent branch for a tree-reference file_id
 
1473
 
1416
1474
        :param file_id: The file_id of the tree reference
1417
1475
        :param path: The path of the file_id in the tree
1418
1476
        :return: A branch associated with the file_id
1471
1529
        else:
1472
1530
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1531
 
1474
 
 
1475
 
class BranchFormat(object):
 
1532
    def heads_to_fetch(self):
 
1533
        """Return the heads that must and that should be fetched to copy this
 
1534
        branch into another repo.
 
1535
 
 
1536
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1537
            set of heads that must be fetched.  if_present_fetch is a set of
 
1538
            heads that must be fetched if present, but no error is necessary if
 
1539
            they are not present.
 
1540
        """
 
1541
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1542
        # are the tags.
 
1543
        must_fetch = set([self.last_revision()])
 
1544
        if_present_fetch = set()
 
1545
        c = self.get_config()
 
1546
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1547
                                                 default=False)
 
1548
        if include_tags:
 
1549
            try:
 
1550
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1551
            except errors.TagsNotSupported:
 
1552
                pass
 
1553
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1554
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1555
        return must_fetch, if_present_fetch
 
1556
 
 
1557
 
 
1558
class BranchFormat(controldir.ControlComponentFormat):
1476
1559
    """An encapsulation of the initialization and open routines for a format.
1477
1560
 
1478
1561
    Formats provide three things:
1481
1564
     * an open routine.
1482
1565
 
1483
1566
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1567
    during branch opening. It's not required that these be instances, they
1485
1568
    can be classes themselves with class methods - it simply depends on
1486
1569
    whether state is needed for a given format or not.
1487
1570
 
1490
1573
    object will be created every time regardless.
1491
1574
    """
1492
1575
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1576
    can_set_append_revisions_only = True
1500
1577
 
1501
1578
    def __eq__(self, other):
1510
1587
        try:
1511
1588
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1589
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1590
            return format_registry.get(format_string)
1514
1591
        except errors.NoSuchFile:
1515
1592
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1593
        except KeyError:
1517
1594
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1595
 
1519
1596
    @classmethod
 
1597
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1598
    def get_default_format(klass):
1521
1599
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1600
        return format_registry.get_default()
 
1601
 
 
1602
    @classmethod
 
1603
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1604
    def get_formats(klass):
 
1605
        """Get all the known formats.
 
1606
 
 
1607
        Warning: This triggers a load of all lazy registered formats: do not
 
1608
        use except when that is desireed.
 
1609
        """
 
1610
        return format_registry._get_all()
 
1611
 
 
1612
    def get_reference(self, a_bzrdir, name=None):
1525
1613
        """Get the target reference of the branch in a_bzrdir.
1526
1614
 
1527
1615
        format probing must have been completed before calling
1529
1617
        in a_bzrdir is correct.
1530
1618
 
1531
1619
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1620
        :param name: Name of the colocated branch to fetch
1532
1621
        :return: None if the branch is not a reference branch.
1533
1622
        """
1534
1623
        return None
1535
1624
 
1536
1625
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1626
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1627
        """Set the target reference of the branch in a_bzrdir.
1539
1628
 
1540
1629
        format probing must have been completed before calling
1542
1631
        in a_bzrdir is correct.
1543
1632
 
1544
1633
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1634
        :param name: Name of colocated branch to set, None for default
1545
1635
        :param to_branch: branch that the checkout is to reference
1546
1636
        """
1547
1637
        raise NotImplementedError(self.set_reference)
1562
1652
        for hook in hooks:
1563
1653
            hook(params)
1564
1654
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
1567
 
        """Initialize a branch in a bzrdir, with specified files
1568
 
 
1569
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
 
        :param utf8_files: The files to create as a list of
1571
 
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
 
        :param set_format: If True, set the format with
1574
 
            self.get_format_string.  (BzrBranch4 has its format set
1575
 
            elsewhere)
1576
 
        :return: a branch in this format
1577
 
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1580
 
        lock_map = {
1581
 
            'metadir': ('lock', lockdir.LockDir),
1582
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1583
 
        }
1584
 
        lock_name, lock_class = lock_map[lock_type]
1585
 
        control_files = lockable_files.LockableFiles(branch_transport,
1586
 
            lock_name, lock_class)
1587
 
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
1596
 
        if set_format:
1597
 
            utf8_files += [('format', self.get_format_string())]
1598
 
        try:
1599
 
            for (filename, content) in utf8_files:
1600
 
                branch_transport.put_bytes(
1601
 
                    filename, content,
1602
 
                    mode=a_bzrdir._get_file_mode())
1603
 
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
1609
 
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1655
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1656
        """Create a branch of this format in a_bzrdir.
1612
1657
        
1613
1658
        :param name: Name of the colocated branch to create.
1647
1692
        """
1648
1693
        raise NotImplementedError(self.network_name)
1649
1694
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1695
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1696
            found_repository=None):
1651
1697
        """Return the branch object for a_bzrdir
1652
1698
 
1653
1699
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1706
        raise NotImplementedError(self.open)
1661
1707
 
1662
1708
    @classmethod
 
1709
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1710
    def register_format(klass, format):
1664
 
        """Register a metadir format."""
1665
 
        klass._formats[format.get_format_string()] = format
1666
 
        # Metadir formats have a network name of their format string, and get
1667
 
        # registered as class factories.
1668
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1711
        """Register a metadir format.
 
1712
 
 
1713
        See MetaDirBranchFormatFactory for the ability to register a format
 
1714
        without loading the code the format needs until it is actually used.
 
1715
        """
 
1716
        format_registry.register(format)
1669
1717
 
1670
1718
    @classmethod
 
1719
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1720
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1721
        format_registry.set_default(format)
1673
1722
 
1674
1723
    def supports_set_append_revisions_only(self):
1675
1724
        """True if this format supports set_append_revisions_only."""
1679
1728
        """True if this format records a stacked-on branch."""
1680
1729
        return False
1681
1730
 
 
1731
    def supports_leaving_lock(self):
 
1732
        """True if this format supports leaving locks in place."""
 
1733
        return False # by default
 
1734
 
1682
1735
    @classmethod
 
1736
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1737
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1738
        format_registry.remove(format)
1685
1739
 
1686
1740
    def __str__(self):
1687
1741
        return self.get_format_description().rstrip()
1691
1745
        return False  # by default
1692
1746
 
1693
1747
 
 
1748
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1749
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1750
    
 
1751
    While none of the built in BranchFormats are lazy registered yet,
 
1752
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1753
    use it, and the bzr-loom plugin uses it as well (see
 
1754
    bzrlib.plugins.loom.formats).
 
1755
    """
 
1756
 
 
1757
    def __init__(self, format_string, module_name, member_name):
 
1758
        """Create a MetaDirBranchFormatFactory.
 
1759
 
 
1760
        :param format_string: The format string the format has.
 
1761
        :param module_name: Module to load the format class from.
 
1762
        :param member_name: Attribute name within the module for the format class.
 
1763
        """
 
1764
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1765
        self._format_string = format_string
 
1766
        
 
1767
    def get_format_string(self):
 
1768
        """See BranchFormat.get_format_string."""
 
1769
        return self._format_string
 
1770
 
 
1771
    def __call__(self):
 
1772
        """Used for network_format_registry support."""
 
1773
        return self.get_obj()()
 
1774
 
 
1775
 
1694
1776
class BranchHooks(Hooks):
1695
1777
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1778
 
1704
1786
        These are all empty initially, because by default nothing should get
1705
1787
        notified.
1706
1788
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1789
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1790
        self.add_hook('set_rh',
1709
1791
            "Invoked whenever the revision history has been set via "
1710
1792
            "set_revision_history. The api signature is (branch, "
1711
1793
            "revision_history), and the branch will be write-locked. "
1712
1794
            "The set_rh hook can be expensive for bzr to trigger, a better "
1713
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1714
 
        self.create_hook(HookPoint('open',
 
1795
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1796
        self.add_hook('open',
1715
1797
            "Called with the Branch object that has been opened after a "
1716
 
            "branch is opened.", (1, 8), None))
1717
 
        self.create_hook(HookPoint('post_push',
 
1798
            "branch is opened.", (1, 8))
 
1799
        self.add_hook('post_push',
1718
1800
            "Called after a push operation completes. post_push is called "
1719
1801
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1802
            "bzr client.", (0, 15))
 
1803
        self.add_hook('post_pull',
1722
1804
            "Called after a pull operation completes. post_pull is called "
1723
1805
            "with a bzrlib.branch.PullResult object and only runs in the "
1724
 
            "bzr client.", (0, 15), None))
1725
 
        self.create_hook(HookPoint('pre_commit',
1726
 
            "Called after a commit is calculated but before it is is "
 
1806
            "bzr client.", (0, 15))
 
1807
        self.add_hook('pre_commit',
 
1808
            "Called after a commit is calculated but before it is "
1727
1809
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1810
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1811
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1813
            "basis revision. hooks MUST NOT modify this delta. "
1732
1814
            " future_tree is an in-memory tree obtained from "
1733
1815
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1816
            "tree.", (0,91))
 
1817
        self.add_hook('post_commit',
1736
1818
            "Called in the bzr client after a commit has completed. "
1737
1819
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1820
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1739
 
            "commit to a branch.", (0, 15), None))
1740
 
        self.create_hook(HookPoint('post_uncommit',
 
1821
            "commit to a branch.", (0, 15))
 
1822
        self.add_hook('post_uncommit',
1741
1823
            "Called in the bzr client after an uncommit completes. "
1742
1824
            "post_uncommit is called with (local, master, old_revno, "
1743
1825
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1826
            "or None, master is the target branch, and an empty branch "
1745
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1746
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1827
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1828
        self.add_hook('pre_change_branch_tip',
1747
1829
            "Called in bzr client and server before a change to the tip of a "
1748
1830
            "branch is made. pre_change_branch_tip is called with a "
1749
1831
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1750
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1751
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1832
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1833
        self.add_hook('post_change_branch_tip',
1752
1834
            "Called in bzr client and server after a change to the tip of a "
1753
1835
            "branch is made. post_change_branch_tip is called with a "
1754
1836
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1755
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1756
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1837
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1838
        self.add_hook('transform_fallback_location',
1757
1839
            "Called when a stacked branch is activating its fallback "
1758
1840
            "locations. transform_fallback_location is called with (branch, "
1759
1841
            "url), and should return a new url. Returning the same url "
1764
1846
            "fallback locations have not been activated. When there are "
1765
1847
            "multiple hooks installed for transform_fallback_location, "
1766
1848
            "all are called with the url returned from the previous hook."
1767
 
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
 
1849
            "The order is however undefined.", (1, 9))
 
1850
        self.add_hook('automatic_tag_name',
 
1851
            "Called to determine an automatic tag name for a revision. "
1770
1852
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1853
            "should return a tag name or None if no tag name could be "
1772
1854
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1855
            (2, 2))
 
1856
        self.add_hook('post_branch_init',
1775
1857
            "Called after new branch initialization completes. "
1776
1858
            "post_branch_init is called with a "
1777
1859
            "bzrlib.branch.BranchInitHookParams. "
1778
1860
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
 
1861
            "lightweight) will all trigger this hook.", (2, 2))
 
1862
        self.add_hook('post_switch',
1781
1863
            "Called after a checkout switches branch. "
1782
1864
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1865
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1866
 
1785
1867
 
1786
1868
 
1789
1871
 
1790
1872
 
1791
1873
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1874
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1875
 
1794
1876
    There are 5 fields that hooks may wish to access:
1795
1877
 
1827
1909
 
1828
1910
 
1829
1911
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1912
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1913
 
1832
1914
    There are 4 fields that hooks may wish to access:
1833
1915
 
1863
1945
        return self.__dict__ == other.__dict__
1864
1946
 
1865
1947
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
 
1948
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1949
 
1873
1950
 
1874
1951
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1952
    """Object holding parameters passed to `*_switch` hooks.
1876
1953
 
1877
1954
    There are 4 fields that hooks may wish to access:
1878
1955
 
1904
1981
            self.revision_id)
1905
1982
 
1906
1983
 
1907
 
class BzrBranchFormat4(BranchFormat):
1908
 
    """Bzr branch format 4.
1909
 
 
1910
 
    This format has:
1911
 
     - a revision-history file.
1912
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1913
 
    """
1914
 
 
1915
 
    def get_format_description(self):
1916
 
        """See BranchFormat.get_format_description()."""
1917
 
        return "Branch format 4"
1918
 
 
1919
 
    def initialize(self, a_bzrdir, name=None):
1920
 
        """Create a branch of this format in a_bzrdir."""
1921
 
        utf8_files = [('revision-history', ''),
1922
 
                      ('branch-name', ''),
1923
 
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1925
 
                                       lock_type='branch4', set_format=False)
1926
 
 
1927
 
    def __init__(self):
1928
 
        super(BzrBranchFormat4, self).__init__()
1929
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1930
 
 
1931
 
    def network_name(self):
1932
 
        """The network name for this format is the control dirs disk label."""
1933
 
        return self._matchingbzrdir.get_format_string()
1934
 
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1936
 
        """See BranchFormat.open()."""
1937
 
        if not _found:
1938
 
            # we are being called directly and must probe.
1939
 
            raise NotImplementedError
1940
 
        return BzrBranch(_format=self,
1941
 
                         _control_files=a_bzrdir._control_files,
1942
 
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
 
                         _repository=a_bzrdir.open_repository())
1945
 
 
1946
 
    def __str__(self):
1947
 
        return "Bazaar-NG branch format 4"
1948
 
 
1949
 
 
1950
1984
class BranchFormatMetadir(BranchFormat):
1951
1985
    """Common logic for meta-dir based branch formats."""
1952
1986
 
1954
1988
        """What class to instantiate on open calls."""
1955
1989
        raise NotImplementedError(self._branch_class)
1956
1990
 
 
1991
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1992
                           repository=None):
 
1993
        """Initialize a branch in a bzrdir, with specified files
 
1994
 
 
1995
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1996
        :param utf8_files: The files to create as a list of
 
1997
            (filename, content) tuples
 
1998
        :param name: Name of colocated branch to create, if any
 
1999
        :return: a branch in this format
 
2000
        """
 
2001
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2002
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2003
        control_files = lockable_files.LockableFiles(branch_transport,
 
2004
            'lock', lockdir.LockDir)
 
2005
        control_files.create_lock()
 
2006
        control_files.lock_write()
 
2007
        try:
 
2008
            utf8_files += [('format', self.get_format_string())]
 
2009
            for (filename, content) in utf8_files:
 
2010
                branch_transport.put_bytes(
 
2011
                    filename, content,
 
2012
                    mode=a_bzrdir._get_file_mode())
 
2013
        finally:
 
2014
            control_files.unlock()
 
2015
        branch = self.open(a_bzrdir, name, _found=True,
 
2016
                found_repository=repository)
 
2017
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2018
        return branch
 
2019
 
1957
2020
    def network_name(self):
1958
2021
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2022
 
1961
2024
        """
1962
2025
        return self.get_format_string()
1963
2026
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2027
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2028
            found_repository=None):
1965
2029
        """See BranchFormat.open()."""
1966
2030
        if not _found:
1967
2031
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2036
        try:
1973
2037
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2038
                                                         lockdir.LockDir)
 
2039
            if found_repository is None:
 
2040
                found_repository = a_bzrdir.find_repository()
1975
2041
            return self._branch_class()(_format=self,
1976
2042
                              _control_files=control_files,
1977
2043
                              name=name,
1978
2044
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2045
                              _repository=found_repository,
1980
2046
                              ignore_fallbacks=ignore_fallbacks)
1981
2047
        except errors.NoSuchFile:
1982
2048
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2055
    def supports_tags(self):
1990
2056
        return True
1991
2057
 
 
2058
    def supports_leaving_lock(self):
 
2059
        return True
 
2060
 
1992
2061
 
1993
2062
class BzrBranchFormat5(BranchFormatMetadir):
1994
2063
    """Bzr branch format 5.
2014
2083
        """See BranchFormat.get_format_description()."""
2015
2084
        return "Branch format 5"
2016
2085
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2086
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2087
        """Create a branch of this format in a_bzrdir."""
2019
2088
        utf8_files = [('revision-history', ''),
2020
2089
                      ('branch-name', ''),
2021
2090
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2091
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2092
 
2024
2093
    def supports_tags(self):
2025
2094
        return False
2047
2116
        """See BranchFormat.get_format_description()."""
2048
2117
        return "Branch format 6"
2049
2118
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2119
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2120
        """Create a branch of this format in a_bzrdir."""
2052
2121
        utf8_files = [('last-revision', '0 null:\n'),
2053
2122
                      ('branch.conf', ''),
2054
2123
                      ('tags', ''),
2055
2124
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2125
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2126
 
2058
2127
    def make_tags(self, branch):
2059
2128
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2146
        """See BranchFormat.get_format_description()."""
2078
2147
        return "Branch format 8"
2079
2148
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2150
        """Create a branch of this format in a_bzrdir."""
2082
2151
        utf8_files = [('last-revision', '0 null:\n'),
2083
2152
                      ('branch.conf', ''),
2084
2153
                      ('tags', ''),
2085
2154
                      ('references', '')
2086
2155
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
 
2156
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2157
 
2094
2158
    def make_tags(self, branch):
2095
2159
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2168
    supports_reference_locations = True
2105
2169
 
2106
2170
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2171
class BzrBranchFormat7(BranchFormatMetadir):
2108
2172
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2173
 
2110
2174
    The stacked location pointer is passed down to the repository and requires
2113
2177
    This format was introduced in bzr 1.6.
2114
2178
    """
2115
2179
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2180
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2181
        """Create a branch of this format in a_bzrdir."""
2118
2182
        utf8_files = [('last-revision', '0 null:\n'),
2119
2183
                      ('branch.conf', ''),
2120
2184
                      ('tags', ''),
2121
2185
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2186
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2187
 
2124
2188
    def _branch_class(self):
2125
2189
        return BzrBranch7
2135
2199
    def supports_set_append_revisions_only(self):
2136
2200
        return True
2137
2201
 
 
2202
    def supports_stacking(self):
 
2203
        return True
 
2204
 
 
2205
    def make_tags(self, branch):
 
2206
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2207
        return BasicTags(branch)
 
2208
 
2138
2209
    supports_reference_locations = False
2139
2210
 
2140
2211
 
2157
2228
        """See BranchFormat.get_format_description()."""
2158
2229
        return "Checkout reference format 1"
2159
2230
 
2160
 
    def get_reference(self, a_bzrdir):
 
2231
    def get_reference(self, a_bzrdir, name=None):
2161
2232
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2233
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2234
        return transport.get_bytes('location')
2164
2235
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2236
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2237
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2238
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2239
        location = transport.put_bytes('location', to_branch.base)
2169
2240
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2241
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2242
            repository=None):
2171
2243
        """Create a branch of this format in a_bzrdir."""
2172
2244
        if target_branch is None:
2173
2245
            # this format does not implement branch itself, thus the implicit
2201
2273
        return clone
2202
2274
 
2203
2275
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2276
             possible_transports=None, ignore_fallbacks=False,
 
2277
             found_repository=None):
2205
2278
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2279
 
2207
2280
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2294
                raise AssertionError("wrong format %r found for %r" %
2222
2295
                    (format, self))
2223
2296
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2297
            location = self.get_reference(a_bzrdir, name)
2225
2298
        real_bzrdir = bzrdir.BzrDir.open(
2226
2299
            location, possible_transports=possible_transports)
2227
2300
        result = real_bzrdir.open_branch(name=name, 
2238
2311
        return result
2239
2312
 
2240
2313
 
 
2314
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2315
    """Branch format registry."""
 
2316
 
 
2317
    def __init__(self, other_registry=None):
 
2318
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2319
        self._default_format = None
 
2320
 
 
2321
    def set_default(self, format):
 
2322
        self._default_format = format
 
2323
 
 
2324
    def get_default(self):
 
2325
        return self._default_format
 
2326
 
 
2327
 
2241
2328
network_format_registry = registry.FormatRegistry()
2242
2329
"""Registry of formats indexed by their network name.
2243
2330
 
2246
2333
BranchFormat.network_name() for more detail.
2247
2334
"""
2248
2335
 
 
2336
format_registry = BranchFormatRegistry(network_format_registry)
 
2337
 
2249
2338
 
2250
2339
# formats which have no format string are not discoverable
2251
2340
# and not independently creatable, so are not registered.
2253
2342
__format6 = BzrBranchFormat6()
2254
2343
__format7 = BzrBranchFormat7()
2255
2344
__format8 = BzrBranchFormat8()
2256
 
BranchFormat.register_format(__format5)
2257
 
BranchFormat.register_format(BranchReferenceFormat())
2258
 
BranchFormat.register_format(__format6)
2259
 
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
2262
 
_legacy_formats = [BzrBranchFormat4(),
2263
 
    ]
2264
 
network_format_registry.register(
2265
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2345
format_registry.register(__format5)
 
2346
format_registry.register(BranchReferenceFormat())
 
2347
format_registry.register(__format6)
 
2348
format_registry.register(__format7)
 
2349
format_registry.register(__format8)
 
2350
format_registry.set_default(__format7)
 
2351
 
 
2352
 
 
2353
class BranchWriteLockResult(LogicalLockResult):
 
2354
    """The result of write locking a branch.
 
2355
 
 
2356
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2357
        None.
 
2358
    :ivar unlock: A callable which will unlock the lock.
 
2359
    """
 
2360
 
 
2361
    def __init__(self, unlock, branch_token):
 
2362
        LogicalLockResult.__init__(self, unlock)
 
2363
        self.branch_token = branch_token
 
2364
 
 
2365
    def __repr__(self):
 
2366
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2367
            self.unlock)
2266
2368
 
2267
2369
 
2268
2370
class BzrBranch(Branch, _RelockDebugMixin):
2324
2426
        return self.control_files.is_locked()
2325
2427
 
2326
2428
    def lock_write(self, token=None):
 
2429
        """Lock the branch for write operations.
 
2430
 
 
2431
        :param token: A token to permit reacquiring a previously held and
 
2432
            preserved lock.
 
2433
        :return: A BranchWriteLockResult.
 
2434
        """
2327
2435
        if not self.is_locked():
2328
2436
            self._note_lock('w')
2329
2437
        # All-in-one needs to always unlock/lock.
2335
2443
        else:
2336
2444
            took_lock = False
2337
2445
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2446
            return BranchWriteLockResult(self.unlock,
 
2447
                self.control_files.lock_write(token=token))
2339
2448
        except:
2340
2449
            if took_lock:
2341
2450
                self.repository.unlock()
2342
2451
            raise
2343
2452
 
2344
2453
    def lock_read(self):
 
2454
        """Lock the branch for read operations.
 
2455
 
 
2456
        :return: A bzrlib.lock.LogicalLockResult.
 
2457
        """
2345
2458
        if not self.is_locked():
2346
2459
            self._note_lock('r')
2347
2460
        # All-in-one needs to always unlock/lock.
2354
2467
            took_lock = False
2355
2468
        try:
2356
2469
            self.control_files.lock_read()
 
2470
            return LogicalLockResult(self.unlock)
2357
2471
        except:
2358
2472
            if took_lock:
2359
2473
                self.repository.unlock()
2387
2501
        """See Branch.print_file."""
2388
2502
        return self.repository.print_file(file, revision_id)
2389
2503
 
2390
 
    def _write_revision_history(self, history):
2391
 
        """Factored out of set_revision_history.
2392
 
 
2393
 
        This performs the actual writing to disk.
2394
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2395
 
        self._transport.put_bytes(
2396
 
            'revision-history', '\n'.join(history),
2397
 
            mode=self.bzrdir._get_file_mode())
2398
 
 
2399
 
    @needs_write_lock
2400
 
    def set_revision_history(self, rev_history):
2401
 
        """See Branch.set_revision_history."""
2402
 
        if 'evil' in debug.debug_flags:
2403
 
            mutter_callsite(3, "set_revision_history scales with history.")
2404
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2405
 
        for rev_id in rev_history:
2406
 
            check_not_reserved_id(rev_id)
2407
 
        if Branch.hooks['post_change_branch_tip']:
2408
 
            # Don't calculate the last_revision_info() if there are no hooks
2409
 
            # that will use it.
2410
 
            old_revno, old_revid = self.last_revision_info()
2411
 
        if len(rev_history) == 0:
2412
 
            revid = _mod_revision.NULL_REVISION
2413
 
        else:
2414
 
            revid = rev_history[-1]
2415
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2416
 
        self._write_revision_history(rev_history)
2417
 
        self._clear_cached_state()
2418
 
        self._cache_revision_history(rev_history)
2419
 
        for hook in Branch.hooks['set_rh']:
2420
 
            hook(self, rev_history)
2421
 
        if Branch.hooks['post_change_branch_tip']:
2422
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2423
 
 
2424
 
    def _synchronize_history(self, destination, revision_id):
2425
 
        """Synchronize last revision and revision history between branches.
2426
 
 
2427
 
        This version is most efficient when the destination is also a
2428
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2429
 
        history is the true lefthand parent history, and all of the revisions
2430
 
        are in the destination's repository.  If not, set_revision_history
2431
 
        will fail.
2432
 
 
2433
 
        :param destination: The branch to copy the history into
2434
 
        :param revision_id: The revision-id to truncate history at.  May
2435
 
          be None to copy complete history.
2436
 
        """
2437
 
        if not isinstance(destination._format, BzrBranchFormat5):
2438
 
            super(BzrBranch, self)._synchronize_history(
2439
 
                destination, revision_id)
2440
 
            return
2441
 
        if revision_id == _mod_revision.NULL_REVISION:
2442
 
            new_history = []
2443
 
        else:
2444
 
            new_history = self.revision_history()
2445
 
        if revision_id is not None and new_history != []:
2446
 
            try:
2447
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2448
 
            except ValueError:
2449
 
                rev = self.repository.get_revision(revision_id)
2450
 
                new_history = rev.get_history(self.repository)[1:]
2451
 
        destination.set_revision_history(new_history)
2452
 
 
2453
2504
    @needs_write_lock
2454
2505
    def set_last_revision_info(self, revno, revision_id):
2455
 
        """Set the last revision of this branch.
2456
 
 
2457
 
        The caller is responsible for checking that the revno is correct
2458
 
        for this revision id.
2459
 
 
2460
 
        It may be possible to set the branch last revision to an id not
2461
 
        present in the repository.  However, branches can also be
2462
 
        configured to check constraints on history, in which case this may not
2463
 
        be permitted.
2464
 
        """
 
2506
        if not revision_id or not isinstance(revision_id, basestring):
 
2507
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2508
        revision_id = _mod_revision.ensure_null(revision_id)
2466
 
        # this old format stores the full history, but this api doesn't
2467
 
        # provide it, so we must generate, and might as well check it's
2468
 
        # correct
2469
 
        history = self._lefthand_history(revision_id)
2470
 
        if len(history) != revno:
2471
 
            raise AssertionError('%d != %d' % (len(history), revno))
2472
 
        self.set_revision_history(history)
2473
 
 
2474
 
    def _gen_revision_history(self):
2475
 
        history = self._transport.get_bytes('revision-history').split('\n')
2476
 
        if history[-1:] == ['']:
2477
 
            # There shouldn't be a trailing newline, but just in case.
2478
 
            history.pop()
2479
 
        return history
2480
 
 
2481
 
    @needs_write_lock
2482
 
    def generate_revision_history(self, revision_id, last_rev=None,
2483
 
        other_branch=None):
2484
 
        """Create a new revision history that will finish with revision_id.
2485
 
 
2486
 
        :param revision_id: the new tip to use.
2487
 
        :param last_rev: The previous last_revision. If not None, then this
2488
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2489
 
        :param other_branch: The other branch that DivergedBranches should
2490
 
            raise with respect to.
2491
 
        """
2492
 
        self.set_revision_history(self._lefthand_history(revision_id,
2493
 
            last_rev, other_branch))
 
2509
        old_revno, old_revid = self.last_revision_info()
 
2510
        if self._get_append_revisions_only():
 
2511
            self._check_history_violation(revision_id)
 
2512
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2513
        self._write_last_revision_info(revno, revision_id)
 
2514
        self._clear_cached_state()
 
2515
        self._last_revision_info_cache = revno, revision_id
 
2516
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2517
 
2495
2518
    def basis_tree(self):
2496
2519
        """See Branch.basis_tree."""
2505
2528
                pass
2506
2529
        return None
2507
2530
 
2508
 
    def _basic_push(self, target, overwrite, stop_revision):
2509
 
        """Basic implementation of push without bound branches or hooks.
2510
 
 
2511
 
        Must be called with source read locked and target write locked.
2512
 
        """
2513
 
        result = BranchPushResult()
2514
 
        result.source_branch = self
2515
 
        result.target_branch = target
2516
 
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
 
        if result.old_revid != self.last_revision():
2519
 
            # We assume that during 'push' this repository is closer than
2520
 
            # the target.
2521
 
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
2524
 
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
2527
 
        result.new_revno, result.new_revid = target.last_revision_info()
2528
 
        return result
2529
 
 
2530
2531
    def get_stacked_on_url(self):
2531
2532
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2533
 
2543
2544
            self._transport.put_bytes('parent', url + '\n',
2544
2545
                mode=self.bzrdir._get_file_mode())
2545
2546
 
2546
 
 
2547
 
class BzrBranch5(BzrBranch):
2548
 
    """A format 5 branch. This supports new features over plain branches.
2549
 
 
2550
 
    It has support for a master_branch which is the data for bound branches.
2551
 
    """
2552
 
 
2553
 
    def get_bound_location(self):
2554
 
        try:
2555
 
            return self._transport.get_bytes('bound')[:-1]
2556
 
        except errors.NoSuchFile:
2557
 
            return None
2558
 
 
2559
 
    @needs_read_lock
2560
 
    def get_master_branch(self, possible_transports=None):
2561
 
        """Return the branch we are bound to.
2562
 
 
2563
 
        :return: Either a Branch, or None
2564
 
 
2565
 
        This could memoise the branch, but if thats done
2566
 
        it must be revalidated on each new lock.
2567
 
        So for now we just don't memoise it.
2568
 
        # RBC 20060304 review this decision.
2569
 
        """
2570
 
        bound_loc = self.get_bound_location()
2571
 
        if not bound_loc:
2572
 
            return None
2573
 
        try:
2574
 
            return Branch.open(bound_loc,
2575
 
                               possible_transports=possible_transports)
2576
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2577
 
            raise errors.BoundBranchConnectionFailure(
2578
 
                    self, bound_loc, e)
2579
 
 
2580
2547
    @needs_write_lock
2581
 
    def set_bound_location(self, location):
2582
 
        """Set the target where this branch is bound to.
2583
 
 
2584
 
        :param location: URL to the target branch
2585
 
        """
2586
 
        if location:
2587
 
            self._transport.put_bytes('bound', location+'\n',
2588
 
                mode=self.bzrdir._get_file_mode())
2589
 
        else:
2590
 
            try:
2591
 
                self._transport.delete('bound')
2592
 
            except errors.NoSuchFile:
2593
 
                return False
2594
 
            return True
 
2548
    def unbind(self):
 
2549
        """If bound, unbind"""
 
2550
        return self.set_bound_location(None)
2595
2551
 
2596
2552
    @needs_write_lock
2597
2553
    def bind(self, other):
2619
2575
        # history around
2620
2576
        self.set_bound_location(other.base)
2621
2577
 
 
2578
    def get_bound_location(self):
 
2579
        try:
 
2580
            return self._transport.get_bytes('bound')[:-1]
 
2581
        except errors.NoSuchFile:
 
2582
            return None
 
2583
 
 
2584
    @needs_read_lock
 
2585
    def get_master_branch(self, possible_transports=None):
 
2586
        """Return the branch we are bound to.
 
2587
 
 
2588
        :return: Either a Branch, or None
 
2589
        """
 
2590
        if self._master_branch_cache is None:
 
2591
            self._master_branch_cache = self._get_master_branch(
 
2592
                possible_transports)
 
2593
        return self._master_branch_cache
 
2594
 
 
2595
    def _get_master_branch(self, possible_transports):
 
2596
        bound_loc = self.get_bound_location()
 
2597
        if not bound_loc:
 
2598
            return None
 
2599
        try:
 
2600
            return Branch.open(bound_loc,
 
2601
                               possible_transports=possible_transports)
 
2602
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2603
            raise errors.BoundBranchConnectionFailure(
 
2604
                    self, bound_loc, e)
 
2605
 
2622
2606
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2607
    def set_bound_location(self, location):
 
2608
        """Set the target where this branch is bound to.
 
2609
 
 
2610
        :param location: URL to the target branch
 
2611
        """
 
2612
        self._master_branch_cache = None
 
2613
        if location:
 
2614
            self._transport.put_bytes('bound', location+'\n',
 
2615
                mode=self.bzrdir._get_file_mode())
 
2616
        else:
 
2617
            try:
 
2618
                self._transport.delete('bound')
 
2619
            except errors.NoSuchFile:
 
2620
                return False
 
2621
            return True
2626
2622
 
2627
2623
    @needs_write_lock
2628
2624
    def update(self, possible_transports=None):
2641
2637
            return old_tip
2642
2638
        return None
2643
2639
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2640
    def _read_last_revision_info(self):
 
2641
        revision_string = self._transport.get_bytes('last-revision')
 
2642
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2643
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2644
        revno = int(revno)
 
2645
        return revno, revision_id
 
2646
 
 
2647
    def _write_last_revision_info(self, revno, revision_id):
 
2648
        """Simply write out the revision id, with no checks.
 
2649
 
 
2650
        Use set_last_revision_info to perform this safely.
 
2651
 
 
2652
        Does not update the revision_history cache.
 
2653
        """
 
2654
        revision_id = _mod_revision.ensure_null(revision_id)
 
2655
        out_string = '%d %s\n' % (revno, revision_id)
 
2656
        self._transport.put_bytes('last-revision', out_string,
 
2657
            mode=self.bzrdir._get_file_mode())
 
2658
 
 
2659
 
 
2660
class FullHistoryBzrBranch(BzrBranch):
 
2661
    """Bzr branch which contains the full revision history."""
 
2662
 
 
2663
    @needs_write_lock
 
2664
    def set_last_revision_info(self, revno, revision_id):
 
2665
        if not revision_id or not isinstance(revision_id, basestring):
 
2666
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2667
        revision_id = _mod_revision.ensure_null(revision_id)
 
2668
        # this old format stores the full history, but this api doesn't
 
2669
        # provide it, so we must generate, and might as well check it's
 
2670
        # correct
 
2671
        history = self._lefthand_history(revision_id)
 
2672
        if len(history) != revno:
 
2673
            raise AssertionError('%d != %d' % (len(history), revno))
 
2674
        self._set_revision_history(history)
 
2675
 
 
2676
    def _read_last_revision_info(self):
 
2677
        rh = self.revision_history()
 
2678
        revno = len(rh)
 
2679
        if revno:
 
2680
            return (revno, rh[-1])
 
2681
        else:
 
2682
            return (0, _mod_revision.NULL_REVISION)
 
2683
 
 
2684
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2685
    @needs_write_lock
 
2686
    def set_revision_history(self, rev_history):
 
2687
        """See Branch.set_revision_history."""
 
2688
        self._set_revision_history(rev_history)
 
2689
 
 
2690
    def _set_revision_history(self, rev_history):
 
2691
        if 'evil' in debug.debug_flags:
 
2692
            mutter_callsite(3, "set_revision_history scales with history.")
 
2693
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2694
        for rev_id in rev_history:
 
2695
            check_not_reserved_id(rev_id)
 
2696
        if Branch.hooks['post_change_branch_tip']:
 
2697
            # Don't calculate the last_revision_info() if there are no hooks
 
2698
            # that will use it.
 
2699
            old_revno, old_revid = self.last_revision_info()
 
2700
        if len(rev_history) == 0:
 
2701
            revid = _mod_revision.NULL_REVISION
 
2702
        else:
 
2703
            revid = rev_history[-1]
 
2704
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2705
        self._write_revision_history(rev_history)
 
2706
        self._clear_cached_state()
 
2707
        self._cache_revision_history(rev_history)
 
2708
        for hook in Branch.hooks['set_rh']:
 
2709
            hook(self, rev_history)
 
2710
        if Branch.hooks['post_change_branch_tip']:
 
2711
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2712
 
 
2713
    def _write_revision_history(self, history):
 
2714
        """Factored out of set_revision_history.
 
2715
 
 
2716
        This performs the actual writing to disk.
 
2717
        It is intended to be called by set_revision_history."""
 
2718
        self._transport.put_bytes(
 
2719
            'revision-history', '\n'.join(history),
 
2720
            mode=self.bzrdir._get_file_mode())
 
2721
 
 
2722
    def _gen_revision_history(self):
 
2723
        history = self._transport.get_bytes('revision-history').split('\n')
 
2724
        if history[-1:] == ['']:
 
2725
            # There shouldn't be a trailing newline, but just in case.
 
2726
            history.pop()
 
2727
        return history
 
2728
 
 
2729
    def _synchronize_history(self, destination, revision_id):
 
2730
        if not isinstance(destination, FullHistoryBzrBranch):
 
2731
            super(BzrBranch, self)._synchronize_history(
 
2732
                destination, revision_id)
 
2733
            return
 
2734
        if revision_id == _mod_revision.NULL_REVISION:
 
2735
            new_history = []
 
2736
        else:
 
2737
            new_history = self.revision_history()
 
2738
        if revision_id is not None and new_history != []:
 
2739
            try:
 
2740
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2741
            except ValueError:
 
2742
                rev = self.repository.get_revision(revision_id)
 
2743
                new_history = rev.get_history(self.repository)[1:]
 
2744
        destination._set_revision_history(new_history)
 
2745
 
 
2746
    @needs_write_lock
 
2747
    def generate_revision_history(self, revision_id, last_rev=None,
 
2748
        other_branch=None):
 
2749
        """Create a new revision history that will finish with revision_id.
 
2750
 
 
2751
        :param revision_id: the new tip to use.
 
2752
        :param last_rev: The previous last_revision. If not None, then this
 
2753
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2754
        :param other_branch: The other branch that DivergedBranches should
 
2755
            raise with respect to.
 
2756
        """
 
2757
        self._set_revision_history(self._lefthand_history(revision_id,
 
2758
            last_rev, other_branch))
 
2759
 
 
2760
 
 
2761
class BzrBranch5(FullHistoryBzrBranch):
 
2762
    """A format 5 branch. This supports new features over plain branches.
 
2763
 
 
2764
    It has support for a master_branch which is the data for bound branches.
 
2765
    """
 
2766
 
 
2767
 
 
2768
class BzrBranch8(BzrBranch):
2646
2769
    """A branch that stores tree-reference locations."""
2647
2770
 
2648
2771
    def _open_hook(self):
2674
2797
        self._last_revision_info_cache = None
2675
2798
        self._reference_info = None
2676
2799
 
2677
 
    def _last_revision_info(self):
2678
 
        revision_string = self._transport.get_bytes('last-revision')
2679
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2680
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2681
 
        revno = int(revno)
2682
 
        return revno, revision_id
2683
 
 
2684
 
    def _write_last_revision_info(self, revno, revision_id):
2685
 
        """Simply write out the revision id, with no checks.
2686
 
 
2687
 
        Use set_last_revision_info to perform this safely.
2688
 
 
2689
 
        Does not update the revision_history cache.
2690
 
        Intended to be called by set_last_revision_info and
2691
 
        _write_revision_history.
2692
 
        """
2693
 
        revision_id = _mod_revision.ensure_null(revision_id)
2694
 
        out_string = '%d %s\n' % (revno, revision_id)
2695
 
        self._transport.put_bytes('last-revision', out_string,
2696
 
            mode=self.bzrdir._get_file_mode())
2697
 
 
2698
 
    @needs_write_lock
2699
 
    def set_last_revision_info(self, revno, revision_id):
2700
 
        revision_id = _mod_revision.ensure_null(revision_id)
2701
 
        old_revno, old_revid = self.last_revision_info()
2702
 
        if self._get_append_revisions_only():
2703
 
            self._check_history_violation(revision_id)
2704
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2705
 
        self._write_last_revision_info(revno, revision_id)
2706
 
        self._clear_cached_state()
2707
 
        self._last_revision_info_cache = revno, revision_id
2708
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2709
 
 
2710
 
    def _synchronize_history(self, destination, revision_id):
2711
 
        """Synchronize last revision and revision history between branches.
2712
 
 
2713
 
        :see: Branch._synchronize_history
2714
 
        """
2715
 
        # XXX: The base Branch has a fast implementation of this method based
2716
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2717
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2718
 
        # but wants the fast implementation, so it calls
2719
 
        # Branch._synchronize_history directly.
2720
 
        Branch._synchronize_history(self, destination, revision_id)
2721
 
 
2722
2800
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2801
        current_revid = self.last_revision()
 
2802
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2803
        if _mod_revision.is_null(last_revision):
2725
2804
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2805
        graph = self.repository.get_graph()
 
2806
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2807
            if lh_ancestor == current_revid:
 
2808
                return
 
2809
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2810
 
2729
2811
    def _gen_revision_history(self):
2730
2812
        """Generate the revision history from last revision
2733
2815
        self._extend_partial_history(stop_index=last_revno-1)
2734
2816
        return list(reversed(self._partial_revision_history_cache))
2735
2817
 
2736
 
    def _write_revision_history(self, history):
2737
 
        """Factored out of set_revision_history.
2738
 
 
2739
 
        This performs the actual writing to disk, with format-specific checks.
2740
 
        It is intended to be called by BzrBranch5.set_revision_history.
2741
 
        """
2742
 
        if len(history) == 0:
2743
 
            last_revision = 'null:'
2744
 
        else:
2745
 
            if history != self._lefthand_history(history[-1]):
2746
 
                raise errors.NotLefthandHistory(history)
2747
 
            last_revision = history[-1]
2748
 
        if self._get_append_revisions_only():
2749
 
            self._check_history_violation(last_revision)
2750
 
        self._write_last_revision_info(len(history), last_revision)
2751
 
 
2752
2818
    @needs_write_lock
2753
2819
    def _set_parent_location(self, url):
2754
2820
        """Set the parent branch"""
2840
2906
 
2841
2907
    def set_bound_location(self, location):
2842
2908
        """See Branch.set_push_location."""
 
2909
        self._master_branch_cache = None
2843
2910
        result = None
2844
2911
        config = self.get_config()
2845
2912
        if location is None:
2876
2943
        # you can always ask for the URL; but you might not be able to use it
2877
2944
        # if the repo can't support stacking.
2878
2945
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2946
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2947
        # waste effort reading the whole stack of config files.
 
2948
        config = self.get_config()._get_branch_data_config()
 
2949
        stacked_url = self._get_config_location('stacked_on_location',
 
2950
            config=config)
2880
2951
        if stacked_url is None:
2881
2952
            raise errors.NotStacked(self)
2882
2953
        return stacked_url
2885
2956
        return self.get_config(
2886
2957
            ).get_user_option_as_bool('append_revisions_only')
2887
2958
 
2888
 
    @needs_write_lock
2889
 
    def generate_revision_history(self, revision_id, last_rev=None,
2890
 
                                  other_branch=None):
2891
 
        """See BzrBranch5.generate_revision_history"""
2892
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
 
        revno = len(history)
2894
 
        self.set_last_revision_info(revno, revision_id)
2895
 
 
2896
2959
    @needs_read_lock
2897
2960
    def get_rev_id(self, revno, history=None):
2898
2961
        """Find the revision id of the specified revno."""
2922
2985
        try:
2923
2986
            index = self._partial_revision_history_cache.index(revision_id)
2924
2987
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
2988
            try:
 
2989
                self._extend_partial_history(stop_revision=revision_id)
 
2990
            except errors.RevisionNotPresent, e:
 
2991
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
2992
            index = len(self._partial_revision_history_cache) - 1
2927
2993
            if self._partial_revision_history_cache[index] != revision_id:
2928
2994
                raise errors.NoSuchRevision(self, revision_id)
2983
3049
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3050
    """
2985
3051
 
 
3052
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3053
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3054
        """Return the relative change in revno.
 
3055
 
 
3056
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3057
        """
2988
3058
        return self.new_revno - self.old_revno
2989
3059
 
2990
3060
    def report(self, to_file):
3015
3085
        target, otherwise it will be None.
3016
3086
    """
3017
3087
 
 
3088
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3089
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3090
        """Return the relative change in revno.
 
3091
 
 
3092
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3093
        """
3020
3094
        return self.new_revno - self.old_revno
3021
3095
 
3022
3096
    def report(self, to_file):
3092
3166
 
3093
3167
 
3094
3168
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3169
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3170
 
3097
3171
    def convert(self, branch):
3098
3172
        format = BzrBranchFormat8()
3101
3175
        branch._transport.put_bytes('format', format.get_format_string())
3102
3176
 
3103
3177
 
3104
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3106
 
    duration.
3107
 
 
3108
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
3109
 
 
3110
 
    If an exception is raised by callable, then that exception *will* be
3111
 
    propagated, even if the unlock attempt raises its own error.  Thus
3112
 
    _run_with_write_locked_target should be preferred to simply doing::
3113
 
 
3114
 
        target.lock_write()
3115
 
        try:
3116
 
            return callable(*args, **kwargs)
3117
 
        finally:
3118
 
            target.unlock()
3119
 
 
3120
 
    """
3121
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
3122
 
    # should share code?
3123
 
    target.lock_write()
3124
 
    try:
3125
 
        result = callable(*args, **kwargs)
3126
 
    except:
3127
 
        exc_info = sys.exc_info()
3128
 
        try:
3129
 
            target.unlock()
3130
 
        finally:
3131
 
            raise exc_info[0], exc_info[1], exc_info[2]
3132
 
    else:
3133
 
        target.unlock()
3134
 
        return result
3135
 
 
3136
 
 
3137
3178
class InterBranch(InterObject):
3138
3179
    """This class represents operations taking place between two branches.
3139
3180
 
3145
3186
    _optimisers = []
3146
3187
    """The available optimised InterBranch types."""
3147
3188
 
3148
 
    @staticmethod
3149
 
    def _get_branch_formats_to_test():
3150
 
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3189
    @classmethod
 
3190
    def _get_branch_formats_to_test(klass):
 
3191
        """Return an iterable of format tuples for testing.
 
3192
        
 
3193
        :return: An iterable of (from_format, to_format) to use when testing
 
3194
            this InterBranch class. Each InterBranch class should define this
 
3195
            method itself.
 
3196
        """
 
3197
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3198
 
 
3199
    @needs_write_lock
3153
3200
    def pull(self, overwrite=False, stop_revision=None,
3154
3201
             possible_transports=None, local=False):
3155
3202
        """Mirror source into target branch.
3160
3207
        """
3161
3208
        raise NotImplementedError(self.pull)
3162
3209
 
3163
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
 
                         graph=None):
3165
 
        """Pull in new perfect-fit revisions.
3166
 
 
3167
 
        :param stop_revision: Updated until the given revision
3168
 
        :param overwrite: Always set the branch pointer, rather than checking
3169
 
            to see if it is a proper descendant.
3170
 
        :param graph: A Graph object that can be used to query history
3171
 
            information. This can be None.
3172
 
        :return: None
3173
 
        """
3174
 
        raise NotImplementedError(self.update_revisions)
3175
 
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
 
3210
    @needs_write_lock
 
3211
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3212
             _override_hook_source_branch=None):
3178
3213
        """Mirror the source branch into the target branch.
3179
3214
 
3181
3216
        """
3182
3217
        raise NotImplementedError(self.push)
3183
3218
 
 
3219
    @needs_write_lock
 
3220
    def copy_content_into(self, revision_id=None):
 
3221
        """Copy the content of source into target
 
3222
 
 
3223
        revision_id: if not None, the revision history in the new branch will
 
3224
                     be truncated to end with revision_id.
 
3225
        """
 
3226
        raise NotImplementedError(self.copy_content_into)
 
3227
 
 
3228
    @needs_write_lock
 
3229
    def fetch(self, stop_revision=None, limit=None):
 
3230
        """Fetch revisions.
 
3231
 
 
3232
        :param stop_revision: Last revision to fetch
 
3233
        :param limit: Optional rough limit of revisions to fetch
 
3234
        """
 
3235
        raise NotImplementedError(self.fetch)
 
3236
 
3184
3237
 
3185
3238
class GenericInterBranch(InterBranch):
3186
 
    """InterBranch implementation that uses public Branch functions.
3187
 
    """
3188
 
 
3189
 
    @staticmethod
3190
 
    def _get_branch_formats_to_test():
3191
 
        return BranchFormat._default_format, BranchFormat._default_format
3192
 
 
3193
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3194
 
        graph=None):
3195
 
        """See InterBranch.update_revisions()."""
 
3239
    """InterBranch implementation that uses public Branch functions."""
 
3240
 
 
3241
    @classmethod
 
3242
    def is_compatible(klass, source, target):
 
3243
        # GenericBranch uses the public API, so always compatible
 
3244
        return True
 
3245
 
 
3246
    @classmethod
 
3247
    def _get_branch_formats_to_test(klass):
 
3248
        return [(format_registry.get_default(), format_registry.get_default())]
 
3249
 
 
3250
    @classmethod
 
3251
    def unwrap_format(klass, format):
 
3252
        if isinstance(format, remote.RemoteBranchFormat):
 
3253
            format._ensure_real()
 
3254
            return format._custom_format
 
3255
        return format
 
3256
 
 
3257
    @needs_write_lock
 
3258
    def copy_content_into(self, revision_id=None):
 
3259
        """Copy the content of source into target
 
3260
 
 
3261
        revision_id: if not None, the revision history in the new branch will
 
3262
                     be truncated to end with revision_id.
 
3263
        """
 
3264
        self.source.update_references(self.target)
 
3265
        self.source._synchronize_history(self.target, revision_id)
 
3266
        try:
 
3267
            parent = self.source.get_parent()
 
3268
        except errors.InaccessibleParent, e:
 
3269
            mutter('parent was not accessible to copy: %s', e)
 
3270
        else:
 
3271
            if parent:
 
3272
                self.target.set_parent(parent)
 
3273
        if self.source._push_should_merge_tags():
 
3274
            self.source.tags.merge_to(self.target.tags)
 
3275
 
 
3276
    @needs_write_lock
 
3277
    def fetch(self, stop_revision=None, limit=None):
 
3278
        if self.target.base == self.source.base:
 
3279
            return (0, [])
3196
3280
        self.source.lock_read()
3197
3281
        try:
3198
 
            other_revno, other_last_revision = self.source.last_revision_info()
3199
 
            stop_revno = None # unknown
3200
 
            if stop_revision is None:
3201
 
                stop_revision = other_last_revision
3202
 
                if _mod_revision.is_null(stop_revision):
3203
 
                    # if there are no commits, we're done.
3204
 
                    return
3205
 
                stop_revno = other_revno
3206
 
 
3207
 
            # what's the current last revision, before we fetch [and change it
3208
 
            # possibly]
3209
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3210
 
            # we fetch here so that we don't process data twice in the common
3211
 
            # case of having something to pull, and so that the check for
3212
 
            # already merged can operate on the just fetched graph, which will
3213
 
            # be cached in memory.
3214
 
            self.target.fetch(self.source, stop_revision)
3215
 
            # Check to see if one is an ancestor of the other
3216
 
            if not overwrite:
3217
 
                if graph is None:
3218
 
                    graph = self.target.repository.get_graph()
3219
 
                if self.target._check_if_descendant_or_diverged(
3220
 
                        stop_revision, last_rev, graph, self.source):
3221
 
                    # stop_revision is a descendant of last_rev, but we aren't
3222
 
                    # overwriting, so we're done.
3223
 
                    return
3224
 
            if stop_revno is None:
3225
 
                if graph is None:
3226
 
                    graph = self.target.repository.get_graph()
3227
 
                this_revno, this_last_revision = \
3228
 
                        self.target.last_revision_info()
3229
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3230
 
                                [(other_last_revision, other_revno),
3231
 
                                 (this_last_revision, this_revno)])
3232
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3282
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3283
            fetch_spec_factory.source_branch = self.source
 
3284
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3285
            fetch_spec_factory.source_repo = self.source.repository
 
3286
            fetch_spec_factory.target_repo = self.target.repository
 
3287
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3288
            fetch_spec_factory.limit = limit
 
3289
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3290
            return self.target.repository.fetch(self.source.repository,
 
3291
                fetch_spec=fetch_spec)
3233
3292
        finally:
3234
3293
            self.source.unlock()
3235
3294
 
 
3295
    @needs_write_lock
 
3296
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3297
            graph=None):
 
3298
        other_revno, other_last_revision = self.source.last_revision_info()
 
3299
        stop_revno = None # unknown
 
3300
        if stop_revision is None:
 
3301
            stop_revision = other_last_revision
 
3302
            if _mod_revision.is_null(stop_revision):
 
3303
                # if there are no commits, we're done.
 
3304
                return
 
3305
            stop_revno = other_revno
 
3306
 
 
3307
        # what's the current last revision, before we fetch [and change it
 
3308
        # possibly]
 
3309
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3310
        # we fetch here so that we don't process data twice in the common
 
3311
        # case of having something to pull, and so that the check for
 
3312
        # already merged can operate on the just fetched graph, which will
 
3313
        # be cached in memory.
 
3314
        self.fetch(stop_revision=stop_revision)
 
3315
        # Check to see if one is an ancestor of the other
 
3316
        if not overwrite:
 
3317
            if graph is None:
 
3318
                graph = self.target.repository.get_graph()
 
3319
            if self.target._check_if_descendant_or_diverged(
 
3320
                    stop_revision, last_rev, graph, self.source):
 
3321
                # stop_revision is a descendant of last_rev, but we aren't
 
3322
                # overwriting, so we're done.
 
3323
                return
 
3324
        if stop_revno is None:
 
3325
            if graph is None:
 
3326
                graph = self.target.repository.get_graph()
 
3327
            this_revno, this_last_revision = \
 
3328
                    self.target.last_revision_info()
 
3329
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3330
                            [(other_last_revision, other_revno),
 
3331
                             (this_last_revision, this_revno)])
 
3332
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3333
 
 
3334
    @needs_write_lock
3236
3335
    def pull(self, overwrite=False, stop_revision=None,
 
3336
             possible_transports=None, run_hooks=True,
 
3337
             _override_hook_target=None, local=False):
 
3338
        """Pull from source into self, updating my master if any.
 
3339
 
 
3340
        :param run_hooks: Private parameter - if false, this branch
 
3341
            is being called because it's the master of the primary branch,
 
3342
            so it should not run its hooks.
 
3343
        """
 
3344
        bound_location = self.target.get_bound_location()
 
3345
        if local and not bound_location:
 
3346
            raise errors.LocalRequiresBoundBranch()
 
3347
        master_branch = None
 
3348
        source_is_master = False
 
3349
        if bound_location:
 
3350
            # bound_location comes from a config file, some care has to be
 
3351
            # taken to relate it to source.user_url
 
3352
            normalized = urlutils.normalize_url(bound_location)
 
3353
            try:
 
3354
                relpath = self.source.user_transport.relpath(normalized)
 
3355
                source_is_master = (relpath == '')
 
3356
            except (errors.PathNotChild, errors.InvalidURL):
 
3357
                source_is_master = False
 
3358
        if not local and bound_location and not source_is_master:
 
3359
            # not pulling from master, so we need to update master.
 
3360
            master_branch = self.target.get_master_branch(possible_transports)
 
3361
            master_branch.lock_write()
 
3362
        try:
 
3363
            if master_branch:
 
3364
                # pull from source into master.
 
3365
                master_branch.pull(self.source, overwrite, stop_revision,
 
3366
                    run_hooks=False)
 
3367
            return self._pull(overwrite,
 
3368
                stop_revision, _hook_master=master_branch,
 
3369
                run_hooks=run_hooks,
 
3370
                _override_hook_target=_override_hook_target,
 
3371
                merge_tags_to_master=not source_is_master)
 
3372
        finally:
 
3373
            if master_branch:
 
3374
                master_branch.unlock()
 
3375
 
 
3376
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3377
             _override_hook_source_branch=None):
 
3378
        """See InterBranch.push.
 
3379
 
 
3380
        This is the basic concrete implementation of push()
 
3381
 
 
3382
        :param _override_hook_source_branch: If specified, run the hooks
 
3383
            passing this Branch as the source, rather than self.  This is for
 
3384
            use of RemoteBranch, where push is delegated to the underlying
 
3385
            vfs-based Branch.
 
3386
        """
 
3387
        if lossy:
 
3388
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3389
        # TODO: Public option to disable running hooks - should be trivial but
 
3390
        # needs tests.
 
3391
 
 
3392
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3393
        op.add_cleanup(self.source.lock_read().unlock)
 
3394
        op.add_cleanup(self.target.lock_write().unlock)
 
3395
        return op.run(overwrite, stop_revision,
 
3396
            _override_hook_source_branch=_override_hook_source_branch)
 
3397
 
 
3398
    def _basic_push(self, overwrite, stop_revision):
 
3399
        """Basic implementation of push without bound branches or hooks.
 
3400
 
 
3401
        Must be called with source read locked and target write locked.
 
3402
        """
 
3403
        result = BranchPushResult()
 
3404
        result.source_branch = self.source
 
3405
        result.target_branch = self.target
 
3406
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3407
        self.source.update_references(self.target)
 
3408
        if result.old_revid != stop_revision:
 
3409
            # We assume that during 'push' this repository is closer than
 
3410
            # the target.
 
3411
            graph = self.source.repository.get_graph(self.target.repository)
 
3412
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3413
                    graph=graph)
 
3414
        if self.source._push_should_merge_tags():
 
3415
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3416
                overwrite)
 
3417
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3418
        return result
 
3419
 
 
3420
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3421
            _override_hook_source_branch=None):
 
3422
        """Push from source into target, and into target's master if any.
 
3423
        """
 
3424
        def _run_hooks():
 
3425
            if _override_hook_source_branch:
 
3426
                result.source_branch = _override_hook_source_branch
 
3427
            for hook in Branch.hooks['post_push']:
 
3428
                hook(result)
 
3429
 
 
3430
        bound_location = self.target.get_bound_location()
 
3431
        if bound_location and self.target.base != bound_location:
 
3432
            # there is a master branch.
 
3433
            #
 
3434
            # XXX: Why the second check?  Is it even supported for a branch to
 
3435
            # be bound to itself? -- mbp 20070507
 
3436
            master_branch = self.target.get_master_branch()
 
3437
            master_branch.lock_write()
 
3438
            operation.add_cleanup(master_branch.unlock)
 
3439
            # push into the master from the source branch.
 
3440
            master_inter = InterBranch.get(self.source, master_branch)
 
3441
            master_inter._basic_push(overwrite, stop_revision)
 
3442
            # and push into the target branch from the source. Note that
 
3443
            # we push from the source branch again, because it's considered
 
3444
            # the highest bandwidth repository.
 
3445
            result = self._basic_push(overwrite, stop_revision)
 
3446
            result.master_branch = master_branch
 
3447
            result.local_branch = self.target
 
3448
        else:
 
3449
            master_branch = None
 
3450
            # no master branch
 
3451
            result = self._basic_push(overwrite, stop_revision)
 
3452
            # TODO: Why set master_branch and local_branch if there's no
 
3453
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3454
            # 20070504
 
3455
            result.master_branch = self.target
 
3456
            result.local_branch = None
 
3457
        _run_hooks()
 
3458
        return result
 
3459
 
 
3460
    def _pull(self, overwrite=False, stop_revision=None,
3237
3461
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3462
             _override_hook_target=None, local=False,
 
3463
             merge_tags_to_master=True):
3239
3464
        """See Branch.pull.
3240
3465
 
 
3466
        This function is the core worker, used by GenericInterBranch.pull to
 
3467
        avoid duplication when pulling source->master and source->local.
 
3468
 
3241
3469
        :param _hook_master: Private parameter - set the branch to
3242
3470
            be supplied as the master to pull hooks.
3243
3471
        :param run_hooks: Private parameter - if false, this branch
3244
3472
            is being called because it's the master of the primary branch,
3245
3473
            so it should not run its hooks.
 
3474
            is being called because it's the master of the primary branch,
 
3475
            so it should not run its hooks.
3246
3476
        :param _override_hook_target: Private parameter - set the branch to be
3247
3477
            supplied as the target_branch to pull hooks.
3248
3478
        :param local: Only update the local branch, and not the bound branch.
3267
3497
            # -- JRV20090506
3268
3498
            result.old_revno, result.old_revid = \
3269
3499
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3500
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3501
                graph=graph)
3272
3502
            # TODO: The old revid should be specified when merging tags, 
3273
3503
            # so a tags implementation that versions tags can only 
3274
3504
            # pull in the most recent changes. -- JRV20090506
3275
3505
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3506
                overwrite, ignore_master=not merge_tags_to_master)
3277
3507
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3508
            if _hook_master:
3279
3509
                result.master_branch = _hook_master
3288
3518
            self.source.unlock()
3289
3519
        return result
3290
3520
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
 
    @classmethod
3358
 
    def is_compatible(self, source, target):
3359
 
        # GenericBranch uses the public API, so always compatible
3360
 
        return True
3361
 
 
3362
 
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
3521
 
3400
3522
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)