/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Martin von Gagern
  • Date: 2011-09-19 08:49:15 UTC
  • mto: This revision was merged to the branch mainline in revision 6148.
  • Revision ID: martin.vgagern@gmx.net-20110919084915-vbumflqq3xqm1vez
Avoid using deprecated api in the unit tests for bzrlib.missing.

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
607
641
        """
608
642
        raise errors.UpgradeRequired(self.user_url)
609
643
 
 
644
    def get_append_revisions_only(self):
 
645
        """Whether it is only possible to append revisions to the history.
 
646
        """
 
647
        if not self._format.supports_set_append_revisions_only():
 
648
            return False
 
649
        return self.get_config(
 
650
            ).get_user_option_as_bool('append_revisions_only')
 
651
 
610
652
    def set_append_revisions_only(self, enabled):
611
653
        if not self._format.supports_set_append_revisions_only():
612
654
            raise errors.UpgradeRequired(self.user_url)
626
668
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
669
 
628
670
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
671
    def fetch(self, from_branch, last_revision=None, limit=None):
630
672
        """Copy revisions from from_branch into this branch.
631
673
 
632
674
        :param from_branch: Where to copy from.
633
675
        :param last_revision: What revision to stop at (None for at the end
634
676
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
677
        :param limit: Optional rough limit of revisions to fetch
636
678
        :return: None
637
679
        """
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()
 
680
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
681
 
655
682
    def get_bound_location(self):
656
683
        """Return the URL of the branch we are bound to.
667
694
 
668
695
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
696
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
697
                           revision_id=None, lossy=False):
671
698
        """Obtain a CommitBuilder for this branch.
672
699
 
673
700
        :param parents: Revision ids of the parents of the new revision.
677
704
        :param committer: Optional committer to set for commit.
678
705
        :param revprops: Optional dictionary of revision properties.
679
706
        :param revision_id: Optional revision id.
 
707
        :param lossy: Whether to discard data that can not be natively
 
708
            represented, when pushing to a foreign VCS 
680
709
        """
681
710
 
682
711
        if config is None:
683
712
            config = self.get_config()
684
713
 
685
714
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
715
            timestamp, timezone, committer, revprops, revision_id,
 
716
            lossy)
687
717
 
688
718
    def get_master_branch(self, possible_transports=None):
689
719
        """Return the branch we are bound to.
716
746
        """Print `file` to stdout."""
717
747
        raise NotImplementedError(self.print_file)
718
748
 
 
749
    @deprecated_method(deprecated_in((2, 4, 0)))
719
750
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
751
        """See Branch.set_revision_history."""
 
752
        self._set_revision_history(rev_history)
 
753
 
 
754
    @needs_write_lock
 
755
    def _set_revision_history(self, rev_history):
 
756
        if len(rev_history) == 0:
 
757
            revid = _mod_revision.NULL_REVISION
 
758
        else:
 
759
            revid = rev_history[-1]
 
760
        if rev_history != self._lefthand_history(revid):
 
761
            raise errors.NotLefthandHistory(rev_history)
 
762
        self.set_last_revision_info(len(rev_history), revid)
 
763
        self._cache_revision_history(rev_history)
 
764
        for hook in Branch.hooks['set_rh']:
 
765
            hook(self, rev_history)
 
766
 
 
767
    @needs_write_lock
 
768
    def set_last_revision_info(self, revno, revision_id):
 
769
        """Set the last revision of this branch.
 
770
 
 
771
        The caller is responsible for checking that the revno is correct
 
772
        for this revision id.
 
773
 
 
774
        It may be possible to set the branch last revision to an id not
 
775
        present in the repository.  However, branches can also be
 
776
        configured to check constraints on history, in which case this may not
 
777
        be permitted.
 
778
        """
 
779
        raise NotImplementedError(self.set_last_revision_info)
 
780
 
 
781
    @needs_write_lock
 
782
    def generate_revision_history(self, revision_id, last_rev=None,
 
783
                                  other_branch=None):
 
784
        """See Branch.generate_revision_history"""
 
785
        graph = self.repository.get_graph()
 
786
        (last_revno, last_revid) = self.last_revision_info()
 
787
        known_revision_ids = [
 
788
            (last_revid, last_revno),
 
789
            (_mod_revision.NULL_REVISION, 0),
 
790
            ]
 
791
        if last_rev is not None:
 
792
            if not graph.is_ancestor(last_rev, revision_id):
 
793
                # our previous tip is not merged into stop_revision
 
794
                raise errors.DivergedBranches(self, other_branch)
 
795
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
796
        self.set_last_revision_info(revno, revision_id)
721
797
 
722
798
    @needs_write_lock
723
799
    def set_parent(self, url):
767
843
 
768
844
    def _unstack(self):
769
845
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
846
 
771
847
        Don't call this directly, use set_stacked_on_url(None).
772
848
        """
773
849
        pb = ui.ui_factory.nested_progress_bar()
782
858
            old_repository = self.repository
783
859
            if len(old_repository._fallback_repositories) != 1:
784
860
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
861
                    "of %r (fallbacks: %r)" % (old_repository,
 
862
                        old_repository._fallback_repositories))
 
863
            # Open the new repository object.
 
864
            # Repositories don't offer an interface to remove fallback
 
865
            # repositories today; take the conceptually simpler option and just
 
866
            # reopen it.  We reopen it starting from the URL so that we
 
867
            # get a separate connection for RemoteRepositories and can
 
868
            # stream from one of them to the other.  This does mean doing
 
869
            # separate SSH connection setup, but unstacking is not a
 
870
            # common operation so it's tolerable.
 
871
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
872
            new_repository = new_bzrdir.find_repository()
 
873
            if new_repository._fallback_repositories:
 
874
                raise AssertionError("didn't expect %r to have "
 
875
                    "fallback_repositories"
 
876
                    % (self.repository,))
 
877
            # Replace self.repository with the new repository.
 
878
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
879
            # lock count) of self.repository to the new repository.
 
880
            lock_token = old_repository.lock_write().repository_token
 
881
            self.repository = new_repository
 
882
            if isinstance(self, remote.RemoteBranch):
 
883
                # Remote branches can have a second reference to the old
 
884
                # repository that need to be replaced.
 
885
                if self._real_branch is not None:
 
886
                    self._real_branch.repository = new_repository
 
887
            self.repository.lock_write(token=lock_token)
 
888
            if lock_token is not None:
 
889
                old_repository.leave_lock_in_place()
787
890
            old_repository.unlock()
 
891
            if lock_token is not None:
 
892
                # XXX: self.repository.leave_lock_in_place() before this
 
893
                # function will not be preserved.  Fortunately that doesn't
 
894
                # affect the current default format (2a), and would be a
 
895
                # corner-case anyway.
 
896
                #  - Andrew Bennetts, 2010/06/30
 
897
                self.repository.dont_leave_lock_in_place()
 
898
            old_lock_count = 0
 
899
            while True:
 
900
                try:
 
901
                    old_repository.unlock()
 
902
                except errors.LockNotHeld:
 
903
                    break
 
904
                old_lock_count += 1
 
905
            if old_lock_count == 0:
 
906
                raise AssertionError(
 
907
                    'old_repository should have been locked at least once.')
 
908
            for i in range(old_lock_count-1):
 
909
                self.repository.lock_write()
 
910
            # Fetch from the old repository into the new.
788
911
            old_repository.lock_read()
789
912
            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
913
                # XXX: If you unstack a branch while it has a working tree
809
914
                # with a pending merge, the pending-merged revisions will no
810
915
                # 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)
 
916
                try:
 
917
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
918
                except errors.TagsNotSupported:
 
919
                    tags_to_fetch = set()
 
920
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
921
                    old_repository, required_ids=[self.last_revision()],
 
922
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
923
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
924
            finally:
819
925
                old_repository.unlock()
820
926
        finally:
825
931
 
826
932
        :seealso: Branch._get_tags_bytes.
827
933
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
934
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
935
        op.add_cleanup(self.lock_write().unlock)
 
936
        return op.run_simple(bytes)
 
937
 
 
938
    def _set_tags_bytes_locked(self, bytes):
 
939
        self._tags_bytes = bytes
 
940
        return self._transport.put_bytes('tags', bytes)
830
941
 
831
942
    def _cache_revision_history(self, rev_history):
832
943
        """Set the cached revision history to rev_history.
859
970
        self._revision_history_cache = None
860
971
        self._revision_id_to_revno_cache = None
861
972
        self._last_revision_info_cache = None
 
973
        self._master_branch_cache = None
862
974
        self._merge_sorted_revisions_cache = None
863
975
        self._partial_revision_history_cache = []
864
976
        self._partial_revision_id_to_revno_cache = {}
 
977
        self._tags_bytes = None
865
978
 
866
979
    def _gen_revision_history(self):
867
980
        """Return sequence of revision hashes on to this branch.
917
1030
        :return: A tuple (revno, revision_id).
918
1031
        """
919
1032
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1033
            self._last_revision_info_cache = self._read_last_revision_info()
921
1034
        return self._last_revision_info_cache
922
1035
 
923
 
    def _last_revision_info(self):
924
 
        rh = self.revision_history()
925
 
        revno = len(rh)
926
 
        if revno:
927
 
            return (revno, rh[-1])
928
 
        else:
929
 
            return (0, _mod_revision.NULL_REVISION)
930
 
 
931
 
    @deprecated_method(deprecated_in((1, 6, 0)))
932
 
    def missing_revisions(self, other, stop_revision=None):
933
 
        """Return a list of new revisions that would perfectly fit.
934
 
 
935
 
        If self and other have not diverged, return a list of the revisions
936
 
        present in other, but missing from self.
937
 
        """
938
 
        self_history = self.revision_history()
939
 
        self_len = len(self_history)
940
 
        other_history = other.revision_history()
941
 
        other_len = len(other_history)
942
 
        common_index = min(self_len, other_len) -1
943
 
        if common_index >= 0 and \
944
 
            self_history[common_index] != other_history[common_index]:
945
 
            raise errors.DivergedBranches(self, other)
946
 
 
947
 
        if stop_revision is None:
948
 
            stop_revision = other_len
949
 
        else:
950
 
            if stop_revision > other_len:
951
 
                raise errors.NoSuchRevision(self, stop_revision)
952
 
        return other_history[self_len:stop_revision]
953
 
 
954
 
    @needs_write_lock
955
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
956
 
                         graph=None):
957
 
        """Pull in new perfect-fit revisions.
958
 
 
959
 
        :param other: Another Branch to pull from
960
 
        :param stop_revision: Updated until the given revision
961
 
        :param overwrite: Always set the branch pointer, rather than checking
962
 
            to see if it is a proper descendant.
963
 
        :param graph: A Graph object that can be used to query history
964
 
            information. This can be None.
965
 
        :return: None
966
 
        """
967
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
968
 
            overwrite, graph)
969
 
 
 
1036
    def _read_last_revision_info(self):
 
1037
        raise NotImplementedError(self._read_last_revision_info)
 
1038
 
 
1039
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1040
    def import_last_revision_info(self, source_repo, revno, revid):
971
1041
        """Set the last revision info, importing from another repo if necessary.
972
1042
 
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
1043
        :param source_repo: Source repository to optionally fetch from
977
1044
        :param revno: Revision number of the new tip
978
1045
        :param revid: Revision id of the new tip
981
1048
            self.repository.fetch(source_repo, revision_id=revid)
982
1049
        self.set_last_revision_info(revno, revid)
983
1050
 
 
1051
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1052
                                           lossy=False):
 
1053
        """Set the last revision info, importing from another repo if necessary.
 
1054
 
 
1055
        This is used by the bound branch code to upload a revision to
 
1056
        the master branch first before updating the tip of the local branch.
 
1057
        Revisions referenced by source's tags are also transferred.
 
1058
 
 
1059
        :param source: Source branch to optionally fetch from
 
1060
        :param revno: Revision number of the new tip
 
1061
        :param revid: Revision id of the new tip
 
1062
        :param lossy: Whether to discard metadata that can not be
 
1063
            natively represented
 
1064
        :return: Tuple with the new revision number and revision id
 
1065
            (should only be different from the arguments when lossy=True)
 
1066
        """
 
1067
        if not self.repository.has_same_location(source.repository):
 
1068
            self.fetch(source, revid)
 
1069
        self.set_last_revision_info(revno, revid)
 
1070
        return (revno, revid)
 
1071
 
984
1072
    def revision_id_to_revno(self, revision_id):
985
1073
        """Given a revision id, return its revno"""
986
1074
        if _mod_revision.is_null(revision_id):
1006
1094
            self._extend_partial_history(distance_from_last)
1007
1095
        return self._partial_revision_history_cache[distance_from_last]
1008
1096
 
1009
 
    @needs_write_lock
1010
1097
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1098
             possible_transports=None, *args, **kwargs):
1012
1099
        """Mirror source into this branch.
1019
1106
            stop_revision=stop_revision,
1020
1107
            possible_transports=possible_transports, *args, **kwargs)
1021
1108
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1109
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1110
            *args, **kwargs):
1024
1111
        """Mirror this branch into target.
1025
1112
 
1026
1113
        This branch is considered to be 'local', having low latency.
1027
1114
        """
1028
1115
        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)
 
1116
            lossy, *args, **kwargs)
1051
1117
 
1052
1118
    def basis_tree(self):
1053
1119
        """Return `Tree` object for last revision."""
1208
1274
        return result
1209
1275
 
1210
1276
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1277
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1278
            repository=None):
1212
1279
        """Create a new line of development from the branch, into to_bzrdir.
1213
1280
 
1214
1281
        to_bzrdir controls the branch format.
1219
1286
        if (repository_policy is not None and
1220
1287
            repository_policy.requires_stacking()):
1221
1288
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1289
        result = to_bzrdir.create_branch(repository=repository)
1223
1290
        result.lock_write()
1224
1291
        try:
1225
1292
            if repository_policy is not None:
1226
1293
                repository_policy.configure_branch(result)
1227
1294
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1295
            master_url = self.get_bound_location()
 
1296
            if master_url is None:
 
1297
                result.set_parent(self.bzrdir.root_transport.base)
 
1298
            else:
 
1299
                result.set_parent(master_url)
1229
1300
        finally:
1230
1301
            result.unlock()
1231
1302
        return result
1255
1326
                revno = 1
1256
1327
        destination.set_last_revision_info(revno, revision_id)
1257
1328
 
1258
 
    @needs_read_lock
1259
1329
    def copy_content_into(self, destination, revision_id=None):
1260
1330
        """Copy the content of self into destination.
1261
1331
 
1262
1332
        revision_id: if not None, the revision history in the new branch will
1263
1333
                     be truncated to end with revision_id.
1264
1334
        """
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)
 
1335
        return InterBranch.get(self, destination).copy_content_into(
 
1336
            revision_id=revision_id)
1276
1337
 
1277
1338
    def update_references(self, target):
1278
1339
        if not getattr(self._format, 'supports_reference_locations', False):
1319
1380
        # specific check.
1320
1381
        return result
1321
1382
 
1322
 
    def _get_checkout_format(self):
 
1383
    def _get_checkout_format(self, lightweight=False):
1323
1384
        """Return the most suitable metadir for a checkout of this branch.
1324
1385
        Weaves are used if this branch's repository uses weaves.
1325
1386
        """
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)
 
1387
        format = self.repository.bzrdir.checkout_metadir()
 
1388
        format.set_branch_format(self._format)
1333
1389
        return format
1334
1390
 
1335
1391
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1392
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1393
        no_tree=None):
1337
1394
        """Create a clone of this branch and its bzrdir.
1338
1395
 
1339
1396
        :param to_transport: The transport to clone onto.
1346
1403
        """
1347
1404
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1405
        # clone call. Or something. 20090224 RBC/spiv.
 
1406
        # XXX: Should this perhaps clone colocated branches as well, 
 
1407
        # rather than just the default branch? 20100319 JRV
1349
1408
        if revision_id is None:
1350
1409
            revision_id = self.last_revision()
1351
1410
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1411
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1412
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1413
            no_tree=no_tree)
1354
1414
        return dir_to.open_branch()
1355
1415
 
1356
1416
    def create_checkout(self, to_location, revision_id=None,
1361
1421
        :param to_location: The url to produce the checkout at
1362
1422
        :param revision_id: The revision to check out
1363
1423
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1424
            produce a bound branch (heavyweight checkout)
1365
1425
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1426
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1427
            The revision tree will be used for cases where accelerator_tree's
1372
1432
        """
1373
1433
        t = transport.get_transport(to_location)
1374
1434
        t.ensure_base()
 
1435
        format = self._get_checkout_format(lightweight=lightweight)
1375
1436
        if lightweight:
1376
 
            format = self._get_checkout_format()
1377
1437
            checkout = format.initialize_on_transport(t)
1378
1438
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
1439
                target_branch=self)
1380
1440
        else:
1381
 
            format = self._get_checkout_format()
1382
1441
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1383
1442
                to_location, force_new_tree=False, format=format)
1384
1443
            checkout = checkout_branch.bzrdir
1413
1472
 
1414
1473
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1474
        """Return the parent branch for a tree-reference file_id
 
1475
 
1416
1476
        :param file_id: The file_id of the tree reference
1417
1477
        :param path: The path of the file_id in the tree
1418
1478
        :return: A branch associated with the file_id
1471
1531
        else:
1472
1532
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1533
 
1474
 
 
1475
 
class BranchFormat(object):
 
1534
    def heads_to_fetch(self):
 
1535
        """Return the heads that must and that should be fetched to copy this
 
1536
        branch into another repo.
 
1537
 
 
1538
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1539
            set of heads that must be fetched.  if_present_fetch is a set of
 
1540
            heads that must be fetched if present, but no error is necessary if
 
1541
            they are not present.
 
1542
        """
 
1543
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1544
        # are the tags.
 
1545
        must_fetch = set([self.last_revision()])
 
1546
        if_present_fetch = set()
 
1547
        c = self.get_config()
 
1548
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1549
                                                 default=False)
 
1550
        if include_tags:
 
1551
            try:
 
1552
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1553
            except errors.TagsNotSupported:
 
1554
                pass
 
1555
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1556
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1557
        return must_fetch, if_present_fetch
 
1558
 
 
1559
 
 
1560
class BranchFormat(controldir.ControlComponentFormat):
1476
1561
    """An encapsulation of the initialization and open routines for a format.
1477
1562
 
1478
1563
    Formats provide three things:
1481
1566
     * an open routine.
1482
1567
 
1483
1568
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1569
    during branch opening. It's not required that these be instances, they
1485
1570
    can be classes themselves with class methods - it simply depends on
1486
1571
    whether state is needed for a given format or not.
1487
1572
 
1490
1575
    object will be created every time regardless.
1491
1576
    """
1492
1577
 
1493
 
    _default_format = None
1494
 
    """The default format used for new branches."""
1495
 
 
1496
 
    _formats = {}
1497
 
    """The known formats."""
1498
 
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1578
    def __eq__(self, other):
1502
1579
        return self.__class__ is other.__class__
1503
1580
 
1510
1587
        try:
1511
1588
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1589
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1590
            return format_registry.get(format_string)
1514
1591
        except errors.NoSuchFile:
1515
1592
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1593
        except KeyError:
1517
1594
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1595
 
1519
1596
    @classmethod
 
1597
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1598
    def get_default_format(klass):
1521
1599
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1600
        return format_registry.get_default()
 
1601
 
 
1602
    @classmethod
 
1603
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1604
    def get_formats(klass):
 
1605
        """Get all the known formats.
 
1606
 
 
1607
        Warning: This triggers a load of all lazy registered formats: do not
 
1608
        use except when that is desireed.
 
1609
        """
 
1610
        return format_registry._get_all()
 
1611
 
 
1612
    def get_reference(self, a_bzrdir, name=None):
1525
1613
        """Get the target reference of the branch in a_bzrdir.
1526
1614
 
1527
1615
        format probing must have been completed before calling
1529
1617
        in a_bzrdir is correct.
1530
1618
 
1531
1619
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1620
        :param name: Name of the colocated branch to fetch
1532
1621
        :return: None if the branch is not a reference branch.
1533
1622
        """
1534
1623
        return None
1535
1624
 
1536
1625
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1626
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1627
        """Set the target reference of the branch in a_bzrdir.
1539
1628
 
1540
1629
        format probing must have been completed before calling
1542
1631
        in a_bzrdir is correct.
1543
1632
 
1544
1633
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1634
        :param name: Name of colocated branch to set, None for default
1545
1635
        :param to_branch: branch that the checkout is to reference
1546
1636
        """
1547
1637
        raise NotImplementedError(self.set_reference)
1562
1652
        for hook in hooks:
1563
1653
            hook(params)
1564
1654
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
1567
 
        """Initialize a branch in a bzrdir, with specified files
1568
 
 
1569
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
 
        :param utf8_files: The files to create as a list of
1571
 
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
 
        :param set_format: If True, set the format with
1574
 
            self.get_format_string.  (BzrBranch4 has its format set
1575
 
            elsewhere)
1576
 
        :return: a branch in this format
1577
 
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1580
 
        lock_map = {
1581
 
            'metadir': ('lock', lockdir.LockDir),
1582
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1583
 
        }
1584
 
        lock_name, lock_class = lock_map[lock_type]
1585
 
        control_files = lockable_files.LockableFiles(branch_transport,
1586
 
            lock_name, lock_class)
1587
 
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
1596
 
        if set_format:
1597
 
            utf8_files += [('format', self.get_format_string())]
1598
 
        try:
1599
 
            for (filename, content) in utf8_files:
1600
 
                branch_transport.put_bytes(
1601
 
                    filename, content,
1602
 
                    mode=a_bzrdir._get_file_mode())
1603
 
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
1609
 
 
1610
 
    def initialize(self, a_bzrdir, name=None):
 
1655
    def initialize(self, a_bzrdir, name=None, repository=None,
 
1656
                   append_revisions_only=None):
1611
1657
        """Create a branch of this format in a_bzrdir.
1612
1658
        
1613
1659
        :param name: Name of the colocated branch to create.
1635
1681
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
1682
        on a RemoteBranch.
1637
1683
        """
1638
 
        return DisabledTags(branch)
 
1684
        return _mod_tag.DisabledTags(branch)
1639
1685
 
1640
1686
    def network_name(self):
1641
1687
        """A simple byte string uniquely identifying this format for RPC calls.
1647
1693
        """
1648
1694
        raise NotImplementedError(self.network_name)
1649
1695
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1696
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1697
            found_repository=None):
1651
1698
        """Return the branch object for a_bzrdir
1652
1699
 
1653
1700
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1707
        raise NotImplementedError(self.open)
1661
1708
 
1662
1709
    @classmethod
 
1710
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1711
    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__)
 
1712
        """Register a metadir format.
 
1713
 
 
1714
        See MetaDirBranchFormatFactory for the ability to register a format
 
1715
        without loading the code the format needs until it is actually used.
 
1716
        """
 
1717
        format_registry.register(format)
1669
1718
 
1670
1719
    @classmethod
 
1720
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1721
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1722
        format_registry.set_default(format)
1673
1723
 
1674
1724
    def supports_set_append_revisions_only(self):
1675
1725
        """True if this format supports set_append_revisions_only."""
1679
1729
        """True if this format records a stacked-on branch."""
1680
1730
        return False
1681
1731
 
 
1732
    def supports_leaving_lock(self):
 
1733
        """True if this format supports leaving locks in place."""
 
1734
        return False # by default
 
1735
 
1682
1736
    @classmethod
 
1737
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1738
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1739
        format_registry.remove(format)
1685
1740
 
1686
1741
    def __str__(self):
1687
1742
        return self.get_format_description().rstrip()
1690
1745
        """True if this format supports tags stored in the branch"""
1691
1746
        return False  # by default
1692
1747
 
 
1748
    def tags_are_versioned(self):
 
1749
        """Whether the tag container for this branch versions tags."""
 
1750
        return False
 
1751
 
 
1752
    def supports_tags_referencing_ghosts(self):
 
1753
        """True if tags can reference ghost revisions."""
 
1754
        return True
 
1755
 
 
1756
 
 
1757
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1758
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1759
    
 
1760
    While none of the built in BranchFormats are lazy registered yet,
 
1761
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1762
    use it, and the bzr-loom plugin uses it as well (see
 
1763
    bzrlib.plugins.loom.formats).
 
1764
    """
 
1765
 
 
1766
    def __init__(self, format_string, module_name, member_name):
 
1767
        """Create a MetaDirBranchFormatFactory.
 
1768
 
 
1769
        :param format_string: The format string the format has.
 
1770
        :param module_name: Module to load the format class from.
 
1771
        :param member_name: Attribute name within the module for the format class.
 
1772
        """
 
1773
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1774
        self._format_string = format_string
 
1775
        
 
1776
    def get_format_string(self):
 
1777
        """See BranchFormat.get_format_string."""
 
1778
        return self._format_string
 
1779
 
 
1780
    def __call__(self):
 
1781
        """Used for network_format_registry support."""
 
1782
        return self.get_obj()()
 
1783
 
1693
1784
 
1694
1785
class BranchHooks(Hooks):
1695
1786
    """A dictionary mapping hook name to a list of callables for branch hooks.
1704
1795
        These are all empty initially, because by default nothing should get
1705
1796
        notified.
1706
1797
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1798
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1799
        self.add_hook('set_rh',
1709
1800
            "Invoked whenever the revision history has been set via "
1710
1801
            "set_revision_history. The api signature is (branch, "
1711
1802
            "revision_history), and the branch will be write-locked. "
1712
1803
            "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',
 
1804
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1805
        self.add_hook('open',
1715
1806
            "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',
 
1807
            "branch is opened.", (1, 8))
 
1808
        self.add_hook('post_push',
1718
1809
            "Called after a push operation completes. post_push is called "
1719
1810
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1811
            "bzr client.", (0, 15))
 
1812
        self.add_hook('post_pull',
1722
1813
            "Called after a pull operation completes. post_pull is called "
1723
1814
            "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 "
 
1815
            "bzr client.", (0, 15))
 
1816
        self.add_hook('pre_commit',
 
1817
            "Called after a commit is calculated but before it is "
1727
1818
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1819
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1820
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1822
            "basis revision. hooks MUST NOT modify this delta. "
1732
1823
            " future_tree is an in-memory tree obtained from "
1733
1824
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1825
            "tree.", (0,91))
 
1826
        self.add_hook('post_commit',
1736
1827
            "Called in the bzr client after a commit has completed. "
1737
1828
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1829
            "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',
 
1830
            "commit to a branch.", (0, 15))
 
1831
        self.add_hook('post_uncommit',
1741
1832
            "Called in the bzr client after an uncommit completes. "
1742
1833
            "post_uncommit is called with (local, master, old_revno, "
1743
1834
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1835
            "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',
 
1836
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1837
        self.add_hook('pre_change_branch_tip',
1747
1838
            "Called in bzr client and server before a change to the tip of a "
1748
1839
            "branch is made. pre_change_branch_tip is called with a "
1749
1840
            "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',
 
1841
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1842
        self.add_hook('post_change_branch_tip',
1752
1843
            "Called in bzr client and server after a change to the tip of a "
1753
1844
            "branch is made. post_change_branch_tip is called with a "
1754
1845
            "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',
 
1846
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1847
        self.add_hook('transform_fallback_location',
1757
1848
            "Called when a stacked branch is activating its fallback "
1758
1849
            "locations. transform_fallback_location is called with (branch, "
1759
1850
            "url), and should return a new url. Returning the same url "
1764
1855
            "fallback locations have not been activated. When there are "
1765
1856
            "multiple hooks installed for transform_fallback_location, "
1766
1857
            "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."
 
1858
            "The order is however undefined.", (1, 9))
 
1859
        self.add_hook('automatic_tag_name',
 
1860
            "Called to determine an automatic tag name for a revision. "
1770
1861
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1862
            "should return a tag name or None if no tag name could be "
1772
1863
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1864
            (2, 2))
 
1865
        self.add_hook('post_branch_init',
1775
1866
            "Called after new branch initialization completes. "
1776
1867
            "post_branch_init is called with a "
1777
1868
            "bzrlib.branch.BranchInitHookParams. "
1778
1869
            "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',
 
1870
            "lightweight) will all trigger this hook.", (2, 2))
 
1871
        self.add_hook('post_switch',
1781
1872
            "Called after a checkout switches branch. "
1782
1873
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1874
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1875
 
1785
1876
 
1786
1877
 
1789
1880
 
1790
1881
 
1791
1882
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1883
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1884
 
1794
1885
    There are 5 fields that hooks may wish to access:
1795
1886
 
1827
1918
 
1828
1919
 
1829
1920
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1921
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1922
 
1832
1923
    There are 4 fields that hooks may wish to access:
1833
1924
 
1863
1954
        return self.__dict__ == other.__dict__
1864
1955
 
1865
1956
    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)
 
1957
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1958
 
1873
1959
 
1874
1960
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1961
    """Object holding parameters passed to `*_switch` hooks.
1876
1962
 
1877
1963
    There are 4 fields that hooks may wish to access:
1878
1964
 
1904
1990
            self.revision_id)
1905
1991
 
1906
1992
 
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
1993
class BranchFormatMetadir(BranchFormat):
1951
1994
    """Common logic for meta-dir based branch formats."""
1952
1995
 
1954
1997
        """What class to instantiate on open calls."""
1955
1998
        raise NotImplementedError(self._branch_class)
1956
1999
 
 
2000
    def _get_initial_config(self, append_revisions_only=None):
 
2001
        if append_revisions_only:
 
2002
            return "append_revisions_only = True\n"
 
2003
        else:
 
2004
            # Avoid writing anything if append_revisions_only is disabled,
 
2005
            # as that is the default.
 
2006
            return ""
 
2007
 
 
2008
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2009
                           repository=None):
 
2010
        """Initialize a branch in a bzrdir, with specified files
 
2011
 
 
2012
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2013
        :param utf8_files: The files to create as a list of
 
2014
            (filename, content) tuples
 
2015
        :param name: Name of colocated branch to create, if any
 
2016
        :return: a branch in this format
 
2017
        """
 
2018
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2019
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2020
        control_files = lockable_files.LockableFiles(branch_transport,
 
2021
            'lock', lockdir.LockDir)
 
2022
        control_files.create_lock()
 
2023
        control_files.lock_write()
 
2024
        try:
 
2025
            utf8_files += [('format', self.get_format_string())]
 
2026
            for (filename, content) in utf8_files:
 
2027
                branch_transport.put_bytes(
 
2028
                    filename, content,
 
2029
                    mode=a_bzrdir._get_file_mode())
 
2030
        finally:
 
2031
            control_files.unlock()
 
2032
        branch = self.open(a_bzrdir, name, _found=True,
 
2033
                found_repository=repository)
 
2034
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2035
        return branch
 
2036
 
1957
2037
    def network_name(self):
1958
2038
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2039
 
1961
2041
        """
1962
2042
        return self.get_format_string()
1963
2043
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2044
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2045
            found_repository=None):
1965
2046
        """See BranchFormat.open()."""
1966
2047
        if not _found:
1967
2048
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2053
        try:
1973
2054
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2055
                                                         lockdir.LockDir)
 
2056
            if found_repository is None:
 
2057
                found_repository = a_bzrdir.find_repository()
1975
2058
            return self._branch_class()(_format=self,
1976
2059
                              _control_files=control_files,
1977
2060
                              name=name,
1978
2061
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2062
                              _repository=found_repository,
1980
2063
                              ignore_fallbacks=ignore_fallbacks)
1981
2064
        except errors.NoSuchFile:
1982
2065
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2072
    def supports_tags(self):
1990
2073
        return True
1991
2074
 
 
2075
    def supports_leaving_lock(self):
 
2076
        return True
 
2077
 
1992
2078
 
1993
2079
class BzrBranchFormat5(BranchFormatMetadir):
1994
2080
    """Bzr branch format 5.
2014
2100
        """See BranchFormat.get_format_description()."""
2015
2101
        return "Branch format 5"
2016
2102
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2103
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2104
                   append_revisions_only=None):
2018
2105
        """Create a branch of this format in a_bzrdir."""
 
2106
        if append_revisions_only:
 
2107
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2019
2108
        utf8_files = [('revision-history', ''),
2020
2109
                      ('branch-name', ''),
2021
2110
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2111
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2112
 
2024
2113
    def supports_tags(self):
2025
2114
        return False
2047
2136
        """See BranchFormat.get_format_description()."""
2048
2137
        return "Branch format 6"
2049
2138
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2139
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2140
                   append_revisions_only=None):
2051
2141
        """Create a branch of this format in a_bzrdir."""
2052
2142
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
 
2143
                      ('branch.conf',
 
2144
                          self._get_initial_config(append_revisions_only)),
2054
2145
                      ('tags', ''),
2055
2146
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2147
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2148
 
2058
2149
    def make_tags(self, branch):
2059
2150
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
 
2151
        return _mod_tag.BasicTags(branch)
2061
2152
 
2062
2153
    def supports_set_append_revisions_only(self):
2063
2154
        return True
2077
2168
        """See BranchFormat.get_format_description()."""
2078
2169
        return "Branch format 8"
2079
2170
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2171
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2172
                   append_revisions_only=None):
2081
2173
        """Create a branch of this format in a_bzrdir."""
2082
2174
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
 
2175
                      ('branch.conf',
 
2176
                          self._get_initial_config(append_revisions_only)),
2084
2177
                      ('tags', ''),
2085
2178
                      ('references', '')
2086
2179
                      ]
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()
 
2180
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2181
 
2094
2182
    def make_tags(self, branch):
2095
2183
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
 
2184
        return _mod_tag.BasicTags(branch)
2097
2185
 
2098
2186
    def supports_set_append_revisions_only(self):
2099
2187
        return True
2104
2192
    supports_reference_locations = True
2105
2193
 
2106
2194
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2195
class BzrBranchFormat7(BranchFormatMetadir):
2108
2196
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2197
 
2110
2198
    The stacked location pointer is passed down to the repository and requires
2113
2201
    This format was introduced in bzr 1.6.
2114
2202
    """
2115
2203
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2204
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2205
                   append_revisions_only=None):
2117
2206
        """Create a branch of this format in a_bzrdir."""
2118
2207
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
 
2208
                      ('branch.conf',
 
2209
                          self._get_initial_config(append_revisions_only)),
2120
2210
                      ('tags', ''),
2121
2211
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2212
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2213
 
2124
2214
    def _branch_class(self):
2125
2215
        return BzrBranch7
2135
2225
    def supports_set_append_revisions_only(self):
2136
2226
        return True
2137
2227
 
 
2228
    def supports_stacking(self):
 
2229
        return True
 
2230
 
 
2231
    def make_tags(self, branch):
 
2232
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2233
        return _mod_tag.BasicTags(branch)
 
2234
 
2138
2235
    supports_reference_locations = False
2139
2236
 
2140
2237
 
2157
2254
        """See BranchFormat.get_format_description()."""
2158
2255
        return "Checkout reference format 1"
2159
2256
 
2160
 
    def get_reference(self, a_bzrdir):
 
2257
    def get_reference(self, a_bzrdir, name=None):
2161
2258
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2259
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2260
        return transport.get_bytes('location')
2164
2261
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2262
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2263
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2264
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2265
        location = transport.put_bytes('location', to_branch.base)
2169
2266
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2267
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2268
            repository=None, append_revisions_only=None):
2171
2269
        """Create a branch of this format in a_bzrdir."""
2172
2270
        if target_branch is None:
2173
2271
            # this format does not implement branch itself, thus the implicit
2174
2272
            # creation contract must see it as uninitializable
2175
2273
            raise errors.UninitializableFormat(self)
2176
2274
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2275
        if a_bzrdir._format.fixed_components:
 
2276
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2177
2277
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2278
        branch_transport.put_bytes('location',
2179
2279
            target_branch.bzrdir.user_url)
2201
2301
        return clone
2202
2302
 
2203
2303
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2304
             possible_transports=None, ignore_fallbacks=False,
 
2305
             found_repository=None):
2205
2306
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2307
 
2207
2308
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2322
                raise AssertionError("wrong format %r found for %r" %
2222
2323
                    (format, self))
2223
2324
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2325
            location = self.get_reference(a_bzrdir, name)
2225
2326
        real_bzrdir = bzrdir.BzrDir.open(
2226
2327
            location, possible_transports=possible_transports)
2227
2328
        result = real_bzrdir.open_branch(name=name, 
2238
2339
        return result
2239
2340
 
2240
2341
 
 
2342
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2343
    """Branch format registry."""
 
2344
 
 
2345
    def __init__(self, other_registry=None):
 
2346
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2347
        self._default_format = None
 
2348
 
 
2349
    def set_default(self, format):
 
2350
        self._default_format = format
 
2351
 
 
2352
    def get_default(self):
 
2353
        return self._default_format
 
2354
 
 
2355
 
2241
2356
network_format_registry = registry.FormatRegistry()
2242
2357
"""Registry of formats indexed by their network name.
2243
2358
 
2246
2361
BranchFormat.network_name() for more detail.
2247
2362
"""
2248
2363
 
 
2364
format_registry = BranchFormatRegistry(network_format_registry)
 
2365
 
2249
2366
 
2250
2367
# formats which have no format string are not discoverable
2251
2368
# and not independently creatable, so are not registered.
2253
2370
__format6 = BzrBranchFormat6()
2254
2371
__format7 = BzrBranchFormat7()
2255
2372
__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__)
 
2373
format_registry.register(__format5)
 
2374
format_registry.register(BranchReferenceFormat())
 
2375
format_registry.register(__format6)
 
2376
format_registry.register(__format7)
 
2377
format_registry.register(__format8)
 
2378
format_registry.set_default(__format7)
 
2379
 
 
2380
 
 
2381
class BranchWriteLockResult(LogicalLockResult):
 
2382
    """The result of write locking a branch.
 
2383
 
 
2384
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2385
        None.
 
2386
    :ivar unlock: A callable which will unlock the lock.
 
2387
    """
 
2388
 
 
2389
    def __init__(self, unlock, branch_token):
 
2390
        LogicalLockResult.__init__(self, unlock)
 
2391
        self.branch_token = branch_token
 
2392
 
 
2393
    def __repr__(self):
 
2394
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2395
            self.unlock)
2266
2396
 
2267
2397
 
2268
2398
class BzrBranch(Branch, _RelockDebugMixin):
2318
2448
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
2449
 
2320
2450
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
 
2451
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2322
2452
 
2323
2453
    def is_locked(self):
2324
2454
        return self.control_files.is_locked()
2325
2455
 
2326
2456
    def lock_write(self, token=None):
 
2457
        """Lock the branch for write operations.
 
2458
 
 
2459
        :param token: A token to permit reacquiring a previously held and
 
2460
            preserved lock.
 
2461
        :return: A BranchWriteLockResult.
 
2462
        """
2327
2463
        if not self.is_locked():
2328
2464
            self._note_lock('w')
2329
2465
        # All-in-one needs to always unlock/lock.
2335
2471
        else:
2336
2472
            took_lock = False
2337
2473
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2474
            return BranchWriteLockResult(self.unlock,
 
2475
                self.control_files.lock_write(token=token))
2339
2476
        except:
2340
2477
            if took_lock:
2341
2478
                self.repository.unlock()
2342
2479
            raise
2343
2480
 
2344
2481
    def lock_read(self):
 
2482
        """Lock the branch for read operations.
 
2483
 
 
2484
        :return: A bzrlib.lock.LogicalLockResult.
 
2485
        """
2345
2486
        if not self.is_locked():
2346
2487
            self._note_lock('r')
2347
2488
        # All-in-one needs to always unlock/lock.
2354
2495
            took_lock = False
2355
2496
        try:
2356
2497
            self.control_files.lock_read()
 
2498
            return LogicalLockResult(self.unlock)
2357
2499
        except:
2358
2500
            if took_lock:
2359
2501
                self.repository.unlock()
2387
2529
        """See Branch.print_file."""
2388
2530
        return self.repository.print_file(file, revision_id)
2389
2531
 
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
2532
    @needs_write_lock
2454
2533
    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
 
        """
 
2534
        if not revision_id or not isinstance(revision_id, basestring):
 
2535
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2536
        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))
 
2537
        old_revno, old_revid = self.last_revision_info()
 
2538
        if self.get_append_revisions_only():
 
2539
            self._check_history_violation(revision_id)
 
2540
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2541
        self._write_last_revision_info(revno, revision_id)
 
2542
        self._clear_cached_state()
 
2543
        self._last_revision_info_cache = revno, revision_id
 
2544
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2545
 
2495
2546
    def basis_tree(self):
2496
2547
        """See Branch.basis_tree."""
2505
2556
                pass
2506
2557
        return None
2507
2558
 
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
2559
    def get_stacked_on_url(self):
2531
2560
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2561
 
2543
2572
            self._transport.put_bytes('parent', url + '\n',
2544
2573
                mode=self.bzrdir._get_file_mode())
2545
2574
 
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
2575
    @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
 
2576
    def unbind(self):
 
2577
        """If bound, unbind"""
 
2578
        return self.set_bound_location(None)
2595
2579
 
2596
2580
    @needs_write_lock
2597
2581
    def bind(self, other):
2619
2603
        # history around
2620
2604
        self.set_bound_location(other.base)
2621
2605
 
 
2606
    def get_bound_location(self):
 
2607
        try:
 
2608
            return self._transport.get_bytes('bound')[:-1]
 
2609
        except errors.NoSuchFile:
 
2610
            return None
 
2611
 
 
2612
    @needs_read_lock
 
2613
    def get_master_branch(self, possible_transports=None):
 
2614
        """Return the branch we are bound to.
 
2615
 
 
2616
        :return: Either a Branch, or None
 
2617
        """
 
2618
        if self._master_branch_cache is None:
 
2619
            self._master_branch_cache = self._get_master_branch(
 
2620
                possible_transports)
 
2621
        return self._master_branch_cache
 
2622
 
 
2623
    def _get_master_branch(self, possible_transports):
 
2624
        bound_loc = self.get_bound_location()
 
2625
        if not bound_loc:
 
2626
            return None
 
2627
        try:
 
2628
            return Branch.open(bound_loc,
 
2629
                               possible_transports=possible_transports)
 
2630
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2631
            raise errors.BoundBranchConnectionFailure(
 
2632
                    self, bound_loc, e)
 
2633
 
2622
2634
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2635
    def set_bound_location(self, location):
 
2636
        """Set the target where this branch is bound to.
 
2637
 
 
2638
        :param location: URL to the target branch
 
2639
        """
 
2640
        self._master_branch_cache = None
 
2641
        if location:
 
2642
            self._transport.put_bytes('bound', location+'\n',
 
2643
                mode=self.bzrdir._get_file_mode())
 
2644
        else:
 
2645
            try:
 
2646
                self._transport.delete('bound')
 
2647
            except errors.NoSuchFile:
 
2648
                return False
 
2649
            return True
2626
2650
 
2627
2651
    @needs_write_lock
2628
2652
    def update(self, possible_transports=None):
2641
2665
            return old_tip
2642
2666
        return None
2643
2667
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2668
    def _read_last_revision_info(self):
 
2669
        revision_string = self._transport.get_bytes('last-revision')
 
2670
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2671
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2672
        revno = int(revno)
 
2673
        return revno, revision_id
 
2674
 
 
2675
    def _write_last_revision_info(self, revno, revision_id):
 
2676
        """Simply write out the revision id, with no checks.
 
2677
 
 
2678
        Use set_last_revision_info to perform this safely.
 
2679
 
 
2680
        Does not update the revision_history cache.
 
2681
        """
 
2682
        revision_id = _mod_revision.ensure_null(revision_id)
 
2683
        out_string = '%d %s\n' % (revno, revision_id)
 
2684
        self._transport.put_bytes('last-revision', out_string,
 
2685
            mode=self.bzrdir._get_file_mode())
 
2686
 
 
2687
 
 
2688
class FullHistoryBzrBranch(BzrBranch):
 
2689
    """Bzr branch which contains the full revision history."""
 
2690
 
 
2691
    @needs_write_lock
 
2692
    def set_last_revision_info(self, revno, revision_id):
 
2693
        if not revision_id or not isinstance(revision_id, basestring):
 
2694
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2695
        revision_id = _mod_revision.ensure_null(revision_id)
 
2696
        # this old format stores the full history, but this api doesn't
 
2697
        # provide it, so we must generate, and might as well check it's
 
2698
        # correct
 
2699
        history = self._lefthand_history(revision_id)
 
2700
        if len(history) != revno:
 
2701
            raise AssertionError('%d != %d' % (len(history), revno))
 
2702
        self._set_revision_history(history)
 
2703
 
 
2704
    def _read_last_revision_info(self):
 
2705
        rh = self.revision_history()
 
2706
        revno = len(rh)
 
2707
        if revno:
 
2708
            return (revno, rh[-1])
 
2709
        else:
 
2710
            return (0, _mod_revision.NULL_REVISION)
 
2711
 
 
2712
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2713
    @needs_write_lock
 
2714
    def set_revision_history(self, rev_history):
 
2715
        """See Branch.set_revision_history."""
 
2716
        self._set_revision_history(rev_history)
 
2717
 
 
2718
    def _set_revision_history(self, rev_history):
 
2719
        if 'evil' in debug.debug_flags:
 
2720
            mutter_callsite(3, "set_revision_history scales with history.")
 
2721
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2722
        for rev_id in rev_history:
 
2723
            check_not_reserved_id(rev_id)
 
2724
        if Branch.hooks['post_change_branch_tip']:
 
2725
            # Don't calculate the last_revision_info() if there are no hooks
 
2726
            # that will use it.
 
2727
            old_revno, old_revid = self.last_revision_info()
 
2728
        if len(rev_history) == 0:
 
2729
            revid = _mod_revision.NULL_REVISION
 
2730
        else:
 
2731
            revid = rev_history[-1]
 
2732
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2733
        self._write_revision_history(rev_history)
 
2734
        self._clear_cached_state()
 
2735
        self._cache_revision_history(rev_history)
 
2736
        for hook in Branch.hooks['set_rh']:
 
2737
            hook(self, rev_history)
 
2738
        if Branch.hooks['post_change_branch_tip']:
 
2739
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2740
 
 
2741
    def _write_revision_history(self, history):
 
2742
        """Factored out of set_revision_history.
 
2743
 
 
2744
        This performs the actual writing to disk.
 
2745
        It is intended to be called by set_revision_history."""
 
2746
        self._transport.put_bytes(
 
2747
            'revision-history', '\n'.join(history),
 
2748
            mode=self.bzrdir._get_file_mode())
 
2749
 
 
2750
    def _gen_revision_history(self):
 
2751
        history = self._transport.get_bytes('revision-history').split('\n')
 
2752
        if history[-1:] == ['']:
 
2753
            # There shouldn't be a trailing newline, but just in case.
 
2754
            history.pop()
 
2755
        return history
 
2756
 
 
2757
    def _synchronize_history(self, destination, revision_id):
 
2758
        if not isinstance(destination, FullHistoryBzrBranch):
 
2759
            super(BzrBranch, self)._synchronize_history(
 
2760
                destination, revision_id)
 
2761
            return
 
2762
        if revision_id == _mod_revision.NULL_REVISION:
 
2763
            new_history = []
 
2764
        else:
 
2765
            new_history = self.revision_history()
 
2766
        if revision_id is not None and new_history != []:
 
2767
            try:
 
2768
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2769
            except ValueError:
 
2770
                rev = self.repository.get_revision(revision_id)
 
2771
                new_history = rev.get_history(self.repository)[1:]
 
2772
        destination._set_revision_history(new_history)
 
2773
 
 
2774
    @needs_write_lock
 
2775
    def generate_revision_history(self, revision_id, last_rev=None,
 
2776
        other_branch=None):
 
2777
        """Create a new revision history that will finish with revision_id.
 
2778
 
 
2779
        :param revision_id: the new tip to use.
 
2780
        :param last_rev: The previous last_revision. If not None, then this
 
2781
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2782
        :param other_branch: The other branch that DivergedBranches should
 
2783
            raise with respect to.
 
2784
        """
 
2785
        self._set_revision_history(self._lefthand_history(revision_id,
 
2786
            last_rev, other_branch))
 
2787
 
 
2788
 
 
2789
class BzrBranch5(FullHistoryBzrBranch):
 
2790
    """A format 5 branch. This supports new features over plain branches.
 
2791
 
 
2792
    It has support for a master_branch which is the data for bound branches.
 
2793
    """
 
2794
 
 
2795
 
 
2796
class BzrBranch8(BzrBranch):
2646
2797
    """A branch that stores tree-reference locations."""
2647
2798
 
2648
2799
    def _open_hook(self):
2674
2825
        self._last_revision_info_cache = None
2675
2826
        self._reference_info = None
2676
2827
 
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
2828
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2829
        current_revid = self.last_revision()
 
2830
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2831
        if _mod_revision.is_null(last_revision):
2725
2832
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2833
        graph = self.repository.get_graph()
 
2834
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2835
            if lh_ancestor == current_revid:
 
2836
                return
 
2837
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2838
 
2729
2839
    def _gen_revision_history(self):
2730
2840
        """Generate the revision history from last revision
2733
2843
        self._extend_partial_history(stop_index=last_revno-1)
2734
2844
        return list(reversed(self._partial_revision_history_cache))
2735
2845
 
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
2846
    @needs_write_lock
2753
2847
    def _set_parent_location(self, url):
2754
2848
        """Set the parent branch"""
2840
2934
 
2841
2935
    def set_bound_location(self, location):
2842
2936
        """See Branch.set_push_location."""
 
2937
        self._master_branch_cache = None
2843
2938
        result = None
2844
2939
        config = self.get_config()
2845
2940
        if location is None:
2876
2971
        # you can always ask for the URL; but you might not be able to use it
2877
2972
        # if the repo can't support stacking.
2878
2973
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2974
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2975
        # waste effort reading the whole stack of config files.
 
2976
        config = self.get_config()._get_branch_data_config()
 
2977
        stacked_url = self._get_config_location('stacked_on_location',
 
2978
            config=config)
2880
2979
        if stacked_url is None:
2881
2980
            raise errors.NotStacked(self)
2882
2981
        return stacked_url
2883
2982
 
2884
 
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
2887
 
 
2888
 
    @needs_write_lock
2889
 
    def generate_revision_history(self, revision_id, last_rev=None,
2890
 
                                  other_branch=None):
2891
 
        """See BzrBranch5.generate_revision_history"""
2892
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2893
 
        revno = len(history)
2894
 
        self.set_last_revision_info(revno, revision_id)
2895
 
 
2896
2983
    @needs_read_lock
2897
2984
    def get_rev_id(self, revno, history=None):
2898
2985
        """Find the revision id of the specified revno."""
2922
3009
        try:
2923
3010
            index = self._partial_revision_history_cache.index(revision_id)
2924
3011
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3012
            try:
 
3013
                self._extend_partial_history(stop_revision=revision_id)
 
3014
            except errors.RevisionNotPresent, e:
 
3015
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3016
            index = len(self._partial_revision_history_cache) - 1
2927
3017
            if self._partial_revision_history_cache[index] != revision_id:
2928
3018
                raise errors.NoSuchRevision(self, revision_id)
2981
3071
    :ivar local_branch: target branch if there is a Master, else None
2982
3072
    :ivar target_branch: Target/destination branch object. (write locked)
2983
3073
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3074
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2984
3075
    """
2985
3076
 
 
3077
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3078
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3079
        """Return the relative change in revno.
 
3080
 
 
3081
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3082
        """
2988
3083
        return self.new_revno - self.old_revno
2989
3084
 
2990
3085
    def report(self, to_file):
 
3086
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3087
        tag_updates = getattr(self, "tag_updates", None)
2991
3088
        if not is_quiet():
2992
 
            if self.old_revid == self.new_revid:
2993
 
                to_file.write('No revisions to pull.\n')
2994
 
            else:
 
3089
            if self.old_revid != self.new_revid:
2995
3090
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3091
            if tag_updates:
 
3092
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3093
            if self.old_revid == self.new_revid and not tag_updates:
 
3094
                if not tag_conflicts:
 
3095
                    to_file.write('No revisions or tags to pull.\n')
 
3096
                else:
 
3097
                    to_file.write('No revisions to pull.\n')
2996
3098
        self._show_tag_conficts(to_file)
2997
3099
 
2998
3100
 
3015
3117
        target, otherwise it will be None.
3016
3118
    """
3017
3119
 
 
3120
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3121
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3122
        """Return the relative change in revno.
 
3123
 
 
3124
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3125
        """
3020
3126
        return self.new_revno - self.old_revno
3021
3127
 
3022
3128
    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)
 
3129
        # TODO: This function gets passed a to_file, but then
 
3130
        # ignores it and calls note() instead. This is also
 
3131
        # inconsistent with PullResult(), which writes to stdout.
 
3132
        # -- JRV20110901, bug #838853
 
3133
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3134
        tag_updates = getattr(self, "tag_updates", None)
 
3135
        if not is_quiet():
 
3136
            if self.old_revid != self.new_revid:
 
3137
                note('Pushed up to revision %d.' % self.new_revno)
 
3138
            if tag_updates:
 
3139
                note('%d tag(s) updated.' % len(tag_updates))
 
3140
            if self.old_revid == self.new_revid and not tag_updates:
 
3141
                if not tag_conflicts:
 
3142
                    note('No new revisions or tags to push.')
 
3143
                else:
 
3144
                    note('No new revisions to push.')
3028
3145
        self._show_tag_conficts(to_file)
3029
3146
 
3030
3147
 
3092
3209
 
3093
3210
 
3094
3211
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3212
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3213
 
3097
3214
    def convert(self, branch):
3098
3215
        format = BzrBranchFormat8()
3101
3218
        branch._transport.put_bytes('format', format.get_format_string())
3102
3219
 
3103
3220
 
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
3221
class InterBranch(InterObject):
3138
3222
    """This class represents operations taking place between two branches.
3139
3223
 
3145
3229
    _optimisers = []
3146
3230
    """The available optimised InterBranch types."""
3147
3231
 
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)
 
3232
    @classmethod
 
3233
    def _get_branch_formats_to_test(klass):
 
3234
        """Return an iterable of format tuples for testing.
 
3235
        
 
3236
        :return: An iterable of (from_format, to_format) to use when testing
 
3237
            this InterBranch class. Each InterBranch class should define this
 
3238
            method itself.
 
3239
        """
 
3240
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3241
 
 
3242
    @needs_write_lock
3153
3243
    def pull(self, overwrite=False, stop_revision=None,
3154
3244
             possible_transports=None, local=False):
3155
3245
        """Mirror source into target branch.
3160
3250
        """
3161
3251
        raise NotImplementedError(self.pull)
3162
3252
 
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,
 
3253
    @needs_write_lock
 
3254
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3255
             _override_hook_source_branch=None):
3178
3256
        """Mirror the source branch into the target branch.
3179
3257
 
3181
3259
        """
3182
3260
        raise NotImplementedError(self.push)
3183
3261
 
 
3262
    @needs_write_lock
 
3263
    def copy_content_into(self, revision_id=None):
 
3264
        """Copy the content of source into target
 
3265
 
 
3266
        revision_id: if not None, the revision history in the new branch will
 
3267
                     be truncated to end with revision_id.
 
3268
        """
 
3269
        raise NotImplementedError(self.copy_content_into)
 
3270
 
 
3271
    @needs_write_lock
 
3272
    def fetch(self, stop_revision=None, limit=None):
 
3273
        """Fetch revisions.
 
3274
 
 
3275
        :param stop_revision: Last revision to fetch
 
3276
        :param limit: Optional rough limit of revisions to fetch
 
3277
        """
 
3278
        raise NotImplementedError(self.fetch)
 
3279
 
3184
3280
 
3185
3281
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()."""
 
3282
    """InterBranch implementation that uses public Branch functions."""
 
3283
 
 
3284
    @classmethod
 
3285
    def is_compatible(klass, source, target):
 
3286
        # GenericBranch uses the public API, so always compatible
 
3287
        return True
 
3288
 
 
3289
    @classmethod
 
3290
    def _get_branch_formats_to_test(klass):
 
3291
        return [(format_registry.get_default(), format_registry.get_default())]
 
3292
 
 
3293
    @classmethod
 
3294
    def unwrap_format(klass, format):
 
3295
        if isinstance(format, remote.RemoteBranchFormat):
 
3296
            format._ensure_real()
 
3297
            return format._custom_format
 
3298
        return format
 
3299
 
 
3300
    @needs_write_lock
 
3301
    def copy_content_into(self, revision_id=None):
 
3302
        """Copy the content of source into target
 
3303
 
 
3304
        revision_id: if not None, the revision history in the new branch will
 
3305
                     be truncated to end with revision_id.
 
3306
        """
 
3307
        self.source.update_references(self.target)
 
3308
        self.source._synchronize_history(self.target, revision_id)
 
3309
        try:
 
3310
            parent = self.source.get_parent()
 
3311
        except errors.InaccessibleParent, e:
 
3312
            mutter('parent was not accessible to copy: %s', e)
 
3313
        else:
 
3314
            if parent:
 
3315
                self.target.set_parent(parent)
 
3316
        if self.source._push_should_merge_tags():
 
3317
            self.source.tags.merge_to(self.target.tags)
 
3318
 
 
3319
    @needs_write_lock
 
3320
    def fetch(self, stop_revision=None, limit=None):
 
3321
        if self.target.base == self.source.base:
 
3322
            return (0, [])
3196
3323
        self.source.lock_read()
3197
3324
        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)
 
3325
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3326
            fetch_spec_factory.source_branch = self.source
 
3327
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3328
            fetch_spec_factory.source_repo = self.source.repository
 
3329
            fetch_spec_factory.target_repo = self.target.repository
 
3330
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3331
            fetch_spec_factory.limit = limit
 
3332
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3333
            return self.target.repository.fetch(self.source.repository,
 
3334
                fetch_spec=fetch_spec)
3233
3335
        finally:
3234
3336
            self.source.unlock()
3235
3337
 
 
3338
    @needs_write_lock
 
3339
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3340
            graph=None):
 
3341
        other_revno, other_last_revision = self.source.last_revision_info()
 
3342
        stop_revno = None # unknown
 
3343
        if stop_revision is None:
 
3344
            stop_revision = other_last_revision
 
3345
            if _mod_revision.is_null(stop_revision):
 
3346
                # if there are no commits, we're done.
 
3347
                return
 
3348
            stop_revno = other_revno
 
3349
 
 
3350
        # what's the current last revision, before we fetch [and change it
 
3351
        # possibly]
 
3352
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3353
        # we fetch here so that we don't process data twice in the common
 
3354
        # case of having something to pull, and so that the check for
 
3355
        # already merged can operate on the just fetched graph, which will
 
3356
        # be cached in memory.
 
3357
        self.fetch(stop_revision=stop_revision)
 
3358
        # Check to see if one is an ancestor of the other
 
3359
        if not overwrite:
 
3360
            if graph is None:
 
3361
                graph = self.target.repository.get_graph()
 
3362
            if self.target._check_if_descendant_or_diverged(
 
3363
                    stop_revision, last_rev, graph, self.source):
 
3364
                # stop_revision is a descendant of last_rev, but we aren't
 
3365
                # overwriting, so we're done.
 
3366
                return
 
3367
        if stop_revno is None:
 
3368
            if graph is None:
 
3369
                graph = self.target.repository.get_graph()
 
3370
            this_revno, this_last_revision = \
 
3371
                    self.target.last_revision_info()
 
3372
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3373
                            [(other_last_revision, other_revno),
 
3374
                             (this_last_revision, this_revno)])
 
3375
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3376
 
 
3377
    @needs_write_lock
3236
3378
    def pull(self, overwrite=False, stop_revision=None,
 
3379
             possible_transports=None, run_hooks=True,
 
3380
             _override_hook_target=None, local=False):
 
3381
        """Pull from source into self, updating my master if any.
 
3382
 
 
3383
        :param run_hooks: Private parameter - if false, this branch
 
3384
            is being called because it's the master of the primary branch,
 
3385
            so it should not run its hooks.
 
3386
        """
 
3387
        bound_location = self.target.get_bound_location()
 
3388
        if local and not bound_location:
 
3389
            raise errors.LocalRequiresBoundBranch()
 
3390
        master_branch = None
 
3391
        source_is_master = False
 
3392
        if bound_location:
 
3393
            # bound_location comes from a config file, some care has to be
 
3394
            # taken to relate it to source.user_url
 
3395
            normalized = urlutils.normalize_url(bound_location)
 
3396
            try:
 
3397
                relpath = self.source.user_transport.relpath(normalized)
 
3398
                source_is_master = (relpath == '')
 
3399
            except (errors.PathNotChild, errors.InvalidURL):
 
3400
                source_is_master = False
 
3401
        if not local and bound_location and not source_is_master:
 
3402
            # not pulling from master, so we need to update master.
 
3403
            master_branch = self.target.get_master_branch(possible_transports)
 
3404
            master_branch.lock_write()
 
3405
        try:
 
3406
            if master_branch:
 
3407
                # pull from source into master.
 
3408
                master_branch.pull(self.source, overwrite, stop_revision,
 
3409
                    run_hooks=False)
 
3410
            return self._pull(overwrite,
 
3411
                stop_revision, _hook_master=master_branch,
 
3412
                run_hooks=run_hooks,
 
3413
                _override_hook_target=_override_hook_target,
 
3414
                merge_tags_to_master=not source_is_master)
 
3415
        finally:
 
3416
            if master_branch:
 
3417
                master_branch.unlock()
 
3418
 
 
3419
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3420
             _override_hook_source_branch=None):
 
3421
        """See InterBranch.push.
 
3422
 
 
3423
        This is the basic concrete implementation of push()
 
3424
 
 
3425
        :param _override_hook_source_branch: If specified, run the hooks
 
3426
            passing this Branch as the source, rather than self.  This is for
 
3427
            use of RemoteBranch, where push is delegated to the underlying
 
3428
            vfs-based Branch.
 
3429
        """
 
3430
        if lossy:
 
3431
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3432
        # TODO: Public option to disable running hooks - should be trivial but
 
3433
        # needs tests.
 
3434
 
 
3435
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3436
        op.add_cleanup(self.source.lock_read().unlock)
 
3437
        op.add_cleanup(self.target.lock_write().unlock)
 
3438
        return op.run(overwrite, stop_revision,
 
3439
            _override_hook_source_branch=_override_hook_source_branch)
 
3440
 
 
3441
    def _basic_push(self, overwrite, stop_revision):
 
3442
        """Basic implementation of push without bound branches or hooks.
 
3443
 
 
3444
        Must be called with source read locked and target write locked.
 
3445
        """
 
3446
        result = BranchPushResult()
 
3447
        result.source_branch = self.source
 
3448
        result.target_branch = self.target
 
3449
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3450
        self.source.update_references(self.target)
 
3451
        if result.old_revid != stop_revision:
 
3452
            # We assume that during 'push' this repository is closer than
 
3453
            # the target.
 
3454
            graph = self.source.repository.get_graph(self.target.repository)
 
3455
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3456
                    graph=graph)
 
3457
        if self.source._push_should_merge_tags():
 
3458
            result.tag_updates, result.tag_conflicts = (
 
3459
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3460
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3461
        return result
 
3462
 
 
3463
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3464
            _override_hook_source_branch=None):
 
3465
        """Push from source into target, and into target's master if any.
 
3466
        """
 
3467
        def _run_hooks():
 
3468
            if _override_hook_source_branch:
 
3469
                result.source_branch = _override_hook_source_branch
 
3470
            for hook in Branch.hooks['post_push']:
 
3471
                hook(result)
 
3472
 
 
3473
        bound_location = self.target.get_bound_location()
 
3474
        if bound_location and self.target.base != bound_location:
 
3475
            # there is a master branch.
 
3476
            #
 
3477
            # XXX: Why the second check?  Is it even supported for a branch to
 
3478
            # be bound to itself? -- mbp 20070507
 
3479
            master_branch = self.target.get_master_branch()
 
3480
            master_branch.lock_write()
 
3481
            operation.add_cleanup(master_branch.unlock)
 
3482
            # push into the master from the source branch.
 
3483
            master_inter = InterBranch.get(self.source, master_branch)
 
3484
            master_inter._basic_push(overwrite, stop_revision)
 
3485
            # and push into the target branch from the source. Note that
 
3486
            # we push from the source branch again, because it's considered
 
3487
            # the highest bandwidth repository.
 
3488
            result = self._basic_push(overwrite, stop_revision)
 
3489
            result.master_branch = master_branch
 
3490
            result.local_branch = self.target
 
3491
        else:
 
3492
            master_branch = None
 
3493
            # no master branch
 
3494
            result = self._basic_push(overwrite, stop_revision)
 
3495
            # TODO: Why set master_branch and local_branch if there's no
 
3496
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3497
            # 20070504
 
3498
            result.master_branch = self.target
 
3499
            result.local_branch = None
 
3500
        _run_hooks()
 
3501
        return result
 
3502
 
 
3503
    def _pull(self, overwrite=False, stop_revision=None,
3237
3504
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3505
             _override_hook_target=None, local=False,
 
3506
             merge_tags_to_master=True):
3239
3507
        """See Branch.pull.
3240
3508
 
 
3509
        This function is the core worker, used by GenericInterBranch.pull to
 
3510
        avoid duplication when pulling source->master and source->local.
 
3511
 
3241
3512
        :param _hook_master: Private parameter - set the branch to
3242
3513
            be supplied as the master to pull hooks.
3243
3514
        :param run_hooks: Private parameter - if false, this branch
3244
3515
            is being called because it's the master of the primary branch,
3245
3516
            so it should not run its hooks.
 
3517
            is being called because it's the master of the primary branch,
 
3518
            so it should not run its hooks.
3246
3519
        :param _override_hook_target: Private parameter - set the branch to be
3247
3520
            supplied as the target_branch to pull hooks.
3248
3521
        :param local: Only update the local branch, and not the bound branch.
3267
3540
            # -- JRV20090506
3268
3541
            result.old_revno, result.old_revid = \
3269
3542
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3543
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3544
                graph=graph)
3272
3545
            # TODO: The old revid should be specified when merging tags, 
3273
3546
            # so a tags implementation that versions tags can only 
3274
3547
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3548
            result.tag_updates, result.tag_conflicts = (
 
3549
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3550
                    ignore_master=not merge_tags_to_master))
3277
3551
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3552
            if _hook_master:
3279
3553
                result.master_branch = _hook_master
3288
3562
            self.source.unlock()
3289
3563
        return result
3290
3564
 
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
3565
 
3400
3566
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)