~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jonathan Riddell
  • Date: 2011-09-20 11:46:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6153.
  • Revision ID: jriddell@canonical.com-20110920114628-o8idd3n4eb4v3n32
fix order of imports

Show diffs side-by-side

added added

removed removed

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