/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

(jam) Merge 2.4 into trunk, including bugs #825027 and #837293

Show diffs side-by-side

added added

removed removed

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