/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: Sidnei da Silva
  • Date: 2009-05-29 14:19:29 UTC
  • mto: (4531.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4532.
  • Revision ID: sidnei.da.silva@canonical.com-20090529141929-3heywbvj36po72a5
- Add initial config

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/branch.py
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, LogicalLockResult
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()
103
104
    def _activate_fallback_location(self, url):
104
105
        """Activate the branch/repository from url as a fallback repository."""
105
106
        repo = self._get_fallback_repository(url)
106
 
        if repo.has_same_location(self.repository):
107
 
            raise errors.UnstackableLocationError(self.user_url, url)
108
107
        self.repository.add_fallback_repository(repo)
109
108
 
110
109
    def break_lock(self):
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.
283
253
        new_history.reverse()
284
254
        return new_history
285
255
 
286
 
    def lock_write(self, token=None):
287
 
        """Lock the branch for write operations.
288
 
 
289
 
        :param token: A token to permit reacquiring a previously held and
290
 
            preserved lock.
291
 
        :return: A BranchWriteLockResult.
292
 
        """
 
256
    def lock_write(self):
293
257
        raise NotImplementedError(self.lock_write)
294
258
 
295
259
    def lock_read(self):
296
 
        """Lock the branch for read operations.
297
 
 
298
 
        :return: A bzrlib.lock.LogicalLockResult.
299
 
        """
300
260
        raise NotImplementedError(self.lock_read)
301
261
 
302
262
    def unlock(self):
427
387
            * 'include' - the stop revision is the last item in the result
428
388
            * 'with-merges' - include the stop revision and all of its
429
389
              merged revisions in the result
430
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
431
 
              that are in both ancestries
432
390
        :param direction: either 'reverse' or 'forward':
433
391
            * reverse means return the start_revision_id first, i.e.
434
392
              start at the most recent revision and go backwards in history
456
414
        # start_revision_id.
457
415
        if self._merge_sorted_revisions_cache is None:
458
416
            last_revision = self.last_revision()
459
 
            known_graph = self.repository.get_known_graph_ancestry(
460
 
                [last_revision])
461
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
462
 
                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
 
463
426
        filtered = self._filter_merge_sorted_revisions(
464
427
            self._merge_sorted_revisions_cache, start_revision_id,
465
428
            stop_revision_id, stop_rule)
466
 
        # Make sure we don't return revisions that are not part of the
467
 
        # start_revision_id ancestry.
468
 
        filtered = self._filter_start_non_ancestors(filtered)
469
429
        if direction == 'reverse':
470
430
            return filtered
471
431
        if direction == 'forward':
478
438
        """Iterate over an inclusive range of sorted revisions."""
479
439
        rev_iter = iter(merge_sorted_revisions)
480
440
        if start_revision_id is not None:
481
 
            for node in rev_iter:
482
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
483
442
                if rev_id != start_revision_id:
484
443
                    continue
485
444
                else:
486
445
                    # The decision to include the start or not
487
446
                    # depends on the stop_rule if a stop is provided
488
 
                    # so pop this node back into the iterator
489
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
490
450
                    break
491
451
        if stop_revision_id is None:
492
 
            # Yield everything
493
 
            for node in rev_iter:
494
 
                rev_id = node.key[-1]
495
 
                yield (rev_id, node.merge_depth, node.revno,
496
 
                       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
497
454
        elif stop_rule == 'exclude':
498
 
            for node in rev_iter:
499
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
500
456
                if rev_id == stop_revision_id:
501
457
                    return
502
 
                yield (rev_id, node.merge_depth, node.revno,
503
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
504
459
        elif stop_rule == 'include':
505
 
            for node in rev_iter:
506
 
                rev_id = node.key[-1]
507
 
                yield (rev_id, node.merge_depth, node.revno,
508
 
                       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
509
462
                if rev_id == stop_revision_id:
510
463
                    return
511
 
        elif stop_rule == 'with-merges-without-common-ancestry':
512
 
            # We want to exclude all revisions that are already part of the
513
 
            # stop_revision_id ancestry.
514
 
            graph = self.repository.get_graph()
515
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
516
 
                                                    [stop_revision_id])
517
 
            for node in rev_iter:
518
 
                rev_id = node.key[-1]
519
 
                if rev_id not in ancestors:
520
 
                    continue
521
 
                yield (rev_id, node.merge_depth, node.revno,
522
 
                       node.end_of_merge)
523
464
        elif stop_rule == 'with-merges':
524
465
            stop_rev = self.repository.get_revision(stop_revision_id)
525
466
            if stop_rev.parent_ids:
526
467
                left_parent = stop_rev.parent_ids[0]
527
468
            else:
528
469
                left_parent = _mod_revision.NULL_REVISION
529
 
            # left_parent is the actual revision we want to stop logging at,
530
 
            # since we want to show the merged revisions after the stop_rev too
531
 
            reached_stop_revision_id = False
532
 
            revision_id_whitelist = []
533
 
            for node in rev_iter:
534
 
                rev_id = node.key[-1]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
535
471
                if rev_id == left_parent:
536
 
                    # reached the left parent after the stop_revision
537
472
                    return
538
 
                if (not reached_stop_revision_id or
539
 
                        rev_id in revision_id_whitelist):
540
 
                    yield (rev_id, node.merge_depth, node.revno,
541
 
                       node.end_of_merge)
542
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
543
 
                        # only do the merged revs of rev_id from now on
544
 
                        rev = self.repository.get_revision(rev_id)
545
 
                        if rev.parent_ids:
546
 
                            reached_stop_revision_id = True
547
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
473
                yield rev_id, depth, revno, end_of_merge
548
474
        else:
549
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
550
476
 
551
 
    def _filter_start_non_ancestors(self, rev_iter):
552
 
        # If we started from a dotted revno, we want to consider it as a tip
553
 
        # and don't want to yield revisions that are not part of its
554
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
555
 
        # uninteresting descendants of the first parent of our tip before the
556
 
        # tip itself.
557
 
        first = rev_iter.next()
558
 
        (rev_id, merge_depth, revno, end_of_merge) = first
559
 
        yield first
560
 
        if not merge_depth:
561
 
            # We start at a mainline revision so by definition, all others
562
 
            # revisions in rev_iter are ancestors
563
 
            for node in rev_iter:
564
 
                yield node
565
 
 
566
 
        clean = False
567
 
        whitelist = set()
568
 
        pmap = self.repository.get_parent_map([rev_id])
569
 
        parents = pmap.get(rev_id, [])
570
 
        if parents:
571
 
            whitelist.update(parents)
572
 
        else:
573
 
            # If there is no parents, there is nothing of interest left
574
 
 
575
 
            # FIXME: It's hard to test this scenario here as this code is never
576
 
            # called in that case. -- vila 20100322
577
 
            return
578
 
 
579
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
580
 
            if not clean:
581
 
                if rev_id in whitelist:
582
 
                    pmap = self.repository.get_parent_map([rev_id])
583
 
                    parents = pmap.get(rev_id, [])
584
 
                    whitelist.remove(rev_id)
585
 
                    whitelist.update(parents)
586
 
                    if merge_depth == 0:
587
 
                        # We've reached the mainline, there is nothing left to
588
 
                        # filter
589
 
                        clean = True
590
 
                else:
591
 
                    # A revision that is not part of the ancestry of our
592
 
                    # starting revision.
593
 
                    continue
594
 
            yield (rev_id, merge_depth, revno, end_of_merge)
595
 
 
596
477
    def leave_lock_in_place(self):
597
478
        """Tell this branch object not to release the physical lock when this
598
479
        object is unlocked.
615
496
        :param other: The branch to bind to
616
497
        :type other: Branch
617
498
        """
618
 
        raise errors.UpgradeRequired(self.user_url)
619
 
 
620
 
    def set_append_revisions_only(self, enabled):
621
 
        if not self._format.supports_set_append_revisions_only():
622
 
            raise errors.UpgradeRequired(self.user_url)
623
 
        if enabled:
624
 
            value = 'True'
625
 
        else:
626
 
            value = 'False'
627
 
        self.get_config().set_user_option('append_revisions_only', value,
628
 
            warn_masked=True)
 
499
        raise errors.UpgradeRequired(self.base)
629
500
 
630
501
    def set_reference_info(self, file_id, tree_path, branch_location):
631
502
        """Set the branch location to use for a tree reference."""
673
544
    def get_old_bound_location(self):
674
545
        """Return the URL of the branch we used to be bound to
675
546
        """
676
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
677
548
 
678
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
679
550
                           timezone=None, committer=None, revprops=None,
757
628
            stacking.
758
629
        """
759
630
        if not self._format.supports_stacking():
760
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
761
 
        # XXX: Changing from one fallback repository to another does not check
762
 
        # that all the data you need is present in the new fallback.
763
 
        # Possibly it should.
 
631
            raise errors.UnstackableBranchFormat(self._format, self.base)
764
632
        self._check_stackable_repo()
765
633
        if not url:
766
634
            try:
768
636
            except (errors.NotStacked, errors.UnstackableBranchFormat,
769
637
                errors.UnstackableRepositoryFormat):
770
638
                return
771
 
            self._unstack()
 
639
            url = ''
 
640
            # XXX: Lock correctness - should unlock our old repo if we were
 
641
            # locked.
 
642
            # repositories don't offer an interface to remove fallback
 
643
            # repositories today; take the conceptually simpler option and just
 
644
            # reopen it.
 
645
            self.repository = self.bzrdir.find_repository()
 
646
            self.repository.lock_write()
 
647
            # for every revision reference the branch has, ensure it is pulled
 
648
            # in.
 
649
            source_repository = self._get_fallback_repository(old_url)
 
650
            for revision_id in chain([self.last_revision()],
 
651
                self.tags.get_reverse_tag_dict()):
 
652
                self.repository.fetch(source_repository, revision_id,
 
653
                    find_ghosts=True)
772
654
        else:
773
655
            self._activate_fallback_location(url)
774
656
        # write this out after the repository is stacked to avoid setting a
775
657
        # stacked config that doesn't work.
776
658
        self._set_config_location('stacked_on_location', url)
777
659
 
778
 
    def _unstack(self):
779
 
        """Change a branch to be unstacked, copying data as needed.
780
 
        
781
 
        Don't call this directly, use set_stacked_on_url(None).
782
 
        """
783
 
        pb = ui.ui_factory.nested_progress_bar()
784
 
        try:
785
 
            pb.update("Unstacking")
786
 
            # The basic approach here is to fetch the tip of the branch,
787
 
            # including all available ghosts, from the existing stacked
788
 
            # repository into a new repository object without the fallbacks. 
789
 
            #
790
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
791
 
            # correct for CHKMap repostiories
792
 
            old_repository = self.repository
793
 
            if len(old_repository._fallback_repositories) != 1:
794
 
                raise AssertionError("can't cope with fallback repositories "
795
 
                    "of %r" % (self.repository,))
796
 
            # unlock it, including unlocking the fallback
797
 
            old_repository.unlock()
798
 
            old_repository.lock_read()
799
 
            try:
800
 
                # Repositories don't offer an interface to remove fallback
801
 
                # repositories today; take the conceptually simpler option and just
802
 
                # reopen it.  We reopen it starting from the URL so that we
803
 
                # get a separate connection for RemoteRepositories and can
804
 
                # stream from one of them to the other.  This does mean doing
805
 
                # separate SSH connection setup, but unstacking is not a
806
 
                # common operation so it's tolerable.
807
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
808
 
                new_repository = new_bzrdir.find_repository()
809
 
                self.repository = new_repository
810
 
                if self.repository._fallback_repositories:
811
 
                    raise AssertionError("didn't expect %r to have "
812
 
                        "fallback_repositories"
813
 
                        % (self.repository,))
814
 
                # this is not paired with an unlock because it's just restoring
815
 
                # the previous state; the lock's released when set_stacked_on_url
816
 
                # returns
817
 
                self.repository.lock_write()
818
 
                # XXX: If you unstack a branch while it has a working tree
819
 
                # with a pending merge, the pending-merged revisions will no
820
 
                # longer be present.  You can (probably) revert and remerge.
821
 
                #
822
 
                # XXX: This only fetches up to the tip of the repository; it
823
 
                # doesn't bring across any tags.  That's fairly consistent
824
 
                # with how branch works, but perhaps not ideal.
825
 
                self.repository.fetch(old_repository,
826
 
                    revision_id=self.last_revision(),
827
 
                    find_ghosts=True)
828
 
            finally:
829
 
                old_repository.unlock()
830
 
        finally:
831
 
            pb.finished()
832
660
 
833
661
    def _set_tags_bytes(self, bytes):
834
662
        """Mirror method for _get_tags_bytes.
870
698
        self._revision_id_to_revno_cache = None
871
699
        self._last_revision_info_cache = None
872
700
        self._merge_sorted_revisions_cache = None
873
 
        self._partial_revision_history_cache = []
874
 
        self._partial_revision_id_to_revno_cache = {}
875
701
 
876
702
    def _gen_revision_history(self):
877
703
        """Return sequence of revision hashes on to this branch.
914
740
 
915
741
    def unbind(self):
916
742
        """Older format branches cannot bind or unbind."""
917
 
        raise errors.UpgradeRequired(self.user_url)
 
743
        raise errors.UpgradeRequired(self.base)
 
744
 
 
745
    def set_append_revisions_only(self, enabled):
 
746
        """Older format branches are never restricted to append-only"""
 
747
        raise errors.UpgradeRequired(self.base)
918
748
 
919
749
    def last_revision(self):
920
750
        """Return last revision id, or NULL_REVISION."""
1001
831
        except ValueError:
1002
832
            raise errors.NoSuchRevision(self, revision_id)
1003
833
 
1004
 
    @needs_read_lock
1005
834
    def get_rev_id(self, revno, history=None):
1006
835
        """Find the revision id of the specified revno."""
1007
836
        if revno == 0:
1008
837
            return _mod_revision.NULL_REVISION
1009
 
        last_revno, last_revid = self.last_revision_info()
1010
 
        if revno == last_revno:
1011
 
            return last_revid
1012
 
        if revno <= 0 or revno > last_revno:
 
838
        if history is None:
 
839
            history = self.revision_history()
 
840
        if revno <= 0 or revno > len(history):
1013
841
            raise errors.NoSuchRevision(self, revno)
1014
 
        distance_from_last = last_revno - revno
1015
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1016
 
            self._extend_partial_history(distance_from_last)
1017
 
        return self._partial_revision_history_cache[distance_from_last]
 
842
        return history[revno - 1]
1018
843
 
1019
844
    @needs_write_lock
1020
845
    def pull(self, source, overwrite=False, stop_revision=None,
1080
905
        try:
1081
906
            return urlutils.join(self.base[:-1], parent)
1082
907
        except errors.InvalidURLJoin, e:
1083
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
908
            raise errors.InaccessibleParent(parent, self.base)
1084
909
 
1085
910
    def _get_parent_location(self):
1086
911
        raise NotImplementedError(self._get_parent_location)
1171
996
        params = ChangeBranchTipParams(
1172
997
            self, old_revno, new_revno, old_revid, new_revid)
1173
998
        for hook in hooks:
1174
 
            hook(params)
 
999
            try:
 
1000
                hook(params)
 
1001
            except errors.TipChangeRejected:
 
1002
                raise
 
1003
            except Exception:
 
1004
                exc_info = sys.exc_info()
 
1005
                hook_name = Branch.hooks.get_hook_name(hook)
 
1006
                raise errors.HookFailed(
 
1007
                    'pre_change_branch_tip', hook_name, exc_info)
1175
1008
 
1176
1009
    @needs_write_lock
1177
1010
    def update(self):
1226
1059
        revision_id: if not None, the revision history in the new branch will
1227
1060
                     be truncated to end with revision_id.
1228
1061
        """
1229
 
        if (repository_policy is not None and
1230
 
            repository_policy.requires_stacking()):
1231
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1232
1062
        result = to_bzrdir.create_branch()
1233
1063
        result.lock_write()
1234
1064
        try:
1255
1085
        source_revno, source_revision_id = self.last_revision_info()
1256
1086
        if revision_id is None:
1257
1087
            revno, revision_id = source_revno, source_revision_id
 
1088
        elif source_revision_id == revision_id:
 
1089
            # we know the revno without needing to walk all of history
 
1090
            revno = source_revno
1258
1091
        else:
1259
 
            graph = self.repository.get_graph()
1260
 
            try:
1261
 
                revno = graph.find_distance_to_null(revision_id, 
1262
 
                    [(source_revision_id, source_revno)])
1263
 
            except errors.GhostRevisionsHaveNoRevno:
1264
 
                # Default to 1, if we can't find anything else
1265
 
                revno = 1
 
1092
            # To figure out the revno for a random revision, we need to build
 
1093
            # the revision history, and count its length.
 
1094
            # We don't care about the order, just how long it is.
 
1095
            # Alternatively, we could start at the current location, and count
 
1096
            # backwards. But there is no guarantee that we will find it since
 
1097
            # it may be a merged revision.
 
1098
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1099
                                                                revision_id)))
1266
1100
        destination.set_last_revision_info(revno, revision_id)
1267
1101
 
1268
1102
    @needs_read_lock
1302
1136
        target._set_all_reference_info(target_reference_dict)
1303
1137
 
1304
1138
    @needs_read_lock
1305
 
    def check(self, refs):
 
1139
    def check(self):
1306
1140
        """Check consistency of the branch.
1307
1141
 
1308
1142
        In particular this checks that revisions given in the revision-history
1311
1145
 
1312
1146
        Callers will typically also want to check the repository.
1313
1147
 
1314
 
        :param refs: Calculated refs for this branch as specified by
1315
 
            branch._get_check_refs()
1316
1148
        :return: A BranchCheckResult.
1317
1149
        """
1318
 
        result = BranchCheckResult(self)
 
1150
        mainline_parent_id = None
1319
1151
        last_revno, last_revision_id = self.last_revision_info()
1320
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1321
 
        if actual_revno != last_revno:
1322
 
            result.errors.append(errors.BzrCheckError(
1323
 
                'revno does not match len(mainline) %s != %s' % (
1324
 
                last_revno, actual_revno)))
1325
 
        # TODO: We should probably also check that self.revision_history
1326
 
        # matches the repository for older branch formats.
1327
 
        # If looking for the code that cross-checks repository parents against
1328
 
        # the iter_reverse_revision_history output, that is now a repository
1329
 
        # specific check.
1330
 
        return result
 
1152
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1153
                                last_revision_id))
 
1154
        real_rev_history.reverse()
 
1155
        if len(real_rev_history) != last_revno:
 
1156
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1157
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1158
        # TODO: We should probably also check that real_rev_history actually
 
1159
        #       matches self.revision_history()
 
1160
        for revision_id in real_rev_history:
 
1161
            try:
 
1162
                revision = self.repository.get_revision(revision_id)
 
1163
            except errors.NoSuchRevision, e:
 
1164
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1165
                            % revision_id)
 
1166
            # In general the first entry on the revision history has no parents.
 
1167
            # But it's not illegal for it to have parents listed; this can happen
 
1168
            # in imports from Arch when the parents weren't reachable.
 
1169
            if mainline_parent_id is not None:
 
1170
                if mainline_parent_id not in revision.parent_ids:
 
1171
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1172
                                        "parents of {%s}"
 
1173
                                        % (mainline_parent_id, revision_id))
 
1174
            mainline_parent_id = revision_id
 
1175
        return BranchCheckResult(self)
1331
1176
 
1332
1177
    def _get_checkout_format(self):
1333
1178
        """Return the most suitable metadir for a checkout of this branch.
1358
1203
        # clone call. Or something. 20090224 RBC/spiv.
1359
1204
        if revision_id is None:
1360
1205
            revision_id = self.last_revision()
1361
 
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1362
 
            revision_id=revision_id, stacked_on=stacked_on,
1363
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1206
        try:
 
1207
            dir_to = self.bzrdir.clone_on_transport(to_transport,
 
1208
                revision_id=revision_id, stacked_on=stacked_on,
 
1209
                create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1210
        except errors.FileExists:
 
1211
            if not use_existing_dir:
 
1212
                raise
 
1213
        except errors.NoSuchFile:
 
1214
            if not create_prefix:
 
1215
                raise
1364
1216
        return dir_to.open_branch()
1365
1217
 
1366
1218
    def create_checkout(self, to_location, revision_id=None,
1385
1237
        if lightweight:
1386
1238
            format = self._get_checkout_format()
1387
1239
            checkout = format.initialize_on_transport(t)
1388
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1389
 
                target_branch=self)
 
1240
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1390
1241
        else:
1391
1242
            format = self._get_checkout_format()
1392
1243
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1434
1285
    def supports_tags(self):
1435
1286
        return self._format.supports_tags()
1436
1287
 
1437
 
    def automatic_tag_name(self, revision_id):
1438
 
        """Try to automatically find the tag name for a revision.
1439
 
 
1440
 
        :param revision_id: Revision id of the revision.
1441
 
        :return: A tag name or None if no tag name could be determined.
1442
 
        """
1443
 
        for hook in Branch.hooks['automatic_tag_name']:
1444
 
            ret = hook(self, revision_id)
1445
 
            if ret is not None:
1446
 
                return ret
1447
 
        return None
1448
 
 
1449
1288
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1450
1289
                                         other_branch):
1451
1290
        """Ensure that revision_b is a descendant of revision_a.
1506
1345
    _formats = {}
1507
1346
    """The known formats."""
1508
1347
 
1509
 
    can_set_append_revisions_only = True
1510
 
 
1511
1348
    def __eq__(self, other):
1512
1349
        return self.__class__ is other.__class__
1513
1350
 
1515
1352
        return not (self == other)
1516
1353
 
1517
1354
    @classmethod
1518
 
    def find_format(klass, a_bzrdir, name=None):
 
1355
    def find_format(klass, a_bzrdir):
1519
1356
        """Return the format for the branch object in a_bzrdir."""
1520
1357
        try:
1521
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1522
 
            format_string = transport.get_bytes("format")
 
1358
            transport = a_bzrdir.get_branch_transport(None)
 
1359
            format_string = transport.get("format").read()
1523
1360
            return klass._formats[format_string]
1524
1361
        except errors.NoSuchFile:
1525
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1362
            raise errors.NotBranchError(path=transport.base)
1526
1363
        except KeyError:
1527
1364
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1528
1365
 
1564
1401
        """Return the short format description for this format."""
1565
1402
        raise NotImplementedError(self.get_format_description)
1566
1403
 
1567
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1568
 
        hooks = Branch.hooks['post_branch_init']
1569
 
        if not hooks:
1570
 
            return
1571
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1572
 
        for hook in hooks:
1573
 
            hook(params)
1574
 
 
1575
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1576
 
                           lock_type='metadir', set_format=True):
 
1404
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1405
                           set_format=True):
1577
1406
        """Initialize a branch in a bzrdir, with specified files
1578
1407
 
1579
1408
        :param a_bzrdir: The bzrdir to initialize the branch in
1580
1409
        :param utf8_files: The files to create as a list of
1581
1410
            (filename, content) tuples
1582
 
        :param name: Name of colocated branch to create, if any
1583
1411
        :param set_format: If True, set the format with
1584
1412
            self.get_format_string.  (BzrBranch4 has its format set
1585
1413
            elsewhere)
1586
1414
        :return: a branch in this format
1587
1415
        """
1588
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1589
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1416
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1417
        branch_transport = a_bzrdir.get_branch_transport(self)
1590
1418
        lock_map = {
1591
1419
            'metadir': ('lock', lockdir.LockDir),
1592
1420
            'branch4': ('branch-lock', lockable_files.TransportLock),
1613
1441
        finally:
1614
1442
            if lock_taken:
1615
1443
                control_files.unlock()
1616
 
        branch = self.open(a_bzrdir, name, _found=True)
1617
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1618
 
        return branch
 
1444
        return self.open(a_bzrdir, _found=True)
1619
1445
 
1620
 
    def initialize(self, a_bzrdir, name=None):
1621
 
        """Create a branch of this format in a_bzrdir.
1622
 
        
1623
 
        :param name: Name of the colocated branch to create.
1624
 
        """
 
1446
    def initialize(self, a_bzrdir):
 
1447
        """Create a branch of this format in a_bzrdir."""
1625
1448
        raise NotImplementedError(self.initialize)
1626
1449
 
1627
1450
    def is_supported(self):
1657
1480
        """
1658
1481
        raise NotImplementedError(self.network_name)
1659
1482
 
1660
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1483
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1661
1484
        """Return the branch object for a_bzrdir
1662
1485
 
1663
1486
        :param a_bzrdir: A BzrDir that contains a branch.
1664
 
        :param name: Name of colocated branch to open
1665
1487
        :param _found: a private parameter, do not use it. It is used to
1666
1488
            indicate if format probing has already be done.
1667
1489
        :param ignore_fallbacks: when set, no fallback branches will be opened
1681
1503
    def set_default_format(klass, format):
1682
1504
        klass._default_format = format
1683
1505
 
1684
 
    def supports_set_append_revisions_only(self):
1685
 
        """True if this format supports set_append_revisions_only."""
1686
 
        return False
1687
 
 
1688
1506
    def supports_stacking(self):
1689
1507
        """True if this format records a stacked-on branch."""
1690
1508
        return False
1775
1593
            "multiple hooks installed for transform_fallback_location, "
1776
1594
            "all are called with the url returned from the previous hook."
1777
1595
            "The order is however undefined.", (1, 9), None))
1778
 
        self.create_hook(HookPoint('automatic_tag_name',
1779
 
            "Called to determine an automatic tag name for a revision."
1780
 
            "automatic_tag_name is called with (branch, revision_id) and "
1781
 
            "should return a tag name or None if no tag name could be "
1782
 
            "determined. The first non-None tag name returned will be used.",
1783
 
            (2, 2), None))
1784
 
        self.create_hook(HookPoint('post_branch_init',
1785
 
            "Called after new branch initialization completes. "
1786
 
            "post_branch_init is called with a "
1787
 
            "bzrlib.branch.BranchInitHookParams. "
1788
 
            "Note that init, branch and checkout (both heavyweight and "
1789
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1790
 
        self.create_hook(HookPoint('post_switch',
1791
 
            "Called after a checkout switches branch. "
1792
 
            "post_switch is called with a "
1793
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1794
 
 
1795
1596
 
1796
1597
 
1797
1598
# install the default hooks into the Branch class.
1836
1637
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1837
1638
 
1838
1639
 
1839
 
class BranchInitHookParams(object):
1840
 
    """Object holding parameters passed to *_branch_init hooks.
1841
 
 
1842
 
    There are 4 fields that hooks may wish to access:
1843
 
 
1844
 
    :ivar format: the branch format
1845
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1846
 
    :ivar name: name of colocated branch, if any (or None)
1847
 
    :ivar branch: the branch created
1848
 
 
1849
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1850
 
    the checkout, hence they are different from the corresponding fields in
1851
 
    branch, which refer to the original branch.
1852
 
    """
1853
 
 
1854
 
    def __init__(self, format, a_bzrdir, name, branch):
1855
 
        """Create a group of BranchInitHook parameters.
1856
 
 
1857
 
        :param format: the branch format
1858
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1859
 
            initialized
1860
 
        :param name: name of colocated branch, if any (or None)
1861
 
        :param branch: the branch created
1862
 
 
1863
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1864
 
        to the checkout, hence they are different from the corresponding fields
1865
 
        in branch, which refer to the original branch.
1866
 
        """
1867
 
        self.format = format
1868
 
        self.bzrdir = a_bzrdir
1869
 
        self.name = name
1870
 
        self.branch = branch
1871
 
 
1872
 
    def __eq__(self, other):
1873
 
        return self.__dict__ == other.__dict__
1874
 
 
1875
 
    def __repr__(self):
1876
 
        if self.branch:
1877
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1878
 
        else:
1879
 
            return "<%s of format:%s bzrdir:%s>" % (
1880
 
                self.__class__.__name__, self.branch,
1881
 
                self.format, self.bzrdir)
1882
 
 
1883
 
 
1884
 
class SwitchHookParams(object):
1885
 
    """Object holding parameters passed to *_switch hooks.
1886
 
 
1887
 
    There are 4 fields that hooks may wish to access:
1888
 
 
1889
 
    :ivar control_dir: BzrDir of the checkout to change
1890
 
    :ivar to_branch: branch that the checkout is to reference
1891
 
    :ivar force: skip the check for local commits in a heavy checkout
1892
 
    :ivar revision_id: revision ID to switch to (or None)
1893
 
    """
1894
 
 
1895
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1896
 
        """Create a group of SwitchHook parameters.
1897
 
 
1898
 
        :param control_dir: BzrDir of the checkout to change
1899
 
        :param to_branch: branch that the checkout is to reference
1900
 
        :param force: skip the check for local commits in a heavy checkout
1901
 
        :param revision_id: revision ID to switch to (or None)
1902
 
        """
1903
 
        self.control_dir = control_dir
1904
 
        self.to_branch = to_branch
1905
 
        self.force = force
1906
 
        self.revision_id = revision_id
1907
 
 
1908
 
    def __eq__(self, other):
1909
 
        return self.__dict__ == other.__dict__
1910
 
 
1911
 
    def __repr__(self):
1912
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1913
 
            self.control_dir, self.to_branch,
1914
 
            self.revision_id)
1915
 
 
1916
 
 
1917
1640
class BzrBranchFormat4(BranchFormat):
1918
1641
    """Bzr branch format 4.
1919
1642
 
1926
1649
        """See BranchFormat.get_format_description()."""
1927
1650
        return "Branch format 4"
1928
1651
 
1929
 
    def initialize(self, a_bzrdir, name=None):
 
1652
    def initialize(self, a_bzrdir):
1930
1653
        """Create a branch of this format in a_bzrdir."""
1931
1654
        utf8_files = [('revision-history', ''),
1932
1655
                      ('branch-name', ''),
1933
1656
                      ]
1934
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1657
        return self._initialize_helper(a_bzrdir, utf8_files,
1935
1658
                                       lock_type='branch4', set_format=False)
1936
1659
 
1937
1660
    def __init__(self):
1942
1665
        """The network name for this format is the control dirs disk label."""
1943
1666
        return self._matchingbzrdir.get_format_string()
1944
1667
 
1945
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1668
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1946
1669
        """See BranchFormat.open()."""
1947
1670
        if not _found:
1948
1671
            # we are being called directly and must probe.
1950
1673
        return BzrBranch(_format=self,
1951
1674
                         _control_files=a_bzrdir._control_files,
1952
1675
                         a_bzrdir=a_bzrdir,
1953
 
                         name=name,
1954
1676
                         _repository=a_bzrdir.open_repository())
1955
1677
 
1956
1678
    def __str__(self):
1971
1693
        """
1972
1694
        return self.get_format_string()
1973
1695
 
1974
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1696
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1975
1697
        """See BranchFormat.open()."""
1976
1698
        if not _found:
1977
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1699
            format = BranchFormat.find_format(a_bzrdir)
1978
1700
            if format.__class__ != self.__class__:
1979
1701
                raise AssertionError("wrong format %r found for %r" %
1980
1702
                    (format, self))
1981
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1982
1703
        try:
 
1704
            transport = a_bzrdir.get_branch_transport(None)
1983
1705
            control_files = lockable_files.LockableFiles(transport, 'lock',
1984
1706
                                                         lockdir.LockDir)
1985
1707
            return self._branch_class()(_format=self,
1986
1708
                              _control_files=control_files,
1987
 
                              name=name,
1988
1709
                              a_bzrdir=a_bzrdir,
1989
1710
                              _repository=a_bzrdir.find_repository(),
1990
1711
                              ignore_fallbacks=ignore_fallbacks)
1991
1712
        except errors.NoSuchFile:
1992
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1713
            raise errors.NotBranchError(path=transport.base)
1993
1714
 
1994
1715
    def __init__(self):
1995
1716
        super(BranchFormatMetadir, self).__init__()
2024
1745
        """See BranchFormat.get_format_description()."""
2025
1746
        return "Branch format 5"
2026
1747
 
2027
 
    def initialize(self, a_bzrdir, name=None):
 
1748
    def initialize(self, a_bzrdir):
2028
1749
        """Create a branch of this format in a_bzrdir."""
2029
1750
        utf8_files = [('revision-history', ''),
2030
1751
                      ('branch-name', ''),
2031
1752
                      ]
2032
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1753
        return self._initialize_helper(a_bzrdir, utf8_files)
2033
1754
 
2034
1755
    def supports_tags(self):
2035
1756
        return False
2057
1778
        """See BranchFormat.get_format_description()."""
2058
1779
        return "Branch format 6"
2059
1780
 
2060
 
    def initialize(self, a_bzrdir, name=None):
 
1781
    def initialize(self, a_bzrdir):
2061
1782
        """Create a branch of this format in a_bzrdir."""
2062
1783
        utf8_files = [('last-revision', '0 null:\n'),
2063
1784
                      ('branch.conf', ''),
2064
1785
                      ('tags', ''),
2065
1786
                      ]
2066
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1787
        return self._initialize_helper(a_bzrdir, utf8_files)
2067
1788
 
2068
1789
    def make_tags(self, branch):
2069
1790
        """See bzrlib.branch.BranchFormat.make_tags()."""
2070
1791
        return BasicTags(branch)
2071
1792
 
2072
 
    def supports_set_append_revisions_only(self):
2073
 
        return True
2074
1793
 
2075
1794
 
2076
1795
class BzrBranchFormat8(BranchFormatMetadir):
2087
1806
        """See BranchFormat.get_format_description()."""
2088
1807
        return "Branch format 8"
2089
1808
 
2090
 
    def initialize(self, a_bzrdir, name=None):
 
1809
    def initialize(self, a_bzrdir):
2091
1810
        """Create a branch of this format in a_bzrdir."""
2092
1811
        utf8_files = [('last-revision', '0 null:\n'),
2093
1812
                      ('branch.conf', ''),
2094
1813
                      ('tags', ''),
2095
1814
                      ('references', '')
2096
1815
                      ]
2097
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1816
        return self._initialize_helper(a_bzrdir, utf8_files)
2098
1817
 
2099
1818
    def __init__(self):
2100
1819
        super(BzrBranchFormat8, self).__init__()
2105
1824
        """See bzrlib.branch.BranchFormat.make_tags()."""
2106
1825
        return BasicTags(branch)
2107
1826
 
2108
 
    def supports_set_append_revisions_only(self):
2109
 
        return True
2110
 
 
2111
1827
    def supports_stacking(self):
2112
1828
        return True
2113
1829
 
2123
1839
    This format was introduced in bzr 1.6.
2124
1840
    """
2125
1841
 
2126
 
    def initialize(self, a_bzrdir, name=None):
 
1842
    def initialize(self, a_bzrdir):
2127
1843
        """Create a branch of this format in a_bzrdir."""
2128
1844
        utf8_files = [('last-revision', '0 null:\n'),
2129
1845
                      ('branch.conf', ''),
2130
1846
                      ('tags', ''),
2131
1847
                      ]
2132
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1848
        return self._initialize_helper(a_bzrdir, utf8_files)
2133
1849
 
2134
1850
    def _branch_class(self):
2135
1851
        return BzrBranch7
2142
1858
        """See BranchFormat.get_format_description()."""
2143
1859
        return "Branch format 7"
2144
1860
 
2145
 
    def supports_set_append_revisions_only(self):
2146
 
        return True
2147
 
 
2148
1861
    supports_reference_locations = False
2149
1862
 
2150
1863
 
2170
1883
    def get_reference(self, a_bzrdir):
2171
1884
        """See BranchFormat.get_reference()."""
2172
1885
        transport = a_bzrdir.get_branch_transport(None)
2173
 
        return transport.get_bytes('location')
 
1886
        return transport.get('location').read()
2174
1887
 
2175
1888
    def set_reference(self, a_bzrdir, to_branch):
2176
1889
        """See BranchFormat.set_reference()."""
2177
1890
        transport = a_bzrdir.get_branch_transport(None)
2178
1891
        location = transport.put_bytes('location', to_branch.base)
2179
1892
 
2180
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1893
    def initialize(self, a_bzrdir, target_branch=None):
2181
1894
        """Create a branch of this format in a_bzrdir."""
2182
1895
        if target_branch is None:
2183
1896
            # this format does not implement branch itself, thus the implicit
2184
1897
            # creation contract must see it as uninitializable
2185
1898
            raise errors.UninitializableFormat(self)
2186
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2187
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1899
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1900
        branch_transport = a_bzrdir.get_branch_transport(self)
2188
1901
        branch_transport.put_bytes('location',
2189
 
            target_branch.bzrdir.user_url)
 
1902
            target_branch.bzrdir.root_transport.base)
2190
1903
        branch_transport.put_bytes('format', self.get_format_string())
2191
 
        branch = self.open(
2192
 
            a_bzrdir, name, _found=True,
 
1904
        return self.open(
 
1905
            a_bzrdir, _found=True,
2193
1906
            possible_transports=[target_branch.bzrdir.root_transport])
2194
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2195
 
        return branch
2196
1907
 
2197
1908
    def __init__(self):
2198
1909
        super(BranchReferenceFormat, self).__init__()
2204
1915
        def clone(to_bzrdir, revision_id=None,
2205
1916
            repository_policy=None):
2206
1917
            """See Branch.clone()."""
2207
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1918
            return format.initialize(to_bzrdir, a_branch)
2208
1919
            # cannot obey revision_id limits when cloning a reference ...
2209
1920
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2210
1921
            # emit some sort of warning/error to the caller ?!
2211
1922
        return clone
2212
1923
 
2213
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1924
    def open(self, a_bzrdir, _found=False, location=None,
2214
1925
             possible_transports=None, ignore_fallbacks=False):
2215
1926
        """Return the branch that the branch reference in a_bzrdir points at.
2216
1927
 
2217
1928
        :param a_bzrdir: A BzrDir that contains a branch.
2218
 
        :param name: Name of colocated branch to open, if any
2219
1929
        :param _found: a private parameter, do not use it. It is used to
2220
1930
            indicate if format probing has already be done.
2221
1931
        :param ignore_fallbacks: when set, no fallback branches will be opened
2226
1936
        :param possible_transports: An optional reusable transports list.
2227
1937
        """
2228
1938
        if not _found:
2229
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1939
            format = BranchFormat.find_format(a_bzrdir)
2230
1940
            if format.__class__ != self.__class__:
2231
1941
                raise AssertionError("wrong format %r found for %r" %
2232
1942
                    (format, self))
2234
1944
            location = self.get_reference(a_bzrdir)
2235
1945
        real_bzrdir = bzrdir.BzrDir.open(
2236
1946
            location, possible_transports=possible_transports)
2237
 
        result = real_bzrdir.open_branch(name=name, 
2238
 
            ignore_fallbacks=ignore_fallbacks)
 
1947
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2239
1948
        # this changes the behaviour of result.clone to create a new reference
2240
1949
        # rather than a copy of the content of the branch.
2241
1950
        # I did not use a proxy object because that needs much more extensive
2268
1977
BranchFormat.register_format(__format6)
2269
1978
BranchFormat.register_format(__format7)
2270
1979
BranchFormat.register_format(__format8)
2271
 
BranchFormat.set_default_format(__format7)
 
1980
BranchFormat.set_default_format(__format6)
2272
1981
_legacy_formats = [BzrBranchFormat4(),
2273
1982
    ]
2274
1983
network_format_registry.register(
2275
1984
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2276
1985
 
2277
1986
 
2278
 
class BranchWriteLockResult(LogicalLockResult):
2279
 
    """The result of write locking a branch.
2280
 
 
2281
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2282
 
        None.
2283
 
    :ivar unlock: A callable which will unlock the lock.
2284
 
    """
2285
 
 
2286
 
    def __init__(self, unlock, branch_token):
2287
 
        LogicalLockResult.__init__(self, unlock)
2288
 
        self.branch_token = branch_token
2289
 
 
2290
 
    def __repr__(self):
2291
 
        return "BranchWriteLockResult(%s, %s)" % (self.branch_token,
2292
 
            self.unlock)
2293
 
 
2294
 
 
2295
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1987
class BzrBranch(Branch):
2296
1988
    """A branch stored in the actual filesystem.
2297
1989
 
2298
1990
    Note that it's "local" in the context of the filesystem; it doesn't
2304
1996
    :ivar repository: Repository for this branch.
2305
1997
    :ivar base: The url of the base directory for this branch; the one
2306
1998
        containing the .bzr directory.
2307
 
    :ivar name: Optional colocated branch name as it exists in the control
2308
 
        directory.
2309
1999
    """
2310
2000
 
2311
2001
    def __init__(self, _format=None,
2312
 
                 _control_files=None, a_bzrdir=None, name=None,
2313
 
                 _repository=None, ignore_fallbacks=False):
 
2002
                 _control_files=None, a_bzrdir=None, _repository=None,
 
2003
                 ignore_fallbacks=False):
2314
2004
        """Create new branch object at a particular location."""
2315
2005
        if a_bzrdir is None:
2316
2006
            raise ValueError('a_bzrdir must be supplied')
2317
2007
        else:
2318
2008
            self.bzrdir = a_bzrdir
2319
2009
        self._base = self.bzrdir.transport.clone('..').base
2320
 
        self.name = name
2321
2010
        # XXX: We should be able to just do
2322
2011
        #   self.base = self.bzrdir.root_transport.base
2323
2012
        # but this does not quite work yet -- mbp 20080522
2330
2019
        Branch.__init__(self)
2331
2020
 
2332
2021
    def __str__(self):
2333
 
        if self.name is None:
2334
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2335
 
        else:
2336
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2337
 
                self.name)
 
2022
        return '%s(%r)' % (self.__class__.__name__, self.base)
2338
2023
 
2339
2024
    __repr__ = __str__
2340
2025
 
2351
2036
        return self.control_files.is_locked()
2352
2037
 
2353
2038
    def lock_write(self, token=None):
2354
 
        """Lock the branch for write operations.
2355
 
 
2356
 
        :param token: A token to permit reacquiring a previously held and
2357
 
            preserved lock.
2358
 
        :return: A BranchWriteLockResult.
2359
 
        """
2360
 
        if not self.is_locked():
2361
 
            self._note_lock('w')
2362
2039
        # All-in-one needs to always unlock/lock.
2363
2040
        repo_control = getattr(self.repository, 'control_files', None)
2364
2041
        if self.control_files == repo_control or not self.is_locked():
2365
 
            self.repository._warn_if_deprecated(self)
2366
2042
            self.repository.lock_write()
2367
2043
            took_lock = True
2368
2044
        else:
2369
2045
            took_lock = False
2370
2046
        try:
2371
 
            return BranchWriteLockResult(self.unlock,
2372
 
                self.control_files.lock_write(token=token))
 
2047
            return self.control_files.lock_write(token=token)
2373
2048
        except:
2374
2049
            if took_lock:
2375
2050
                self.repository.unlock()
2376
2051
            raise
2377
2052
 
2378
2053
    def lock_read(self):
2379
 
        """Lock the branch for read operations.
2380
 
 
2381
 
        :return: A bzrlib.lock.LogicalLockResult.
2382
 
        """
2383
 
        if not self.is_locked():
2384
 
            self._note_lock('r')
2385
2054
        # All-in-one needs to always unlock/lock.
2386
2055
        repo_control = getattr(self.repository, 'control_files', None)
2387
2056
        if self.control_files == repo_control or not self.is_locked():
2388
 
            self.repository._warn_if_deprecated(self)
2389
2057
            self.repository.lock_read()
2390
2058
            took_lock = True
2391
2059
        else:
2392
2060
            took_lock = False
2393
2061
        try:
2394
2062
            self.control_files.lock_read()
2395
 
            return LogicalLockResult(self.unlock)
2396
2063
        except:
2397
2064
            if took_lock:
2398
2065
                self.repository.unlock()
2399
2066
            raise
2400
2067
 
2401
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2402
2068
    def unlock(self):
2403
2069
        try:
2404
2070
            self.control_files.unlock()
2567
2233
        return result
2568
2234
 
2569
2235
    def get_stacked_on_url(self):
2570
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2236
        raise errors.UnstackableBranchFormat(self._format, self.base)
2571
2237
 
2572
2238
    def set_push_location(self, location):
2573
2239
        """See Branch.set_push_location."""
2706
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2707
2373
        super(BzrBranch8, self).__init__(*args, **kwargs)
2708
2374
        self._last_revision_info_cache = None
 
2375
        self._partial_revision_history_cache = []
2709
2376
        self._reference_info = None
2710
2377
 
2711
2378
    def _clear_cached_state(self):
2712
2379
        super(BzrBranch8, self)._clear_cached_state()
2713
2380
        self._last_revision_info_cache = None
 
2381
        self._partial_revision_history_cache = []
2714
2382
        self._reference_info = None
2715
2383
 
2716
2384
    def _last_revision_info(self):
2763
2431
        if _mod_revision.is_null(last_revision):
2764
2432
            return
2765
2433
        if last_revision not in self._lefthand_history(revision_id):
2766
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2434
            raise errors.AppendRevisionsOnlyViolation(self.base)
2767
2435
 
2768
2436
    def _gen_revision_history(self):
2769
2437
        """Generate the revision history from last revision
2772
2440
        self._extend_partial_history(stop_index=last_revno-1)
2773
2441
        return list(reversed(self._partial_revision_history_cache))
2774
2442
 
 
2443
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2444
        """Extend the partial history to include a given index
 
2445
 
 
2446
        If a stop_index is supplied, stop when that index has been reached.
 
2447
        If a stop_revision is supplied, stop when that revision is
 
2448
        encountered.  Otherwise, stop when the beginning of history is
 
2449
        reached.
 
2450
 
 
2451
        :param stop_index: The index which should be present.  When it is
 
2452
            present, history extension will stop.
 
2453
        :param revision_id: The revision id which should be present.  When
 
2454
            it is encountered, history extension will stop.
 
2455
        """
 
2456
        repo = self.repository
 
2457
        if len(self._partial_revision_history_cache) == 0:
 
2458
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2459
        else:
 
2460
            start_revision = self._partial_revision_history_cache[-1]
 
2461
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2462
            #skip the last revision in the list
 
2463
            next_revision = iterator.next()
 
2464
        for revision_id in iterator:
 
2465
            self._partial_revision_history_cache.append(revision_id)
 
2466
            if (stop_index is not None and
 
2467
                len(self._partial_revision_history_cache) > stop_index):
 
2468
                break
 
2469
            if revision_id == stop_revision:
 
2470
                break
 
2471
 
2775
2472
    def _write_revision_history(self, history):
2776
2473
        """Factored out of set_revision_history.
2777
2474
 
2869
2566
        if branch_location is None:
2870
2567
            return Branch.reference_parent(self, file_id, path,
2871
2568
                                           possible_transports)
2872
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2569
        branch_location = urlutils.join(self.base, branch_location)
2873
2570
        return Branch.open(branch_location,
2874
2571
                           possible_transports=possible_transports)
2875
2572
 
2920
2617
            raise errors.NotStacked(self)
2921
2618
        return stacked_url
2922
2619
 
 
2620
    def set_append_revisions_only(self, enabled):
 
2621
        if enabled:
 
2622
            value = 'True'
 
2623
        else:
 
2624
            value = 'False'
 
2625
        self.get_config().set_user_option('append_revisions_only', value,
 
2626
            warn_masked=True)
 
2627
 
2923
2628
    def _get_append_revisions_only(self):
2924
 
        return self.get_config(
2925
 
            ).get_user_option_as_bool('append_revisions_only')
 
2629
        value = self.get_config().get_user_option('append_revisions_only')
 
2630
        return value == 'True'
2926
2631
 
2927
2632
    @needs_write_lock
2928
2633
    def generate_revision_history(self, revision_id, last_rev=None,
2990
2695
    """
2991
2696
 
2992
2697
    def get_stacked_on_url(self):
2993
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2698
        raise errors.UnstackableBranchFormat(self._format, self.base)
2994
2699
 
2995
2700
 
2996
2701
######################################################################
3075
2780
 
3076
2781
    def __init__(self, branch):
3077
2782
        self.branch = branch
3078
 
        self.errors = []
3079
2783
 
3080
2784
    def report_results(self, verbose):
3081
2785
        """Report the check results via trace.note.
3083
2787
        :param verbose: Requests more detailed display of what was checked,
3084
2788
            if any.
3085
2789
        """
3086
 
        note('checked branch %s format %s', self.branch.user_url,
3087
 
            self.branch._format)
3088
 
        for error in self.errors:
3089
 
            note('found error:%s', error)
 
2790
        note('checked branch %s format %s',
 
2791
             self.branch.base,
 
2792
             self.branch._format)
3090
2793
 
3091
2794
 
3092
2795
class Converter5to6(object):
3187
2890
    @staticmethod
3188
2891
    def _get_branch_formats_to_test():
3189
2892
        """Return a tuple with the Branch formats to use when testing."""
3190
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
 
2893
        raise NotImplementedError(self._get_branch_formats_to_test)
3191
2894
 
3192
2895
    def pull(self, overwrite=False, stop_revision=None,
3193
2896
             possible_transports=None, local=False):
3348
3051
                _override_hook_source_branch=_override_hook_source_branch)
3349
3052
        finally:
3350
3053
            self.source.unlock()
 
3054
        return result
3351
3055
 
3352
3056
    def _push_with_bound_branches(self, overwrite, stop_revision,
3353
3057
            _override_hook_source_branch=None):
3418
3122
        if local and not bound_location:
3419
3123
            raise errors.LocalRequiresBoundBranch()
3420
3124
        master_branch = None
3421
 
        if not local and bound_location and self.source.user_url != bound_location:
 
3125
        if not local and bound_location and self.source.base != bound_location:
3422
3126
            # not pulling from master, so we need to update master.
3423
3127
            master_branch = self.target.get_master_branch(possible_transports)
3424
3128
            master_branch.lock_write()