/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2011-08-10 14:02:04 UTC
  • mto: (6015.9.8 2.4)
  • mto: This revision was merged to the branch mainline in revision 6066.
  • Revision ID: john@arbash-meinel.com-20110810140204-3ppg9vbeikxq5lmd
Fix the 11 tests that still failed.

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,
63
71
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
72
 
65
73
 
66
 
class Branch(bzrdir.ControlComponent):
 
74
class Branch(controldir.ControlComponent):
67
75
    """Branch holding a history of revisions.
68
76
 
69
77
    :ivar base:
70
78
        Base directory/url of the branch; using control_url and
71
79
        control_transport is more standardized.
72
 
 
73
 
    hooks: An instance of BranchHooks.
 
80
    :ivar hooks: An instance of BranchHooks.
 
81
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
82
        _clear_cached_state.
74
83
    """
75
84
    # this is really an instance variable - FIXME move it there
76
85
    # - RBC 20060112
90
99
        self._revision_id_to_revno_cache = None
91
100
        self._partial_revision_id_to_revno_cache = {}
92
101
        self._partial_revision_history_cache = []
 
102
        self._tags_bytes = None
93
103
        self._last_revision_info_cache = None
 
104
        self._master_branch_cache = None
94
105
        self._merge_sorted_revisions_cache = None
95
106
        self._open_hook()
96
107
        hooks = Branch.hooks['open']
102
113
 
103
114
    def _activate_fallback_location(self, url):
104
115
        """Activate the branch/repository from url as a fallback repository."""
 
116
        for existing_fallback_repo in self.repository._fallback_repositories:
 
117
            if existing_fallback_repo.user_url == url:
 
118
                # This fallback is already configured.  This probably only
 
119
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
120
                # confusing _unstack we don't add this a second time.
 
121
                mutter('duplicate activation of fallback %r on %r', url, self)
 
122
                return
105
123
        repo = self._get_fallback_repository(url)
106
124
        if repo.has_same_location(self.repository):
107
125
            raise errors.UnstackableLocationError(self.user_url, url)
197
215
        return self.supports_tags() and self.tags.get_tag_dict()
198
216
 
199
217
    def get_config(self):
 
218
        """Get a bzrlib.config.BranchConfig for this Branch.
 
219
 
 
220
        This can then be used to get and set configuration options for the
 
221
        branch.
 
222
 
 
223
        :return: A bzrlib.config.BranchConfig.
 
224
        """
200
225
        return BranchConfig(self)
201
226
 
202
227
    def _get_config(self):
218
243
            possible_transports=[self.bzrdir.root_transport])
219
244
        return a_branch.repository
220
245
 
 
246
    @needs_read_lock
221
247
    def _get_tags_bytes(self):
222
248
        """Get the bytes of a serialised tags dict.
223
249
 
230
256
        :return: The bytes of the tags file.
231
257
        :seealso: Branch._set_tags_bytes.
232
258
        """
233
 
        return self._transport.get_bytes('tags')
 
259
        if self._tags_bytes is None:
 
260
            self._tags_bytes = self._transport.get_bytes('tags')
 
261
        return self._tags_bytes
234
262
 
235
263
    def _get_nick(self, local=False, possible_transports=None):
236
264
        config = self.get_config()
238
266
        if not local and not config.has_explicit_nickname():
239
267
            try:
240
268
                master = self.get_master_branch(possible_transports)
 
269
                if master and self.user_url == master.user_url:
 
270
                    raise errors.RecursiveBind(self.user_url)
241
271
                if master is not None:
242
272
                    # return the master branch value
243
273
                    return master.nick
 
274
            except errors.RecursiveBind, e:
 
275
                raise e
244
276
            except errors.BzrError, e:
245
277
                # Silently fall back to local implicit nick if the master is
246
278
                # unavailable
283
315
        new_history.reverse()
284
316
        return new_history
285
317
 
286
 
    def lock_write(self):
 
318
    def lock_write(self, token=None):
 
319
        """Lock the branch for write operations.
 
320
 
 
321
        :param token: A token to permit reacquiring a previously held and
 
322
            preserved lock.
 
323
        :return: A BranchWriteLockResult.
 
324
        """
287
325
        raise NotImplementedError(self.lock_write)
288
326
 
289
327
    def lock_read(self):
 
328
        """Lock the branch for read operations.
 
329
 
 
330
        :return: A bzrlib.lock.LogicalLockResult.
 
331
        """
290
332
        raise NotImplementedError(self.lock_read)
291
333
 
292
334
    def unlock(self):
413
455
            after. If None, the rest of history is included.
414
456
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
457
            to use for termination:
 
458
 
416
459
            * 'exclude' - leave the stop revision out of the result (default)
417
460
            * 'include' - the stop revision is the last item in the result
418
461
            * 'with-merges' - include the stop revision and all of its
420
463
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
464
              that are in both ancestries
422
465
        :param direction: either 'reverse' or 'forward':
 
466
 
423
467
            * reverse means return the start_revision_id first, i.e.
424
468
              start at the most recent revision and go backwards in history
425
469
            * forward returns tuples in the opposite order to reverse.
469
513
        rev_iter = iter(merge_sorted_revisions)
470
514
        if start_revision_id is not None:
471
515
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
516
                rev_id = node.key
473
517
                if rev_id != start_revision_id:
474
518
                    continue
475
519
                else:
481
525
        if stop_revision_id is None:
482
526
            # Yield everything
483
527
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
 
528
                rev_id = node.key
485
529
                yield (rev_id, node.merge_depth, node.revno,
486
530
                       node.end_of_merge)
487
531
        elif stop_rule == 'exclude':
488
532
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
533
                rev_id = node.key
490
534
                if rev_id == stop_revision_id:
491
535
                    return
492
536
                yield (rev_id, node.merge_depth, node.revno,
493
537
                       node.end_of_merge)
494
538
        elif stop_rule == 'include':
495
539
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
 
540
                rev_id = node.key
497
541
                yield (rev_id, node.merge_depth, node.revno,
498
542
                       node.end_of_merge)
499
543
                if rev_id == stop_revision_id:
505
549
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
550
                                                    [stop_revision_id])
507
551
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
 
552
                rev_id = node.key
509
553
                if rev_id not in ancestors:
510
554
                    continue
511
555
                yield (rev_id, node.merge_depth, node.revno,
521
565
            reached_stop_revision_id = False
522
566
            revision_id_whitelist = []
523
567
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
568
                rev_id = node.key
525
569
                if rev_id == left_parent:
526
570
                    # reached the left parent after the stop_revision
527
571
                    return
626
670
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
671
 
628
672
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
673
    def fetch(self, from_branch, last_revision=None, limit=None):
630
674
        """Copy revisions from from_branch into this branch.
631
675
 
632
676
        :param from_branch: Where to copy from.
633
677
        :param last_revision: What revision to stop at (None for at the end
634
678
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
679
        :param limit: Optional rough limit of revisions to fetch
636
680
        :return: None
637
681
        """
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()
 
682
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
683
 
655
684
    def get_bound_location(self):
656
685
        """Return the URL of the branch we are bound to.
667
696
 
668
697
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
698
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
699
                           revision_id=None, lossy=False):
671
700
        """Obtain a CommitBuilder for this branch.
672
701
 
673
702
        :param parents: Revision ids of the parents of the new revision.
677
706
        :param committer: Optional committer to set for commit.
678
707
        :param revprops: Optional dictionary of revision properties.
679
708
        :param revision_id: Optional revision id.
 
709
        :param lossy: Whether to discard data that can not be natively
 
710
            represented, when pushing to a foreign VCS 
680
711
        """
681
712
 
682
713
        if config is None:
683
714
            config = self.get_config()
684
715
 
685
716
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
717
            timestamp, timezone, committer, revprops, revision_id,
 
718
            lossy)
687
719
 
688
720
    def get_master_branch(self, possible_transports=None):
689
721
        """Return the branch we are bound to.
716
748
        """Print `file` to stdout."""
717
749
        raise NotImplementedError(self.print_file)
718
750
 
 
751
    @deprecated_method(deprecated_in((2, 4, 0)))
719
752
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
753
        """See Branch.set_revision_history."""
 
754
        self._set_revision_history(rev_history)
 
755
 
 
756
    @needs_write_lock
 
757
    def _set_revision_history(self, rev_history):
 
758
        if len(rev_history) == 0:
 
759
            revid = _mod_revision.NULL_REVISION
 
760
        else:
 
761
            revid = rev_history[-1]
 
762
        if rev_history != self._lefthand_history(revid):
 
763
            raise errors.NotLefthandHistory(rev_history)
 
764
        self.set_last_revision_info(len(rev_history), revid)
 
765
        self._cache_revision_history(rev_history)
 
766
        for hook in Branch.hooks['set_rh']:
 
767
            hook(self, rev_history)
 
768
 
 
769
    @needs_write_lock
 
770
    def set_last_revision_info(self, revno, revision_id):
 
771
        """Set the last revision of this branch.
 
772
 
 
773
        The caller is responsible for checking that the revno is correct
 
774
        for this revision id.
 
775
 
 
776
        It may be possible to set the branch last revision to an id not
 
777
        present in the repository.  However, branches can also be
 
778
        configured to check constraints on history, in which case this may not
 
779
        be permitted.
 
780
        """
 
781
        raise NotImplementedError(self.set_last_revision_info)
 
782
 
 
783
    @needs_write_lock
 
784
    def generate_revision_history(self, revision_id, last_rev=None,
 
785
                                  other_branch=None):
 
786
        """See Branch.generate_revision_history"""
 
787
        graph = self.repository.get_graph()
 
788
        known_revision_ids = [
 
789
            self.last_revision_info(),
 
790
            (_mod_revision.NULL_REVISION, 0),
 
791
            ]
 
792
        if last_rev is not None:
 
793
            if not graph.is_ancestor(last_rev, revision_id):
 
794
                # our previous tip is not merged into stop_revision
 
795
                raise errors.DivergedBranches(self, other_branch)
 
796
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
797
        self.set_last_revision_info(revno, revision_id)
721
798
 
722
799
    @needs_write_lock
723
800
    def set_parent(self, url):
767
844
 
768
845
    def _unstack(self):
769
846
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
847
 
771
848
        Don't call this directly, use set_stacked_on_url(None).
772
849
        """
773
850
        pb = ui.ui_factory.nested_progress_bar()
782
859
            old_repository = self.repository
783
860
            if len(old_repository._fallback_repositories) != 1:
784
861
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
862
                    "of %r (fallbacks: %r)" % (old_repository,
 
863
                        old_repository._fallback_repositories))
 
864
            # Open the new repository object.
 
865
            # Repositories don't offer an interface to remove fallback
 
866
            # repositories today; take the conceptually simpler option and just
 
867
            # reopen it.  We reopen it starting from the URL so that we
 
868
            # get a separate connection for RemoteRepositories and can
 
869
            # stream from one of them to the other.  This does mean doing
 
870
            # separate SSH connection setup, but unstacking is not a
 
871
            # common operation so it's tolerable.
 
872
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
873
            new_repository = new_bzrdir.find_repository()
 
874
            if new_repository._fallback_repositories:
 
875
                raise AssertionError("didn't expect %r to have "
 
876
                    "fallback_repositories"
 
877
                    % (self.repository,))
 
878
            # Replace self.repository with the new repository.
 
879
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
880
            # lock count) of self.repository to the new repository.
 
881
            lock_token = old_repository.lock_write().repository_token
 
882
            self.repository = new_repository
 
883
            if isinstance(self, remote.RemoteBranch):
 
884
                # Remote branches can have a second reference to the old
 
885
                # repository that need to be replaced.
 
886
                if self._real_branch is not None:
 
887
                    self._real_branch.repository = new_repository
 
888
            self.repository.lock_write(token=lock_token)
 
889
            if lock_token is not None:
 
890
                old_repository.leave_lock_in_place()
787
891
            old_repository.unlock()
 
892
            if lock_token is not None:
 
893
                # XXX: self.repository.leave_lock_in_place() before this
 
894
                # function will not be preserved.  Fortunately that doesn't
 
895
                # affect the current default format (2a), and would be a
 
896
                # corner-case anyway.
 
897
                #  - Andrew Bennetts, 2010/06/30
 
898
                self.repository.dont_leave_lock_in_place()
 
899
            old_lock_count = 0
 
900
            while True:
 
901
                try:
 
902
                    old_repository.unlock()
 
903
                except errors.LockNotHeld:
 
904
                    break
 
905
                old_lock_count += 1
 
906
            if old_lock_count == 0:
 
907
                raise AssertionError(
 
908
                    'old_repository should have been locked at least once.')
 
909
            for i in range(old_lock_count-1):
 
910
                self.repository.lock_write()
 
911
            # Fetch from the old repository into the new.
788
912
            old_repository.lock_read()
789
913
            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
914
                # XXX: If you unstack a branch while it has a working tree
809
915
                # with a pending merge, the pending-merged revisions will no
810
916
                # 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)
 
917
                try:
 
918
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
919
                except errors.TagsNotSupported:
 
920
                    tags_to_fetch = set()
 
921
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
922
                    old_repository, required_ids=[self.last_revision()],
 
923
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
924
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
925
            finally:
819
926
                old_repository.unlock()
820
927
        finally:
825
932
 
826
933
        :seealso: Branch._get_tags_bytes.
827
934
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
935
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
936
        op.add_cleanup(self.lock_write().unlock)
 
937
        return op.run_simple(bytes)
 
938
 
 
939
    def _set_tags_bytes_locked(self, bytes):
 
940
        self._tags_bytes = bytes
 
941
        return self._transport.put_bytes('tags', bytes)
830
942
 
831
943
    def _cache_revision_history(self, rev_history):
832
944
        """Set the cached revision history to rev_history.
859
971
        self._revision_history_cache = None
860
972
        self._revision_id_to_revno_cache = None
861
973
        self._last_revision_info_cache = None
 
974
        self._master_branch_cache = None
862
975
        self._merge_sorted_revisions_cache = None
863
976
        self._partial_revision_history_cache = []
864
977
        self._partial_revision_id_to_revno_cache = {}
 
978
        self._tags_bytes = None
865
979
 
866
980
    def _gen_revision_history(self):
867
981
        """Return sequence of revision hashes on to this branch.
917
1031
        :return: A tuple (revno, revision_id).
918
1032
        """
919
1033
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1034
            self._last_revision_info_cache = self._read_last_revision_info()
921
1035
        return self._last_revision_info_cache
922
1036
 
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
 
 
 
1037
    def _read_last_revision_info(self):
 
1038
        raise NotImplementedError(self._read_last_revision_info)
 
1039
 
 
1040
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1041
    def import_last_revision_info(self, source_repo, revno, revid):
971
1042
        """Set the last revision info, importing from another repo if necessary.
972
1043
 
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
1044
        :param source_repo: Source repository to optionally fetch from
977
1045
        :param revno: Revision number of the new tip
978
1046
        :param revid: Revision id of the new tip
981
1049
            self.repository.fetch(source_repo, revision_id=revid)
982
1050
        self.set_last_revision_info(revno, revid)
983
1051
 
 
1052
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1053
                                           lossy=False):
 
1054
        """Set the last revision info, importing from another repo if necessary.
 
1055
 
 
1056
        This is used by the bound branch code to upload a revision to
 
1057
        the master branch first before updating the tip of the local branch.
 
1058
        Revisions referenced by source's tags are also transferred.
 
1059
 
 
1060
        :param source: Source branch to optionally fetch from
 
1061
        :param revno: Revision number of the new tip
 
1062
        :param revid: Revision id of the new tip
 
1063
        :param lossy: Whether to discard metadata that can not be
 
1064
            natively represented
 
1065
        :return: Tuple with the new revision number and revision id
 
1066
            (should only be different from the arguments when lossy=True)
 
1067
        """
 
1068
        if not self.repository.has_same_location(source.repository):
 
1069
            self.fetch(source, revid)
 
1070
        self.set_last_revision_info(revno, revid)
 
1071
        return (revno, revid)
 
1072
 
984
1073
    def revision_id_to_revno(self, revision_id):
985
1074
        """Given a revision id, return its revno"""
986
1075
        if _mod_revision.is_null(revision_id):
1006
1095
            self._extend_partial_history(distance_from_last)
1007
1096
        return self._partial_revision_history_cache[distance_from_last]
1008
1097
 
1009
 
    @needs_write_lock
1010
1098
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1099
             possible_transports=None, *args, **kwargs):
1012
1100
        """Mirror source into this branch.
1019
1107
            stop_revision=stop_revision,
1020
1108
            possible_transports=possible_transports, *args, **kwargs)
1021
1109
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1110
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1111
            *args, **kwargs):
1024
1112
        """Mirror this branch into target.
1025
1113
 
1026
1114
        This branch is considered to be 'local', having low latency.
1027
1115
        """
1028
1116
        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)
 
1117
            lossy, *args, **kwargs)
1051
1118
 
1052
1119
    def basis_tree(self):
1053
1120
        """Return `Tree` object for last revision."""
1208
1275
        return result
1209
1276
 
1210
1277
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1278
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1279
            repository=None):
1212
1280
        """Create a new line of development from the branch, into to_bzrdir.
1213
1281
 
1214
1282
        to_bzrdir controls the branch format.
1219
1287
        if (repository_policy is not None and
1220
1288
            repository_policy.requires_stacking()):
1221
1289
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1290
        result = to_bzrdir.create_branch(repository=repository)
1223
1291
        result.lock_write()
1224
1292
        try:
1225
1293
            if repository_policy is not None:
1226
1294
                repository_policy.configure_branch(result)
1227
1295
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1296
            master_url = self.get_bound_location()
 
1297
            if master_url is None:
 
1298
                result.set_parent(self.bzrdir.root_transport.base)
 
1299
            else:
 
1300
                result.set_parent(master_url)
1229
1301
        finally:
1230
1302
            result.unlock()
1231
1303
        return result
1255
1327
                revno = 1
1256
1328
        destination.set_last_revision_info(revno, revision_id)
1257
1329
 
1258
 
    @needs_read_lock
1259
1330
    def copy_content_into(self, destination, revision_id=None):
1260
1331
        """Copy the content of self into destination.
1261
1332
 
1262
1333
        revision_id: if not None, the revision history in the new branch will
1263
1334
                     be truncated to end with revision_id.
1264
1335
        """
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)
 
1336
        return InterBranch.get(self, destination).copy_content_into(
 
1337
            revision_id=revision_id)
1276
1338
 
1277
1339
    def update_references(self, target):
1278
1340
        if not getattr(self._format, 'supports_reference_locations', False):
1323
1385
        """Return the most suitable metadir for a checkout of this branch.
1324
1386
        Weaves are used if this branch's repository uses weaves.
1325
1387
        """
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)
 
1388
        format = self.repository.bzrdir.checkout_metadir()
 
1389
        format.set_branch_format(self._format)
1333
1390
        return format
1334
1391
 
1335
1392
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1393
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1394
        no_tree=None):
1337
1395
        """Create a clone of this branch and its bzrdir.
1338
1396
 
1339
1397
        :param to_transport: The transport to clone onto.
1346
1404
        """
1347
1405
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1406
        # clone call. Or something. 20090224 RBC/spiv.
 
1407
        # XXX: Should this perhaps clone colocated branches as well, 
 
1408
        # rather than just the default branch? 20100319 JRV
1349
1409
        if revision_id is None:
1350
1410
            revision_id = self.last_revision()
1351
1411
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1412
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1413
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1414
            no_tree=no_tree)
1354
1415
        return dir_to.open_branch()
1355
1416
 
1356
1417
    def create_checkout(self, to_location, revision_id=None,
1361
1422
        :param to_location: The url to produce the checkout at
1362
1423
        :param revision_id: The revision to check out
1363
1424
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1425
            produce a bound branch (heavyweight checkout)
1365
1426
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1427
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1428
            The revision tree will be used for cases where accelerator_tree's
1413
1474
 
1414
1475
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1476
        """Return the parent branch for a tree-reference file_id
 
1477
 
1416
1478
        :param file_id: The file_id of the tree reference
1417
1479
        :param path: The path of the file_id in the tree
1418
1480
        :return: A branch associated with the file_id
1471
1533
        else:
1472
1534
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1535
 
1474
 
 
1475
 
class BranchFormat(object):
 
1536
    def heads_to_fetch(self):
 
1537
        """Return the heads that must and that should be fetched to copy this
 
1538
        branch into another repo.
 
1539
 
 
1540
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1541
            set of heads that must be fetched.  if_present_fetch is a set of
 
1542
            heads that must be fetched if present, but no error is necessary if
 
1543
            they are not present.
 
1544
        """
 
1545
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1546
        # are the tags.
 
1547
        must_fetch = set([self.last_revision()])
 
1548
        if_present_fetch = set()
 
1549
        c = self.get_config()
 
1550
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1551
                                                 default=False)
 
1552
        if include_tags:
 
1553
            try:
 
1554
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1555
            except errors.TagsNotSupported:
 
1556
                pass
 
1557
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1558
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1559
        return must_fetch, if_present_fetch
 
1560
 
 
1561
 
 
1562
class BranchFormat(controldir.ControlComponentFormat):
1476
1563
    """An encapsulation of the initialization and open routines for a format.
1477
1564
 
1478
1565
    Formats provide three things:
1481
1568
     * an open routine.
1482
1569
 
1483
1570
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1571
    during branch opening. It's not required that these be instances, they
1485
1572
    can be classes themselves with class methods - it simply depends on
1486
1573
    whether state is needed for a given format or not.
1487
1574
 
1490
1577
    object will be created every time regardless.
1491
1578
    """
1492
1579
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
1580
    can_set_append_revisions_only = True
1500
1581
 
1501
1582
    def __eq__(self, other):
1510
1591
        try:
1511
1592
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1593
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1594
            return format_registry.get(format_string)
1514
1595
        except errors.NoSuchFile:
1515
1596
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1597
        except KeyError:
1517
1598
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1599
 
1519
1600
    @classmethod
 
1601
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1602
    def get_default_format(klass):
1521
1603
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1604
        return format_registry.get_default()
 
1605
 
 
1606
    @classmethod
 
1607
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1608
    def get_formats(klass):
 
1609
        """Get all the known formats.
 
1610
 
 
1611
        Warning: This triggers a load of all lazy registered formats: do not
 
1612
        use except when that is desireed.
 
1613
        """
 
1614
        return format_registry._get_all()
 
1615
 
 
1616
    def get_reference(self, a_bzrdir, name=None):
1525
1617
        """Get the target reference of the branch in a_bzrdir.
1526
1618
 
1527
1619
        format probing must have been completed before calling
1529
1621
        in a_bzrdir is correct.
1530
1622
 
1531
1623
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1624
        :param name: Name of the colocated branch to fetch
1532
1625
        :return: None if the branch is not a reference branch.
1533
1626
        """
1534
1627
        return None
1535
1628
 
1536
1629
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1630
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1631
        """Set the target reference of the branch in a_bzrdir.
1539
1632
 
1540
1633
        format probing must have been completed before calling
1542
1635
        in a_bzrdir is correct.
1543
1636
 
1544
1637
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1638
        :param name: Name of colocated branch to set, None for default
1545
1639
        :param to_branch: branch that the checkout is to reference
1546
1640
        """
1547
1641
        raise NotImplementedError(self.set_reference)
1562
1656
        for hook in hooks:
1563
1657
            hook(params)
1564
1658
 
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):
 
1659
    def initialize(self, a_bzrdir, name=None, repository=None):
1611
1660
        """Create a branch of this format in a_bzrdir.
1612
1661
        
1613
1662
        :param name: Name of the colocated branch to create.
1647
1696
        """
1648
1697
        raise NotImplementedError(self.network_name)
1649
1698
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1699
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1700
            found_repository=None):
1651
1701
        """Return the branch object for a_bzrdir
1652
1702
 
1653
1703
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1710
        raise NotImplementedError(self.open)
1661
1711
 
1662
1712
    @classmethod
 
1713
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1714
    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__)
 
1715
        """Register a metadir format.
 
1716
 
 
1717
        See MetaDirBranchFormatFactory for the ability to register a format
 
1718
        without loading the code the format needs until it is actually used.
 
1719
        """
 
1720
        format_registry.register(format)
1669
1721
 
1670
1722
    @classmethod
 
1723
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1724
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1725
        format_registry.set_default(format)
1673
1726
 
1674
1727
    def supports_set_append_revisions_only(self):
1675
1728
        """True if this format supports set_append_revisions_only."""
1679
1732
        """True if this format records a stacked-on branch."""
1680
1733
        return False
1681
1734
 
 
1735
    def supports_leaving_lock(self):
 
1736
        """True if this format supports leaving locks in place."""
 
1737
        return False # by default
 
1738
 
1682
1739
    @classmethod
 
1740
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1741
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1742
        format_registry.remove(format)
1685
1743
 
1686
1744
    def __str__(self):
1687
1745
        return self.get_format_description().rstrip()
1691
1749
        return False  # by default
1692
1750
 
1693
1751
 
 
1752
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1753
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1754
    
 
1755
    While none of the built in BranchFormats are lazy registered yet,
 
1756
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1757
    use it, and the bzr-loom plugin uses it as well (see
 
1758
    bzrlib.plugins.loom.formats).
 
1759
    """
 
1760
 
 
1761
    def __init__(self, format_string, module_name, member_name):
 
1762
        """Create a MetaDirBranchFormatFactory.
 
1763
 
 
1764
        :param format_string: The format string the format has.
 
1765
        :param module_name: Module to load the format class from.
 
1766
        :param member_name: Attribute name within the module for the format class.
 
1767
        """
 
1768
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1769
        self._format_string = format_string
 
1770
        
 
1771
    def get_format_string(self):
 
1772
        """See BranchFormat.get_format_string."""
 
1773
        return self._format_string
 
1774
 
 
1775
    def __call__(self):
 
1776
        """Used for network_format_registry support."""
 
1777
        return self.get_obj()()
 
1778
 
 
1779
 
1694
1780
class BranchHooks(Hooks):
1695
1781
    """A dictionary mapping hook name to a list of callables for branch hooks.
1696
1782
 
1704
1790
        These are all empty initially, because by default nothing should get
1705
1791
        notified.
1706
1792
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1793
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1794
        self.add_hook('set_rh',
1709
1795
            "Invoked whenever the revision history has been set via "
1710
1796
            "set_revision_history. The api signature is (branch, "
1711
1797
            "revision_history), and the branch will be write-locked. "
1712
1798
            "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',
 
1799
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1800
        self.add_hook('open',
1715
1801
            "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',
 
1802
            "branch is opened.", (1, 8))
 
1803
        self.add_hook('post_push',
1718
1804
            "Called after a push operation completes. post_push is called "
1719
1805
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1806
            "bzr client.", (0, 15))
 
1807
        self.add_hook('post_pull',
1722
1808
            "Called after a pull operation completes. post_pull is called "
1723
1809
            "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 "
 
1810
            "bzr client.", (0, 15))
 
1811
        self.add_hook('pre_commit',
 
1812
            "Called after a commit is calculated but before it is "
1727
1813
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1814
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1815
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1817
            "basis revision. hooks MUST NOT modify this delta. "
1732
1818
            " future_tree is an in-memory tree obtained from "
1733
1819
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1820
            "tree.", (0,91))
 
1821
        self.add_hook('post_commit',
1736
1822
            "Called in the bzr client after a commit has completed. "
1737
1823
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1824
            "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',
 
1825
            "commit to a branch.", (0, 15))
 
1826
        self.add_hook('post_uncommit',
1741
1827
            "Called in the bzr client after an uncommit completes. "
1742
1828
            "post_uncommit is called with (local, master, old_revno, "
1743
1829
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1830
            "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',
 
1831
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1832
        self.add_hook('pre_change_branch_tip',
1747
1833
            "Called in bzr client and server before a change to the tip of a "
1748
1834
            "branch is made. pre_change_branch_tip is called with a "
1749
1835
            "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',
 
1836
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1837
        self.add_hook('post_change_branch_tip',
1752
1838
            "Called in bzr client and server after a change to the tip of a "
1753
1839
            "branch is made. post_change_branch_tip is called with a "
1754
1840
            "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',
 
1841
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1842
        self.add_hook('transform_fallback_location',
1757
1843
            "Called when a stacked branch is activating its fallback "
1758
1844
            "locations. transform_fallback_location is called with (branch, "
1759
1845
            "url), and should return a new url. Returning the same url "
1764
1850
            "fallback locations have not been activated. When there are "
1765
1851
            "multiple hooks installed for transform_fallback_location, "
1766
1852
            "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."
 
1853
            "The order is however undefined.", (1, 9))
 
1854
        self.add_hook('automatic_tag_name',
 
1855
            "Called to determine an automatic tag name for a revision. "
1770
1856
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1857
            "should return a tag name or None if no tag name could be "
1772
1858
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1859
            (2, 2))
 
1860
        self.add_hook('post_branch_init',
1775
1861
            "Called after new branch initialization completes. "
1776
1862
            "post_branch_init is called with a "
1777
1863
            "bzrlib.branch.BranchInitHookParams. "
1778
1864
            "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',
 
1865
            "lightweight) will all trigger this hook.", (2, 2))
 
1866
        self.add_hook('post_switch',
1781
1867
            "Called after a checkout switches branch. "
1782
1868
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1869
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1870
 
1785
1871
 
1786
1872
 
1789
1875
 
1790
1876
 
1791
1877
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1878
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1879
 
1794
1880
    There are 5 fields that hooks may wish to access:
1795
1881
 
1827
1913
 
1828
1914
 
1829
1915
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1916
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1917
 
1832
1918
    There are 4 fields that hooks may wish to access:
1833
1919
 
1863
1949
        return self.__dict__ == other.__dict__
1864
1950
 
1865
1951
    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)
 
1952
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1953
 
1873
1954
 
1874
1955
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1956
    """Object holding parameters passed to `*_switch` hooks.
1876
1957
 
1877
1958
    There are 4 fields that hooks may wish to access:
1878
1959
 
1904
1985
            self.revision_id)
1905
1986
 
1906
1987
 
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
1988
class BranchFormatMetadir(BranchFormat):
1951
1989
    """Common logic for meta-dir based branch formats."""
1952
1990
 
1954
1992
        """What class to instantiate on open calls."""
1955
1993
        raise NotImplementedError(self._branch_class)
1956
1994
 
 
1995
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1996
                           repository=None):
 
1997
        """Initialize a branch in a bzrdir, with specified files
 
1998
 
 
1999
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2000
        :param utf8_files: The files to create as a list of
 
2001
            (filename, content) tuples
 
2002
        :param name: Name of colocated branch to create, if any
 
2003
        :return: a branch in this format
 
2004
        """
 
2005
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2006
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2007
        control_files = lockable_files.LockableFiles(branch_transport,
 
2008
            'lock', lockdir.LockDir)
 
2009
        control_files.create_lock()
 
2010
        control_files.lock_write()
 
2011
        try:
 
2012
            utf8_files += [('format', self.get_format_string())]
 
2013
            for (filename, content) in utf8_files:
 
2014
                branch_transport.put_bytes(
 
2015
                    filename, content,
 
2016
                    mode=a_bzrdir._get_file_mode())
 
2017
        finally:
 
2018
            control_files.unlock()
 
2019
        branch = self.open(a_bzrdir, name, _found=True,
 
2020
                found_repository=repository)
 
2021
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2022
        return branch
 
2023
 
1957
2024
    def network_name(self):
1958
2025
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2026
 
1961
2028
        """
1962
2029
        return self.get_format_string()
1963
2030
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2031
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2032
            found_repository=None):
1965
2033
        """See BranchFormat.open()."""
1966
2034
        if not _found:
1967
2035
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2040
        try:
1973
2041
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2042
                                                         lockdir.LockDir)
 
2043
            if found_repository is None:
 
2044
                found_repository = a_bzrdir.find_repository()
1975
2045
            return self._branch_class()(_format=self,
1976
2046
                              _control_files=control_files,
1977
2047
                              name=name,
1978
2048
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2049
                              _repository=found_repository,
1980
2050
                              ignore_fallbacks=ignore_fallbacks)
1981
2051
        except errors.NoSuchFile:
1982
2052
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2059
    def supports_tags(self):
1990
2060
        return True
1991
2061
 
 
2062
    def supports_leaving_lock(self):
 
2063
        return True
 
2064
 
1992
2065
 
1993
2066
class BzrBranchFormat5(BranchFormatMetadir):
1994
2067
    """Bzr branch format 5.
2014
2087
        """See BranchFormat.get_format_description()."""
2015
2088
        return "Branch format 5"
2016
2089
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2090
    def initialize(self, a_bzrdir, name=None, repository=None):
2018
2091
        """Create a branch of this format in a_bzrdir."""
2019
2092
        utf8_files = [('revision-history', ''),
2020
2093
                      ('branch-name', ''),
2021
2094
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2095
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2096
 
2024
2097
    def supports_tags(self):
2025
2098
        return False
2047
2120
        """See BranchFormat.get_format_description()."""
2048
2121
        return "Branch format 6"
2049
2122
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2123
    def initialize(self, a_bzrdir, name=None, repository=None):
2051
2124
        """Create a branch of this format in a_bzrdir."""
2052
2125
        utf8_files = [('last-revision', '0 null:\n'),
2053
2126
                      ('branch.conf', ''),
2054
2127
                      ('tags', ''),
2055
2128
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2129
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2130
 
2058
2131
    def make_tags(self, branch):
2059
2132
        """See bzrlib.branch.BranchFormat.make_tags()."""
2077
2150
        """See BranchFormat.get_format_description()."""
2078
2151
        return "Branch format 8"
2079
2152
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2153
    def initialize(self, a_bzrdir, name=None, repository=None):
2081
2154
        """Create a branch of this format in a_bzrdir."""
2082
2155
        utf8_files = [('last-revision', '0 null:\n'),
2083
2156
                      ('branch.conf', ''),
2084
2157
                      ('tags', ''),
2085
2158
                      ('references', '')
2086
2159
                      ]
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()
 
2160
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2161
 
2094
2162
    def make_tags(self, branch):
2095
2163
        """See bzrlib.branch.BranchFormat.make_tags()."""
2104
2172
    supports_reference_locations = True
2105
2173
 
2106
2174
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2175
class BzrBranchFormat7(BranchFormatMetadir):
2108
2176
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2177
 
2110
2178
    The stacked location pointer is passed down to the repository and requires
2113
2181
    This format was introduced in bzr 1.6.
2114
2182
    """
2115
2183
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2184
    def initialize(self, a_bzrdir, name=None, repository=None):
2117
2185
        """Create a branch of this format in a_bzrdir."""
2118
2186
        utf8_files = [('last-revision', '0 null:\n'),
2119
2187
                      ('branch.conf', ''),
2120
2188
                      ('tags', ''),
2121
2189
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2190
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2191
 
2124
2192
    def _branch_class(self):
2125
2193
        return BzrBranch7
2135
2203
    def supports_set_append_revisions_only(self):
2136
2204
        return True
2137
2205
 
 
2206
    def supports_stacking(self):
 
2207
        return True
 
2208
 
 
2209
    def make_tags(self, branch):
 
2210
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2211
        return BasicTags(branch)
 
2212
 
2138
2213
    supports_reference_locations = False
2139
2214
 
2140
2215
 
2157
2232
        """See BranchFormat.get_format_description()."""
2158
2233
        return "Checkout reference format 1"
2159
2234
 
2160
 
    def get_reference(self, a_bzrdir):
 
2235
    def get_reference(self, a_bzrdir, name=None):
2161
2236
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2237
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2238
        return transport.get_bytes('location')
2164
2239
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2240
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2241
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2242
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2243
        location = transport.put_bytes('location', to_branch.base)
2169
2244
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2245
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2246
            repository=None):
2171
2247
        """Create a branch of this format in a_bzrdir."""
2172
2248
        if target_branch is None:
2173
2249
            # this format does not implement branch itself, thus the implicit
2201
2277
        return clone
2202
2278
 
2203
2279
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2280
             possible_transports=None, ignore_fallbacks=False,
 
2281
             found_repository=None):
2205
2282
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2283
 
2207
2284
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2298
                raise AssertionError("wrong format %r found for %r" %
2222
2299
                    (format, self))
2223
2300
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2301
            location = self.get_reference(a_bzrdir, name)
2225
2302
        real_bzrdir = bzrdir.BzrDir.open(
2226
2303
            location, possible_transports=possible_transports)
2227
2304
        result = real_bzrdir.open_branch(name=name, 
2238
2315
        return result
2239
2316
 
2240
2317
 
 
2318
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2319
    """Branch format registry."""
 
2320
 
 
2321
    def __init__(self, other_registry=None):
 
2322
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2323
        self._default_format = None
 
2324
 
 
2325
    def set_default(self, format):
 
2326
        self._default_format = format
 
2327
 
 
2328
    def get_default(self):
 
2329
        return self._default_format
 
2330
 
 
2331
 
2241
2332
network_format_registry = registry.FormatRegistry()
2242
2333
"""Registry of formats indexed by their network name.
2243
2334
 
2246
2337
BranchFormat.network_name() for more detail.
2247
2338
"""
2248
2339
 
 
2340
format_registry = BranchFormatRegistry(network_format_registry)
 
2341
 
2249
2342
 
2250
2343
# formats which have no format string are not discoverable
2251
2344
# and not independently creatable, so are not registered.
2253
2346
__format6 = BzrBranchFormat6()
2254
2347
__format7 = BzrBranchFormat7()
2255
2348
__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__)
 
2349
format_registry.register(__format5)
 
2350
format_registry.register(BranchReferenceFormat())
 
2351
format_registry.register(__format6)
 
2352
format_registry.register(__format7)
 
2353
format_registry.register(__format8)
 
2354
format_registry.set_default(__format7)
 
2355
 
 
2356
 
 
2357
class BranchWriteLockResult(LogicalLockResult):
 
2358
    """The result of write locking a branch.
 
2359
 
 
2360
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2361
        None.
 
2362
    :ivar unlock: A callable which will unlock the lock.
 
2363
    """
 
2364
 
 
2365
    def __init__(self, unlock, branch_token):
 
2366
        LogicalLockResult.__init__(self, unlock)
 
2367
        self.branch_token = branch_token
 
2368
 
 
2369
    def __repr__(self):
 
2370
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2371
            self.unlock)
2266
2372
 
2267
2373
 
2268
2374
class BzrBranch(Branch, _RelockDebugMixin):
2324
2430
        return self.control_files.is_locked()
2325
2431
 
2326
2432
    def lock_write(self, token=None):
 
2433
        """Lock the branch for write operations.
 
2434
 
 
2435
        :param token: A token to permit reacquiring a previously held and
 
2436
            preserved lock.
 
2437
        :return: A BranchWriteLockResult.
 
2438
        """
2327
2439
        if not self.is_locked():
2328
2440
            self._note_lock('w')
2329
2441
        # All-in-one needs to always unlock/lock.
2335
2447
        else:
2336
2448
            took_lock = False
2337
2449
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2450
            return BranchWriteLockResult(self.unlock,
 
2451
                self.control_files.lock_write(token=token))
2339
2452
        except:
2340
2453
            if took_lock:
2341
2454
                self.repository.unlock()
2342
2455
            raise
2343
2456
 
2344
2457
    def lock_read(self):
 
2458
        """Lock the branch for read operations.
 
2459
 
 
2460
        :return: A bzrlib.lock.LogicalLockResult.
 
2461
        """
2345
2462
        if not self.is_locked():
2346
2463
            self._note_lock('r')
2347
2464
        # All-in-one needs to always unlock/lock.
2354
2471
            took_lock = False
2355
2472
        try:
2356
2473
            self.control_files.lock_read()
 
2474
            return LogicalLockResult(self.unlock)
2357
2475
        except:
2358
2476
            if took_lock:
2359
2477
                self.repository.unlock()
2387
2505
        """See Branch.print_file."""
2388
2506
        return self.repository.print_file(file, revision_id)
2389
2507
 
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
2508
    @needs_write_lock
2454
2509
    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
 
        """
 
2510
        if not revision_id or not isinstance(revision_id, basestring):
 
2511
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2512
        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))
 
2513
        old_revno, old_revid = self.last_revision_info()
 
2514
        if self._get_append_revisions_only():
 
2515
            self._check_history_violation(revision_id)
 
2516
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2517
        self._write_last_revision_info(revno, revision_id)
 
2518
        self._clear_cached_state()
 
2519
        self._last_revision_info_cache = revno, revision_id
 
2520
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2521
 
2495
2522
    def basis_tree(self):
2496
2523
        """See Branch.basis_tree."""
2505
2532
                pass
2506
2533
        return None
2507
2534
 
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
2535
    def get_stacked_on_url(self):
2531
2536
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2537
 
2543
2548
            self._transport.put_bytes('parent', url + '\n',
2544
2549
                mode=self.bzrdir._get_file_mode())
2545
2550
 
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
2551
    @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
 
2552
    def unbind(self):
 
2553
        """If bound, unbind"""
 
2554
        return self.set_bound_location(None)
2595
2555
 
2596
2556
    @needs_write_lock
2597
2557
    def bind(self, other):
2619
2579
        # history around
2620
2580
        self.set_bound_location(other.base)
2621
2581
 
 
2582
    def get_bound_location(self):
 
2583
        try:
 
2584
            return self._transport.get_bytes('bound')[:-1]
 
2585
        except errors.NoSuchFile:
 
2586
            return None
 
2587
 
 
2588
    @needs_read_lock
 
2589
    def get_master_branch(self, possible_transports=None):
 
2590
        """Return the branch we are bound to.
 
2591
 
 
2592
        :return: Either a Branch, or None
 
2593
        """
 
2594
        if self._master_branch_cache is None:
 
2595
            self._master_branch_cache = self._get_master_branch(
 
2596
                possible_transports)
 
2597
        return self._master_branch_cache
 
2598
 
 
2599
    def _get_master_branch(self, possible_transports):
 
2600
        bound_loc = self.get_bound_location()
 
2601
        if not bound_loc:
 
2602
            return None
 
2603
        try:
 
2604
            return Branch.open(bound_loc,
 
2605
                               possible_transports=possible_transports)
 
2606
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2607
            raise errors.BoundBranchConnectionFailure(
 
2608
                    self, bound_loc, e)
 
2609
 
2622
2610
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2611
    def set_bound_location(self, location):
 
2612
        """Set the target where this branch is bound to.
 
2613
 
 
2614
        :param location: URL to the target branch
 
2615
        """
 
2616
        self._master_branch_cache = None
 
2617
        if location:
 
2618
            self._transport.put_bytes('bound', location+'\n',
 
2619
                mode=self.bzrdir._get_file_mode())
 
2620
        else:
 
2621
            try:
 
2622
                self._transport.delete('bound')
 
2623
            except errors.NoSuchFile:
 
2624
                return False
 
2625
            return True
2626
2626
 
2627
2627
    @needs_write_lock
2628
2628
    def update(self, possible_transports=None):
2641
2641
            return old_tip
2642
2642
        return None
2643
2643
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2644
    def _read_last_revision_info(self):
 
2645
        revision_string = self._transport.get_bytes('last-revision')
 
2646
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2647
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2648
        revno = int(revno)
 
2649
        return revno, revision_id
 
2650
 
 
2651
    def _write_last_revision_info(self, revno, revision_id):
 
2652
        """Simply write out the revision id, with no checks.
 
2653
 
 
2654
        Use set_last_revision_info to perform this safely.
 
2655
 
 
2656
        Does not update the revision_history cache.
 
2657
        """
 
2658
        revision_id = _mod_revision.ensure_null(revision_id)
 
2659
        out_string = '%d %s\n' % (revno, revision_id)
 
2660
        self._transport.put_bytes('last-revision', out_string,
 
2661
            mode=self.bzrdir._get_file_mode())
 
2662
 
 
2663
 
 
2664
class FullHistoryBzrBranch(BzrBranch):
 
2665
    """Bzr branch which contains the full revision history."""
 
2666
 
 
2667
    @needs_write_lock
 
2668
    def set_last_revision_info(self, revno, revision_id):
 
2669
        if not revision_id or not isinstance(revision_id, basestring):
 
2670
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2671
        revision_id = _mod_revision.ensure_null(revision_id)
 
2672
        # this old format stores the full history, but this api doesn't
 
2673
        # provide it, so we must generate, and might as well check it's
 
2674
        # correct
 
2675
        history = self._lefthand_history(revision_id)
 
2676
        if len(history) != revno:
 
2677
            raise AssertionError('%d != %d' % (len(history), revno))
 
2678
        self._set_revision_history(history)
 
2679
 
 
2680
    def _read_last_revision_info(self):
 
2681
        rh = self.revision_history()
 
2682
        revno = len(rh)
 
2683
        if revno:
 
2684
            return (revno, rh[-1])
 
2685
        else:
 
2686
            return (0, _mod_revision.NULL_REVISION)
 
2687
 
 
2688
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2689
    @needs_write_lock
 
2690
    def set_revision_history(self, rev_history):
 
2691
        """See Branch.set_revision_history."""
 
2692
        self._set_revision_history(rev_history)
 
2693
 
 
2694
    def _set_revision_history(self, rev_history):
 
2695
        if 'evil' in debug.debug_flags:
 
2696
            mutter_callsite(3, "set_revision_history scales with history.")
 
2697
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2698
        for rev_id in rev_history:
 
2699
            check_not_reserved_id(rev_id)
 
2700
        if Branch.hooks['post_change_branch_tip']:
 
2701
            # Don't calculate the last_revision_info() if there are no hooks
 
2702
            # that will use it.
 
2703
            old_revno, old_revid = self.last_revision_info()
 
2704
        if len(rev_history) == 0:
 
2705
            revid = _mod_revision.NULL_REVISION
 
2706
        else:
 
2707
            revid = rev_history[-1]
 
2708
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2709
        self._write_revision_history(rev_history)
 
2710
        self._clear_cached_state()
 
2711
        self._cache_revision_history(rev_history)
 
2712
        for hook in Branch.hooks['set_rh']:
 
2713
            hook(self, rev_history)
 
2714
        if Branch.hooks['post_change_branch_tip']:
 
2715
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2716
 
 
2717
    def _write_revision_history(self, history):
 
2718
        """Factored out of set_revision_history.
 
2719
 
 
2720
        This performs the actual writing to disk.
 
2721
        It is intended to be called by set_revision_history."""
 
2722
        self._transport.put_bytes(
 
2723
            'revision-history', '\n'.join(history),
 
2724
            mode=self.bzrdir._get_file_mode())
 
2725
 
 
2726
    def _gen_revision_history(self):
 
2727
        history = self._transport.get_bytes('revision-history').split('\n')
 
2728
        if history[-1:] == ['']:
 
2729
            # There shouldn't be a trailing newline, but just in case.
 
2730
            history.pop()
 
2731
        return history
 
2732
 
 
2733
    def _synchronize_history(self, destination, revision_id):
 
2734
        if not isinstance(destination, FullHistoryBzrBranch):
 
2735
            super(BzrBranch, self)._synchronize_history(
 
2736
                destination, revision_id)
 
2737
            return
 
2738
        if revision_id == _mod_revision.NULL_REVISION:
 
2739
            new_history = []
 
2740
        else:
 
2741
            new_history = self.revision_history()
 
2742
        if revision_id is not None and new_history != []:
 
2743
            try:
 
2744
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2745
            except ValueError:
 
2746
                rev = self.repository.get_revision(revision_id)
 
2747
                new_history = rev.get_history(self.repository)[1:]
 
2748
        destination._set_revision_history(new_history)
 
2749
 
 
2750
    @needs_write_lock
 
2751
    def generate_revision_history(self, revision_id, last_rev=None,
 
2752
        other_branch=None):
 
2753
        """Create a new revision history that will finish with revision_id.
 
2754
 
 
2755
        :param revision_id: the new tip to use.
 
2756
        :param last_rev: The previous last_revision. If not None, then this
 
2757
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2758
        :param other_branch: The other branch that DivergedBranches should
 
2759
            raise with respect to.
 
2760
        """
 
2761
        self._set_revision_history(self._lefthand_history(revision_id,
 
2762
            last_rev, other_branch))
 
2763
 
 
2764
 
 
2765
class BzrBranch5(FullHistoryBzrBranch):
 
2766
    """A format 5 branch. This supports new features over plain branches.
 
2767
 
 
2768
    It has support for a master_branch which is the data for bound branches.
 
2769
    """
 
2770
 
 
2771
 
 
2772
class BzrBranch8(BzrBranch):
2646
2773
    """A branch that stores tree-reference locations."""
2647
2774
 
2648
2775
    def _open_hook(self):
2674
2801
        self._last_revision_info_cache = None
2675
2802
        self._reference_info = None
2676
2803
 
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
2804
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2805
        current_revid = self.last_revision()
 
2806
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2807
        if _mod_revision.is_null(last_revision):
2725
2808
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2809
        graph = self.repository.get_graph()
 
2810
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2811
            if lh_ancestor == current_revid:
 
2812
                return
 
2813
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2814
 
2729
2815
    def _gen_revision_history(self):
2730
2816
        """Generate the revision history from last revision
2733
2819
        self._extend_partial_history(stop_index=last_revno-1)
2734
2820
        return list(reversed(self._partial_revision_history_cache))
2735
2821
 
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
2822
    @needs_write_lock
2753
2823
    def _set_parent_location(self, url):
2754
2824
        """Set the parent branch"""
2840
2910
 
2841
2911
    def set_bound_location(self, location):
2842
2912
        """See Branch.set_push_location."""
 
2913
        self._master_branch_cache = None
2843
2914
        result = None
2844
2915
        config = self.get_config()
2845
2916
        if location is None:
2876
2947
        # you can always ask for the URL; but you might not be able to use it
2877
2948
        # if the repo can't support stacking.
2878
2949
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2950
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2951
        # waste effort reading the whole stack of config files.
 
2952
        config = self.get_config()._get_branch_data_config()
 
2953
        stacked_url = self._get_config_location('stacked_on_location',
 
2954
            config=config)
2880
2955
        if stacked_url is None:
2881
2956
            raise errors.NotStacked(self)
2882
2957
        return stacked_url
2885
2960
        return self.get_config(
2886
2961
            ).get_user_option_as_bool('append_revisions_only')
2887
2962
 
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
2963
    @needs_read_lock
2897
2964
    def get_rev_id(self, revno, history=None):
2898
2965
        """Find the revision id of the specified revno."""
2922
2989
        try:
2923
2990
            index = self._partial_revision_history_cache.index(revision_id)
2924
2991
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
2992
            try:
 
2993
                self._extend_partial_history(stop_revision=revision_id)
 
2994
            except errors.RevisionNotPresent, e:
 
2995
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
2996
            index = len(self._partial_revision_history_cache) - 1
2927
2997
            if self._partial_revision_history_cache[index] != revision_id:
2928
2998
                raise errors.NoSuchRevision(self, revision_id)
2983
3053
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2984
3054
    """
2985
3055
 
 
3056
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3057
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3058
        """Return the relative change in revno.
 
3059
 
 
3060
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3061
        """
2988
3062
        return self.new_revno - self.old_revno
2989
3063
 
2990
3064
    def report(self, to_file):
3015
3089
        target, otherwise it will be None.
3016
3090
    """
3017
3091
 
 
3092
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3093
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3094
        """Return the relative change in revno.
 
3095
 
 
3096
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3097
        """
3020
3098
        return self.new_revno - self.old_revno
3021
3099
 
3022
3100
    def report(self, to_file):
3101
3179
        branch._transport.put_bytes('format', format.get_format_string())
3102
3180
 
3103
3181
 
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
3182
class InterBranch(InterObject):
3138
3183
    """This class represents operations taking place between two branches.
3139
3184
 
3145
3190
    _optimisers = []
3146
3191
    """The available optimised InterBranch types."""
3147
3192
 
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)
 
3193
    @classmethod
 
3194
    def _get_branch_formats_to_test(klass):
 
3195
        """Return an iterable of format tuples for testing.
 
3196
        
 
3197
        :return: An iterable of (from_format, to_format) to use when testing
 
3198
            this InterBranch class. Each InterBranch class should define this
 
3199
            method itself.
 
3200
        """
 
3201
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3202
 
 
3203
    @needs_write_lock
3153
3204
    def pull(self, overwrite=False, stop_revision=None,
3154
3205
             possible_transports=None, local=False):
3155
3206
        """Mirror source into target branch.
3160
3211
        """
3161
3212
        raise NotImplementedError(self.pull)
3162
3213
 
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,
 
3214
    @needs_write_lock
 
3215
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3216
             _override_hook_source_branch=None):
3178
3217
        """Mirror the source branch into the target branch.
3179
3218
 
3181
3220
        """
3182
3221
        raise NotImplementedError(self.push)
3183
3222
 
 
3223
    @needs_write_lock
 
3224
    def copy_content_into(self, revision_id=None):
 
3225
        """Copy the content of source into target
 
3226
 
 
3227
        revision_id: if not None, the revision history in the new branch will
 
3228
                     be truncated to end with revision_id.
 
3229
        """
 
3230
        raise NotImplementedError(self.copy_content_into)
 
3231
 
 
3232
    @needs_write_lock
 
3233
    def fetch(self, stop_revision=None, limit=None):
 
3234
        """Fetch revisions.
 
3235
 
 
3236
        :param stop_revision: Last revision to fetch
 
3237
        :param limit: Optional rough limit of revisions to fetch
 
3238
        """
 
3239
        raise NotImplementedError(self.fetch)
 
3240
 
3184
3241
 
3185
3242
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()."""
 
3243
    """InterBranch implementation that uses public Branch functions."""
 
3244
 
 
3245
    @classmethod
 
3246
    def is_compatible(klass, source, target):
 
3247
        # GenericBranch uses the public API, so always compatible
 
3248
        return True
 
3249
 
 
3250
    @classmethod
 
3251
    def _get_branch_formats_to_test(klass):
 
3252
        return [(format_registry.get_default(), format_registry.get_default())]
 
3253
 
 
3254
    @classmethod
 
3255
    def unwrap_format(klass, format):
 
3256
        if isinstance(format, remote.RemoteBranchFormat):
 
3257
            format._ensure_real()
 
3258
            return format._custom_format
 
3259
        return format
 
3260
 
 
3261
    @needs_write_lock
 
3262
    def copy_content_into(self, revision_id=None):
 
3263
        """Copy the content of source into target
 
3264
 
 
3265
        revision_id: if not None, the revision history in the new branch will
 
3266
                     be truncated to end with revision_id.
 
3267
        """
 
3268
        self.source.update_references(self.target)
 
3269
        self.source._synchronize_history(self.target, revision_id)
 
3270
        try:
 
3271
            parent = self.source.get_parent()
 
3272
        except errors.InaccessibleParent, e:
 
3273
            mutter('parent was not accessible to copy: %s', e)
 
3274
        else:
 
3275
            if parent:
 
3276
                self.target.set_parent(parent)
 
3277
        if self.source._push_should_merge_tags():
 
3278
            self.source.tags.merge_to(self.target.tags)
 
3279
 
 
3280
    @needs_write_lock
 
3281
    def fetch(self, stop_revision=None, limit=None):
 
3282
        if self.target.base == self.source.base:
 
3283
            return (0, [])
3196
3284
        self.source.lock_read()
3197
3285
        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)
 
3286
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3287
            fetch_spec_factory.source_branch = self.source
 
3288
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3289
            fetch_spec_factory.source_repo = self.source.repository
 
3290
            fetch_spec_factory.target_repo = self.target.repository
 
3291
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3292
            fetch_spec_factory.limit = limit
 
3293
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3294
            return self.target.repository.fetch(self.source.repository,
 
3295
                fetch_spec=fetch_spec)
3233
3296
        finally:
3234
3297
            self.source.unlock()
3235
3298
 
 
3299
    @needs_write_lock
 
3300
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3301
            graph=None):
 
3302
        other_revno, other_last_revision = self.source.last_revision_info()
 
3303
        stop_revno = None # unknown
 
3304
        if stop_revision is None:
 
3305
            stop_revision = other_last_revision
 
3306
            if _mod_revision.is_null(stop_revision):
 
3307
                # if there are no commits, we're done.
 
3308
                return
 
3309
            stop_revno = other_revno
 
3310
 
 
3311
        # what's the current last revision, before we fetch [and change it
 
3312
        # possibly]
 
3313
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3314
        # we fetch here so that we don't process data twice in the common
 
3315
        # case of having something to pull, and so that the check for
 
3316
        # already merged can operate on the just fetched graph, which will
 
3317
        # be cached in memory.
 
3318
        self.fetch(stop_revision=stop_revision)
 
3319
        # Check to see if one is an ancestor of the other
 
3320
        if not overwrite:
 
3321
            if graph is None:
 
3322
                graph = self.target.repository.get_graph()
 
3323
            if self.target._check_if_descendant_or_diverged(
 
3324
                    stop_revision, last_rev, graph, self.source):
 
3325
                # stop_revision is a descendant of last_rev, but we aren't
 
3326
                # overwriting, so we're done.
 
3327
                return
 
3328
        if stop_revno is None:
 
3329
            if graph is None:
 
3330
                graph = self.target.repository.get_graph()
 
3331
            this_revno, this_last_revision = \
 
3332
                    self.target.last_revision_info()
 
3333
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3334
                            [(other_last_revision, other_revno),
 
3335
                             (this_last_revision, this_revno)])
 
3336
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3337
 
 
3338
    @needs_write_lock
3236
3339
    def pull(self, overwrite=False, stop_revision=None,
 
3340
             possible_transports=None, run_hooks=True,
 
3341
             _override_hook_target=None, local=False):
 
3342
        """Pull from source into self, updating my master if any.
 
3343
 
 
3344
        :param run_hooks: Private parameter - if false, this branch
 
3345
            is being called because it's the master of the primary branch,
 
3346
            so it should not run its hooks.
 
3347
        """
 
3348
        bound_location = self.target.get_bound_location()
 
3349
        if local and not bound_location:
 
3350
            raise errors.LocalRequiresBoundBranch()
 
3351
        master_branch = None
 
3352
        source_is_master = False
 
3353
        if bound_location:
 
3354
            # bound_location comes from a config file, some care has to be
 
3355
            # taken to relate it to source.user_url
 
3356
            normalized = urlutils.normalize_url(bound_location)
 
3357
            try:
 
3358
                relpath = self.source.user_transport.relpath(normalized)
 
3359
                source_is_master = (relpath == '')
 
3360
            except (errors.PathNotChild, errors.InvalidURL):
 
3361
                source_is_master = False
 
3362
        if not local and bound_location and not source_is_master:
 
3363
            # not pulling from master, so we need to update master.
 
3364
            master_branch = self.target.get_master_branch(possible_transports)
 
3365
            master_branch.lock_write()
 
3366
        try:
 
3367
            if master_branch:
 
3368
                # pull from source into master.
 
3369
                master_branch.pull(self.source, overwrite, stop_revision,
 
3370
                    run_hooks=False)
 
3371
            return self._pull(overwrite,
 
3372
                stop_revision, _hook_master=master_branch,
 
3373
                run_hooks=run_hooks,
 
3374
                _override_hook_target=_override_hook_target,
 
3375
                merge_tags_to_master=not source_is_master)
 
3376
        finally:
 
3377
            if master_branch:
 
3378
                master_branch.unlock()
 
3379
 
 
3380
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3381
             _override_hook_source_branch=None):
 
3382
        """See InterBranch.push.
 
3383
 
 
3384
        This is the basic concrete implementation of push()
 
3385
 
 
3386
        :param _override_hook_source_branch: If specified, run the hooks
 
3387
            passing this Branch as the source, rather than self.  This is for
 
3388
            use of RemoteBranch, where push is delegated to the underlying
 
3389
            vfs-based Branch.
 
3390
        """
 
3391
        if lossy:
 
3392
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3393
        # TODO: Public option to disable running hooks - should be trivial but
 
3394
        # needs tests.
 
3395
 
 
3396
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3397
        op.add_cleanup(self.source.lock_read().unlock)
 
3398
        op.add_cleanup(self.target.lock_write().unlock)
 
3399
        return op.run(overwrite, stop_revision,
 
3400
            _override_hook_source_branch=_override_hook_source_branch)
 
3401
 
 
3402
    def _basic_push(self, overwrite, stop_revision):
 
3403
        """Basic implementation of push without bound branches or hooks.
 
3404
 
 
3405
        Must be called with source read locked and target write locked.
 
3406
        """
 
3407
        result = BranchPushResult()
 
3408
        result.source_branch = self.source
 
3409
        result.target_branch = self.target
 
3410
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3411
        self.source.update_references(self.target)
 
3412
        if result.old_revid != stop_revision:
 
3413
            # We assume that during 'push' this repository is closer than
 
3414
            # the target.
 
3415
            graph = self.source.repository.get_graph(self.target.repository)
 
3416
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3417
                    graph=graph)
 
3418
        if self.source._push_should_merge_tags():
 
3419
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3420
                overwrite)
 
3421
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3422
        return result
 
3423
 
 
3424
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3425
            _override_hook_source_branch=None):
 
3426
        """Push from source into target, and into target's master if any.
 
3427
        """
 
3428
        def _run_hooks():
 
3429
            if _override_hook_source_branch:
 
3430
                result.source_branch = _override_hook_source_branch
 
3431
            for hook in Branch.hooks['post_push']:
 
3432
                hook(result)
 
3433
 
 
3434
        bound_location = self.target.get_bound_location()
 
3435
        if bound_location and self.target.base != bound_location:
 
3436
            # there is a master branch.
 
3437
            #
 
3438
            # XXX: Why the second check?  Is it even supported for a branch to
 
3439
            # be bound to itself? -- mbp 20070507
 
3440
            master_branch = self.target.get_master_branch()
 
3441
            master_branch.lock_write()
 
3442
            operation.add_cleanup(master_branch.unlock)
 
3443
            # push into the master from the source branch.
 
3444
            master_inter = InterBranch.get(self.source, master_branch)
 
3445
            master_inter._basic_push(overwrite, stop_revision)
 
3446
            # and push into the target branch from the source. Note that
 
3447
            # we push from the source branch again, because it's considered
 
3448
            # the highest bandwidth repository.
 
3449
            result = self._basic_push(overwrite, stop_revision)
 
3450
            result.master_branch = master_branch
 
3451
            result.local_branch = self.target
 
3452
        else:
 
3453
            master_branch = None
 
3454
            # no master branch
 
3455
            result = self._basic_push(overwrite, stop_revision)
 
3456
            # TODO: Why set master_branch and local_branch if there's no
 
3457
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3458
            # 20070504
 
3459
            result.master_branch = self.target
 
3460
            result.local_branch = None
 
3461
        _run_hooks()
 
3462
        return result
 
3463
 
 
3464
    def _pull(self, overwrite=False, stop_revision=None,
3237
3465
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3466
             _override_hook_target=None, local=False,
 
3467
             merge_tags_to_master=True):
3239
3468
        """See Branch.pull.
3240
3469
 
 
3470
        This function is the core worker, used by GenericInterBranch.pull to
 
3471
        avoid duplication when pulling source->master and source->local.
 
3472
 
3241
3473
        :param _hook_master: Private parameter - set the branch to
3242
3474
            be supplied as the master to pull hooks.
3243
3475
        :param run_hooks: Private parameter - if false, this branch
3244
3476
            is being called because it's the master of the primary branch,
3245
3477
            so it should not run its hooks.
 
3478
            is being called because it's the master of the primary branch,
 
3479
            so it should not run its hooks.
3246
3480
        :param _override_hook_target: Private parameter - set the branch to be
3247
3481
            supplied as the target_branch to pull hooks.
3248
3482
        :param local: Only update the local branch, and not the bound branch.
3267
3501
            # -- JRV20090506
3268
3502
            result.old_revno, result.old_revid = \
3269
3503
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3504
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3505
                graph=graph)
3272
3506
            # TODO: The old revid should be specified when merging tags, 
3273
3507
            # so a tags implementation that versions tags can only 
3274
3508
            # pull in the most recent changes. -- JRV20090506
3275
3509
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3510
                overwrite, ignore_master=not merge_tags_to_master)
3277
3511
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3512
            if _hook_master:
3279
3513
                result.master_branch = _hook_master
3288
3522
            self.source.unlock()
3289
3523
        return result
3290
3524
 
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
3525
 
3400
3526
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)