~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-05-11 11:47:36 UTC
  • mfrom: (5200.3.8 lock_return)
  • Revision ID: pqm@pqm.ubuntu.com-20100511114736-mc1sq9zyo3vufec7
(lifeless) Provide a consistent interface to Tree, Branch,
 Repository where lock methods return an object with an unlock method to
 unlock the lock. This breaks the API for Branch,
 Repository on their lock_write methods. (Robert Collins)

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(), """
22
 
import itertools
 
23
from itertools import chain
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,
38
 
        tag as _mod_tag,
 
35
        symbol_versioning,
39
36
        transport,
 
37
        tsort,
40
38
        ui,
41
39
        urlutils,
42
40
        )
 
41
from bzrlib.config import BranchConfig, TransportConfig
 
42
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
 
43
from bzrlib.tag import (
 
44
    BasicTags,
 
45
    DisabledTags,
 
46
    )
43
47
""")
44
48
 
45
 
from bzrlib import (
46
 
    controldir,
47
 
    )
48
 
from bzrlib.decorators import (
49
 
    needs_read_lock,
50
 
    needs_write_lock,
51
 
    only_raises,
52
 
    )
53
 
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
54
51
from bzrlib.inter import InterObject
55
52
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
56
53
from bzrlib import registry
61
58
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
62
59
 
63
60
 
64
 
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):
65
67
    """Branch holding a history of revisions.
66
68
 
67
69
    :ivar base:
68
70
        Base directory/url of the branch; using control_url and
69
71
        control_transport is more standardized.
70
 
    :ivar hooks: An instance of BranchHooks.
71
 
    :ivar _master_branch_cache: cached result of get_master_branch, see
72
 
        _clear_cached_state.
 
72
 
 
73
    hooks: An instance of BranchHooks.
73
74
    """
74
75
    # this is really an instance variable - FIXME move it there
75
76
    # - RBC 20060112
89
90
        self._revision_id_to_revno_cache = None
90
91
        self._partial_revision_id_to_revno_cache = {}
91
92
        self._partial_revision_history_cache = []
92
 
        self._tags_bytes = None
93
93
        self._last_revision_info_cache = None
94
 
        self._master_branch_cache = None
95
94
        self._merge_sorted_revisions_cache = None
96
95
        self._open_hook()
97
96
        hooks = Branch.hooks['open']
103
102
 
104
103
    def _activate_fallback_location(self, url):
105
104
        """Activate the branch/repository from url as a fallback repository."""
106
 
        for existing_fallback_repo in self.repository._fallback_repositories:
107
 
            if existing_fallback_repo.user_url == url:
108
 
                # This fallback is already configured.  This probably only
109
 
                # happens because BzrDir.sprout is a horrible mess.  To avoid
110
 
                # confusing _unstack we don't add this a second time.
111
 
                mutter('duplicate activation of fallback %r on %r', url, self)
112
 
                return
113
105
        repo = self._get_fallback_repository(url)
114
106
        if repo.has_same_location(self.repository):
115
107
            raise errors.UnstackableLocationError(self.user_url, url)
205
197
        return self.supports_tags() and self.tags.get_tag_dict()
206
198
 
207
199
    def get_config(self):
208
 
        """Get a bzrlib.config.BranchConfig for this Branch.
209
 
 
210
 
        This can then be used to get and set configuration options for the
211
 
        branch.
212
 
 
213
 
        :return: A bzrlib.config.BranchConfig.
214
 
        """
215
 
        return _mod_config.BranchConfig(self)
 
200
        return BranchConfig(self)
216
201
 
217
202
    def _get_config(self):
218
203
        """Get the concrete config for just the config in this branch.
233
218
            possible_transports=[self.bzrdir.root_transport])
234
219
        return a_branch.repository
235
220
 
236
 
    @needs_read_lock
237
221
    def _get_tags_bytes(self):
238
222
        """Get the bytes of a serialised tags dict.
239
223
 
246
230
        :return: The bytes of the tags file.
247
231
        :seealso: Branch._set_tags_bytes.
248
232
        """
249
 
        if self._tags_bytes is None:
250
 
            self._tags_bytes = self._transport.get_bytes('tags')
251
 
        return self._tags_bytes
 
233
        return self._transport.get_bytes('tags')
252
234
 
253
235
    def _get_nick(self, local=False, possible_transports=None):
254
236
        config = self.get_config()
256
238
        if not local and not config.has_explicit_nickname():
257
239
            try:
258
240
                master = self.get_master_branch(possible_transports)
259
 
                if master and self.user_url == master.user_url:
260
 
                    raise errors.RecursiveBind(self.user_url)
261
241
                if master is not None:
262
242
                    # return the master branch value
263
243
                    return master.nick
264
 
            except errors.RecursiveBind, e:
265
 
                raise e
266
244
            except errors.BzrError, e:
267
245
                # Silently fall back to local implicit nick if the master is
268
246
                # unavailable
445
423
            after. If None, the rest of history is included.
446
424
        :param stop_rule: if stop_revision_id is not None, the precise rule
447
425
            to use for termination:
448
 
 
449
426
            * 'exclude' - leave the stop revision out of the result (default)
450
427
            * 'include' - the stop revision is the last item in the result
451
428
            * 'with-merges' - include the stop revision and all of its
453
430
            * 'with-merges-without-common-ancestry' - filter out revisions 
454
431
              that are in both ancestries
455
432
        :param direction: either 'reverse' or 'forward':
456
 
 
457
433
            * reverse means return the start_revision_id first, i.e.
458
434
              start at the most recent revision and go backwards in history
459
435
            * forward returns tuples in the opposite order to reverse.
503
479
        rev_iter = iter(merge_sorted_revisions)
504
480
        if start_revision_id is not None:
505
481
            for node in rev_iter:
506
 
                rev_id = node.key
 
482
                rev_id = node.key[-1]
507
483
                if rev_id != start_revision_id:
508
484
                    continue
509
485
                else:
510
486
                    # The decision to include the start or not
511
487
                    # depends on the stop_rule if a stop is provided
512
488
                    # so pop this node back into the iterator
513
 
                    rev_iter = itertools.chain(iter([node]), rev_iter)
 
489
                    rev_iter = chain(iter([node]), rev_iter)
514
490
                    break
515
491
        if stop_revision_id is None:
516
492
            # Yield everything
517
493
            for node in rev_iter:
518
 
                rev_id = node.key
 
494
                rev_id = node.key[-1]
519
495
                yield (rev_id, node.merge_depth, node.revno,
520
496
                       node.end_of_merge)
521
497
        elif stop_rule == 'exclude':
522
498
            for node in rev_iter:
523
 
                rev_id = node.key
 
499
                rev_id = node.key[-1]
524
500
                if rev_id == stop_revision_id:
525
501
                    return
526
502
                yield (rev_id, node.merge_depth, node.revno,
527
503
                       node.end_of_merge)
528
504
        elif stop_rule == 'include':
529
505
            for node in rev_iter:
530
 
                rev_id = node.key
 
506
                rev_id = node.key[-1]
531
507
                yield (rev_id, node.merge_depth, node.revno,
532
508
                       node.end_of_merge)
533
509
                if rev_id == stop_revision_id:
539
515
            ancestors = graph.find_unique_ancestors(start_revision_id,
540
516
                                                    [stop_revision_id])
541
517
            for node in rev_iter:
542
 
                rev_id = node.key
 
518
                rev_id = node.key[-1]
543
519
                if rev_id not in ancestors:
544
520
                    continue
545
521
                yield (rev_id, node.merge_depth, node.revno,
555
531
            reached_stop_revision_id = False
556
532
            revision_id_whitelist = []
557
533
            for node in rev_iter:
558
 
                rev_id = node.key
 
534
                rev_id = node.key[-1]
559
535
                if rev_id == left_parent:
560
536
                    # reached the left parent after the stop_revision
561
537
                    return
641
617
        """
642
618
        raise errors.UpgradeRequired(self.user_url)
643
619
 
644
 
    def get_append_revisions_only(self):
645
 
        """Whether it is only possible to append revisions to the history.
646
 
        """
647
 
        if not self._format.supports_set_append_revisions_only():
648
 
            return False
649
 
        return self.get_config(
650
 
            ).get_user_option_as_bool('append_revisions_only')
651
 
 
652
620
    def set_append_revisions_only(self, enabled):
653
621
        if not self._format.supports_set_append_revisions_only():
654
622
            raise errors.UpgradeRequired(self.user_url)
668
636
        raise errors.UnsupportedOperation(self.get_reference_info, self)
669
637
 
670
638
    @needs_write_lock
671
 
    def fetch(self, from_branch, last_revision=None, limit=None):
 
639
    def fetch(self, from_branch, last_revision=None, pb=None):
672
640
        """Copy revisions from from_branch into this branch.
673
641
 
674
642
        :param from_branch: Where to copy from.
675
643
        :param last_revision: What revision to stop at (None for at the end
676
644
                              of the branch.
677
 
        :param limit: Optional rough limit of revisions to fetch
 
645
        :param pb: An optional progress bar to use.
678
646
        :return: None
679
647
        """
680
 
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
 
648
        if self.base == from_branch.base:
 
649
            return (0, [])
 
650
        if pb is not None:
 
651
            symbol_versioning.warn(
 
652
                symbol_versioning.deprecated_in((1, 14, 0))
 
653
                % "pb parameter to fetch()")
 
654
        from_branch.lock_read()
 
655
        try:
 
656
            if last_revision is None:
 
657
                last_revision = from_branch.last_revision()
 
658
                last_revision = _mod_revision.ensure_null(last_revision)
 
659
            return self.repository.fetch(from_branch.repository,
 
660
                                         revision_id=last_revision,
 
661
                                         pb=pb)
 
662
        finally:
 
663
            from_branch.unlock()
681
664
 
682
665
    def get_bound_location(self):
683
666
        """Return the URL of the branch we are bound to.
694
677
 
695
678
    def get_commit_builder(self, parents, config=None, timestamp=None,
696
679
                           timezone=None, committer=None, revprops=None,
697
 
                           revision_id=None, lossy=False):
 
680
                           revision_id=None):
698
681
        """Obtain a CommitBuilder for this branch.
699
682
 
700
683
        :param parents: Revision ids of the parents of the new revision.
704
687
        :param committer: Optional committer to set for commit.
705
688
        :param revprops: Optional dictionary of revision properties.
706
689
        :param revision_id: Optional revision id.
707
 
        :param lossy: Whether to discard data that can not be natively
708
 
            represented, when pushing to a foreign VCS 
709
690
        """
710
691
 
711
692
        if config is None:
712
693
            config = self.get_config()
713
694
 
714
695
        return self.repository.get_commit_builder(self, parents, config,
715
 
            timestamp, timezone, committer, revprops, revision_id,
716
 
            lossy)
 
696
            timestamp, timezone, committer, revprops, revision_id)
717
697
 
718
698
    def get_master_branch(self, possible_transports=None):
719
699
        """Return the branch we are bound to.
746
726
        """Print `file` to stdout."""
747
727
        raise NotImplementedError(self.print_file)
748
728
 
749
 
    @deprecated_method(deprecated_in((2, 4, 0)))
750
729
    def set_revision_history(self, rev_history):
751
 
        """See Branch.set_revision_history."""
752
 
        self._set_revision_history(rev_history)
753
 
 
754
 
    @needs_write_lock
755
 
    def _set_revision_history(self, rev_history):
756
 
        if len(rev_history) == 0:
757
 
            revid = _mod_revision.NULL_REVISION
758
 
        else:
759
 
            revid = rev_history[-1]
760
 
        if rev_history != self._lefthand_history(revid):
761
 
            raise errors.NotLefthandHistory(rev_history)
762
 
        self.set_last_revision_info(len(rev_history), revid)
763
 
        self._cache_revision_history(rev_history)
764
 
        for hook in Branch.hooks['set_rh']:
765
 
            hook(self, rev_history)
766
 
 
767
 
    @needs_write_lock
768
 
    def set_last_revision_info(self, revno, revision_id):
769
 
        """Set the last revision of this branch.
770
 
 
771
 
        The caller is responsible for checking that the revno is correct
772
 
        for this revision id.
773
 
 
774
 
        It may be possible to set the branch last revision to an id not
775
 
        present in the repository.  However, branches can also be
776
 
        configured to check constraints on history, in which case this may not
777
 
        be permitted.
778
 
        """
779
 
        raise NotImplementedError(self.set_last_revision_info)
780
 
 
781
 
    @needs_write_lock
782
 
    def generate_revision_history(self, revision_id, last_rev=None,
783
 
                                  other_branch=None):
784
 
        """See Branch.generate_revision_history"""
785
 
        graph = self.repository.get_graph()
786
 
        (last_revno, last_revid) = self.last_revision_info()
787
 
        known_revision_ids = [
788
 
            (last_revid, last_revno),
789
 
            (_mod_revision.NULL_REVISION, 0),
790
 
            ]
791
 
        if last_rev is not None:
792
 
            if not graph.is_ancestor(last_rev, revision_id):
793
 
                # our previous tip is not merged into stop_revision
794
 
                raise errors.DivergedBranches(self, other_branch)
795
 
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
796
 
        self.set_last_revision_info(revno, revision_id)
 
730
        raise NotImplementedError(self.set_revision_history)
797
731
 
798
732
    @needs_write_lock
799
733
    def set_parent(self, url):
843
777
 
844
778
    def _unstack(self):
845
779
        """Change a branch to be unstacked, copying data as needed.
846
 
 
 
780
        
847
781
        Don't call this directly, use set_stacked_on_url(None).
848
782
        """
849
783
        pb = ui.ui_factory.nested_progress_bar()
858
792
            old_repository = self.repository
859
793
            if len(old_repository._fallback_repositories) != 1:
860
794
                raise AssertionError("can't cope with fallback repositories "
861
 
                    "of %r (fallbacks: %r)" % (old_repository,
862
 
                        old_repository._fallback_repositories))
863
 
            # Open the new repository object.
864
 
            # Repositories don't offer an interface to remove fallback
865
 
            # repositories today; take the conceptually simpler option and just
866
 
            # reopen it.  We reopen it starting from the URL so that we
867
 
            # get a separate connection for RemoteRepositories and can
868
 
            # stream from one of them to the other.  This does mean doing
869
 
            # separate SSH connection setup, but unstacking is not a
870
 
            # common operation so it's tolerable.
871
 
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
872
 
            new_repository = new_bzrdir.find_repository()
873
 
            if new_repository._fallback_repositories:
874
 
                raise AssertionError("didn't expect %r to have "
875
 
                    "fallback_repositories"
876
 
                    % (self.repository,))
877
 
            # Replace self.repository with the new repository.
878
 
            # Do our best to transfer the lock state (i.e. lock-tokens and
879
 
            # lock count) of self.repository to the new repository.
880
 
            lock_token = old_repository.lock_write().repository_token
881
 
            self.repository = new_repository
882
 
            if isinstance(self, remote.RemoteBranch):
883
 
                # Remote branches can have a second reference to the old
884
 
                # repository that need to be replaced.
885
 
                if self._real_branch is not None:
886
 
                    self._real_branch.repository = new_repository
887
 
            self.repository.lock_write(token=lock_token)
888
 
            if lock_token is not None:
889
 
                old_repository.leave_lock_in_place()
 
795
                    "of %r" % (self.repository,))
 
796
            # unlock it, including unlocking the fallback
890
797
            old_repository.unlock()
891
 
            if lock_token is not None:
892
 
                # XXX: self.repository.leave_lock_in_place() before this
893
 
                # function will not be preserved.  Fortunately that doesn't
894
 
                # affect the current default format (2a), and would be a
895
 
                # corner-case anyway.
896
 
                #  - Andrew Bennetts, 2010/06/30
897
 
                self.repository.dont_leave_lock_in_place()
898
 
            old_lock_count = 0
899
 
            while True:
900
 
                try:
901
 
                    old_repository.unlock()
902
 
                except errors.LockNotHeld:
903
 
                    break
904
 
                old_lock_count += 1
905
 
            if old_lock_count == 0:
906
 
                raise AssertionError(
907
 
                    'old_repository should have been locked at least once.')
908
 
            for i in range(old_lock_count-1):
 
798
            old_repository.lock_read()
 
799
            try:
 
800
                # Repositories don't offer an interface to remove fallback
 
801
                # repositories today; take the conceptually simpler option and just
 
802
                # reopen it.  We reopen it starting from the URL so that we
 
803
                # get a separate connection for RemoteRepositories and can
 
804
                # stream from one of them to the other.  This does mean doing
 
805
                # separate SSH connection setup, but unstacking is not a
 
806
                # common operation so it's tolerable.
 
807
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
808
                new_repository = new_bzrdir.find_repository()
 
809
                self.repository = new_repository
 
810
                if self.repository._fallback_repositories:
 
811
                    raise AssertionError("didn't expect %r to have "
 
812
                        "fallback_repositories"
 
813
                        % (self.repository,))
 
814
                # this is not paired with an unlock because it's just restoring
 
815
                # the previous state; the lock's released when set_stacked_on_url
 
816
                # returns
909
817
                self.repository.lock_write()
910
 
            # Fetch from the old repository into the new.
911
 
            old_repository.lock_read()
912
 
            try:
913
818
                # XXX: If you unstack a branch while it has a working tree
914
819
                # with a pending merge, the pending-merged revisions will no
915
820
                # longer be present.  You can (probably) revert and remerge.
916
 
                try:
917
 
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
918
 
                except errors.TagsNotSupported:
919
 
                    tags_to_fetch = set()
920
 
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
921
 
                    old_repository, required_ids=[self.last_revision()],
922
 
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
923
 
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
 
821
                #
 
822
                # XXX: This only fetches up to the tip of the repository; it
 
823
                # doesn't bring across any tags.  That's fairly consistent
 
824
                # with how branch works, but perhaps not ideal.
 
825
                self.repository.fetch(old_repository,
 
826
                    revision_id=self.last_revision(),
 
827
                    find_ghosts=True)
924
828
            finally:
925
829
                old_repository.unlock()
926
830
        finally:
931
835
 
932
836
        :seealso: Branch._get_tags_bytes.
933
837
        """
934
 
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
935
 
        op.add_cleanup(self.lock_write().unlock)
936
 
        return op.run_simple(bytes)
937
 
 
938
 
    def _set_tags_bytes_locked(self, bytes):
939
 
        self._tags_bytes = bytes
940
 
        return self._transport.put_bytes('tags', bytes)
 
838
        return _run_with_write_locked_target(self, self._transport.put_bytes,
 
839
            'tags', bytes)
941
840
 
942
841
    def _cache_revision_history(self, rev_history):
943
842
        """Set the cached revision history to rev_history.
970
869
        self._revision_history_cache = None
971
870
        self._revision_id_to_revno_cache = None
972
871
        self._last_revision_info_cache = None
973
 
        self._master_branch_cache = None
974
872
        self._merge_sorted_revisions_cache = None
975
873
        self._partial_revision_history_cache = []
976
874
        self._partial_revision_id_to_revno_cache = {}
977
 
        self._tags_bytes = None
978
875
 
979
876
    def _gen_revision_history(self):
980
877
        """Return sequence of revision hashes on to this branch.
1030
927
        :return: A tuple (revno, revision_id).
1031
928
        """
1032
929
        if self._last_revision_info_cache is None:
1033
 
            self._last_revision_info_cache = self._read_last_revision_info()
 
930
            self._last_revision_info_cache = self._last_revision_info()
1034
931
        return self._last_revision_info_cache
1035
932
 
1036
 
    def _read_last_revision_info(self):
1037
 
        raise NotImplementedError(self._read_last_revision_info)
1038
 
 
1039
 
    @deprecated_method(deprecated_in((2, 4, 0)))
 
933
    def _last_revision_info(self):
 
934
        rh = self.revision_history()
 
935
        revno = len(rh)
 
936
        if revno:
 
937
            return (revno, rh[-1])
 
938
        else:
 
939
            return (0, _mod_revision.NULL_REVISION)
 
940
 
 
941
    @deprecated_method(deprecated_in((1, 6, 0)))
 
942
    def missing_revisions(self, other, stop_revision=None):
 
943
        """Return a list of new revisions that would perfectly fit.
 
944
 
 
945
        If self and other have not diverged, return a list of the revisions
 
946
        present in other, but missing from self.
 
947
        """
 
948
        self_history = self.revision_history()
 
949
        self_len = len(self_history)
 
950
        other_history = other.revision_history()
 
951
        other_len = len(other_history)
 
952
        common_index = min(self_len, other_len) -1
 
953
        if common_index >= 0 and \
 
954
            self_history[common_index] != other_history[common_index]:
 
955
            raise errors.DivergedBranches(self, other)
 
956
 
 
957
        if stop_revision is None:
 
958
            stop_revision = other_len
 
959
        else:
 
960
            if stop_revision > other_len:
 
961
                raise errors.NoSuchRevision(self, stop_revision)
 
962
        return other_history[self_len:stop_revision]
 
963
 
 
964
    @needs_write_lock
 
965
    def update_revisions(self, other, stop_revision=None, overwrite=False,
 
966
                         graph=None):
 
967
        """Pull in new perfect-fit revisions.
 
968
 
 
969
        :param other: Another Branch to pull from
 
970
        :param stop_revision: Updated until the given revision
 
971
        :param overwrite: Always set the branch pointer, rather than checking
 
972
            to see if it is a proper descendant.
 
973
        :param graph: A Graph object that can be used to query history
 
974
            information. This can be None.
 
975
        :return: None
 
976
        """
 
977
        return InterBranch.get(other, self).update_revisions(stop_revision,
 
978
            overwrite, graph)
 
979
 
1040
980
    def import_last_revision_info(self, source_repo, revno, revid):
1041
981
        """Set the last revision info, importing from another repo if necessary.
1042
982
 
 
983
        This is used by the bound branch code to upload a revision to
 
984
        the master branch first before updating the tip of the local branch.
 
985
 
1043
986
        :param source_repo: Source repository to optionally fetch from
1044
987
        :param revno: Revision number of the new tip
1045
988
        :param revid: Revision id of the new tip
1048
991
            self.repository.fetch(source_repo, revision_id=revid)
1049
992
        self.set_last_revision_info(revno, revid)
1050
993
 
1051
 
    def import_last_revision_info_and_tags(self, source, revno, revid,
1052
 
                                           lossy=False):
1053
 
        """Set the last revision info, importing from another repo if necessary.
1054
 
 
1055
 
        This is used by the bound branch code to upload a revision to
1056
 
        the master branch first before updating the tip of the local branch.
1057
 
        Revisions referenced by source's tags are also transferred.
1058
 
 
1059
 
        :param source: Source branch to optionally fetch from
1060
 
        :param revno: Revision number of the new tip
1061
 
        :param revid: Revision id of the new tip
1062
 
        :param lossy: Whether to discard metadata that can not be
1063
 
            natively represented
1064
 
        :return: Tuple with the new revision number and revision id
1065
 
            (should only be different from the arguments when lossy=True)
1066
 
        """
1067
 
        if not self.repository.has_same_location(source.repository):
1068
 
            self.fetch(source, revid)
1069
 
        self.set_last_revision_info(revno, revid)
1070
 
        return (revno, revid)
1071
 
 
1072
994
    def revision_id_to_revno(self, revision_id):
1073
995
        """Given a revision id, return its revno"""
1074
996
        if _mod_revision.is_null(revision_id):
1094
1016
            self._extend_partial_history(distance_from_last)
1095
1017
        return self._partial_revision_history_cache[distance_from_last]
1096
1018
 
 
1019
    @needs_write_lock
1097
1020
    def pull(self, source, overwrite=False, stop_revision=None,
1098
1021
             possible_transports=None, *args, **kwargs):
1099
1022
        """Mirror source into this branch.
1106
1029
            stop_revision=stop_revision,
1107
1030
            possible_transports=possible_transports, *args, **kwargs)
1108
1031
 
1109
 
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
1110
 
            *args, **kwargs):
 
1032
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1033
        **kwargs):
1111
1034
        """Mirror this branch into target.
1112
1035
 
1113
1036
        This branch is considered to be 'local', having low latency.
1114
1037
        """
1115
1038
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1116
 
            lossy, *args, **kwargs)
 
1039
            *args, **kwargs)
 
1040
 
 
1041
    def lossy_push(self, target, stop_revision=None):
 
1042
        """Push deltas into another branch.
 
1043
 
 
1044
        :note: This does not, like push, retain the revision ids from 
 
1045
            the source branch and will, rather than adding bzr-specific 
 
1046
            metadata, push only those semantics of the revision that can be 
 
1047
            natively represented by this branch' VCS.
 
1048
 
 
1049
        :param target: Target branch
 
1050
        :param stop_revision: Revision to push, defaults to last revision.
 
1051
        :return: BranchPushResult with an extra member revidmap: 
 
1052
            A dictionary mapping revision ids from the target branch 
 
1053
            to new revision ids in the target branch, for each 
 
1054
            revision that was pushed.
 
1055
        """
 
1056
        inter = InterBranch.get(self, target)
 
1057
        lossy_push = getattr(inter, "lossy_push", None)
 
1058
        if lossy_push is None:
 
1059
            raise errors.LossyPushToSameVCS(self, target)
 
1060
        return lossy_push(stop_revision)
1117
1061
 
1118
1062
    def basis_tree(self):
1119
1063
        """Return `Tree` object for last revision."""
1274
1218
        return result
1275
1219
 
1276
1220
    @needs_read_lock
1277
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
1278
 
            repository=None):
 
1221
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1279
1222
        """Create a new line of development from the branch, into to_bzrdir.
1280
1223
 
1281
1224
        to_bzrdir controls the branch format.
1286
1229
        if (repository_policy is not None and
1287
1230
            repository_policy.requires_stacking()):
1288
1231
            to_bzrdir._format.require_stacking(_skip_repo=True)
1289
 
        result = to_bzrdir.create_branch(repository=repository)
 
1232
        result = to_bzrdir.create_branch()
1290
1233
        result.lock_write()
1291
1234
        try:
1292
1235
            if repository_policy is not None:
1293
1236
                repository_policy.configure_branch(result)
1294
1237
            self.copy_content_into(result, revision_id=revision_id)
1295
 
            master_url = self.get_bound_location()
1296
 
            if master_url is None:
1297
 
                result.set_parent(self.bzrdir.root_transport.base)
1298
 
            else:
1299
 
                result.set_parent(master_url)
 
1238
            result.set_parent(self.bzrdir.root_transport.base)
1300
1239
        finally:
1301
1240
            result.unlock()
1302
1241
        return result
1326
1265
                revno = 1
1327
1266
        destination.set_last_revision_info(revno, revision_id)
1328
1267
 
 
1268
    @needs_read_lock
1329
1269
    def copy_content_into(self, destination, revision_id=None):
1330
1270
        """Copy the content of self into destination.
1331
1271
 
1332
1272
        revision_id: if not None, the revision history in the new branch will
1333
1273
                     be truncated to end with revision_id.
1334
1274
        """
1335
 
        return InterBranch.get(self, destination).copy_content_into(
1336
 
            revision_id=revision_id)
 
1275
        self.update_references(destination)
 
1276
        self._synchronize_history(destination, revision_id)
 
1277
        try:
 
1278
            parent = self.get_parent()
 
1279
        except errors.InaccessibleParent, e:
 
1280
            mutter('parent was not accessible to copy: %s', e)
 
1281
        else:
 
1282
            if parent:
 
1283
                destination.set_parent(parent)
 
1284
        if self._push_should_merge_tags():
 
1285
            self.tags.merge_to(destination.tags)
1337
1286
 
1338
1287
    def update_references(self, target):
1339
1288
        if not getattr(self._format, 'supports_reference_locations', False):
1380
1329
        # specific check.
1381
1330
        return result
1382
1331
 
1383
 
    def _get_checkout_format(self, lightweight=False):
 
1332
    def _get_checkout_format(self):
1384
1333
        """Return the most suitable metadir for a checkout of this branch.
1385
1334
        Weaves are used if this branch's repository uses weaves.
1386
1335
        """
1387
 
        format = self.repository.bzrdir.checkout_metadir()
1388
 
        format.set_branch_format(self._format)
 
1336
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
 
1337
            from bzrlib.repofmt import weaverepo
 
1338
            format = bzrdir.BzrDirMetaFormat1()
 
1339
            format.repository_format = weaverepo.RepositoryFormat7()
 
1340
        else:
 
1341
            format = self.repository.bzrdir.checkout_metadir()
 
1342
            format.set_branch_format(self._format)
1389
1343
        return format
1390
1344
 
1391
1345
    def create_clone_on_transport(self, to_transport, revision_id=None,
1392
 
        stacked_on=None, create_prefix=False, use_existing_dir=False,
1393
 
        no_tree=None):
 
1346
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1394
1347
        """Create a clone of this branch and its bzrdir.
1395
1348
 
1396
1349
        :param to_transport: The transport to clone onto.
1409
1362
            revision_id = self.last_revision()
1410
1363
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1411
1364
            revision_id=revision_id, stacked_on=stacked_on,
1412
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
1413
 
            no_tree=no_tree)
 
1365
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1414
1366
        return dir_to.open_branch()
1415
1367
 
1416
1368
    def create_checkout(self, to_location, revision_id=None,
1421
1373
        :param to_location: The url to produce the checkout at
1422
1374
        :param revision_id: The revision to check out
1423
1375
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1424
 
            produce a bound branch (heavyweight checkout)
 
1376
        produce a bound branch (heavyweight checkout)
1425
1377
        :param accelerator_tree: A tree which can be used for retrieving file
1426
1378
            contents more quickly than the revision tree, i.e. a workingtree.
1427
1379
            The revision tree will be used for cases where accelerator_tree's
1432
1384
        """
1433
1385
        t = transport.get_transport(to_location)
1434
1386
        t.ensure_base()
1435
 
        format = self._get_checkout_format(lightweight=lightweight)
1436
1387
        if lightweight:
 
1388
            format = self._get_checkout_format()
1437
1389
            checkout = format.initialize_on_transport(t)
1438
1390
            from_branch = BranchReferenceFormat().initialize(checkout, 
1439
1391
                target_branch=self)
1440
1392
        else:
 
1393
            format = self._get_checkout_format()
1441
1394
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1442
1395
                to_location, force_new_tree=False, format=format)
1443
1396
            checkout = checkout_branch.bzrdir
1472
1425
 
1473
1426
    def reference_parent(self, file_id, path, possible_transports=None):
1474
1427
        """Return the parent branch for a tree-reference file_id
1475
 
 
1476
1428
        :param file_id: The file_id of the tree reference
1477
1429
        :param path: The path of the file_id in the tree
1478
1430
        :return: A branch associated with the file_id
1531
1483
        else:
1532
1484
            raise AssertionError("invalid heads: %r" % (heads,))
1533
1485
 
1534
 
    def heads_to_fetch(self):
1535
 
        """Return the heads that must and that should be fetched to copy this
1536
 
        branch into another repo.
1537
 
 
1538
 
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
1539
 
            set of heads that must be fetched.  if_present_fetch is a set of
1540
 
            heads that must be fetched if present, but no error is necessary if
1541
 
            they are not present.
1542
 
        """
1543
 
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
1544
 
        # are the tags.
1545
 
        must_fetch = set([self.last_revision()])
1546
 
        if_present_fetch = set()
1547
 
        c = self.get_config()
1548
 
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
1549
 
                                                 default=False)
1550
 
        if include_tags:
1551
 
            try:
1552
 
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
1553
 
            except errors.TagsNotSupported:
1554
 
                pass
1555
 
        must_fetch.discard(_mod_revision.NULL_REVISION)
1556
 
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
1557
 
        return must_fetch, if_present_fetch
1558
 
 
1559
 
 
1560
 
class BranchFormat(controldir.ControlComponentFormat):
 
1486
 
 
1487
class BranchFormat(object):
1561
1488
    """An encapsulation of the initialization and open routines for a format.
1562
1489
 
1563
1490
    Formats provide three things:
1566
1493
     * an open routine.
1567
1494
 
1568
1495
    Formats are placed in an dict by their format string for reference
1569
 
    during branch opening. It's not required that these be instances, they
 
1496
    during branch opening. Its not required that these be instances, they
1570
1497
    can be classes themselves with class methods - it simply depends on
1571
1498
    whether state is needed for a given format or not.
1572
1499
 
1575
1502
    object will be created every time regardless.
1576
1503
    """
1577
1504
 
 
1505
    _default_format = None
 
1506
    """The default format used for new branches."""
 
1507
 
 
1508
    _formats = {}
 
1509
    """The known formats."""
 
1510
 
 
1511
    can_set_append_revisions_only = True
 
1512
 
1578
1513
    def __eq__(self, other):
1579
1514
        return self.__class__ is other.__class__
1580
1515
 
1587
1522
        try:
1588
1523
            transport = a_bzrdir.get_branch_transport(None, name=name)
1589
1524
            format_string = transport.get_bytes("format")
1590
 
            return format_registry.get(format_string)
 
1525
            return klass._formats[format_string]
1591
1526
        except errors.NoSuchFile:
1592
1527
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1593
1528
        except KeyError:
1594
1529
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1595
1530
 
1596
1531
    @classmethod
1597
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1598
1532
    def get_default_format(klass):
1599
1533
        """Return the current default format."""
1600
 
        return format_registry.get_default()
1601
 
 
1602
 
    @classmethod
1603
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1604
 
    def get_formats(klass):
1605
 
        """Get all the known formats.
1606
 
 
1607
 
        Warning: This triggers a load of all lazy registered formats: do not
1608
 
        use except when that is desireed.
1609
 
        """
1610
 
        return format_registry._get_all()
 
1534
        return klass._default_format
1611
1535
 
1612
1536
    def get_reference(self, a_bzrdir, name=None):
1613
1537
        """Get the target reference of the branch in a_bzrdir.
1652
1576
        for hook in hooks:
1653
1577
            hook(params)
1654
1578
 
1655
 
    def initialize(self, a_bzrdir, name=None, repository=None,
1656
 
                   append_revisions_only=None):
 
1579
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1580
                           lock_type='metadir', set_format=True):
 
1581
        """Initialize a branch in a bzrdir, with specified files
 
1582
 
 
1583
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1584
        :param utf8_files: The files to create as a list of
 
1585
            (filename, content) tuples
 
1586
        :param name: Name of colocated branch to create, if any
 
1587
        :param set_format: If True, set the format with
 
1588
            self.get_format_string.  (BzrBranch4 has its format set
 
1589
            elsewhere)
 
1590
        :return: a branch in this format
 
1591
        """
 
1592
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1593
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1594
        lock_map = {
 
1595
            'metadir': ('lock', lockdir.LockDir),
 
1596
            'branch4': ('branch-lock', lockable_files.TransportLock),
 
1597
        }
 
1598
        lock_name, lock_class = lock_map[lock_type]
 
1599
        control_files = lockable_files.LockableFiles(branch_transport,
 
1600
            lock_name, lock_class)
 
1601
        control_files.create_lock()
 
1602
        try:
 
1603
            control_files.lock_write()
 
1604
        except errors.LockContention:
 
1605
            if lock_type != 'branch4':
 
1606
                raise
 
1607
            lock_taken = False
 
1608
        else:
 
1609
            lock_taken = True
 
1610
        if set_format:
 
1611
            utf8_files += [('format', self.get_format_string())]
 
1612
        try:
 
1613
            for (filename, content) in utf8_files:
 
1614
                branch_transport.put_bytes(
 
1615
                    filename, content,
 
1616
                    mode=a_bzrdir._get_file_mode())
 
1617
        finally:
 
1618
            if lock_taken:
 
1619
                control_files.unlock()
 
1620
        branch = self.open(a_bzrdir, name, _found=True)
 
1621
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1622
        return branch
 
1623
 
 
1624
    def initialize(self, a_bzrdir, name=None):
1657
1625
        """Create a branch of this format in a_bzrdir.
1658
1626
        
1659
1627
        :param name: Name of the colocated branch to create.
1681
1649
        Note that it is normal for branch to be a RemoteBranch when using tags
1682
1650
        on a RemoteBranch.
1683
1651
        """
1684
 
        return _mod_tag.DisabledTags(branch)
 
1652
        return DisabledTags(branch)
1685
1653
 
1686
1654
    def network_name(self):
1687
1655
        """A simple byte string uniquely identifying this format for RPC calls.
1693
1661
        """
1694
1662
        raise NotImplementedError(self.network_name)
1695
1663
 
1696
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
1697
 
            found_repository=None):
 
1664
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1698
1665
        """Return the branch object for a_bzrdir
1699
1666
 
1700
1667
        :param a_bzrdir: A BzrDir that contains a branch.
1707
1674
        raise NotImplementedError(self.open)
1708
1675
 
1709
1676
    @classmethod
1710
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1711
1677
    def register_format(klass, format):
1712
 
        """Register a metadir format.
1713
 
 
1714
 
        See MetaDirBranchFormatFactory for the ability to register a format
1715
 
        without loading the code the format needs until it is actually used.
1716
 
        """
1717
 
        format_registry.register(format)
 
1678
        """Register a metadir format."""
 
1679
        klass._formats[format.get_format_string()] = format
 
1680
        # Metadir formats have a network name of their format string, and get
 
1681
        # registered as class factories.
 
1682
        network_format_registry.register(format.get_format_string(), format.__class__)
1718
1683
 
1719
1684
    @classmethod
1720
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1721
1685
    def set_default_format(klass, format):
1722
 
        format_registry.set_default(format)
 
1686
        klass._default_format = format
1723
1687
 
1724
1688
    def supports_set_append_revisions_only(self):
1725
1689
        """True if this format supports set_append_revisions_only."""
1729
1693
        """True if this format records a stacked-on branch."""
1730
1694
        return False
1731
1695
 
1732
 
    def supports_leaving_lock(self):
1733
 
        """True if this format supports leaving locks in place."""
1734
 
        return False # by default
1735
 
 
1736
1696
    @classmethod
1737
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1738
1697
    def unregister_format(klass, format):
1739
 
        format_registry.remove(format)
 
1698
        del klass._formats[format.get_format_string()]
1740
1699
 
1741
1700
    def __str__(self):
1742
1701
        return self.get_format_description().rstrip()
1745
1704
        """True if this format supports tags stored in the branch"""
1746
1705
        return False  # by default
1747
1706
 
1748
 
    def tags_are_versioned(self):
1749
 
        """Whether the tag container for this branch versions tags."""
1750
 
        return False
1751
 
 
1752
 
    def supports_tags_referencing_ghosts(self):
1753
 
        """True if tags can reference ghost revisions."""
1754
 
        return True
1755
 
 
1756
 
 
1757
 
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
1758
 
    """A factory for a BranchFormat object, permitting simple lazy registration.
1759
 
    
1760
 
    While none of the built in BranchFormats are lazy registered yet,
1761
 
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
1762
 
    use it, and the bzr-loom plugin uses it as well (see
1763
 
    bzrlib.plugins.loom.formats).
1764
 
    """
1765
 
 
1766
 
    def __init__(self, format_string, module_name, member_name):
1767
 
        """Create a MetaDirBranchFormatFactory.
1768
 
 
1769
 
        :param format_string: The format string the format has.
1770
 
        :param module_name: Module to load the format class from.
1771
 
        :param member_name: Attribute name within the module for the format class.
1772
 
        """
1773
 
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
1774
 
        self._format_string = format_string
1775
 
        
1776
 
    def get_format_string(self):
1777
 
        """See BranchFormat.get_format_string."""
1778
 
        return self._format_string
1779
 
 
1780
 
    def __call__(self):
1781
 
        """Used for network_format_registry support."""
1782
 
        return self.get_obj()()
1783
 
 
1784
1707
 
1785
1708
class BranchHooks(Hooks):
1786
1709
    """A dictionary mapping hook name to a list of callables for branch hooks.
1795
1718
        These are all empty initially, because by default nothing should get
1796
1719
        notified.
1797
1720
        """
1798
 
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
1799
 
        self.add_hook('set_rh',
 
1721
        Hooks.__init__(self)
 
1722
        self.create_hook(HookPoint('set_rh',
1800
1723
            "Invoked whenever the revision history has been set via "
1801
1724
            "set_revision_history. The api signature is (branch, "
1802
1725
            "revision_history), and the branch will be write-locked. "
1803
1726
            "The set_rh hook can be expensive for bzr to trigger, a better "
1804
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
1805
 
        self.add_hook('open',
 
1727
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
 
1728
        self.create_hook(HookPoint('open',
1806
1729
            "Called with the Branch object that has been opened after a "
1807
 
            "branch is opened.", (1, 8))
1808
 
        self.add_hook('post_push',
 
1730
            "branch is opened.", (1, 8), None))
 
1731
        self.create_hook(HookPoint('post_push',
1809
1732
            "Called after a push operation completes. post_push is called "
1810
1733
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1811
 
            "bzr client.", (0, 15))
1812
 
        self.add_hook('post_pull',
 
1734
            "bzr client.", (0, 15), None))
 
1735
        self.create_hook(HookPoint('post_pull',
1813
1736
            "Called after a pull operation completes. post_pull is called "
1814
1737
            "with a bzrlib.branch.PullResult object and only runs in the "
1815
 
            "bzr client.", (0, 15))
1816
 
        self.add_hook('pre_commit',
1817
 
            "Called after a commit is calculated but before it is "
 
1738
            "bzr client.", (0, 15), None))
 
1739
        self.create_hook(HookPoint('pre_commit',
 
1740
            "Called after a commit is calculated but before it is is "
1818
1741
            "completed. pre_commit is called with (local, master, old_revno, "
1819
1742
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1820
1743
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1822
1745
            "basis revision. hooks MUST NOT modify this delta. "
1823
1746
            " future_tree is an in-memory tree obtained from "
1824
1747
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1825
 
            "tree.", (0,91))
1826
 
        self.add_hook('post_commit',
 
1748
            "tree.", (0,91), None))
 
1749
        self.create_hook(HookPoint('post_commit',
1827
1750
            "Called in the bzr client after a commit has completed. "
1828
1751
            "post_commit is called with (local, master, old_revno, old_revid, "
1829
1752
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1830
 
            "commit to a branch.", (0, 15))
1831
 
        self.add_hook('post_uncommit',
 
1753
            "commit to a branch.", (0, 15), None))
 
1754
        self.create_hook(HookPoint('post_uncommit',
1832
1755
            "Called in the bzr client after an uncommit completes. "
1833
1756
            "post_uncommit is called with (local, master, old_revno, "
1834
1757
            "old_revid, new_revno, new_revid) where local is the local branch "
1835
1758
            "or None, master is the target branch, and an empty branch "
1836
 
            "receives new_revno of 0, new_revid of None.", (0, 15))
1837
 
        self.add_hook('pre_change_branch_tip',
 
1759
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
 
1760
        self.create_hook(HookPoint('pre_change_branch_tip',
1838
1761
            "Called in bzr client and server before a change to the tip of a "
1839
1762
            "branch is made. pre_change_branch_tip is called with a "
1840
1763
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1841
 
            "commit, uncommit will all trigger this hook.", (1, 6))
1842
 
        self.add_hook('post_change_branch_tip',
 
1764
            "commit, uncommit will all trigger this hook.", (1, 6), None))
 
1765
        self.create_hook(HookPoint('post_change_branch_tip',
1843
1766
            "Called in bzr client and server after a change to the tip of a "
1844
1767
            "branch is made. post_change_branch_tip is called with a "
1845
1768
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1846
 
            "commit, uncommit will all trigger this hook.", (1, 4))
1847
 
        self.add_hook('transform_fallback_location',
 
1769
            "commit, uncommit will all trigger this hook.", (1, 4), None))
 
1770
        self.create_hook(HookPoint('transform_fallback_location',
1848
1771
            "Called when a stacked branch is activating its fallback "
1849
1772
            "locations. transform_fallback_location is called with (branch, "
1850
1773
            "url), and should return a new url. Returning the same url "
1855
1778
            "fallback locations have not been activated. When there are "
1856
1779
            "multiple hooks installed for transform_fallback_location, "
1857
1780
            "all are called with the url returned from the previous hook."
1858
 
            "The order is however undefined.", (1, 9))
1859
 
        self.add_hook('automatic_tag_name',
1860
 
            "Called to determine an automatic tag name for a revision. "
 
1781
            "The order is however undefined.", (1, 9), None))
 
1782
        self.create_hook(HookPoint('automatic_tag_name',
 
1783
            "Called to determine an automatic tag name for a revision."
1861
1784
            "automatic_tag_name is called with (branch, revision_id) and "
1862
1785
            "should return a tag name or None if no tag name could be "
1863
1786
            "determined. The first non-None tag name returned will be used.",
1864
 
            (2, 2))
1865
 
        self.add_hook('post_branch_init',
 
1787
            (2, 2), None))
 
1788
        self.create_hook(HookPoint('post_branch_init',
1866
1789
            "Called after new branch initialization completes. "
1867
1790
            "post_branch_init is called with a "
1868
1791
            "bzrlib.branch.BranchInitHookParams. "
1869
1792
            "Note that init, branch and checkout (both heavyweight and "
1870
 
            "lightweight) will all trigger this hook.", (2, 2))
1871
 
        self.add_hook('post_switch',
 
1793
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1794
        self.create_hook(HookPoint('post_switch',
1872
1795
            "Called after a checkout switches branch. "
1873
1796
            "post_switch is called with a "
1874
 
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1797
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1875
1798
 
1876
1799
 
1877
1800
 
1880
1803
 
1881
1804
 
1882
1805
class ChangeBranchTipParams(object):
1883
 
    """Object holding parameters passed to `*_change_branch_tip` hooks.
 
1806
    """Object holding parameters passed to *_change_branch_tip hooks.
1884
1807
 
1885
1808
    There are 5 fields that hooks may wish to access:
1886
1809
 
1918
1841
 
1919
1842
 
1920
1843
class BranchInitHookParams(object):
1921
 
    """Object holding parameters passed to `*_branch_init` hooks.
 
1844
    """Object holding parameters passed to *_branch_init hooks.
1922
1845
 
1923
1846
    There are 4 fields that hooks may wish to access:
1924
1847
 
1954
1877
        return self.__dict__ == other.__dict__
1955
1878
 
1956
1879
    def __repr__(self):
1957
 
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1880
        if self.branch:
 
1881
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1882
        else:
 
1883
            return "<%s of format:%s bzrdir:%s>" % (
 
1884
                self.__class__.__name__, self.branch,
 
1885
                self.format, self.bzrdir)
1958
1886
 
1959
1887
 
1960
1888
class SwitchHookParams(object):
1961
 
    """Object holding parameters passed to `*_switch` hooks.
 
1889
    """Object holding parameters passed to *_switch hooks.
1962
1890
 
1963
1891
    There are 4 fields that hooks may wish to access:
1964
1892
 
1990
1918
            self.revision_id)
1991
1919
 
1992
1920
 
 
1921
class BzrBranchFormat4(BranchFormat):
 
1922
    """Bzr branch format 4.
 
1923
 
 
1924
    This format has:
 
1925
     - a revision-history file.
 
1926
     - a branch-lock lock file [ to be shared with the bzrdir ]
 
1927
    """
 
1928
 
 
1929
    def get_format_description(self):
 
1930
        """See BranchFormat.get_format_description()."""
 
1931
        return "Branch format 4"
 
1932
 
 
1933
    def initialize(self, a_bzrdir, name=None):
 
1934
        """Create a branch of this format in a_bzrdir."""
 
1935
        utf8_files = [('revision-history', ''),
 
1936
                      ('branch-name', ''),
 
1937
                      ]
 
1938
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1939
                                       lock_type='branch4', set_format=False)
 
1940
 
 
1941
    def __init__(self):
 
1942
        super(BzrBranchFormat4, self).__init__()
 
1943
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
 
1944
 
 
1945
    def network_name(self):
 
1946
        """The network name for this format is the control dirs disk label."""
 
1947
        return self._matchingbzrdir.get_format_string()
 
1948
 
 
1949
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1950
        """See BranchFormat.open()."""
 
1951
        if not _found:
 
1952
            # we are being called directly and must probe.
 
1953
            raise NotImplementedError
 
1954
        return BzrBranch(_format=self,
 
1955
                         _control_files=a_bzrdir._control_files,
 
1956
                         a_bzrdir=a_bzrdir,
 
1957
                         name=name,
 
1958
                         _repository=a_bzrdir.open_repository())
 
1959
 
 
1960
    def __str__(self):
 
1961
        return "Bazaar-NG branch format 4"
 
1962
 
 
1963
 
1993
1964
class BranchFormatMetadir(BranchFormat):
1994
1965
    """Common logic for meta-dir based branch formats."""
1995
1966
 
1997
1968
        """What class to instantiate on open calls."""
1998
1969
        raise NotImplementedError(self._branch_class)
1999
1970
 
2000
 
    def _get_initial_config(self, append_revisions_only=None):
2001
 
        if append_revisions_only:
2002
 
            return "append_revisions_only = True\n"
2003
 
        else:
2004
 
            # Avoid writing anything if append_revisions_only is disabled,
2005
 
            # as that is the default.
2006
 
            return ""
2007
 
 
2008
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
2009
 
                           repository=None):
2010
 
        """Initialize a branch in a bzrdir, with specified files
2011
 
 
2012
 
        :param a_bzrdir: The bzrdir to initialize the branch in
2013
 
        :param utf8_files: The files to create as a list of
2014
 
            (filename, content) tuples
2015
 
        :param name: Name of colocated branch to create, if any
2016
 
        :return: a branch in this format
2017
 
        """
2018
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
2019
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2020
 
        control_files = lockable_files.LockableFiles(branch_transport,
2021
 
            'lock', lockdir.LockDir)
2022
 
        control_files.create_lock()
2023
 
        control_files.lock_write()
2024
 
        try:
2025
 
            utf8_files += [('format', self.get_format_string())]
2026
 
            for (filename, content) in utf8_files:
2027
 
                branch_transport.put_bytes(
2028
 
                    filename, content,
2029
 
                    mode=a_bzrdir._get_file_mode())
2030
 
        finally:
2031
 
            control_files.unlock()
2032
 
        branch = self.open(a_bzrdir, name, _found=True,
2033
 
                found_repository=repository)
2034
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2035
 
        return branch
2036
 
 
2037
1971
    def network_name(self):
2038
1972
        """A simple byte string uniquely identifying this format for RPC calls.
2039
1973
 
2041
1975
        """
2042
1976
        return self.get_format_string()
2043
1977
 
2044
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
2045
 
            found_repository=None):
 
1978
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
2046
1979
        """See BranchFormat.open()."""
2047
1980
        if not _found:
2048
1981
            format = BranchFormat.find_format(a_bzrdir, name=name)
2053
1986
        try:
2054
1987
            control_files = lockable_files.LockableFiles(transport, 'lock',
2055
1988
                                                         lockdir.LockDir)
2056
 
            if found_repository is None:
2057
 
                found_repository = a_bzrdir.find_repository()
2058
1989
            return self._branch_class()(_format=self,
2059
1990
                              _control_files=control_files,
2060
1991
                              name=name,
2061
1992
                              a_bzrdir=a_bzrdir,
2062
 
                              _repository=found_repository,
 
1993
                              _repository=a_bzrdir.find_repository(),
2063
1994
                              ignore_fallbacks=ignore_fallbacks)
2064
1995
        except errors.NoSuchFile:
2065
1996
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
2072
2003
    def supports_tags(self):
2073
2004
        return True
2074
2005
 
2075
 
    def supports_leaving_lock(self):
2076
 
        return True
2077
 
 
2078
2006
 
2079
2007
class BzrBranchFormat5(BranchFormatMetadir):
2080
2008
    """Bzr branch format 5.
2100
2028
        """See BranchFormat.get_format_description()."""
2101
2029
        return "Branch format 5"
2102
2030
 
2103
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2104
 
                   append_revisions_only=None):
 
2031
    def initialize(self, a_bzrdir, name=None):
2105
2032
        """Create a branch of this format in a_bzrdir."""
2106
 
        if append_revisions_only:
2107
 
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2108
2033
        utf8_files = [('revision-history', ''),
2109
2034
                      ('branch-name', ''),
2110
2035
                      ]
2111
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2036
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2112
2037
 
2113
2038
    def supports_tags(self):
2114
2039
        return False
2136
2061
        """See BranchFormat.get_format_description()."""
2137
2062
        return "Branch format 6"
2138
2063
 
2139
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2140
 
                   append_revisions_only=None):
 
2064
    def initialize(self, a_bzrdir, name=None):
2141
2065
        """Create a branch of this format in a_bzrdir."""
2142
2066
        utf8_files = [('last-revision', '0 null:\n'),
2143
 
                      ('branch.conf',
2144
 
                          self._get_initial_config(append_revisions_only)),
 
2067
                      ('branch.conf', ''),
2145
2068
                      ('tags', ''),
2146
2069
                      ]
2147
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2070
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2148
2071
 
2149
2072
    def make_tags(self, branch):
2150
2073
        """See bzrlib.branch.BranchFormat.make_tags()."""
2151
 
        return _mod_tag.BasicTags(branch)
 
2074
        return BasicTags(branch)
2152
2075
 
2153
2076
    def supports_set_append_revisions_only(self):
2154
2077
        return True
2168
2091
        """See BranchFormat.get_format_description()."""
2169
2092
        return "Branch format 8"
2170
2093
 
2171
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2172
 
                   append_revisions_only=None):
 
2094
    def initialize(self, a_bzrdir, name=None):
2173
2095
        """Create a branch of this format in a_bzrdir."""
2174
2096
        utf8_files = [('last-revision', '0 null:\n'),
2175
 
                      ('branch.conf',
2176
 
                          self._get_initial_config(append_revisions_only)),
 
2097
                      ('branch.conf', ''),
2177
2098
                      ('tags', ''),
2178
2099
                      ('references', '')
2179
2100
                      ]
2180
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2101
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2102
 
 
2103
    def __init__(self):
 
2104
        super(BzrBranchFormat8, self).__init__()
 
2105
        self._matchingbzrdir.repository_format = \
 
2106
            RepositoryFormatKnitPack5RichRoot()
2181
2107
 
2182
2108
    def make_tags(self, branch):
2183
2109
        """See bzrlib.branch.BranchFormat.make_tags()."""
2184
 
        return _mod_tag.BasicTags(branch)
 
2110
        return BasicTags(branch)
2185
2111
 
2186
2112
    def supports_set_append_revisions_only(self):
2187
2113
        return True
2192
2118
    supports_reference_locations = True
2193
2119
 
2194
2120
 
2195
 
class BzrBranchFormat7(BranchFormatMetadir):
 
2121
class BzrBranchFormat7(BzrBranchFormat8):
2196
2122
    """Branch format with last-revision, tags, and a stacked location pointer.
2197
2123
 
2198
2124
    The stacked location pointer is passed down to the repository and requires
2201
2127
    This format was introduced in bzr 1.6.
2202
2128
    """
2203
2129
 
2204
 
    def initialize(self, a_bzrdir, name=None, repository=None,
2205
 
                   append_revisions_only=None):
 
2130
    def initialize(self, a_bzrdir, name=None):
2206
2131
        """Create a branch of this format in a_bzrdir."""
2207
2132
        utf8_files = [('last-revision', '0 null:\n'),
2208
 
                      ('branch.conf',
2209
 
                          self._get_initial_config(append_revisions_only)),
 
2133
                      ('branch.conf', ''),
2210
2134
                      ('tags', ''),
2211
2135
                      ]
2212
 
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
 
2136
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2213
2137
 
2214
2138
    def _branch_class(self):
2215
2139
        return BzrBranch7
2225
2149
    def supports_set_append_revisions_only(self):
2226
2150
        return True
2227
2151
 
2228
 
    def supports_stacking(self):
2229
 
        return True
2230
 
 
2231
 
    def make_tags(self, branch):
2232
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2233
 
        return _mod_tag.BasicTags(branch)
2234
 
 
2235
2152
    supports_reference_locations = False
2236
2153
 
2237
2154
 
2264
2181
        transport = a_bzrdir.get_branch_transport(None, name=name)
2265
2182
        location = transport.put_bytes('location', to_branch.base)
2266
2183
 
2267
 
    def initialize(self, a_bzrdir, name=None, target_branch=None,
2268
 
            repository=None, append_revisions_only=None):
 
2184
    def initialize(self, a_bzrdir, name=None, target_branch=None):
2269
2185
        """Create a branch of this format in a_bzrdir."""
2270
2186
        if target_branch is None:
2271
2187
            # this format does not implement branch itself, thus the implicit
2272
2188
            # creation contract must see it as uninitializable
2273
2189
            raise errors.UninitializableFormat(self)
2274
2190
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2275
 
        if a_bzrdir._format.fixed_components:
2276
 
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2277
2191
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2278
2192
        branch_transport.put_bytes('location',
2279
2193
            target_branch.bzrdir.user_url)
2301
2215
        return clone
2302
2216
 
2303
2217
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2304
 
             possible_transports=None, ignore_fallbacks=False,
2305
 
             found_repository=None):
 
2218
             possible_transports=None, ignore_fallbacks=False):
2306
2219
        """Return the branch that the branch reference in a_bzrdir points at.
2307
2220
 
2308
2221
        :param a_bzrdir: A BzrDir that contains a branch.
2339
2252
        return result
2340
2253
 
2341
2254
 
2342
 
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
2343
 
    """Branch format registry."""
2344
 
 
2345
 
    def __init__(self, other_registry=None):
2346
 
        super(BranchFormatRegistry, self).__init__(other_registry)
2347
 
        self._default_format = None
2348
 
 
2349
 
    def set_default(self, format):
2350
 
        self._default_format = format
2351
 
 
2352
 
    def get_default(self):
2353
 
        return self._default_format
2354
 
 
2355
 
 
2356
2255
network_format_registry = registry.FormatRegistry()
2357
2256
"""Registry of formats indexed by their network name.
2358
2257
 
2361
2260
BranchFormat.network_name() for more detail.
2362
2261
"""
2363
2262
 
2364
 
format_registry = BranchFormatRegistry(network_format_registry)
2365
 
 
2366
2263
 
2367
2264
# formats which have no format string are not discoverable
2368
2265
# and not independently creatable, so are not registered.
2370
2267
__format6 = BzrBranchFormat6()
2371
2268
__format7 = BzrBranchFormat7()
2372
2269
__format8 = BzrBranchFormat8()
2373
 
format_registry.register(__format5)
2374
 
format_registry.register(BranchReferenceFormat())
2375
 
format_registry.register(__format6)
2376
 
format_registry.register(__format7)
2377
 
format_registry.register(__format8)
2378
 
format_registry.set_default(__format7)
 
2270
BranchFormat.register_format(__format5)
 
2271
BranchFormat.register_format(BranchReferenceFormat())
 
2272
BranchFormat.register_format(__format6)
 
2273
BranchFormat.register_format(__format7)
 
2274
BranchFormat.register_format(__format8)
 
2275
BranchFormat.set_default_format(__format7)
 
2276
_legacy_formats = [BzrBranchFormat4(),
 
2277
    ]
 
2278
network_format_registry.register(
 
2279
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2379
2280
 
2380
2281
 
2381
2282
class BranchWriteLockResult(LogicalLockResult):
2448
2349
    base = property(_get_base, doc="The URL for the root of this branch.")
2449
2350
 
2450
2351
    def _get_config(self):
2451
 
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
 
2352
        return TransportConfig(self._transport, 'branch.conf')
2452
2353
 
2453
2354
    def is_locked(self):
2454
2355
        return self.control_files.is_locked()
2529
2430
        """See Branch.print_file."""
2530
2431
        return self.repository.print_file(file, revision_id)
2531
2432
 
 
2433
    def _write_revision_history(self, history):
 
2434
        """Factored out of set_revision_history.
 
2435
 
 
2436
        This performs the actual writing to disk.
 
2437
        It is intended to be called by BzrBranch5.set_revision_history."""
 
2438
        self._transport.put_bytes(
 
2439
            'revision-history', '\n'.join(history),
 
2440
            mode=self.bzrdir._get_file_mode())
 
2441
 
 
2442
    @needs_write_lock
 
2443
    def set_revision_history(self, rev_history):
 
2444
        """See Branch.set_revision_history."""
 
2445
        if 'evil' in debug.debug_flags:
 
2446
            mutter_callsite(3, "set_revision_history scales with history.")
 
2447
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2448
        for rev_id in rev_history:
 
2449
            check_not_reserved_id(rev_id)
 
2450
        if Branch.hooks['post_change_branch_tip']:
 
2451
            # Don't calculate the last_revision_info() if there are no hooks
 
2452
            # that will use it.
 
2453
            old_revno, old_revid = self.last_revision_info()
 
2454
        if len(rev_history) == 0:
 
2455
            revid = _mod_revision.NULL_REVISION
 
2456
        else:
 
2457
            revid = rev_history[-1]
 
2458
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2459
        self._write_revision_history(rev_history)
 
2460
        self._clear_cached_state()
 
2461
        self._cache_revision_history(rev_history)
 
2462
        for hook in Branch.hooks['set_rh']:
 
2463
            hook(self, rev_history)
 
2464
        if Branch.hooks['post_change_branch_tip']:
 
2465
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2466
 
 
2467
    def _synchronize_history(self, destination, revision_id):
 
2468
        """Synchronize last revision and revision history between branches.
 
2469
 
 
2470
        This version is most efficient when the destination is also a
 
2471
        BzrBranch5, but works for BzrBranch6 as long as the revision
 
2472
        history is the true lefthand parent history, and all of the revisions
 
2473
        are in the destination's repository.  If not, set_revision_history
 
2474
        will fail.
 
2475
 
 
2476
        :param destination: The branch to copy the history into
 
2477
        :param revision_id: The revision-id to truncate history at.  May
 
2478
          be None to copy complete history.
 
2479
        """
 
2480
        if not isinstance(destination._format, BzrBranchFormat5):
 
2481
            super(BzrBranch, self)._synchronize_history(
 
2482
                destination, revision_id)
 
2483
            return
 
2484
        if revision_id == _mod_revision.NULL_REVISION:
 
2485
            new_history = []
 
2486
        else:
 
2487
            new_history = self.revision_history()
 
2488
        if revision_id is not None and new_history != []:
 
2489
            try:
 
2490
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2491
            except ValueError:
 
2492
                rev = self.repository.get_revision(revision_id)
 
2493
                new_history = rev.get_history(self.repository)[1:]
 
2494
        destination.set_revision_history(new_history)
 
2495
 
2532
2496
    @needs_write_lock
2533
2497
    def set_last_revision_info(self, revno, revision_id):
2534
 
        if not revision_id or not isinstance(revision_id, basestring):
2535
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2498
        """Set the last revision of this branch.
 
2499
 
 
2500
        The caller is responsible for checking that the revno is correct
 
2501
        for this revision id.
 
2502
 
 
2503
        It may be possible to set the branch last revision to an id not
 
2504
        present in the repository.  However, branches can also be
 
2505
        configured to check constraints on history, in which case this may not
 
2506
        be permitted.
 
2507
        """
2536
2508
        revision_id = _mod_revision.ensure_null(revision_id)
2537
 
        old_revno, old_revid = self.last_revision_info()
2538
 
        if self.get_append_revisions_only():
2539
 
            self._check_history_violation(revision_id)
2540
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2541
 
        self._write_last_revision_info(revno, revision_id)
2542
 
        self._clear_cached_state()
2543
 
        self._last_revision_info_cache = revno, revision_id
2544
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2509
        # this old format stores the full history, but this api doesn't
 
2510
        # provide it, so we must generate, and might as well check it's
 
2511
        # correct
 
2512
        history = self._lefthand_history(revision_id)
 
2513
        if len(history) != revno:
 
2514
            raise AssertionError('%d != %d' % (len(history), revno))
 
2515
        self.set_revision_history(history)
 
2516
 
 
2517
    def _gen_revision_history(self):
 
2518
        history = self._transport.get_bytes('revision-history').split('\n')
 
2519
        if history[-1:] == ['']:
 
2520
            # There shouldn't be a trailing newline, but just in case.
 
2521
            history.pop()
 
2522
        return history
 
2523
 
 
2524
    @needs_write_lock
 
2525
    def generate_revision_history(self, revision_id, last_rev=None,
 
2526
        other_branch=None):
 
2527
        """Create a new revision history that will finish with revision_id.
 
2528
 
 
2529
        :param revision_id: the new tip to use.
 
2530
        :param last_rev: The previous last_revision. If not None, then this
 
2531
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2532
        :param other_branch: The other branch that DivergedBranches should
 
2533
            raise with respect to.
 
2534
        """
 
2535
        self.set_revision_history(self._lefthand_history(revision_id,
 
2536
            last_rev, other_branch))
2545
2537
 
2546
2538
    def basis_tree(self):
2547
2539
        """See Branch.basis_tree."""
2556
2548
                pass
2557
2549
        return None
2558
2550
 
 
2551
    def _basic_push(self, target, overwrite, stop_revision):
 
2552
        """Basic implementation of push without bound branches or hooks.
 
2553
 
 
2554
        Must be called with source read locked and target write locked.
 
2555
        """
 
2556
        result = BranchPushResult()
 
2557
        result.source_branch = self
 
2558
        result.target_branch = target
 
2559
        result.old_revno, result.old_revid = target.last_revision_info()
 
2560
        self.update_references(target)
 
2561
        if result.old_revid != self.last_revision():
 
2562
            # We assume that during 'push' this repository is closer than
 
2563
            # the target.
 
2564
            graph = self.repository.get_graph(target.repository)
 
2565
            target.update_revisions(self, stop_revision,
 
2566
                overwrite=overwrite, graph=graph)
 
2567
        if self._push_should_merge_tags():
 
2568
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2569
                overwrite)
 
2570
        result.new_revno, result.new_revid = target.last_revision_info()
 
2571
        return result
 
2572
 
2559
2573
    def get_stacked_on_url(self):
2560
2574
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2561
2575
 
2572
2586
            self._transport.put_bytes('parent', url + '\n',
2573
2587
                mode=self.bzrdir._get_file_mode())
2574
2588
 
 
2589
 
 
2590
class BzrBranch5(BzrBranch):
 
2591
    """A format 5 branch. This supports new features over plain branches.
 
2592
 
 
2593
    It has support for a master_branch which is the data for bound branches.
 
2594
    """
 
2595
 
 
2596
    def get_bound_location(self):
 
2597
        try:
 
2598
            return self._transport.get_bytes('bound')[:-1]
 
2599
        except errors.NoSuchFile:
 
2600
            return None
 
2601
 
 
2602
    @needs_read_lock
 
2603
    def get_master_branch(self, possible_transports=None):
 
2604
        """Return the branch we are bound to.
 
2605
 
 
2606
        :return: Either a Branch, or None
 
2607
 
 
2608
        This could memoise the branch, but if thats done
 
2609
        it must be revalidated on each new lock.
 
2610
        So for now we just don't memoise it.
 
2611
        # RBC 20060304 review this decision.
 
2612
        """
 
2613
        bound_loc = self.get_bound_location()
 
2614
        if not bound_loc:
 
2615
            return None
 
2616
        try:
 
2617
            return Branch.open(bound_loc,
 
2618
                               possible_transports=possible_transports)
 
2619
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2620
            raise errors.BoundBranchConnectionFailure(
 
2621
                    self, bound_loc, e)
 
2622
 
2575
2623
    @needs_write_lock
2576
 
    def unbind(self):
2577
 
        """If bound, unbind"""
2578
 
        return self.set_bound_location(None)
 
2624
    def set_bound_location(self, location):
 
2625
        """Set the target where this branch is bound to.
 
2626
 
 
2627
        :param location: URL to the target branch
 
2628
        """
 
2629
        if location:
 
2630
            self._transport.put_bytes('bound', location+'\n',
 
2631
                mode=self.bzrdir._get_file_mode())
 
2632
        else:
 
2633
            try:
 
2634
                self._transport.delete('bound')
 
2635
            except errors.NoSuchFile:
 
2636
                return False
 
2637
            return True
2579
2638
 
2580
2639
    @needs_write_lock
2581
2640
    def bind(self, other):
2603
2662
        # history around
2604
2663
        self.set_bound_location(other.base)
2605
2664
 
2606
 
    def get_bound_location(self):
2607
 
        try:
2608
 
            return self._transport.get_bytes('bound')[:-1]
2609
 
        except errors.NoSuchFile:
2610
 
            return None
2611
 
 
2612
 
    @needs_read_lock
2613
 
    def get_master_branch(self, possible_transports=None):
2614
 
        """Return the branch we are bound to.
2615
 
 
2616
 
        :return: Either a Branch, or None
2617
 
        """
2618
 
        if self._master_branch_cache is None:
2619
 
            self._master_branch_cache = self._get_master_branch(
2620
 
                possible_transports)
2621
 
        return self._master_branch_cache
2622
 
 
2623
 
    def _get_master_branch(self, possible_transports):
2624
 
        bound_loc = self.get_bound_location()
2625
 
        if not bound_loc:
2626
 
            return None
2627
 
        try:
2628
 
            return Branch.open(bound_loc,
2629
 
                               possible_transports=possible_transports)
2630
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2631
 
            raise errors.BoundBranchConnectionFailure(
2632
 
                    self, bound_loc, e)
2633
 
 
2634
2665
    @needs_write_lock
2635
 
    def set_bound_location(self, location):
2636
 
        """Set the target where this branch is bound to.
2637
 
 
2638
 
        :param location: URL to the target branch
2639
 
        """
2640
 
        self._master_branch_cache = None
2641
 
        if location:
2642
 
            self._transport.put_bytes('bound', location+'\n',
2643
 
                mode=self.bzrdir._get_file_mode())
2644
 
        else:
2645
 
            try:
2646
 
                self._transport.delete('bound')
2647
 
            except errors.NoSuchFile:
2648
 
                return False
2649
 
            return True
 
2666
    def unbind(self):
 
2667
        """If bound, unbind"""
 
2668
        return self.set_bound_location(None)
2650
2669
 
2651
2670
    @needs_write_lock
2652
2671
    def update(self, possible_transports=None):
2665
2684
            return old_tip
2666
2685
        return None
2667
2686
 
2668
 
    def _read_last_revision_info(self):
2669
 
        revision_string = self._transport.get_bytes('last-revision')
2670
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2671
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2672
 
        revno = int(revno)
2673
 
        return revno, revision_id
2674
 
 
2675
 
    def _write_last_revision_info(self, revno, revision_id):
2676
 
        """Simply write out the revision id, with no checks.
2677
 
 
2678
 
        Use set_last_revision_info to perform this safely.
2679
 
 
2680
 
        Does not update the revision_history cache.
2681
 
        """
2682
 
        revision_id = _mod_revision.ensure_null(revision_id)
2683
 
        out_string = '%d %s\n' % (revno, revision_id)
2684
 
        self._transport.put_bytes('last-revision', out_string,
2685
 
            mode=self.bzrdir._get_file_mode())
2686
 
 
2687
 
 
2688
 
class FullHistoryBzrBranch(BzrBranch):
2689
 
    """Bzr branch which contains the full revision history."""
2690
 
 
2691
 
    @needs_write_lock
2692
 
    def set_last_revision_info(self, revno, revision_id):
2693
 
        if not revision_id or not isinstance(revision_id, basestring):
2694
 
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2695
 
        revision_id = _mod_revision.ensure_null(revision_id)
2696
 
        # this old format stores the full history, but this api doesn't
2697
 
        # provide it, so we must generate, and might as well check it's
2698
 
        # correct
2699
 
        history = self._lefthand_history(revision_id)
2700
 
        if len(history) != revno:
2701
 
            raise AssertionError('%d != %d' % (len(history), revno))
2702
 
        self._set_revision_history(history)
2703
 
 
2704
 
    def _read_last_revision_info(self):
2705
 
        rh = self.revision_history()
2706
 
        revno = len(rh)
2707
 
        if revno:
2708
 
            return (revno, rh[-1])
2709
 
        else:
2710
 
            return (0, _mod_revision.NULL_REVISION)
2711
 
 
2712
 
    @deprecated_method(deprecated_in((2, 4, 0)))
2713
 
    @needs_write_lock
2714
 
    def set_revision_history(self, rev_history):
2715
 
        """See Branch.set_revision_history."""
2716
 
        self._set_revision_history(rev_history)
2717
 
 
2718
 
    def _set_revision_history(self, rev_history):
2719
 
        if 'evil' in debug.debug_flags:
2720
 
            mutter_callsite(3, "set_revision_history scales with history.")
2721
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2722
 
        for rev_id in rev_history:
2723
 
            check_not_reserved_id(rev_id)
2724
 
        if Branch.hooks['post_change_branch_tip']:
2725
 
            # Don't calculate the last_revision_info() if there are no hooks
2726
 
            # that will use it.
2727
 
            old_revno, old_revid = self.last_revision_info()
2728
 
        if len(rev_history) == 0:
2729
 
            revid = _mod_revision.NULL_REVISION
2730
 
        else:
2731
 
            revid = rev_history[-1]
2732
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2733
 
        self._write_revision_history(rev_history)
2734
 
        self._clear_cached_state()
2735
 
        self._cache_revision_history(rev_history)
2736
 
        for hook in Branch.hooks['set_rh']:
2737
 
            hook(self, rev_history)
2738
 
        if Branch.hooks['post_change_branch_tip']:
2739
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2740
 
 
2741
 
    def _write_revision_history(self, history):
2742
 
        """Factored out of set_revision_history.
2743
 
 
2744
 
        This performs the actual writing to disk.
2745
 
        It is intended to be called by set_revision_history."""
2746
 
        self._transport.put_bytes(
2747
 
            'revision-history', '\n'.join(history),
2748
 
            mode=self.bzrdir._get_file_mode())
2749
 
 
2750
 
    def _gen_revision_history(self):
2751
 
        history = self._transport.get_bytes('revision-history').split('\n')
2752
 
        if history[-1:] == ['']:
2753
 
            # There shouldn't be a trailing newline, but just in case.
2754
 
            history.pop()
2755
 
        return history
2756
 
 
2757
 
    def _synchronize_history(self, destination, revision_id):
2758
 
        if not isinstance(destination, FullHistoryBzrBranch):
2759
 
            super(BzrBranch, self)._synchronize_history(
2760
 
                destination, revision_id)
2761
 
            return
2762
 
        if revision_id == _mod_revision.NULL_REVISION:
2763
 
            new_history = []
2764
 
        else:
2765
 
            new_history = self.revision_history()
2766
 
        if revision_id is not None and new_history != []:
2767
 
            try:
2768
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2769
 
            except ValueError:
2770
 
                rev = self.repository.get_revision(revision_id)
2771
 
                new_history = rev.get_history(self.repository)[1:]
2772
 
        destination._set_revision_history(new_history)
2773
 
 
2774
 
    @needs_write_lock
2775
 
    def generate_revision_history(self, revision_id, last_rev=None,
2776
 
        other_branch=None):
2777
 
        """Create a new revision history that will finish with revision_id.
2778
 
 
2779
 
        :param revision_id: the new tip to use.
2780
 
        :param last_rev: The previous last_revision. If not None, then this
2781
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2782
 
        :param other_branch: The other branch that DivergedBranches should
2783
 
            raise with respect to.
2784
 
        """
2785
 
        self._set_revision_history(self._lefthand_history(revision_id,
2786
 
            last_rev, other_branch))
2787
 
 
2788
 
 
2789
 
class BzrBranch5(FullHistoryBzrBranch):
2790
 
    """A format 5 branch. This supports new features over plain branches.
2791
 
 
2792
 
    It has support for a master_branch which is the data for bound branches.
2793
 
    """
2794
 
 
2795
 
 
2796
 
class BzrBranch8(BzrBranch):
 
2687
 
 
2688
class BzrBranch8(BzrBranch5):
2797
2689
    """A branch that stores tree-reference locations."""
2798
2690
 
2799
2691
    def _open_hook(self):
2825
2717
        self._last_revision_info_cache = None
2826
2718
        self._reference_info = None
2827
2719
 
 
2720
    def _last_revision_info(self):
 
2721
        revision_string = self._transport.get_bytes('last-revision')
 
2722
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2723
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2724
        revno = int(revno)
 
2725
        return revno, revision_id
 
2726
 
 
2727
    def _write_last_revision_info(self, revno, revision_id):
 
2728
        """Simply write out the revision id, with no checks.
 
2729
 
 
2730
        Use set_last_revision_info to perform this safely.
 
2731
 
 
2732
        Does not update the revision_history cache.
 
2733
        Intended to be called by set_last_revision_info and
 
2734
        _write_revision_history.
 
2735
        """
 
2736
        revision_id = _mod_revision.ensure_null(revision_id)
 
2737
        out_string = '%d %s\n' % (revno, revision_id)
 
2738
        self._transport.put_bytes('last-revision', out_string,
 
2739
            mode=self.bzrdir._get_file_mode())
 
2740
 
 
2741
    @needs_write_lock
 
2742
    def set_last_revision_info(self, revno, revision_id):
 
2743
        revision_id = _mod_revision.ensure_null(revision_id)
 
2744
        old_revno, old_revid = self.last_revision_info()
 
2745
        if self._get_append_revisions_only():
 
2746
            self._check_history_violation(revision_id)
 
2747
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2748
        self._write_last_revision_info(revno, revision_id)
 
2749
        self._clear_cached_state()
 
2750
        self._last_revision_info_cache = revno, revision_id
 
2751
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2752
 
 
2753
    def _synchronize_history(self, destination, revision_id):
 
2754
        """Synchronize last revision and revision history between branches.
 
2755
 
 
2756
        :see: Branch._synchronize_history
 
2757
        """
 
2758
        # XXX: The base Branch has a fast implementation of this method based
 
2759
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
 
2760
        # that uses set_revision_history.  This class inherits from BzrBranch5,
 
2761
        # but wants the fast implementation, so it calls
 
2762
        # Branch._synchronize_history directly.
 
2763
        Branch._synchronize_history(self, destination, revision_id)
 
2764
 
2828
2765
    def _check_history_violation(self, revision_id):
2829
 
        current_revid = self.last_revision()
2830
 
        last_revision = _mod_revision.ensure_null(current_revid)
 
2766
        last_revision = _mod_revision.ensure_null(self.last_revision())
2831
2767
        if _mod_revision.is_null(last_revision):
2832
2768
            return
2833
 
        graph = self.repository.get_graph()
2834
 
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
2835
 
            if lh_ancestor == current_revid:
2836
 
                return
2837
 
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2769
        if last_revision not in self._lefthand_history(revision_id):
 
2770
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2838
2771
 
2839
2772
    def _gen_revision_history(self):
2840
2773
        """Generate the revision history from last revision
2843
2776
        self._extend_partial_history(stop_index=last_revno-1)
2844
2777
        return list(reversed(self._partial_revision_history_cache))
2845
2778
 
 
2779
    def _write_revision_history(self, history):
 
2780
        """Factored out of set_revision_history.
 
2781
 
 
2782
        This performs the actual writing to disk, with format-specific checks.
 
2783
        It is intended to be called by BzrBranch5.set_revision_history.
 
2784
        """
 
2785
        if len(history) == 0:
 
2786
            last_revision = 'null:'
 
2787
        else:
 
2788
            if history != self._lefthand_history(history[-1]):
 
2789
                raise errors.NotLefthandHistory(history)
 
2790
            last_revision = history[-1]
 
2791
        if self._get_append_revisions_only():
 
2792
            self._check_history_violation(last_revision)
 
2793
        self._write_last_revision_info(len(history), last_revision)
 
2794
 
2846
2795
    @needs_write_lock
2847
2796
    def _set_parent_location(self, url):
2848
2797
        """Set the parent branch"""
2934
2883
 
2935
2884
    def set_bound_location(self, location):
2936
2885
        """See Branch.set_push_location."""
2937
 
        self._master_branch_cache = None
2938
2886
        result = None
2939
2887
        config = self.get_config()
2940
2888
        if location is None:
2971
2919
        # you can always ask for the URL; but you might not be able to use it
2972
2920
        # if the repo can't support stacking.
2973
2921
        ## self._check_stackable_repo()
2974
 
        # stacked_on_location is only ever defined in branch.conf, so don't
2975
 
        # waste effort reading the whole stack of config files.
2976
 
        config = self.get_config()._get_branch_data_config()
2977
 
        stacked_url = self._get_config_location('stacked_on_location',
2978
 
            config=config)
 
2922
        stacked_url = self._get_config_location('stacked_on_location')
2979
2923
        if stacked_url is None:
2980
2924
            raise errors.NotStacked(self)
2981
2925
        return stacked_url
2982
2926
 
 
2927
    def _get_append_revisions_only(self):
 
2928
        return self.get_config(
 
2929
            ).get_user_option_as_bool('append_revisions_only')
 
2930
 
 
2931
    @needs_write_lock
 
2932
    def generate_revision_history(self, revision_id, last_rev=None,
 
2933
                                  other_branch=None):
 
2934
        """See BzrBranch5.generate_revision_history"""
 
2935
        history = self._lefthand_history(revision_id, last_rev, other_branch)
 
2936
        revno = len(history)
 
2937
        self.set_last_revision_info(revno, revision_id)
 
2938
 
2983
2939
    @needs_read_lock
2984
2940
    def get_rev_id(self, revno, history=None):
2985
2941
        """Find the revision id of the specified revno."""
3009
2965
        try:
3010
2966
            index = self._partial_revision_history_cache.index(revision_id)
3011
2967
        except ValueError:
3012
 
            try:
3013
 
                self._extend_partial_history(stop_revision=revision_id)
3014
 
            except errors.RevisionNotPresent, e:
3015
 
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
 
2968
            self._extend_partial_history(stop_revision=revision_id)
3016
2969
            index = len(self._partial_revision_history_cache) - 1
3017
2970
            if self._partial_revision_history_cache[index] != revision_id:
3018
2971
                raise errors.NoSuchRevision(self, revision_id)
3071
3024
    :ivar local_branch: target branch if there is a Master, else None
3072
3025
    :ivar target_branch: Target/destination branch object. (write locked)
3073
3026
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
3074
 
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
3075
3027
    """
3076
3028
 
3077
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3078
3029
    def __int__(self):
3079
 
        """Return the relative change in revno.
3080
 
 
3081
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3082
 
        """
 
3030
        # DEPRECATED: pull used to return the change in revno
3083
3031
        return self.new_revno - self.old_revno
3084
3032
 
3085
3033
    def report(self, to_file):
3086
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3087
 
        tag_updates = getattr(self, "tag_updates", None)
3088
3034
        if not is_quiet():
3089
 
            if self.old_revid != self.new_revid:
 
3035
            if self.old_revid == self.new_revid:
 
3036
                to_file.write('No revisions to pull.\n')
 
3037
            else:
3090
3038
                to_file.write('Now on revision %d.\n' % self.new_revno)
3091
 
            if tag_updates:
3092
 
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
3093
 
            if self.old_revid == self.new_revid and not tag_updates:
3094
 
                if not tag_conflicts:
3095
 
                    to_file.write('No revisions or tags to pull.\n')
3096
 
                else:
3097
 
                    to_file.write('No revisions to pull.\n')
3098
3039
        self._show_tag_conficts(to_file)
3099
3040
 
3100
3041
 
3117
3058
        target, otherwise it will be None.
3118
3059
    """
3119
3060
 
3120
 
    @deprecated_method(deprecated_in((2, 3, 0)))
3121
3061
    def __int__(self):
3122
 
        """Return the relative change in revno.
3123
 
 
3124
 
        :deprecated: Use `new_revno` and `old_revno` instead.
3125
 
        """
 
3062
        # DEPRECATED: push used to return the change in revno
3126
3063
        return self.new_revno - self.old_revno
3127
3064
 
3128
3065
    def report(self, to_file):
3129
 
        # TODO: This function gets passed a to_file, but then
3130
 
        # ignores it and calls note() instead. This is also
3131
 
        # inconsistent with PullResult(), which writes to stdout.
3132
 
        # -- JRV20110901, bug #838853
3133
 
        tag_conflicts = getattr(self, "tag_conflicts", None)
3134
 
        tag_updates = getattr(self, "tag_updates", None)
3135
 
        if not is_quiet():
3136
 
            if self.old_revid != self.new_revid:
3137
 
                note('Pushed up to revision %d.' % self.new_revno)
3138
 
            if tag_updates:
3139
 
                note('%d tag(s) updated.' % len(tag_updates))
3140
 
            if self.old_revid == self.new_revid and not tag_updates:
3141
 
                if not tag_conflicts:
3142
 
                    note('No new revisions or tags to push.')
3143
 
                else:
3144
 
                    note('No new revisions to push.')
 
3066
        """Write a human-readable description of the result."""
 
3067
        if self.old_revid == self.new_revid:
 
3068
            note('No new revisions to push.')
 
3069
        else:
 
3070
            note('Pushed up to revision %d.' % self.new_revno)
3145
3071
        self._show_tag_conficts(to_file)
3146
3072
 
3147
3073
 
3209
3135
 
3210
3136
 
3211
3137
class Converter7to8(object):
3212
 
    """Perform an in-place upgrade of format 7 to format 8"""
 
3138
    """Perform an in-place upgrade of format 6 to format 7"""
3213
3139
 
3214
3140
    def convert(self, branch):
3215
3141
        format = BzrBranchFormat8()
3218
3144
        branch._transport.put_bytes('format', format.get_format_string())
3219
3145
 
3220
3146
 
 
3147
def _run_with_write_locked_target(target, callable, *args, **kwargs):
 
3148
    """Run ``callable(*args, **kwargs)``, write-locking target for the
 
3149
    duration.
 
3150
 
 
3151
    _run_with_write_locked_target will attempt to release the lock it acquires.
 
3152
 
 
3153
    If an exception is raised by callable, then that exception *will* be
 
3154
    propagated, even if the unlock attempt raises its own error.  Thus
 
3155
    _run_with_write_locked_target should be preferred to simply doing::
 
3156
 
 
3157
        target.lock_write()
 
3158
        try:
 
3159
            return callable(*args, **kwargs)
 
3160
        finally:
 
3161
            target.unlock()
 
3162
 
 
3163
    """
 
3164
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
 
3165
    # should share code?
 
3166
    target.lock_write()
 
3167
    try:
 
3168
        result = callable(*args, **kwargs)
 
3169
    except:
 
3170
        exc_info = sys.exc_info()
 
3171
        try:
 
3172
            target.unlock()
 
3173
        finally:
 
3174
            raise exc_info[0], exc_info[1], exc_info[2]
 
3175
    else:
 
3176
        target.unlock()
 
3177
        return result
 
3178
 
 
3179
 
3221
3180
class InterBranch(InterObject):
3222
3181
    """This class represents operations taking place between two branches.
3223
3182
 
3229
3188
    _optimisers = []
3230
3189
    """The available optimised InterBranch types."""
3231
3190
 
3232
 
    @classmethod
3233
 
    def _get_branch_formats_to_test(klass):
3234
 
        """Return an iterable of format tuples for testing.
3235
 
        
3236
 
        :return: An iterable of (from_format, to_format) to use when testing
3237
 
            this InterBranch class. Each InterBranch class should define this
3238
 
            method itself.
3239
 
        """
3240
 
        raise NotImplementedError(klass._get_branch_formats_to_test)
 
3191
    @staticmethod
 
3192
    def _get_branch_formats_to_test():
 
3193
        """Return a tuple with the Branch formats to use when testing."""
 
3194
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3241
3195
 
3242
 
    @needs_write_lock
3243
3196
    def pull(self, overwrite=False, stop_revision=None,
3244
3197
             possible_transports=None, local=False):
3245
3198
        """Mirror source into target branch.
3250
3203
        """
3251
3204
        raise NotImplementedError(self.pull)
3252
3205
 
3253
 
    @needs_write_lock
3254
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3206
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3207
                         graph=None):
 
3208
        """Pull in new perfect-fit revisions.
 
3209
 
 
3210
        :param stop_revision: Updated until the given revision
 
3211
        :param overwrite: Always set the branch pointer, rather than checking
 
3212
            to see if it is a proper descendant.
 
3213
        :param graph: A Graph object that can be used to query history
 
3214
            information. This can be None.
 
3215
        :return: None
 
3216
        """
 
3217
        raise NotImplementedError(self.update_revisions)
 
3218
 
 
3219
    def push(self, overwrite=False, stop_revision=None,
3255
3220
             _override_hook_source_branch=None):
3256
3221
        """Mirror the source branch into the target branch.
3257
3222
 
3259
3224
        """
3260
3225
        raise NotImplementedError(self.push)
3261
3226
 
3262
 
    @needs_write_lock
3263
 
    def copy_content_into(self, revision_id=None):
3264
 
        """Copy the content of source into target
3265
 
 
3266
 
        revision_id: if not None, the revision history in the new branch will
3267
 
                     be truncated to end with revision_id.
3268
 
        """
3269
 
        raise NotImplementedError(self.copy_content_into)
3270
 
 
3271
 
    @needs_write_lock
3272
 
    def fetch(self, stop_revision=None, limit=None):
3273
 
        """Fetch revisions.
3274
 
 
3275
 
        :param stop_revision: Last revision to fetch
3276
 
        :param limit: Optional rough limit of revisions to fetch
3277
 
        """
3278
 
        raise NotImplementedError(self.fetch)
3279
 
 
3280
3227
 
3281
3228
class GenericInterBranch(InterBranch):
3282
 
    """InterBranch implementation that uses public Branch functions."""
3283
 
 
3284
 
    @classmethod
3285
 
    def is_compatible(klass, source, target):
3286
 
        # GenericBranch uses the public API, so always compatible
3287
 
        return True
3288
 
 
3289
 
    @classmethod
3290
 
    def _get_branch_formats_to_test(klass):
3291
 
        return [(format_registry.get_default(), format_registry.get_default())]
3292
 
 
3293
 
    @classmethod
3294
 
    def unwrap_format(klass, format):
3295
 
        if isinstance(format, remote.RemoteBranchFormat):
3296
 
            format._ensure_real()
3297
 
            return format._custom_format
3298
 
        return format
3299
 
 
3300
 
    @needs_write_lock
3301
 
    def copy_content_into(self, revision_id=None):
3302
 
        """Copy the content of source into target
3303
 
 
3304
 
        revision_id: if not None, the revision history in the new branch will
3305
 
                     be truncated to end with revision_id.
3306
 
        """
3307
 
        self.source.update_references(self.target)
3308
 
        self.source._synchronize_history(self.target, revision_id)
3309
 
        try:
3310
 
            parent = self.source.get_parent()
3311
 
        except errors.InaccessibleParent, e:
3312
 
            mutter('parent was not accessible to copy: %s', e)
3313
 
        else:
3314
 
            if parent:
3315
 
                self.target.set_parent(parent)
3316
 
        if self.source._push_should_merge_tags():
3317
 
            self.source.tags.merge_to(self.target.tags)
3318
 
 
3319
 
    @needs_write_lock
3320
 
    def fetch(self, stop_revision=None, limit=None):
3321
 
        if self.target.base == self.source.base:
3322
 
            return (0, [])
 
3229
    """InterBranch implementation that uses public Branch functions.
 
3230
    """
 
3231
 
 
3232
    @staticmethod
 
3233
    def _get_branch_formats_to_test():
 
3234
        return BranchFormat._default_format, BranchFormat._default_format
 
3235
 
 
3236
    def update_revisions(self, stop_revision=None, overwrite=False,
 
3237
        graph=None):
 
3238
        """See InterBranch.update_revisions()."""
3323
3239
        self.source.lock_read()
3324
3240
        try:
3325
 
            fetch_spec_factory = fetch.FetchSpecFactory()
3326
 
            fetch_spec_factory.source_branch = self.source
3327
 
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
3328
 
            fetch_spec_factory.source_repo = self.source.repository
3329
 
            fetch_spec_factory.target_repo = self.target.repository
3330
 
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
3331
 
            fetch_spec_factory.limit = limit
3332
 
            fetch_spec = fetch_spec_factory.make_fetch_spec()
3333
 
            return self.target.repository.fetch(self.source.repository,
3334
 
                fetch_spec=fetch_spec)
 
3241
            other_revno, other_last_revision = self.source.last_revision_info()
 
3242
            stop_revno = None # unknown
 
3243
            if stop_revision is None:
 
3244
                stop_revision = other_last_revision
 
3245
                if _mod_revision.is_null(stop_revision):
 
3246
                    # if there are no commits, we're done.
 
3247
                    return
 
3248
                stop_revno = other_revno
 
3249
 
 
3250
            # what's the current last revision, before we fetch [and change it
 
3251
            # possibly]
 
3252
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3253
            # we fetch here so that we don't process data twice in the common
 
3254
            # case of having something to pull, and so that the check for
 
3255
            # already merged can operate on the just fetched graph, which will
 
3256
            # be cached in memory.
 
3257
            self.target.fetch(self.source, stop_revision)
 
3258
            # Check to see if one is an ancestor of the other
 
3259
            if not overwrite:
 
3260
                if graph is None:
 
3261
                    graph = self.target.repository.get_graph()
 
3262
                if self.target._check_if_descendant_or_diverged(
 
3263
                        stop_revision, last_rev, graph, self.source):
 
3264
                    # stop_revision is a descendant of last_rev, but we aren't
 
3265
                    # overwriting, so we're done.
 
3266
                    return
 
3267
            if stop_revno is None:
 
3268
                if graph is None:
 
3269
                    graph = self.target.repository.get_graph()
 
3270
                this_revno, this_last_revision = \
 
3271
                        self.target.last_revision_info()
 
3272
                stop_revno = graph.find_distance_to_null(stop_revision,
 
3273
                                [(other_last_revision, other_revno),
 
3274
                                 (this_last_revision, this_revno)])
 
3275
            self.target.set_last_revision_info(stop_revno, stop_revision)
3335
3276
        finally:
3336
3277
            self.source.unlock()
3337
3278
 
3338
 
    @needs_write_lock
3339
 
    def _update_revisions(self, stop_revision=None, overwrite=False,
3340
 
            graph=None):
3341
 
        other_revno, other_last_revision = self.source.last_revision_info()
3342
 
        stop_revno = None # unknown
3343
 
        if stop_revision is None:
3344
 
            stop_revision = other_last_revision
3345
 
            if _mod_revision.is_null(stop_revision):
3346
 
                # if there are no commits, we're done.
3347
 
                return
3348
 
            stop_revno = other_revno
3349
 
 
3350
 
        # what's the current last revision, before we fetch [and change it
3351
 
        # possibly]
3352
 
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
3353
 
        # we fetch here so that we don't process data twice in the common
3354
 
        # case of having something to pull, and so that the check for
3355
 
        # already merged can operate on the just fetched graph, which will
3356
 
        # be cached in memory.
3357
 
        self.fetch(stop_revision=stop_revision)
3358
 
        # Check to see if one is an ancestor of the other
3359
 
        if not overwrite:
3360
 
            if graph is None:
3361
 
                graph = self.target.repository.get_graph()
3362
 
            if self.target._check_if_descendant_or_diverged(
3363
 
                    stop_revision, last_rev, graph, self.source):
3364
 
                # stop_revision is a descendant of last_rev, but we aren't
3365
 
                # overwriting, so we're done.
3366
 
                return
3367
 
        if stop_revno is None:
3368
 
            if graph is None:
3369
 
                graph = self.target.repository.get_graph()
3370
 
            this_revno, this_last_revision = \
3371
 
                    self.target.last_revision_info()
3372
 
            stop_revno = graph.find_distance_to_null(stop_revision,
3373
 
                            [(other_last_revision, other_revno),
3374
 
                             (this_last_revision, this_revno)])
3375
 
        self.target.set_last_revision_info(stop_revno, stop_revision)
3376
 
 
3377
 
    @needs_write_lock
3378
3279
    def pull(self, overwrite=False, stop_revision=None,
3379
 
             possible_transports=None, run_hooks=True,
3380
 
             _override_hook_target=None, local=False):
3381
 
        """Pull from source into self, updating my master if any.
3382
 
 
3383
 
        :param run_hooks: Private parameter - if false, this branch
3384
 
            is being called because it's the master of the primary branch,
3385
 
            so it should not run its hooks.
3386
 
        """
3387
 
        bound_location = self.target.get_bound_location()
3388
 
        if local and not bound_location:
3389
 
            raise errors.LocalRequiresBoundBranch()
3390
 
        master_branch = None
3391
 
        source_is_master = False
3392
 
        if bound_location:
3393
 
            # bound_location comes from a config file, some care has to be
3394
 
            # taken to relate it to source.user_url
3395
 
            normalized = urlutils.normalize_url(bound_location)
3396
 
            try:
3397
 
                relpath = self.source.user_transport.relpath(normalized)
3398
 
                source_is_master = (relpath == '')
3399
 
            except (errors.PathNotChild, errors.InvalidURL):
3400
 
                source_is_master = False
3401
 
        if not local and bound_location and not source_is_master:
3402
 
            # not pulling from master, so we need to update master.
3403
 
            master_branch = self.target.get_master_branch(possible_transports)
3404
 
            master_branch.lock_write()
3405
 
        try:
3406
 
            if master_branch:
3407
 
                # pull from source into master.
3408
 
                master_branch.pull(self.source, overwrite, stop_revision,
3409
 
                    run_hooks=False)
3410
 
            return self._pull(overwrite,
3411
 
                stop_revision, _hook_master=master_branch,
3412
 
                run_hooks=run_hooks,
3413
 
                _override_hook_target=_override_hook_target,
3414
 
                merge_tags_to_master=not source_is_master)
3415
 
        finally:
3416
 
            if master_branch:
3417
 
                master_branch.unlock()
3418
 
 
3419
 
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3420
 
             _override_hook_source_branch=None):
3421
 
        """See InterBranch.push.
3422
 
 
3423
 
        This is the basic concrete implementation of push()
3424
 
 
3425
 
        :param _override_hook_source_branch: If specified, run the hooks
3426
 
            passing this Branch as the source, rather than self.  This is for
3427
 
            use of RemoteBranch, where push is delegated to the underlying
3428
 
            vfs-based Branch.
3429
 
        """
3430
 
        if lossy:
3431
 
            raise errors.LossyPushToSameVCS(self.source, self.target)
3432
 
        # TODO: Public option to disable running hooks - should be trivial but
3433
 
        # needs tests.
3434
 
 
3435
 
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
3436
 
        op.add_cleanup(self.source.lock_read().unlock)
3437
 
        op.add_cleanup(self.target.lock_write().unlock)
3438
 
        return op.run(overwrite, stop_revision,
3439
 
            _override_hook_source_branch=_override_hook_source_branch)
3440
 
 
3441
 
    def _basic_push(self, overwrite, stop_revision):
3442
 
        """Basic implementation of push without bound branches or hooks.
3443
 
 
3444
 
        Must be called with source read locked and target write locked.
3445
 
        """
3446
 
        result = BranchPushResult()
3447
 
        result.source_branch = self.source
3448
 
        result.target_branch = self.target
3449
 
        result.old_revno, result.old_revid = self.target.last_revision_info()
3450
 
        self.source.update_references(self.target)
3451
 
        if result.old_revid != stop_revision:
3452
 
            # We assume that during 'push' this repository is closer than
3453
 
            # the target.
3454
 
            graph = self.source.repository.get_graph(self.target.repository)
3455
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3456
 
                    graph=graph)
3457
 
        if self.source._push_should_merge_tags():
3458
 
            result.tag_updates, result.tag_conflicts = (
3459
 
                self.source.tags.merge_to(self.target.tags, overwrite))
3460
 
        result.new_revno, result.new_revid = self.target.last_revision_info()
3461
 
        return result
3462
 
 
3463
 
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
3464
 
            _override_hook_source_branch=None):
3465
 
        """Push from source into target, and into target's master if any.
3466
 
        """
3467
 
        def _run_hooks():
3468
 
            if _override_hook_source_branch:
3469
 
                result.source_branch = _override_hook_source_branch
3470
 
            for hook in Branch.hooks['post_push']:
3471
 
                hook(result)
3472
 
 
3473
 
        bound_location = self.target.get_bound_location()
3474
 
        if bound_location and self.target.base != bound_location:
3475
 
            # there is a master branch.
3476
 
            #
3477
 
            # XXX: Why the second check?  Is it even supported for a branch to
3478
 
            # be bound to itself? -- mbp 20070507
3479
 
            master_branch = self.target.get_master_branch()
3480
 
            master_branch.lock_write()
3481
 
            operation.add_cleanup(master_branch.unlock)
3482
 
            # push into the master from the source branch.
3483
 
            master_inter = InterBranch.get(self.source, master_branch)
3484
 
            master_inter._basic_push(overwrite, stop_revision)
3485
 
            # and push into the target branch from the source. Note that
3486
 
            # we push from the source branch again, because it's considered
3487
 
            # the highest bandwidth repository.
3488
 
            result = self._basic_push(overwrite, stop_revision)
3489
 
            result.master_branch = master_branch
3490
 
            result.local_branch = self.target
3491
 
        else:
3492
 
            master_branch = None
3493
 
            # no master branch
3494
 
            result = self._basic_push(overwrite, stop_revision)
3495
 
            # TODO: Why set master_branch and local_branch if there's no
3496
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3497
 
            # 20070504
3498
 
            result.master_branch = self.target
3499
 
            result.local_branch = None
3500
 
        _run_hooks()
3501
 
        return result
3502
 
 
3503
 
    def _pull(self, overwrite=False, stop_revision=None,
3504
3280
             possible_transports=None, _hook_master=None, run_hooks=True,
3505
 
             _override_hook_target=None, local=False,
3506
 
             merge_tags_to_master=True):
 
3281
             _override_hook_target=None, local=False):
3507
3282
        """See Branch.pull.
3508
3283
 
3509
 
        This function is the core worker, used by GenericInterBranch.pull to
3510
 
        avoid duplication when pulling source->master and source->local.
3511
 
 
3512
3284
        :param _hook_master: Private parameter - set the branch to
3513
3285
            be supplied as the master to pull hooks.
3514
3286
        :param run_hooks: Private parameter - if false, this branch
3515
3287
            is being called because it's the master of the primary branch,
3516
3288
            so it should not run its hooks.
3517
 
            is being called because it's the master of the primary branch,
3518
 
            so it should not run its hooks.
3519
3289
        :param _override_hook_target: Private parameter - set the branch to be
3520
3290
            supplied as the target_branch to pull hooks.
3521
3291
        :param local: Only update the local branch, and not the bound branch.
3540
3310
            # -- JRV20090506
3541
3311
            result.old_revno, result.old_revid = \
3542
3312
                self.target.last_revision_info()
3543
 
            self._update_revisions(stop_revision, overwrite=overwrite,
3544
 
                graph=graph)
 
3313
            self.target.update_revisions(self.source, stop_revision,
 
3314
                overwrite=overwrite, graph=graph)
3545
3315
            # TODO: The old revid should be specified when merging tags, 
3546
3316
            # so a tags implementation that versions tags can only 
3547
3317
            # pull in the most recent changes. -- JRV20090506
3548
 
            result.tag_updates, result.tag_conflicts = (
3549
 
                self.source.tags.merge_to(self.target.tags, overwrite,
3550
 
                    ignore_master=not merge_tags_to_master))
 
3318
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3319
                overwrite)
3551
3320
            result.new_revno, result.new_revid = self.target.last_revision_info()
3552
3321
            if _hook_master:
3553
3322
                result.master_branch = _hook_master
3562
3331
            self.source.unlock()
3563
3332
        return result
3564
3333
 
 
3334
    def push(self, overwrite=False, stop_revision=None,
 
3335
             _override_hook_source_branch=None):
 
3336
        """See InterBranch.push.
 
3337
 
 
3338
        This is the basic concrete implementation of push()
 
3339
 
 
3340
        :param _override_hook_source_branch: If specified, run
 
3341
        the hooks passing this Branch as the source, rather than self.
 
3342
        This is for use of RemoteBranch, where push is delegated to the
 
3343
        underlying vfs-based Branch.
 
3344
        """
 
3345
        # TODO: Public option to disable running hooks - should be trivial but
 
3346
        # needs tests.
 
3347
        self.source.lock_read()
 
3348
        try:
 
3349
            return _run_with_write_locked_target(
 
3350
                self.target, self._push_with_bound_branches, overwrite,
 
3351
                stop_revision,
 
3352
                _override_hook_source_branch=_override_hook_source_branch)
 
3353
        finally:
 
3354
            self.source.unlock()
 
3355
 
 
3356
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3357
            _override_hook_source_branch=None):
 
3358
        """Push from source into target, and into target's master if any.
 
3359
        """
 
3360
        def _run_hooks():
 
3361
            if _override_hook_source_branch:
 
3362
                result.source_branch = _override_hook_source_branch
 
3363
            for hook in Branch.hooks['post_push']:
 
3364
                hook(result)
 
3365
 
 
3366
        bound_location = self.target.get_bound_location()
 
3367
        if bound_location and self.target.base != bound_location:
 
3368
            # there is a master branch.
 
3369
            #
 
3370
            # XXX: Why the second check?  Is it even supported for a branch to
 
3371
            # be bound to itself? -- mbp 20070507
 
3372
            master_branch = self.target.get_master_branch()
 
3373
            master_branch.lock_write()
 
3374
            try:
 
3375
                # push into the master from the source branch.
 
3376
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3377
                # and push into the target branch from the source. Note that we
 
3378
                # push from the source branch again, because its considered the
 
3379
                # highest bandwidth repository.
 
3380
                result = self.source._basic_push(self.target, overwrite,
 
3381
                    stop_revision)
 
3382
                result.master_branch = master_branch
 
3383
                result.local_branch = self.target
 
3384
                _run_hooks()
 
3385
                return result
 
3386
            finally:
 
3387
                master_branch.unlock()
 
3388
        else:
 
3389
            # no master branch
 
3390
            result = self.source._basic_push(self.target, overwrite,
 
3391
                stop_revision)
 
3392
            # TODO: Why set master_branch and local_branch if there's no
 
3393
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3394
            # 20070504
 
3395
            result.master_branch = self.target
 
3396
            result.local_branch = None
 
3397
            _run_hooks()
 
3398
            return result
 
3399
 
 
3400
    @classmethod
 
3401
    def is_compatible(self, source, target):
 
3402
        # GenericBranch uses the public API, so always compatible
 
3403
        return True
 
3404
 
 
3405
 
 
3406
class InterToBranch5(GenericInterBranch):
 
3407
 
 
3408
    @staticmethod
 
3409
    def _get_branch_formats_to_test():
 
3410
        return BranchFormat._default_format, BzrBranchFormat5()
 
3411
 
 
3412
    def pull(self, overwrite=False, stop_revision=None,
 
3413
             possible_transports=None, run_hooks=True,
 
3414
             _override_hook_target=None, local=False):
 
3415
        """Pull from source into self, updating my master if any.
 
3416
 
 
3417
        :param run_hooks: Private parameter - if false, this branch
 
3418
            is being called because it's the master of the primary branch,
 
3419
            so it should not run its hooks.
 
3420
        """
 
3421
        bound_location = self.target.get_bound_location()
 
3422
        if local and not bound_location:
 
3423
            raise errors.LocalRequiresBoundBranch()
 
3424
        master_branch = None
 
3425
        if not local and bound_location and self.source.user_url != bound_location:
 
3426
            # not pulling from master, so we need to update master.
 
3427
            master_branch = self.target.get_master_branch(possible_transports)
 
3428
            master_branch.lock_write()
 
3429
        try:
 
3430
            if master_branch:
 
3431
                # pull from source into master.
 
3432
                master_branch.pull(self.source, overwrite, stop_revision,
 
3433
                    run_hooks=False)
 
3434
            return super(InterToBranch5, self).pull(overwrite,
 
3435
                stop_revision, _hook_master=master_branch,
 
3436
                run_hooks=run_hooks,
 
3437
                _override_hook_target=_override_hook_target)
 
3438
        finally:
 
3439
            if master_branch:
 
3440
                master_branch.unlock()
 
3441
 
3565
3442
 
3566
3443
InterBranch.register_optimiser(GenericInterBranch)
 
3444
InterBranch.register_optimiser(InterToBranch5)