/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Lawrence Mitchell
  • Date: 2011-11-08 10:54:09 UTC
  • mto: This revision was merged to the branch mainline in revision 6245.
  • Revision ID: wence@gmx.li-20111108105409-cgdqeek7vl7e8nbb
Only set check_clean if {clean} is asked for in template
      
The {clean} flag in templates requires an lstat of every file in the
repository.  If the filesystem is slow this can take a noticeable
amount of time.  So only switch check_clean to True if the template
actually asks for it, to avoid penalising those who don't want to
know.

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