/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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