~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 08:40:16 UTC
  • mfrom: (5642.4.6 712474-module-available)
  • Revision ID: pqm@pqm.ubuntu.com-20110817084016-600z65qzqmmt44w7
(vila) ModuleAvailableFeature don't try to imported already imported
 modules. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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
24
24
from bzrlib import (
25
25
        bzrdir,
26
26
        cache_utf8,
 
27
        cleanup,
27
28
        config as _mod_config,
28
29
        debug,
29
30
        errors,
 
31
        fetch,
 
32
        graph as _mod_graph,
30
33
        lockdir,
31
34
        lockable_files,
 
35
        remote,
32
36
        repository,
33
37
        revision as _mod_revision,
34
38
        rio,
35
 
        symbol_versioning,
36
39
        transport,
37
 
        tsort,
38
40
        ui,
39
41
        urlutils,
40
42
        )
41
43
from bzrlib.config import BranchConfig, TransportConfig
42
 
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
44
from bzrlib.tag import (
44
45
    BasicTags,
45
46
    DisabledTags,
46
47
    )
47
48
""")
48
49
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
50
from bzrlib import (
 
51
    controldir,
 
52
    )
 
53
from bzrlib.decorators import (
 
54
    needs_read_lock,
 
55
    needs_write_lock,
 
56
    only_raises,
 
57
    )
 
58
from bzrlib.hooks import Hooks
51
59
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
 
60
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
53
61
from bzrlib import registry
54
62
from bzrlib.symbol_versioning import (
55
63
    deprecated_in,
58
66
from bzrlib.trace import mutter, mutter_callsite, note, is_quiet
59
67
 
60
68
 
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
 
# TODO: Maybe include checks for common corruption of newlines, etc?
67
 
 
68
 
# TODO: Some operations like log might retrieve the same revisions
69
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
70
 
# cache in memory to make this faster.  In general anything can be
71
 
# cached in memory between lock and unlock operations. .. nb thats
72
 
# what the transaction identity map provides
73
 
 
74
 
 
75
 
######################################################################
76
 
# branch objects
77
 
 
78
 
class Branch(object):
 
69
class Branch(controldir.ControlComponent):
79
70
    """Branch holding a history of revisions.
80
71
 
81
 
    base
82
 
        Base directory/url of the branch.
83
 
 
84
 
    hooks: An instance of BranchHooks.
 
72
    :ivar base:
 
73
        Base directory/url of the branch; using control_url and
 
74
        control_transport is more standardized.
 
75
    :ivar hooks: An instance of BranchHooks.
 
76
    :ivar _master_branch_cache: cached result of get_master_branch, see
 
77
        _clear_cached_state.
85
78
    """
86
79
    # this is really an instance variable - FIXME move it there
87
80
    # - RBC 20060112
88
81
    base = None
89
82
 
 
83
    @property
 
84
    def control_transport(self):
 
85
        return self._transport
 
86
 
 
87
    @property
 
88
    def user_transport(self):
 
89
        return self.bzrdir.user_transport
 
90
 
90
91
    def __init__(self, *ignored, **ignored_too):
91
92
        self.tags = self._format.make_tags(self)
92
93
        self._revision_history_cache = None
93
94
        self._revision_id_to_revno_cache = None
94
95
        self._partial_revision_id_to_revno_cache = {}
95
96
        self._partial_revision_history_cache = []
 
97
        self._tags_bytes = None
96
98
        self._last_revision_info_cache = None
 
99
        self._master_branch_cache = None
97
100
        self._merge_sorted_revisions_cache = None
98
101
        self._open_hook()
99
102
        hooks = Branch.hooks['open']
105
108
 
106
109
    def _activate_fallback_location(self, url):
107
110
        """Activate the branch/repository from url as a fallback repository."""
 
111
        for existing_fallback_repo in self.repository._fallback_repositories:
 
112
            if existing_fallback_repo.user_url == url:
 
113
                # This fallback is already configured.  This probably only
 
114
                # happens because BzrDir.sprout is a horrible mess.  To avoid
 
115
                # confusing _unstack we don't add this a second time.
 
116
                mutter('duplicate activation of fallback %r on %r', url, self)
 
117
                return
108
118
        repo = self._get_fallback_repository(url)
109
119
        if repo.has_same_location(self.repository):
110
 
            raise errors.UnstackableLocationError(self.base, url)
 
120
            raise errors.UnstackableLocationError(self.user_url, url)
111
121
        self.repository.add_fallback_repository(repo)
112
122
 
113
123
    def break_lock(self):
167
177
        """
168
178
        control = bzrdir.BzrDir.open(base, _unsupported,
169
179
                                     possible_transports=possible_transports)
170
 
        return control.open_branch(_unsupported)
 
180
        return control.open_branch(unsupported=_unsupported)
171
181
 
172
182
    @staticmethod
173
 
    def open_from_transport(transport, _unsupported=False):
 
183
    def open_from_transport(transport, name=None, _unsupported=False):
174
184
        """Open the branch rooted at transport"""
175
185
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
176
 
        return control.open_branch(_unsupported)
 
186
        return control.open_branch(name=name, unsupported=_unsupported)
177
187
 
178
188
    @staticmethod
179
189
    def open_containing(url, possible_transports=None):
200
210
        return self.supports_tags() and self.tags.get_tag_dict()
201
211
 
202
212
    def get_config(self):
 
213
        """Get a bzrlib.config.BranchConfig for this Branch.
 
214
 
 
215
        This can then be used to get and set configuration options for the
 
216
        branch.
 
217
 
 
218
        :return: A bzrlib.config.BranchConfig.
 
219
        """
203
220
        return BranchConfig(self)
204
221
 
205
222
    def _get_config(self):
217
234
    def _get_fallback_repository(self, url):
218
235
        """Get the repository we fallback to at url."""
219
236
        url = urlutils.join(self.base, url)
220
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
237
        a_branch = Branch.open(url,
221
238
            possible_transports=[self.bzrdir.root_transport])
222
 
        return a_bzrdir.open_branch().repository
 
239
        return a_branch.repository
223
240
 
 
241
    @needs_read_lock
224
242
    def _get_tags_bytes(self):
225
243
        """Get the bytes of a serialised tags dict.
226
244
 
233
251
        :return: The bytes of the tags file.
234
252
        :seealso: Branch._set_tags_bytes.
235
253
        """
236
 
        return self._transport.get_bytes('tags')
 
254
        if self._tags_bytes is None:
 
255
            self._tags_bytes = self._transport.get_bytes('tags')
 
256
        return self._tags_bytes
237
257
 
238
258
    def _get_nick(self, local=False, possible_transports=None):
239
259
        config = self.get_config()
241
261
        if not local and not config.has_explicit_nickname():
242
262
            try:
243
263
                master = self.get_master_branch(possible_transports)
 
264
                if master and self.user_url == master.user_url:
 
265
                    raise errors.RecursiveBind(self.user_url)
244
266
                if master is not None:
245
267
                    # return the master branch value
246
268
                    return master.nick
 
269
            except errors.RecursiveBind, e:
 
270
                raise e
247
271
            except errors.BzrError, e:
248
272
                # Silently fall back to local implicit nick if the master is
249
273
                # unavailable
286
310
        new_history.reverse()
287
311
        return new_history
288
312
 
289
 
    def lock_write(self):
 
313
    def lock_write(self, token=None):
 
314
        """Lock the branch for write operations.
 
315
 
 
316
        :param token: A token to permit reacquiring a previously held and
 
317
            preserved lock.
 
318
        :return: A BranchWriteLockResult.
 
319
        """
290
320
        raise NotImplementedError(self.lock_write)
291
321
 
292
322
    def lock_read(self):
 
323
        """Lock the branch for read operations.
 
324
 
 
325
        :return: A bzrlib.lock.LogicalLockResult.
 
326
        """
293
327
        raise NotImplementedError(self.lock_read)
294
328
 
295
329
    def unlock(self):
416
450
            after. If None, the rest of history is included.
417
451
        :param stop_rule: if stop_revision_id is not None, the precise rule
418
452
            to use for termination:
 
453
 
419
454
            * 'exclude' - leave the stop revision out of the result (default)
420
455
            * 'include' - the stop revision is the last item in the result
421
456
            * 'with-merges' - include the stop revision and all of its
422
457
              merged revisions in the result
 
458
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
459
              that are in both ancestries
423
460
        :param direction: either 'reverse' or 'forward':
 
461
 
424
462
            * reverse means return the start_revision_id first, i.e.
425
463
              start at the most recent revision and go backwards in history
426
464
            * forward returns tuples in the opposite order to reverse.
447
485
        # start_revision_id.
448
486
        if self._merge_sorted_revisions_cache is None:
449
487
            last_revision = self.last_revision()
450
 
            last_key = (last_revision,)
451
 
            known_graph = self.repository.revisions.get_known_graph_ancestry(
452
 
                [last_key])
 
488
            known_graph = self.repository.get_known_graph_ancestry(
 
489
                [last_revision])
453
490
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
 
                last_key)
 
491
                last_revision)
455
492
        filtered = self._filter_merge_sorted_revisions(
456
493
            self._merge_sorted_revisions_cache, start_revision_id,
457
494
            stop_revision_id, stop_rule)
 
495
        # Make sure we don't return revisions that are not part of the
 
496
        # start_revision_id ancestry.
 
497
        filtered = self._filter_start_non_ancestors(filtered)
458
498
        if direction == 'reverse':
459
499
            return filtered
460
500
        if direction == 'forward':
468
508
        rev_iter = iter(merge_sorted_revisions)
469
509
        if start_revision_id is not None:
470
510
            for node in rev_iter:
471
 
                rev_id = node.key[-1]
 
511
                rev_id = node.key
472
512
                if rev_id != start_revision_id:
473
513
                    continue
474
514
                else:
480
520
        if stop_revision_id is None:
481
521
            # Yield everything
482
522
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
523
                rev_id = node.key
484
524
                yield (rev_id, node.merge_depth, node.revno,
485
525
                       node.end_of_merge)
486
526
        elif stop_rule == 'exclude':
487
527
            for node in rev_iter:
488
 
                rev_id = node.key[-1]
 
528
                rev_id = node.key
489
529
                if rev_id == stop_revision_id:
490
530
                    return
491
531
                yield (rev_id, node.merge_depth, node.revno,
492
532
                       node.end_of_merge)
493
533
        elif stop_rule == 'include':
494
534
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
 
535
                rev_id = node.key
496
536
                yield (rev_id, node.merge_depth, node.revno,
497
537
                       node.end_of_merge)
498
538
                if rev_id == stop_revision_id:
499
539
                    return
 
540
        elif stop_rule == 'with-merges-without-common-ancestry':
 
541
            # We want to exclude all revisions that are already part of the
 
542
            # stop_revision_id ancestry.
 
543
            graph = self.repository.get_graph()
 
544
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
545
                                                    [stop_revision_id])
 
546
            for node in rev_iter:
 
547
                rev_id = node.key
 
548
                if rev_id not in ancestors:
 
549
                    continue
 
550
                yield (rev_id, node.merge_depth, node.revno,
 
551
                       node.end_of_merge)
500
552
        elif stop_rule == 'with-merges':
501
553
            stop_rev = self.repository.get_revision(stop_revision_id)
502
554
            if stop_rev.parent_ids:
508
560
            reached_stop_revision_id = False
509
561
            revision_id_whitelist = []
510
562
            for node in rev_iter:
511
 
                rev_id = node.key[-1]
 
563
                rev_id = node.key
512
564
                if rev_id == left_parent:
513
565
                    # reached the left parent after the stop_revision
514
566
                    return
525
577
        else:
526
578
            raise ValueError('invalid stop_rule %r' % stop_rule)
527
579
 
 
580
    def _filter_start_non_ancestors(self, rev_iter):
 
581
        # If we started from a dotted revno, we want to consider it as a tip
 
582
        # and don't want to yield revisions that are not part of its
 
583
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
584
        # uninteresting descendants of the first parent of our tip before the
 
585
        # tip itself.
 
586
        first = rev_iter.next()
 
587
        (rev_id, merge_depth, revno, end_of_merge) = first
 
588
        yield first
 
589
        if not merge_depth:
 
590
            # We start at a mainline revision so by definition, all others
 
591
            # revisions in rev_iter are ancestors
 
592
            for node in rev_iter:
 
593
                yield node
 
594
 
 
595
        clean = False
 
596
        whitelist = set()
 
597
        pmap = self.repository.get_parent_map([rev_id])
 
598
        parents = pmap.get(rev_id, [])
 
599
        if parents:
 
600
            whitelist.update(parents)
 
601
        else:
 
602
            # If there is no parents, there is nothing of interest left
 
603
 
 
604
            # FIXME: It's hard to test this scenario here as this code is never
 
605
            # called in that case. -- vila 20100322
 
606
            return
 
607
 
 
608
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
609
            if not clean:
 
610
                if rev_id in whitelist:
 
611
                    pmap = self.repository.get_parent_map([rev_id])
 
612
                    parents = pmap.get(rev_id, [])
 
613
                    whitelist.remove(rev_id)
 
614
                    whitelist.update(parents)
 
615
                    if merge_depth == 0:
 
616
                        # We've reached the mainline, there is nothing left to
 
617
                        # filter
 
618
                        clean = True
 
619
                else:
 
620
                    # A revision that is not part of the ancestry of our
 
621
                    # starting revision.
 
622
                    continue
 
623
            yield (rev_id, merge_depth, revno, end_of_merge)
 
624
 
528
625
    def leave_lock_in_place(self):
529
626
        """Tell this branch object not to release the physical lock when this
530
627
        object is unlocked.
547
644
        :param other: The branch to bind to
548
645
        :type other: Branch
549
646
        """
550
 
        raise errors.UpgradeRequired(self.base)
 
647
        raise errors.UpgradeRequired(self.user_url)
551
648
 
552
649
    def set_append_revisions_only(self, enabled):
553
650
        if not self._format.supports_set_append_revisions_only():
554
 
            raise errors.UpgradeRequired(self.base)
 
651
            raise errors.UpgradeRequired(self.user_url)
555
652
        if enabled:
556
653
            value = 'True'
557
654
        else:
568
665
        raise errors.UnsupportedOperation(self.get_reference_info, self)
569
666
 
570
667
    @needs_write_lock
571
 
    def fetch(self, from_branch, last_revision=None, pb=None):
 
668
    def fetch(self, from_branch, last_revision=None, limit=None):
572
669
        """Copy revisions from from_branch into this branch.
573
670
 
574
671
        :param from_branch: Where to copy from.
575
672
        :param last_revision: What revision to stop at (None for at the end
576
673
                              of the branch.
577
 
        :param pb: An optional progress bar to use.
 
674
        :param limit: Optional rough limit of revisions to fetch
578
675
        :return: None
579
676
        """
580
 
        if self.base == from_branch.base:
581
 
            return (0, [])
582
 
        if pb is not None:
583
 
            symbol_versioning.warn(
584
 
                symbol_versioning.deprecated_in((1, 14, 0))
585
 
                % "pb parameter to fetch()")
586
 
        from_branch.lock_read()
587
 
        try:
588
 
            if last_revision is None:
589
 
                last_revision = from_branch.last_revision()
590
 
                last_revision = _mod_revision.ensure_null(last_revision)
591
 
            return self.repository.fetch(from_branch.repository,
592
 
                                         revision_id=last_revision,
593
 
                                         pb=pb)
594
 
        finally:
595
 
            from_branch.unlock()
 
677
        return InterBranch.get(from_branch, self).fetch(last_revision, limit=limit)
596
678
 
597
679
    def get_bound_location(self):
598
680
        """Return the URL of the branch we are bound to.
605
687
    def get_old_bound_location(self):
606
688
        """Return the URL of the branch we used to be bound to
607
689
        """
608
 
        raise errors.UpgradeRequired(self.base)
 
690
        raise errors.UpgradeRequired(self.user_url)
609
691
 
610
692
    def get_commit_builder(self, parents, config=None, timestamp=None,
611
693
                           timezone=None, committer=None, revprops=None,
612
 
                           revision_id=None):
 
694
                           revision_id=None, lossy=False):
613
695
        """Obtain a CommitBuilder for this branch.
614
696
 
615
697
        :param parents: Revision ids of the parents of the new revision.
619
701
        :param committer: Optional committer to set for commit.
620
702
        :param revprops: Optional dictionary of revision properties.
621
703
        :param revision_id: Optional revision id.
 
704
        :param lossy: Whether to discard data that can not be natively
 
705
            represented, when pushing to a foreign VCS 
622
706
        """
623
707
 
624
708
        if config is None:
625
709
            config = self.get_config()
626
710
 
627
711
        return self.repository.get_commit_builder(self, parents, config,
628
 
            timestamp, timezone, committer, revprops, revision_id)
 
712
            timestamp, timezone, committer, revprops, revision_id,
 
713
            lossy)
629
714
 
630
715
    def get_master_branch(self, possible_transports=None):
631
716
        """Return the branch we are bound to.
658
743
        """Print `file` to stdout."""
659
744
        raise NotImplementedError(self.print_file)
660
745
 
 
746
    @deprecated_method(deprecated_in((2, 4, 0)))
661
747
    def set_revision_history(self, rev_history):
662
 
        raise NotImplementedError(self.set_revision_history)
 
748
        """See Branch.set_revision_history."""
 
749
        self._set_revision_history(rev_history)
 
750
 
 
751
    @needs_write_lock
 
752
    def _set_revision_history(self, rev_history):
 
753
        if len(rev_history) == 0:
 
754
            revid = _mod_revision.NULL_REVISION
 
755
        else:
 
756
            revid = rev_history[-1]
 
757
        if rev_history != self._lefthand_history(revid):
 
758
            raise errors.NotLefthandHistory(rev_history)
 
759
        self.set_last_revision_info(len(rev_history), revid)
 
760
        self._cache_revision_history(rev_history)
 
761
        for hook in Branch.hooks['set_rh']:
 
762
            hook(self, rev_history)
 
763
 
 
764
    @needs_write_lock
 
765
    def set_last_revision_info(self, revno, revision_id):
 
766
        """Set the last revision of this branch.
 
767
 
 
768
        The caller is responsible for checking that the revno is correct
 
769
        for this revision id.
 
770
 
 
771
        It may be possible to set the branch last revision to an id not
 
772
        present in the repository.  However, branches can also be
 
773
        configured to check constraints on history, in which case this may not
 
774
        be permitted.
 
775
        """
 
776
        raise NotImplementedError(self.set_last_revision_info)
 
777
 
 
778
    @needs_write_lock
 
779
    def generate_revision_history(self, revision_id, last_rev=None,
 
780
                                  other_branch=None):
 
781
        """See Branch.generate_revision_history"""
 
782
        graph = self.repository.get_graph()
 
783
        (last_revno, last_revid) = self.last_revision_info()
 
784
        known_revision_ids = [
 
785
            (last_revid, last_revno),
 
786
            (_mod_revision.NULL_REVISION, 0),
 
787
            ]
 
788
        if last_rev is not None:
 
789
            if not graph.is_ancestor(last_rev, revision_id):
 
790
                # our previous tip is not merged into stop_revision
 
791
                raise errors.DivergedBranches(self, other_branch)
 
792
        revno = graph.find_distance_to_null(revision_id, known_revision_ids)
 
793
        self.set_last_revision_info(revno, revision_id)
663
794
 
664
795
    @needs_write_lock
665
796
    def set_parent(self, url):
689
820
            stacking.
690
821
        """
691
822
        if not self._format.supports_stacking():
692
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
823
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
693
824
        # XXX: Changing from one fallback repository to another does not check
694
825
        # that all the data you need is present in the new fallback.
695
826
        # Possibly it should.
709
840
 
710
841
    def _unstack(self):
711
842
        """Change a branch to be unstacked, copying data as needed.
712
 
        
 
843
 
713
844
        Don't call this directly, use set_stacked_on_url(None).
714
845
        """
715
846
        pb = ui.ui_factory.nested_progress_bar()
724
855
            old_repository = self.repository
725
856
            if len(old_repository._fallback_repositories) != 1:
726
857
                raise AssertionError("can't cope with fallback repositories "
727
 
                    "of %r" % (self.repository,))
728
 
            # unlock it, including unlocking the fallback
 
858
                    "of %r (fallbacks: %r)" % (old_repository,
 
859
                        old_repository._fallback_repositories))
 
860
            # Open the new repository object.
 
861
            # Repositories don't offer an interface to remove fallback
 
862
            # repositories today; take the conceptually simpler option and just
 
863
            # reopen it.  We reopen it starting from the URL so that we
 
864
            # get a separate connection for RemoteRepositories and can
 
865
            # stream from one of them to the other.  This does mean doing
 
866
            # separate SSH connection setup, but unstacking is not a
 
867
            # common operation so it's tolerable.
 
868
            new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
869
            new_repository = new_bzrdir.find_repository()
 
870
            if new_repository._fallback_repositories:
 
871
                raise AssertionError("didn't expect %r to have "
 
872
                    "fallback_repositories"
 
873
                    % (self.repository,))
 
874
            # Replace self.repository with the new repository.
 
875
            # Do our best to transfer the lock state (i.e. lock-tokens and
 
876
            # lock count) of self.repository to the new repository.
 
877
            lock_token = old_repository.lock_write().repository_token
 
878
            self.repository = new_repository
 
879
            if isinstance(self, remote.RemoteBranch):
 
880
                # Remote branches can have a second reference to the old
 
881
                # repository that need to be replaced.
 
882
                if self._real_branch is not None:
 
883
                    self._real_branch.repository = new_repository
 
884
            self.repository.lock_write(token=lock_token)
 
885
            if lock_token is not None:
 
886
                old_repository.leave_lock_in_place()
729
887
            old_repository.unlock()
 
888
            if lock_token is not None:
 
889
                # XXX: self.repository.leave_lock_in_place() before this
 
890
                # function will not be preserved.  Fortunately that doesn't
 
891
                # affect the current default format (2a), and would be a
 
892
                # corner-case anyway.
 
893
                #  - Andrew Bennetts, 2010/06/30
 
894
                self.repository.dont_leave_lock_in_place()
 
895
            old_lock_count = 0
 
896
            while True:
 
897
                try:
 
898
                    old_repository.unlock()
 
899
                except errors.LockNotHeld:
 
900
                    break
 
901
                old_lock_count += 1
 
902
            if old_lock_count == 0:
 
903
                raise AssertionError(
 
904
                    'old_repository should have been locked at least once.')
 
905
            for i in range(old_lock_count-1):
 
906
                self.repository.lock_write()
 
907
            # Fetch from the old repository into the new.
730
908
            old_repository.lock_read()
731
909
            try:
732
 
                # Repositories don't offer an interface to remove fallback
733
 
                # repositories today; take the conceptually simpler option and just
734
 
                # reopen it.  We reopen it starting from the URL so that we
735
 
                # get a separate connection for RemoteRepositories and can
736
 
                # stream from one of them to the other.  This does mean doing
737
 
                # separate SSH connection setup, but unstacking is not a
738
 
                # common operation so it's tolerable.
739
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
 
                new_repository = new_bzrdir.find_repository()
741
 
                self.repository = new_repository
742
 
                if self.repository._fallback_repositories:
743
 
                    raise AssertionError("didn't expect %r to have "
744
 
                        "fallback_repositories"
745
 
                        % (self.repository,))
746
 
                # this is not paired with an unlock because it's just restoring
747
 
                # the previous state; the lock's released when set_stacked_on_url
748
 
                # returns
749
 
                self.repository.lock_write()
750
910
                # XXX: If you unstack a branch while it has a working tree
751
911
                # with a pending merge, the pending-merged revisions will no
752
912
                # longer be present.  You can (probably) revert and remerge.
753
 
                #
754
 
                # XXX: This only fetches up to the tip of the repository; it
755
 
                # doesn't bring across any tags.  That's fairly consistent
756
 
                # with how branch works, but perhaps not ideal.
757
 
                self.repository.fetch(old_repository,
758
 
                    revision_id=self.last_revision(),
759
 
                    find_ghosts=True)
 
913
                try:
 
914
                    tags_to_fetch = set(self.tags.get_reverse_tag_dict())
 
915
                except errors.TagsNotSupported:
 
916
                    tags_to_fetch = set()
 
917
                fetch_spec = _mod_graph.NotInOtherForRevs(self.repository,
 
918
                    old_repository, required_ids=[self.last_revision()],
 
919
                    if_present_ids=tags_to_fetch, find_ghosts=True).execute()
 
920
                self.repository.fetch(old_repository, fetch_spec=fetch_spec)
760
921
            finally:
761
922
                old_repository.unlock()
762
923
        finally:
767
928
 
768
929
        :seealso: Branch._get_tags_bytes.
769
930
        """
770
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
771
 
            'tags', bytes)
 
931
        op = cleanup.OperationWithCleanups(self._set_tags_bytes_locked)
 
932
        op.add_cleanup(self.lock_write().unlock)
 
933
        return op.run_simple(bytes)
 
934
 
 
935
    def _set_tags_bytes_locked(self, bytes):
 
936
        self._tags_bytes = bytes
 
937
        return self._transport.put_bytes('tags', bytes)
772
938
 
773
939
    def _cache_revision_history(self, rev_history):
774
940
        """Set the cached revision history to rev_history.
801
967
        self._revision_history_cache = None
802
968
        self._revision_id_to_revno_cache = None
803
969
        self._last_revision_info_cache = None
 
970
        self._master_branch_cache = None
804
971
        self._merge_sorted_revisions_cache = None
805
972
        self._partial_revision_history_cache = []
806
973
        self._partial_revision_id_to_revno_cache = {}
 
974
        self._tags_bytes = None
807
975
 
808
976
    def _gen_revision_history(self):
809
977
        """Return sequence of revision hashes on to this branch.
846
1014
 
847
1015
    def unbind(self):
848
1016
        """Older format branches cannot bind or unbind."""
849
 
        raise errors.UpgradeRequired(self.base)
 
1017
        raise errors.UpgradeRequired(self.user_url)
850
1018
 
851
1019
    def last_revision(self):
852
1020
        """Return last revision id, or NULL_REVISION."""
859
1027
        :return: A tuple (revno, revision_id).
860
1028
        """
861
1029
        if self._last_revision_info_cache is None:
862
 
            self._last_revision_info_cache = self._last_revision_info()
 
1030
            self._last_revision_info_cache = self._read_last_revision_info()
863
1031
        return self._last_revision_info_cache
864
1032
 
865
 
    def _last_revision_info(self):
866
 
        rh = self.revision_history()
867
 
        revno = len(rh)
868
 
        if revno:
869
 
            return (revno, rh[-1])
870
 
        else:
871
 
            return (0, _mod_revision.NULL_REVISION)
872
 
 
873
 
    @deprecated_method(deprecated_in((1, 6, 0)))
874
 
    def missing_revisions(self, other, stop_revision=None):
875
 
        """Return a list of new revisions that would perfectly fit.
876
 
 
877
 
        If self and other have not diverged, return a list of the revisions
878
 
        present in other, but missing from self.
879
 
        """
880
 
        self_history = self.revision_history()
881
 
        self_len = len(self_history)
882
 
        other_history = other.revision_history()
883
 
        other_len = len(other_history)
884
 
        common_index = min(self_len, other_len) -1
885
 
        if common_index >= 0 and \
886
 
            self_history[common_index] != other_history[common_index]:
887
 
            raise errors.DivergedBranches(self, other)
888
 
 
889
 
        if stop_revision is None:
890
 
            stop_revision = other_len
891
 
        else:
892
 
            if stop_revision > other_len:
893
 
                raise errors.NoSuchRevision(self, stop_revision)
894
 
        return other_history[self_len:stop_revision]
895
 
 
896
 
    @needs_write_lock
897
 
    def update_revisions(self, other, stop_revision=None, overwrite=False,
898
 
                         graph=None):
899
 
        """Pull in new perfect-fit revisions.
900
 
 
901
 
        :param other: Another Branch to pull from
902
 
        :param stop_revision: Updated until the given revision
903
 
        :param overwrite: Always set the branch pointer, rather than checking
904
 
            to see if it is a proper descendant.
905
 
        :param graph: A Graph object that can be used to query history
906
 
            information. This can be None.
907
 
        :return: None
908
 
        """
909
 
        return InterBranch.get(other, self).update_revisions(stop_revision,
910
 
            overwrite, graph)
911
 
 
 
1033
    def _read_last_revision_info(self):
 
1034
        raise NotImplementedError(self._read_last_revision_info)
 
1035
 
 
1036
    @deprecated_method(deprecated_in((2, 4, 0)))
912
1037
    def import_last_revision_info(self, source_repo, revno, revid):
913
1038
        """Set the last revision info, importing from another repo if necessary.
914
1039
 
915
 
        This is used by the bound branch code to upload a revision to
916
 
        the master branch first before updating the tip of the local branch.
917
 
 
918
1040
        :param source_repo: Source repository to optionally fetch from
919
1041
        :param revno: Revision number of the new tip
920
1042
        :param revid: Revision id of the new tip
923
1045
            self.repository.fetch(source_repo, revision_id=revid)
924
1046
        self.set_last_revision_info(revno, revid)
925
1047
 
 
1048
    def import_last_revision_info_and_tags(self, source, revno, revid,
 
1049
                                           lossy=False):
 
1050
        """Set the last revision info, importing from another repo if necessary.
 
1051
 
 
1052
        This is used by the bound branch code to upload a revision to
 
1053
        the master branch first before updating the tip of the local branch.
 
1054
        Revisions referenced by source's tags are also transferred.
 
1055
 
 
1056
        :param source: Source branch to optionally fetch from
 
1057
        :param revno: Revision number of the new tip
 
1058
        :param revid: Revision id of the new tip
 
1059
        :param lossy: Whether to discard metadata that can not be
 
1060
            natively represented
 
1061
        :return: Tuple with the new revision number and revision id
 
1062
            (should only be different from the arguments when lossy=True)
 
1063
        """
 
1064
        if not self.repository.has_same_location(source.repository):
 
1065
            self.fetch(source, revid)
 
1066
        self.set_last_revision_info(revno, revid)
 
1067
        return (revno, revid)
 
1068
 
926
1069
    def revision_id_to_revno(self, revision_id):
927
1070
        """Given a revision id, return its revno"""
928
1071
        if _mod_revision.is_null(revision_id):
948
1091
            self._extend_partial_history(distance_from_last)
949
1092
        return self._partial_revision_history_cache[distance_from_last]
950
1093
 
951
 
    @needs_write_lock
952
1094
    def pull(self, source, overwrite=False, stop_revision=None,
953
1095
             possible_transports=None, *args, **kwargs):
954
1096
        """Mirror source into this branch.
961
1103
            stop_revision=stop_revision,
962
1104
            possible_transports=possible_transports, *args, **kwargs)
963
1105
 
964
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
965
 
        **kwargs):
 
1106
    def push(self, target, overwrite=False, stop_revision=None, lossy=False,
 
1107
            *args, **kwargs):
966
1108
        """Mirror this branch into target.
967
1109
 
968
1110
        This branch is considered to be 'local', having low latency.
969
1111
        """
970
1112
        return InterBranch.get(self, target).push(overwrite, stop_revision,
971
 
            *args, **kwargs)
972
 
 
973
 
    def lossy_push(self, target, stop_revision=None):
974
 
        """Push deltas into another branch.
975
 
 
976
 
        :note: This does not, like push, retain the revision ids from 
977
 
            the source branch and will, rather than adding bzr-specific 
978
 
            metadata, push only those semantics of the revision that can be 
979
 
            natively represented by this branch' VCS.
980
 
 
981
 
        :param target: Target branch
982
 
        :param stop_revision: Revision to push, defaults to last revision.
983
 
        :return: BranchPushResult with an extra member revidmap: 
984
 
            A dictionary mapping revision ids from the target branch 
985
 
            to new revision ids in the target branch, for each 
986
 
            revision that was pushed.
987
 
        """
988
 
        inter = InterBranch.get(self, target)
989
 
        lossy_push = getattr(inter, "lossy_push", None)
990
 
        if lossy_push is None:
991
 
            raise errors.LossyPushToSameVCS(self, target)
992
 
        return lossy_push(stop_revision)
 
1113
            lossy, *args, **kwargs)
993
1114
 
994
1115
    def basis_tree(self):
995
1116
        """Return `Tree` object for last revision."""
1012
1133
        try:
1013
1134
            return urlutils.join(self.base[:-1], parent)
1014
1135
        except errors.InvalidURLJoin, e:
1015
 
            raise errors.InaccessibleParent(parent, self.base)
 
1136
            raise errors.InaccessibleParent(parent, self.user_url)
1016
1137
 
1017
1138
    def _get_parent_location(self):
1018
1139
        raise NotImplementedError(self._get_parent_location)
1150
1271
        return result
1151
1272
 
1152
1273
    @needs_read_lock
1153
 
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
 
1274
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None,
 
1275
            repository=None):
1154
1276
        """Create a new line of development from the branch, into to_bzrdir.
1155
1277
 
1156
1278
        to_bzrdir controls the branch format.
1161
1283
        if (repository_policy is not None and
1162
1284
            repository_policy.requires_stacking()):
1163
1285
            to_bzrdir._format.require_stacking(_skip_repo=True)
1164
 
        result = to_bzrdir.create_branch()
 
1286
        result = to_bzrdir.create_branch(repository=repository)
1165
1287
        result.lock_write()
1166
1288
        try:
1167
1289
            if repository_policy is not None:
1168
1290
                repository_policy.configure_branch(result)
1169
1291
            self.copy_content_into(result, revision_id=revision_id)
1170
 
            result.set_parent(self.bzrdir.root_transport.base)
 
1292
            master_url = self.get_bound_location()
 
1293
            if master_url is None:
 
1294
                result.set_parent(self.bzrdir.root_transport.base)
 
1295
            else:
 
1296
                result.set_parent(master_url)
1171
1297
        finally:
1172
1298
            result.unlock()
1173
1299
        return result
1197
1323
                revno = 1
1198
1324
        destination.set_last_revision_info(revno, revision_id)
1199
1325
 
1200
 
    @needs_read_lock
1201
1326
    def copy_content_into(self, destination, revision_id=None):
1202
1327
        """Copy the content of self into destination.
1203
1328
 
1204
1329
        revision_id: if not None, the revision history in the new branch will
1205
1330
                     be truncated to end with revision_id.
1206
1331
        """
1207
 
        self.update_references(destination)
1208
 
        self._synchronize_history(destination, revision_id)
1209
 
        try:
1210
 
            parent = self.get_parent()
1211
 
        except errors.InaccessibleParent, e:
1212
 
            mutter('parent was not accessible to copy: %s', e)
1213
 
        else:
1214
 
            if parent:
1215
 
                destination.set_parent(parent)
1216
 
        if self._push_should_merge_tags():
1217
 
            self.tags.merge_to(destination.tags)
 
1332
        return InterBranch.get(self, destination).copy_content_into(
 
1333
            revision_id=revision_id)
1218
1334
 
1219
1335
    def update_references(self, target):
1220
1336
        if not getattr(self._format, 'supports_reference_locations', False):
1265
1381
        """Return the most suitable metadir for a checkout of this branch.
1266
1382
        Weaves are used if this branch's repository uses weaves.
1267
1383
        """
1268
 
        if isinstance(self.bzrdir, bzrdir.BzrDirPreSplitOut):
1269
 
            from bzrlib.repofmt import weaverepo
1270
 
            format = bzrdir.BzrDirMetaFormat1()
1271
 
            format.repository_format = weaverepo.RepositoryFormat7()
1272
 
        else:
1273
 
            format = self.repository.bzrdir.checkout_metadir()
1274
 
            format.set_branch_format(self._format)
 
1384
        format = self.repository.bzrdir.checkout_metadir()
 
1385
        format.set_branch_format(self._format)
1275
1386
        return format
1276
1387
 
1277
1388
    def create_clone_on_transport(self, to_transport, revision_id=None,
1278
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1389
        stacked_on=None, create_prefix=False, use_existing_dir=False,
 
1390
        no_tree=None):
1279
1391
        """Create a clone of this branch and its bzrdir.
1280
1392
 
1281
1393
        :param to_transport: The transport to clone onto.
1288
1400
        """
1289
1401
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1290
1402
        # clone call. Or something. 20090224 RBC/spiv.
 
1403
        # XXX: Should this perhaps clone colocated branches as well, 
 
1404
        # rather than just the default branch? 20100319 JRV
1291
1405
        if revision_id is None:
1292
1406
            revision_id = self.last_revision()
1293
1407
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
1408
            revision_id=revision_id, stacked_on=stacked_on,
1295
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1409
            create_prefix=create_prefix, use_existing_dir=use_existing_dir,
 
1410
            no_tree=no_tree)
1296
1411
        return dir_to.open_branch()
1297
1412
 
1298
1413
    def create_checkout(self, to_location, revision_id=None,
1303
1418
        :param to_location: The url to produce the checkout at
1304
1419
        :param revision_id: The revision to check out
1305
1420
        :param lightweight: If True, produce a lightweight checkout, otherwise,
1306
 
        produce a bound branch (heavyweight checkout)
 
1421
            produce a bound branch (heavyweight checkout)
1307
1422
        :param accelerator_tree: A tree which can be used for retrieving file
1308
1423
            contents more quickly than the revision tree, i.e. a workingtree.
1309
1424
            The revision tree will be used for cases where accelerator_tree's
1317
1432
        if lightweight:
1318
1433
            format = self._get_checkout_format()
1319
1434
            checkout = format.initialize_on_transport(t)
1320
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1435
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1436
                target_branch=self)
1321
1437
        else:
1322
1438
            format = self._get_checkout_format()
1323
1439
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1354
1470
 
1355
1471
    def reference_parent(self, file_id, path, possible_transports=None):
1356
1472
        """Return the parent branch for a tree-reference file_id
 
1473
 
1357
1474
        :param file_id: The file_id of the tree reference
1358
1475
        :param path: The path of the file_id in the tree
1359
1476
        :return: A branch associated with the file_id
1365
1482
    def supports_tags(self):
1366
1483
        return self._format.supports_tags()
1367
1484
 
 
1485
    def automatic_tag_name(self, revision_id):
 
1486
        """Try to automatically find the tag name for a revision.
 
1487
 
 
1488
        :param revision_id: Revision id of the revision.
 
1489
        :return: A tag name or None if no tag name could be determined.
 
1490
        """
 
1491
        for hook in Branch.hooks['automatic_tag_name']:
 
1492
            ret = hook(self, revision_id)
 
1493
            if ret is not None:
 
1494
                return ret
 
1495
        return None
 
1496
 
1368
1497
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1369
1498
                                         other_branch):
1370
1499
        """Ensure that revision_b is a descendant of revision_a.
1400
1529
        else:
1401
1530
            raise AssertionError("invalid heads: %r" % (heads,))
1402
1531
 
1403
 
 
1404
 
class BranchFormat(object):
 
1532
    def heads_to_fetch(self):
 
1533
        """Return the heads that must and that should be fetched to copy this
 
1534
        branch into another repo.
 
1535
 
 
1536
        :returns: a 2-tuple of (must_fetch, if_present_fetch).  must_fetch is a
 
1537
            set of heads that must be fetched.  if_present_fetch is a set of
 
1538
            heads that must be fetched if present, but no error is necessary if
 
1539
            they are not present.
 
1540
        """
 
1541
        # For bzr native formats must_fetch is just the tip, and if_present_fetch
 
1542
        # are the tags.
 
1543
        must_fetch = set([self.last_revision()])
 
1544
        if_present_fetch = set()
 
1545
        c = self.get_config()
 
1546
        include_tags = c.get_user_option_as_bool('branch.fetch_tags',
 
1547
                                                 default=False)
 
1548
        if include_tags:
 
1549
            try:
 
1550
                if_present_fetch = set(self.tags.get_reverse_tag_dict())
 
1551
            except errors.TagsNotSupported:
 
1552
                pass
 
1553
        must_fetch.discard(_mod_revision.NULL_REVISION)
 
1554
        if_present_fetch.discard(_mod_revision.NULL_REVISION)
 
1555
        return must_fetch, if_present_fetch
 
1556
 
 
1557
 
 
1558
class BranchFormat(controldir.ControlComponentFormat):
1405
1559
    """An encapsulation of the initialization and open routines for a format.
1406
1560
 
1407
1561
    Formats provide three things:
1410
1564
     * an open routine.
1411
1565
 
1412
1566
    Formats are placed in an dict by their format string for reference
1413
 
    during branch opening. Its not required that these be instances, they
 
1567
    during branch opening. It's not required that these be instances, they
1414
1568
    can be classes themselves with class methods - it simply depends on
1415
1569
    whether state is needed for a given format or not.
1416
1570
 
1419
1573
    object will be created every time regardless.
1420
1574
    """
1421
1575
 
1422
 
    _default_format = None
1423
 
    """The default format used for new branches."""
1424
 
 
1425
 
    _formats = {}
1426
 
    """The known formats."""
1427
 
 
1428
1576
    can_set_append_revisions_only = True
1429
1577
 
1430
1578
    def __eq__(self, other):
1434
1582
        return not (self == other)
1435
1583
 
1436
1584
    @classmethod
1437
 
    def find_format(klass, a_bzrdir):
 
1585
    def find_format(klass, a_bzrdir, name=None):
1438
1586
        """Return the format for the branch object in a_bzrdir."""
1439
1587
        try:
1440
 
            transport = a_bzrdir.get_branch_transport(None)
 
1588
            transport = a_bzrdir.get_branch_transport(None, name=name)
1441
1589
            format_string = transport.get_bytes("format")
1442
 
            return klass._formats[format_string]
 
1590
            return format_registry.get(format_string)
1443
1591
        except errors.NoSuchFile:
1444
1592
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1445
1593
        except KeyError:
1446
1594
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1447
1595
 
1448
1596
    @classmethod
 
1597
    @deprecated_method(deprecated_in((2, 4, 0)))
1449
1598
    def get_default_format(klass):
1450
1599
        """Return the current default format."""
1451
 
        return klass._default_format
1452
 
 
1453
 
    def get_reference(self, a_bzrdir):
 
1600
        return format_registry.get_default()
 
1601
 
 
1602
    @classmethod
 
1603
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1604
    def get_formats(klass):
 
1605
        """Get all the known formats.
 
1606
 
 
1607
        Warning: This triggers a load of all lazy registered formats: do not
 
1608
        use except when that is desireed.
 
1609
        """
 
1610
        return format_registry._get_all()
 
1611
 
 
1612
    def get_reference(self, a_bzrdir, name=None):
1454
1613
        """Get the target reference of the branch in a_bzrdir.
1455
1614
 
1456
1615
        format probing must have been completed before calling
1458
1617
        in a_bzrdir is correct.
1459
1618
 
1460
1619
        :param a_bzrdir: The bzrdir to get the branch data from.
 
1620
        :param name: Name of the colocated branch to fetch
1461
1621
        :return: None if the branch is not a reference branch.
1462
1622
        """
1463
1623
        return None
1464
1624
 
1465
1625
    @classmethod
1466
 
    def set_reference(self, a_bzrdir, to_branch):
 
1626
    def set_reference(self, a_bzrdir, name, to_branch):
1467
1627
        """Set the target reference of the branch in a_bzrdir.
1468
1628
 
1469
1629
        format probing must have been completed before calling
1471
1631
        in a_bzrdir is correct.
1472
1632
 
1473
1633
        :param a_bzrdir: The bzrdir to set the branch reference for.
 
1634
        :param name: Name of colocated branch to set, None for default
1474
1635
        :param to_branch: branch that the checkout is to reference
1475
1636
        """
1476
1637
        raise NotImplementedError(self.set_reference)
1483
1644
        """Return the short format description for this format."""
1484
1645
        raise NotImplementedError(self.get_format_description)
1485
1646
 
1486
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1487
 
                           set_format=True):
1488
 
        """Initialize a branch in a bzrdir, with specified files
 
1647
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1648
        hooks = Branch.hooks['post_branch_init']
 
1649
        if not hooks:
 
1650
            return
 
1651
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1652
        for hook in hooks:
 
1653
            hook(params)
1489
1654
 
1490
 
        :param a_bzrdir: The bzrdir to initialize the branch in
1491
 
        :param utf8_files: The files to create as a list of
1492
 
            (filename, content) tuples
1493
 
        :param set_format: If True, set the format with
1494
 
            self.get_format_string.  (BzrBranch4 has its format set
1495
 
            elsewhere)
1496
 
        :return: a branch in this format
 
1655
    def initialize(self, a_bzrdir, name=None, repository=None):
 
1656
        """Create a branch of this format in a_bzrdir.
 
1657
        
 
1658
        :param name: Name of the colocated branch to create.
1497
1659
        """
1498
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1499
 
        branch_transport = a_bzrdir.get_branch_transport(self)
1500
 
        lock_map = {
1501
 
            'metadir': ('lock', lockdir.LockDir),
1502
 
            'branch4': ('branch-lock', lockable_files.TransportLock),
1503
 
        }
1504
 
        lock_name, lock_class = lock_map[lock_type]
1505
 
        control_files = lockable_files.LockableFiles(branch_transport,
1506
 
            lock_name, lock_class)
1507
 
        control_files.create_lock()
1508
 
        try:
1509
 
            control_files.lock_write()
1510
 
        except errors.LockContention:
1511
 
            if lock_type != 'branch4':
1512
 
                raise
1513
 
            lock_taken = False
1514
 
        else:
1515
 
            lock_taken = True
1516
 
        if set_format:
1517
 
            utf8_files += [('format', self.get_format_string())]
1518
 
        try:
1519
 
            for (filename, content) in utf8_files:
1520
 
                branch_transport.put_bytes(
1521
 
                    filename, content,
1522
 
                    mode=a_bzrdir._get_file_mode())
1523
 
        finally:
1524
 
            if lock_taken:
1525
 
                control_files.unlock()
1526
 
        return self.open(a_bzrdir, _found=True)
1527
 
 
1528
 
    def initialize(self, a_bzrdir):
1529
 
        """Create a branch of this format in a_bzrdir."""
1530
1660
        raise NotImplementedError(self.initialize)
1531
1661
 
1532
1662
    def is_supported(self):
1562
1692
        """
1563
1693
        raise NotImplementedError(self.network_name)
1564
1694
 
1565
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1695
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
1696
            found_repository=None):
1566
1697
        """Return the branch object for a_bzrdir
1567
1698
 
1568
1699
        :param a_bzrdir: A BzrDir that contains a branch.
 
1700
        :param name: Name of colocated branch to open
1569
1701
        :param _found: a private parameter, do not use it. It is used to
1570
1702
            indicate if format probing has already be done.
1571
1703
        :param ignore_fallbacks: when set, no fallback branches will be opened
1574
1706
        raise NotImplementedError(self.open)
1575
1707
 
1576
1708
    @classmethod
 
1709
    @deprecated_method(deprecated_in((2, 4, 0)))
1577
1710
    def register_format(klass, format):
1578
 
        """Register a metadir format."""
1579
 
        klass._formats[format.get_format_string()] = format
1580
 
        # Metadir formats have a network name of their format string, and get
1581
 
        # registered as class factories.
1582
 
        network_format_registry.register(format.get_format_string(), format.__class__)
 
1711
        """Register a metadir format.
 
1712
 
 
1713
        See MetaDirBranchFormatFactory for the ability to register a format
 
1714
        without loading the code the format needs until it is actually used.
 
1715
        """
 
1716
        format_registry.register(format)
1583
1717
 
1584
1718
    @classmethod
 
1719
    @deprecated_method(deprecated_in((2, 4, 0)))
1585
1720
    def set_default_format(klass, format):
1586
 
        klass._default_format = format
 
1721
        format_registry.set_default(format)
1587
1722
 
1588
1723
    def supports_set_append_revisions_only(self):
1589
1724
        """True if this format supports set_append_revisions_only."""
1593
1728
        """True if this format records a stacked-on branch."""
1594
1729
        return False
1595
1730
 
 
1731
    def supports_leaving_lock(self):
 
1732
        """True if this format supports leaving locks in place."""
 
1733
        return False # by default
 
1734
 
1596
1735
    @classmethod
 
1736
    @deprecated_method(deprecated_in((2, 4, 0)))
1597
1737
    def unregister_format(klass, format):
1598
 
        del klass._formats[format.get_format_string()]
 
1738
        format_registry.remove(format)
1599
1739
 
1600
1740
    def __str__(self):
1601
1741
        return self.get_format_description().rstrip()
1605
1745
        return False  # by default
1606
1746
 
1607
1747
 
 
1748
class MetaDirBranchFormatFactory(registry._LazyObjectGetter):
 
1749
    """A factory for a BranchFormat object, permitting simple lazy registration.
 
1750
    
 
1751
    While none of the built in BranchFormats are lazy registered yet,
 
1752
    bzrlib.tests.test_branch.TestMetaDirBranchFormatFactory demonstrates how to
 
1753
    use it, and the bzr-loom plugin uses it as well (see
 
1754
    bzrlib.plugins.loom.formats).
 
1755
    """
 
1756
 
 
1757
    def __init__(self, format_string, module_name, member_name):
 
1758
        """Create a MetaDirBranchFormatFactory.
 
1759
 
 
1760
        :param format_string: The format string the format has.
 
1761
        :param module_name: Module to load the format class from.
 
1762
        :param member_name: Attribute name within the module for the format class.
 
1763
        """
 
1764
        registry._LazyObjectGetter.__init__(self, module_name, member_name)
 
1765
        self._format_string = format_string
 
1766
        
 
1767
    def get_format_string(self):
 
1768
        """See BranchFormat.get_format_string."""
 
1769
        return self._format_string
 
1770
 
 
1771
    def __call__(self):
 
1772
        """Used for network_format_registry support."""
 
1773
        return self.get_obj()()
 
1774
 
 
1775
 
1608
1776
class BranchHooks(Hooks):
1609
1777
    """A dictionary mapping hook name to a list of callables for branch hooks.
1610
1778
 
1618
1786
        These are all empty initially, because by default nothing should get
1619
1787
        notified.
1620
1788
        """
1621
 
        Hooks.__init__(self)
1622
 
        self.create_hook(HookPoint('set_rh',
 
1789
        Hooks.__init__(self, "bzrlib.branch", "Branch.hooks")
 
1790
        self.add_hook('set_rh',
1623
1791
            "Invoked whenever the revision history has been set via "
1624
1792
            "set_revision_history. The api signature is (branch, "
1625
1793
            "revision_history), and the branch will be write-locked. "
1626
1794
            "The set_rh hook can be expensive for bzr to trigger, a better "
1627
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
 
        self.create_hook(HookPoint('open',
 
1795
            "hook to use is Branch.post_change_branch_tip.", (0, 15))
 
1796
        self.add_hook('open',
1629
1797
            "Called with the Branch object that has been opened after a "
1630
 
            "branch is opened.", (1, 8), None))
1631
 
        self.create_hook(HookPoint('post_push',
 
1798
            "branch is opened.", (1, 8))
 
1799
        self.add_hook('post_push',
1632
1800
            "Called after a push operation completes. post_push is called "
1633
1801
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
 
            "bzr client.", (0, 15), None))
1635
 
        self.create_hook(HookPoint('post_pull',
 
1802
            "bzr client.", (0, 15))
 
1803
        self.add_hook('post_pull',
1636
1804
            "Called after a pull operation completes. post_pull is called "
1637
1805
            "with a bzrlib.branch.PullResult object and only runs in the "
1638
 
            "bzr client.", (0, 15), None))
1639
 
        self.create_hook(HookPoint('pre_commit',
1640
 
            "Called after a commit is calculated but before it is is "
 
1806
            "bzr client.", (0, 15))
 
1807
        self.add_hook('pre_commit',
 
1808
            "Called after a commit is calculated but before it is "
1641
1809
            "completed. pre_commit is called with (local, master, old_revno, "
1642
1810
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
1811
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1645
1813
            "basis revision. hooks MUST NOT modify this delta. "
1646
1814
            " future_tree is an in-memory tree obtained from "
1647
1815
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
 
            "tree.", (0,91), None))
1649
 
        self.create_hook(HookPoint('post_commit',
 
1816
            "tree.", (0,91))
 
1817
        self.add_hook('post_commit',
1650
1818
            "Called in the bzr client after a commit has completed. "
1651
1819
            "post_commit is called with (local, master, old_revno, old_revid, "
1652
1820
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
 
            "commit to a branch.", (0, 15), None))
1654
 
        self.create_hook(HookPoint('post_uncommit',
 
1821
            "commit to a branch.", (0, 15))
 
1822
        self.add_hook('post_uncommit',
1655
1823
            "Called in the bzr client after an uncommit completes. "
1656
1824
            "post_uncommit is called with (local, master, old_revno, "
1657
1825
            "old_revid, new_revno, new_revid) where local is the local branch "
1658
1826
            "or None, master is the target branch, and an empty branch "
1659
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
 
        self.create_hook(HookPoint('pre_change_branch_tip',
 
1827
            "receives new_revno of 0, new_revid of None.", (0, 15))
 
1828
        self.add_hook('pre_change_branch_tip',
1661
1829
            "Called in bzr client and server before a change to the tip of a "
1662
1830
            "branch is made. pre_change_branch_tip is called with a "
1663
1831
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1665
 
        self.create_hook(HookPoint('post_change_branch_tip',
 
1832
            "commit, uncommit will all trigger this hook.", (1, 6))
 
1833
        self.add_hook('post_change_branch_tip',
1666
1834
            "Called in bzr client and server after a change to the tip of a "
1667
1835
            "branch is made. post_change_branch_tip is called with a "
1668
1836
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1670
 
        self.create_hook(HookPoint('transform_fallback_location',
 
1837
            "commit, uncommit will all trigger this hook.", (1, 4))
 
1838
        self.add_hook('transform_fallback_location',
1671
1839
            "Called when a stacked branch is activating its fallback "
1672
1840
            "locations. transform_fallback_location is called with (branch, "
1673
1841
            "url), and should return a new url. Returning the same url "
1678
1846
            "fallback locations have not been activated. When there are "
1679
1847
            "multiple hooks installed for transform_fallback_location, "
1680
1848
            "all are called with the url returned from the previous hook."
1681
 
            "The order is however undefined.", (1, 9), None))
 
1849
            "The order is however undefined.", (1, 9))
 
1850
        self.add_hook('automatic_tag_name',
 
1851
            "Called to determine an automatic tag name for a revision. "
 
1852
            "automatic_tag_name is called with (branch, revision_id) and "
 
1853
            "should return a tag name or None if no tag name could be "
 
1854
            "determined. The first non-None tag name returned will be used.",
 
1855
            (2, 2))
 
1856
        self.add_hook('post_branch_init',
 
1857
            "Called after new branch initialization completes. "
 
1858
            "post_branch_init is called with a "
 
1859
            "bzrlib.branch.BranchInitHookParams. "
 
1860
            "Note that init, branch and checkout (both heavyweight and "
 
1861
            "lightweight) will all trigger this hook.", (2, 2))
 
1862
        self.add_hook('post_switch',
 
1863
            "Called after a checkout switches branch. "
 
1864
            "post_switch is called with a "
 
1865
            "bzrlib.branch.SwitchHookParams.", (2, 2))
 
1866
 
1682
1867
 
1683
1868
 
1684
1869
# install the default hooks into the Branch class.
1686
1871
 
1687
1872
 
1688
1873
class ChangeBranchTipParams(object):
1689
 
    """Object holding parameters passed to *_change_branch_tip hooks.
 
1874
    """Object holding parameters passed to `*_change_branch_tip` hooks.
1690
1875
 
1691
1876
    There are 5 fields that hooks may wish to access:
1692
1877
 
1723
1908
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1724
1909
 
1725
1910
 
1726
 
class BzrBranchFormat4(BranchFormat):
1727
 
    """Bzr branch format 4.
1728
 
 
1729
 
    This format has:
1730
 
     - a revision-history file.
1731
 
     - a branch-lock lock file [ to be shared with the bzrdir ]
1732
 
    """
1733
 
 
1734
 
    def get_format_description(self):
1735
 
        """See BranchFormat.get_format_description()."""
1736
 
        return "Branch format 4"
1737
 
 
1738
 
    def initialize(self, a_bzrdir):
1739
 
        """Create a branch of this format in a_bzrdir."""
1740
 
        utf8_files = [('revision-history', ''),
1741
 
                      ('branch-name', ''),
1742
 
                      ]
1743
 
        return self._initialize_helper(a_bzrdir, utf8_files,
1744
 
                                       lock_type='branch4', set_format=False)
1745
 
 
1746
 
    def __init__(self):
1747
 
        super(BzrBranchFormat4, self).__init__()
1748
 
        self._matchingbzrdir = bzrdir.BzrDirFormat6()
1749
 
 
1750
 
    def network_name(self):
1751
 
        """The network name for this format is the control dirs disk label."""
1752
 
        return self._matchingbzrdir.get_format_string()
1753
 
 
1754
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
 
        """See BranchFormat.open()."""
1756
 
        if not _found:
1757
 
            # we are being called directly and must probe.
1758
 
            raise NotImplementedError
1759
 
        return BzrBranch(_format=self,
1760
 
                         _control_files=a_bzrdir._control_files,
1761
 
                         a_bzrdir=a_bzrdir,
1762
 
                         _repository=a_bzrdir.open_repository())
1763
 
 
1764
 
    def __str__(self):
1765
 
        return "Bazaar-NG branch format 4"
 
1911
class BranchInitHookParams(object):
 
1912
    """Object holding parameters passed to `*_branch_init` hooks.
 
1913
 
 
1914
    There are 4 fields that hooks may wish to access:
 
1915
 
 
1916
    :ivar format: the branch format
 
1917
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1918
    :ivar name: name of colocated branch, if any (or None)
 
1919
    :ivar branch: the branch created
 
1920
 
 
1921
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1922
    the checkout, hence they are different from the corresponding fields in
 
1923
    branch, which refer to the original branch.
 
1924
    """
 
1925
 
 
1926
    def __init__(self, format, a_bzrdir, name, branch):
 
1927
        """Create a group of BranchInitHook parameters.
 
1928
 
 
1929
        :param format: the branch format
 
1930
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1931
            initialized
 
1932
        :param name: name of colocated branch, if any (or None)
 
1933
        :param branch: the branch created
 
1934
 
 
1935
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1936
        to the checkout, hence they are different from the corresponding fields
 
1937
        in branch, which refer to the original branch.
 
1938
        """
 
1939
        self.format = format
 
1940
        self.bzrdir = a_bzrdir
 
1941
        self.name = name
 
1942
        self.branch = branch
 
1943
 
 
1944
    def __eq__(self, other):
 
1945
        return self.__dict__ == other.__dict__
 
1946
 
 
1947
    def __repr__(self):
 
1948
        return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1949
 
 
1950
 
 
1951
class SwitchHookParams(object):
 
1952
    """Object holding parameters passed to `*_switch` hooks.
 
1953
 
 
1954
    There are 4 fields that hooks may wish to access:
 
1955
 
 
1956
    :ivar control_dir: BzrDir of the checkout to change
 
1957
    :ivar to_branch: branch that the checkout is to reference
 
1958
    :ivar force: skip the check for local commits in a heavy checkout
 
1959
    :ivar revision_id: revision ID to switch to (or None)
 
1960
    """
 
1961
 
 
1962
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1963
        """Create a group of SwitchHook parameters.
 
1964
 
 
1965
        :param control_dir: BzrDir of the checkout to change
 
1966
        :param to_branch: branch that the checkout is to reference
 
1967
        :param force: skip the check for local commits in a heavy checkout
 
1968
        :param revision_id: revision ID to switch to (or None)
 
1969
        """
 
1970
        self.control_dir = control_dir
 
1971
        self.to_branch = to_branch
 
1972
        self.force = force
 
1973
        self.revision_id = revision_id
 
1974
 
 
1975
    def __eq__(self, other):
 
1976
        return self.__dict__ == other.__dict__
 
1977
 
 
1978
    def __repr__(self):
 
1979
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
1980
            self.control_dir, self.to_branch,
 
1981
            self.revision_id)
1766
1982
 
1767
1983
 
1768
1984
class BranchFormatMetadir(BranchFormat):
1772
1988
        """What class to instantiate on open calls."""
1773
1989
        raise NotImplementedError(self._branch_class)
1774
1990
 
 
1991
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1992
                           repository=None):
 
1993
        """Initialize a branch in a bzrdir, with specified files
 
1994
 
 
1995
        :param a_bzrdir: The bzrdir to initialize the branch in
 
1996
        :param utf8_files: The files to create as a list of
 
1997
            (filename, content) tuples
 
1998
        :param name: Name of colocated branch to create, if any
 
1999
        :return: a branch in this format
 
2000
        """
 
2001
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
2002
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
2003
        control_files = lockable_files.LockableFiles(branch_transport,
 
2004
            'lock', lockdir.LockDir)
 
2005
        control_files.create_lock()
 
2006
        control_files.lock_write()
 
2007
        try:
 
2008
            utf8_files += [('format', self.get_format_string())]
 
2009
            for (filename, content) in utf8_files:
 
2010
                branch_transport.put_bytes(
 
2011
                    filename, content,
 
2012
                    mode=a_bzrdir._get_file_mode())
 
2013
        finally:
 
2014
            control_files.unlock()
 
2015
        branch = self.open(a_bzrdir, name, _found=True,
 
2016
                found_repository=repository)
 
2017
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2018
        return branch
 
2019
 
1775
2020
    def network_name(self):
1776
2021
        """A simple byte string uniquely identifying this format for RPC calls.
1777
2022
 
1779
2024
        """
1780
2025
        return self.get_format_string()
1781
2026
 
1782
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
2027
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False,
 
2028
            found_repository=None):
1783
2029
        """See BranchFormat.open()."""
1784
2030
        if not _found:
1785
 
            format = BranchFormat.find_format(a_bzrdir)
 
2031
            format = BranchFormat.find_format(a_bzrdir, name=name)
1786
2032
            if format.__class__ != self.__class__:
1787
2033
                raise AssertionError("wrong format %r found for %r" %
1788
2034
                    (format, self))
 
2035
        transport = a_bzrdir.get_branch_transport(None, name=name)
1789
2036
        try:
1790
 
            transport = a_bzrdir.get_branch_transport(None)
1791
2037
            control_files = lockable_files.LockableFiles(transport, 'lock',
1792
2038
                                                         lockdir.LockDir)
 
2039
            if found_repository is None:
 
2040
                found_repository = a_bzrdir.find_repository()
1793
2041
            return self._branch_class()(_format=self,
1794
2042
                              _control_files=control_files,
 
2043
                              name=name,
1795
2044
                              a_bzrdir=a_bzrdir,
1796
 
                              _repository=a_bzrdir.find_repository(),
 
2045
                              _repository=found_repository,
1797
2046
                              ignore_fallbacks=ignore_fallbacks)
1798
2047
        except errors.NoSuchFile:
1799
2048
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1806
2055
    def supports_tags(self):
1807
2056
        return True
1808
2057
 
 
2058
    def supports_leaving_lock(self):
 
2059
        return True
 
2060
 
1809
2061
 
1810
2062
class BzrBranchFormat5(BranchFormatMetadir):
1811
2063
    """Bzr branch format 5.
1831
2083
        """See BranchFormat.get_format_description()."""
1832
2084
        return "Branch format 5"
1833
2085
 
1834
 
    def initialize(self, a_bzrdir):
 
2086
    def initialize(self, a_bzrdir, name=None, repository=None):
1835
2087
        """Create a branch of this format in a_bzrdir."""
1836
2088
        utf8_files = [('revision-history', ''),
1837
2089
                      ('branch-name', ''),
1838
2090
                      ]
1839
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2091
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1840
2092
 
1841
2093
    def supports_tags(self):
1842
2094
        return False
1864
2116
        """See BranchFormat.get_format_description()."""
1865
2117
        return "Branch format 6"
1866
2118
 
1867
 
    def initialize(self, a_bzrdir):
 
2119
    def initialize(self, a_bzrdir, name=None, repository=None):
1868
2120
        """Create a branch of this format in a_bzrdir."""
1869
2121
        utf8_files = [('last-revision', '0 null:\n'),
1870
2122
                      ('branch.conf', ''),
1871
2123
                      ('tags', ''),
1872
2124
                      ]
1873
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2125
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1874
2126
 
1875
2127
    def make_tags(self, branch):
1876
2128
        """See bzrlib.branch.BranchFormat.make_tags()."""
1894
2146
        """See BranchFormat.get_format_description()."""
1895
2147
        return "Branch format 8"
1896
2148
 
1897
 
    def initialize(self, a_bzrdir):
 
2149
    def initialize(self, a_bzrdir, name=None, repository=None):
1898
2150
        """Create a branch of this format in a_bzrdir."""
1899
2151
        utf8_files = [('last-revision', '0 null:\n'),
1900
2152
                      ('branch.conf', ''),
1901
2153
                      ('tags', ''),
1902
2154
                      ('references', '')
1903
2155
                      ]
1904
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1905
 
 
1906
 
    def __init__(self):
1907
 
        super(BzrBranchFormat8, self).__init__()
1908
 
        self._matchingbzrdir.repository_format = \
1909
 
            RepositoryFormatKnitPack5RichRoot()
 
2156
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1910
2157
 
1911
2158
    def make_tags(self, branch):
1912
2159
        """See bzrlib.branch.BranchFormat.make_tags()."""
1921
2168
    supports_reference_locations = True
1922
2169
 
1923
2170
 
1924
 
class BzrBranchFormat7(BzrBranchFormat8):
 
2171
class BzrBranchFormat7(BranchFormatMetadir):
1925
2172
    """Branch format with last-revision, tags, and a stacked location pointer.
1926
2173
 
1927
2174
    The stacked location pointer is passed down to the repository and requires
1930
2177
    This format was introduced in bzr 1.6.
1931
2178
    """
1932
2179
 
1933
 
    def initialize(self, a_bzrdir):
 
2180
    def initialize(self, a_bzrdir, name=None, repository=None):
1934
2181
        """Create a branch of this format in a_bzrdir."""
1935
2182
        utf8_files = [('last-revision', '0 null:\n'),
1936
2183
                      ('branch.conf', ''),
1937
2184
                      ('tags', ''),
1938
2185
                      ]
1939
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2186
        return self._initialize_helper(a_bzrdir, utf8_files, name, repository)
1940
2187
 
1941
2188
    def _branch_class(self):
1942
2189
        return BzrBranch7
1952
2199
    def supports_set_append_revisions_only(self):
1953
2200
        return True
1954
2201
 
 
2202
    def supports_stacking(self):
 
2203
        return True
 
2204
 
 
2205
    def make_tags(self, branch):
 
2206
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
2207
        return BasicTags(branch)
 
2208
 
1955
2209
    supports_reference_locations = False
1956
2210
 
1957
2211
 
1974
2228
        """See BranchFormat.get_format_description()."""
1975
2229
        return "Checkout reference format 1"
1976
2230
 
1977
 
    def get_reference(self, a_bzrdir):
 
2231
    def get_reference(self, a_bzrdir, name=None):
1978
2232
        """See BranchFormat.get_reference()."""
1979
 
        transport = a_bzrdir.get_branch_transport(None)
 
2233
        transport = a_bzrdir.get_branch_transport(None, name=name)
1980
2234
        return transport.get_bytes('location')
1981
2235
 
1982
 
    def set_reference(self, a_bzrdir, to_branch):
 
2236
    def set_reference(self, a_bzrdir, name, to_branch):
1983
2237
        """See BranchFormat.set_reference()."""
1984
 
        transport = a_bzrdir.get_branch_transport(None)
 
2238
        transport = a_bzrdir.get_branch_transport(None, name=name)
1985
2239
        location = transport.put_bytes('location', to_branch.base)
1986
2240
 
1987
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2241
    def initialize(self, a_bzrdir, name=None, target_branch=None,
 
2242
            repository=None):
1988
2243
        """Create a branch of this format in a_bzrdir."""
1989
2244
        if target_branch is None:
1990
2245
            # this format does not implement branch itself, thus the implicit
1991
2246
            # creation contract must see it as uninitializable
1992
2247
            raise errors.UninitializableFormat(self)
1993
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1994
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2248
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2249
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1995
2250
        branch_transport.put_bytes('location',
1996
 
            target_branch.bzrdir.root_transport.base)
 
2251
            target_branch.bzrdir.user_url)
1997
2252
        branch_transport.put_bytes('format', self.get_format_string())
1998
 
        return self.open(
1999
 
            a_bzrdir, _found=True,
 
2253
        branch = self.open(
 
2254
            a_bzrdir, name, _found=True,
2000
2255
            possible_transports=[target_branch.bzrdir.root_transport])
 
2256
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2257
        return branch
2001
2258
 
2002
2259
    def __init__(self):
2003
2260
        super(BranchReferenceFormat, self).__init__()
2009
2266
        def clone(to_bzrdir, revision_id=None,
2010
2267
            repository_policy=None):
2011
2268
            """See Branch.clone()."""
2012
 
            return format.initialize(to_bzrdir, a_branch)
 
2269
            return format.initialize(to_bzrdir, target_branch=a_branch)
2013
2270
            # cannot obey revision_id limits when cloning a reference ...
2014
2271
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2015
2272
            # emit some sort of warning/error to the caller ?!
2016
2273
        return clone
2017
2274
 
2018
 
    def open(self, a_bzrdir, _found=False, location=None,
2019
 
             possible_transports=None, ignore_fallbacks=False):
 
2275
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
2276
             possible_transports=None, ignore_fallbacks=False,
 
2277
             found_repository=None):
2020
2278
        """Return the branch that the branch reference in a_bzrdir points at.
2021
2279
 
2022
2280
        :param a_bzrdir: A BzrDir that contains a branch.
 
2281
        :param name: Name of colocated branch to open, if any
2023
2282
        :param _found: a private parameter, do not use it. It is used to
2024
2283
            indicate if format probing has already be done.
2025
2284
        :param ignore_fallbacks: when set, no fallback branches will be opened
2030
2289
        :param possible_transports: An optional reusable transports list.
2031
2290
        """
2032
2291
        if not _found:
2033
 
            format = BranchFormat.find_format(a_bzrdir)
 
2292
            format = BranchFormat.find_format(a_bzrdir, name=name)
2034
2293
            if format.__class__ != self.__class__:
2035
2294
                raise AssertionError("wrong format %r found for %r" %
2036
2295
                    (format, self))
2037
2296
        if location is None:
2038
 
            location = self.get_reference(a_bzrdir)
 
2297
            location = self.get_reference(a_bzrdir, name)
2039
2298
        real_bzrdir = bzrdir.BzrDir.open(
2040
2299
            location, possible_transports=possible_transports)
2041
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2300
        result = real_bzrdir.open_branch(name=name, 
 
2301
            ignore_fallbacks=ignore_fallbacks)
2042
2302
        # this changes the behaviour of result.clone to create a new reference
2043
2303
        # rather than a copy of the content of the branch.
2044
2304
        # I did not use a proxy object because that needs much more extensive
2051
2311
        return result
2052
2312
 
2053
2313
 
 
2314
class BranchFormatRegistry(controldir.ControlComponentFormatRegistry):
 
2315
    """Branch format registry."""
 
2316
 
 
2317
    def __init__(self, other_registry=None):
 
2318
        super(BranchFormatRegistry, self).__init__(other_registry)
 
2319
        self._default_format = None
 
2320
 
 
2321
    def set_default(self, format):
 
2322
        self._default_format = format
 
2323
 
 
2324
    def get_default(self):
 
2325
        return self._default_format
 
2326
 
 
2327
 
2054
2328
network_format_registry = registry.FormatRegistry()
2055
2329
"""Registry of formats indexed by their network name.
2056
2330
 
2059
2333
BranchFormat.network_name() for more detail.
2060
2334
"""
2061
2335
 
 
2336
format_registry = BranchFormatRegistry(network_format_registry)
 
2337
 
2062
2338
 
2063
2339
# formats which have no format string are not discoverable
2064
2340
# and not independently creatable, so are not registered.
2066
2342
__format6 = BzrBranchFormat6()
2067
2343
__format7 = BzrBranchFormat7()
2068
2344
__format8 = BzrBranchFormat8()
2069
 
BranchFormat.register_format(__format5)
2070
 
BranchFormat.register_format(BranchReferenceFormat())
2071
 
BranchFormat.register_format(__format6)
2072
 
BranchFormat.register_format(__format7)
2073
 
BranchFormat.register_format(__format8)
2074
 
BranchFormat.set_default_format(__format7)
2075
 
_legacy_formats = [BzrBranchFormat4(),
2076
 
    ]
2077
 
network_format_registry.register(
2078
 
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
 
2345
format_registry.register(__format5)
 
2346
format_registry.register(BranchReferenceFormat())
 
2347
format_registry.register(__format6)
 
2348
format_registry.register(__format7)
 
2349
format_registry.register(__format8)
 
2350
format_registry.set_default(__format7)
 
2351
 
 
2352
 
 
2353
class BranchWriteLockResult(LogicalLockResult):
 
2354
    """The result of write locking a branch.
 
2355
 
 
2356
    :ivar branch_token: The token obtained from the underlying branch lock, or
 
2357
        None.
 
2358
    :ivar unlock: A callable which will unlock the lock.
 
2359
    """
 
2360
 
 
2361
    def __init__(self, unlock, branch_token):
 
2362
        LogicalLockResult.__init__(self, unlock)
 
2363
        self.branch_token = branch_token
 
2364
 
 
2365
    def __repr__(self):
 
2366
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
 
2367
            self.unlock)
2079
2368
 
2080
2369
 
2081
2370
class BzrBranch(Branch, _RelockDebugMixin):
2090
2379
    :ivar repository: Repository for this branch.
2091
2380
    :ivar base: The url of the base directory for this branch; the one
2092
2381
        containing the .bzr directory.
 
2382
    :ivar name: Optional colocated branch name as it exists in the control
 
2383
        directory.
2093
2384
    """
2094
2385
 
2095
2386
    def __init__(self, _format=None,
2096
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2097
 
                 ignore_fallbacks=False):
 
2387
                 _control_files=None, a_bzrdir=None, name=None,
 
2388
                 _repository=None, ignore_fallbacks=False):
2098
2389
        """Create new branch object at a particular location."""
2099
2390
        if a_bzrdir is None:
2100
2391
            raise ValueError('a_bzrdir must be supplied')
2101
2392
        else:
2102
2393
            self.bzrdir = a_bzrdir
2103
2394
        self._base = self.bzrdir.transport.clone('..').base
 
2395
        self.name = name
2104
2396
        # XXX: We should be able to just do
2105
2397
        #   self.base = self.bzrdir.root_transport.base
2106
2398
        # but this does not quite work yet -- mbp 20080522
2113
2405
        Branch.__init__(self)
2114
2406
 
2115
2407
    def __str__(self):
2116
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2408
        if self.name is None:
 
2409
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2410
        else:
 
2411
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
 
2412
                self.name)
2117
2413
 
2118
2414
    __repr__ = __str__
2119
2415
 
2130
2426
        return self.control_files.is_locked()
2131
2427
 
2132
2428
    def lock_write(self, token=None):
 
2429
        """Lock the branch for write operations.
 
2430
 
 
2431
        :param token: A token to permit reacquiring a previously held and
 
2432
            preserved lock.
 
2433
        :return: A BranchWriteLockResult.
 
2434
        """
2133
2435
        if not self.is_locked():
2134
2436
            self._note_lock('w')
2135
2437
        # All-in-one needs to always unlock/lock.
2141
2443
        else:
2142
2444
            took_lock = False
2143
2445
        try:
2144
 
            return self.control_files.lock_write(token=token)
 
2446
            return BranchWriteLockResult(self.unlock,
 
2447
                self.control_files.lock_write(token=token))
2145
2448
        except:
2146
2449
            if took_lock:
2147
2450
                self.repository.unlock()
2148
2451
            raise
2149
2452
 
2150
2453
    def lock_read(self):
 
2454
        """Lock the branch for read operations.
 
2455
 
 
2456
        :return: A bzrlib.lock.LogicalLockResult.
 
2457
        """
2151
2458
        if not self.is_locked():
2152
2459
            self._note_lock('r')
2153
2460
        # All-in-one needs to always unlock/lock.
2160
2467
            took_lock = False
2161
2468
        try:
2162
2469
            self.control_files.lock_read()
 
2470
            return LogicalLockResult(self.unlock)
2163
2471
        except:
2164
2472
            if took_lock:
2165
2473
                self.repository.unlock()
2193
2501
        """See Branch.print_file."""
2194
2502
        return self.repository.print_file(file, revision_id)
2195
2503
 
2196
 
    def _write_revision_history(self, history):
2197
 
        """Factored out of set_revision_history.
2198
 
 
2199
 
        This performs the actual writing to disk.
2200
 
        It is intended to be called by BzrBranch5.set_revision_history."""
2201
 
        self._transport.put_bytes(
2202
 
            'revision-history', '\n'.join(history),
2203
 
            mode=self.bzrdir._get_file_mode())
2204
 
 
2205
 
    @needs_write_lock
2206
 
    def set_revision_history(self, rev_history):
2207
 
        """See Branch.set_revision_history."""
2208
 
        if 'evil' in debug.debug_flags:
2209
 
            mutter_callsite(3, "set_revision_history scales with history.")
2210
 
        check_not_reserved_id = _mod_revision.check_not_reserved_id
2211
 
        for rev_id in rev_history:
2212
 
            check_not_reserved_id(rev_id)
2213
 
        if Branch.hooks['post_change_branch_tip']:
2214
 
            # Don't calculate the last_revision_info() if there are no hooks
2215
 
            # that will use it.
2216
 
            old_revno, old_revid = self.last_revision_info()
2217
 
        if len(rev_history) == 0:
2218
 
            revid = _mod_revision.NULL_REVISION
2219
 
        else:
2220
 
            revid = rev_history[-1]
2221
 
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
2222
 
        self._write_revision_history(rev_history)
2223
 
        self._clear_cached_state()
2224
 
        self._cache_revision_history(rev_history)
2225
 
        for hook in Branch.hooks['set_rh']:
2226
 
            hook(self, rev_history)
2227
 
        if Branch.hooks['post_change_branch_tip']:
2228
 
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2229
 
 
2230
 
    def _synchronize_history(self, destination, revision_id):
2231
 
        """Synchronize last revision and revision history between branches.
2232
 
 
2233
 
        This version is most efficient when the destination is also a
2234
 
        BzrBranch5, but works for BzrBranch6 as long as the revision
2235
 
        history is the true lefthand parent history, and all of the revisions
2236
 
        are in the destination's repository.  If not, set_revision_history
2237
 
        will fail.
2238
 
 
2239
 
        :param destination: The branch to copy the history into
2240
 
        :param revision_id: The revision-id to truncate history at.  May
2241
 
          be None to copy complete history.
2242
 
        """
2243
 
        if not isinstance(destination._format, BzrBranchFormat5):
2244
 
            super(BzrBranch, self)._synchronize_history(
2245
 
                destination, revision_id)
2246
 
            return
2247
 
        if revision_id == _mod_revision.NULL_REVISION:
2248
 
            new_history = []
2249
 
        else:
2250
 
            new_history = self.revision_history()
2251
 
        if revision_id is not None and new_history != []:
2252
 
            try:
2253
 
                new_history = new_history[:new_history.index(revision_id) + 1]
2254
 
            except ValueError:
2255
 
                rev = self.repository.get_revision(revision_id)
2256
 
                new_history = rev.get_history(self.repository)[1:]
2257
 
        destination.set_revision_history(new_history)
2258
 
 
2259
2504
    @needs_write_lock
2260
2505
    def set_last_revision_info(self, revno, revision_id):
2261
 
        """Set the last revision of this branch.
2262
 
 
2263
 
        The caller is responsible for checking that the revno is correct
2264
 
        for this revision id.
2265
 
 
2266
 
        It may be possible to set the branch last revision to an id not
2267
 
        present in the repository.  However, branches can also be
2268
 
        configured to check constraints on history, in which case this may not
2269
 
        be permitted.
2270
 
        """
 
2506
        if not revision_id or not isinstance(revision_id, basestring):
 
2507
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
2271
2508
        revision_id = _mod_revision.ensure_null(revision_id)
2272
 
        # this old format stores the full history, but this api doesn't
2273
 
        # provide it, so we must generate, and might as well check it's
2274
 
        # correct
2275
 
        history = self._lefthand_history(revision_id)
2276
 
        if len(history) != revno:
2277
 
            raise AssertionError('%d != %d' % (len(history), revno))
2278
 
        self.set_revision_history(history)
2279
 
 
2280
 
    def _gen_revision_history(self):
2281
 
        history = self._transport.get_bytes('revision-history').split('\n')
2282
 
        if history[-1:] == ['']:
2283
 
            # There shouldn't be a trailing newline, but just in case.
2284
 
            history.pop()
2285
 
        return history
2286
 
 
2287
 
    @needs_write_lock
2288
 
    def generate_revision_history(self, revision_id, last_rev=None,
2289
 
        other_branch=None):
2290
 
        """Create a new revision history that will finish with revision_id.
2291
 
 
2292
 
        :param revision_id: the new tip to use.
2293
 
        :param last_rev: The previous last_revision. If not None, then this
2294
 
            must be a ancestory of revision_id, or DivergedBranches is raised.
2295
 
        :param other_branch: The other branch that DivergedBranches should
2296
 
            raise with respect to.
2297
 
        """
2298
 
        self.set_revision_history(self._lefthand_history(revision_id,
2299
 
            last_rev, other_branch))
 
2509
        old_revno, old_revid = self.last_revision_info()
 
2510
        if self._get_append_revisions_only():
 
2511
            self._check_history_violation(revision_id)
 
2512
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
 
2513
        self._write_last_revision_info(revno, revision_id)
 
2514
        self._clear_cached_state()
 
2515
        self._last_revision_info_cache = revno, revision_id
 
2516
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2300
2517
 
2301
2518
    def basis_tree(self):
2302
2519
        """See Branch.basis_tree."""
2311
2528
                pass
2312
2529
        return None
2313
2530
 
2314
 
    def _basic_push(self, target, overwrite, stop_revision):
2315
 
        """Basic implementation of push without bound branches or hooks.
2316
 
 
2317
 
        Must be called with source read locked and target write locked.
2318
 
        """
2319
 
        result = BranchPushResult()
2320
 
        result.source_branch = self
2321
 
        result.target_branch = target
2322
 
        result.old_revno, result.old_revid = target.last_revision_info()
2323
 
        self.update_references(target)
2324
 
        if result.old_revid != self.last_revision():
2325
 
            # We assume that during 'push' this repository is closer than
2326
 
            # the target.
2327
 
            graph = self.repository.get_graph(target.repository)
2328
 
            target.update_revisions(self, stop_revision,
2329
 
                overwrite=overwrite, graph=graph)
2330
 
        if self._push_should_merge_tags():
2331
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2332
 
                overwrite)
2333
 
        result.new_revno, result.new_revid = target.last_revision_info()
2334
 
        return result
2335
 
 
2336
2531
    def get_stacked_on_url(self):
2337
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2532
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2338
2533
 
2339
2534
    def set_push_location(self, location):
2340
2535
        """See Branch.set_push_location."""
2349
2544
            self._transport.put_bytes('parent', url + '\n',
2350
2545
                mode=self.bzrdir._get_file_mode())
2351
2546
 
2352
 
 
2353
 
class BzrBranch5(BzrBranch):
2354
 
    """A format 5 branch. This supports new features over plain branches.
2355
 
 
2356
 
    It has support for a master_branch which is the data for bound branches.
2357
 
    """
2358
 
 
2359
 
    def get_bound_location(self):
2360
 
        try:
2361
 
            return self._transport.get_bytes('bound')[:-1]
2362
 
        except errors.NoSuchFile:
2363
 
            return None
2364
 
 
2365
 
    @needs_read_lock
2366
 
    def get_master_branch(self, possible_transports=None):
2367
 
        """Return the branch we are bound to.
2368
 
 
2369
 
        :return: Either a Branch, or None
2370
 
 
2371
 
        This could memoise the branch, but if thats done
2372
 
        it must be revalidated on each new lock.
2373
 
        So for now we just don't memoise it.
2374
 
        # RBC 20060304 review this decision.
2375
 
        """
2376
 
        bound_loc = self.get_bound_location()
2377
 
        if not bound_loc:
2378
 
            return None
2379
 
        try:
2380
 
            return Branch.open(bound_loc,
2381
 
                               possible_transports=possible_transports)
2382
 
        except (errors.NotBranchError, errors.ConnectionError), e:
2383
 
            raise errors.BoundBranchConnectionFailure(
2384
 
                    self, bound_loc, e)
2385
 
 
2386
2547
    @needs_write_lock
2387
 
    def set_bound_location(self, location):
2388
 
        """Set the target where this branch is bound to.
2389
 
 
2390
 
        :param location: URL to the target branch
2391
 
        """
2392
 
        if location:
2393
 
            self._transport.put_bytes('bound', location+'\n',
2394
 
                mode=self.bzrdir._get_file_mode())
2395
 
        else:
2396
 
            try:
2397
 
                self._transport.delete('bound')
2398
 
            except errors.NoSuchFile:
2399
 
                return False
2400
 
            return True
 
2548
    def unbind(self):
 
2549
        """If bound, unbind"""
 
2550
        return self.set_bound_location(None)
2401
2551
 
2402
2552
    @needs_write_lock
2403
2553
    def bind(self, other):
2425
2575
        # history around
2426
2576
        self.set_bound_location(other.base)
2427
2577
 
 
2578
    def get_bound_location(self):
 
2579
        try:
 
2580
            return self._transport.get_bytes('bound')[:-1]
 
2581
        except errors.NoSuchFile:
 
2582
            return None
 
2583
 
 
2584
    @needs_read_lock
 
2585
    def get_master_branch(self, possible_transports=None):
 
2586
        """Return the branch we are bound to.
 
2587
 
 
2588
        :return: Either a Branch, or None
 
2589
        """
 
2590
        if self._master_branch_cache is None:
 
2591
            self._master_branch_cache = self._get_master_branch(
 
2592
                possible_transports)
 
2593
        return self._master_branch_cache
 
2594
 
 
2595
    def _get_master_branch(self, possible_transports):
 
2596
        bound_loc = self.get_bound_location()
 
2597
        if not bound_loc:
 
2598
            return None
 
2599
        try:
 
2600
            return Branch.open(bound_loc,
 
2601
                               possible_transports=possible_transports)
 
2602
        except (errors.NotBranchError, errors.ConnectionError), e:
 
2603
            raise errors.BoundBranchConnectionFailure(
 
2604
                    self, bound_loc, e)
 
2605
 
2428
2606
    @needs_write_lock
2429
 
    def unbind(self):
2430
 
        """If bound, unbind"""
2431
 
        return self.set_bound_location(None)
 
2607
    def set_bound_location(self, location):
 
2608
        """Set the target where this branch is bound to.
 
2609
 
 
2610
        :param location: URL to the target branch
 
2611
        """
 
2612
        self._master_branch_cache = None
 
2613
        if location:
 
2614
            self._transport.put_bytes('bound', location+'\n',
 
2615
                mode=self.bzrdir._get_file_mode())
 
2616
        else:
 
2617
            try:
 
2618
                self._transport.delete('bound')
 
2619
            except errors.NoSuchFile:
 
2620
                return False
 
2621
            return True
2432
2622
 
2433
2623
    @needs_write_lock
2434
2624
    def update(self, possible_transports=None):
2447
2637
            return old_tip
2448
2638
        return None
2449
2639
 
2450
 
 
2451
 
class BzrBranch8(BzrBranch5):
 
2640
    def _read_last_revision_info(self):
 
2641
        revision_string = self._transport.get_bytes('last-revision')
 
2642
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
 
2643
        revision_id = cache_utf8.get_cached_utf8(revision_id)
 
2644
        revno = int(revno)
 
2645
        return revno, revision_id
 
2646
 
 
2647
    def _write_last_revision_info(self, revno, revision_id):
 
2648
        """Simply write out the revision id, with no checks.
 
2649
 
 
2650
        Use set_last_revision_info to perform this safely.
 
2651
 
 
2652
        Does not update the revision_history cache.
 
2653
        """
 
2654
        revision_id = _mod_revision.ensure_null(revision_id)
 
2655
        out_string = '%d %s\n' % (revno, revision_id)
 
2656
        self._transport.put_bytes('last-revision', out_string,
 
2657
            mode=self.bzrdir._get_file_mode())
 
2658
 
 
2659
 
 
2660
class FullHistoryBzrBranch(BzrBranch):
 
2661
    """Bzr branch which contains the full revision history."""
 
2662
 
 
2663
    @needs_write_lock
 
2664
    def set_last_revision_info(self, revno, revision_id):
 
2665
        if not revision_id or not isinstance(revision_id, basestring):
 
2666
            raise errors.InvalidRevisionId(revision_id=revision_id, branch=self)
 
2667
        revision_id = _mod_revision.ensure_null(revision_id)
 
2668
        # this old format stores the full history, but this api doesn't
 
2669
        # provide it, so we must generate, and might as well check it's
 
2670
        # correct
 
2671
        history = self._lefthand_history(revision_id)
 
2672
        if len(history) != revno:
 
2673
            raise AssertionError('%d != %d' % (len(history), revno))
 
2674
        self._set_revision_history(history)
 
2675
 
 
2676
    def _read_last_revision_info(self):
 
2677
        rh = self.revision_history()
 
2678
        revno = len(rh)
 
2679
        if revno:
 
2680
            return (revno, rh[-1])
 
2681
        else:
 
2682
            return (0, _mod_revision.NULL_REVISION)
 
2683
 
 
2684
    @deprecated_method(deprecated_in((2, 4, 0)))
 
2685
    @needs_write_lock
 
2686
    def set_revision_history(self, rev_history):
 
2687
        """See Branch.set_revision_history."""
 
2688
        self._set_revision_history(rev_history)
 
2689
 
 
2690
    def _set_revision_history(self, rev_history):
 
2691
        if 'evil' in debug.debug_flags:
 
2692
            mutter_callsite(3, "set_revision_history scales with history.")
 
2693
        check_not_reserved_id = _mod_revision.check_not_reserved_id
 
2694
        for rev_id in rev_history:
 
2695
            check_not_reserved_id(rev_id)
 
2696
        if Branch.hooks['post_change_branch_tip']:
 
2697
            # Don't calculate the last_revision_info() if there are no hooks
 
2698
            # that will use it.
 
2699
            old_revno, old_revid = self.last_revision_info()
 
2700
        if len(rev_history) == 0:
 
2701
            revid = _mod_revision.NULL_REVISION
 
2702
        else:
 
2703
            revid = rev_history[-1]
 
2704
        self._run_pre_change_branch_tip_hooks(len(rev_history), revid)
 
2705
        self._write_revision_history(rev_history)
 
2706
        self._clear_cached_state()
 
2707
        self._cache_revision_history(rev_history)
 
2708
        for hook in Branch.hooks['set_rh']:
 
2709
            hook(self, rev_history)
 
2710
        if Branch.hooks['post_change_branch_tip']:
 
2711
            self._run_post_change_branch_tip_hooks(old_revno, old_revid)
 
2712
 
 
2713
    def _write_revision_history(self, history):
 
2714
        """Factored out of set_revision_history.
 
2715
 
 
2716
        This performs the actual writing to disk.
 
2717
        It is intended to be called by set_revision_history."""
 
2718
        self._transport.put_bytes(
 
2719
            'revision-history', '\n'.join(history),
 
2720
            mode=self.bzrdir._get_file_mode())
 
2721
 
 
2722
    def _gen_revision_history(self):
 
2723
        history = self._transport.get_bytes('revision-history').split('\n')
 
2724
        if history[-1:] == ['']:
 
2725
            # There shouldn't be a trailing newline, but just in case.
 
2726
            history.pop()
 
2727
        return history
 
2728
 
 
2729
    def _synchronize_history(self, destination, revision_id):
 
2730
        if not isinstance(destination, FullHistoryBzrBranch):
 
2731
            super(BzrBranch, self)._synchronize_history(
 
2732
                destination, revision_id)
 
2733
            return
 
2734
        if revision_id == _mod_revision.NULL_REVISION:
 
2735
            new_history = []
 
2736
        else:
 
2737
            new_history = self.revision_history()
 
2738
        if revision_id is not None and new_history != []:
 
2739
            try:
 
2740
                new_history = new_history[:new_history.index(revision_id) + 1]
 
2741
            except ValueError:
 
2742
                rev = self.repository.get_revision(revision_id)
 
2743
                new_history = rev.get_history(self.repository)[1:]
 
2744
        destination._set_revision_history(new_history)
 
2745
 
 
2746
    @needs_write_lock
 
2747
    def generate_revision_history(self, revision_id, last_rev=None,
 
2748
        other_branch=None):
 
2749
        """Create a new revision history that will finish with revision_id.
 
2750
 
 
2751
        :param revision_id: the new tip to use.
 
2752
        :param last_rev: The previous last_revision. If not None, then this
 
2753
            must be a ancestory of revision_id, or DivergedBranches is raised.
 
2754
        :param other_branch: The other branch that DivergedBranches should
 
2755
            raise with respect to.
 
2756
        """
 
2757
        self._set_revision_history(self._lefthand_history(revision_id,
 
2758
            last_rev, other_branch))
 
2759
 
 
2760
 
 
2761
class BzrBranch5(FullHistoryBzrBranch):
 
2762
    """A format 5 branch. This supports new features over plain branches.
 
2763
 
 
2764
    It has support for a master_branch which is the data for bound branches.
 
2765
    """
 
2766
 
 
2767
 
 
2768
class BzrBranch8(BzrBranch):
2452
2769
    """A branch that stores tree-reference locations."""
2453
2770
 
2454
2771
    def _open_hook(self):
2480
2797
        self._last_revision_info_cache = None
2481
2798
        self._reference_info = None
2482
2799
 
2483
 
    def _last_revision_info(self):
2484
 
        revision_string = self._transport.get_bytes('last-revision')
2485
 
        revno, revision_id = revision_string.rstrip('\n').split(' ', 1)
2486
 
        revision_id = cache_utf8.get_cached_utf8(revision_id)
2487
 
        revno = int(revno)
2488
 
        return revno, revision_id
2489
 
 
2490
 
    def _write_last_revision_info(self, revno, revision_id):
2491
 
        """Simply write out the revision id, with no checks.
2492
 
 
2493
 
        Use set_last_revision_info to perform this safely.
2494
 
 
2495
 
        Does not update the revision_history cache.
2496
 
        Intended to be called by set_last_revision_info and
2497
 
        _write_revision_history.
2498
 
        """
2499
 
        revision_id = _mod_revision.ensure_null(revision_id)
2500
 
        out_string = '%d %s\n' % (revno, revision_id)
2501
 
        self._transport.put_bytes('last-revision', out_string,
2502
 
            mode=self.bzrdir._get_file_mode())
2503
 
 
2504
 
    @needs_write_lock
2505
 
    def set_last_revision_info(self, revno, revision_id):
2506
 
        revision_id = _mod_revision.ensure_null(revision_id)
2507
 
        old_revno, old_revid = self.last_revision_info()
2508
 
        if self._get_append_revisions_only():
2509
 
            self._check_history_violation(revision_id)
2510
 
        self._run_pre_change_branch_tip_hooks(revno, revision_id)
2511
 
        self._write_last_revision_info(revno, revision_id)
2512
 
        self._clear_cached_state()
2513
 
        self._last_revision_info_cache = revno, revision_id
2514
 
        self._run_post_change_branch_tip_hooks(old_revno, old_revid)
2515
 
 
2516
 
    def _synchronize_history(self, destination, revision_id):
2517
 
        """Synchronize last revision and revision history between branches.
2518
 
 
2519
 
        :see: Branch._synchronize_history
2520
 
        """
2521
 
        # XXX: The base Branch has a fast implementation of this method based
2522
 
        # on set_last_revision_info, but BzrBranch/BzrBranch5 have a slower one
2523
 
        # that uses set_revision_history.  This class inherits from BzrBranch5,
2524
 
        # but wants the fast implementation, so it calls
2525
 
        # Branch._synchronize_history directly.
2526
 
        Branch._synchronize_history(self, destination, revision_id)
2527
 
 
2528
2800
    def _check_history_violation(self, revision_id):
2529
 
        last_revision = _mod_revision.ensure_null(self.last_revision())
 
2801
        current_revid = self.last_revision()
 
2802
        last_revision = _mod_revision.ensure_null(current_revid)
2530
2803
        if _mod_revision.is_null(last_revision):
2531
2804
            return
2532
 
        if last_revision not in self._lefthand_history(revision_id):
2533
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2805
        graph = self.repository.get_graph()
 
2806
        for lh_ancestor in graph.iter_lefthand_ancestry(revision_id):
 
2807
            if lh_ancestor == current_revid:
 
2808
                return
 
2809
        raise errors.AppendRevisionsOnlyViolation(self.user_url)
2534
2810
 
2535
2811
    def _gen_revision_history(self):
2536
2812
        """Generate the revision history from last revision
2539
2815
        self._extend_partial_history(stop_index=last_revno-1)
2540
2816
        return list(reversed(self._partial_revision_history_cache))
2541
2817
 
2542
 
    def _write_revision_history(self, history):
2543
 
        """Factored out of set_revision_history.
2544
 
 
2545
 
        This performs the actual writing to disk, with format-specific checks.
2546
 
        It is intended to be called by BzrBranch5.set_revision_history.
2547
 
        """
2548
 
        if len(history) == 0:
2549
 
            last_revision = 'null:'
2550
 
        else:
2551
 
            if history != self._lefthand_history(history[-1]):
2552
 
                raise errors.NotLefthandHistory(history)
2553
 
            last_revision = history[-1]
2554
 
        if self._get_append_revisions_only():
2555
 
            self._check_history_violation(last_revision)
2556
 
        self._write_last_revision_info(len(history), last_revision)
2557
 
 
2558
2818
    @needs_write_lock
2559
2819
    def _set_parent_location(self, url):
2560
2820
        """Set the parent branch"""
2636
2896
        if branch_location is None:
2637
2897
            return Branch.reference_parent(self, file_id, path,
2638
2898
                                           possible_transports)
2639
 
        branch_location = urlutils.join(self.base, branch_location)
 
2899
        branch_location = urlutils.join(self.user_url, branch_location)
2640
2900
        return Branch.open(branch_location,
2641
2901
                           possible_transports=possible_transports)
2642
2902
 
2646
2906
 
2647
2907
    def set_bound_location(self, location):
2648
2908
        """See Branch.set_push_location."""
 
2909
        self._master_branch_cache = None
2649
2910
        result = None
2650
2911
        config = self.get_config()
2651
2912
        if location is None:
2682
2943
        # you can always ask for the URL; but you might not be able to use it
2683
2944
        # if the repo can't support stacking.
2684
2945
        ## self._check_stackable_repo()
2685
 
        stacked_url = self._get_config_location('stacked_on_location')
 
2946
        # stacked_on_location is only ever defined in branch.conf, so don't
 
2947
        # waste effort reading the whole stack of config files.
 
2948
        config = self.get_config()._get_branch_data_config()
 
2949
        stacked_url = self._get_config_location('stacked_on_location',
 
2950
            config=config)
2686
2951
        if stacked_url is None:
2687
2952
            raise errors.NotStacked(self)
2688
2953
        return stacked_url
2689
2954
 
2690
2955
    def _get_append_revisions_only(self):
2691
 
        value = self.get_config().get_user_option('append_revisions_only')
2692
 
        return value == 'True'
2693
 
 
2694
 
    @needs_write_lock
2695
 
    def generate_revision_history(self, revision_id, last_rev=None,
2696
 
                                  other_branch=None):
2697
 
        """See BzrBranch5.generate_revision_history"""
2698
 
        history = self._lefthand_history(revision_id, last_rev, other_branch)
2699
 
        revno = len(history)
2700
 
        self.set_last_revision_info(revno, revision_id)
 
2956
        return self.get_config(
 
2957
            ).get_user_option_as_bool('append_revisions_only')
2701
2958
 
2702
2959
    @needs_read_lock
2703
2960
    def get_rev_id(self, revno, history=None):
2728
2985
        try:
2729
2986
            index = self._partial_revision_history_cache.index(revision_id)
2730
2987
        except ValueError:
2731
 
            self._extend_partial_history(stop_revision=revision_id)
 
2988
            try:
 
2989
                self._extend_partial_history(stop_revision=revision_id)
 
2990
            except errors.RevisionNotPresent, e:
 
2991
                raise errors.GhostRevisionsHaveNoRevno(revision_id, e.revision_id)
2732
2992
            index = len(self._partial_revision_history_cache) - 1
2733
2993
            if self._partial_revision_history_cache[index] != revision_id:
2734
2994
                raise errors.NoSuchRevision(self, revision_id)
2757
3017
    """
2758
3018
 
2759
3019
    def get_stacked_on_url(self):
2760
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
3020
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2761
3021
 
2762
3022
 
2763
3023
######################################################################
2789
3049
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2790
3050
    """
2791
3051
 
 
3052
    @deprecated_method(deprecated_in((2, 3, 0)))
2792
3053
    def __int__(self):
2793
 
        # DEPRECATED: pull used to return the change in revno
 
3054
        """Return the relative change in revno.
 
3055
 
 
3056
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3057
        """
2794
3058
        return self.new_revno - self.old_revno
2795
3059
 
2796
3060
    def report(self, to_file):
2821
3085
        target, otherwise it will be None.
2822
3086
    """
2823
3087
 
 
3088
    @deprecated_method(deprecated_in((2, 3, 0)))
2824
3089
    def __int__(self):
2825
 
        # DEPRECATED: push used to return the change in revno
 
3090
        """Return the relative change in revno.
 
3091
 
 
3092
        :deprecated: Use `new_revno` and `old_revno` instead.
 
3093
        """
2826
3094
        return self.new_revno - self.old_revno
2827
3095
 
2828
3096
    def report(self, to_file):
2850
3118
        :param verbose: Requests more detailed display of what was checked,
2851
3119
            if any.
2852
3120
        """
2853
 
        note('checked branch %s format %s', self.branch.base,
 
3121
        note('checked branch %s format %s', self.branch.user_url,
2854
3122
            self.branch._format)
2855
3123
        for error in self.errors:
2856
3124
            note('found error:%s', error)
2898
3166
 
2899
3167
 
2900
3168
class Converter7to8(object):
2901
 
    """Perform an in-place upgrade of format 6 to format 7"""
 
3169
    """Perform an in-place upgrade of format 7 to format 8"""
2902
3170
 
2903
3171
    def convert(self, branch):
2904
3172
        format = BzrBranchFormat8()
2907
3175
        branch._transport.put_bytes('format', format.get_format_string())
2908
3176
 
2909
3177
 
2910
 
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2911
 
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2912
 
    duration.
2913
 
 
2914
 
    _run_with_write_locked_target will attempt to release the lock it acquires.
2915
 
 
2916
 
    If an exception is raised by callable, then that exception *will* be
2917
 
    propagated, even if the unlock attempt raises its own error.  Thus
2918
 
    _run_with_write_locked_target should be preferred to simply doing::
2919
 
 
2920
 
        target.lock_write()
2921
 
        try:
2922
 
            return callable(*args, **kwargs)
2923
 
        finally:
2924
 
            target.unlock()
2925
 
 
2926
 
    """
2927
 
    # This is very similar to bzrlib.decorators.needs_write_lock.  Perhaps they
2928
 
    # should share code?
2929
 
    target.lock_write()
2930
 
    try:
2931
 
        result = callable(*args, **kwargs)
2932
 
    except:
2933
 
        exc_info = sys.exc_info()
2934
 
        try:
2935
 
            target.unlock()
2936
 
        finally:
2937
 
            raise exc_info[0], exc_info[1], exc_info[2]
2938
 
    else:
2939
 
        target.unlock()
2940
 
        return result
2941
 
 
2942
 
 
2943
3178
class InterBranch(InterObject):
2944
3179
    """This class represents operations taking place between two branches.
2945
3180
 
2951
3186
    _optimisers = []
2952
3187
    """The available optimised InterBranch types."""
2953
3188
 
2954
 
    @staticmethod
2955
 
    def _get_branch_formats_to_test():
2956
 
        """Return a tuple with the Branch formats to use when testing."""
2957
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3189
    @classmethod
 
3190
    def _get_branch_formats_to_test(klass):
 
3191
        """Return an iterable of format tuples for testing.
 
3192
        
 
3193
        :return: An iterable of (from_format, to_format) to use when testing
 
3194
            this InterBranch class. Each InterBranch class should define this
 
3195
            method itself.
 
3196
        """
 
3197
        raise NotImplementedError(klass._get_branch_formats_to_test)
2958
3198
 
 
3199
    @needs_write_lock
2959
3200
    def pull(self, overwrite=False, stop_revision=None,
2960
3201
             possible_transports=None, local=False):
2961
3202
        """Mirror source into target branch.
2966
3207
        """
2967
3208
        raise NotImplementedError(self.pull)
2968
3209
 
2969
 
    def update_revisions(self, stop_revision=None, overwrite=False,
2970
 
                         graph=None):
2971
 
        """Pull in new perfect-fit revisions.
2972
 
 
2973
 
        :param stop_revision: Updated until the given revision
2974
 
        :param overwrite: Always set the branch pointer, rather than checking
2975
 
            to see if it is a proper descendant.
2976
 
        :param graph: A Graph object that can be used to query history
2977
 
            information. This can be None.
2978
 
        :return: None
2979
 
        """
2980
 
        raise NotImplementedError(self.update_revisions)
2981
 
 
2982
 
    def push(self, overwrite=False, stop_revision=None,
 
3210
    @needs_write_lock
 
3211
    def push(self, overwrite=False, stop_revision=None, lossy=False,
2983
3212
             _override_hook_source_branch=None):
2984
3213
        """Mirror the source branch into the target branch.
2985
3214
 
2987
3216
        """
2988
3217
        raise NotImplementedError(self.push)
2989
3218
 
 
3219
    @needs_write_lock
 
3220
    def copy_content_into(self, revision_id=None):
 
3221
        """Copy the content of source into target
 
3222
 
 
3223
        revision_id: if not None, the revision history in the new branch will
 
3224
                     be truncated to end with revision_id.
 
3225
        """
 
3226
        raise NotImplementedError(self.copy_content_into)
 
3227
 
 
3228
    @needs_write_lock
 
3229
    def fetch(self, stop_revision=None, limit=None):
 
3230
        """Fetch revisions.
 
3231
 
 
3232
        :param stop_revision: Last revision to fetch
 
3233
        :param limit: Optional rough limit of revisions to fetch
 
3234
        """
 
3235
        raise NotImplementedError(self.fetch)
 
3236
 
2990
3237
 
2991
3238
class GenericInterBranch(InterBranch):
2992
 
    """InterBranch implementation that uses public Branch functions.
2993
 
    """
2994
 
 
2995
 
    @staticmethod
2996
 
    def _get_branch_formats_to_test():
2997
 
        return BranchFormat._default_format, BranchFormat._default_format
2998
 
 
2999
 
    def update_revisions(self, stop_revision=None, overwrite=False,
3000
 
        graph=None):
3001
 
        """See InterBranch.update_revisions()."""
 
3239
    """InterBranch implementation that uses public Branch functions."""
 
3240
 
 
3241
    @classmethod
 
3242
    def is_compatible(klass, source, target):
 
3243
        # GenericBranch uses the public API, so always compatible
 
3244
        return True
 
3245
 
 
3246
    @classmethod
 
3247
    def _get_branch_formats_to_test(klass):
 
3248
        return [(format_registry.get_default(), format_registry.get_default())]
 
3249
 
 
3250
    @classmethod
 
3251
    def unwrap_format(klass, format):
 
3252
        if isinstance(format, remote.RemoteBranchFormat):
 
3253
            format._ensure_real()
 
3254
            return format._custom_format
 
3255
        return format
 
3256
 
 
3257
    @needs_write_lock
 
3258
    def copy_content_into(self, revision_id=None):
 
3259
        """Copy the content of source into target
 
3260
 
 
3261
        revision_id: if not None, the revision history in the new branch will
 
3262
                     be truncated to end with revision_id.
 
3263
        """
 
3264
        self.source.update_references(self.target)
 
3265
        self.source._synchronize_history(self.target, revision_id)
 
3266
        try:
 
3267
            parent = self.source.get_parent()
 
3268
        except errors.InaccessibleParent, e:
 
3269
            mutter('parent was not accessible to copy: %s', e)
 
3270
        else:
 
3271
            if parent:
 
3272
                self.target.set_parent(parent)
 
3273
        if self.source._push_should_merge_tags():
 
3274
            self.source.tags.merge_to(self.target.tags)
 
3275
 
 
3276
    @needs_write_lock
 
3277
    def fetch(self, stop_revision=None, limit=None):
 
3278
        if self.target.base == self.source.base:
 
3279
            return (0, [])
3002
3280
        self.source.lock_read()
3003
3281
        try:
3004
 
            other_revno, other_last_revision = self.source.last_revision_info()
3005
 
            stop_revno = None # unknown
3006
 
            if stop_revision is None:
3007
 
                stop_revision = other_last_revision
3008
 
                if _mod_revision.is_null(stop_revision):
3009
 
                    # if there are no commits, we're done.
3010
 
                    return
3011
 
                stop_revno = other_revno
3012
 
 
3013
 
            # what's the current last revision, before we fetch [and change it
3014
 
            # possibly]
3015
 
            last_rev = _mod_revision.ensure_null(self.target.last_revision())
3016
 
            # we fetch here so that we don't process data twice in the common
3017
 
            # case of having something to pull, and so that the check for
3018
 
            # already merged can operate on the just fetched graph, which will
3019
 
            # be cached in memory.
3020
 
            self.target.fetch(self.source, stop_revision)
3021
 
            # Check to see if one is an ancestor of the other
3022
 
            if not overwrite:
3023
 
                if graph is None:
3024
 
                    graph = self.target.repository.get_graph()
3025
 
                if self.target._check_if_descendant_or_diverged(
3026
 
                        stop_revision, last_rev, graph, self.source):
3027
 
                    # stop_revision is a descendant of last_rev, but we aren't
3028
 
                    # overwriting, so we're done.
3029
 
                    return
3030
 
            if stop_revno is None:
3031
 
                if graph is None:
3032
 
                    graph = self.target.repository.get_graph()
3033
 
                this_revno, this_last_revision = \
3034
 
                        self.target.last_revision_info()
3035
 
                stop_revno = graph.find_distance_to_null(stop_revision,
3036
 
                                [(other_last_revision, other_revno),
3037
 
                                 (this_last_revision, this_revno)])
3038
 
            self.target.set_last_revision_info(stop_revno, stop_revision)
 
3282
            fetch_spec_factory = fetch.FetchSpecFactory()
 
3283
            fetch_spec_factory.source_branch = self.source
 
3284
            fetch_spec_factory.source_branch_stop_revision_id = stop_revision
 
3285
            fetch_spec_factory.source_repo = self.source.repository
 
3286
            fetch_spec_factory.target_repo = self.target.repository
 
3287
            fetch_spec_factory.target_repo_kind = fetch.TargetRepoKinds.PREEXISTING
 
3288
            fetch_spec_factory.limit = limit
 
3289
            fetch_spec = fetch_spec_factory.make_fetch_spec()
 
3290
            return self.target.repository.fetch(self.source.repository,
 
3291
                fetch_spec=fetch_spec)
3039
3292
        finally:
3040
3293
            self.source.unlock()
3041
3294
 
 
3295
    @needs_write_lock
 
3296
    def _update_revisions(self, stop_revision=None, overwrite=False,
 
3297
            graph=None):
 
3298
        other_revno, other_last_revision = self.source.last_revision_info()
 
3299
        stop_revno = None # unknown
 
3300
        if stop_revision is None:
 
3301
            stop_revision = other_last_revision
 
3302
            if _mod_revision.is_null(stop_revision):
 
3303
                # if there are no commits, we're done.
 
3304
                return
 
3305
            stop_revno = other_revno
 
3306
 
 
3307
        # what's the current last revision, before we fetch [and change it
 
3308
        # possibly]
 
3309
        last_rev = _mod_revision.ensure_null(self.target.last_revision())
 
3310
        # we fetch here so that we don't process data twice in the common
 
3311
        # case of having something to pull, and so that the check for
 
3312
        # already merged can operate on the just fetched graph, which will
 
3313
        # be cached in memory.
 
3314
        self.fetch(stop_revision=stop_revision)
 
3315
        # Check to see if one is an ancestor of the other
 
3316
        if not overwrite:
 
3317
            if graph is None:
 
3318
                graph = self.target.repository.get_graph()
 
3319
            if self.target._check_if_descendant_or_diverged(
 
3320
                    stop_revision, last_rev, graph, self.source):
 
3321
                # stop_revision is a descendant of last_rev, but we aren't
 
3322
                # overwriting, so we're done.
 
3323
                return
 
3324
        if stop_revno is None:
 
3325
            if graph is None:
 
3326
                graph = self.target.repository.get_graph()
 
3327
            this_revno, this_last_revision = \
 
3328
                    self.target.last_revision_info()
 
3329
            stop_revno = graph.find_distance_to_null(stop_revision,
 
3330
                            [(other_last_revision, other_revno),
 
3331
                             (this_last_revision, this_revno)])
 
3332
        self.target.set_last_revision_info(stop_revno, stop_revision)
 
3333
 
 
3334
    @needs_write_lock
3042
3335
    def pull(self, overwrite=False, stop_revision=None,
 
3336
             possible_transports=None, run_hooks=True,
 
3337
             _override_hook_target=None, local=False):
 
3338
        """Pull from source into self, updating my master if any.
 
3339
 
 
3340
        :param run_hooks: Private parameter - if false, this branch
 
3341
            is being called because it's the master of the primary branch,
 
3342
            so it should not run its hooks.
 
3343
        """
 
3344
        bound_location = self.target.get_bound_location()
 
3345
        if local and not bound_location:
 
3346
            raise errors.LocalRequiresBoundBranch()
 
3347
        master_branch = None
 
3348
        source_is_master = False
 
3349
        if bound_location:
 
3350
            # bound_location comes from a config file, some care has to be
 
3351
            # taken to relate it to source.user_url
 
3352
            normalized = urlutils.normalize_url(bound_location)
 
3353
            try:
 
3354
                relpath = self.source.user_transport.relpath(normalized)
 
3355
                source_is_master = (relpath == '')
 
3356
            except (errors.PathNotChild, errors.InvalidURL):
 
3357
                source_is_master = False
 
3358
        if not local and bound_location and not source_is_master:
 
3359
            # not pulling from master, so we need to update master.
 
3360
            master_branch = self.target.get_master_branch(possible_transports)
 
3361
            master_branch.lock_write()
 
3362
        try:
 
3363
            if master_branch:
 
3364
                # pull from source into master.
 
3365
                master_branch.pull(self.source, overwrite, stop_revision,
 
3366
                    run_hooks=False)
 
3367
            return self._pull(overwrite,
 
3368
                stop_revision, _hook_master=master_branch,
 
3369
                run_hooks=run_hooks,
 
3370
                _override_hook_target=_override_hook_target,
 
3371
                merge_tags_to_master=not source_is_master)
 
3372
        finally:
 
3373
            if master_branch:
 
3374
                master_branch.unlock()
 
3375
 
 
3376
    def push(self, overwrite=False, stop_revision=None, lossy=False,
 
3377
             _override_hook_source_branch=None):
 
3378
        """See InterBranch.push.
 
3379
 
 
3380
        This is the basic concrete implementation of push()
 
3381
 
 
3382
        :param _override_hook_source_branch: If specified, run the hooks
 
3383
            passing this Branch as the source, rather than self.  This is for
 
3384
            use of RemoteBranch, where push is delegated to the underlying
 
3385
            vfs-based Branch.
 
3386
        """
 
3387
        if lossy:
 
3388
            raise errors.LossyPushToSameVCS(self.source, self.target)
 
3389
        # TODO: Public option to disable running hooks - should be trivial but
 
3390
        # needs tests.
 
3391
 
 
3392
        op = cleanup.OperationWithCleanups(self._push_with_bound_branches)
 
3393
        op.add_cleanup(self.source.lock_read().unlock)
 
3394
        op.add_cleanup(self.target.lock_write().unlock)
 
3395
        return op.run(overwrite, stop_revision,
 
3396
            _override_hook_source_branch=_override_hook_source_branch)
 
3397
 
 
3398
    def _basic_push(self, overwrite, stop_revision):
 
3399
        """Basic implementation of push without bound branches or hooks.
 
3400
 
 
3401
        Must be called with source read locked and target write locked.
 
3402
        """
 
3403
        result = BranchPushResult()
 
3404
        result.source_branch = self.source
 
3405
        result.target_branch = self.target
 
3406
        result.old_revno, result.old_revid = self.target.last_revision_info()
 
3407
        self.source.update_references(self.target)
 
3408
        if result.old_revid != stop_revision:
 
3409
            # We assume that during 'push' this repository is closer than
 
3410
            # the target.
 
3411
            graph = self.source.repository.get_graph(self.target.repository)
 
3412
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3413
                    graph=graph)
 
3414
        if self.source._push_should_merge_tags():
 
3415
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3416
                overwrite)
 
3417
        result.new_revno, result.new_revid = self.target.last_revision_info()
 
3418
        return result
 
3419
 
 
3420
    def _push_with_bound_branches(self, operation, overwrite, stop_revision,
 
3421
            _override_hook_source_branch=None):
 
3422
        """Push from source into target, and into target's master if any.
 
3423
        """
 
3424
        def _run_hooks():
 
3425
            if _override_hook_source_branch:
 
3426
                result.source_branch = _override_hook_source_branch
 
3427
            for hook in Branch.hooks['post_push']:
 
3428
                hook(result)
 
3429
 
 
3430
        bound_location = self.target.get_bound_location()
 
3431
        if bound_location and self.target.base != bound_location:
 
3432
            # there is a master branch.
 
3433
            #
 
3434
            # XXX: Why the second check?  Is it even supported for a branch to
 
3435
            # be bound to itself? -- mbp 20070507
 
3436
            master_branch = self.target.get_master_branch()
 
3437
            master_branch.lock_write()
 
3438
            operation.add_cleanup(master_branch.unlock)
 
3439
            # push into the master from the source branch.
 
3440
            master_inter = InterBranch.get(self.source, master_branch)
 
3441
            master_inter._basic_push(overwrite, stop_revision)
 
3442
            # and push into the target branch from the source. Note that
 
3443
            # we push from the source branch again, because it's considered
 
3444
            # the highest bandwidth repository.
 
3445
            result = self._basic_push(overwrite, stop_revision)
 
3446
            result.master_branch = master_branch
 
3447
            result.local_branch = self.target
 
3448
        else:
 
3449
            master_branch = None
 
3450
            # no master branch
 
3451
            result = self._basic_push(overwrite, stop_revision)
 
3452
            # TODO: Why set master_branch and local_branch if there's no
 
3453
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3454
            # 20070504
 
3455
            result.master_branch = self.target
 
3456
            result.local_branch = None
 
3457
        _run_hooks()
 
3458
        return result
 
3459
 
 
3460
    def _pull(self, overwrite=False, stop_revision=None,
3043
3461
             possible_transports=None, _hook_master=None, run_hooks=True,
3044
 
             _override_hook_target=None, local=False):
 
3462
             _override_hook_target=None, local=False,
 
3463
             merge_tags_to_master=True):
3045
3464
        """See Branch.pull.
3046
3465
 
 
3466
        This function is the core worker, used by GenericInterBranch.pull to
 
3467
        avoid duplication when pulling source->master and source->local.
 
3468
 
3047
3469
        :param _hook_master: Private parameter - set the branch to
3048
3470
            be supplied as the master to pull hooks.
3049
3471
        :param run_hooks: Private parameter - if false, this branch
3050
3472
            is being called because it's the master of the primary branch,
3051
3473
            so it should not run its hooks.
 
3474
            is being called because it's the master of the primary branch,
 
3475
            so it should not run its hooks.
3052
3476
        :param _override_hook_target: Private parameter - set the branch to be
3053
3477
            supplied as the target_branch to pull hooks.
3054
3478
        :param local: Only update the local branch, and not the bound branch.
3073
3497
            # -- JRV20090506
3074
3498
            result.old_revno, result.old_revid = \
3075
3499
                self.target.last_revision_info()
3076
 
            self.target.update_revisions(self.source, stop_revision,
3077
 
                overwrite=overwrite, graph=graph)
 
3500
            self._update_revisions(stop_revision, overwrite=overwrite,
 
3501
                graph=graph)
3078
3502
            # TODO: The old revid should be specified when merging tags, 
3079
3503
            # so a tags implementation that versions tags can only 
3080
3504
            # pull in the most recent changes. -- JRV20090506
3081
3505
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3082
 
                overwrite)
 
3506
                overwrite, ignore_master=not merge_tags_to_master)
3083
3507
            result.new_revno, result.new_revid = self.target.last_revision_info()
3084
3508
            if _hook_master:
3085
3509
                result.master_branch = _hook_master
3094
3518
            self.source.unlock()
3095
3519
        return result
3096
3520
 
3097
 
    def push(self, overwrite=False, stop_revision=None,
3098
 
             _override_hook_source_branch=None):
3099
 
        """See InterBranch.push.
3100
 
 
3101
 
        This is the basic concrete implementation of push()
3102
 
 
3103
 
        :param _override_hook_source_branch: If specified, run
3104
 
        the hooks passing this Branch as the source, rather than self.
3105
 
        This is for use of RemoteBranch, where push is delegated to the
3106
 
        underlying vfs-based Branch.
3107
 
        """
3108
 
        # TODO: Public option to disable running hooks - should be trivial but
3109
 
        # needs tests.
3110
 
        self.source.lock_read()
3111
 
        try:
3112
 
            return _run_with_write_locked_target(
3113
 
                self.target, self._push_with_bound_branches, overwrite,
3114
 
                stop_revision,
3115
 
                _override_hook_source_branch=_override_hook_source_branch)
3116
 
        finally:
3117
 
            self.source.unlock()
3118
 
 
3119
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3120
 
            _override_hook_source_branch=None):
3121
 
        """Push from source into target, and into target's master if any.
3122
 
        """
3123
 
        def _run_hooks():
3124
 
            if _override_hook_source_branch:
3125
 
                result.source_branch = _override_hook_source_branch
3126
 
            for hook in Branch.hooks['post_push']:
3127
 
                hook(result)
3128
 
 
3129
 
        bound_location = self.target.get_bound_location()
3130
 
        if bound_location and self.target.base != bound_location:
3131
 
            # there is a master branch.
3132
 
            #
3133
 
            # XXX: Why the second check?  Is it even supported for a branch to
3134
 
            # be bound to itself? -- mbp 20070507
3135
 
            master_branch = self.target.get_master_branch()
3136
 
            master_branch.lock_write()
3137
 
            try:
3138
 
                # push into the master from the source branch.
3139
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3140
 
                # and push into the target branch from the source. Note that we
3141
 
                # push from the source branch again, because its considered the
3142
 
                # highest bandwidth repository.
3143
 
                result = self.source._basic_push(self.target, overwrite,
3144
 
                    stop_revision)
3145
 
                result.master_branch = master_branch
3146
 
                result.local_branch = self.target
3147
 
                _run_hooks()
3148
 
                return result
3149
 
            finally:
3150
 
                master_branch.unlock()
3151
 
        else:
3152
 
            # no master branch
3153
 
            result = self.source._basic_push(self.target, overwrite,
3154
 
                stop_revision)
3155
 
            # TODO: Why set master_branch and local_branch if there's no
3156
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3157
 
            # 20070504
3158
 
            result.master_branch = self.target
3159
 
            result.local_branch = None
3160
 
            _run_hooks()
3161
 
            return result
3162
 
 
3163
 
    @classmethod
3164
 
    def is_compatible(self, source, target):
3165
 
        # GenericBranch uses the public API, so always compatible
3166
 
        return True
3167
 
 
3168
 
 
3169
 
class InterToBranch5(GenericInterBranch):
3170
 
 
3171
 
    @staticmethod
3172
 
    def _get_branch_formats_to_test():
3173
 
        return BranchFormat._default_format, BzrBranchFormat5()
3174
 
 
3175
 
    def pull(self, overwrite=False, stop_revision=None,
3176
 
             possible_transports=None, run_hooks=True,
3177
 
             _override_hook_target=None, local=False):
3178
 
        """Pull from source into self, updating my master if any.
3179
 
 
3180
 
        :param run_hooks: Private parameter - if false, this branch
3181
 
            is being called because it's the master of the primary branch,
3182
 
            so it should not run its hooks.
3183
 
        """
3184
 
        bound_location = self.target.get_bound_location()
3185
 
        if local and not bound_location:
3186
 
            raise errors.LocalRequiresBoundBranch()
3187
 
        master_branch = None
3188
 
        if not local and bound_location and self.source.base != bound_location:
3189
 
            # not pulling from master, so we need to update master.
3190
 
            master_branch = self.target.get_master_branch(possible_transports)
3191
 
            master_branch.lock_write()
3192
 
        try:
3193
 
            if master_branch:
3194
 
                # pull from source into master.
3195
 
                master_branch.pull(self.source, overwrite, stop_revision,
3196
 
                    run_hooks=False)
3197
 
            return super(InterToBranch5, self).pull(overwrite,
3198
 
                stop_revision, _hook_master=master_branch,
3199
 
                run_hooks=run_hooks,
3200
 
                _override_hook_target=_override_hook_target)
3201
 
        finally:
3202
 
            if master_branch:
3203
 
                master_branch.unlock()
3204
 
 
3205
3521
 
3206
3522
InterBranch.register_optimiser(GenericInterBranch)
3207
 
InterBranch.register_optimiser(InterToBranch5)