~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Jelmer Vernooij
  • Date: 2011-09-25 23:58:12 UTC
  • mto: This revision was merged to the branch mainline in revision 6216.
  • Revision ID: jelmer@samba.org-20110925235812-c35izhdesn8rg0l5
More fixes.

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)
 
217
 
 
218
    def get_config_stack(self):
 
219
        """Get a bzrlib.config.BranchStack for this Branch.
 
220
 
 
221
        This can then be used to get and set configuration options for the
 
222
        branch.
 
223
 
 
224
        :return: A bzrlib.config.BranchStack.
 
225
        """
 
226
        return _mod_config.BranchStack(self)
201
227
 
202
228
    def _get_config(self):
203
229
        """Get the concrete config for just the config in this branch.
218
244
            possible_transports=[self.bzrdir.root_transport])
219
245
        return a_branch.repository
220
246
 
 
247
    @needs_read_lock
221
248
    def _get_tags_bytes(self):
222
249
        """Get the bytes of a serialised tags dict.
223
250
 
230
257
        :return: The bytes of the tags file.
231
258
        :seealso: Branch._set_tags_bytes.
232
259
        """
233
 
        return self._transport.get_bytes('tags')
 
260
        if self._tags_bytes is None:
 
261
            self._tags_bytes = self._transport.get_bytes('tags')
 
262
        return self._tags_bytes
234
263
 
235
264
    def _get_nick(self, local=False, possible_transports=None):
236
265
        config = self.get_config()
238
267
        if not local and not config.has_explicit_nickname():
239
268
            try:
240
269
                master = self.get_master_branch(possible_transports)
 
270
                if master and self.user_url == master.user_url:
 
271
                    raise errors.RecursiveBind(self.user_url)
241
272
                if master is not None:
242
273
                    # return the master branch value
243
274
                    return master.nick
 
275
            except errors.RecursiveBind, e:
 
276
                raise e
244
277
            except errors.BzrError, e:
245
278
                # Silently fall back to local implicit nick if the master is
246
279
                # unavailable
283
316
        new_history.reverse()
284
317
        return new_history
285
318
 
286
 
    def lock_write(self):
 
319
    def lock_write(self, token=None):
 
320
        """Lock the branch for write operations.
 
321
 
 
322
        :param token: A token to permit reacquiring a previously held and
 
323
            preserved lock.
 
324
        :return: A BranchWriteLockResult.
 
325
        """
287
326
        raise NotImplementedError(self.lock_write)
288
327
 
289
328
    def lock_read(self):
 
329
        """Lock the branch for read operations.
 
330
 
 
331
        :return: A bzrlib.lock.LogicalLockResult.
 
332
        """
290
333
        raise NotImplementedError(self.lock_read)
291
334
 
292
335
    def unlock(self):
413
456
            after. If None, the rest of history is included.
414
457
        :param stop_rule: if stop_revision_id is not None, the precise rule
415
458
            to use for termination:
 
459
 
416
460
            * 'exclude' - leave the stop revision out of the result (default)
417
461
            * 'include' - the stop revision is the last item in the result
418
462
            * 'with-merges' - include the stop revision and all of its
420
464
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
465
              that are in both ancestries
422
466
        :param direction: either 'reverse' or 'forward':
 
467
 
423
468
            * reverse means return the start_revision_id first, i.e.
424
469
              start at the most recent revision and go backwards in history
425
470
            * forward returns tuples in the opposite order to reverse.
469
514
        rev_iter = iter(merge_sorted_revisions)
470
515
        if start_revision_id is not None:
471
516
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
517
                rev_id = node.key
473
518
                if rev_id != start_revision_id:
474
519
                    continue
475
520
                else:
476
521
                    # The decision to include the start or not
477
522
                    # depends on the stop_rule if a stop is provided
478
523
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
524
                    rev_iter = itertools.chain(iter([node]), rev_iter)
480
525
                    break
481
526
        if stop_revision_id is None:
482
527
            # Yield everything
483
528
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
 
529
                rev_id = node.key
485
530
                yield (rev_id, node.merge_depth, node.revno,
486
531
                       node.end_of_merge)
487
532
        elif stop_rule == 'exclude':
488
533
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
534
                rev_id = node.key
490
535
                if rev_id == stop_revision_id:
491
536
                    return
492
537
                yield (rev_id, node.merge_depth, node.revno,
493
538
                       node.end_of_merge)
494
539
        elif stop_rule == 'include':
495
540
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
 
541
                rev_id = node.key
497
542
                yield (rev_id, node.merge_depth, node.revno,
498
543
                       node.end_of_merge)
499
544
                if rev_id == stop_revision_id:
505
550
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
551
                                                    [stop_revision_id])
507
552
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
 
553
                rev_id = node.key
509
554
                if rev_id not in ancestors:
510
555
                    continue
511
556
                yield (rev_id, node.merge_depth, node.revno,
521
566
            reached_stop_revision_id = False
522
567
            revision_id_whitelist = []
523
568
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
569
                rev_id = node.key
525
570
                if rev_id == left_parent:
526
571
                    # reached the left parent after the stop_revision
527
572
                    return
607
652
        """
608
653
        raise errors.UpgradeRequired(self.user_url)
609
654
 
 
655
    def get_append_revisions_only(self):
 
656
        """Whether it is only possible to append revisions to the history.
 
657
        """
 
658
        if not self._format.supports_set_append_revisions_only():
 
659
            return False
 
660
        return self.get_config(
 
661
            ).get_user_option_as_bool('append_revisions_only')
 
662
 
610
663
    def set_append_revisions_only(self, enabled):
611
664
        if not self._format.supports_set_append_revisions_only():
612
665
            raise errors.UpgradeRequired(self.user_url)
626
679
        raise errors.UnsupportedOperation(self.get_reference_info, self)
627
680
 
628
681
    @needs_write_lock
629
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
682
    def fetch(self, from_branch, last_revision=None, limit=None):
630
683
        """Copy revisions from from_branch into this branch.
631
684
 
632
685
        :param from_branch: Where to copy from.
633
686
        :param last_revision: What revision to stop at (None for at the end
634
687
                              of the branch.
635
 
        :param pb: An optional progress bar to use.
 
688
        :param limit: Optional rough limit of revisions to fetch
636
689
        :return: None
637
690
        """
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()
 
691
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
654
692
 
655
693
    def get_bound_location(self):
656
694
        """Return the URL of the branch we are bound to.
667
705
 
668
706
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
707
                           timezone=None, committer=None, revprops=None,
670
 
                           revision_id=None):
 
708
                           revision_id=None, lossy=False):
671
709
        """Obtain a CommitBuilder for this branch.
672
710
 
673
711
        :param parents: Revision ids of the parents of the new revision.
677
715
        :param committer: Optional committer to set for commit.
678
716
        :param revprops: Optional dictionary of revision properties.
679
717
        :param revision_id: Optional revision id.
 
718
        :param lossy: Whether to discard data that can not be natively
 
719
            represented, when pushing to a foreign VCS 
680
720
        """
681
721
 
682
722
        if config is None:
683
723
            config = self.get_config()
684
724
 
685
725
        return self.repository.get_commit_builder(self, parents, config,
686
 
            timestamp, timezone, committer, revprops, revision_id)
 
726
            timestamp, timezone, committer, revprops, revision_id,
 
727
            lossy)
687
728
 
688
729
    def get_master_branch(self, possible_transports=None):
689
730
        """Return the branch we are bound to.
698
739
        The delta is relative to its mainline predecessor, or the
699
740
        empty tree for revision 1.
700
741
        """
701
 
        rh = self.revision_history()
702
 
        if not (1 <= revno <= len(rh)):
 
742
        try:
 
743
            revid = self.get_rev_id(revno-1)
 
744
        except errors.NoSuchRevision:
703
745
            raise errors.InvalidRevisionNumber(revno)
704
 
        return self.repository.get_revision_delta(rh[revno-1])
 
746
        return self.repository.get_revision_delta(revid)
705
747
 
706
748
    def get_stacked_on_url(self):
707
749
        """Get the URL this branch is stacked against.
716
758
        """Print `file` to stdout."""
717
759
        raise NotImplementedError(self.print_file)
718
760
 
 
761
    @deprecated_method(deprecated_in((2, 4, 0)))
719
762
    def set_revision_history(self, rev_history):
720
 
        raise NotImplementedError(self.set_revision_history)
 
763
        """See Branch.set_revision_history."""
 
764
        self._set_revision_history(rev_history)
 
765
 
 
766
    @needs_write_lock
 
767
    def _set_revision_history(self, rev_history):
 
768
        if len(rev_history) == 0:
 
769
            revid = _mod_revision.NULL_REVISION
 
770
        else:
 
771
            revid = rev_history[-1]
 
772
        if rev_history != self._lefthand_history(revid):
 
773
            raise errors.NotLefthandHistory(rev_history)
 
774
        self.set_last_revision_info(len(rev_history), revid)
 
775
        self._cache_revision_history(rev_history)
 
776
        for hook in Branch.hooks['set_rh']:
 
777
            hook(self, rev_history)
 
778
 
 
779
    @needs_write_lock
 
780
    def set_last_revision_info(self, revno, revision_id):
 
781
        """Set the last revision of this branch.
 
782
 
 
783
        The caller is responsible for checking that the revno is correct
 
784
        for this revision id.
 
785
 
 
786
        It may be possible to set the branch last revision to an id not
 
787
        present in the repository.  However, branches can also be
 
788
        configured to check constraints on history, in which case this may not
 
789
        be permitted.
 
790
        """
 
791
        raise NotImplementedError(self.set_last_revision_info)
 
792
 
 
793
    @needs_write_lock
 
794
    def generate_revision_history(self, revision_id, last_rev=None,
 
795
                                  other_branch=None):
 
796
        """See Branch.generate_revision_history"""
 
797
        graph = self.repository.get_graph()
 
798
        (last_revno, last_revid) = self.last_revision_info()
 
799
        known_revision_ids = [
 
800
            (last_revid, last_revno),
 
801
            (_mod_revision.NULL_REVISION, 0),
 
802
            ]
 
803
        if last_rev is not None:
 
804
            if not graph.is_ancestor(last_rev, revision_id):
 
805
                # our previous tip is not merged into stop_revision
 
806
                raise errors.DivergedBranches(self, other_branch)
 
807
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
808
        self.set_last_revision_info(revno, revision_id)
721
809
 
722
810
    @needs_write_lock
723
811
    def set_parent(self, url):
767
855
 
768
856
    def _unstack(self):
769
857
        """Change a branch to be unstacked, copying data as needed.
770
 
        
 
858
 
771
859
        Don't call this directly, use set_stacked_on_url(None).
772
860
        """
773
861
        pb = ui.ui_factory.nested_progress_bar()
774
862
        try:
775
 
            pb.update("Unstacking")
 
863
            pb.update(gettext("Unstacking"))
776
864
            # The basic approach here is to fetch the tip of the branch,
777
865
            # including all available ghosts, from the existing stacked
778
866
            # repository into a new repository object without the fallbacks. 
782
870
            old_repository = self.repository
783
871
            if len(old_repository._fallback_repositories) != 1:
784
872
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
 
873
                    "of %r (fallbacks: %r)" % (old_repository,
 
874
                        old_repository._fallback_repositories))
 
875
            # Open the new repository object.
 
876
            # Repositories don't offer an interface to remove fallback
 
877
            # repositories today; take the conceptually simpler option and just
 
878
            # reopen it.  We reopen it starting from the URL so that we
 
879
            # get a separate connection for RemoteRepositories and can
 
880
            # stream from one of them to the other.  This does mean doing
 
881
            # separate SSH connection setup, but unstacking is not a
 
882
            # common operation so it's tolerable.
 
883
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
884
            new_repository = new_bzrdir.find_repository()
 
885
            if new_repository._fallback_repositories:
 
886
                raise AssertionError("didn't expect %r to have "
 
887
                    "fallback_repositories"
 
888
                    % (self.repository,))
 
889
            # Replace self.repository with the new repository.
 
890
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
891
            # lock count) of self.repository to the new repository.
 
892
            lock_token = old_repository.lock_write().repository_token
 
893
            self.repository = new_repository
 
894
            if isinstance(self, remote.RemoteBranch):
 
895
                # Remote branches can have a second reference to the old
 
896
                # repository that need to be replaced.
 
897
                if self._real_branch is not None:
 
898
                    self._real_branch.repository = new_repository
 
899
            self.repository.lock_write(token=lock_token)
 
900
            if lock_token is not None:
 
901
                old_repository.leave_lock_in_place()
787
902
            old_repository.unlock()
 
903
            if lock_token is not None:
 
904
                # XXX: self.repository.leave_lock_in_place() before this
 
905
                # function will not be preserved.  Fortunately that doesn't
 
906
                # affect the current default format (2a), and would be a
 
907
                # corner-case anyway.
 
908
                #  - Andrew Bennetts, 2010/06/30
 
909
                self.repository.dont_leave_lock_in_place()
 
910
            old_lock_count = 0
 
911
            while True:
 
912
                try:
 
913
                    old_repository.unlock()
 
914
                except errors.LockNotHeld:
 
915
                    break
 
916
                old_lock_count += 1
 
917
            if old_lock_count == 0:
 
918
                raise AssertionError(
 
919
                    'old_repository should have been locked at least once.')
 
920
            for i in range(old_lock_count-1):
 
921
                self.repository.lock_write()
 
922
            # Fetch from the old repository into the new.
788
923
            old_repository.lock_read()
789
924
            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
925
                # XXX: If you unstack a branch while it has a working tree
809
926
                # with a pending merge, the pending-merged revisions will no
810
927
                # 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)
 
928
                try:
 
929
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
930
                except errors.TagsNotSupported:
 
931
                    tags_to_fetch = set()
 
932
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
933
                    old_repository, required_ids=[self.last_revision()],
 
934
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
935
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
818
936
            finally:
819
937
                old_repository.unlock()
820
938
        finally:
825
943
 
826
944
        :seealso: Branch._get_tags_bytes.
827
945
        """
828
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
829
 
            'tags', bytes)
 
946
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
947
        op.add_cleanup(self.lock_write().unlock)
 
948
        return op.run_simple(bytes)
 
949
 
 
950
    def _set_tags_bytes_locked(self, bytes):
 
951
        self._tags_bytes = bytes
 
952
        return self._transport.put_bytes('tags', bytes)
830
953
 
831
954
    def _cache_revision_history(self, rev_history):
832
955
        """Set the cached revision history to rev_history.
859
982
        self._revision_history_cache = None
860
983
        self._revision_id_to_revno_cache = None
861
984
        self._last_revision_info_cache = None
 
985
        self._master_branch_cache = None
862
986
        self._merge_sorted_revisions_cache = None
863
987
        self._partial_revision_history_cache = []
864
988
        self._partial_revision_id_to_revno_cache = {}
 
989
        self._tags_bytes = None
865
990
 
866
991
    def _gen_revision_history(self):
867
992
        """Return sequence of revision hashes on to this branch.
878
1003
        """
879
1004
        raise NotImplementedError(self._gen_revision_history)
880
1005
 
 
1006
    @deprecated_method(deprecated_in((2, 5, 0)))
881
1007
    @needs_read_lock
882
1008
    def revision_history(self):
883
1009
        """Return sequence of revision ids on this branch.
885
1011
        This method will cache the revision history for as long as it is safe to
886
1012
        do so.
887
1013
        """
 
1014
        return self._revision_history()
 
1015
 
 
1016
    @needs_read_lock
 
1017
    def iter_revision_history(self):
 
1018
        """Iterate over the revision ids in this branch, last to first.
 
1019
        """
 
1020
        for revid in self._revision_history():
 
1021
            yield revid
 
1022
 
 
1023
    def _revision_history(self):
888
1024
        if 'evil' in debug.debug_flags:
889
1025
            mutter_callsite(3, "revision_history scales with history.")
890
1026
        if self._revision_history_cache is not None:
917
1053
        :return: A tuple (revno, revision_id).
918
1054
        """
919
1055
        if self._last_revision_info_cache is None:
920
 
            self._last_revision_info_cache = self._last_revision_info()
 
1056
            self._last_revision_info_cache = self._read_last_revision_info()
921
1057
        return self._last_revision_info_cache
922
1058
 
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
 
 
 
1059
    def _read_last_revision_info(self):
 
1060
        raise NotImplementedError(self._read_last_revision_info)
 
1061
 
 
1062
    @deprecated_method(deprecated_in((2, 4, 0)))
970
1063
    def import_last_revision_info(self, source_repo, revno, revid):
971
1064
        """Set the last revision info, importing from another repo if necessary.
972
1065
 
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
1066
        :param source_repo: Source repository to optionally fetch from
977
1067
        :param revno: Revision number of the new tip
978
1068
        :param revid: Revision id of the new tip
981
1071
            self.repository.fetch(source_repo, revision_id=revid)
982
1072
        self.set_last_revision_info(revno, revid)
983
1073
 
 
1074
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1075
                                           lossy=False):
 
1076
        """Set the last revision info, importing from another repo if necessary.
 
1077
 
 
1078
        This is used by the bound branch code to upload a revision to
 
1079
        the master branch first before updating the tip of the local branch.
 
1080
        Revisions referenced by source's tags are also transferred.
 
1081
 
 
1082
        :param source: Source branch to optionally fetch from
 
1083
        :param revno: Revision number of the new tip
 
1084
        :param revid: Revision id of the new tip
 
1085
        :param lossy: Whether to discard metadata that can not be
 
1086
            natively represented
 
1087
        :return: Tuple with the new revision number and revision id
 
1088
            (should only be different from the arguments when lossy=True)
 
1089
        """
 
1090
        if not self.repository.has_same_location(source.repository):
 
1091
            self.fetch(source, revid)
 
1092
        self.set_last_revision_info(revno, revid)
 
1093
        return (revno, revid)
 
1094
 
984
1095
    def revision_id_to_revno(self, revision_id):
985
1096
        """Given a revision id, return its revno"""
986
1097
        if _mod_revision.is_null(revision_id):
987
1098
            return 0
988
 
        history = self.revision_history()
 
1099
        history = self._revision_history()
989
1100
        try:
990
1101
            return history.index(revision_id) + 1
991
1102
        except ValueError:
1006
1117
            self._extend_partial_history(distance_from_last)
1007
1118
        return self._partial_revision_history_cache[distance_from_last]
1008
1119
 
1009
 
    @needs_write_lock
1010
1120
    def pull(self, source, overwrite=False, stop_revision=None,
1011
1121
             possible_transports=None, *args, **kwargs):
1012
1122
        """Mirror source into this branch.
1019
1129
            stop_revision=stop_revision,
1020
1130
            possible_transports=possible_transports, *args, **kwargs)
1021
1131
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
1132
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1133
            *args, **kwargs):
1024
1134
        """Mirror this branch into target.
1025
1135
 
1026
1136
        This branch is considered to be 'local', having low latency.
1027
1137
        """
1028
1138
        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)
 
1139
            lossy, *args, **kwargs)
1051
1140
 
1052
1141
    def basis_tree(self):
1053
1142
        """Return `Tree` object for last revision."""
1208
1297
        return result
1209
1298
 
1210
1299
    @needs_read_lock
1211
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1300
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1301
            repository=None):
1212
1302
        """Create a new line of development from the branch, into to_bzrdir.
1213
1303
 
1214
1304
        to_bzrdir controls the branch format.
1219
1309
        if (repository_policy is not None and
1220
1310
            repository_policy.requires_stacking()):
1221
1311
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
 
        result = to_bzrdir.create_branch()
 
1312
        result = to_bzrdir.create_branch(repository=repository)
1223
1313
        result.lock_write()
1224
1314
        try:
1225
1315
            if repository_policy is not None:
1226
1316
                repository_policy.configure_branch(result)
1227
1317
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1318
            master_url = self.get_bound_location()
 
1319
            if master_url is None:
 
1320
                result.set_parent(self.bzrdir.root_transport.base)
 
1321
            else:
 
1322
                result.set_parent(master_url)
1229
1323
        finally:
1230
1324
            result.unlock()
1231
1325
        return result
1255
1349
                revno = 1
1256
1350
        destination.set_last_revision_info(revno, revision_id)
1257
1351
 
1258
 
    @needs_read_lock
1259
1352
    def copy_content_into(self, destination, revision_id=None):
1260
1353
        """Copy the content of self into destination.
1261
1354
 
1262
1355
        revision_id: if not None, the revision history in the new branch will
1263
1356
                     be truncated to end with revision_id.
1264
1357
        """
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)
 
1358
        return InterBranch.get(self, destination).copy_content_into(
 
1359
            revision_id=revision_id)
1276
1360
 
1277
1361
    def update_references(self, target):
1278
1362
        if not getattr(self._format, 'supports_reference_locations', False):
1319
1403
        # specific check.
1320
1404
        return result
1321
1405
 
1322
 
    def _get_checkout_format(self):
 
1406
    def _get_checkout_format(self, lightweight=False):
1323
1407
        """Return the most suitable metadir for a checkout of this branch.
1324
1408
        Weaves are used if this branch's repository uses weaves.
1325
1409
        """
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)
 
1410
        format = self.repository.bzrdir.checkout_metadir()
 
1411
        format.set_branch_format(self._format)
1333
1412
        return format
1334
1413
 
1335
1414
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1415
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1416
        no_tree=None):
1337
1417
        """Create a clone of this branch and its bzrdir.
1338
1418
 
1339
1419
        :param to_transport: The transport to clone onto.
1346
1426
        """
1347
1427
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1428
        # clone call. Or something. 20090224 RBC/spiv.
 
1429
        # XXX: Should this perhaps clone colocated branches as well, 
 
1430
        # rather than just the default branch? 20100319 JRV
1349
1431
        if revision_id is None:
1350
1432
            revision_id = self.last_revision()
1351
1433
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
1434
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1435
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1436
            no_tree=no_tree)
1354
1437
        return dir_to.open_branch()
1355
1438
 
1356
1439
    def create_checkout(self, to_location, revision_id=None,
1361
1444
        :param to_location: The url to produce the checkout at
1362
1445
        :param revision_id: The revision to check out
1363
1446
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1364
 
        produce a bound branch (heavyweight checkout)
 
1447
            produce a bound branch (heavyweight checkout)
1365
1448
        :param accelerator_tree: A tree which can be used for retrieving file
1366
1449
            contents more quickly than the revision tree, i.e. a workingtree.
1367
1450
            The revision tree will be used for cases where accelerator_tree's
1372
1455
        """
1373
1456
        t = transport.get_transport(to_location)
1374
1457
        t.ensure_base()
 
1458
        format = self._get_checkout_format(lightweight=lightweight)
1375
1459
        if lightweight:
1376
 
            format = self._get_checkout_format()
1377
1460
            checkout = format.initialize_on_transport(t)
1378
1461
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
1462
                target_branch=self)
1380
1463
        else:
1381
 
            format = self._get_checkout_format()
1382
1464
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1383
1465
                to_location, force_new_tree=False, format=format)
1384
1466
            checkout = checkout_branch.bzrdir
1413
1495
 
1414
1496
    def reference_parent(self, file_id, path, possible_transports=None):
1415
1497
        """Return the parent branch for a tree-reference file_id
 
1498
 
1416
1499
        :param file_id: The file_id of the tree reference
1417
1500
        :param path: The path of the file_id in the tree
1418
1501
        :return: A branch associated with the file_id
1471
1554
        else:
1472
1555
            raise AssertionError("invalid heads: %r" % (heads,))
1473
1556
 
1474
 
 
1475
 
class BranchFormat(object):
 
1557
    def heads_to_fetch(self):
 
1558
        """Return the heads that must and that should be fetched to copy this
 
1559
        branch into another repo.
 
1560
 
 
1561
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1562
            set of heads that must be fetched.  if_present_fetch is a set of
 
1563
            heads that must be fetched if present, but no error is necessary if
 
1564
            they are not present.
 
1565
        """
 
1566
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1567
        # are the tags.
 
1568
        must_fetch = set([self.last_revision()])
 
1569
        if_present_fetch = set()
 
1570
        c = self.get_config()
 
1571
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1572
                                                 default=False)
 
1573
        if include_tags:
 
1574
            try:
 
1575
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1576
            except errors.TagsNotSupported:
 
1577
                pass
 
1578
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1579
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1580
        return must_fetch, if_present_fetch
 
1581
 
 
1582
 
 
1583
class BranchFormat(controldir.ControlComponentFormat):
1476
1584
    """An encapsulation of the initialization and open routines for a format.
1477
1585
 
1478
1586
    Formats provide three things:
1481
1589
     * an open routine.
1482
1590
 
1483
1591
    Formats are placed in an dict by their format string for reference
1484
 
    during branch opening. Its not required that these be instances, they
 
1592
    during branch opening. It's not required that these be instances, they
1485
1593
    can be classes themselves with class methods - it simply depends on
1486
1594
    whether state is needed for a given format or not.
1487
1595
 
1490
1598
    object will be created every time regardless.
1491
1599
    """
1492
1600
 
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
1601
    def __eq__(self, other):
1502
1602
        return self.__class__ is other.__class__
1503
1603
 
1510
1610
        try:
1511
1611
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
1612
            format_string = transport.get_bytes("format")
1513
 
            return klass._formats[format_string]
 
1613
            return format_registry.get(format_string)
1514
1614
        except errors.NoSuchFile:
1515
1615
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1516
1616
        except KeyError:
1517
1617
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1618
 
1519
1619
    @classmethod
 
1620
    @deprecated_method(deprecated_in((2, 4, 0)))
1520
1621
    def get_default_format(klass):
1521
1622
        """Return the current default format."""
1522
 
        return klass._default_format
1523
 
 
1524
 
    def get_reference(self, a_bzrdir):
 
1623
        return format_registry.get_default()
 
1624
 
 
1625
    @classmethod
 
1626
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1627
    def get_formats(klass):
 
1628
        """Get all the known formats.
 
1629
 
 
1630
        Warning: This triggers a load of all lazy registered formats: do not
 
1631
        use except when that is desireed.
 
1632
        """
 
1633
        return format_registry._get_all()
 
1634
 
 
1635
    def get_reference(self, a_bzrdir, name=None):
1525
1636
        """Get the target reference of the branch in a_bzrdir.
1526
1637
 
1527
1638
        format probing must have been completed before calling
1529
1640
        in a_bzrdir is correct.
1530
1641
 
1531
1642
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1643
        :param name: Name of the colocated branch to fetch
1532
1644
        :return: None if the branch is not a reference branch.
1533
1645
        """
1534
1646
        return None
1535
1647
 
1536
1648
    @classmethod
1537
 
    def set_reference(self, a_bzrdir, to_branch):
 
1649
    def set_reference(self, a_bzrdir, name, to_branch):
1538
1650
        """Set the target reference of the branch in a_bzrdir.
1539
1651
 
1540
1652
        format probing must have been completed before calling
1542
1654
        in a_bzrdir is correct.
1543
1655
 
1544
1656
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1657
        :param name: Name of colocated branch to set, None for default
1545
1658
        :param to_branch: branch that the checkout is to reference
1546
1659
        """
1547
1660
        raise NotImplementedError(self.set_reference)
1562
1675
        for hook in hooks:
1563
1676
            hook(params)
1564
1677
 
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):
 
1678
    def initialize(self, a_bzrdir, name=None, repository=None,
 
1679
                   append_revisions_only=None):
1611
1680
        """Create a branch of this format in a_bzrdir.
1612
1681
        
1613
1682
        :param name: Name of the colocated branch to create.
1635
1704
        Note that it is normal for branch to be a RemoteBranch when using tags
1636
1705
        on a RemoteBranch.
1637
1706
        """
1638
 
        return DisabledTags(branch)
 
1707
        return _mod_tag.DisabledTags(branch)
1639
1708
 
1640
1709
    def network_name(self):
1641
1710
        """A simple byte string uniquely identifying this format for RPC calls.
1647
1716
        """
1648
1717
        raise NotImplementedError(self.network_name)
1649
1718
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1719
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1720
            found_repository=None):
1651
1721
        """Return the branch object for a_bzrdir
1652
1722
 
1653
1723
        :param a_bzrdir: A BzrDir that contains a branch.
1660
1730
        raise NotImplementedError(self.open)
1661
1731
 
1662
1732
    @classmethod
 
1733
    @deprecated_method(deprecated_in((2, 4, 0)))
1663
1734
    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__)
 
1735
        """Register a metadir format.
 
1736
 
 
1737
        See MetaDirBranchFormatFactory for the ability to register a format
 
1738
        without loading the code the format needs until it is actually used.
 
1739
        """
 
1740
        format_registry.register(format)
1669
1741
 
1670
1742
    @classmethod
 
1743
    @deprecated_method(deprecated_in((2, 4, 0)))
1671
1744
    def set_default_format(klass, format):
1672
 
        klass._default_format = format
 
1745
        format_registry.set_default(format)
1673
1746
 
1674
1747
    def supports_set_append_revisions_only(self):
1675
1748
        """True if this format supports set_append_revisions_only."""
1679
1752
        """True if this format records a stacked-on branch."""
1680
1753
        return False
1681
1754
 
 
1755
    def supports_leaving_lock(self):
 
1756
        """True if this format supports leaving locks in place."""
 
1757
        return False # by default
 
1758
 
1682
1759
    @classmethod
 
1760
    @deprecated_method(deprecated_in((2, 4, 0)))
1683
1761
    def unregister_format(klass, format):
1684
 
        del klass._formats[format.get_format_string()]
 
1762
        format_registry.remove(format)
1685
1763
 
1686
1764
    def __str__(self):
1687
1765
        return self.get_format_description().rstrip()
1690
1768
        """True if this format supports tags stored in the branch"""
1691
1769
        return False  # by default
1692
1770
 
 
1771
    def tags_are_versioned(self):
 
1772
        """Whether the tag container for this branch versions tags."""
 
1773
        return False
 
1774
 
 
1775
    def supports_tags_referencing_ghosts(self):
 
1776
        """True if tags can reference ghost revisions."""
 
1777
        return True
 
1778
 
 
1779
 
 
1780
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1781
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1782
    
 
1783
    While none of the built in BranchFormats are lazy registered yet,
 
1784
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1785
    use it, and the bzr-loom plugin uses it as well (see
 
1786
    bzrlib.plugins.loom.formats).
 
1787
    """
 
1788
 
 
1789
    def __init__(self, format_string, module_name, member_name):
 
1790
        """Create a MetaDirBranchFormatFactory.
 
1791
 
 
1792
        :param format_string: The format string the format has.
 
1793
        :param module_name: Module to load the format class from.
 
1794
        :param member_name: Attribute name within the module for the format class.
 
1795
        """
 
1796
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1797
        self._format_string = format_string
 
1798
        
 
1799
    def get_format_string(self):
 
1800
        """See BranchFormat.get_format_string."""
 
1801
        return self._format_string
 
1802
 
 
1803
    def __call__(self):
 
1804
        """Used for network_format_registry support."""
 
1805
        return self.get_obj()()
 
1806
 
1693
1807
 
1694
1808
class BranchHooks(Hooks):
1695
1809
    """A dictionary mapping hook name to a list of callables for branch hooks.
1704
1818
        These are all empty initially, because by default nothing should get
1705
1819
        notified.
1706
1820
        """
1707
 
        Hooks.__init__(self)
1708
 
        self.create_hook(HookPoint('set_rh',
 
1821
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1822
        self.add_hook('set_rh',
1709
1823
            "Invoked whenever the revision history has been set via "
1710
1824
            "set_revision_history. The api signature is (branch, "
1711
1825
            "revision_history), and the branch will be write-locked. "
1712
1826
            "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',
 
1827
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1828
        self.add_hook('open',
1715
1829
            "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',
 
1830
            "branch is opened.", (1, 8))
 
1831
        self.add_hook('post_push',
1718
1832
            "Called after a push operation completes. post_push is called "
1719
1833
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1720
 
            "bzr client.", (0, 15), None))
1721
 
        self.create_hook(HookPoint('post_pull',
 
1834
            "bzr client.", (0, 15))
 
1835
        self.add_hook('post_pull',
1722
1836
            "Called after a pull operation completes. post_pull is called "
1723
1837
            "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 "
 
1838
            "bzr client.", (0, 15))
 
1839
        self.add_hook('pre_commit',
 
1840
            "Called after a commit is calculated but before it is "
1727
1841
            "completed. pre_commit is called with (local, master, old_revno, "
1728
1842
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1729
1843
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1731
1845
            "basis revision. hooks MUST NOT modify this delta. "
1732
1846
            " future_tree is an in-memory tree obtained from "
1733
1847
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1734
 
            "tree.", (0,91), None))
1735
 
        self.create_hook(HookPoint('post_commit',
 
1848
            "tree.", (0,91))
 
1849
        self.add_hook('post_commit',
1736
1850
            "Called in the bzr client after a commit has completed. "
1737
1851
            "post_commit is called with (local, master, old_revno, old_revid, "
1738
1852
            "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',
 
1853
            "commit to a branch.", (0, 15))
 
1854
        self.add_hook('post_uncommit',
1741
1855
            "Called in the bzr client after an uncommit completes. "
1742
1856
            "post_uncommit is called with (local, master, old_revno, "
1743
1857
            "old_revid, new_revno, new_revid) where local is the local branch "
1744
1858
            "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',
 
1859
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1860
        self.add_hook('pre_change_branch_tip',
1747
1861
            "Called in bzr client and server before a change to the tip of a "
1748
1862
            "branch is made. pre_change_branch_tip is called with a "
1749
1863
            "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',
 
1864
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1865
        self.add_hook('post_change_branch_tip',
1752
1866
            "Called in bzr client and server after a change to the tip of a "
1753
1867
            "branch is made. post_change_branch_tip is called with a "
1754
1868
            "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',
 
1869
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1870
        self.add_hook('transform_fallback_location',
1757
1871
            "Called when a stacked branch is activating its fallback "
1758
1872
            "locations. transform_fallback_location is called with (branch, "
1759
1873
            "url), and should return a new url. Returning the same url "
1764
1878
            "fallback locations have not been activated. When there are "
1765
1879
            "multiple hooks installed for transform_fallback_location, "
1766
1880
            "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."
 
1881
            "The order is however undefined.", (1, 9))
 
1882
        self.add_hook('automatic_tag_name',
 
1883
            "Called to determine an automatic tag name for a revision. "
1770
1884
            "automatic_tag_name is called with (branch, revision_id) and "
1771
1885
            "should return a tag name or None if no tag name could be "
1772
1886
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
 
1887
            (2, 2))
 
1888
        self.add_hook('post_branch_init',
1775
1889
            "Called after new branch initialization completes. "
1776
1890
            "post_branch_init is called with a "
1777
1891
            "bzrlib.branch.BranchInitHookParams. "
1778
1892
            "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',
 
1893
            "lightweight) will all trigger this hook.", (2, 2))
 
1894
        self.add_hook('post_switch',
1781
1895
            "Called after a checkout switches branch. "
1782
1896
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1897
            "bzrlib.branch.SwitchHookParams.", (2, 2))
1784
1898
 
1785
1899
 
1786
1900
 
1789
1903
 
1790
1904
 
1791
1905
class ChangeBranchTipParams(object):
1792
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1906
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1793
1907
 
1794
1908
    There are 5 fields that hooks may wish to access:
1795
1909
 
1827
1941
 
1828
1942
 
1829
1943
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
 
1944
    """Object holding parameters passed to `*_branch_init` hooks.
1831
1945
 
1832
1946
    There are 4 fields that hooks may wish to access:
1833
1947
 
1863
1977
        return self.__dict__ == other.__dict__
1864
1978
 
1865
1979
    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)
 
1980
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
1872
1981
 
1873
1982
 
1874
1983
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
 
1984
    """Object holding parameters passed to `*_switch` hooks.
1876
1985
 
1877
1986
    There are 4 fields that hooks may wish to access:
1878
1987
 
1904
2013
            self.revision_id)
1905
2014
 
1906
2015
 
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
2016
class BranchFormatMetadir(BranchFormat):
1951
2017
    """Common logic for meta-dir based branch formats."""
1952
2018
 
1954
2020
        """What class to instantiate on open calls."""
1955
2021
        raise NotImplementedError(self._branch_class)
1956
2022
 
 
2023
    def _get_initial_config(self, append_revisions_only=None):
 
2024
        if append_revisions_only:
 
2025
            return "append_revisions_only = True\n"
 
2026
        else:
 
2027
            # Avoid writing anything if append_revisions_only is disabled,
 
2028
            # as that is the default.
 
2029
            return ""
 
2030
 
 
2031
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
2032
                           repository=None):
 
2033
        """Initialize a branch in a bzrdir, with specified files
 
2034
 
 
2035
        :param a_bzrdir: The bzrdir to initialize the branch in
 
2036
        :param utf8_files: The files to create as a list of
 
2037
            (filename, content) tuples
 
2038
        :param name: Name of colocated branch to create, if any
 
2039
        :return: a branch in this format
 
2040
        """
 
2041
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2042
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2043
        control_files = lockable_files.LockableFiles(branch_transport,
 
2044
            'lock', lockdir.LockDir)
 
2045
        control_files.create_lock()
 
2046
        control_files.lock_write()
 
2047
        try:
 
2048
            utf8_files += [('format', self.get_format_string())]
 
2049
            for (filename, content) in utf8_files:
 
2050
                branch_transport.put_bytes(
 
2051
                    filename, content,
 
2052
                    mode=a_bzrdir._get_file_mode())
 
2053
        finally:
 
2054
            control_files.unlock()
 
2055
        branch = self.open(a_bzrdir, name, _found=True,
 
2056
                found_repository=repository)
 
2057
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2058
        return branch
 
2059
 
1957
2060
    def network_name(self):
1958
2061
        """A simple byte string uniquely identifying this format for RPC calls.
1959
2062
 
1961
2064
        """
1962
2065
        return self.get_format_string()
1963
2066
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
2067
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2068
            found_repository=None):
1965
2069
        """See BranchFormat.open()."""
1966
2070
        if not _found:
1967
2071
            format = BranchFormat.find_format(a_bzrdir, name=name)
1972
2076
        try:
1973
2077
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
2078
                                                         lockdir.LockDir)
 
2079
            if found_repository is None:
 
2080
                found_repository = a_bzrdir.find_repository()
1975
2081
            return self._branch_class()(_format=self,
1976
2082
                              _control_files=control_files,
1977
2083
                              name=name,
1978
2084
                              a_bzrdir=a_bzrdir,
1979
 
                              _repository=a_bzrdir.find_repository(),
 
2085
                              _repository=found_repository,
1980
2086
                              ignore_fallbacks=ignore_fallbacks)
1981
2087
        except errors.NoSuchFile:
1982
2088
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1989
2095
    def supports_tags(self):
1990
2096
        return True
1991
2097
 
 
2098
    def supports_leaving_lock(self):
 
2099
        return True
 
2100
 
1992
2101
 
1993
2102
class BzrBranchFormat5(BranchFormatMetadir):
1994
2103
    """Bzr branch format 5.
2014
2123
        """See BranchFormat.get_format_description()."""
2015
2124
        return "Branch format 5"
2016
2125
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
2126
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2127
                   append_revisions_only=None):
2018
2128
        """Create a branch of this format in a_bzrdir."""
 
2129
        if append_revisions_only:
 
2130
            raise errors.UpgradeRequired(a_bzrdir.user_url)
2019
2131
        utf8_files = [('revision-history', ''),
2020
2132
                      ('branch-name', ''),
2021
2133
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2134
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2023
2135
 
2024
2136
    def supports_tags(self):
2025
2137
        return False
2047
2159
        """See BranchFormat.get_format_description()."""
2048
2160
        return "Branch format 6"
2049
2161
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
2162
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2163
                   append_revisions_only=None):
2051
2164
        """Create a branch of this format in a_bzrdir."""
2052
2165
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
 
2166
                      ('branch.conf',
 
2167
                          self._get_initial_config(append_revisions_only)),
2054
2168
                      ('tags', ''),
2055
2169
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2170
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2057
2171
 
2058
2172
    def make_tags(self, branch):
2059
2173
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
 
2174
        return _mod_tag.BasicTags(branch)
2061
2175
 
2062
2176
    def supports_set_append_revisions_only(self):
2063
2177
        return True
2077
2191
        """See BranchFormat.get_format_description()."""
2078
2192
        return "Branch format 8"
2079
2193
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
2194
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2195
                   append_revisions_only=None):
2081
2196
        """Create a branch of this format in a_bzrdir."""
2082
2197
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
 
2198
                      ('branch.conf',
 
2199
                          self._get_initial_config(append_revisions_only)),
2084
2200
                      ('tags', ''),
2085
2201
                      ('references', '')
2086
2202
                      ]
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()
 
2203
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2093
2204
 
2094
2205
    def make_tags(self, branch):
2095
2206
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
 
2207
        return _mod_tag.BasicTags(branch)
2097
2208
 
2098
2209
    def supports_set_append_revisions_only(self):
2099
2210
        return True
2104
2215
    supports_reference_locations = True
2105
2216
 
2106
2217
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2218
class BzrBranchFormat7(BranchFormatMetadir):
2108
2219
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
2220
 
2110
2221
    The stacked location pointer is passed down to the repository and requires
2113
2224
    This format was introduced in bzr 1.6.
2114
2225
    """
2115
2226
 
2116
 
    def initialize(self, a_bzrdir, name=None):
 
2227
    def initialize(self, a_bzrdir, name=None, repository=None,
 
2228
                   append_revisions_only=None):
2117
2229
        """Create a branch of this format in a_bzrdir."""
2118
2230
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
 
2231
                      ('branch.conf',
 
2232
                          self._get_initial_config(append_revisions_only)),
2120
2233
                      ('tags', ''),
2121
2234
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
2235
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
2123
2236
 
2124
2237
    def _branch_class(self):
2125
2238
        return BzrBranch7
2135
2248
    def supports_set_append_revisions_only(self):
2136
2249
        return True
2137
2250
 
 
2251
    def supports_stacking(self):
 
2252
        return True
 
2253
 
 
2254
    def make_tags(self, branch):
 
2255
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2256
        return _mod_tag.BasicTags(branch)
 
2257
 
2138
2258
    supports_reference_locations = False
2139
2259
 
2140
2260
 
2157
2277
        """See BranchFormat.get_format_description()."""
2158
2278
        return "Checkout reference format 1"
2159
2279
 
2160
 
    def get_reference(self, a_bzrdir):
 
2280
    def get_reference(self, a_bzrdir, name=None):
2161
2281
        """See BranchFormat.get_reference()."""
2162
 
        transport = a_bzrdir.get_branch_transport(None)
 
2282
        transport = a_bzrdir.get_branch_transport(None, name=name)
2163
2283
        return transport.get_bytes('location')
2164
2284
 
2165
 
    def set_reference(self, a_bzrdir, to_branch):
 
2285
    def set_reference(self, a_bzrdir, name, to_branch):
2166
2286
        """See BranchFormat.set_reference()."""
2167
 
        transport = a_bzrdir.get_branch_transport(None)
 
2287
        transport = a_bzrdir.get_branch_transport(None, name=name)
2168
2288
        location = transport.put_bytes('location', to_branch.base)
2169
2289
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
2290
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2291
            repository=None, append_revisions_only=None):
2171
2292
        """Create a branch of this format in a_bzrdir."""
2172
2293
        if target_branch is None:
2173
2294
            # this format does not implement branch itself, thus the implicit
2174
2295
            # creation contract must see it as uninitializable
2175
2296
            raise errors.UninitializableFormat(self)
2176
2297
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2298
        if a_bzrdir._format.fixed_components:
 
2299
            raise errors.IncompatibleFormat(self, a_bzrdir._format)
2177
2300
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
2178
2301
        branch_transport.put_bytes('location',
2179
2302
            target_branch.bzrdir.user_url)
2201
2324
        return clone
2202
2325
 
2203
2326
    def open(self, a_bzrdir, name=None, _found=False, location=None,
2204
 
             possible_transports=None, ignore_fallbacks=False):
 
2327
             possible_transports=None, ignore_fallbacks=False,
 
2328
             found_repository=None):
2205
2329
        """Return the branch that the branch reference in a_bzrdir points at.
2206
2330
 
2207
2331
        :param a_bzrdir: A BzrDir that contains a branch.
2221
2345
                raise AssertionError("wrong format %r found for %r" %
2222
2346
                    (format, self))
2223
2347
        if location is None:
2224
 
            location = self.get_reference(a_bzrdir)
 
2348
            location = self.get_reference(a_bzrdir, name)
2225
2349
        real_bzrdir = bzrdir.BzrDir.open(
2226
2350
            location, possible_transports=possible_transports)
2227
2351
        result = real_bzrdir.open_branch(name=name, 
2238
2362
        return result
2239
2363
 
2240
2364
 
 
2365
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2366
    """Branch format registry."""
 
2367
 
 
2368
    def __init__(self, other_registry=None):
 
2369
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2370
        self._default_format = None
 
2371
 
 
2372
    def set_default(self, format):
 
2373
        self._default_format = format
 
2374
 
 
2375
    def get_default(self):
 
2376
        return self._default_format
 
2377
 
 
2378
 
2241
2379
network_format_registry = registry.FormatRegistry()
2242
2380
"""Registry of formats indexed by their network name.
2243
2381
 
2246
2384
BranchFormat.network_name() for more detail.
2247
2385
"""
2248
2386
 
 
2387
format_registry = BranchFormatRegistry(network_format_registry)
 
2388
 
2249
2389
 
2250
2390
# formats which have no format string are not discoverable
2251
2391
# and not independently creatable, so are not registered.
2253
2393
__format6 = BzrBranchFormat6()
2254
2394
__format7 = BzrBranchFormat7()
2255
2395
__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__)
 
2396
format_registry.register(__format5)
 
2397
format_registry.register(BranchReferenceFormat())
 
2398
format_registry.register(__format6)
 
2399
format_registry.register(__format7)
 
2400
format_registry.register(__format8)
 
2401
format_registry.set_default(__format7)
 
2402
 
 
2403
 
 
2404
class BranchWriteLockResult(LogicalLockResult):
 
2405
    """The result of write locking a branch.
 
2406
 
 
2407
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2408
        None.
 
2409
    :ivar unlock: A callable which will unlock the lock.
 
2410
    """
 
2411
 
 
2412
    def __init__(self, unlock, branch_token):
 
2413
        LogicalLockResult.__init__(self, unlock)
 
2414
        self.branch_token = branch_token
 
2415
 
 
2416
    def __repr__(self):
 
2417
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2418
            self.unlock)
2266
2419
 
2267
2420
 
2268
2421
class BzrBranch(Branch, _RelockDebugMixin):
2318
2471
    base = property(_get_base, doc="The URL for the root of this branch.")
2319
2472
 
2320
2473
    def _get_config(self):
2321
 
        return TransportConfig(self._transport, 'branch.conf')
 
2474
        return _mod_config.TransportConfig(self._transport, 'branch.conf')
2322
2475
 
2323
2476
    def is_locked(self):
2324
2477
        return self.control_files.is_locked()
2325
2478
 
2326
2479
    def lock_write(self, token=None):
 
2480
        """Lock the branch for write operations.
 
2481
 
 
2482
        :param token: A token to permit reacquiring a previously held and
 
2483
            preserved lock.
 
2484
        :return: A BranchWriteLockResult.
 
2485
        """
2327
2486
        if not self.is_locked():
2328
2487
            self._note_lock('w')
2329
2488
        # All-in-one needs to always unlock/lock.
2335
2494
        else:
2336
2495
            took_lock = False
2337
2496
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
2497
            return BranchWriteLockResult(self.unlock,
 
2498
                self.control_files.lock_write(token=token))
2339
2499
        except:
2340
2500
            if took_lock:
2341
2501
                self.repository.unlock()
2342
2502
            raise
2343
2503
 
2344
2504
    def lock_read(self):
 
2505
        """Lock the branch for read operations.
 
2506
 
 
2507
        :return: A bzrlib.lock.LogicalLockResult.
 
2508
        """
2345
2509
        if not self.is_locked():
2346
2510
            self._note_lock('r')
2347
2511
        # All-in-one needs to always unlock/lock.
2354
2518
            took_lock = False
2355
2519
        try:
2356
2520
            self.control_files.lock_read()
 
2521
            return LogicalLockResult(self.unlock)
2357
2522
        except:
2358
2523
            if took_lock:
2359
2524
                self.repository.unlock()
2387
2552
        """See Branch.print_file."""
2388
2553
        return self.repository.print_file(file, revision_id)
2389
2554
 
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
2555
    @needs_write_lock
2454
2556
    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
 
        """
 
2557
        if not revision_id or not isinstance(revision_id, basestring):
 
2558
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2465
2559
        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))
 
2560
        old_revno, old_revid = self.last_revision_info()
 
2561
        if self.get_append_revisions_only():
 
2562
            self._check_history_violation(revision_id)
 
2563
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2564
        self._write_last_revision_info(revno, revision_id)
 
2565
        self._clear_cached_state()
 
2566
        self._last_revision_info_cache = revno, revision_id
 
2567
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2494
2568
 
2495
2569
    def basis_tree(self):
2496
2570
        """See Branch.basis_tree."""
2505
2579
                pass
2506
2580
        return None
2507
2581
 
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
2582
    def get_stacked_on_url(self):
2531
2583
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2532
2584
 
2543
2595
            self._transport.put_bytes('parent', url + '\n',
2544
2596
                mode=self.bzrdir._get_file_mode())
2545
2597
 
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
2598
    @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
 
2599
    def unbind(self):
 
2600
        """If bound, unbind"""
 
2601
        return self.set_bound_location(None)
2595
2602
 
2596
2603
    @needs_write_lock
2597
2604
    def bind(self, other):
2619
2626
        # history around
2620
2627
        self.set_bound_location(other.base)
2621
2628
 
 
2629
    def get_bound_location(self):
 
2630
        try:
 
2631
            return self._transport.get_bytes('bound')[:-1]
 
2632
        except errors.NoSuchFile:
 
2633
            return None
 
2634
 
 
2635
    @needs_read_lock
 
2636
    def get_master_branch(self, possible_transports=None):
 
2637
        """Return the branch we are bound to.
 
2638
 
 
2639
        :return: Either a Branch, or None
 
2640
        """
 
2641
        if self._master_branch_cache is None:
 
2642
            self._master_branch_cache = self._get_master_branch(
 
2643
                possible_transports)
 
2644
        return self._master_branch_cache
 
2645
 
 
2646
    def _get_master_branch(self, possible_transports):
 
2647
        bound_loc = self.get_bound_location()
 
2648
        if not bound_loc:
 
2649
            return None
 
2650
        try:
 
2651
            return Branch.open(bound_loc,
 
2652
                               possible_transports=possible_transports)
 
2653
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2654
            raise errors.BoundBranchConnectionFailure(
 
2655
                    self, bound_loc, e)
 
2656
 
2622
2657
    @needs_write_lock
2623
 
    def unbind(self):
2624
 
        """If bound, unbind"""
2625
 
        return self.set_bound_location(None)
 
2658
    def set_bound_location(self, location):
 
2659
        """Set the target where this branch is bound to.
 
2660
 
 
2661
        :param location: URL to the target branch
 
2662
        """
 
2663
        self._master_branch_cache = None
 
2664
        if location:
 
2665
            self._transport.put_bytes('bound', location+'\n',
 
2666
                mode=self.bzrdir._get_file_mode())
 
2667
        else:
 
2668
            try:
 
2669
                self._transport.delete('bound')
 
2670
            except errors.NoSuchFile:
 
2671
                return False
 
2672
            return True
2626
2673
 
2627
2674
    @needs_write_lock
2628
2675
    def update(self, possible_transports=None):
2641
2688
            return old_tip
2642
2689
        return None
2643
2690
 
2644
 
 
2645
 
class BzrBranch8(BzrBranch5):
 
2691
    def _read_last_revision_info(self):
 
2692
        revision_string = self._transport.get_bytes('last-revision')
 
2693
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2694
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2695
        revno = int(revno)
 
2696
        return revno, revision_id
 
2697
 
 
2698
    def _write_last_revision_info(self, revno, revision_id):
 
2699
        """Simply write out the revision id, with no checks.
 
2700
 
 
2701
        Use set_last_revision_info to perform this safely.
 
2702
 
 
2703
        Does not update the revision_history cache.
 
2704
        """
 
2705
        revision_id = _mod_revision.ensure_null(revision_id)
 
2706
        out_string = '%d %s\n' % (revno, revision_id)
 
2707
        self._transport.put_bytes('last-revision', out_string,
 
2708
            mode=self.bzrdir._get_file_mode())
 
2709
 
 
2710
 
 
2711
class FullHistoryBzrBranch(BzrBranch):
 
2712
    """Bzr branch which contains the full revision history."""
 
2713
 
 
2714
    @needs_write_lock
 
2715
    def set_last_revision_info(self, revno, revision_id):
 
2716
        if not revision_id or not isinstance(revision_id, basestring):
 
2717
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2718
        revision_id = _mod_revision.ensure_null(revision_id)
 
2719
        # this old format stores the full history, but this api doesn't
 
2720
        # provide it, so we must generate, and might as well check it's
 
2721
        # correct
 
2722
        history = self._lefthand_history(revision_id)
 
2723
        if len(history) != revno:
 
2724
            raise AssertionError('%d != %d' % (len(history), revno))
 
2725
        self._set_revision_history(history)
 
2726
 
 
2727
    def _read_last_revision_info(self):
 
2728
        rh = self._revision_history()
 
2729
        revno = len(rh)
 
2730
        if revno:
 
2731
            return (revno, rh[-1])
 
2732
        else:
 
2733
            return (0, _mod_revision.NULL_REVISION)
 
2734
 
 
2735
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2736
    @needs_write_lock
 
2737
    def set_revision_history(self, rev_history):
 
2738
        """See Branch.set_revision_history."""
 
2739
        self._set_revision_history(rev_history)
 
2740
 
 
2741
    def _set_revision_history(self, rev_history):
 
2742
        if 'evil' in debug.debug_flags:
 
2743
            mutter_callsite(3, "set_revision_history scales with history.")
 
2744
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2745
        for rev_id in rev_history:
 
2746
            check_not_reserved_id(rev_id)
 
2747
        if Branch.hooks['post_change_branch_tip']:
 
2748
            # Don't calculate the last_revision_info() if there are no hooks
 
2749
            # that will use it.
 
2750
            old_revno, old_revid = self.last_revision_info()
 
2751
        if len(rev_history) == 0:
 
2752
            revid = _mod_revision.NULL_REVISION
 
2753
        else:
 
2754
            revid = rev_history[-1]
 
2755
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2756
        self._write_revision_history(rev_history)
 
2757
        self._clear_cached_state()
 
2758
        self._cache_revision_history(rev_history)
 
2759
        for hook in Branch.hooks['set_rh']:
 
2760
            hook(self, rev_history)
 
2761
        if Branch.hooks['post_change_branch_tip']:
 
2762
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2763
 
 
2764
    def _write_revision_history(self, history):
 
2765
        """Factored out of set_revision_history.
 
2766
 
 
2767
        This performs the actual writing to disk.
 
2768
        It is intended to be called by set_revision_history."""
 
2769
        self._transport.put_bytes(
 
2770
            'revision-history', '\n'.join(history),
 
2771
            mode=self.bzrdir._get_file_mode())
 
2772
 
 
2773
    def _gen_revision_history(self):
 
2774
        history = self._transport.get_bytes('revision-history').split('\n')
 
2775
        if history[-1:] == ['']:
 
2776
            # There shouldn't be a trailing newline, but just in case.
 
2777
            history.pop()
 
2778
        return history
 
2779
 
 
2780
    def _synchronize_history(self, destination, revision_id):
 
2781
        if not isinstance(destination, FullHistoryBzrBranch):
 
2782
            super(BzrBranch, self)._synchronize_history(
 
2783
                destination, revision_id)
 
2784
            return
 
2785
        if revision_id == _mod_revision.NULL_REVISION:
 
2786
            new_history = []
 
2787
        else:
 
2788
            new_history = self._revision_history()
 
2789
        if revision_id is not None and new_history != []:
 
2790
            try:
 
2791
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2792
            except ValueError:
 
2793
                rev = self.repository.get_revision(revision_id)
 
2794
                new_history = rev.get_history(self.repository)[1:]
 
2795
        destination._set_revision_history(new_history)
 
2796
 
 
2797
    @needs_write_lock
 
2798
    def generate_revision_history(self, revision_id, last_rev=None,
 
2799
        other_branch=None):
 
2800
        """Create a new revision history that will finish with revision_id.
 
2801
 
 
2802
        :param revision_id: the new tip to use.
 
2803
        :param last_rev: The previous last_revision. If not None, then this
 
2804
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2805
        :param other_branch: The other branch that DivergedBranches should
 
2806
            raise with respect to.
 
2807
        """
 
2808
        self._set_revision_history(self._lefthand_history(revision_id,
 
2809
            last_rev, other_branch))
 
2810
 
 
2811
 
 
2812
class BzrBranch5(FullHistoryBzrBranch):
 
2813
    """A format 5 branch. This supports new features over plain branches.
 
2814
 
 
2815
    It has support for a master_branch which is the data for bound branches.
 
2816
    """
 
2817
 
 
2818
 
 
2819
class BzrBranch8(BzrBranch):
2646
2820
    """A branch that stores tree-reference locations."""
2647
2821
 
2648
2822
    def _open_hook(self):
2674
2848
        self._last_revision_info_cache = None
2675
2849
        self._reference_info = None
2676
2850
 
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
2851
    def _check_history_violation(self, revision_id):
2723
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2852
        current_revid = self.last_revision()
 
2853
        last_revision = _mod_revision.ensure_null(current_revid)
2724
2854
        if _mod_revision.is_null(last_revision):
2725
2855
            return
2726
 
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2856
        graph = self.repository.get_graph()
 
2857
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2858
            if lh_ancestor == current_revid:
 
2859
                return
 
2860
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2728
2861
 
2729
2862
    def _gen_revision_history(self):
2730
2863
        """Generate the revision history from last revision
2733
2866
        self._extend_partial_history(stop_index=last_revno-1)
2734
2867
        return list(reversed(self._partial_revision_history_cache))
2735
2868
 
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
2869
    @needs_write_lock
2753
2870
    def _set_parent_location(self, url):
2754
2871
        """Set the parent branch"""
2840
2957
 
2841
2958
    def set_bound_location(self, location):
2842
2959
        """See Branch.set_push_location."""
 
2960
        self._master_branch_cache = None
2843
2961
        result = None
2844
2962
        config = self.get_config()
2845
2963
        if location is None:
2876
2994
        # you can always ask for the URL; but you might not be able to use it
2877
2995
        # if the repo can't support stacking.
2878
2996
        ## self._check_stackable_repo()
2879
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2997
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2998
        # waste effort reading the whole stack of config files.
 
2999
        config = self.get_config()._get_branch_data_config()
 
3000
        stacked_url = self._get_config_location('stacked_on_location',
 
3001
            config=config)
2880
3002
        if stacked_url is None:
2881
3003
            raise errors.NotStacked(self)
2882
3004
        return stacked_url
2883
3005
 
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
3006
    @needs_read_lock
2897
3007
    def get_rev_id(self, revno, history=None):
2898
3008
        """Find the revision id of the specified revno."""
2922
3032
        try:
2923
3033
            index = self._partial_revision_history_cache.index(revision_id)
2924
3034
        except ValueError:
2925
 
            self._extend_partial_history(stop_revision=revision_id)
 
3035
            try:
 
3036
                self._extend_partial_history(stop_revision=revision_id)
 
3037
            except errors.RevisionNotPresent, e:
 
3038
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2926
3039
            index = len(self._partial_revision_history_cache) - 1
2927
3040
            if self._partial_revision_history_cache[index] != revision_id:
2928
3041
                raise errors.NoSuchRevision(self, revision_id)
2981
3094
    :ivar local_branch: target branch if there is a Master, else None
2982
3095
    :ivar target_branch: Target/destination branch object. (write locked)
2983
3096
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
 
3097
    :ivar tag_updates: A dict with new tags, see BasicTags.merge_to
2984
3098
    """
2985
3099
 
 
3100
    @deprecated_method(deprecated_in((2, 3, 0)))
2986
3101
    def __int__(self):
2987
 
        # DEPRECATED: pull used to return the change in revno
 
3102
        """Return the relative change in revno.
 
3103
 
 
3104
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3105
        """
2988
3106
        return self.new_revno - self.old_revno
2989
3107
 
2990
3108
    def report(self, to_file):
 
3109
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3110
        tag_updates = getattr(self, "tag_updates", None)
2991
3111
        if not is_quiet():
2992
 
            if self.old_revid == self.new_revid:
2993
 
                to_file.write('No revisions to pull.\n')
2994
 
            else:
 
3112
            if self.old_revid != self.new_revid:
2995
3113
                to_file.write('Now on revision %d.\n' % self.new_revno)
 
3114
            if tag_updates:
 
3115
                to_file.write('%d tag(s) updated.\n' % len(tag_updates))
 
3116
            if self.old_revid == self.new_revid and not tag_updates:
 
3117
                if not tag_conflicts:
 
3118
                    to_file.write('No revisions or tags to pull.\n')
 
3119
                else:
 
3120
                    to_file.write('No revisions to pull.\n')
2996
3121
        self._show_tag_conficts(to_file)
2997
3122
 
2998
3123
 
3015
3140
        target, otherwise it will be None.
3016
3141
    """
3017
3142
 
 
3143
    @deprecated_method(deprecated_in((2, 3, 0)))
3018
3144
    def __int__(self):
3019
 
        # DEPRECATED: push used to return the change in revno
 
3145
        """Return the relative change in revno.
 
3146
 
 
3147
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3148
        """
3020
3149
        return self.new_revno - self.old_revno
3021
3150
 
3022
3151
    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)
 
3152
        # TODO: This function gets passed a to_file, but then
 
3153
        # ignores it and calls note() instead. This is also
 
3154
        # inconsistent with PullResult(), which writes to stdout.
 
3155
        # -- JRV20110901, bug #838853
 
3156
        tag_conflicts = getattr(self, "tag_conflicts", None)
 
3157
        tag_updates = getattr(self, "tag_updates", None)
 
3158
        if not is_quiet():
 
3159
            if self.old_revid != self.new_revid:
 
3160
                note(gettext('Pushed up to revision %d.') % self.new_revno)
 
3161
            if tag_updates:
 
3162
                note(ngettext('%d tag updated.', '%d tags updated.', len(tag_updates)) % len(tag_updates))
 
3163
            if self.old_revid == self.new_revid and not tag_updates:
 
3164
                if not tag_conflicts:
 
3165
                    note(gettext('No new revisions or tags to push.'))
 
3166
                else:
 
3167
                    note(gettext('No new revisions to push.'))
3028
3168
        self._show_tag_conficts(to_file)
3029
3169
 
3030
3170
 
3044
3184
        :param verbose: Requests more detailed display of what was checked,
3045
3185
            if any.
3046
3186
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
 
3187
        note(gettext('checked branch {0} format {1}').format(
 
3188
                                self.branch.user_url, self.branch._format))
3049
3189
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
3190
            note(gettext('found error:%s'), error)
3051
3191
 
3052
3192
 
3053
3193
class Converter5to6(object):
3092
3232
 
3093
3233
 
3094
3234
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3235
    """Perform an in-place upgrade of format 7 to format 8"""
3096
3236
 
3097
3237
    def convert(self, branch):
3098
3238
        format = BzrBranchFormat8()
3101
3241
        branch._transport.put_bytes('format', format.get_format_string())
3102
3242
 
3103
3243
 
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
3244
class InterBranch(InterObject):
3138
3245
    """This class represents operations taking place between two branches.
3139
3246
 
3145
3252
    _optimisers = []
3146
3253
    """The available optimised InterBranch types."""
3147
3254
 
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)
 
3255
    @classmethod
 
3256
    def _get_branch_formats_to_test(klass):
 
3257
        """Return an iterable of format tuples for testing.
 
3258
        
 
3259
        :return: An iterable of (from_format, to_format) to use when testing
 
3260
            this InterBranch class. Each InterBranch class should define this
 
3261
            method itself.
 
3262
        """
 
3263
        raise NotImplementedError(klass._get_branch_formats_to_test)
3152
3264
 
 
3265
    @needs_write_lock
3153
3266
    def pull(self, overwrite=False, stop_revision=None,
3154
3267
             possible_transports=None, local=False):
3155
3268
        """Mirror source into target branch.
3160
3273
        """
3161
3274
        raise NotImplementedError(self.pull)
3162
3275
 
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,
 
3276
    @needs_write_lock
 
3277
    def push(self, overwrite=False, stop_revision=None, lossy=False,
3177
3278
             _override_hook_source_branch=None):
3178
3279
        """Mirror the source branch into the target branch.
3179
3280
 
3181
3282
        """
3182
3283
        raise NotImplementedError(self.push)
3183
3284
 
 
3285
    @needs_write_lock
 
3286
    def copy_content_into(self, revision_id=None):
 
3287
        """Copy the content of source into target
 
3288
 
 
3289
        revision_id: if not None, the revision history in the new branch will
 
3290
                     be truncated to end with revision_id.
 
3291
        """
 
3292
        raise NotImplementedError(self.copy_content_into)
 
3293
 
 
3294
    @needs_write_lock
 
3295
    def fetch(self, stop_revision=None, limit=None):
 
3296
        """Fetch revisions.
 
3297
 
 
3298
        :param stop_revision: Last revision to fetch
 
3299
        :param limit: Optional rough limit of revisions to fetch
 
3300
        """
 
3301
        raise NotImplementedError(self.fetch)
 
3302
 
3184
3303
 
3185
3304
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()."""
 
3305
    """InterBranch implementation that uses public Branch functions."""
 
3306
 
 
3307
    @classmethod
 
3308
    def is_compatible(klass, source, target):
 
3309
        # GenericBranch uses the public API, so always compatible
 
3310
        return True
 
3311
 
 
3312
    @classmethod
 
3313
    def _get_branch_formats_to_test(klass):
 
3314
        return [(format_registry.get_default(), format_registry.get_default())]
 
3315
 
 
3316
    @classmethod
 
3317
    def unwrap_format(klass, format):
 
3318
        if isinstance(format, remote.RemoteBranchFormat):
 
3319
            format._ensure_real()
 
3320
            return format._custom_format
 
3321
        return format
 
3322
 
 
3323
    @needs_write_lock
 
3324
    def copy_content_into(self, revision_id=None):
 
3325
        """Copy the content of source into target
 
3326
 
 
3327
        revision_id: if not None, the revision history in the new branch will
 
3328
                     be truncated to end with revision_id.
 
3329
        """
 
3330
        self.source.update_references(self.target)
 
3331
        self.source._synchronize_history(self.target, revision_id)
 
3332
        try:
 
3333
            parent = self.source.get_parent()
 
3334
        except errors.InaccessibleParent, e:
 
3335
            mutter('parent was not accessible to copy: %s', e)
 
3336
        else:
 
3337
            if parent:
 
3338
                self.target.set_parent(parent)
 
3339
        if self.source._push_should_merge_tags():
 
3340
            self.source.tags.merge_to(self.target.tags)
 
3341
 
 
3342
    @needs_write_lock
 
3343
    def fetch(self, stop_revision=None, limit=None):
 
3344
        if self.target.base == self.source.base:
 
3345
            return (0, [])
3196
3346
        self.source.lock_read()
3197
3347
        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)
 
3348
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3349
            fetch_spec_factory.source_branch = self.source
 
3350
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3351
            fetch_spec_factory.source_repo = self.source.repository
 
3352
            fetch_spec_factory.target_repo = self.target.repository
 
3353
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3354
            fetch_spec_factory.limit = limit
 
3355
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3356
            return self.target.repository.fetch(self.source.repository,
 
3357
                fetch_spec=fetch_spec)
3233
3358
        finally:
3234
3359
            self.source.unlock()
3235
3360
 
 
3361
    @needs_write_lock
 
3362
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3363
            graph=None):
 
3364
        other_revno, other_last_revision = self.source.last_revision_info()
 
3365
        stop_revno = None # unknown
 
3366
        if stop_revision is None:
 
3367
            stop_revision = other_last_revision
 
3368
            if _mod_revision.is_null(stop_revision):
 
3369
                # if there are no commits, we're done.
 
3370
                return
 
3371
            stop_revno = other_revno
 
3372
 
 
3373
        # what's the current last revision, before we fetch [and change it
 
3374
        # possibly]
 
3375
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3376
        # we fetch here so that we don't process data twice in the common
 
3377
        # case of having something to pull, and so that the check for
 
3378
        # already merged can operate on the just fetched graph, which will
 
3379
        # be cached in memory.
 
3380
        self.fetch(stop_revision=stop_revision)
 
3381
        # Check to see if one is an ancestor of the other
 
3382
        if not overwrite:
 
3383
            if graph is None:
 
3384
                graph = self.target.repository.get_graph()
 
3385
            if self.target._check_if_descendant_or_diverged(
 
3386
                    stop_revision, last_rev, graph, self.source):
 
3387
                # stop_revision is a descendant of last_rev, but we aren't
 
3388
                # overwriting, so we're done.
 
3389
                return
 
3390
        if stop_revno is None:
 
3391
            if graph is None:
 
3392
                graph = self.target.repository.get_graph()
 
3393
            this_revno, this_last_revision = \
 
3394
                    self.target.last_revision_info()
 
3395
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3396
                            [(other_last_revision, other_revno),
 
3397
                             (this_last_revision, this_revno)])
 
3398
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3399
 
 
3400
    @needs_write_lock
3236
3401
    def pull(self, overwrite=False, stop_revision=None,
 
3402
             possible_transports=None, run_hooks=True,
 
3403
             _override_hook_target=None, local=False):
 
3404
        """Pull from source into self, updating my master if any.
 
3405
 
 
3406
        :param run_hooks: Private parameter - if false, this branch
 
3407
            is being called because it's the master of the primary branch,
 
3408
            so it should not run its hooks.
 
3409
        """
 
3410
        bound_location = self.target.get_bound_location()
 
3411
        if local and not bound_location:
 
3412
            raise errors.LocalRequiresBoundBranch()
 
3413
        master_branch = None
 
3414
        source_is_master = False
 
3415
        if bound_location:
 
3416
            # bound_location comes from a config file, some care has to be
 
3417
            # taken to relate it to source.user_url
 
3418
            normalized = urlutils.normalize_url(bound_location)
 
3419
            try:
 
3420
                relpath = self.source.user_transport.relpath(normalized)
 
3421
                source_is_master = (relpath == '')
 
3422
            except (errors.PathNotChild, errors.InvalidURL):
 
3423
                source_is_master = False
 
3424
        if not local and bound_location and not source_is_master:
 
3425
            # not pulling from master, so we need to update master.
 
3426
            master_branch = self.target.get_master_branch(possible_transports)
 
3427
            master_branch.lock_write()
 
3428
        try:
 
3429
            if master_branch:
 
3430
                # pull from source into master.
 
3431
                master_branch.pull(self.source, overwrite, stop_revision,
 
3432
                    run_hooks=False)
 
3433
            return self._pull(overwrite,
 
3434
                stop_revision, _hook_master=master_branch,
 
3435
                run_hooks=run_hooks,
 
3436
                _override_hook_target=_override_hook_target,
 
3437
                merge_tags_to_master=not source_is_master)
 
3438
        finally:
 
3439
            if master_branch:
 
3440
                master_branch.unlock()
 
3441
 
 
3442
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3443
             _override_hook_source_branch=None):
 
3444
        """See InterBranch.push.
 
3445
 
 
3446
        This is the basic concrete implementation of push()
 
3447
 
 
3448
        :param _override_hook_source_branch: If specified, run the hooks
 
3449
            passing this Branch as the source, rather than self.  This is for
 
3450
            use of RemoteBranch, where push is delegated to the underlying
 
3451
            vfs-based Branch.
 
3452
        """
 
3453
        if lossy:
 
3454
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3455
        # TODO: Public option to disable running hooks - should be trivial but
 
3456
        # needs tests.
 
3457
 
 
3458
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3459
        op.add_cleanup(self.source.lock_read().unlock)
 
3460
        op.add_cleanup(self.target.lock_write().unlock)
 
3461
        return op.run(overwrite, stop_revision,
 
3462
            _override_hook_source_branch=_override_hook_source_branch)
 
3463
 
 
3464
    def _basic_push(self, overwrite, stop_revision):
 
3465
        """Basic implementation of push without bound branches or hooks.
 
3466
 
 
3467
        Must be called with source read locked and target write locked.
 
3468
        """
 
3469
        result = BranchPushResult()
 
3470
        result.source_branch = self.source
 
3471
        result.target_branch = self.target
 
3472
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3473
        self.source.update_references(self.target)
 
3474
        if result.old_revid != stop_revision:
 
3475
            # We assume that during 'push' this repository is closer than
 
3476
            # the target.
 
3477
            graph = self.source.repository.get_graph(self.target.repository)
 
3478
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3479
                    graph=graph)
 
3480
        if self.source._push_should_merge_tags():
 
3481
            result.tag_updates, result.tag_conflicts = (
 
3482
                self.source.tags.merge_to(self.target.tags, overwrite))
 
3483
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3484
        return result
 
3485
 
 
3486
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3487
            _override_hook_source_branch=None):
 
3488
        """Push from source into target, and into target's master if any.
 
3489
        """
 
3490
        def _run_hooks():
 
3491
            if _override_hook_source_branch:
 
3492
                result.source_branch = _override_hook_source_branch
 
3493
            for hook in Branch.hooks['post_push']:
 
3494
                hook(result)
 
3495
 
 
3496
        bound_location = self.target.get_bound_location()
 
3497
        if bound_location and self.target.base != bound_location:
 
3498
            # there is a master branch.
 
3499
            #
 
3500
            # XXX: Why the second check?  Is it even supported for a branch to
 
3501
            # be bound to itself? -- mbp 20070507
 
3502
            master_branch = self.target.get_master_branch()
 
3503
            master_branch.lock_write()
 
3504
            operation.add_cleanup(master_branch.unlock)
 
3505
            # push into the master from the source branch.
 
3506
            master_inter = InterBranch.get(self.source, master_branch)
 
3507
            master_inter._basic_push(overwrite, stop_revision)
 
3508
            # and push into the target branch from the source. Note that
 
3509
            # we push from the source branch again, because it's considered
 
3510
            # the highest bandwidth repository.
 
3511
            result = self._basic_push(overwrite, stop_revision)
 
3512
            result.master_branch = master_branch
 
3513
            result.local_branch = self.target
 
3514
        else:
 
3515
            master_branch = None
 
3516
            # no master branch
 
3517
            result = self._basic_push(overwrite, stop_revision)
 
3518
            # TODO: Why set master_branch and local_branch if there's no
 
3519
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3520
            # 20070504
 
3521
            result.master_branch = self.target
 
3522
            result.local_branch = None
 
3523
        _run_hooks()
 
3524
        return result
 
3525
 
 
3526
    def _pull(self, overwrite=False, stop_revision=None,
3237
3527
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
 
3528
             _override_hook_target=None, local=False,
 
3529
             merge_tags_to_master=True):
3239
3530
        """See Branch.pull.
3240
3531
 
 
3532
        This function is the core worker, used by GenericInterBranch.pull to
 
3533
        avoid duplication when pulling source->master and source->local.
 
3534
 
3241
3535
        :param _hook_master: Private parameter - set the branch to
3242
3536
            be supplied as the master to pull hooks.
3243
3537
        :param run_hooks: Private parameter - if false, this branch
3244
3538
            is being called because it's the master of the primary branch,
3245
3539
            so it should not run its hooks.
 
3540
            is being called because it's the master of the primary branch,
 
3541
            so it should not run its hooks.
3246
3542
        :param _override_hook_target: Private parameter - set the branch to be
3247
3543
            supplied as the target_branch to pull hooks.
3248
3544
        :param local: Only update the local branch, and not the bound branch.
3267
3563
            # -- JRV20090506
3268
3564
            result.old_revno, result.old_revid = \
3269
3565
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
 
3566
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3567
                graph=graph)
3272
3568
            # TODO: The old revid should be specified when merging tags, 
3273
3569
            # so a tags implementation that versions tags can only 
3274
3570
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
 
3571
            result.tag_updates, result.tag_conflicts = (
 
3572
                self.source.tags.merge_to(self.target.tags, overwrite,
 
3573
                    ignore_master=not merge_tags_to_master))
3277
3574
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
3575
            if _hook_master:
3279
3576
                result.master_branch = _hook_master
3288
3585
            self.source.unlock()
3289
3586
        return result
3290
3587
 
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
3588
 
3400
3589
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)