~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-05-03 09:07:50 UTC
  • mfrom: (5185.1.1 fix-515660)
  • Revision ID: pqm@pqm.ubuntu.com-20100503090750-ojeefmuph3yj8m5z
Update 'bzr bind' help to indicate what happens when no location is
 specified.

Show diffs side-by-side

added added

removed removed

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