/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: Aaron Bentley
  • Date: 2009-04-14 15:02:46 UTC
  • mto: This revision was merged to the branch mainline in revision 4302.
  • Revision ID: aaron@aaronbentley.com-20090414150246-6xfd3bwwf2m8v4px
Cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 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, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
50
from bzrlib.hooks import HookPoint, Hooks
51
51
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
52
from bzrlib import registry
54
53
from bzrlib.symbol_versioning import (
55
54
    deprecated_in,
63
62
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
63
 
65
64
 
66
 
class Branch(bzrdir.ControlComponent):
 
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):
67
78
    """Branch holding a history of revisions.
68
79
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
80
    base
 
81
        Base directory/url of the branch.
72
82
 
73
83
    hooks: An instance of BranchHooks.
74
84
    """
76
86
    # - RBC 20060112
77
87
    base = None
78
88
 
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
 
 
87
89
    def __init__(self, *ignored, **ignored_too):
88
90
        self.tags = self._format.make_tags(self)
89
91
        self._revision_history_cache = None
90
92
        self._revision_id_to_revno_cache = None
91
93
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
94
        self._last_revision_info_cache = None
94
95
        self._merge_sorted_revisions_cache = None
95
96
        self._open_hook()
102
103
 
103
104
    def _activate_fallback_location(self, url):
104
105
        """Activate the branch/repository from url as a fallback repository."""
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)
 
106
        self.repository.add_fallback_repository(
 
107
            self._get_fallback_repository(url))
109
108
 
110
109
    def break_lock(self):
111
110
        """Break a lock if one is present from another instance.
126
125
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
126
                self.repository.base)
128
127
 
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
 
 
158
128
    @staticmethod
159
129
    def open(base, _unsupported=False, possible_transports=None):
160
130
        """Open the branch rooted at base.
164
134
        """
165
135
        control = bzrdir.BzrDir.open(base, _unsupported,
166
136
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
137
        return control.open_branch(_unsupported)
168
138
 
169
139
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
140
    def open_from_transport(transport, _unsupported=False):
171
141
        """Open the branch rooted at transport"""
172
142
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
143
        return control.open_branch(_unsupported)
174
144
 
175
145
    @staticmethod
176
146
    def open_containing(url, possible_transports=None):
214
184
    def _get_fallback_repository(self, url):
215
185
        """Get the repository we fallback to at url."""
216
186
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
187
        a_bzrdir = bzrdir.BzrDir.open(url,
218
188
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
189
        return a_bzrdir.open_branch().repository
220
190
 
221
191
    def _get_tags_bytes(self):
222
192
        """Get the bytes of a serialised tags dict.
417
387
            * 'include' - the stop revision is the last item in the result
418
388
            * 'with-merges' - include the stop revision and all of its
419
389
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
390
        :param direction: either 'reverse' or 'forward':
423
391
            * reverse means return the start_revision_id first, i.e.
424
392
              start at the most recent revision and go backwards in history
446
414
        # start_revision_id.
447
415
        if self._merge_sorted_revisions_cache is None:
448
416
            last_revision = self.last_revision()
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)
 
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
 
453
426
        filtered = self._filter_merge_sorted_revisions(
454
427
            self._merge_sorted_revisions_cache, start_revision_id,
455
428
            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)
459
429
        if direction == 'reverse':
460
430
            return filtered
461
431
        if direction == 'forward':
468
438
        """Iterate over an inclusive range of sorted revisions."""
469
439
        rev_iter = iter(merge_sorted_revisions)
470
440
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
442
                if rev_id != start_revision_id:
474
443
                    continue
475
444
                else:
476
445
                    # The decision to include the start or not
477
446
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
480
450
                    break
481
451
        if stop_revision_id is None:
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)
 
452
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
453
                yield rev_id, depth, revno, end_of_merge
487
454
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
456
                if rev_id == stop_revision_id:
491
457
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
494
459
        elif stop_rule == 'include':
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)
 
460
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
461
                yield rev_id, depth, revno, end_of_merge
499
462
                if rev_id == stop_revision_id:
500
463
                    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)
513
464
        elif stop_rule == 'with-merges':
514
465
            stop_rev = self.repository.get_revision(stop_revision_id)
515
466
            if stop_rev.parent_ids:
516
467
                left_parent = stop_rev.parent_ids[0]
517
468
            else:
518
469
                left_parent = _mod_revision.NULL_REVISION
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]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
471
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
472
                    return
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)
 
473
                yield rev_id, depth, revno, end_of_merge
538
474
        else:
539
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
476
 
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
 
 
586
477
    def leave_lock_in_place(self):
587
478
        """Tell this branch object not to release the physical lock when this
588
479
        object is unlocked.
605
496
        :param other: The branch to bind to
606
497
        :type other: Branch
607
498
        """
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)
 
499
        raise errors.UpgradeRequired(self.base)
619
500
 
620
501
    def set_reference_info(self, file_id, tree_path, branch_location):
621
502
        """Set the branch location to use for a tree reference."""
663
544
    def get_old_bound_location(self):
664
545
        """Return the URL of the branch we used to be bound to
665
546
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
667
548
 
668
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
550
                           timezone=None, committer=None, revprops=None,
719
600
    def set_revision_history(self, rev_history):
720
601
        raise NotImplementedError(self.set_revision_history)
721
602
 
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
741
603
    def set_stacked_on_url(self, url):
742
604
        """Set the URL this branch is stacked against.
743
605
 
747
609
            stacking.
748
610
        """
749
611
        if not self._format.supports_stacking():
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.
 
612
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
613
        self._check_stackable_repo()
755
614
        if not url:
756
615
            try:
758
617
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
618
                errors.UnstackableRepositoryFormat):
760
619
                return
761
 
            self._unstack()
 
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)
762
632
        else:
763
633
            self._activate_fallback_location(url)
764
634
        # write this out after the repository is stacked to avoid setting a
765
635
        # stacked config that doesn't work.
766
636
        self._set_config_location('stacked_on_location', url)
767
637
 
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()
822
638
 
823
639
    def _set_tags_bytes(self, bytes):
824
640
        """Mirror method for _get_tags_bytes.
860
676
        self._revision_id_to_revno_cache = None
861
677
        self._last_revision_info_cache = None
862
678
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
679
 
866
680
    def _gen_revision_history(self):
867
681
        """Return sequence of revision hashes on to this branch.
904
718
 
905
719
    def unbind(self):
906
720
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
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)
908
726
 
909
727
    def last_revision(self):
910
728
        """Return last revision id, or NULL_REVISION."""
991
809
        except ValueError:
992
810
            raise errors.NoSuchRevision(self, revision_id)
993
811
 
994
 
    @needs_read_lock
995
812
    def get_rev_id(self, revno, history=None):
996
813
        """Find the revision id of the specified revno."""
997
814
        if revno == 0:
998
815
            return _mod_revision.NULL_REVISION
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:
 
816
        if history is None:
 
817
            history = self.revision_history()
 
818
        if revno <= 0 or revno > len(history):
1003
819
            raise errors.NoSuchRevision(self, revno)
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]
 
820
        return history[revno - 1]
1008
821
 
1009
 
    @needs_write_lock
1010
822
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
823
             possible_transports=None, _override_hook_target=None):
1012
824
        """Mirror source into this branch.
1013
825
 
1014
826
        This branch is considered to be 'local', having low latency.
1015
827
 
1016
828
        :returns: PullResult instance
1017
829
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
830
        raise NotImplementedError(self.pull)
1021
831
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
832
    def push(self, target, overwrite=False, stop_revision=None):
1024
833
        """Mirror this branch into target.
1025
834
 
1026
835
        This branch is considered to be 'local', having low latency.
1027
836
        """
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)
 
837
        raise NotImplementedError(self.push)
1051
838
 
1052
839
    def basis_tree(self):
1053
840
        """Return `Tree` object for last revision."""
1070
857
        try:
1071
858
            return urlutils.join(self.base[:-1], parent)
1072
859
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
860
            raise errors.InaccessibleParent(parent, self.base)
1074
861
 
1075
862
    def _get_parent_location(self):
1076
863
        raise NotImplementedError(self._get_parent_location)
1093
880
            location = None
1094
881
        return location
1095
882
 
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
 
 
1100
883
    def get_submit_branch(self):
1101
884
        """Return the submit location of the branch.
1102
885
 
1161
944
        params = ChangeBranchTipParams(
1162
945
            self, old_revno, new_revno, old_revid, new_revid)
1163
946
        for hook in hooks:
1164
 
            hook(params)
 
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)
1165
959
 
1166
960
    @needs_write_lock
1167
961
    def update(self):
1198
992
                     be truncated to end with revision_id.
1199
993
        """
1200
994
        result = to_bzrdir.create_branch()
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
 
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
1209
999
 
1210
1000
    @needs_read_lock
1211
1001
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1216
1006
        revision_id: if not None, the revision history in the new branch will
1217
1007
                     be truncated to end with revision_id.
1218
1008
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
1009
        result = to_bzrdir.create_branch()
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()
 
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)
1231
1014
        return result
1232
1015
 
1233
1016
    def _synchronize_history(self, destination, revision_id):
1245
1028
        source_revno, source_revision_id = self.last_revision_info()
1246
1029
        if revision_id is None:
1247
1030
            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
1248
1034
        else:
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
 
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)))
1256
1043
        destination.set_last_revision_info(revno, revision_id)
1257
1044
 
1258
1045
    @needs_read_lock
1277
1064
    def update_references(self, target):
1278
1065
        if not getattr(self._format, 'supports_reference_locations', False):
1279
1066
            return
1280
 
        reference_dict = self._get_all_reference_info()
 
1067
        reference_dict = self._get_info_dict()
1281
1068
        if len(reference_dict) == 0:
1282
1069
            return
1283
1070
        old_base = self.base
1284
1071
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
 
1072
        target_reference_dict = target._get_info_dict()
1286
1073
        for file_id, (tree_path, branch_location) in (
1287
1074
            reference_dict.items()):
1288
1075
            branch_location = urlutils.rebase_url(branch_location,
1289
1076
                                                  old_base, new_base)
1290
1077
            target_reference_dict.setdefault(
1291
1078
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
 
1079
        target._save_reference_dict(target_reference_dict)
1293
1080
 
1294
1081
    @needs_read_lock
1295
 
    def check(self, refs):
 
1082
    def check(self):
1296
1083
        """Check consistency of the branch.
1297
1084
 
1298
1085
        In particular this checks that revisions given in the revision-history
1301
1088
 
1302
1089
        Callers will typically also want to check the repository.
1303
1090
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1091
        :return: A BranchCheckResult.
1307
1092
        """
1308
 
        result = BranchCheckResult(self)
 
1093
        mainline_parent_id = None
1309
1094
        last_revno, last_revision_id = self.last_revision_info()
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
 
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)
1321
1119
 
1322
1120
    def _get_checkout_format(self):
1323
1121
        """Return the most suitable metadir for a checkout of this branch.
1333
1131
        return format
1334
1132
 
1335
1133
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1134
        stacked_on=None):
1337
1135
        """Create a clone of this branch and its bzrdir.
1338
1136
 
1339
1137
        :param to_transport: The transport to clone onto.
1340
1138
        :param revision_id: The revision id to use as tip in the new branch.
1341
1139
            If None the tip is obtained from this branch.
1342
1140
        :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.
1346
1141
        """
1347
1142
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1143
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1144
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1145
            revision_id=revision_id, stacked_on=stacked_on)
1354
1146
        return dir_to.open_branch()
1355
1147
 
1356
1148
    def create_checkout(self, to_location, revision_id=None,
1375
1167
        if lightweight:
1376
1168
            format = self._get_checkout_format()
1377
1169
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1170
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1171
        else:
1381
1172
            format = self._get_checkout_format()
1382
1173
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1424
1215
    def supports_tags(self):
1425
1216
        return self._format.supports_tags()
1426
1217
 
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
 
 
1439
1218
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1219
                                         other_branch):
1441
1220
        """Ensure that revision_b is a descendant of revision_a.
1496
1275
    _formats = {}
1497
1276
    """The known formats."""
1498
1277
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1278
    def __eq__(self, other):
1502
1279
        return self.__class__ is other.__class__
1503
1280
 
1505
1282
        return not (self == other)
1506
1283
 
1507
1284
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1285
    def find_format(klass, a_bzrdir):
1509
1286
        """Return the format for the branch object in a_bzrdir."""
1510
1287
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1288
            transport = a_bzrdir.get_branch_transport(None)
 
1289
            format_string = transport.get("format").read()
1513
1290
            return klass._formats[format_string]
1514
1291
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1292
            raise errors.NotBranchError(path=transport.base)
1516
1293
        except KeyError:
1517
1294
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1295
 
1554
1331
        """Return the short format description for this format."""
1555
1332
        raise NotImplementedError(self.get_format_description)
1556
1333
 
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):
 
1334
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1335
                           set_format=True):
1567
1336
        """Initialize a branch in a bzrdir, with specified files
1568
1337
 
1569
1338
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1339
        :param utf8_files: The files to create as a list of
1571
1340
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1341
        :param set_format: If True, set the format with
1574
1342
            self.get_format_string.  (BzrBranch4 has its format set
1575
1343
            elsewhere)
1576
1344
        :return: a branch in this format
1577
1345
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1346
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1347
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1348
        lock_map = {
1581
1349
            'metadir': ('lock', lockdir.LockDir),
1582
1350
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1353
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1354
            lock_name, lock_class)
1587
1355
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1356
        control_files.lock_write()
1596
1357
        if set_format:
1597
1358
            utf8_files += [('format', self.get_format_string())]
1598
1359
        try:
1601
1362
                    filename, content,
1602
1363
                    mode=a_bzrdir._get_file_mode())
1603
1364
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1365
            control_files.unlock()
 
1366
        return self.open(a_bzrdir, _found=True)
1609
1367
 
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
 
        """
 
1368
    def initialize(self, a_bzrdir):
 
1369
        """Create a branch of this format in a_bzrdir."""
1615
1370
        raise NotImplementedError(self.initialize)
1616
1371
 
1617
1372
    def is_supported(self):
1647
1402
        """
1648
1403
        raise NotImplementedError(self.network_name)
1649
1404
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1405
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1406
        """Return the branch object for a_bzrdir
1652
1407
 
1653
1408
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1409
        :param _found: a private parameter, do not use it. It is used to
1656
1410
            indicate if format probing has already be done.
1657
1411
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1425
    def set_default_format(klass, format):
1672
1426
        klass._default_format = format
1673
1427
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1428
    def supports_stacking(self):
1679
1429
        """True if this format records a stacked-on branch."""
1680
1430
        return False
1765
1515
            "multiple hooks installed for transform_fallback_location, "
1766
1516
            "all are called with the url returned from the previous hook."
1767
1517
            "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
 
 
1785
1518
 
1786
1519
 
1787
1520
# install the default hooks into the Branch class.
1826
1559
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1560
 
1828
1561
 
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
 
 
1907
1562
class BzrBranchFormat4(BranchFormat):
1908
1563
    """Bzr branch format 4.
1909
1564
 
1916
1571
        """See BranchFormat.get_format_description()."""
1917
1572
        return "Branch format 4"
1918
1573
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1574
    def initialize(self, a_bzrdir):
1920
1575
        """Create a branch of this format in a_bzrdir."""
1921
1576
        utf8_files = [('revision-history', ''),
1922
1577
                      ('branch-name', ''),
1923
1578
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1579
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1580
                                       lock_type='branch4', set_format=False)
1926
1581
 
1927
1582
    def __init__(self):
1932
1587
        """The network name for this format is the control dirs disk label."""
1933
1588
        return self._matchingbzrdir.get_format_string()
1934
1589
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1590
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1591
        """See BranchFormat.open()."""
1937
1592
        if not _found:
1938
1593
            # we are being called directly and must probe.
1940
1595
        return BzrBranch(_format=self,
1941
1596
                         _control_files=a_bzrdir._control_files,
1942
1597
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1598
                         _repository=a_bzrdir.open_repository())
1945
1599
 
1946
1600
    def __str__(self):
1961
1615
        """
1962
1616
        return self.get_format_string()
1963
1617
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1618
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1619
        """See BranchFormat.open()."""
1966
1620
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1621
            format = BranchFormat.find_format(a_bzrdir)
1968
1622
            if format.__class__ != self.__class__:
1969
1623
                raise AssertionError("wrong format %r found for %r" %
1970
1624
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1625
        try:
 
1626
            transport = a_bzrdir.get_branch_transport(None)
1973
1627
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1628
                                                         lockdir.LockDir)
1975
1629
            return self._branch_class()(_format=self,
1976
1630
                              _control_files=control_files,
1977
 
                              name=name,
1978
1631
                              a_bzrdir=a_bzrdir,
1979
1632
                              _repository=a_bzrdir.find_repository(),
1980
1633
                              ignore_fallbacks=ignore_fallbacks)
1981
1634
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1635
            raise errors.NotBranchError(path=transport.base)
1983
1636
 
1984
1637
    def __init__(self):
1985
1638
        super(BranchFormatMetadir, self).__init__()
2014
1667
        """See BranchFormat.get_format_description()."""
2015
1668
        return "Branch format 5"
2016
1669
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1670
    def initialize(self, a_bzrdir):
2018
1671
        """Create a branch of this format in a_bzrdir."""
2019
1672
        utf8_files = [('revision-history', ''),
2020
1673
                      ('branch-name', ''),
2021
1674
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1675
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1676
 
2024
1677
    def supports_tags(self):
2025
1678
        return False
2047
1700
        """See BranchFormat.get_format_description()."""
2048
1701
        return "Branch format 6"
2049
1702
 
2050
 
    def initialize(self, a_bzrdir, name=None):
 
1703
    def initialize(self, a_bzrdir):
2051
1704
        """Create a branch of this format in a_bzrdir."""
2052
1705
        utf8_files = [('last-revision', '0 null:\n'),
2053
1706
                      ('branch.conf', ''),
2054
1707
                      ('tags', ''),
2055
1708
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1709
        return self._initialize_helper(a_bzrdir, utf8_files)
2057
1710
 
2058
1711
    def make_tags(self, branch):
2059
1712
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
1713
        return BasicTags(branch)
2061
1714
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
1715
 
2065
1716
 
2066
1717
class BzrBranchFormat8(BranchFormatMetadir):
2077
1728
        """See BranchFormat.get_format_description()."""
2078
1729
        return "Branch format 8"
2079
1730
 
2080
 
    def initialize(self, a_bzrdir, name=None):
 
1731
    def initialize(self, a_bzrdir):
2081
1732
        """Create a branch of this format in a_bzrdir."""
2082
1733
        utf8_files = [('last-revision', '0 null:\n'),
2083
1734
                      ('branch.conf', ''),
2084
1735
                      ('tags', ''),
2085
1736
                      ('references', '')
2086
1737
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1738
        return self._initialize_helper(a_bzrdir, utf8_files)
2088
1739
 
2089
1740
    def __init__(self):
2090
1741
        super(BzrBranchFormat8, self).__init__()
2095
1746
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
1747
        return BasicTags(branch)
2097
1748
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
1749
    def supports_stacking(self):
2102
1750
        return True
2103
1751
 
2113
1761
    This format was introduced in bzr 1.6.
2114
1762
    """
2115
1763
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1764
    def _branch_class(self):
2125
1765
        return BzrBranch7
2126
1766
 
2132
1772
        """See BranchFormat.get_format_description()."""
2133
1773
        return "Branch format 7"
2134
1774
 
2135
 
    def supports_set_append_revisions_only(self):
2136
 
        return True
2137
 
 
2138
1775
    supports_reference_locations = False
2139
1776
 
2140
1777
 
2160
1797
    def get_reference(self, a_bzrdir):
2161
1798
        """See BranchFormat.get_reference()."""
2162
1799
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1800
        return transport.get('location').read()
2164
1801
 
2165
1802
    def set_reference(self, a_bzrdir, to_branch):
2166
1803
        """See BranchFormat.set_reference()."""
2167
1804
        transport = a_bzrdir.get_branch_transport(None)
2168
1805
        location = transport.put_bytes('location', to_branch.base)
2169
1806
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1807
    def initialize(self, a_bzrdir, target_branch=None):
2171
1808
        """Create a branch of this format in a_bzrdir."""
2172
1809
        if target_branch is None:
2173
1810
            # this format does not implement branch itself, thus the implicit
2174
1811
            # creation contract must see it as uninitializable
2175
1812
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1813
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1814
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1815
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1816
            target_branch.bzrdir.root_transport.base)
2180
1817
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1818
        return self.open(
 
1819
            a_bzrdir, _found=True,
2183
1820
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1821
 
2187
1822
    def __init__(self):
2188
1823
        super(BranchReferenceFormat, self).__init__()
2194
1829
        def clone(to_bzrdir, revision_id=None,
2195
1830
            repository_policy=None):
2196
1831
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1832
            return format.initialize(to_bzrdir, a_branch)
2198
1833
            # cannot obey revision_id limits when cloning a reference ...
2199
1834
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1835
            # emit some sort of warning/error to the caller ?!
2201
1836
        return clone
2202
1837
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1838
    def open(self, a_bzrdir, _found=False, location=None,
2204
1839
             possible_transports=None, ignore_fallbacks=False):
2205
1840
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1841
 
2207
1842
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1843
        :param _found: a private parameter, do not use it. It is used to
2210
1844
            indicate if format probing has already be done.
2211
1845
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1850
        :param possible_transports: An optional reusable transports list.
2217
1851
        """
2218
1852
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1853
            format = BranchFormat.find_format(a_bzrdir)
2220
1854
            if format.__class__ != self.__class__:
2221
1855
                raise AssertionError("wrong format %r found for %r" %
2222
1856
                    (format, self))
2224
1858
            location = self.get_reference(a_bzrdir)
2225
1859
        real_bzrdir = bzrdir.BzrDir.open(
2226
1860
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1861
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1862
        # this changes the behaviour of result.clone to create a new reference
2230
1863
        # rather than a copy of the content of the branch.
2231
1864
        # I did not use a proxy object because that needs much more extensive
2258
1891
BranchFormat.register_format(__format6)
2259
1892
BranchFormat.register_format(__format7)
2260
1893
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1894
BranchFormat.set_default_format(__format6)
2262
1895
_legacy_formats = [BzrBranchFormat4(),
2263
1896
    ]
2264
1897
network_format_registry.register(
2265
1898
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1899
 
2267
1900
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1901
class BzrBranch(Branch):
2269
1902
    """A branch stored in the actual filesystem.
2270
1903
 
2271
1904
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1910
    :ivar repository: Repository for this branch.
2278
1911
    :ivar base: The url of the base directory for this branch; the one
2279
1912
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1913
    """
2283
1914
 
2284
1915
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1916
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1917
                 ignore_fallbacks=False):
2287
1918
        """Create new branch object at a particular location."""
2288
1919
        if a_bzrdir is None:
2289
1920
            raise ValueError('a_bzrdir must be supplied')
2290
1921
        else:
2291
1922
            self.bzrdir = a_bzrdir
2292
1923
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1924
        # XXX: We should be able to just do
2295
1925
        #   self.base = self.bzrdir.root_transport.base
2296
1926
        # but this does not quite work yet -- mbp 20080522
2303
1933
        Branch.__init__(self)
2304
1934
 
2305
1935
    def __str__(self):
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)
 
1936
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1937
 
2312
1938
    __repr__ = __str__
2313
1939
 
2324
1950
        return self.control_files.is_locked()
2325
1951
 
2326
1952
    def lock_write(self, token=None):
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
 
1953
        repo_token = self.repository.lock_write()
2337
1954
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1955
            token = self.control_files.lock_write(token=token)
2339
1956
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1957
            self.repository.unlock()
2342
1958
            raise
 
1959
        return token
2343
1960
 
2344
1961
    def lock_read(self):
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
 
1962
        self.repository.lock_read()
2355
1963
        try:
2356
1964
            self.control_files.lock_read()
2357
1965
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1966
            self.repository.unlock()
2360
1967
            raise
2361
1968
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1969
    def unlock(self):
 
1970
        # TODO: test for failed two phase locks. This is known broken.
2364
1971
        try:
2365
1972
            self.control_files.unlock()
2366
1973
        finally:
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()
 
1974
            self.repository.unlock()
 
1975
        if not self.control_files.is_locked():
 
1976
            # we just released the lock
 
1977
            self._clear_cached_state()
2375
1978
 
2376
1979
    def peek_lock_mode(self):
2377
1980
        if self.control_files._lock_count == 0:
2496
2099
        """See Branch.basis_tree."""
2497
2100
        return self.repository.revision_tree(self.last_revision())
2498
2101
 
 
2102
    @needs_write_lock
 
2103
    def pull(self, source, overwrite=False, stop_revision=None,
 
2104
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2105
             _override_hook_target=None):
 
2106
        """See Branch.pull.
 
2107
 
 
2108
        :param _hook_master: Private parameter - set the branch to
 
2109
            be supplied as the master to pull hooks.
 
2110
        :param run_hooks: Private parameter - if false, this branch
 
2111
            is being called because it's the master of the primary branch,
 
2112
            so it should not run its hooks.
 
2113
        :param _override_hook_target: Private parameter - set the branch to be
 
2114
            supplied as the target_branch to pull hooks.
 
2115
        """
 
2116
        result = PullResult()
 
2117
        result.source_branch = source
 
2118
        if _override_hook_target is None:
 
2119
            result.target_branch = self
 
2120
        else:
 
2121
            result.target_branch = _override_hook_target
 
2122
        source.lock_read()
 
2123
        try:
 
2124
            # We assume that during 'pull' the local repository is closer than
 
2125
            # the remote one.
 
2126
            source.update_references(self)
 
2127
            graph = self.repository.get_graph(source.repository)
 
2128
            result.old_revno, result.old_revid = self.last_revision_info()
 
2129
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2130
                                  graph=graph)
 
2131
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2132
            result.new_revno, result.new_revid = self.last_revision_info()
 
2133
            if _hook_master:
 
2134
                result.master_branch = _hook_master
 
2135
                result.local_branch = result.target_branch
 
2136
            else:
 
2137
                result.master_branch = result.target_branch
 
2138
                result.local_branch = None
 
2139
            if run_hooks:
 
2140
                for hook in Branch.hooks['post_pull']:
 
2141
                    hook(result)
 
2142
        finally:
 
2143
            source.unlock()
 
2144
        return result
 
2145
 
2499
2146
    def _get_parent_location(self):
2500
2147
        _locs = ['parent', 'pull', 'x-pull']
2501
2148
        for l in _locs:
2505
2152
                pass
2506
2153
        return None
2507
2154
 
 
2155
    @needs_read_lock
 
2156
    def push(self, target, overwrite=False, stop_revision=None,
 
2157
             _override_hook_source_branch=None):
 
2158
        """See Branch.push.
 
2159
 
 
2160
        This is the basic concrete implementation of push()
 
2161
 
 
2162
        :param _override_hook_source_branch: If specified, run
 
2163
        the hooks passing this Branch as the source, rather than self.
 
2164
        This is for use of RemoteBranch, where push is delegated to the
 
2165
        underlying vfs-based Branch.
 
2166
        """
 
2167
        # TODO: Public option to disable running hooks - should be trivial but
 
2168
        # needs tests.
 
2169
        return _run_with_write_locked_target(
 
2170
            target, self._push_with_bound_branches, target, overwrite,
 
2171
            stop_revision,
 
2172
            _override_hook_source_branch=_override_hook_source_branch)
 
2173
 
 
2174
    def _push_with_bound_branches(self, target, overwrite,
 
2175
            stop_revision,
 
2176
            _override_hook_source_branch=None):
 
2177
        """Push from self into target, and into target's master if any.
 
2178
 
 
2179
        This is on the base BzrBranch class even though it doesn't support
 
2180
        bound branches because the *target* might be bound.
 
2181
        """
 
2182
        def _run_hooks():
 
2183
            if _override_hook_source_branch:
 
2184
                result.source_branch = _override_hook_source_branch
 
2185
            for hook in Branch.hooks['post_push']:
 
2186
                hook(result)
 
2187
 
 
2188
        bound_location = target.get_bound_location()
 
2189
        if bound_location and target.base != bound_location:
 
2190
            # there is a master branch.
 
2191
            #
 
2192
            # XXX: Why the second check?  Is it even supported for a branch to
 
2193
            # be bound to itself? -- mbp 20070507
 
2194
            master_branch = target.get_master_branch()
 
2195
            master_branch.lock_write()
 
2196
            try:
 
2197
                # push into the master from this branch.
 
2198
                self._basic_push(master_branch, overwrite, stop_revision)
 
2199
                # and push into the target branch from this. Note that we push from
 
2200
                # this branch again, because its considered the highest bandwidth
 
2201
                # repository.
 
2202
                result = self._basic_push(target, overwrite, stop_revision)
 
2203
                result.master_branch = master_branch
 
2204
                result.local_branch = target
 
2205
                _run_hooks()
 
2206
                return result
 
2207
            finally:
 
2208
                master_branch.unlock()
 
2209
        else:
 
2210
            # no master branch
 
2211
            result = self._basic_push(target, overwrite, stop_revision)
 
2212
            # TODO: Why set master_branch and local_branch if there's no
 
2213
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2214
            # 20070504
 
2215
            result.master_branch = target
 
2216
            result.local_branch = None
 
2217
            _run_hooks()
 
2218
            return result
 
2219
 
2508
2220
    def _basic_push(self, target, overwrite, stop_revision):
2509
2221
        """Basic implementation of push without bound branches or hooks.
2510
2222
 
2511
 
        Must be called with source read locked and target write locked.
 
2223
        Must be called with self read locked and target write locked.
2512
2224
        """
2513
2225
        result = BranchPushResult()
2514
2226
        result.source_branch = self
2519
2231
            # We assume that during 'push' this repository is closer than
2520
2232
            # the target.
2521
2233
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2234
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2235
                                    graph=graph)
2524
2236
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2237
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2238
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2239
        return result
2529
2240
 
2530
2241
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2242
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2243
 
2533
2244
    def set_push_location(self, location):
2534
2245
        """See Branch.set_push_location."""
2536
2247
            'push_location', location,
2537
2248
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2249
 
 
2250
    @needs_write_lock
 
2251
    def set_parent(self, url):
 
2252
        """See Branch.set_parent."""
 
2253
        # TODO: Maybe delete old location files?
 
2254
        # URLs should never be unicode, even on the local fs,
 
2255
        # FIXUP this and get_parent in a future branch format bump:
 
2256
        # read and rewrite the file. RBC 20060125
 
2257
        if url is not None:
 
2258
            if isinstance(url, unicode):
 
2259
                try:
 
2260
                    url = url.encode('ascii')
 
2261
                except UnicodeEncodeError:
 
2262
                    raise errors.InvalidURL(url,
 
2263
                        "Urls must be 7-bit ascii, "
 
2264
                        "use bzrlib.urlutils.escape")
 
2265
            url = urlutils.relative_url(self.base, url)
 
2266
        self._set_parent_location(url)
 
2267
 
2539
2268
    def _set_parent_location(self, url):
2540
2269
        if url is None:
2541
2270
            self._transport.delete('parent')
2550
2279
    It has support for a master_branch which is the data for bound branches.
2551
2280
    """
2552
2281
 
 
2282
    @needs_write_lock
 
2283
    def pull(self, source, overwrite=False, stop_revision=None,
 
2284
             run_hooks=True, possible_transports=None,
 
2285
             _override_hook_target=None):
 
2286
        """Pull from source into self, updating my master if any.
 
2287
 
 
2288
        :param run_hooks: Private parameter - if false, this branch
 
2289
            is being called because it's the master of the primary branch,
 
2290
            so it should not run its hooks.
 
2291
        """
 
2292
        bound_location = self.get_bound_location()
 
2293
        master_branch = None
 
2294
        if bound_location and source.base != bound_location:
 
2295
            # not pulling from master, so we need to update master.
 
2296
            master_branch = self.get_master_branch(possible_transports)
 
2297
            master_branch.lock_write()
 
2298
        try:
 
2299
            if master_branch:
 
2300
                # pull from source into master.
 
2301
                master_branch.pull(source, overwrite, stop_revision,
 
2302
                    run_hooks=False)
 
2303
            return super(BzrBranch5, self).pull(source, overwrite,
 
2304
                stop_revision, _hook_master=master_branch,
 
2305
                run_hooks=run_hooks,
 
2306
                _override_hook_target=_override_hook_target)
 
2307
        finally:
 
2308
            if master_branch:
 
2309
                master_branch.unlock()
 
2310
 
2553
2311
    def get_bound_location(self):
2554
2312
        try:
2555
2313
            return self._transport.get_bytes('bound')[:-1]
2667
2425
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
2426
        super(BzrBranch8, self).__init__(*args, **kwargs)
2669
2427
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2428
        self._partial_revision_history_cache = []
2671
2429
 
2672
2430
    def _clear_cached_state(self):
2673
2431
        super(BzrBranch8, self)._clear_cached_state()
2674
2432
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2433
        self._partial_revision_history_cache = []
2676
2434
 
2677
2435
    def _last_revision_info(self):
2678
2436
        revision_string = self._transport.get_bytes('last-revision')
2724
2482
        if _mod_revision.is_null(last_revision):
2725
2483
            return
2726
2484
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2485
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2486
 
2729
2487
    def _gen_revision_history(self):
2730
2488
        """Generate the revision history from last revision
2733
2491
        self._extend_partial_history(stop_index=last_revno-1)
2734
2492
        return list(reversed(self._partial_revision_history_cache))
2735
2493
 
 
2494
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2495
        """Extend the partial history to include a given index
 
2496
 
 
2497
        If a stop_index is supplied, stop when that index has been reached.
 
2498
        If a stop_revision is supplied, stop when that revision is
 
2499
        encountered.  Otherwise, stop when the beginning of history is
 
2500
        reached.
 
2501
 
 
2502
        :param stop_index: The index which should be present.  When it is
 
2503
            present, history extension will stop.
 
2504
        :param revision_id: The revision id which should be present.  When
 
2505
            it is encountered, history extension will stop.
 
2506
        """
 
2507
        repo = self.repository
 
2508
        if len(self._partial_revision_history_cache) == 0:
 
2509
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2510
        else:
 
2511
            start_revision = self._partial_revision_history_cache[-1]
 
2512
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2513
            #skip the last revision in the list
 
2514
            next_revision = iterator.next()
 
2515
        for revision_id in iterator:
 
2516
            self._partial_revision_history_cache.append(revision_id)
 
2517
            if (stop_index is not None and
 
2518
                len(self._partial_revision_history_cache) > stop_index):
 
2519
                break
 
2520
            if revision_id == stop_revision:
 
2521
                break
 
2522
 
2736
2523
    def _write_revision_history(self, history):
2737
2524
        """Factored out of set_revision_history.
2738
2525
 
2759
2546
        """Set the parent branch"""
2760
2547
        return self._get_config_location('parent_location')
2761
2548
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
 
2549
    def _get_info_dict(self):
2785
2550
        rio_file = self._transport.get('references')
2786
2551
        try:
2787
2552
            stanzas = rio.read_stanzas(rio_file)
2789
2554
                             s['branch_location'])) for s in stanzas)
2790
2555
        finally:
2791
2556
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
2557
        return info_dict
2794
2558
 
2795
2559
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
 
2560
        """Set the branch location to use for a tree reference."""
 
2561
        info_dict = self._get_info_dict()
2804
2562
        info_dict[file_id] = (tree_path, branch_location)
2805
2563
        if None in (tree_path, branch_location):
2806
2564
            if tree_path is not None:
2810
2568
                raise ValueError('branch_location must be None when tree_path'
2811
2569
                                 ' is None.')
2812
2570
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
 
2571
        self._save_reference_dict(info_dict)
 
2572
 
 
2573
    def _save_reference_dict(self, info_dict):
 
2574
        s = StringIO()
 
2575
        writer = rio.RioWriter(s)
 
2576
        for key, (tree_path, branch_location) in info_dict.iteritems():
 
2577
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
 
2578
                                branch_location=branch_location)
 
2579
            writer.write_stanza(stanza)
 
2580
        self._transport.put_bytes('references', s.getvalue())
2814
2581
 
2815
2582
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
 
2583
        """Get the tree_path and branch_location for a tree reference."""
 
2584
        return self._get_info_dict().get(file_id, (None, None))
2821
2585
 
2822
2586
    def reference_parent(self, file_id, path, possible_transports=None):
2823
2587
        """Return the parent branch for a tree-reference file_id.
2830
2594
        if branch_location is None:
2831
2595
            return Branch.reference_parent(self, file_id, path,
2832
2596
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2597
        branch_location = urlutils.join(self.base, branch_location)
2834
2598
        return Branch.open(branch_location,
2835
2599
                           possible_transports=possible_transports)
2836
2600
 
2881
2645
            raise errors.NotStacked(self)
2882
2646
        return stacked_url
2883
2647
 
 
2648
    def set_append_revisions_only(self, enabled):
 
2649
        if enabled:
 
2650
            value = 'True'
 
2651
        else:
 
2652
            value = 'False'
 
2653
        self.get_config().set_user_option('append_revisions_only', value,
 
2654
            warn_masked=True)
 
2655
 
2884
2656
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2657
        value = self.get_config().get_user_option('append_revisions_only')
 
2658
        return value == 'True'
2887
2659
 
2888
2660
    @needs_write_lock
2889
2661
    def generate_revision_history(self, revision_id, last_rev=None,
2951
2723
    """
2952
2724
 
2953
2725
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2726
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2727
 
2956
2728
 
2957
2729
######################################################################
3036
2808
 
3037
2809
    def __init__(self, branch):
3038
2810
        self.branch = branch
3039
 
        self.errors = []
3040
2811
 
3041
2812
    def report_results(self, verbose):
3042
2813
        """Report the check results via trace.note.
3044
2815
        :param verbose: Requests more detailed display of what was checked,
3045
2816
            if any.
3046
2817
        """
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)
 
2818
        note('checked branch %s format %s',
 
2819
             self.branch.base,
 
2820
             self.branch._format)
3051
2821
 
3052
2822
 
3053
2823
class Converter5to6(object):
3091
2861
        branch._transport.put_bytes('format', format.get_format_string())
3092
2862
 
3093
2863
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2864
 
3104
2865
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2866
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2909
    @staticmethod
3149
2910
    def _get_branch_formats_to_test():
3150
2911
        """Return a tuple with the Branch formats to use when testing."""
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)
 
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2913
 
3163
2914
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2915
                         graph=None):
3173
2924
        """
3174
2925
        raise NotImplementedError(self.update_revisions)
3175
2926
 
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
 
 
3184
2927
 
3185
2928
class GenericInterBranch(InterBranch):
3186
2929
    """InterBranch implementation that uses public Branch functions.
3233
2976
        finally:
3234
2977
            self.source.unlock()
3235
2978
 
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
 
 
3357
2979
    @classmethod
3358
2980
    def is_compatible(self, source, target):
3359
2981
        # GenericBranch uses the public API, so always compatible
3360
2982
        return True
3361
2983
 
3362
2984
 
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
 
 
3400
2985
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)