/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.
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: An object with an unlock method which will release the lock
299
 
            obtained.
300
 
        """
301
260
        raise NotImplementedError(self.lock_read)
302
261
 
303
262
    def unlock(self):
428
387
            * 'include' - the stop revision is the last item in the result
429
388
            * 'with-merges' - include the stop revision and all of its
430
389
              merged revisions in the result
431
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
432
 
              that are in both ancestries
433
390
        :param direction: either 'reverse' or 'forward':
434
391
            * reverse means return the start_revision_id first, i.e.
435
392
              start at the most recent revision and go backwards in history
457
414
        # start_revision_id.
458
415
        if self._merge_sorted_revisions_cache is None:
459
416
            last_revision = self.last_revision()
460
 
            known_graph = self.repository.get_known_graph_ancestry(
461
 
                [last_revision])
462
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
463
 
                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
 
464
426
        filtered = self._filter_merge_sorted_revisions(
465
427
            self._merge_sorted_revisions_cache, start_revision_id,
466
428
            stop_revision_id, stop_rule)
467
 
        # Make sure we don't return revisions that are not part of the
468
 
        # start_revision_id ancestry.
469
 
        filtered = self._filter_start_non_ancestors(filtered)
470
429
        if direction == 'reverse':
471
430
            return filtered
472
431
        if direction == 'forward':
479
438
        """Iterate over an inclusive range of sorted revisions."""
480
439
        rev_iter = iter(merge_sorted_revisions)
481
440
        if start_revision_id is not None:
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
 
441
            for rev_id, depth, revno, end_of_merge in rev_iter:
484
442
                if rev_id != start_revision_id:
485
443
                    continue
486
444
                else:
487
445
                    # The decision to include the start or not
488
446
                    # depends on the stop_rule if a stop is provided
489
 
                    # so pop this node back into the iterator
490
 
                    rev_iter = chain(iter([node]), rev_iter)
 
447
                    rev_iter = chain(
 
448
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
449
                        rev_iter)
491
450
                    break
492
451
        if stop_revision_id is None:
493
 
            # Yield everything
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       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
498
454
        elif stop_rule == 'exclude':
499
 
            for node in rev_iter:
500
 
                rev_id = node.key[-1]
 
455
            for rev_id, depth, revno, end_of_merge in rev_iter:
501
456
                if rev_id == stop_revision_id:
502
457
                    return
503
 
                yield (rev_id, node.merge_depth, node.revno,
504
 
                       node.end_of_merge)
 
458
                yield rev_id, depth, revno, end_of_merge
505
459
        elif stop_rule == 'include':
506
 
            for node in rev_iter:
507
 
                rev_id = node.key[-1]
508
 
                yield (rev_id, node.merge_depth, node.revno,
509
 
                       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
510
462
                if rev_id == stop_revision_id:
511
463
                    return
512
 
        elif stop_rule == 'with-merges-without-common-ancestry':
513
 
            # We want to exclude all revisions that are already part of the
514
 
            # stop_revision_id ancestry.
515
 
            graph = self.repository.get_graph()
516
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
517
 
                                                    [stop_revision_id])
518
 
            for node in rev_iter:
519
 
                rev_id = node.key[-1]
520
 
                if rev_id not in ancestors:
521
 
                    continue
522
 
                yield (rev_id, node.merge_depth, node.revno,
523
 
                       node.end_of_merge)
524
464
        elif stop_rule == 'with-merges':
525
465
            stop_rev = self.repository.get_revision(stop_revision_id)
526
466
            if stop_rev.parent_ids:
527
467
                left_parent = stop_rev.parent_ids[0]
528
468
            else:
529
469
                left_parent = _mod_revision.NULL_REVISION
530
 
            # left_parent is the actual revision we want to stop logging at,
531
 
            # since we want to show the merged revisions after the stop_rev too
532
 
            reached_stop_revision_id = False
533
 
            revision_id_whitelist = []
534
 
            for node in rev_iter:
535
 
                rev_id = node.key[-1]
 
470
            for rev_id, depth, revno, end_of_merge in rev_iter:
536
471
                if rev_id == left_parent:
537
 
                    # reached the left parent after the stop_revision
538
472
                    return
539
 
                if (not reached_stop_revision_id or
540
 
                        rev_id in revision_id_whitelist):
541
 
                    yield (rev_id, node.merge_depth, node.revno,
542
 
                       node.end_of_merge)
543
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
544
 
                        # only do the merged revs of rev_id from now on
545
 
                        rev = self.repository.get_revision(rev_id)
546
 
                        if rev.parent_ids:
547
 
                            reached_stop_revision_id = True
548
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
473
                yield rev_id, depth, revno, end_of_merge
549
474
        else:
550
475
            raise ValueError('invalid stop_rule %r' % stop_rule)
551
476
 
552
 
    def _filter_start_non_ancestors(self, rev_iter):
553
 
        # If we started from a dotted revno, we want to consider it as a tip
554
 
        # and don't want to yield revisions that are not part of its
555
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
556
 
        # uninteresting descendants of the first parent of our tip before the
557
 
        # tip itself.
558
 
        first = rev_iter.next()
559
 
        (rev_id, merge_depth, revno, end_of_merge) = first
560
 
        yield first
561
 
        if not merge_depth:
562
 
            # We start at a mainline revision so by definition, all others
563
 
            # revisions in rev_iter are ancestors
564
 
            for node in rev_iter:
565
 
                yield node
566
 
 
567
 
        clean = False
568
 
        whitelist = set()
569
 
        pmap = self.repository.get_parent_map([rev_id])
570
 
        parents = pmap.get(rev_id, [])
571
 
        if parents:
572
 
            whitelist.update(parents)
573
 
        else:
574
 
            # If there is no parents, there is nothing of interest left
575
 
 
576
 
            # FIXME: It's hard to test this scenario here as this code is never
577
 
            # called in that case. -- vila 20100322
578
 
            return
579
 
 
580
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
581
 
            if not clean:
582
 
                if rev_id in whitelist:
583
 
                    pmap = self.repository.get_parent_map([rev_id])
584
 
                    parents = pmap.get(rev_id, [])
585
 
                    whitelist.remove(rev_id)
586
 
                    whitelist.update(parents)
587
 
                    if merge_depth == 0:
588
 
                        # We've reached the mainline, there is nothing left to
589
 
                        # filter
590
 
                        clean = True
591
 
                else:
592
 
                    # A revision that is not part of the ancestry of our
593
 
                    # starting revision.
594
 
                    continue
595
 
            yield (rev_id, merge_depth, revno, end_of_merge)
596
 
 
597
477
    def leave_lock_in_place(self):
598
478
        """Tell this branch object not to release the physical lock when this
599
479
        object is unlocked.
616
496
        :param other: The branch to bind to
617
497
        :type other: Branch
618
498
        """
619
 
        raise errors.UpgradeRequired(self.user_url)
620
 
 
621
 
    def set_append_revisions_only(self, enabled):
622
 
        if not self._format.supports_set_append_revisions_only():
623
 
            raise errors.UpgradeRequired(self.user_url)
624
 
        if enabled:
625
 
            value = 'True'
626
 
        else:
627
 
            value = 'False'
628
 
        self.get_config().set_user_option('append_revisions_only', value,
629
 
            warn_masked=True)
 
499
        raise errors.UpgradeRequired(self.base)
630
500
 
631
501
    def set_reference_info(self, file_id, tree_path, branch_location):
632
502
        """Set the branch location to use for a tree reference."""
674
544
    def get_old_bound_location(self):
675
545
        """Return the URL of the branch we used to be bound to
676
546
        """
677
 
        raise errors.UpgradeRequired(self.user_url)
 
547
        raise errors.UpgradeRequired(self.base)
678
548
 
679
549
    def get_commit_builder(self, parents, config=None, timestamp=None,
680
550
                           timezone=None, committer=None, revprops=None,
730
600
    def set_revision_history(self, rev_history):
731
601
        raise NotImplementedError(self.set_revision_history)
732
602
 
733
 
    @needs_write_lock
734
 
    def set_parent(self, url):
735
 
        """See Branch.set_parent."""
736
 
        # TODO: Maybe delete old location files?
737
 
        # URLs should never be unicode, even on the local fs,
738
 
        # FIXUP this and get_parent in a future branch format bump:
739
 
        # read and rewrite the file. RBC 20060125
740
 
        if url is not None:
741
 
            if isinstance(url, unicode):
742
 
                try:
743
 
                    url = url.encode('ascii')
744
 
                except UnicodeEncodeError:
745
 
                    raise errors.InvalidURL(url,
746
 
                        "Urls must be 7-bit ascii, "
747
 
                        "use bzrlib.urlutils.escape")
748
 
            url = urlutils.relative_url(self.base, url)
749
 
        self._set_parent_location(url)
750
 
 
751
 
    @needs_write_lock
752
603
    def set_stacked_on_url(self, url):
753
604
        """Set the URL this branch is stacked against.
754
605
 
758
609
            stacking.
759
610
        """
760
611
        if not self._format.supports_stacking():
761
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
762
 
        # XXX: Changing from one fallback repository to another does not check
763
 
        # that all the data you need is present in the new fallback.
764
 
        # Possibly it should.
 
612
            raise errors.UnstackableBranchFormat(self._format, self.base)
765
613
        self._check_stackable_repo()
766
614
        if not url:
767
615
            try:
769
617
            except (errors.NotStacked, errors.UnstackableBranchFormat,
770
618
                errors.UnstackableRepositoryFormat):
771
619
                return
772
 
            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)
773
632
        else:
774
633
            self._activate_fallback_location(url)
775
634
        # write this out after the repository is stacked to avoid setting a
776
635
        # stacked config that doesn't work.
777
636
        self._set_config_location('stacked_on_location', url)
778
637
 
779
 
    def _unstack(self):
780
 
        """Change a branch to be unstacked, copying data as needed.
781
 
        
782
 
        Don't call this directly, use set_stacked_on_url(None).
783
 
        """
784
 
        pb = ui.ui_factory.nested_progress_bar()
785
 
        try:
786
 
            pb.update("Unstacking")
787
 
            # The basic approach here is to fetch the tip of the branch,
788
 
            # including all available ghosts, from the existing stacked
789
 
            # repository into a new repository object without the fallbacks. 
790
 
            #
791
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
792
 
            # correct for CHKMap repostiories
793
 
            old_repository = self.repository
794
 
            if len(old_repository._fallback_repositories) != 1:
795
 
                raise AssertionError("can't cope with fallback repositories "
796
 
                    "of %r" % (self.repository,))
797
 
            # unlock it, including unlocking the fallback
798
 
            old_repository.unlock()
799
 
            old_repository.lock_read()
800
 
            try:
801
 
                # Repositories don't offer an interface to remove fallback
802
 
                # repositories today; take the conceptually simpler option and just
803
 
                # reopen it.  We reopen it starting from the URL so that we
804
 
                # get a separate connection for RemoteRepositories and can
805
 
                # stream from one of them to the other.  This does mean doing
806
 
                # separate SSH connection setup, but unstacking is not a
807
 
                # common operation so it's tolerable.
808
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
809
 
                new_repository = new_bzrdir.find_repository()
810
 
                self.repository = new_repository
811
 
                if self.repository._fallback_repositories:
812
 
                    raise AssertionError("didn't expect %r to have "
813
 
                        "fallback_repositories"
814
 
                        % (self.repository,))
815
 
                # this is not paired with an unlock because it's just restoring
816
 
                # the previous state; the lock's released when set_stacked_on_url
817
 
                # returns
818
 
                self.repository.lock_write()
819
 
                # XXX: If you unstack a branch while it has a working tree
820
 
                # with a pending merge, the pending-merged revisions will no
821
 
                # longer be present.  You can (probably) revert and remerge.
822
 
                #
823
 
                # XXX: This only fetches up to the tip of the repository; it
824
 
                # doesn't bring across any tags.  That's fairly consistent
825
 
                # with how branch works, but perhaps not ideal.
826
 
                self.repository.fetch(old_repository,
827
 
                    revision_id=self.last_revision(),
828
 
                    find_ghosts=True)
829
 
            finally:
830
 
                old_repository.unlock()
831
 
        finally:
832
 
            pb.finished()
833
638
 
834
639
    def _set_tags_bytes(self, bytes):
835
640
        """Mirror method for _get_tags_bytes.
871
676
        self._revision_id_to_revno_cache = None
872
677
        self._last_revision_info_cache = None
873
678
        self._merge_sorted_revisions_cache = None
874
 
        self._partial_revision_history_cache = []
875
 
        self._partial_revision_id_to_revno_cache = {}
876
679
 
877
680
    def _gen_revision_history(self):
878
681
        """Return sequence of revision hashes on to this branch.
915
718
 
916
719
    def unbind(self):
917
720
        """Older format branches cannot bind or unbind."""
918
 
        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)
919
726
 
920
727
    def last_revision(self):
921
728
        """Return last revision id, or NULL_REVISION."""
1002
809
        except ValueError:
1003
810
            raise errors.NoSuchRevision(self, revision_id)
1004
811
 
1005
 
    @needs_read_lock
1006
812
    def get_rev_id(self, revno, history=None):
1007
813
        """Find the revision id of the specified revno."""
1008
814
        if revno == 0:
1009
815
            return _mod_revision.NULL_REVISION
1010
 
        last_revno, last_revid = self.last_revision_info()
1011
 
        if revno == last_revno:
1012
 
            return last_revid
1013
 
        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):
1014
819
            raise errors.NoSuchRevision(self, revno)
1015
 
        distance_from_last = last_revno - revno
1016
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1017
 
            self._extend_partial_history(distance_from_last)
1018
 
        return self._partial_revision_history_cache[distance_from_last]
 
820
        return history[revno - 1]
1019
821
 
1020
 
    @needs_write_lock
1021
822
    def pull(self, source, overwrite=False, stop_revision=None,
1022
 
             possible_transports=None, *args, **kwargs):
 
823
             possible_transports=None, _override_hook_target=None):
1023
824
        """Mirror source into this branch.
1024
825
 
1025
826
        This branch is considered to be 'local', having low latency.
1026
827
 
1027
828
        :returns: PullResult instance
1028
829
        """
1029
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1030
 
            stop_revision=stop_revision,
1031
 
            possible_transports=possible_transports, *args, **kwargs)
 
830
        raise NotImplementedError(self.pull)
1032
831
 
1033
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1034
 
        **kwargs):
 
832
    def push(self, target, overwrite=False, stop_revision=None):
1035
833
        """Mirror this branch into target.
1036
834
 
1037
835
        This branch is considered to be 'local', having low latency.
1038
836
        """
1039
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1040
 
            *args, **kwargs)
1041
 
 
1042
 
    def lossy_push(self, target, stop_revision=None):
1043
 
        """Push deltas into another branch.
1044
 
 
1045
 
        :note: This does not, like push, retain the revision ids from 
1046
 
            the source branch and will, rather than adding bzr-specific 
1047
 
            metadata, push only those semantics of the revision that can be 
1048
 
            natively represented by this branch' VCS.
1049
 
 
1050
 
        :param target: Target branch
1051
 
        :param stop_revision: Revision to push, defaults to last revision.
1052
 
        :return: BranchPushResult with an extra member revidmap: 
1053
 
            A dictionary mapping revision ids from the target branch 
1054
 
            to new revision ids in the target branch, for each 
1055
 
            revision that was pushed.
1056
 
        """
1057
 
        inter = InterBranch.get(self, target)
1058
 
        lossy_push = getattr(inter, "lossy_push", None)
1059
 
        if lossy_push is None:
1060
 
            raise errors.LossyPushToSameVCS(self, target)
1061
 
        return lossy_push(stop_revision)
 
837
        raise NotImplementedError(self.push)
1062
838
 
1063
839
    def basis_tree(self):
1064
840
        """Return `Tree` object for last revision."""
1081
857
        try:
1082
858
            return urlutils.join(self.base[:-1], parent)
1083
859
        except errors.InvalidURLJoin, e:
1084
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
860
            raise errors.InaccessibleParent(parent, self.base)
1085
861
 
1086
862
    def _get_parent_location(self):
1087
863
        raise NotImplementedError(self._get_parent_location)
1104
880
            location = None
1105
881
        return location
1106
882
 
1107
 
    def get_child_submit_format(self):
1108
 
        """Return the preferred format of submissions to this branch."""
1109
 
        return self.get_config().get_user_option("child_submit_format")
1110
 
 
1111
883
    def get_submit_branch(self):
1112
884
        """Return the submit location of the branch.
1113
885
 
1172
944
        params = ChangeBranchTipParams(
1173
945
            self, old_revno, new_revno, old_revid, new_revid)
1174
946
        for hook in hooks:
1175
 
            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)
1176
959
 
1177
960
    @needs_write_lock
1178
961
    def update(self):
1209
992
                     be truncated to end with revision_id.
1210
993
        """
1211
994
        result = to_bzrdir.create_branch()
1212
 
        result.lock_write()
1213
 
        try:
1214
 
            if repository_policy is not None:
1215
 
                repository_policy.configure_branch(result)
1216
 
            self.copy_content_into(result, revision_id=revision_id)
1217
 
        finally:
1218
 
            result.unlock()
1219
 
        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
1220
999
 
1221
1000
    @needs_read_lock
1222
1001
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1227
1006
        revision_id: if not None, the revision history in the new branch will
1228
1007
                     be truncated to end with revision_id.
1229
1008
        """
1230
 
        if (repository_policy is not None and
1231
 
            repository_policy.requires_stacking()):
1232
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1233
1009
        result = to_bzrdir.create_branch()
1234
 
        result.lock_write()
1235
 
        try:
1236
 
            if repository_policy is not None:
1237
 
                repository_policy.configure_branch(result)
1238
 
            self.copy_content_into(result, revision_id=revision_id)
1239
 
            result.set_parent(self.bzrdir.root_transport.base)
1240
 
        finally:
1241
 
            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)
1242
1014
        return result
1243
1015
 
1244
1016
    def _synchronize_history(self, destination, revision_id):
1256
1028
        source_revno, source_revision_id = self.last_revision_info()
1257
1029
        if revision_id is None:
1258
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
1259
1034
        else:
1260
 
            graph = self.repository.get_graph()
1261
 
            try:
1262
 
                revno = graph.find_distance_to_null(revision_id, 
1263
 
                    [(source_revision_id, source_revno)])
1264
 
            except errors.GhostRevisionsHaveNoRevno:
1265
 
                # Default to 1, if we can't find anything else
1266
 
                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)))
1267
1043
        destination.set_last_revision_info(revno, revision_id)
1268
1044
 
1269
1045
    @needs_read_lock
1288
1064
    def update_references(self, target):
1289
1065
        if not getattr(self._format, 'supports_reference_locations', False):
1290
1066
            return
1291
 
        reference_dict = self._get_all_reference_info()
 
1067
        reference_dict = self._get_info_dict()
1292
1068
        if len(reference_dict) == 0:
1293
1069
            return
1294
1070
        old_base = self.base
1295
1071
        new_base = target.base
1296
 
        target_reference_dict = target._get_all_reference_info()
 
1072
        target_reference_dict = target._get_info_dict()
1297
1073
        for file_id, (tree_path, branch_location) in (
1298
1074
            reference_dict.items()):
1299
1075
            branch_location = urlutils.rebase_url(branch_location,
1300
1076
                                                  old_base, new_base)
1301
1077
            target_reference_dict.setdefault(
1302
1078
                file_id, (tree_path, branch_location))
1303
 
        target._set_all_reference_info(target_reference_dict)
 
1079
        target._save_reference_dict(target_reference_dict)
1304
1080
 
1305
1081
    @needs_read_lock
1306
 
    def check(self, refs):
 
1082
    def check(self):
1307
1083
        """Check consistency of the branch.
1308
1084
 
1309
1085
        In particular this checks that revisions given in the revision-history
1312
1088
 
1313
1089
        Callers will typically also want to check the repository.
1314
1090
 
1315
 
        :param refs: Calculated refs for this branch as specified by
1316
 
            branch._get_check_refs()
1317
1091
        :return: A BranchCheckResult.
1318
1092
        """
1319
 
        result = BranchCheckResult(self)
 
1093
        mainline_parent_id = None
1320
1094
        last_revno, last_revision_id = self.last_revision_info()
1321
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1322
 
        if actual_revno != last_revno:
1323
 
            result.errors.append(errors.BzrCheckError(
1324
 
                'revno does not match len(mainline) %s != %s' % (
1325
 
                last_revno, actual_revno)))
1326
 
        # TODO: We should probably also check that self.revision_history
1327
 
        # matches the repository for older branch formats.
1328
 
        # If looking for the code that cross-checks repository parents against
1329
 
        # the iter_reverse_revision_history output, that is now a repository
1330
 
        # specific check.
1331
 
        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)
1332
1119
 
1333
1120
    def _get_checkout_format(self):
1334
1121
        """Return the most suitable metadir for a checkout of this branch.
1344
1131
        return format
1345
1132
 
1346
1133
    def create_clone_on_transport(self, to_transport, revision_id=None,
1347
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1134
        stacked_on=None):
1348
1135
        """Create a clone of this branch and its bzrdir.
1349
1136
 
1350
1137
        :param to_transport: The transport to clone onto.
1351
1138
        :param revision_id: The revision id to use as tip in the new branch.
1352
1139
            If None the tip is obtained from this branch.
1353
1140
        :param stacked_on: An optional URL to stack the clone on.
1354
 
        :param create_prefix: Create any missing directories leading up to
1355
 
            to_transport.
1356
 
        :param use_existing_dir: Use an existing directory if one exists.
1357
1141
        """
1358
1142
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1359
1143
        # clone call. Or something. 20090224 RBC/spiv.
1360
 
        if revision_id is None:
1361
 
            revision_id = self.last_revision()
1362
1144
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1363
 
            revision_id=revision_id, stacked_on=stacked_on,
1364
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1145
            revision_id=revision_id, stacked_on=stacked_on)
1365
1146
        return dir_to.open_branch()
1366
1147
 
1367
1148
    def create_checkout(self, to_location, revision_id=None,
1386
1167
        if lightweight:
1387
1168
            format = self._get_checkout_format()
1388
1169
            checkout = format.initialize_on_transport(t)
1389
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1390
 
                target_branch=self)
 
1170
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1391
1171
        else:
1392
1172
            format = self._get_checkout_format()
1393
1173
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1435
1215
    def supports_tags(self):
1436
1216
        return self._format.supports_tags()
1437
1217
 
1438
 
    def automatic_tag_name(self, revision_id):
1439
 
        """Try to automatically find the tag name for a revision.
1440
 
 
1441
 
        :param revision_id: Revision id of the revision.
1442
 
        :return: A tag name or None if no tag name could be determined.
1443
 
        """
1444
 
        for hook in Branch.hooks['automatic_tag_name']:
1445
 
            ret = hook(self, revision_id)
1446
 
            if ret is not None:
1447
 
                return ret
1448
 
        return None
1449
 
 
1450
1218
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1451
1219
                                         other_branch):
1452
1220
        """Ensure that revision_b is a descendant of revision_a.
1507
1275
    _formats = {}
1508
1276
    """The known formats."""
1509
1277
 
1510
 
    can_set_append_revisions_only = True
1511
 
 
1512
1278
    def __eq__(self, other):
1513
1279
        return self.__class__ is other.__class__
1514
1280
 
1516
1282
        return not (self == other)
1517
1283
 
1518
1284
    @classmethod
1519
 
    def find_format(klass, a_bzrdir, name=None):
 
1285
    def find_format(klass, a_bzrdir):
1520
1286
        """Return the format for the branch object in a_bzrdir."""
1521
1287
        try:
1522
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1523
 
            format_string = transport.get_bytes("format")
 
1288
            transport = a_bzrdir.get_branch_transport(None)
 
1289
            format_string = transport.get("format").read()
1524
1290
            return klass._formats[format_string]
1525
1291
        except errors.NoSuchFile:
1526
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1292
            raise errors.NotBranchError(path=transport.base)
1527
1293
        except KeyError:
1528
1294
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1529
1295
 
1565
1331
        """Return the short format description for this format."""
1566
1332
        raise NotImplementedError(self.get_format_description)
1567
1333
 
1568
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1569
 
        hooks = Branch.hooks['post_branch_init']
1570
 
        if not hooks:
1571
 
            return
1572
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1573
 
        for hook in hooks:
1574
 
            hook(params)
1575
 
 
1576
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1577
 
                           lock_type='metadir', set_format=True):
 
1334
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1335
                           set_format=True):
1578
1336
        """Initialize a branch in a bzrdir, with specified files
1579
1337
 
1580
1338
        :param a_bzrdir: The bzrdir to initialize the branch in
1581
1339
        :param utf8_files: The files to create as a list of
1582
1340
            (filename, content) tuples
1583
 
        :param name: Name of colocated branch to create, if any
1584
1341
        :param set_format: If True, set the format with
1585
1342
            self.get_format_string.  (BzrBranch4 has its format set
1586
1343
            elsewhere)
1587
1344
        :return: a branch in this format
1588
1345
        """
1589
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1590
 
        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)
1591
1348
        lock_map = {
1592
1349
            'metadir': ('lock', lockdir.LockDir),
1593
1350
            'branch4': ('branch-lock', lockable_files.TransportLock),
1596
1353
        control_files = lockable_files.LockableFiles(branch_transport,
1597
1354
            lock_name, lock_class)
1598
1355
        control_files.create_lock()
1599
 
        try:
1600
 
            control_files.lock_write()
1601
 
        except errors.LockContention:
1602
 
            if lock_type != 'branch4':
1603
 
                raise
1604
 
            lock_taken = False
1605
 
        else:
1606
 
            lock_taken = True
 
1356
        control_files.lock_write()
1607
1357
        if set_format:
1608
1358
            utf8_files += [('format', self.get_format_string())]
1609
1359
        try:
1612
1362
                    filename, content,
1613
1363
                    mode=a_bzrdir._get_file_mode())
1614
1364
        finally:
1615
 
            if lock_taken:
1616
 
                control_files.unlock()
1617
 
        branch = self.open(a_bzrdir, name, _found=True)
1618
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1619
 
        return branch
 
1365
            control_files.unlock()
 
1366
        return self.open(a_bzrdir, _found=True)
1620
1367
 
1621
 
    def initialize(self, a_bzrdir, name=None):
1622
 
        """Create a branch of this format in a_bzrdir.
1623
 
        
1624
 
        :param name: Name of the colocated branch to create.
1625
 
        """
 
1368
    def initialize(self, a_bzrdir):
 
1369
        """Create a branch of this format in a_bzrdir."""
1626
1370
        raise NotImplementedError(self.initialize)
1627
1371
 
1628
1372
    def is_supported(self):
1658
1402
        """
1659
1403
        raise NotImplementedError(self.network_name)
1660
1404
 
1661
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1405
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1662
1406
        """Return the branch object for a_bzrdir
1663
1407
 
1664
1408
        :param a_bzrdir: A BzrDir that contains a branch.
1665
 
        :param name: Name of colocated branch to open
1666
1409
        :param _found: a private parameter, do not use it. It is used to
1667
1410
            indicate if format probing has already be done.
1668
1411
        :param ignore_fallbacks: when set, no fallback branches will be opened
1682
1425
    def set_default_format(klass, format):
1683
1426
        klass._default_format = format
1684
1427
 
1685
 
    def supports_set_append_revisions_only(self):
1686
 
        """True if this format supports set_append_revisions_only."""
1687
 
        return False
1688
 
 
1689
1428
    def supports_stacking(self):
1690
1429
        """True if this format records a stacked-on branch."""
1691
1430
        return False
1776
1515
            "multiple hooks installed for transform_fallback_location, "
1777
1516
            "all are called with the url returned from the previous hook."
1778
1517
            "The order is however undefined.", (1, 9), None))
1779
 
        self.create_hook(HookPoint('automatic_tag_name',
1780
 
            "Called to determine an automatic tag name for a revision."
1781
 
            "automatic_tag_name is called with (branch, revision_id) and "
1782
 
            "should return a tag name or None if no tag name could be "
1783
 
            "determined. The first non-None tag name returned will be used.",
1784
 
            (2, 2), None))
1785
 
        self.create_hook(HookPoint('post_branch_init',
1786
 
            "Called after new branch initialization completes. "
1787
 
            "post_branch_init is called with a "
1788
 
            "bzrlib.branch.BranchInitHookParams. "
1789
 
            "Note that init, branch and checkout (both heavyweight and "
1790
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1791
 
        self.create_hook(HookPoint('post_switch',
1792
 
            "Called after a checkout switches branch. "
1793
 
            "post_switch is called with a "
1794
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1795
 
 
1796
1518
 
1797
1519
 
1798
1520
# install the default hooks into the Branch class.
1837
1559
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1838
1560
 
1839
1561
 
1840
 
class BranchInitHookParams(object):
1841
 
    """Object holding parameters passed to *_branch_init hooks.
1842
 
 
1843
 
    There are 4 fields that hooks may wish to access:
1844
 
 
1845
 
    :ivar format: the branch format
1846
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1847
 
    :ivar name: name of colocated branch, if any (or None)
1848
 
    :ivar branch: the branch created
1849
 
 
1850
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1851
 
    the checkout, hence they are different from the corresponding fields in
1852
 
    branch, which refer to the original branch.
1853
 
    """
1854
 
 
1855
 
    def __init__(self, format, a_bzrdir, name, branch):
1856
 
        """Create a group of BranchInitHook parameters.
1857
 
 
1858
 
        :param format: the branch format
1859
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1860
 
            initialized
1861
 
        :param name: name of colocated branch, if any (or None)
1862
 
        :param branch: the branch created
1863
 
 
1864
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1865
 
        to the checkout, hence they are different from the corresponding fields
1866
 
        in branch, which refer to the original branch.
1867
 
        """
1868
 
        self.format = format
1869
 
        self.bzrdir = a_bzrdir
1870
 
        self.name = name
1871
 
        self.branch = branch
1872
 
 
1873
 
    def __eq__(self, other):
1874
 
        return self.__dict__ == other.__dict__
1875
 
 
1876
 
    def __repr__(self):
1877
 
        if self.branch:
1878
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1879
 
        else:
1880
 
            return "<%s of format:%s bzrdir:%s>" % (
1881
 
                self.__class__.__name__, self.branch,
1882
 
                self.format, self.bzrdir)
1883
 
 
1884
 
 
1885
 
class SwitchHookParams(object):
1886
 
    """Object holding parameters passed to *_switch hooks.
1887
 
 
1888
 
    There are 4 fields that hooks may wish to access:
1889
 
 
1890
 
    :ivar control_dir: BzrDir of the checkout to change
1891
 
    :ivar to_branch: branch that the checkout is to reference
1892
 
    :ivar force: skip the check for local commits in a heavy checkout
1893
 
    :ivar revision_id: revision ID to switch to (or None)
1894
 
    """
1895
 
 
1896
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1897
 
        """Create a group of SwitchHook parameters.
1898
 
 
1899
 
        :param control_dir: BzrDir of the checkout to change
1900
 
        :param to_branch: branch that the checkout is to reference
1901
 
        :param force: skip the check for local commits in a heavy checkout
1902
 
        :param revision_id: revision ID to switch to (or None)
1903
 
        """
1904
 
        self.control_dir = control_dir
1905
 
        self.to_branch = to_branch
1906
 
        self.force = force
1907
 
        self.revision_id = revision_id
1908
 
 
1909
 
    def __eq__(self, other):
1910
 
        return self.__dict__ == other.__dict__
1911
 
 
1912
 
    def __repr__(self):
1913
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1914
 
            self.control_dir, self.to_branch,
1915
 
            self.revision_id)
1916
 
 
1917
 
 
1918
1562
class BzrBranchFormat4(BranchFormat):
1919
1563
    """Bzr branch format 4.
1920
1564
 
1927
1571
        """See BranchFormat.get_format_description()."""
1928
1572
        return "Branch format 4"
1929
1573
 
1930
 
    def initialize(self, a_bzrdir, name=None):
 
1574
    def initialize(self, a_bzrdir):
1931
1575
        """Create a branch of this format in a_bzrdir."""
1932
1576
        utf8_files = [('revision-history', ''),
1933
1577
                      ('branch-name', ''),
1934
1578
                      ]
1935
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1579
        return self._initialize_helper(a_bzrdir, utf8_files,
1936
1580
                                       lock_type='branch4', set_format=False)
1937
1581
 
1938
1582
    def __init__(self):
1943
1587
        """The network name for this format is the control dirs disk label."""
1944
1588
        return self._matchingbzrdir.get_format_string()
1945
1589
 
1946
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1590
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1947
1591
        """See BranchFormat.open()."""
1948
1592
        if not _found:
1949
1593
            # we are being called directly and must probe.
1951
1595
        return BzrBranch(_format=self,
1952
1596
                         _control_files=a_bzrdir._control_files,
1953
1597
                         a_bzrdir=a_bzrdir,
1954
 
                         name=name,
1955
1598
                         _repository=a_bzrdir.open_repository())
1956
1599
 
1957
1600
    def __str__(self):
1972
1615
        """
1973
1616
        return self.get_format_string()
1974
1617
 
1975
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1618
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1976
1619
        """See BranchFormat.open()."""
1977
1620
        if not _found:
1978
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1621
            format = BranchFormat.find_format(a_bzrdir)
1979
1622
            if format.__class__ != self.__class__:
1980
1623
                raise AssertionError("wrong format %r found for %r" %
1981
1624
                    (format, self))
1982
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1983
1625
        try:
 
1626
            transport = a_bzrdir.get_branch_transport(None)
1984
1627
            control_files = lockable_files.LockableFiles(transport, 'lock',
1985
1628
                                                         lockdir.LockDir)
1986
1629
            return self._branch_class()(_format=self,
1987
1630
                              _control_files=control_files,
1988
 
                              name=name,
1989
1631
                              a_bzrdir=a_bzrdir,
1990
1632
                              _repository=a_bzrdir.find_repository(),
1991
1633
                              ignore_fallbacks=ignore_fallbacks)
1992
1634
        except errors.NoSuchFile:
1993
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1635
            raise errors.NotBranchError(path=transport.base)
1994
1636
 
1995
1637
    def __init__(self):
1996
1638
        super(BranchFormatMetadir, self).__init__()
2025
1667
        """See BranchFormat.get_format_description()."""
2026
1668
        return "Branch format 5"
2027
1669
 
2028
 
    def initialize(self, a_bzrdir, name=None):
 
1670
    def initialize(self, a_bzrdir):
2029
1671
        """Create a branch of this format in a_bzrdir."""
2030
1672
        utf8_files = [('revision-history', ''),
2031
1673
                      ('branch-name', ''),
2032
1674
                      ]
2033
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1675
        return self._initialize_helper(a_bzrdir, utf8_files)
2034
1676
 
2035
1677
    def supports_tags(self):
2036
1678
        return False
2058
1700
        """See BranchFormat.get_format_description()."""
2059
1701
        return "Branch format 6"
2060
1702
 
2061
 
    def initialize(self, a_bzrdir, name=None):
 
1703
    def initialize(self, a_bzrdir):
2062
1704
        """Create a branch of this format in a_bzrdir."""
2063
1705
        utf8_files = [('last-revision', '0 null:\n'),
2064
1706
                      ('branch.conf', ''),
2065
1707
                      ('tags', ''),
2066
1708
                      ]
2067
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1709
        return self._initialize_helper(a_bzrdir, utf8_files)
2068
1710
 
2069
1711
    def make_tags(self, branch):
2070
1712
        """See bzrlib.branch.BranchFormat.make_tags()."""
2071
1713
        return BasicTags(branch)
2072
1714
 
2073
 
    def supports_set_append_revisions_only(self):
2074
 
        return True
2075
1715
 
2076
1716
 
2077
1717
class BzrBranchFormat8(BranchFormatMetadir):
2088
1728
        """See BranchFormat.get_format_description()."""
2089
1729
        return "Branch format 8"
2090
1730
 
2091
 
    def initialize(self, a_bzrdir, name=None):
 
1731
    def initialize(self, a_bzrdir):
2092
1732
        """Create a branch of this format in a_bzrdir."""
2093
1733
        utf8_files = [('last-revision', '0 null:\n'),
2094
1734
                      ('branch.conf', ''),
2095
1735
                      ('tags', ''),
2096
1736
                      ('references', '')
2097
1737
                      ]
2098
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1738
        return self._initialize_helper(a_bzrdir, utf8_files)
2099
1739
 
2100
1740
    def __init__(self):
2101
1741
        super(BzrBranchFormat8, self).__init__()
2106
1746
        """See bzrlib.branch.BranchFormat.make_tags()."""
2107
1747
        return BasicTags(branch)
2108
1748
 
2109
 
    def supports_set_append_revisions_only(self):
2110
 
        return True
2111
 
 
2112
1749
    def supports_stacking(self):
2113
1750
        return True
2114
1751
 
2124
1761
    This format was introduced in bzr 1.6.
2125
1762
    """
2126
1763
 
2127
 
    def initialize(self, a_bzrdir, name=None):
2128
 
        """Create a branch of this format in a_bzrdir."""
2129
 
        utf8_files = [('last-revision', '0 null:\n'),
2130
 
                      ('branch.conf', ''),
2131
 
                      ('tags', ''),
2132
 
                      ]
2133
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2134
 
 
2135
1764
    def _branch_class(self):
2136
1765
        return BzrBranch7
2137
1766
 
2143
1772
        """See BranchFormat.get_format_description()."""
2144
1773
        return "Branch format 7"
2145
1774
 
2146
 
    def supports_set_append_revisions_only(self):
2147
 
        return True
2148
 
 
2149
1775
    supports_reference_locations = False
2150
1776
 
2151
1777
 
2171
1797
    def get_reference(self, a_bzrdir):
2172
1798
        """See BranchFormat.get_reference()."""
2173
1799
        transport = a_bzrdir.get_branch_transport(None)
2174
 
        return transport.get_bytes('location')
 
1800
        return transport.get('location').read()
2175
1801
 
2176
1802
    def set_reference(self, a_bzrdir, to_branch):
2177
1803
        """See BranchFormat.set_reference()."""
2178
1804
        transport = a_bzrdir.get_branch_transport(None)
2179
1805
        location = transport.put_bytes('location', to_branch.base)
2180
1806
 
2181
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1807
    def initialize(self, a_bzrdir, target_branch=None):
2182
1808
        """Create a branch of this format in a_bzrdir."""
2183
1809
        if target_branch is None:
2184
1810
            # this format does not implement branch itself, thus the implicit
2185
1811
            # creation contract must see it as uninitializable
2186
1812
            raise errors.UninitializableFormat(self)
2187
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2188
 
        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)
2189
1815
        branch_transport.put_bytes('location',
2190
 
            target_branch.bzrdir.user_url)
 
1816
            target_branch.bzrdir.root_transport.base)
2191
1817
        branch_transport.put_bytes('format', self.get_format_string())
2192
 
        branch = self.open(
2193
 
            a_bzrdir, name, _found=True,
 
1818
        return self.open(
 
1819
            a_bzrdir, _found=True,
2194
1820
            possible_transports=[target_branch.bzrdir.root_transport])
2195
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2196
 
        return branch
2197
1821
 
2198
1822
    def __init__(self):
2199
1823
        super(BranchReferenceFormat, self).__init__()
2205
1829
        def clone(to_bzrdir, revision_id=None,
2206
1830
            repository_policy=None):
2207
1831
            """See Branch.clone()."""
2208
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1832
            return format.initialize(to_bzrdir, a_branch)
2209
1833
            # cannot obey revision_id limits when cloning a reference ...
2210
1834
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2211
1835
            # emit some sort of warning/error to the caller ?!
2212
1836
        return clone
2213
1837
 
2214
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1838
    def open(self, a_bzrdir, _found=False, location=None,
2215
1839
             possible_transports=None, ignore_fallbacks=False):
2216
1840
        """Return the branch that the branch reference in a_bzrdir points at.
2217
1841
 
2218
1842
        :param a_bzrdir: A BzrDir that contains a branch.
2219
 
        :param name: Name of colocated branch to open, if any
2220
1843
        :param _found: a private parameter, do not use it. It is used to
2221
1844
            indicate if format probing has already be done.
2222
1845
        :param ignore_fallbacks: when set, no fallback branches will be opened
2227
1850
        :param possible_transports: An optional reusable transports list.
2228
1851
        """
2229
1852
        if not _found:
2230
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1853
            format = BranchFormat.find_format(a_bzrdir)
2231
1854
            if format.__class__ != self.__class__:
2232
1855
                raise AssertionError("wrong format %r found for %r" %
2233
1856
                    (format, self))
2235
1858
            location = self.get_reference(a_bzrdir)
2236
1859
        real_bzrdir = bzrdir.BzrDir.open(
2237
1860
            location, possible_transports=possible_transports)
2238
 
        result = real_bzrdir.open_branch(name=name, 
2239
 
            ignore_fallbacks=ignore_fallbacks)
 
1861
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2240
1862
        # this changes the behaviour of result.clone to create a new reference
2241
1863
        # rather than a copy of the content of the branch.
2242
1864
        # I did not use a proxy object because that needs much more extensive
2269
1891
BranchFormat.register_format(__format6)
2270
1892
BranchFormat.register_format(__format7)
2271
1893
BranchFormat.register_format(__format8)
2272
 
BranchFormat.set_default_format(__format7)
 
1894
BranchFormat.set_default_format(__format6)
2273
1895
_legacy_formats = [BzrBranchFormat4(),
2274
1896
    ]
2275
1897
network_format_registry.register(
2276
1898
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2277
1899
 
2278
1900
 
2279
 
class BranchWriteLockResult(object):
2280
 
    """The result of write locking a branch.
2281
 
 
2282
 
    :ivar branch_token: The token obtained from the underlying branch lock, or
2283
 
        None.
2284
 
    :ivar unlock: A callable which will unlock the lock.
2285
 
    """
2286
 
 
2287
 
    def __init__(self, unlock, branch_token):
2288
 
        self.branch_token = branch_token
2289
 
        self.unlock = unlock
2290
 
 
2291
 
 
2292
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1901
class BzrBranch(Branch):
2293
1902
    """A branch stored in the actual filesystem.
2294
1903
 
2295
1904
    Note that it's "local" in the context of the filesystem; it doesn't
2301
1910
    :ivar repository: Repository for this branch.
2302
1911
    :ivar base: The url of the base directory for this branch; the one
2303
1912
        containing the .bzr directory.
2304
 
    :ivar name: Optional colocated branch name as it exists in the control
2305
 
        directory.
2306
1913
    """
2307
1914
 
2308
1915
    def __init__(self, _format=None,
2309
 
                 _control_files=None, a_bzrdir=None, name=None,
2310
 
                 _repository=None, ignore_fallbacks=False):
 
1916
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1917
                 ignore_fallbacks=False):
2311
1918
        """Create new branch object at a particular location."""
2312
1919
        if a_bzrdir is None:
2313
1920
            raise ValueError('a_bzrdir must be supplied')
2314
1921
        else:
2315
1922
            self.bzrdir = a_bzrdir
2316
1923
        self._base = self.bzrdir.transport.clone('..').base
2317
 
        self.name = name
2318
1924
        # XXX: We should be able to just do
2319
1925
        #   self.base = self.bzrdir.root_transport.base
2320
1926
        # but this does not quite work yet -- mbp 20080522
2327
1933
        Branch.__init__(self)
2328
1934
 
2329
1935
    def __str__(self):
2330
 
        if self.name is None:
2331
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2332
 
        else:
2333
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2334
 
                self.name)
 
1936
        return '%s(%r)' % (self.__class__.__name__, self.base)
2335
1937
 
2336
1938
    __repr__ = __str__
2337
1939
 
2348
1950
        return self.control_files.is_locked()
2349
1951
 
2350
1952
    def lock_write(self, token=None):
2351
 
        """Lock the branch for write operations.
2352
 
 
2353
 
        :param token: A token to permit reacquiring a previously held and
2354
 
            preserved lock.
2355
 
        :return: A BranchWriteLockResult.
2356
 
        """
2357
 
        if not self.is_locked():
2358
 
            self._note_lock('w')
2359
 
        # All-in-one needs to always unlock/lock.
2360
 
        repo_control = getattr(self.repository, 'control_files', None)
2361
 
        if self.control_files == repo_control or not self.is_locked():
2362
 
            self.repository._warn_if_deprecated(self)
2363
 
            self.repository.lock_write()
2364
 
            took_lock = True
2365
 
        else:
2366
 
            took_lock = False
 
1953
        repo_token = self.repository.lock_write()
2367
1954
        try:
2368
 
            return BranchWriteLockResult(self.unlock,
2369
 
                self.control_files.lock_write(token=token))
 
1955
            token = self.control_files.lock_write(token=token)
2370
1956
        except:
2371
 
            if took_lock:
2372
 
                self.repository.unlock()
 
1957
            self.repository.unlock()
2373
1958
            raise
 
1959
        return token
2374
1960
 
2375
1961
    def lock_read(self):
2376
 
        """Lock the branch for read operations.
2377
 
 
2378
 
        :return: An object with an unlock method which will release the lock
2379
 
            obtained.
2380
 
        """
2381
 
        if not self.is_locked():
2382
 
            self._note_lock('r')
2383
 
        # All-in-one needs to always unlock/lock.
2384
 
        repo_control = getattr(self.repository, 'control_files', None)
2385
 
        if self.control_files == repo_control or not self.is_locked():
2386
 
            self.repository._warn_if_deprecated(self)
2387
 
            self.repository.lock_read()
2388
 
            took_lock = True
2389
 
        else:
2390
 
            took_lock = False
 
1962
        self.repository.lock_read()
2391
1963
        try:
2392
1964
            self.control_files.lock_read()
2393
 
            return self
2394
1965
        except:
2395
 
            if took_lock:
2396
 
                self.repository.unlock()
 
1966
            self.repository.unlock()
2397
1967
            raise
2398
1968
 
2399
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2400
1969
    def unlock(self):
 
1970
        # TODO: test for failed two phase locks. This is known broken.
2401
1971
        try:
2402
1972
            self.control_files.unlock()
2403
1973
        finally:
2404
 
            # All-in-one needs to always unlock/lock.
2405
 
            repo_control = getattr(self.repository, 'control_files', None)
2406
 
            if (self.control_files == repo_control or
2407
 
                not self.control_files.is_locked()):
2408
 
                self.repository.unlock()
2409
 
            if not self.control_files.is_locked():
2410
 
                # we just released the lock
2411
 
                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()
2412
1978
 
2413
1979
    def peek_lock_mode(self):
2414
1980
        if self.control_files._lock_count == 0:
2533
2099
        """See Branch.basis_tree."""
2534
2100
        return self.repository.revision_tree(self.last_revision())
2535
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
 
2536
2146
    def _get_parent_location(self):
2537
2147
        _locs = ['parent', 'pull', 'x-pull']
2538
2148
        for l in _locs:
2542
2152
                pass
2543
2153
        return None
2544
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
 
2545
2220
    def _basic_push(self, target, overwrite, stop_revision):
2546
2221
        """Basic implementation of push without bound branches or hooks.
2547
2222
 
2548
 
        Must be called with source read locked and target write locked.
 
2223
        Must be called with self read locked and target write locked.
2549
2224
        """
2550
2225
        result = BranchPushResult()
2551
2226
        result.source_branch = self
2556
2231
            # We assume that during 'push' this repository is closer than
2557
2232
            # the target.
2558
2233
            graph = self.repository.get_graph(target.repository)
2559
 
            target.update_revisions(self, stop_revision,
2560
 
                overwrite=overwrite, graph=graph)
 
2234
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2235
                                    graph=graph)
2561
2236
        if self._push_should_merge_tags():
2562
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2563
 
                overwrite)
 
2237
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2564
2238
        result.new_revno, result.new_revid = target.last_revision_info()
2565
2239
        return result
2566
2240
 
2567
2241
    def get_stacked_on_url(self):
2568
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2242
        raise errors.UnstackableBranchFormat(self._format, self.base)
2569
2243
 
2570
2244
    def set_push_location(self, location):
2571
2245
        """See Branch.set_push_location."""
2573
2247
            'push_location', location,
2574
2248
            store=_mod_config.STORE_LOCATION_NORECURSE)
2575
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
 
2576
2268
    def _set_parent_location(self, url):
2577
2269
        if url is None:
2578
2270
            self._transport.delete('parent')
2587
2279
    It has support for a master_branch which is the data for bound branches.
2588
2280
    """
2589
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
 
2590
2311
    def get_bound_location(self):
2591
2312
        try:
2592
2313
            return self._transport.get_bytes('bound')[:-1]
2704
2425
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2705
2426
        super(BzrBranch8, self).__init__(*args, **kwargs)
2706
2427
        self._last_revision_info_cache = None
2707
 
        self._reference_info = None
 
2428
        self._partial_revision_history_cache = []
2708
2429
 
2709
2430
    def _clear_cached_state(self):
2710
2431
        super(BzrBranch8, self)._clear_cached_state()
2711
2432
        self._last_revision_info_cache = None
2712
 
        self._reference_info = None
 
2433
        self._partial_revision_history_cache = []
2713
2434
 
2714
2435
    def _last_revision_info(self):
2715
2436
        revision_string = self._transport.get_bytes('last-revision')
2761
2482
        if _mod_revision.is_null(last_revision):
2762
2483
            return
2763
2484
        if last_revision not in self._lefthand_history(revision_id):
2764
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2485
            raise errors.AppendRevisionsOnlyViolation(self.base)
2765
2486
 
2766
2487
    def _gen_revision_history(self):
2767
2488
        """Generate the revision history from last revision
2770
2491
        self._extend_partial_history(stop_index=last_revno-1)
2771
2492
        return list(reversed(self._partial_revision_history_cache))
2772
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
 
2773
2523
    def _write_revision_history(self, history):
2774
2524
        """Factored out of set_revision_history.
2775
2525
 
2796
2546
        """Set the parent branch"""
2797
2547
        return self._get_config_location('parent_location')
2798
2548
 
2799
 
    @needs_write_lock
2800
 
    def _set_all_reference_info(self, info_dict):
2801
 
        """Replace all reference info stored in a branch.
2802
 
 
2803
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2804
 
        """
2805
 
        s = StringIO()
2806
 
        writer = rio.RioWriter(s)
2807
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2808
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2809
 
                                branch_location=branch_location)
2810
 
            writer.write_stanza(stanza)
2811
 
        self._transport.put_bytes('references', s.getvalue())
2812
 
        self._reference_info = info_dict
2813
 
 
2814
 
    @needs_read_lock
2815
 
    def _get_all_reference_info(self):
2816
 
        """Return all the reference info stored in a branch.
2817
 
 
2818
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2819
 
        """
2820
 
        if self._reference_info is not None:
2821
 
            return self._reference_info
 
2549
    def _get_info_dict(self):
2822
2550
        rio_file = self._transport.get('references')
2823
2551
        try:
2824
2552
            stanzas = rio.read_stanzas(rio_file)
2826
2554
                             s['branch_location'])) for s in stanzas)
2827
2555
        finally:
2828
2556
            rio_file.close()
2829
 
        self._reference_info = info_dict
2830
2557
        return info_dict
2831
2558
 
2832
2559
    def set_reference_info(self, file_id, tree_path, branch_location):
2833
 
        """Set the branch location to use for a tree reference.
2834
 
 
2835
 
        :param file_id: The file-id of the tree reference.
2836
 
        :param tree_path: The path of the tree reference in the tree.
2837
 
        :param branch_location: The location of the branch to retrieve tree
2838
 
            references from.
2839
 
        """
2840
 
        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()
2841
2562
        info_dict[file_id] = (tree_path, branch_location)
2842
2563
        if None in (tree_path, branch_location):
2843
2564
            if tree_path is not None:
2847
2568
                raise ValueError('branch_location must be None when tree_path'
2848
2569
                                 ' is None.')
2849
2570
            del info_dict[file_id]
2850
 
        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())
2851
2581
 
2852
2582
    def get_reference_info(self, file_id):
2853
 
        """Get the tree_path and branch_location for a tree reference.
2854
 
 
2855
 
        :return: a tuple of (tree_path, branch_location)
2856
 
        """
2857
 
        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))
2858
2585
 
2859
2586
    def reference_parent(self, file_id, path, possible_transports=None):
2860
2587
        """Return the parent branch for a tree-reference file_id.
2867
2594
        if branch_location is None:
2868
2595
            return Branch.reference_parent(self, file_id, path,
2869
2596
                                           possible_transports)
2870
 
        branch_location = urlutils.join(self.user_url, branch_location)
 
2597
        branch_location = urlutils.join(self.base, branch_location)
2871
2598
        return Branch.open(branch_location,
2872
2599
                           possible_transports=possible_transports)
2873
2600
 
2918
2645
            raise errors.NotStacked(self)
2919
2646
        return stacked_url
2920
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
 
2921
2656
    def _get_append_revisions_only(self):
2922
 
        return self.get_config(
2923
 
            ).get_user_option_as_bool('append_revisions_only')
 
2657
        value = self.get_config().get_user_option('append_revisions_only')
 
2658
        return value == 'True'
2924
2659
 
2925
2660
    @needs_write_lock
2926
2661
    def generate_revision_history(self, revision_id, last_rev=None,
2988
2723
    """
2989
2724
 
2990
2725
    def get_stacked_on_url(self):
2991
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2726
        raise errors.UnstackableBranchFormat(self._format, self.base)
2992
2727
 
2993
2728
 
2994
2729
######################################################################
3073
2808
 
3074
2809
    def __init__(self, branch):
3075
2810
        self.branch = branch
3076
 
        self.errors = []
3077
2811
 
3078
2812
    def report_results(self, verbose):
3079
2813
        """Report the check results via trace.note.
3081
2815
        :param verbose: Requests more detailed display of what was checked,
3082
2816
            if any.
3083
2817
        """
3084
 
        note('checked branch %s format %s', self.branch.user_url,
3085
 
            self.branch._format)
3086
 
        for error in self.errors:
3087
 
            note('found error:%s', error)
 
2818
        note('checked branch %s format %s',
 
2819
             self.branch.base,
 
2820
             self.branch._format)
3088
2821
 
3089
2822
 
3090
2823
class Converter5to6(object):
3128
2861
        branch._transport.put_bytes('format', format.get_format_string())
3129
2862
 
3130
2863
 
3131
 
class Converter7to8(object):
3132
 
    """Perform an in-place upgrade of format 6 to format 7"""
3133
 
 
3134
 
    def convert(self, branch):
3135
 
        format = BzrBranchFormat8()
3136
 
        branch._transport.put_bytes('references', '')
3137
 
        # update target format
3138
 
        branch._transport.put_bytes('format', format.get_format_string())
3139
 
 
3140
2864
 
3141
2865
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3142
2866
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3185
2909
    @staticmethod
3186
2910
    def _get_branch_formats_to_test():
3187
2911
        """Return a tuple with the Branch formats to use when testing."""
3188
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3189
 
 
3190
 
    def pull(self, overwrite=False, stop_revision=None,
3191
 
             possible_transports=None, local=False):
3192
 
        """Mirror source into target branch.
3193
 
 
3194
 
        The target branch is considered to be 'local', having low latency.
3195
 
 
3196
 
        :returns: PullResult instance
3197
 
        """
3198
 
        raise NotImplementedError(self.pull)
 
2912
        raise NotImplementedError(self._get_branch_formats_to_test)
3199
2913
 
3200
2914
    def update_revisions(self, stop_revision=None, overwrite=False,
3201
2915
                         graph=None):
3210
2924
        """
3211
2925
        raise NotImplementedError(self.update_revisions)
3212
2926
 
3213
 
    def push(self, overwrite=False, stop_revision=None,
3214
 
             _override_hook_source_branch=None):
3215
 
        """Mirror the source branch into the target branch.
3216
 
 
3217
 
        The source branch is considered to be 'local', having low latency.
3218
 
        """
3219
 
        raise NotImplementedError(self.push)
3220
 
 
3221
2927
 
3222
2928
class GenericInterBranch(InterBranch):
3223
2929
    """InterBranch implementation that uses public Branch functions.
3270
2976
        finally:
3271
2977
            self.source.unlock()
3272
2978
 
3273
 
    def pull(self, overwrite=False, stop_revision=None,
3274
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3275
 
             _override_hook_target=None, local=False):
3276
 
        """See Branch.pull.
3277
 
 
3278
 
        :param _hook_master: Private parameter - set the branch to
3279
 
            be supplied as the master to pull hooks.
3280
 
        :param run_hooks: Private parameter - if false, this branch
3281
 
            is being called because it's the master of the primary branch,
3282
 
            so it should not run its hooks.
3283
 
        :param _override_hook_target: Private parameter - set the branch to be
3284
 
            supplied as the target_branch to pull hooks.
3285
 
        :param local: Only update the local branch, and not the bound branch.
3286
 
        """
3287
 
        # This type of branch can't be bound.
3288
 
        if local:
3289
 
            raise errors.LocalRequiresBoundBranch()
3290
 
        result = PullResult()
3291
 
        result.source_branch = self.source
3292
 
        if _override_hook_target is None:
3293
 
            result.target_branch = self.target
3294
 
        else:
3295
 
            result.target_branch = _override_hook_target
3296
 
        self.source.lock_read()
3297
 
        try:
3298
 
            # We assume that during 'pull' the target repository is closer than
3299
 
            # the source one.
3300
 
            self.source.update_references(self.target)
3301
 
            graph = self.target.repository.get_graph(self.source.repository)
3302
 
            # TODO: Branch formats should have a flag that indicates 
3303
 
            # that revno's are expensive, and pull() should honor that flag.
3304
 
            # -- JRV20090506
3305
 
            result.old_revno, result.old_revid = \
3306
 
                self.target.last_revision_info()
3307
 
            self.target.update_revisions(self.source, stop_revision,
3308
 
                overwrite=overwrite, graph=graph)
3309
 
            # TODO: The old revid should be specified when merging tags, 
3310
 
            # so a tags implementation that versions tags can only 
3311
 
            # pull in the most recent changes. -- JRV20090506
3312
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3313
 
                overwrite)
3314
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3315
 
            if _hook_master:
3316
 
                result.master_branch = _hook_master
3317
 
                result.local_branch = result.target_branch
3318
 
            else:
3319
 
                result.master_branch = result.target_branch
3320
 
                result.local_branch = None
3321
 
            if run_hooks:
3322
 
                for hook in Branch.hooks['post_pull']:
3323
 
                    hook(result)
3324
 
        finally:
3325
 
            self.source.unlock()
3326
 
        return result
3327
 
 
3328
 
    def push(self, overwrite=False, stop_revision=None,
3329
 
             _override_hook_source_branch=None):
3330
 
        """See InterBranch.push.
3331
 
 
3332
 
        This is the basic concrete implementation of push()
3333
 
 
3334
 
        :param _override_hook_source_branch: If specified, run
3335
 
        the hooks passing this Branch as the source, rather than self.
3336
 
        This is for use of RemoteBranch, where push is delegated to the
3337
 
        underlying vfs-based Branch.
3338
 
        """
3339
 
        # TODO: Public option to disable running hooks - should be trivial but
3340
 
        # needs tests.
3341
 
        self.source.lock_read()
3342
 
        try:
3343
 
            return _run_with_write_locked_target(
3344
 
                self.target, self._push_with_bound_branches, overwrite,
3345
 
                stop_revision,
3346
 
                _override_hook_source_branch=_override_hook_source_branch)
3347
 
        finally:
3348
 
            self.source.unlock()
3349
 
 
3350
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3351
 
            _override_hook_source_branch=None):
3352
 
        """Push from source into target, and into target's master if any.
3353
 
        """
3354
 
        def _run_hooks():
3355
 
            if _override_hook_source_branch:
3356
 
                result.source_branch = _override_hook_source_branch
3357
 
            for hook in Branch.hooks['post_push']:
3358
 
                hook(result)
3359
 
 
3360
 
        bound_location = self.target.get_bound_location()
3361
 
        if bound_location and self.target.base != bound_location:
3362
 
            # there is a master branch.
3363
 
            #
3364
 
            # XXX: Why the second check?  Is it even supported for a branch to
3365
 
            # be bound to itself? -- mbp 20070507
3366
 
            master_branch = self.target.get_master_branch()
3367
 
            master_branch.lock_write()
3368
 
            try:
3369
 
                # push into the master from the source branch.
3370
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3371
 
                # and push into the target branch from the source. Note that we
3372
 
                # push from the source branch again, because its considered the
3373
 
                # highest bandwidth repository.
3374
 
                result = self.source._basic_push(self.target, overwrite,
3375
 
                    stop_revision)
3376
 
                result.master_branch = master_branch
3377
 
                result.local_branch = self.target
3378
 
                _run_hooks()
3379
 
                return result
3380
 
            finally:
3381
 
                master_branch.unlock()
3382
 
        else:
3383
 
            # no master branch
3384
 
            result = self.source._basic_push(self.target, overwrite,
3385
 
                stop_revision)
3386
 
            # TODO: Why set master_branch and local_branch if there's no
3387
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3388
 
            # 20070504
3389
 
            result.master_branch = self.target
3390
 
            result.local_branch = None
3391
 
            _run_hooks()
3392
 
            return result
3393
 
 
3394
2979
    @classmethod
3395
2980
    def is_compatible(self, source, target):
3396
2981
        # GenericBranch uses the public API, so always compatible
3397
2982
        return True
3398
2983
 
3399
2984
 
3400
 
class InterToBranch5(GenericInterBranch):
3401
 
 
3402
 
    @staticmethod
3403
 
    def _get_branch_formats_to_test():
3404
 
        return BranchFormat._default_format, BzrBranchFormat5()
3405
 
 
3406
 
    def pull(self, overwrite=False, stop_revision=None,
3407
 
             possible_transports=None, run_hooks=True,
3408
 
             _override_hook_target=None, local=False):
3409
 
        """Pull from source into self, updating my master if any.
3410
 
 
3411
 
        :param run_hooks: Private parameter - if false, this branch
3412
 
            is being called because it's the master of the primary branch,
3413
 
            so it should not run its hooks.
3414
 
        """
3415
 
        bound_location = self.target.get_bound_location()
3416
 
        if local and not bound_location:
3417
 
            raise errors.LocalRequiresBoundBranch()
3418
 
        master_branch = None
3419
 
        if not local and bound_location and self.source.user_url != bound_location:
3420
 
            # not pulling from master, so we need to update master.
3421
 
            master_branch = self.target.get_master_branch(possible_transports)
3422
 
            master_branch.lock_write()
3423
 
        try:
3424
 
            if master_branch:
3425
 
                # pull from source into master.
3426
 
                master_branch.pull(self.source, overwrite, stop_revision,
3427
 
                    run_hooks=False)
3428
 
            return super(InterToBranch5, self).pull(overwrite,
3429
 
                stop_revision, _hook_master=master_branch,
3430
 
                run_hooks=run_hooks,
3431
 
                _override_hook_target=_override_hook_target)
3432
 
        finally:
3433
 
            if master_branch:
3434
 
                master_branch.unlock()
3435
 
 
3436
 
 
3437
2985
InterBranch.register_optimiser(GenericInterBranch)
3438
 
InterBranch.register_optimiser(InterToBranch5)