/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
46
46
    )
47
47
""")
48
48
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
 
52
from bzrlib.lock import _RelockDebugMixin
52
53
from bzrlib import registry
53
54
from bzrlib.symbol_versioning import (
54
55
    deprecated_in,
62
63
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
63
64
 
64
65
 
65
 
# TODO: Maybe include checks for common corruption of newlines, etc?
66
 
 
67
 
# TODO: Some operations like log might retrieve the same revisions
68
 
# repeatedly to calculate deltas.  We could perhaps have a weakref
69
 
# cache in memory to make this faster.  In general anything can be
70
 
# cached in memory between lock and unlock operations. .. nb thats
71
 
# what the transaction identity map provides
72
 
 
73
 
 
74
 
######################################################################
75
 
# branch objects
76
 
 
77
 
class Branch(object):
 
66
class Branch(bzrdir.ControlComponent):
78
67
    """Branch holding a history of revisions.
79
68
 
80
 
    base
81
 
        Base directory/url of the branch.
 
69
    :ivar base:
 
70
        Base directory/url of the branch; using control_url and
 
71
        control_transport is more standardized.
82
72
 
83
73
    hooks: An instance of BranchHooks.
84
74
    """
86
76
    # - RBC 20060112
87
77
    base = None
88
78
 
 
79
    @property
 
80
    def control_transport(self):
 
81
        return self._transport
 
82
 
 
83
    @property
 
84
    def user_transport(self):
 
85
        return self.bzrdir.user_transport
 
86
 
89
87
    def __init__(self, *ignored, **ignored_too):
90
88
        self.tags = self._format.make_tags(self)
91
89
        self._revision_history_cache = None
92
90
        self._revision_id_to_revno_cache = None
93
91
        self._partial_revision_id_to_revno_cache = {}
 
92
        self._partial_revision_history_cache = []
94
93
        self._last_revision_info_cache = None
95
94
        self._merge_sorted_revisions_cache = None
96
95
        self._open_hook()
103
102
 
104
103
    def _activate_fallback_location(self, url):
105
104
        """Activate the branch/repository from url as a fallback repository."""
106
 
        self.repository.add_fallback_repository(
107
 
            self._get_fallback_repository(url))
 
105
        repo = self._get_fallback_repository(url)
 
106
        if repo.has_same_location(self.repository):
 
107
            raise errors.UnstackableLocationError(self.user_url, url)
 
108
        self.repository.add_fallback_repository(repo)
108
109
 
109
110
    def break_lock(self):
110
111
        """Break a lock if one is present from another instance.
125
126
            raise errors.UnstackableRepositoryFormat(self.repository._format,
126
127
                self.repository.base)
127
128
 
 
129
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
130
        """Extend the partial history to include a given index
 
131
 
 
132
        If a stop_index is supplied, stop when that index has been reached.
 
133
        If a stop_revision is supplied, stop when that revision is
 
134
        encountered.  Otherwise, stop when the beginning of history is
 
135
        reached.
 
136
 
 
137
        :param stop_index: The index which should be present.  When it is
 
138
            present, history extension will stop.
 
139
        :param stop_revision: The revision id which should be present.  When
 
140
            it is encountered, history extension will stop.
 
141
        """
 
142
        if len(self._partial_revision_history_cache) == 0:
 
143
            self._partial_revision_history_cache = [self.last_revision()]
 
144
        repository._iter_for_revno(
 
145
            self.repository, self._partial_revision_history_cache,
 
146
            stop_index=stop_index, stop_revision=stop_revision)
 
147
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
 
148
            self._partial_revision_history_cache.pop()
 
149
 
 
150
    def _get_check_refs(self):
 
151
        """Get the references needed for check().
 
152
 
 
153
        See bzrlib.check.
 
154
        """
 
155
        revid = self.last_revision()
 
156
        return [('revision-existence', revid), ('lefthand-distance', revid)]
 
157
 
128
158
    @staticmethod
129
159
    def open(base, _unsupported=False, possible_transports=None):
130
160
        """Open the branch rooted at base.
134
164
        """
135
165
        control = bzrdir.BzrDir.open(base, _unsupported,
136
166
                                     possible_transports=possible_transports)
137
 
        return control.open_branch(_unsupported)
 
167
        return control.open_branch(unsupported=_unsupported)
138
168
 
139
169
    @staticmethod
140
 
    def open_from_transport(transport, _unsupported=False):
 
170
    def open_from_transport(transport, name=None, _unsupported=False):
141
171
        """Open the branch rooted at transport"""
142
172
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
143
 
        return control.open_branch(_unsupported)
 
173
        return control.open_branch(name=name, unsupported=_unsupported)
144
174
 
145
175
    @staticmethod
146
176
    def open_containing(url, possible_transports=None):
184
214
    def _get_fallback_repository(self, url):
185
215
        """Get the repository we fallback to at url."""
186
216
        url = urlutils.join(self.base, url)
187
 
        a_bzrdir = bzrdir.BzrDir.open(url,
 
217
        a_branch = Branch.open(url,
188
218
            possible_transports=[self.bzrdir.root_transport])
189
 
        return a_bzrdir.open_branch().repository
 
219
        return a_branch.repository
190
220
 
191
221
    def _get_tags_bytes(self):
192
222
        """Get the bytes of a serialised tags dict.
387
417
            * 'include' - the stop revision is the last item in the result
388
418
            * 'with-merges' - include the stop revision and all of its
389
419
              merged revisions in the result
 
420
            * 'with-merges-without-common-ancestry' - filter out revisions 
 
421
              that are in both ancestries
390
422
        :param direction: either 'reverse' or 'forward':
391
423
            * reverse means return the start_revision_id first, i.e.
392
424
              start at the most recent revision and go backwards in history
414
446
        # start_revision_id.
415
447
        if self._merge_sorted_revisions_cache is None:
416
448
            last_revision = self.last_revision()
417
 
            graph = self.repository.get_graph()
418
 
            parent_map = dict(((key, value) for key, value in
419
 
                     graph.iter_ancestry([last_revision]) if value is not None))
420
 
            revision_graph = repository._strip_NULL_ghosts(parent_map)
421
 
            revs = tsort.merge_sort(revision_graph, last_revision, None,
422
 
                generate_revno=True)
423
 
            # Drop the sequence # before caching
424
 
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
425
 
 
 
449
            known_graph = self.repository.get_known_graph_ancestry(
 
450
                [last_revision])
 
451
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
 
452
                last_revision)
426
453
        filtered = self._filter_merge_sorted_revisions(
427
454
            self._merge_sorted_revisions_cache, start_revision_id,
428
455
            stop_revision_id, stop_rule)
 
456
        # Make sure we don't return revisions that are not part of the
 
457
        # start_revision_id ancestry.
 
458
        filtered = self._filter_start_non_ancestors(filtered)
429
459
        if direction == 'reverse':
430
460
            return filtered
431
461
        if direction == 'forward':
438
468
        """Iterate over an inclusive range of sorted revisions."""
439
469
        rev_iter = iter(merge_sorted_revisions)
440
470
        if start_revision_id is not None:
441
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
471
            for node in rev_iter:
 
472
                rev_id = node.key[-1]
442
473
                if rev_id != start_revision_id:
443
474
                    continue
444
475
                else:
445
476
                    # The decision to include the start or not
446
477
                    # depends on the stop_rule if a stop is provided
447
 
                    rev_iter = chain(
448
 
                        iter([(rev_id, depth, revno, end_of_merge)]),
449
 
                        rev_iter)
 
478
                    # so pop this node back into the iterator
 
479
                    rev_iter = chain(iter([node]), rev_iter)
450
480
                    break
451
481
        if stop_revision_id is None:
452
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
453
 
                yield rev_id, depth, revno, end_of_merge
 
482
            # Yield everything
 
483
            for node in rev_iter:
 
484
                rev_id = node.key[-1]
 
485
                yield (rev_id, node.merge_depth, node.revno,
 
486
                       node.end_of_merge)
454
487
        elif stop_rule == 'exclude':
455
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
488
            for node in rev_iter:
 
489
                rev_id = node.key[-1]
456
490
                if rev_id == stop_revision_id:
457
491
                    return
458
 
                yield rev_id, depth, revno, end_of_merge
 
492
                yield (rev_id, node.merge_depth, node.revno,
 
493
                       node.end_of_merge)
459
494
        elif stop_rule == 'include':
460
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
461
 
                yield rev_id, depth, revno, end_of_merge
 
495
            for node in rev_iter:
 
496
                rev_id = node.key[-1]
 
497
                yield (rev_id, node.merge_depth, node.revno,
 
498
                       node.end_of_merge)
462
499
                if rev_id == stop_revision_id:
463
500
                    return
 
501
        elif stop_rule == 'with-merges-without-common-ancestry':
 
502
            # We want to exclude all revisions that are already part of the
 
503
            # stop_revision_id ancestry.
 
504
            graph = self.repository.get_graph()
 
505
            ancestors = graph.find_unique_ancestors(start_revision_id,
 
506
                                                    [stop_revision_id])
 
507
            for node in rev_iter:
 
508
                rev_id = node.key[-1]
 
509
                if rev_id not in ancestors:
 
510
                    continue
 
511
                yield (rev_id, node.merge_depth, node.revno,
 
512
                       node.end_of_merge)
464
513
        elif stop_rule == 'with-merges':
465
514
            stop_rev = self.repository.get_revision(stop_revision_id)
466
515
            if stop_rev.parent_ids:
467
516
                left_parent = stop_rev.parent_ids[0]
468
517
            else:
469
518
                left_parent = _mod_revision.NULL_REVISION
470
 
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
519
            # left_parent is the actual revision we want to stop logging at,
 
520
            # since we want to show the merged revisions after the stop_rev too
 
521
            reached_stop_revision_id = False
 
522
            revision_id_whitelist = []
 
523
            for node in rev_iter:
 
524
                rev_id = node.key[-1]
471
525
                if rev_id == left_parent:
 
526
                    # reached the left parent after the stop_revision
472
527
                    return
473
 
                yield rev_id, depth, revno, end_of_merge
 
528
                if (not reached_stop_revision_id or
 
529
                        rev_id in revision_id_whitelist):
 
530
                    yield (rev_id, node.merge_depth, node.revno,
 
531
                       node.end_of_merge)
 
532
                    if reached_stop_revision_id or rev_id == stop_revision_id:
 
533
                        # only do the merged revs of rev_id from now on
 
534
                        rev = self.repository.get_revision(rev_id)
 
535
                        if rev.parent_ids:
 
536
                            reached_stop_revision_id = True
 
537
                            revision_id_whitelist.extend(rev.parent_ids)
474
538
        else:
475
539
            raise ValueError('invalid stop_rule %r' % stop_rule)
476
540
 
 
541
    def _filter_start_non_ancestors(self, rev_iter):
 
542
        # If we started from a dotted revno, we want to consider it as a tip
 
543
        # and don't want to yield revisions that are not part of its
 
544
        # ancestry. Given the order guaranteed by the merge sort, we will see
 
545
        # uninteresting descendants of the first parent of our tip before the
 
546
        # tip itself.
 
547
        first = rev_iter.next()
 
548
        (rev_id, merge_depth, revno, end_of_merge) = first
 
549
        yield first
 
550
        if not merge_depth:
 
551
            # We start at a mainline revision so by definition, all others
 
552
            # revisions in rev_iter are ancestors
 
553
            for node in rev_iter:
 
554
                yield node
 
555
 
 
556
        clean = False
 
557
        whitelist = set()
 
558
        pmap = self.repository.get_parent_map([rev_id])
 
559
        parents = pmap.get(rev_id, [])
 
560
        if parents:
 
561
            whitelist.update(parents)
 
562
        else:
 
563
            # If there is no parents, there is nothing of interest left
 
564
 
 
565
            # FIXME: It's hard to test this scenario here as this code is never
 
566
            # called in that case. -- vila 20100322
 
567
            return
 
568
 
 
569
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
 
570
            if not clean:
 
571
                if rev_id in whitelist:
 
572
                    pmap = self.repository.get_parent_map([rev_id])
 
573
                    parents = pmap.get(rev_id, [])
 
574
                    whitelist.remove(rev_id)
 
575
                    whitelist.update(parents)
 
576
                    if merge_depth == 0:
 
577
                        # We've reached the mainline, there is nothing left to
 
578
                        # filter
 
579
                        clean = True
 
580
                else:
 
581
                    # A revision that is not part of the ancestry of our
 
582
                    # starting revision.
 
583
                    continue
 
584
            yield (rev_id, merge_depth, revno, end_of_merge)
 
585
 
477
586
    def leave_lock_in_place(self):
478
587
        """Tell this branch object not to release the physical lock when this
479
588
        object is unlocked.
496
605
        :param other: The branch to bind to
497
606
        :type other: Branch
498
607
        """
499
 
        raise errors.UpgradeRequired(self.base)
 
608
        raise errors.UpgradeRequired(self.user_url)
 
609
 
 
610
    def set_append_revisions_only(self, enabled):
 
611
        if not self._format.supports_set_append_revisions_only():
 
612
            raise errors.UpgradeRequired(self.user_url)
 
613
        if enabled:
 
614
            value = 'True'
 
615
        else:
 
616
            value = 'False'
 
617
        self.get_config().set_user_option('append_revisions_only', value,
 
618
            warn_masked=True)
500
619
 
501
620
    def set_reference_info(self, file_id, tree_path, branch_location):
502
621
        """Set the branch location to use for a tree reference."""
544
663
    def get_old_bound_location(self):
545
664
        """Return the URL of the branch we used to be bound to
546
665
        """
547
 
        raise errors.UpgradeRequired(self.base)
 
666
        raise errors.UpgradeRequired(self.user_url)
548
667
 
549
668
    def get_commit_builder(self, parents, config=None, timestamp=None,
550
669
                           timezone=None, committer=None, revprops=None,
600
719
    def set_revision_history(self, rev_history):
601
720
        raise NotImplementedError(self.set_revision_history)
602
721
 
 
722
    @needs_write_lock
 
723
    def set_parent(self, url):
 
724
        """See Branch.set_parent."""
 
725
        # TODO: Maybe delete old location files?
 
726
        # URLs should never be unicode, even on the local fs,
 
727
        # FIXUP this and get_parent in a future branch format bump:
 
728
        # read and rewrite the file. RBC 20060125
 
729
        if url is not None:
 
730
            if isinstance(url, unicode):
 
731
                try:
 
732
                    url = url.encode('ascii')
 
733
                except UnicodeEncodeError:
 
734
                    raise errors.InvalidURL(url,
 
735
                        "Urls must be 7-bit ascii, "
 
736
                        "use bzrlib.urlutils.escape")
 
737
            url = urlutils.relative_url(self.base, url)
 
738
        self._set_parent_location(url)
 
739
 
 
740
    @needs_write_lock
603
741
    def set_stacked_on_url(self, url):
604
742
        """Set the URL this branch is stacked against.
605
743
 
609
747
            stacking.
610
748
        """
611
749
        if not self._format.supports_stacking():
612
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
 
750
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
751
        # XXX: Changing from one fallback repository to another does not check
 
752
        # that all the data you need is present in the new fallback.
 
753
        # Possibly it should.
613
754
        self._check_stackable_repo()
614
755
        if not url:
615
756
            try:
617
758
            except (errors.NotStacked, errors.UnstackableBranchFormat,
618
759
                errors.UnstackableRepositoryFormat):
619
760
                return
620
 
            url = ''
621
 
            # repositories don't offer an interface to remove fallback
622
 
            # repositories today; take the conceptually simpler option and just
623
 
            # reopen it.
624
 
            self.repository = self.bzrdir.find_repository()
625
 
            # for every revision reference the branch has, ensure it is pulled
626
 
            # in.
627
 
            source_repository = self._get_fallback_repository(old_url)
628
 
            for revision_id in chain([self.last_revision()],
629
 
                self.tags.get_reverse_tag_dict()):
630
 
                self.repository.fetch(source_repository, revision_id,
631
 
                    find_ghosts=True)
 
761
            self._unstack()
632
762
        else:
633
763
            self._activate_fallback_location(url)
634
764
        # write this out after the repository is stacked to avoid setting a
635
765
        # stacked config that doesn't work.
636
766
        self._set_config_location('stacked_on_location', url)
637
767
 
 
768
    def _unstack(self):
 
769
        """Change a branch to be unstacked, copying data as needed.
 
770
        
 
771
        Don't call this directly, use set_stacked_on_url(None).
 
772
        """
 
773
        pb = ui.ui_factory.nested_progress_bar()
 
774
        try:
 
775
            pb.update("Unstacking")
 
776
            # The basic approach here is to fetch the tip of the branch,
 
777
            # including all available ghosts, from the existing stacked
 
778
            # repository into a new repository object without the fallbacks. 
 
779
            #
 
780
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
 
781
            # correct for CHKMap repostiories
 
782
            old_repository = self.repository
 
783
            if len(old_repository._fallback_repositories) != 1:
 
784
                raise AssertionError("can't cope with fallback repositories "
 
785
                    "of %r" % (self.repository,))
 
786
            # unlock it, including unlocking the fallback
 
787
            old_repository.unlock()
 
788
            old_repository.lock_read()
 
789
            try:
 
790
                # Repositories don't offer an interface to remove fallback
 
791
                # repositories today; take the conceptually simpler option and just
 
792
                # reopen it.  We reopen it starting from the URL so that we
 
793
                # get a separate connection for RemoteRepositories and can
 
794
                # stream from one of them to the other.  This does mean doing
 
795
                # separate SSH connection setup, but unstacking is not a
 
796
                # common operation so it's tolerable.
 
797
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
 
798
                new_repository = new_bzrdir.find_repository()
 
799
                self.repository = new_repository
 
800
                if self.repository._fallback_repositories:
 
801
                    raise AssertionError("didn't expect %r to have "
 
802
                        "fallback_repositories"
 
803
                        % (self.repository,))
 
804
                # this is not paired with an unlock because it's just restoring
 
805
                # the previous state; the lock's released when set_stacked_on_url
 
806
                # returns
 
807
                self.repository.lock_write()
 
808
                # XXX: If you unstack a branch while it has a working tree
 
809
                # with a pending merge, the pending-merged revisions will no
 
810
                # longer be present.  You can (probably) revert and remerge.
 
811
                #
 
812
                # XXX: This only fetches up to the tip of the repository; it
 
813
                # doesn't bring across any tags.  That's fairly consistent
 
814
                # with how branch works, but perhaps not ideal.
 
815
                self.repository.fetch(old_repository,
 
816
                    revision_id=self.last_revision(),
 
817
                    find_ghosts=True)
 
818
            finally:
 
819
                old_repository.unlock()
 
820
        finally:
 
821
            pb.finished()
638
822
 
639
823
    def _set_tags_bytes(self, bytes):
640
824
        """Mirror method for _get_tags_bytes.
676
860
        self._revision_id_to_revno_cache = None
677
861
        self._last_revision_info_cache = None
678
862
        self._merge_sorted_revisions_cache = None
 
863
        self._partial_revision_history_cache = []
 
864
        self._partial_revision_id_to_revno_cache = {}
679
865
 
680
866
    def _gen_revision_history(self):
681
867
        """Return sequence of revision hashes on to this branch.
718
904
 
719
905
    def unbind(self):
720
906
        """Older format branches cannot bind or unbind."""
721
 
        raise errors.UpgradeRequired(self.base)
722
 
 
723
 
    def set_append_revisions_only(self, enabled):
724
 
        """Older format branches are never restricted to append-only"""
725
 
        raise errors.UpgradeRequired(self.base)
 
907
        raise errors.UpgradeRequired(self.user_url)
726
908
 
727
909
    def last_revision(self):
728
910
        """Return last revision id, or NULL_REVISION."""
809
991
        except ValueError:
810
992
            raise errors.NoSuchRevision(self, revision_id)
811
993
 
 
994
    @needs_read_lock
812
995
    def get_rev_id(self, revno, history=None):
813
996
        """Find the revision id of the specified revno."""
814
997
        if revno == 0:
815
998
            return _mod_revision.NULL_REVISION
816
 
        if history is None:
817
 
            history = self.revision_history()
818
 
        if revno <= 0 or revno > len(history):
 
999
        last_revno, last_revid = self.last_revision_info()
 
1000
        if revno == last_revno:
 
1001
            return last_revid
 
1002
        if revno <= 0 or revno > last_revno:
819
1003
            raise errors.NoSuchRevision(self, revno)
820
 
        return history[revno - 1]
 
1004
        distance_from_last = last_revno - revno
 
1005
        if len(self._partial_revision_history_cache) <= distance_from_last:
 
1006
            self._extend_partial_history(distance_from_last)
 
1007
        return self._partial_revision_history_cache[distance_from_last]
821
1008
 
 
1009
    @needs_write_lock
822
1010
    def pull(self, source, overwrite=False, stop_revision=None,
823
 
             possible_transports=None, _override_hook_target=None):
 
1011
             possible_transports=None, *args, **kwargs):
824
1012
        """Mirror source into this branch.
825
1013
 
826
1014
        This branch is considered to be 'local', having low latency.
827
1015
 
828
1016
        :returns: PullResult instance
829
1017
        """
830
 
        raise NotImplementedError(self.pull)
 
1018
        return InterBranch.get(source, self).pull(overwrite=overwrite,
 
1019
            stop_revision=stop_revision,
 
1020
            possible_transports=possible_transports, *args, **kwargs)
831
1021
 
832
 
    def push(self, target, overwrite=False, stop_revision=None):
 
1022
    def push(self, target, overwrite=False, stop_revision=None, *args,
 
1023
        **kwargs):
833
1024
        """Mirror this branch into target.
834
1025
 
835
1026
        This branch is considered to be 'local', having low latency.
836
1027
        """
837
 
        raise NotImplementedError(self.push)
 
1028
        return InterBranch.get(self, target).push(overwrite, stop_revision,
 
1029
            *args, **kwargs)
 
1030
 
 
1031
    def lossy_push(self, target, stop_revision=None):
 
1032
        """Push deltas into another branch.
 
1033
 
 
1034
        :note: This does not, like push, retain the revision ids from 
 
1035
            the source branch and will, rather than adding bzr-specific 
 
1036
            metadata, push only those semantics of the revision that can be 
 
1037
            natively represented by this branch' VCS.
 
1038
 
 
1039
        :param target: Target branch
 
1040
        :param stop_revision: Revision to push, defaults to last revision.
 
1041
        :return: BranchPushResult with an extra member revidmap: 
 
1042
            A dictionary mapping revision ids from the target branch 
 
1043
            to new revision ids in the target branch, for each 
 
1044
            revision that was pushed.
 
1045
        """
 
1046
        inter = InterBranch.get(self, target)
 
1047
        lossy_push = getattr(inter, "lossy_push", None)
 
1048
        if lossy_push is None:
 
1049
            raise errors.LossyPushToSameVCS(self, target)
 
1050
        return lossy_push(stop_revision)
838
1051
 
839
1052
    def basis_tree(self):
840
1053
        """Return `Tree` object for last revision."""
857
1070
        try:
858
1071
            return urlutils.join(self.base[:-1], parent)
859
1072
        except errors.InvalidURLJoin, e:
860
 
            raise errors.InaccessibleParent(parent, self.base)
 
1073
            raise errors.InaccessibleParent(parent, self.user_url)
861
1074
 
862
1075
    def _get_parent_location(self):
863
1076
        raise NotImplementedError(self._get_parent_location)
880
1093
            location = None
881
1094
        return location
882
1095
 
 
1096
    def get_child_submit_format(self):
 
1097
        """Return the preferred format of submissions to this branch."""
 
1098
        return self.get_config().get_user_option("child_submit_format")
 
1099
 
883
1100
    def get_submit_branch(self):
884
1101
        """Return the submit location of the branch.
885
1102
 
944
1161
        params = ChangeBranchTipParams(
945
1162
            self, old_revno, new_revno, old_revid, new_revid)
946
1163
        for hook in hooks:
947
 
            try:
948
 
                hook(params)
949
 
            except errors.TipChangeRejected:
950
 
                raise
951
 
            except Exception:
952
 
                exc_info = sys.exc_info()
953
 
                hook_name = Branch.hooks.get_hook_name(hook)
954
 
                raise errors.HookFailed(
955
 
                    'pre_change_branch_tip', hook_name, exc_info)
956
 
 
957
 
    def set_parent(self, url):
958
 
        raise NotImplementedError(self.set_parent)
 
1164
            hook(params)
959
1165
 
960
1166
    @needs_write_lock
961
1167
    def update(self):
992
1198
                     be truncated to end with revision_id.
993
1199
        """
994
1200
        result = to_bzrdir.create_branch()
995
 
        if repository_policy is not None:
996
 
            repository_policy.configure_branch(result)
997
 
        self.copy_content_into(result, revision_id=revision_id)
998
 
        return  result
 
1201
        result.lock_write()
 
1202
        try:
 
1203
            if repository_policy is not None:
 
1204
                repository_policy.configure_branch(result)
 
1205
            self.copy_content_into(result, revision_id=revision_id)
 
1206
        finally:
 
1207
            result.unlock()
 
1208
        return result
999
1209
 
1000
1210
    @needs_read_lock
1001
1211
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1006
1216
        revision_id: if not None, the revision history in the new branch will
1007
1217
                     be truncated to end with revision_id.
1008
1218
        """
 
1219
        if (repository_policy is not None and
 
1220
            repository_policy.requires_stacking()):
 
1221
            to_bzrdir._format.require_stacking(_skip_repo=True)
1009
1222
        result = to_bzrdir.create_branch()
1010
 
        if repository_policy is not None:
1011
 
            repository_policy.configure_branch(result)
1012
 
        self.copy_content_into(result, revision_id=revision_id)
1013
 
        result.set_parent(self.bzrdir.root_transport.base)
 
1223
        result.lock_write()
 
1224
        try:
 
1225
            if repository_policy is not None:
 
1226
                repository_policy.configure_branch(result)
 
1227
            self.copy_content_into(result, revision_id=revision_id)
 
1228
            result.set_parent(self.bzrdir.root_transport.base)
 
1229
        finally:
 
1230
            result.unlock()
1014
1231
        return result
1015
1232
 
1016
1233
    def _synchronize_history(self, destination, revision_id):
1028
1245
        source_revno, source_revision_id = self.last_revision_info()
1029
1246
        if revision_id is None:
1030
1247
            revno, revision_id = source_revno, source_revision_id
1031
 
        elif source_revision_id == revision_id:
1032
 
            # we know the revno without needing to walk all of history
1033
 
            revno = source_revno
1034
1248
        else:
1035
 
            # To figure out the revno for a random revision, we need to build
1036
 
            # the revision history, and count its length.
1037
 
            # We don't care about the order, just how long it is.
1038
 
            # Alternatively, we could start at the current location, and count
1039
 
            # backwards. But there is no guarantee that we will find it since
1040
 
            # it may be a merged revision.
1041
 
            revno = len(list(self.repository.iter_reverse_revision_history(
1042
 
                                                                revision_id)))
 
1249
            graph = self.repository.get_graph()
 
1250
            try:
 
1251
                revno = graph.find_distance_to_null(revision_id, 
 
1252
                    [(source_revision_id, source_revno)])
 
1253
            except errors.GhostRevisionsHaveNoRevno:
 
1254
                # Default to 1, if we can't find anything else
 
1255
                revno = 1
1043
1256
        destination.set_last_revision_info(revno, revision_id)
1044
1257
 
1045
1258
    @needs_read_lock
1079
1292
        target._set_all_reference_info(target_reference_dict)
1080
1293
 
1081
1294
    @needs_read_lock
1082
 
    def check(self):
 
1295
    def check(self, refs):
1083
1296
        """Check consistency of the branch.
1084
1297
 
1085
1298
        In particular this checks that revisions given in the revision-history
1088
1301
 
1089
1302
        Callers will typically also want to check the repository.
1090
1303
 
 
1304
        :param refs: Calculated refs for this branch as specified by
 
1305
            branch._get_check_refs()
1091
1306
        :return: A BranchCheckResult.
1092
1307
        """
1093
 
        mainline_parent_id = None
 
1308
        result = BranchCheckResult(self)
1094
1309
        last_revno, last_revision_id = self.last_revision_info()
1095
 
        real_rev_history = list(self.repository.iter_reverse_revision_history(
1096
 
                                last_revision_id))
1097
 
        real_rev_history.reverse()
1098
 
        if len(real_rev_history) != last_revno:
1099
 
            raise errors.BzrCheckError('revno does not match len(mainline)'
1100
 
                ' %s != %s' % (last_revno, len(real_rev_history)))
1101
 
        # TODO: We should probably also check that real_rev_history actually
1102
 
        #       matches self.revision_history()
1103
 
        for revision_id in real_rev_history:
1104
 
            try:
1105
 
                revision = self.repository.get_revision(revision_id)
1106
 
            except errors.NoSuchRevision, e:
1107
 
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
1108
 
                            % revision_id)
1109
 
            # In general the first entry on the revision history has no parents.
1110
 
            # But it's not illegal for it to have parents listed; this can happen
1111
 
            # in imports from Arch when the parents weren't reachable.
1112
 
            if mainline_parent_id is not None:
1113
 
                if mainline_parent_id not in revision.parent_ids:
1114
 
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
1115
 
                                        "parents of {%s}"
1116
 
                                        % (mainline_parent_id, revision_id))
1117
 
            mainline_parent_id = revision_id
1118
 
        return BranchCheckResult(self)
 
1310
        actual_revno = refs[('lefthand-distance', last_revision_id)]
 
1311
        if actual_revno != last_revno:
 
1312
            result.errors.append(errors.BzrCheckError(
 
1313
                'revno does not match len(mainline) %s != %s' % (
 
1314
                last_revno, actual_revno)))
 
1315
        # TODO: We should probably also check that self.revision_history
 
1316
        # matches the repository for older branch formats.
 
1317
        # If looking for the code that cross-checks repository parents against
 
1318
        # the iter_reverse_revision_history output, that is now a repository
 
1319
        # specific check.
 
1320
        return result
1119
1321
 
1120
1322
    def _get_checkout_format(self):
1121
1323
        """Return the most suitable metadir for a checkout of this branch.
1131
1333
        return format
1132
1334
 
1133
1335
    def create_clone_on_transport(self, to_transport, revision_id=None,
1134
 
        stacked_on=None):
 
1336
        stacked_on=None, create_prefix=False, use_existing_dir=False):
1135
1337
        """Create a clone of this branch and its bzrdir.
1136
1338
 
1137
1339
        :param to_transport: The transport to clone onto.
1138
1340
        :param revision_id: The revision id to use as tip in the new branch.
1139
1341
            If None the tip is obtained from this branch.
1140
1342
        :param stacked_on: An optional URL to stack the clone on.
 
1343
        :param create_prefix: Create any missing directories leading up to
 
1344
            to_transport.
 
1345
        :param use_existing_dir: Use an existing directory if one exists.
1141
1346
        """
1142
1347
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1143
1348
        # clone call. Or something. 20090224 RBC/spiv.
 
1349
        if revision_id is None:
 
1350
            revision_id = self.last_revision()
1144
1351
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1145
 
            revision_id=revision_id, stacked_on=stacked_on)
 
1352
            revision_id=revision_id, stacked_on=stacked_on,
 
1353
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
1146
1354
        return dir_to.open_branch()
1147
1355
 
1148
1356
    def create_checkout(self, to_location, revision_id=None,
1167
1375
        if lightweight:
1168
1376
            format = self._get_checkout_format()
1169
1377
            checkout = format.initialize_on_transport(t)
1170
 
            from_branch = BranchReferenceFormat().initialize(checkout, self)
 
1378
            from_branch = BranchReferenceFormat().initialize(checkout, 
 
1379
                target_branch=self)
1171
1380
        else:
1172
1381
            format = self._get_checkout_format()
1173
1382
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1215
1424
    def supports_tags(self):
1216
1425
        return self._format.supports_tags()
1217
1426
 
 
1427
    def automatic_tag_name(self, revision_id):
 
1428
        """Try to automatically find the tag name for a revision.
 
1429
 
 
1430
        :param revision_id: Revision id of the revision.
 
1431
        :return: A tag name or None if no tag name could be determined.
 
1432
        """
 
1433
        for hook in Branch.hooks['automatic_tag_name']:
 
1434
            ret = hook(self, revision_id)
 
1435
            if ret is not None:
 
1436
                return ret
 
1437
        return None
 
1438
 
1218
1439
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1219
1440
                                         other_branch):
1220
1441
        """Ensure that revision_b is a descendant of revision_a.
1275
1496
    _formats = {}
1276
1497
    """The known formats."""
1277
1498
 
 
1499
    can_set_append_revisions_only = True
 
1500
 
1278
1501
    def __eq__(self, other):
1279
1502
        return self.__class__ is other.__class__
1280
1503
 
1282
1505
        return not (self == other)
1283
1506
 
1284
1507
    @classmethod
1285
 
    def find_format(klass, a_bzrdir):
 
1508
    def find_format(klass, a_bzrdir, name=None):
1286
1509
        """Return the format for the branch object in a_bzrdir."""
1287
1510
        try:
1288
 
            transport = a_bzrdir.get_branch_transport(None)
1289
 
            format_string = transport.get("format").read()
 
1511
            transport = a_bzrdir.get_branch_transport(None, name=name)
 
1512
            format_string = transport.get_bytes("format")
1290
1513
            return klass._formats[format_string]
1291
1514
        except errors.NoSuchFile:
1292
 
            raise errors.NotBranchError(path=transport.base)
 
1515
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1293
1516
        except KeyError:
1294
1517
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1295
1518
 
1331
1554
        """Return the short format description for this format."""
1332
1555
        raise NotImplementedError(self.get_format_description)
1333
1556
 
1334
 
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
1335
 
                           set_format=True):
 
1557
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
 
1558
        hooks = Branch.hooks['post_branch_init']
 
1559
        if not hooks:
 
1560
            return
 
1561
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
 
1562
        for hook in hooks:
 
1563
            hook(params)
 
1564
 
 
1565
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
 
1566
                           lock_type='metadir', set_format=True):
1336
1567
        """Initialize a branch in a bzrdir, with specified files
1337
1568
 
1338
1569
        :param a_bzrdir: The bzrdir to initialize the branch in
1339
1570
        :param utf8_files: The files to create as a list of
1340
1571
            (filename, content) tuples
 
1572
        :param name: Name of colocated branch to create, if any
1341
1573
        :param set_format: If True, set the format with
1342
1574
            self.get_format_string.  (BzrBranch4 has its format set
1343
1575
            elsewhere)
1344
1576
        :return: a branch in this format
1345
1577
        """
1346
 
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
1347
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
1578
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
 
1579
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1348
1580
        lock_map = {
1349
1581
            'metadir': ('lock', lockdir.LockDir),
1350
1582
            'branch4': ('branch-lock', lockable_files.TransportLock),
1353
1585
        control_files = lockable_files.LockableFiles(branch_transport,
1354
1586
            lock_name, lock_class)
1355
1587
        control_files.create_lock()
1356
 
        control_files.lock_write()
 
1588
        try:
 
1589
            control_files.lock_write()
 
1590
        except errors.LockContention:
 
1591
            if lock_type != 'branch4':
 
1592
                raise
 
1593
            lock_taken = False
 
1594
        else:
 
1595
            lock_taken = True
1357
1596
        if set_format:
1358
1597
            utf8_files += [('format', self.get_format_string())]
1359
1598
        try:
1362
1601
                    filename, content,
1363
1602
                    mode=a_bzrdir._get_file_mode())
1364
1603
        finally:
1365
 
            control_files.unlock()
1366
 
        return self.open(a_bzrdir, _found=True)
 
1604
            if lock_taken:
 
1605
                control_files.unlock()
 
1606
        branch = self.open(a_bzrdir, name, _found=True)
 
1607
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
1608
        return branch
1367
1609
 
1368
 
    def initialize(self, a_bzrdir):
1369
 
        """Create a branch of this format in a_bzrdir."""
 
1610
    def initialize(self, a_bzrdir, name=None):
 
1611
        """Create a branch of this format in a_bzrdir.
 
1612
        
 
1613
        :param name: Name of the colocated branch to create.
 
1614
        """
1370
1615
        raise NotImplementedError(self.initialize)
1371
1616
 
1372
1617
    def is_supported(self):
1402
1647
        """
1403
1648
        raise NotImplementedError(self.network_name)
1404
1649
 
1405
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1650
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1406
1651
        """Return the branch object for a_bzrdir
1407
1652
 
1408
1653
        :param a_bzrdir: A BzrDir that contains a branch.
 
1654
        :param name: Name of colocated branch to open
1409
1655
        :param _found: a private parameter, do not use it. It is used to
1410
1656
            indicate if format probing has already be done.
1411
1657
        :param ignore_fallbacks: when set, no fallback branches will be opened
1425
1671
    def set_default_format(klass, format):
1426
1672
        klass._default_format = format
1427
1673
 
 
1674
    def supports_set_append_revisions_only(self):
 
1675
        """True if this format supports set_append_revisions_only."""
 
1676
        return False
 
1677
 
1428
1678
    def supports_stacking(self):
1429
1679
        """True if this format records a stacked-on branch."""
1430
1680
        return False
1515
1765
            "multiple hooks installed for transform_fallback_location, "
1516
1766
            "all are called with the url returned from the previous hook."
1517
1767
            "The order is however undefined.", (1, 9), None))
 
1768
        self.create_hook(HookPoint('automatic_tag_name',
 
1769
            "Called to determine an automatic tag name for a revision."
 
1770
            "automatic_tag_name is called with (branch, revision_id) and "
 
1771
            "should return a tag name or None if no tag name could be "
 
1772
            "determined. The first non-None tag name returned will be used.",
 
1773
            (2, 2), None))
 
1774
        self.create_hook(HookPoint('post_branch_init',
 
1775
            "Called after new branch initialization completes. "
 
1776
            "post_branch_init is called with a "
 
1777
            "bzrlib.branch.BranchInitHookParams. "
 
1778
            "Note that init, branch and checkout (both heavyweight and "
 
1779
            "lightweight) will all trigger this hook.", (2, 2), None))
 
1780
        self.create_hook(HookPoint('post_switch',
 
1781
            "Called after a checkout switches branch. "
 
1782
            "post_switch is called with a "
 
1783
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
 
1784
 
1518
1785
 
1519
1786
 
1520
1787
# install the default hooks into the Branch class.
1559
1826
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1560
1827
 
1561
1828
 
 
1829
class BranchInitHookParams(object):
 
1830
    """Object holding parameters passed to *_branch_init hooks.
 
1831
 
 
1832
    There are 4 fields that hooks may wish to access:
 
1833
 
 
1834
    :ivar format: the branch format
 
1835
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
 
1836
    :ivar name: name of colocated branch, if any (or None)
 
1837
    :ivar branch: the branch created
 
1838
 
 
1839
    Note that for lightweight checkouts, the bzrdir and format fields refer to
 
1840
    the checkout, hence they are different from the corresponding fields in
 
1841
    branch, which refer to the original branch.
 
1842
    """
 
1843
 
 
1844
    def __init__(self, format, a_bzrdir, name, branch):
 
1845
        """Create a group of BranchInitHook parameters.
 
1846
 
 
1847
        :param format: the branch format
 
1848
        :param a_bzrdir: the BzrDir where the branch will be/has been
 
1849
            initialized
 
1850
        :param name: name of colocated branch, if any (or None)
 
1851
        :param branch: the branch created
 
1852
 
 
1853
        Note that for lightweight checkouts, the bzrdir and format fields refer
 
1854
        to the checkout, hence they are different from the corresponding fields
 
1855
        in branch, which refer to the original branch.
 
1856
        """
 
1857
        self.format = format
 
1858
        self.bzrdir = a_bzrdir
 
1859
        self.name = name
 
1860
        self.branch = branch
 
1861
 
 
1862
    def __eq__(self, other):
 
1863
        return self.__dict__ == other.__dict__
 
1864
 
 
1865
    def __repr__(self):
 
1866
        if self.branch:
 
1867
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
 
1868
        else:
 
1869
            return "<%s of format:%s bzrdir:%s>" % (
 
1870
                self.__class__.__name__, self.branch,
 
1871
                self.format, self.bzrdir)
 
1872
 
 
1873
 
 
1874
class SwitchHookParams(object):
 
1875
    """Object holding parameters passed to *_switch hooks.
 
1876
 
 
1877
    There are 4 fields that hooks may wish to access:
 
1878
 
 
1879
    :ivar control_dir: BzrDir of the checkout to change
 
1880
    :ivar to_branch: branch that the checkout is to reference
 
1881
    :ivar force: skip the check for local commits in a heavy checkout
 
1882
    :ivar revision_id: revision ID to switch to (or None)
 
1883
    """
 
1884
 
 
1885
    def __init__(self, control_dir, to_branch, force, revision_id):
 
1886
        """Create a group of SwitchHook parameters.
 
1887
 
 
1888
        :param control_dir: BzrDir of the checkout to change
 
1889
        :param to_branch: branch that the checkout is to reference
 
1890
        :param force: skip the check for local commits in a heavy checkout
 
1891
        :param revision_id: revision ID to switch to (or None)
 
1892
        """
 
1893
        self.control_dir = control_dir
 
1894
        self.to_branch = to_branch
 
1895
        self.force = force
 
1896
        self.revision_id = revision_id
 
1897
 
 
1898
    def __eq__(self, other):
 
1899
        return self.__dict__ == other.__dict__
 
1900
 
 
1901
    def __repr__(self):
 
1902
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
 
1903
            self.control_dir, self.to_branch,
 
1904
            self.revision_id)
 
1905
 
 
1906
 
1562
1907
class BzrBranchFormat4(BranchFormat):
1563
1908
    """Bzr branch format 4.
1564
1909
 
1571
1916
        """See BranchFormat.get_format_description()."""
1572
1917
        return "Branch format 4"
1573
1918
 
1574
 
    def initialize(self, a_bzrdir):
 
1919
    def initialize(self, a_bzrdir, name=None):
1575
1920
        """Create a branch of this format in a_bzrdir."""
1576
1921
        utf8_files = [('revision-history', ''),
1577
1922
                      ('branch-name', ''),
1578
1923
                      ]
1579
 
        return self._initialize_helper(a_bzrdir, utf8_files,
 
1924
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
1580
1925
                                       lock_type='branch4', set_format=False)
1581
1926
 
1582
1927
    def __init__(self):
1587
1932
        """The network name for this format is the control dirs disk label."""
1588
1933
        return self._matchingbzrdir.get_format_string()
1589
1934
 
1590
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1935
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1591
1936
        """See BranchFormat.open()."""
1592
1937
        if not _found:
1593
1938
            # we are being called directly and must probe.
1595
1940
        return BzrBranch(_format=self,
1596
1941
                         _control_files=a_bzrdir._control_files,
1597
1942
                         a_bzrdir=a_bzrdir,
 
1943
                         name=name,
1598
1944
                         _repository=a_bzrdir.open_repository())
1599
1945
 
1600
1946
    def __str__(self):
1615
1961
        """
1616
1962
        return self.get_format_string()
1617
1963
 
1618
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1964
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
1619
1965
        """See BranchFormat.open()."""
1620
1966
        if not _found:
1621
 
            format = BranchFormat.find_format(a_bzrdir)
 
1967
            format = BranchFormat.find_format(a_bzrdir, name=name)
1622
1968
            if format.__class__ != self.__class__:
1623
1969
                raise AssertionError("wrong format %r found for %r" %
1624
1970
                    (format, self))
 
1971
        transport = a_bzrdir.get_branch_transport(None, name=name)
1625
1972
        try:
1626
 
            transport = a_bzrdir.get_branch_transport(None)
1627
1973
            control_files = lockable_files.LockableFiles(transport, 'lock',
1628
1974
                                                         lockdir.LockDir)
1629
1975
            return self._branch_class()(_format=self,
1630
1976
                              _control_files=control_files,
 
1977
                              name=name,
1631
1978
                              a_bzrdir=a_bzrdir,
1632
1979
                              _repository=a_bzrdir.find_repository(),
1633
1980
                              ignore_fallbacks=ignore_fallbacks)
1634
1981
        except errors.NoSuchFile:
1635
 
            raise errors.NotBranchError(path=transport.base)
 
1982
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
1636
1983
 
1637
1984
    def __init__(self):
1638
1985
        super(BranchFormatMetadir, self).__init__()
1667
2014
        """See BranchFormat.get_format_description()."""
1668
2015
        return "Branch format 5"
1669
2016
 
1670
 
    def initialize(self, a_bzrdir):
 
2017
    def initialize(self, a_bzrdir, name=None):
1671
2018
        """Create a branch of this format in a_bzrdir."""
1672
2019
        utf8_files = [('revision-history', ''),
1673
2020
                      ('branch-name', ''),
1674
2021
                      ]
1675
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2022
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1676
2023
 
1677
2024
    def supports_tags(self):
1678
2025
        return False
1700
2047
        """See BranchFormat.get_format_description()."""
1701
2048
        return "Branch format 6"
1702
2049
 
1703
 
    def initialize(self, a_bzrdir):
 
2050
    def initialize(self, a_bzrdir, name=None):
1704
2051
        """Create a branch of this format in a_bzrdir."""
1705
2052
        utf8_files = [('last-revision', '0 null:\n'),
1706
2053
                      ('branch.conf', ''),
1707
2054
                      ('tags', ''),
1708
2055
                      ]
1709
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2056
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1710
2057
 
1711
2058
    def make_tags(self, branch):
1712
2059
        """See bzrlib.branch.BranchFormat.make_tags()."""
1713
2060
        return BasicTags(branch)
1714
2061
 
 
2062
    def supports_set_append_revisions_only(self):
 
2063
        return True
1715
2064
 
1716
2065
 
1717
2066
class BzrBranchFormat8(BranchFormatMetadir):
1728
2077
        """See BranchFormat.get_format_description()."""
1729
2078
        return "Branch format 8"
1730
2079
 
1731
 
    def initialize(self, a_bzrdir):
 
2080
    def initialize(self, a_bzrdir, name=None):
1732
2081
        """Create a branch of this format in a_bzrdir."""
1733
2082
        utf8_files = [('last-revision', '0 null:\n'),
1734
2083
                      ('branch.conf', ''),
1735
2084
                      ('tags', ''),
1736
2085
                      ('references', '')
1737
2086
                      ]
1738
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2087
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1739
2088
 
1740
2089
    def __init__(self):
1741
2090
        super(BzrBranchFormat8, self).__init__()
1746
2095
        """See bzrlib.branch.BranchFormat.make_tags()."""
1747
2096
        return BasicTags(branch)
1748
2097
 
 
2098
    def supports_set_append_revisions_only(self):
 
2099
        return True
 
2100
 
1749
2101
    def supports_stacking(self):
1750
2102
        return True
1751
2103
 
1761
2113
    This format was introduced in bzr 1.6.
1762
2114
    """
1763
2115
 
1764
 
    def initialize(self, a_bzrdir):
 
2116
    def initialize(self, a_bzrdir, name=None):
1765
2117
        """Create a branch of this format in a_bzrdir."""
1766
2118
        utf8_files = [('last-revision', '0 null:\n'),
1767
2119
                      ('branch.conf', ''),
1768
2120
                      ('tags', ''),
1769
2121
                      ]
1770
 
        return self._initialize_helper(a_bzrdir, utf8_files)
 
2122
        return self._initialize_helper(a_bzrdir, utf8_files, name)
1771
2123
 
1772
2124
    def _branch_class(self):
1773
2125
        return BzrBranch7
1780
2132
        """See BranchFormat.get_format_description()."""
1781
2133
        return "Branch format 7"
1782
2134
 
 
2135
    def supports_set_append_revisions_only(self):
 
2136
        return True
 
2137
 
1783
2138
    supports_reference_locations = False
1784
2139
 
1785
2140
 
1805
2160
    def get_reference(self, a_bzrdir):
1806
2161
        """See BranchFormat.get_reference()."""
1807
2162
        transport = a_bzrdir.get_branch_transport(None)
1808
 
        return transport.get('location').read()
 
2163
        return transport.get_bytes('location')
1809
2164
 
1810
2165
    def set_reference(self, a_bzrdir, to_branch):
1811
2166
        """See BranchFormat.set_reference()."""
1812
2167
        transport = a_bzrdir.get_branch_transport(None)
1813
2168
        location = transport.put_bytes('location', to_branch.base)
1814
2169
 
1815
 
    def initialize(self, a_bzrdir, target_branch=None):
 
2170
    def initialize(self, a_bzrdir, name=None, target_branch=None):
1816
2171
        """Create a branch of this format in a_bzrdir."""
1817
2172
        if target_branch is None:
1818
2173
            # this format does not implement branch itself, thus the implicit
1819
2174
            # creation contract must see it as uninitializable
1820
2175
            raise errors.UninitializableFormat(self)
1821
 
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
1822
 
        branch_transport = a_bzrdir.get_branch_transport(self)
 
2176
        mutter('creating branch reference in %s', a_bzrdir.user_url)
 
2177
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
1823
2178
        branch_transport.put_bytes('location',
1824
 
            target_branch.bzrdir.root_transport.base)
 
2179
            target_branch.bzrdir.user_url)
1825
2180
        branch_transport.put_bytes('format', self.get_format_string())
1826
 
        return self.open(
1827
 
            a_bzrdir, _found=True,
 
2181
        branch = self.open(
 
2182
            a_bzrdir, name, _found=True,
1828
2183
            possible_transports=[target_branch.bzrdir.root_transport])
 
2184
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
 
2185
        return branch
1829
2186
 
1830
2187
    def __init__(self):
1831
2188
        super(BranchReferenceFormat, self).__init__()
1837
2194
        def clone(to_bzrdir, revision_id=None,
1838
2195
            repository_policy=None):
1839
2196
            """See Branch.clone()."""
1840
 
            return format.initialize(to_bzrdir, a_branch)
 
2197
            return format.initialize(to_bzrdir, target_branch=a_branch)
1841
2198
            # cannot obey revision_id limits when cloning a reference ...
1842
2199
            # FIXME RBC 20060210 either nuke revision_id for clone, or
1843
2200
            # emit some sort of warning/error to the caller ?!
1844
2201
        return clone
1845
2202
 
1846
 
    def open(self, a_bzrdir, _found=False, location=None,
 
2203
    def open(self, a_bzrdir, name=None, _found=False, location=None,
1847
2204
             possible_transports=None, ignore_fallbacks=False):
1848
2205
        """Return the branch that the branch reference in a_bzrdir points at.
1849
2206
 
1850
2207
        :param a_bzrdir: A BzrDir that contains a branch.
 
2208
        :param name: Name of colocated branch to open, if any
1851
2209
        :param _found: a private parameter, do not use it. It is used to
1852
2210
            indicate if format probing has already be done.
1853
2211
        :param ignore_fallbacks: when set, no fallback branches will be opened
1858
2216
        :param possible_transports: An optional reusable transports list.
1859
2217
        """
1860
2218
        if not _found:
1861
 
            format = BranchFormat.find_format(a_bzrdir)
 
2219
            format = BranchFormat.find_format(a_bzrdir, name=name)
1862
2220
            if format.__class__ != self.__class__:
1863
2221
                raise AssertionError("wrong format %r found for %r" %
1864
2222
                    (format, self))
1866
2224
            location = self.get_reference(a_bzrdir)
1867
2225
        real_bzrdir = bzrdir.BzrDir.open(
1868
2226
            location, possible_transports=possible_transports)
1869
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
2227
        result = real_bzrdir.open_branch(name=name, 
 
2228
            ignore_fallbacks=ignore_fallbacks)
1870
2229
        # this changes the behaviour of result.clone to create a new reference
1871
2230
        # rather than a copy of the content of the branch.
1872
2231
        # I did not use a proxy object because that needs much more extensive
1899
2258
BranchFormat.register_format(__format6)
1900
2259
BranchFormat.register_format(__format7)
1901
2260
BranchFormat.register_format(__format8)
1902
 
BranchFormat.set_default_format(__format6)
 
2261
BranchFormat.set_default_format(__format7)
1903
2262
_legacy_formats = [BzrBranchFormat4(),
1904
2263
    ]
1905
2264
network_format_registry.register(
1906
2265
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
1907
2266
 
1908
2267
 
1909
 
class BzrBranch(Branch):
 
2268
class BzrBranch(Branch, _RelockDebugMixin):
1910
2269
    """A branch stored in the actual filesystem.
1911
2270
 
1912
2271
    Note that it's "local" in the context of the filesystem; it doesn't
1918
2277
    :ivar repository: Repository for this branch.
1919
2278
    :ivar base: The url of the base directory for this branch; the one
1920
2279
        containing the .bzr directory.
 
2280
    :ivar name: Optional colocated branch name as it exists in the control
 
2281
        directory.
1921
2282
    """
1922
2283
 
1923
2284
    def __init__(self, _format=None,
1924
 
                 _control_files=None, a_bzrdir=None, _repository=None,
1925
 
                 ignore_fallbacks=False):
 
2285
                 _control_files=None, a_bzrdir=None, name=None,
 
2286
                 _repository=None, ignore_fallbacks=False):
1926
2287
        """Create new branch object at a particular location."""
1927
2288
        if a_bzrdir is None:
1928
2289
            raise ValueError('a_bzrdir must be supplied')
1929
2290
        else:
1930
2291
            self.bzrdir = a_bzrdir
1931
2292
        self._base = self.bzrdir.transport.clone('..').base
 
2293
        self.name = name
1932
2294
        # XXX: We should be able to just do
1933
2295
        #   self.base = self.bzrdir.root_transport.base
1934
2296
        # but this does not quite work yet -- mbp 20080522
1941
2303
        Branch.__init__(self)
1942
2304
 
1943
2305
    def __str__(self):
1944
 
        return '%s(%r)' % (self.__class__.__name__, self.base)
 
2306
        if self.name is None:
 
2307
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
 
2308
        else:
 
2309
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
 
2310
                self.name)
1945
2311
 
1946
2312
    __repr__ = __str__
1947
2313
 
1958
2324
        return self.control_files.is_locked()
1959
2325
 
1960
2326
    def lock_write(self, token=None):
1961
 
        repo_token = self.repository.lock_write()
 
2327
        if not self.is_locked():
 
2328
            self._note_lock('w')
 
2329
        # All-in-one needs to always unlock/lock.
 
2330
        repo_control = getattr(self.repository, 'control_files', None)
 
2331
        if self.control_files == repo_control or not self.is_locked():
 
2332
            self.repository._warn_if_deprecated(self)
 
2333
            self.repository.lock_write()
 
2334
            took_lock = True
 
2335
        else:
 
2336
            took_lock = False
1962
2337
        try:
1963
 
            token = self.control_files.lock_write(token=token)
 
2338
            return self.control_files.lock_write(token=token)
1964
2339
        except:
1965
 
            self.repository.unlock()
 
2340
            if took_lock:
 
2341
                self.repository.unlock()
1966
2342
            raise
1967
 
        return token
1968
2343
 
1969
2344
    def lock_read(self):
1970
 
        self.repository.lock_read()
 
2345
        if not self.is_locked():
 
2346
            self._note_lock('r')
 
2347
        # All-in-one needs to always unlock/lock.
 
2348
        repo_control = getattr(self.repository, 'control_files', None)
 
2349
        if self.control_files == repo_control or not self.is_locked():
 
2350
            self.repository._warn_if_deprecated(self)
 
2351
            self.repository.lock_read()
 
2352
            took_lock = True
 
2353
        else:
 
2354
            took_lock = False
1971
2355
        try:
1972
2356
            self.control_files.lock_read()
1973
2357
        except:
1974
 
            self.repository.unlock()
 
2358
            if took_lock:
 
2359
                self.repository.unlock()
1975
2360
            raise
1976
2361
 
 
2362
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1977
2363
    def unlock(self):
1978
 
        # TODO: test for failed two phase locks. This is known broken.
1979
2364
        try:
1980
2365
            self.control_files.unlock()
1981
2366
        finally:
1982
 
            self.repository.unlock()
1983
 
        if not self.control_files.is_locked():
1984
 
            # we just released the lock
1985
 
            self._clear_cached_state()
 
2367
            # All-in-one needs to always unlock/lock.
 
2368
            repo_control = getattr(self.repository, 'control_files', None)
 
2369
            if (self.control_files == repo_control or
 
2370
                not self.control_files.is_locked()):
 
2371
                self.repository.unlock()
 
2372
            if not self.control_files.is_locked():
 
2373
                # we just released the lock
 
2374
                self._clear_cached_state()
1986
2375
 
1987
2376
    def peek_lock_mode(self):
1988
2377
        if self.control_files._lock_count == 0:
2107
2496
        """See Branch.basis_tree."""
2108
2497
        return self.repository.revision_tree(self.last_revision())
2109
2498
 
2110
 
    @needs_write_lock
2111
 
    def pull(self, source, overwrite=False, stop_revision=None,
2112
 
             _hook_master=None, run_hooks=True, possible_transports=None,
2113
 
             _override_hook_target=None):
2114
 
        """See Branch.pull.
2115
 
 
2116
 
        :param _hook_master: Private parameter - set the branch to
2117
 
            be supplied as the master to pull hooks.
2118
 
        :param run_hooks: Private parameter - if false, this branch
2119
 
            is being called because it's the master of the primary branch,
2120
 
            so it should not run its hooks.
2121
 
        :param _override_hook_target: Private parameter - set the branch to be
2122
 
            supplied as the target_branch to pull hooks.
2123
 
        """
2124
 
        result = PullResult()
2125
 
        result.source_branch = source
2126
 
        if _override_hook_target is None:
2127
 
            result.target_branch = self
2128
 
        else:
2129
 
            result.target_branch = _override_hook_target
2130
 
        source.lock_read()
2131
 
        try:
2132
 
            # We assume that during 'pull' the local repository is closer than
2133
 
            # the remote one.
2134
 
            source.update_references(self)
2135
 
            graph = self.repository.get_graph(source.repository)
2136
 
            result.old_revno, result.old_revid = self.last_revision_info()
2137
 
            self.update_revisions(source, stop_revision, overwrite=overwrite,
2138
 
                                  graph=graph)
2139
 
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
2140
 
            result.new_revno, result.new_revid = self.last_revision_info()
2141
 
            if _hook_master:
2142
 
                result.master_branch = _hook_master
2143
 
                result.local_branch = result.target_branch
2144
 
            else:
2145
 
                result.master_branch = result.target_branch
2146
 
                result.local_branch = None
2147
 
            if run_hooks:
2148
 
                for hook in Branch.hooks['post_pull']:
2149
 
                    hook(result)
2150
 
        finally:
2151
 
            source.unlock()
2152
 
        return result
2153
 
 
2154
2499
    def _get_parent_location(self):
2155
2500
        _locs = ['parent', 'pull', 'x-pull']
2156
2501
        for l in _locs:
2160
2505
                pass
2161
2506
        return None
2162
2507
 
2163
 
    @needs_read_lock
2164
 
    def push(self, target, overwrite=False, stop_revision=None,
2165
 
             _override_hook_source_branch=None):
2166
 
        """See Branch.push.
2167
 
 
2168
 
        This is the basic concrete implementation of push()
2169
 
 
2170
 
        :param _override_hook_source_branch: If specified, run
2171
 
        the hooks passing this Branch as the source, rather than self.
2172
 
        This is for use of RemoteBranch, where push is delegated to the
2173
 
        underlying vfs-based Branch.
2174
 
        """
2175
 
        # TODO: Public option to disable running hooks - should be trivial but
2176
 
        # needs tests.
2177
 
        return _run_with_write_locked_target(
2178
 
            target, self._push_with_bound_branches, target, overwrite,
2179
 
            stop_revision,
2180
 
            _override_hook_source_branch=_override_hook_source_branch)
2181
 
 
2182
 
    def _push_with_bound_branches(self, target, overwrite,
2183
 
            stop_revision,
2184
 
            _override_hook_source_branch=None):
2185
 
        """Push from self into target, and into target's master if any.
2186
 
 
2187
 
        This is on the base BzrBranch class even though it doesn't support
2188
 
        bound branches because the *target* might be bound.
2189
 
        """
2190
 
        def _run_hooks():
2191
 
            if _override_hook_source_branch:
2192
 
                result.source_branch = _override_hook_source_branch
2193
 
            for hook in Branch.hooks['post_push']:
2194
 
                hook(result)
2195
 
 
2196
 
        bound_location = target.get_bound_location()
2197
 
        if bound_location and target.base != bound_location:
2198
 
            # there is a master branch.
2199
 
            #
2200
 
            # XXX: Why the second check?  Is it even supported for a branch to
2201
 
            # be bound to itself? -- mbp 20070507
2202
 
            master_branch = target.get_master_branch()
2203
 
            master_branch.lock_write()
2204
 
            try:
2205
 
                # push into the master from this branch.
2206
 
                self._basic_push(master_branch, overwrite, stop_revision)
2207
 
                # and push into the target branch from this. Note that we push from
2208
 
                # this branch again, because its considered the highest bandwidth
2209
 
                # repository.
2210
 
                result = self._basic_push(target, overwrite, stop_revision)
2211
 
                result.master_branch = master_branch
2212
 
                result.local_branch = target
2213
 
                _run_hooks()
2214
 
                return result
2215
 
            finally:
2216
 
                master_branch.unlock()
2217
 
        else:
2218
 
            # no master branch
2219
 
            result = self._basic_push(target, overwrite, stop_revision)
2220
 
            # TODO: Why set master_branch and local_branch if there's no
2221
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
2222
 
            # 20070504
2223
 
            result.master_branch = target
2224
 
            result.local_branch = None
2225
 
            _run_hooks()
2226
 
            return result
2227
 
 
2228
2508
    def _basic_push(self, target, overwrite, stop_revision):
2229
2509
        """Basic implementation of push without bound branches or hooks.
2230
2510
 
2231
 
        Must be called with self read locked and target write locked.
 
2511
        Must be called with source read locked and target write locked.
2232
2512
        """
2233
2513
        result = BranchPushResult()
2234
2514
        result.source_branch = self
2239
2519
            # We assume that during 'push' this repository is closer than
2240
2520
            # the target.
2241
2521
            graph = self.repository.get_graph(target.repository)
2242
 
            target.update_revisions(self, stop_revision, overwrite=overwrite,
2243
 
                                    graph=graph)
 
2522
            target.update_revisions(self, stop_revision,
 
2523
                overwrite=overwrite, graph=graph)
2244
2524
        if self._push_should_merge_tags():
2245
 
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
 
2525
            result.tag_conflicts = self.tags.merge_to(target.tags,
 
2526
                overwrite)
2246
2527
        result.new_revno, result.new_revid = target.last_revision_info()
2247
2528
        return result
2248
2529
 
2249
2530
    def get_stacked_on_url(self):
2250
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2531
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2251
2532
 
2252
2533
    def set_push_location(self, location):
2253
2534
        """See Branch.set_push_location."""
2255
2536
            'push_location', location,
2256
2537
            store=_mod_config.STORE_LOCATION_NORECURSE)
2257
2538
 
2258
 
    @needs_write_lock
2259
 
    def set_parent(self, url):
2260
 
        """See Branch.set_parent."""
2261
 
        # TODO: Maybe delete old location files?
2262
 
        # URLs should never be unicode, even on the local fs,
2263
 
        # FIXUP this and get_parent in a future branch format bump:
2264
 
        # read and rewrite the file. RBC 20060125
2265
 
        if url is not None:
2266
 
            if isinstance(url, unicode):
2267
 
                try:
2268
 
                    url = url.encode('ascii')
2269
 
                except UnicodeEncodeError:
2270
 
                    raise errors.InvalidURL(url,
2271
 
                        "Urls must be 7-bit ascii, "
2272
 
                        "use bzrlib.urlutils.escape")
2273
 
            url = urlutils.relative_url(self.base, url)
2274
 
        self._set_parent_location(url)
2275
 
 
2276
2539
    def _set_parent_location(self, url):
2277
2540
        if url is None:
2278
2541
            self._transport.delete('parent')
2287
2550
    It has support for a master_branch which is the data for bound branches.
2288
2551
    """
2289
2552
 
2290
 
    @needs_write_lock
2291
 
    def pull(self, source, overwrite=False, stop_revision=None,
2292
 
             run_hooks=True, possible_transports=None,
2293
 
             _override_hook_target=None):
2294
 
        """Pull from source into self, updating my master if any.
2295
 
 
2296
 
        :param run_hooks: Private parameter - if false, this branch
2297
 
            is being called because it's the master of the primary branch,
2298
 
            so it should not run its hooks.
2299
 
        """
2300
 
        bound_location = self.get_bound_location()
2301
 
        master_branch = None
2302
 
        if bound_location and source.base != bound_location:
2303
 
            # not pulling from master, so we need to update master.
2304
 
            master_branch = self.get_master_branch(possible_transports)
2305
 
            master_branch.lock_write()
2306
 
        try:
2307
 
            if master_branch:
2308
 
                # pull from source into master.
2309
 
                master_branch.pull(source, overwrite, stop_revision,
2310
 
                    run_hooks=False)
2311
 
            return super(BzrBranch5, self).pull(source, overwrite,
2312
 
                stop_revision, _hook_master=master_branch,
2313
 
                run_hooks=run_hooks,
2314
 
                _override_hook_target=_override_hook_target)
2315
 
        finally:
2316
 
            if master_branch:
2317
 
                master_branch.unlock()
2318
 
 
2319
2553
    def get_bound_location(self):
2320
2554
        try:
2321
2555
            return self._transport.get_bytes('bound')[:-1]
2433
2667
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2434
2668
        super(BzrBranch8, self).__init__(*args, **kwargs)
2435
2669
        self._last_revision_info_cache = None
2436
 
        self._partial_revision_history_cache = []
 
2670
        self._reference_info = None
2437
2671
 
2438
2672
    def _clear_cached_state(self):
2439
2673
        super(BzrBranch8, self)._clear_cached_state()
2440
2674
        self._last_revision_info_cache = None
2441
 
        self._partial_revision_history_cache = []
 
2675
        self._reference_info = None
2442
2676
 
2443
2677
    def _last_revision_info(self):
2444
2678
        revision_string = self._transport.get_bytes('last-revision')
2490
2724
        if _mod_revision.is_null(last_revision):
2491
2725
            return
2492
2726
        if last_revision not in self._lefthand_history(revision_id):
2493
 
            raise errors.AppendRevisionsOnlyViolation(self.base)
 
2727
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
2494
2728
 
2495
2729
    def _gen_revision_history(self):
2496
2730
        """Generate the revision history from last revision
2499
2733
        self._extend_partial_history(stop_index=last_revno-1)
2500
2734
        return list(reversed(self._partial_revision_history_cache))
2501
2735
 
2502
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
2503
 
        """Extend the partial history to include a given index
2504
 
 
2505
 
        If a stop_index is supplied, stop when that index has been reached.
2506
 
        If a stop_revision is supplied, stop when that revision is
2507
 
        encountered.  Otherwise, stop when the beginning of history is
2508
 
        reached.
2509
 
 
2510
 
        :param stop_index: The index which should be present.  When it is
2511
 
            present, history extension will stop.
2512
 
        :param revision_id: The revision id which should be present.  When
2513
 
            it is encountered, history extension will stop.
2514
 
        """
2515
 
        repo = self.repository
2516
 
        if len(self._partial_revision_history_cache) == 0:
2517
 
            iterator = repo.iter_reverse_revision_history(self.last_revision())
2518
 
        else:
2519
 
            start_revision = self._partial_revision_history_cache[-1]
2520
 
            iterator = repo.iter_reverse_revision_history(start_revision)
2521
 
            #skip the last revision in the list
2522
 
            next_revision = iterator.next()
2523
 
        for revision_id in iterator:
2524
 
            self._partial_revision_history_cache.append(revision_id)
2525
 
            if (stop_index is not None and
2526
 
                len(self._partial_revision_history_cache) > stop_index):
2527
 
                break
2528
 
            if revision_id == stop_revision:
2529
 
                break
2530
 
 
2531
2736
    def _write_revision_history(self, history):
2532
2737
        """Factored out of set_revision_history.
2533
2738
 
2554
2759
        """Set the parent branch"""
2555
2760
        return self._get_config_location('parent_location')
2556
2761
 
 
2762
    @needs_write_lock
2557
2763
    def _set_all_reference_info(self, info_dict):
2558
2764
        """Replace all reference info stored in a branch.
2559
2765
 
2566
2772
                                branch_location=branch_location)
2567
2773
            writer.write_stanza(stanza)
2568
2774
        self._transport.put_bytes('references', s.getvalue())
 
2775
        self._reference_info = info_dict
2569
2776
 
 
2777
    @needs_read_lock
2570
2778
    def _get_all_reference_info(self):
2571
2779
        """Return all the reference info stored in a branch.
2572
2780
 
2573
2781
        :return: A dict of {file_id: (tree_path, branch_location)}
2574
2782
        """
 
2783
        if self._reference_info is not None:
 
2784
            return self._reference_info
2575
2785
        rio_file = self._transport.get('references')
2576
2786
        try:
2577
2787
            stanzas = rio.read_stanzas(rio_file)
2579
2789
                             s['branch_location'])) for s in stanzas)
2580
2790
        finally:
2581
2791
            rio_file.close()
 
2792
        self._reference_info = info_dict
2582
2793
        return info_dict
2583
2794
 
2584
2795
    def set_reference_info(self, file_id, tree_path, branch_location):
2619
2830
        if branch_location is None:
2620
2831
            return Branch.reference_parent(self, file_id, path,
2621
2832
                                           possible_transports)
2622
 
        branch_location = urlutils.join(self.base, branch_location)
 
2833
        branch_location = urlutils.join(self.user_url, branch_location)
2623
2834
        return Branch.open(branch_location,
2624
2835
                           possible_transports=possible_transports)
2625
2836
 
2670
2881
            raise errors.NotStacked(self)
2671
2882
        return stacked_url
2672
2883
 
2673
 
    def set_append_revisions_only(self, enabled):
2674
 
        if enabled:
2675
 
            value = 'True'
2676
 
        else:
2677
 
            value = 'False'
2678
 
        self.get_config().set_user_option('append_revisions_only', value,
2679
 
            warn_masked=True)
2680
 
 
2681
2884
    def _get_append_revisions_only(self):
2682
 
        value = self.get_config().get_user_option('append_revisions_only')
2683
 
        return value == 'True'
 
2885
        return self.get_config(
 
2886
            ).get_user_option_as_bool('append_revisions_only')
2684
2887
 
2685
2888
    @needs_write_lock
2686
2889
    def generate_revision_history(self, revision_id, last_rev=None,
2748
2951
    """
2749
2952
 
2750
2953
    def get_stacked_on_url(self):
2751
 
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2954
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
2752
2955
 
2753
2956
 
2754
2957
######################################################################
2833
3036
 
2834
3037
    def __init__(self, branch):
2835
3038
        self.branch = branch
 
3039
        self.errors = []
2836
3040
 
2837
3041
    def report_results(self, verbose):
2838
3042
        """Report the check results via trace.note.
2840
3044
        :param verbose: Requests more detailed display of what was checked,
2841
3045
            if any.
2842
3046
        """
2843
 
        note('checked branch %s format %s',
2844
 
             self.branch.base,
2845
 
             self.branch._format)
 
3047
        note('checked branch %s format %s', self.branch.user_url,
 
3048
            self.branch._format)
 
3049
        for error in self.errors:
 
3050
            note('found error:%s', error)
2846
3051
 
2847
3052
 
2848
3053
class Converter5to6(object):
2943
3148
    @staticmethod
2944
3149
    def _get_branch_formats_to_test():
2945
3150
        """Return a tuple with the Branch formats to use when testing."""
2946
 
        raise NotImplementedError(self._get_branch_formats_to_test)
 
3151
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
3152
 
 
3153
    def pull(self, overwrite=False, stop_revision=None,
 
3154
             possible_transports=None, local=False):
 
3155
        """Mirror source into target branch.
 
3156
 
 
3157
        The target branch is considered to be 'local', having low latency.
 
3158
 
 
3159
        :returns: PullResult instance
 
3160
        """
 
3161
        raise NotImplementedError(self.pull)
2947
3162
 
2948
3163
    def update_revisions(self, stop_revision=None, overwrite=False,
2949
3164
                         graph=None):
2958
3173
        """
2959
3174
        raise NotImplementedError(self.update_revisions)
2960
3175
 
 
3176
    def push(self, overwrite=False, stop_revision=None,
 
3177
             _override_hook_source_branch=None):
 
3178
        """Mirror the source branch into the target branch.
 
3179
 
 
3180
        The source branch is considered to be 'local', having low latency.
 
3181
        """
 
3182
        raise NotImplementedError(self.push)
 
3183
 
2961
3184
 
2962
3185
class GenericInterBranch(InterBranch):
2963
3186
    """InterBranch implementation that uses public Branch functions.
3010
3233
        finally:
3011
3234
            self.source.unlock()
3012
3235
 
 
3236
    def pull(self, overwrite=False, stop_revision=None,
 
3237
             possible_transports=None, _hook_master=None, run_hooks=True,
 
3238
             _override_hook_target=None, local=False):
 
3239
        """See Branch.pull.
 
3240
 
 
3241
        :param _hook_master: Private parameter - set the branch to
 
3242
            be supplied as the master to pull hooks.
 
3243
        :param run_hooks: Private parameter - if false, this branch
 
3244
            is being called because it's the master of the primary branch,
 
3245
            so it should not run its hooks.
 
3246
        :param _override_hook_target: Private parameter - set the branch to be
 
3247
            supplied as the target_branch to pull hooks.
 
3248
        :param local: Only update the local branch, and not the bound branch.
 
3249
        """
 
3250
        # This type of branch can't be bound.
 
3251
        if local:
 
3252
            raise errors.LocalRequiresBoundBranch()
 
3253
        result = PullResult()
 
3254
        result.source_branch = self.source
 
3255
        if _override_hook_target is None:
 
3256
            result.target_branch = self.target
 
3257
        else:
 
3258
            result.target_branch = _override_hook_target
 
3259
        self.source.lock_read()
 
3260
        try:
 
3261
            # We assume that during 'pull' the target repository is closer than
 
3262
            # the source one.
 
3263
            self.source.update_references(self.target)
 
3264
            graph = self.target.repository.get_graph(self.source.repository)
 
3265
            # TODO: Branch formats should have a flag that indicates 
 
3266
            # that revno's are expensive, and pull() should honor that flag.
 
3267
            # -- JRV20090506
 
3268
            result.old_revno, result.old_revid = \
 
3269
                self.target.last_revision_info()
 
3270
            self.target.update_revisions(self.source, stop_revision,
 
3271
                overwrite=overwrite, graph=graph)
 
3272
            # TODO: The old revid should be specified when merging tags, 
 
3273
            # so a tags implementation that versions tags can only 
 
3274
            # pull in the most recent changes. -- JRV20090506
 
3275
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
 
3276
                overwrite)
 
3277
            result.new_revno, result.new_revid = self.target.last_revision_info()
 
3278
            if _hook_master:
 
3279
                result.master_branch = _hook_master
 
3280
                result.local_branch = result.target_branch
 
3281
            else:
 
3282
                result.master_branch = result.target_branch
 
3283
                result.local_branch = None
 
3284
            if run_hooks:
 
3285
                for hook in Branch.hooks['post_pull']:
 
3286
                    hook(result)
 
3287
        finally:
 
3288
            self.source.unlock()
 
3289
        return result
 
3290
 
 
3291
    def push(self, overwrite=False, stop_revision=None,
 
3292
             _override_hook_source_branch=None):
 
3293
        """See InterBranch.push.
 
3294
 
 
3295
        This is the basic concrete implementation of push()
 
3296
 
 
3297
        :param _override_hook_source_branch: If specified, run
 
3298
        the hooks passing this Branch as the source, rather than self.
 
3299
        This is for use of RemoteBranch, where push is delegated to the
 
3300
        underlying vfs-based Branch.
 
3301
        """
 
3302
        # TODO: Public option to disable running hooks - should be trivial but
 
3303
        # needs tests.
 
3304
        self.source.lock_read()
 
3305
        try:
 
3306
            return _run_with_write_locked_target(
 
3307
                self.target, self._push_with_bound_branches, overwrite,
 
3308
                stop_revision,
 
3309
                _override_hook_source_branch=_override_hook_source_branch)
 
3310
        finally:
 
3311
            self.source.unlock()
 
3312
 
 
3313
    def _push_with_bound_branches(self, overwrite, stop_revision,
 
3314
            _override_hook_source_branch=None):
 
3315
        """Push from source into target, and into target's master if any.
 
3316
        """
 
3317
        def _run_hooks():
 
3318
            if _override_hook_source_branch:
 
3319
                result.source_branch = _override_hook_source_branch
 
3320
            for hook in Branch.hooks['post_push']:
 
3321
                hook(result)
 
3322
 
 
3323
        bound_location = self.target.get_bound_location()
 
3324
        if bound_location and self.target.base != bound_location:
 
3325
            # there is a master branch.
 
3326
            #
 
3327
            # XXX: Why the second check?  Is it even supported for a branch to
 
3328
            # be bound to itself? -- mbp 20070507
 
3329
            master_branch = self.target.get_master_branch()
 
3330
            master_branch.lock_write()
 
3331
            try:
 
3332
                # push into the master from the source branch.
 
3333
                self.source._basic_push(master_branch, overwrite, stop_revision)
 
3334
                # and push into the target branch from the source. Note that we
 
3335
                # push from the source branch again, because its considered the
 
3336
                # highest bandwidth repository.
 
3337
                result = self.source._basic_push(self.target, overwrite,
 
3338
                    stop_revision)
 
3339
                result.master_branch = master_branch
 
3340
                result.local_branch = self.target
 
3341
                _run_hooks()
 
3342
                return result
 
3343
            finally:
 
3344
                master_branch.unlock()
 
3345
        else:
 
3346
            # no master branch
 
3347
            result = self.source._basic_push(self.target, overwrite,
 
3348
                stop_revision)
 
3349
            # TODO: Why set master_branch and local_branch if there's no
 
3350
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
3351
            # 20070504
 
3352
            result.master_branch = self.target
 
3353
            result.local_branch = None
 
3354
            _run_hooks()
 
3355
            return result
 
3356
 
3013
3357
    @classmethod
3014
3358
    def is_compatible(self, source, target):
3015
3359
        # GenericBranch uses the public API, so always compatible
3016
3360
        return True
3017
3361
 
3018
3362
 
 
3363
class InterToBranch5(GenericInterBranch):
 
3364
 
 
3365
    @staticmethod
 
3366
    def _get_branch_formats_to_test():
 
3367
        return BranchFormat._default_format, BzrBranchFormat5()
 
3368
 
 
3369
    def pull(self, overwrite=False, stop_revision=None,
 
3370
             possible_transports=None, run_hooks=True,
 
3371
             _override_hook_target=None, local=False):
 
3372
        """Pull from source into self, updating my master if any.
 
3373
 
 
3374
        :param run_hooks: Private parameter - if false, this branch
 
3375
            is being called because it's the master of the primary branch,
 
3376
            so it should not run its hooks.
 
3377
        """
 
3378
        bound_location = self.target.get_bound_location()
 
3379
        if local and not bound_location:
 
3380
            raise errors.LocalRequiresBoundBranch()
 
3381
        master_branch = None
 
3382
        if not local and bound_location and self.source.user_url != bound_location:
 
3383
            # not pulling from master, so we need to update master.
 
3384
            master_branch = self.target.get_master_branch(possible_transports)
 
3385
            master_branch.lock_write()
 
3386
        try:
 
3387
            if master_branch:
 
3388
                # pull from source into master.
 
3389
                master_branch.pull(self.source, overwrite, stop_revision,
 
3390
                    run_hooks=False)
 
3391
            return super(InterToBranch5, self).pull(overwrite,
 
3392
                stop_revision, _hook_master=master_branch,
 
3393
                run_hooks=run_hooks,
 
3394
                _override_hook_target=_override_hook_target)
 
3395
        finally:
 
3396
            if master_branch:
 
3397
                master_branch.unlock()
 
3398
 
 
3399
 
3019
3400
InterBranch.register_optimiser(GenericInterBranch)
 
3401
InterBranch.register_optimiser(InterToBranch5)