~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-04-10 19:37:20 UTC
  • mfrom: (4222.3.15 username)
  • Revision ID: pqm@pqm.ubuntu.com-20090410193720-nyej7ft1k2yoyhui
(Jelmer) Prompt for user names for http if they are not in the
        configuration.

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
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
 
18
 
from cStringIO import StringIO
19
18
import sys
20
19
 
21
20
from bzrlib.lazy_import import lazy_import
31
30
        lockable_files,
32
31
        repository,
33
32
        revision as _mod_revision,
34
 
        rio,
35
33
        symbol_versioning,
36
34
        transport,
37
35
        tsort,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
47
from bzrlib.decorators import needs_read_lock, needs_write_lock
50
48
from bzrlib.hooks import HookPoint, Hooks
51
49
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
50
from bzrlib import registry
54
51
from bzrlib.symbol_versioning import (
55
52
    deprecated_in,
63
60
BZR_BRANCH_FORMAT_6 = "Bazaar Branch Format 6 (bzr 0.15)\n"
64
61
 
65
62
 
66
 
class Branch(bzrdir.ControlComponent):
 
63
# TODO: Maybe include checks for common corruption of newlines, etc?
 
64
 
 
65
# TODO: Some operations like log might retrieve the same revisions
 
66
# repeatedly to calculate deltas.  We could perhaps have a weakref
 
67
# cache in memory to make this faster.  In general anything can be
 
68
# cached in memory between lock and unlock operations. .. nb thats
 
69
# what the transaction identity map provides
 
70
 
 
71
 
 
72
######################################################################
 
73
# branch objects
 
74
 
 
75
class Branch(object):
67
76
    """Branch holding a history of revisions.
68
77
 
69
 
    :ivar base:
70
 
        Base directory/url of the branch; using control_url and
71
 
        control_transport is more standardized.
 
78
    base
 
79
        Base directory/url of the branch.
72
80
 
73
81
    hooks: An instance of BranchHooks.
74
82
    """
76
84
    # - RBC 20060112
77
85
    base = None
78
86
 
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
87
    def __init__(self, *ignored, **ignored_too):
88
88
        self.tags = self._format.make_tags(self)
89
89
        self._revision_history_cache = None
90
90
        self._revision_id_to_revno_cache = None
91
91
        self._partial_revision_id_to_revno_cache = {}
92
 
        self._partial_revision_history_cache = []
93
92
        self._last_revision_info_cache = None
94
93
        self._merge_sorted_revisions_cache = None
95
94
        self._open_hook()
102
101
 
103
102
    def _activate_fallback_location(self, url):
104
103
        """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)
 
104
        self.repository.add_fallback_repository(
 
105
            self._get_fallback_repository(url))
109
106
 
110
107
    def break_lock(self):
111
108
        """Break a lock if one is present from another instance.
126
123
            raise errors.UnstackableRepositoryFormat(self.repository._format,
127
124
                self.repository.base)
128
125
 
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
126
    @staticmethod
159
127
    def open(base, _unsupported=False, possible_transports=None):
160
128
        """Open the branch rooted at base.
164
132
        """
165
133
        control = bzrdir.BzrDir.open(base, _unsupported,
166
134
                                     possible_transports=possible_transports)
167
 
        return control.open_branch(unsupported=_unsupported)
 
135
        return control.open_branch(_unsupported)
168
136
 
169
137
    @staticmethod
170
 
    def open_from_transport(transport, name=None, _unsupported=False):
 
138
    def open_from_transport(transport, _unsupported=False):
171
139
        """Open the branch rooted at transport"""
172
140
        control = bzrdir.BzrDir.open_from_transport(transport, _unsupported)
173
 
        return control.open_branch(name=name, unsupported=_unsupported)
 
141
        return control.open_branch(_unsupported)
174
142
 
175
143
    @staticmethod
176
144
    def open_containing(url, possible_transports=None):
214
182
    def _get_fallback_repository(self, url):
215
183
        """Get the repository we fallback to at url."""
216
184
        url = urlutils.join(self.base, url)
217
 
        a_branch = Branch.open(url,
 
185
        a_bzrdir = bzrdir.BzrDir.open(url,
218
186
            possible_transports=[self.bzrdir.root_transport])
219
 
        return a_branch.repository
 
187
        return a_bzrdir.open_branch().repository
220
188
 
221
189
    def _get_tags_bytes(self):
222
190
        """Get the bytes of a serialised tags dict.
417
385
            * 'include' - the stop revision is the last item in the result
418
386
            * 'with-merges' - include the stop revision and all of its
419
387
              merged revisions in the result
420
 
            * 'with-merges-without-common-ancestry' - filter out revisions 
421
 
              that are in both ancestries
422
388
        :param direction: either 'reverse' or 'forward':
423
389
            * reverse means return the start_revision_id first, i.e.
424
390
              start at the most recent revision and go backwards in history
446
412
        # start_revision_id.
447
413
        if self._merge_sorted_revisions_cache is None:
448
414
            last_revision = self.last_revision()
449
 
            known_graph = self.repository.get_known_graph_ancestry(
450
 
                [last_revision])
451
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
452
 
                last_revision)
 
415
            graph = self.repository.get_graph()
 
416
            parent_map = dict(((key, value) for key, value in
 
417
                     graph.iter_ancestry([last_revision]) if value is not None))
 
418
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
419
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
420
                generate_revno=True)
 
421
            # Drop the sequence # before caching
 
422
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
423
 
453
424
        filtered = self._filter_merge_sorted_revisions(
454
425
            self._merge_sorted_revisions_cache, start_revision_id,
455
426
            stop_revision_id, stop_rule)
456
 
        # Make sure we don't return revisions that are not part of the
457
 
        # start_revision_id ancestry.
458
 
        filtered = self._filter_start_non_ancestors(filtered)
459
427
        if direction == 'reverse':
460
428
            return filtered
461
429
        if direction == 'forward':
468
436
        """Iterate over an inclusive range of sorted revisions."""
469
437
        rev_iter = iter(merge_sorted_revisions)
470
438
        if start_revision_id is not None:
471
 
            for node in rev_iter:
472
 
                rev_id = node.key[-1]
 
439
            for rev_id, depth, revno, end_of_merge in rev_iter:
473
440
                if rev_id != start_revision_id:
474
441
                    continue
475
442
                else:
476
443
                    # The decision to include the start or not
477
444
                    # depends on the stop_rule if a stop is provided
478
 
                    # so pop this node back into the iterator
479
 
                    rev_iter = chain(iter([node]), rev_iter)
 
445
                    rev_iter = chain(
 
446
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
447
                        rev_iter)
480
448
                    break
481
449
        if stop_revision_id is None:
482
 
            # Yield everything
483
 
            for node in rev_iter:
484
 
                rev_id = node.key[-1]
485
 
                yield (rev_id, node.merge_depth, node.revno,
486
 
                       node.end_of_merge)
 
450
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
451
                yield rev_id, depth, revno, end_of_merge
487
452
        elif stop_rule == 'exclude':
488
 
            for node in rev_iter:
489
 
                rev_id = node.key[-1]
 
453
            for rev_id, depth, revno, end_of_merge in rev_iter:
490
454
                if rev_id == stop_revision_id:
491
455
                    return
492
 
                yield (rev_id, node.merge_depth, node.revno,
493
 
                       node.end_of_merge)
 
456
                yield rev_id, depth, revno, end_of_merge
494
457
        elif stop_rule == 'include':
495
 
            for node in rev_iter:
496
 
                rev_id = node.key[-1]
497
 
                yield (rev_id, node.merge_depth, node.revno,
498
 
                       node.end_of_merge)
 
458
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
459
                yield rev_id, depth, revno, end_of_merge
499
460
                if rev_id == stop_revision_id:
500
461
                    return
501
 
        elif stop_rule == 'with-merges-without-common-ancestry':
502
 
            # We want to exclude all revisions that are already part of the
503
 
            # stop_revision_id ancestry.
504
 
            graph = self.repository.get_graph()
505
 
            ancestors = graph.find_unique_ancestors(start_revision_id,
506
 
                                                    [stop_revision_id])
507
 
            for node in rev_iter:
508
 
                rev_id = node.key[-1]
509
 
                if rev_id not in ancestors:
510
 
                    continue
511
 
                yield (rev_id, node.merge_depth, node.revno,
512
 
                       node.end_of_merge)
513
462
        elif stop_rule == 'with-merges':
514
463
            stop_rev = self.repository.get_revision(stop_revision_id)
515
464
            if stop_rev.parent_ids:
516
465
                left_parent = stop_rev.parent_ids[0]
517
466
            else:
518
467
                left_parent = _mod_revision.NULL_REVISION
519
 
            # left_parent is the actual revision we want to stop logging at,
520
 
            # since we want to show the merged revisions after the stop_rev too
521
 
            reached_stop_revision_id = False
522
 
            revision_id_whitelist = []
523
 
            for node in rev_iter:
524
 
                rev_id = node.key[-1]
 
468
            for rev_id, depth, revno, end_of_merge in rev_iter:
525
469
                if rev_id == left_parent:
526
 
                    # reached the left parent after the stop_revision
527
470
                    return
528
 
                if (not reached_stop_revision_id or
529
 
                        rev_id in revision_id_whitelist):
530
 
                    yield (rev_id, node.merge_depth, node.revno,
531
 
                       node.end_of_merge)
532
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
533
 
                        # only do the merged revs of rev_id from now on
534
 
                        rev = self.repository.get_revision(rev_id)
535
 
                        if rev.parent_ids:
536
 
                            reached_stop_revision_id = True
537
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
471
                yield rev_id, depth, revno, end_of_merge
538
472
        else:
539
473
            raise ValueError('invalid stop_rule %r' % stop_rule)
540
474
 
541
 
    def _filter_start_non_ancestors(self, rev_iter):
542
 
        # If we started from a dotted revno, we want to consider it as a tip
543
 
        # and don't want to yield revisions that are not part of its
544
 
        # ancestry. Given the order guaranteed by the merge sort, we will see
545
 
        # uninteresting descendants of the first parent of our tip before the
546
 
        # tip itself.
547
 
        first = rev_iter.next()
548
 
        (rev_id, merge_depth, revno, end_of_merge) = first
549
 
        yield first
550
 
        if not merge_depth:
551
 
            # We start at a mainline revision so by definition, all others
552
 
            # revisions in rev_iter are ancestors
553
 
            for node in rev_iter:
554
 
                yield node
555
 
 
556
 
        clean = False
557
 
        whitelist = set()
558
 
        pmap = self.repository.get_parent_map([rev_id])
559
 
        parents = pmap.get(rev_id, [])
560
 
        if parents:
561
 
            whitelist.update(parents)
562
 
        else:
563
 
            # If there is no parents, there is nothing of interest left
564
 
 
565
 
            # FIXME: It's hard to test this scenario here as this code is never
566
 
            # called in that case. -- vila 20100322
567
 
            return
568
 
 
569
 
        for (rev_id, merge_depth, revno, end_of_merge) in rev_iter:
570
 
            if not clean:
571
 
                if rev_id in whitelist:
572
 
                    pmap = self.repository.get_parent_map([rev_id])
573
 
                    parents = pmap.get(rev_id, [])
574
 
                    whitelist.remove(rev_id)
575
 
                    whitelist.update(parents)
576
 
                    if merge_depth == 0:
577
 
                        # We've reached the mainline, there is nothing left to
578
 
                        # filter
579
 
                        clean = True
580
 
                else:
581
 
                    # A revision that is not part of the ancestry of our
582
 
                    # starting revision.
583
 
                    continue
584
 
            yield (rev_id, merge_depth, revno, end_of_merge)
585
 
 
586
475
    def leave_lock_in_place(self):
587
476
        """Tell this branch object not to release the physical lock when this
588
477
        object is unlocked.
605
494
        :param other: The branch to bind to
606
495
        :type other: Branch
607
496
        """
608
 
        raise errors.UpgradeRequired(self.user_url)
609
 
 
610
 
    def set_append_revisions_only(self, enabled):
611
 
        if not self._format.supports_set_append_revisions_only():
612
 
            raise errors.UpgradeRequired(self.user_url)
613
 
        if enabled:
614
 
            value = 'True'
615
 
        else:
616
 
            value = 'False'
617
 
        self.get_config().set_user_option('append_revisions_only', value,
618
 
            warn_masked=True)
619
 
 
620
 
    def set_reference_info(self, file_id, tree_path, branch_location):
621
 
        """Set the branch location to use for a tree reference."""
622
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
623
 
 
624
 
    def get_reference_info(self, file_id):
625
 
        """Get the tree_path and branch_location for a tree reference."""
626
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
 
497
        raise errors.UpgradeRequired(self.base)
627
498
 
628
499
    @needs_write_lock
629
500
    def fetch(self, from_branch, last_revision=None, pb=None):
663
534
    def get_old_bound_location(self):
664
535
        """Return the URL of the branch we used to be bound to
665
536
        """
666
 
        raise errors.UpgradeRequired(self.user_url)
 
537
        raise errors.UpgradeRequired(self.base)
667
538
 
668
539
    def get_commit_builder(self, parents, config=None, timestamp=None,
669
540
                           timezone=None, committer=None, revprops=None,
719
590
    def set_revision_history(self, rev_history):
720
591
        raise NotImplementedError(self.set_revision_history)
721
592
 
722
 
    @needs_write_lock
723
 
    def set_parent(self, url):
724
 
        """See Branch.set_parent."""
725
 
        # TODO: Maybe delete old location files?
726
 
        # URLs should never be unicode, even on the local fs,
727
 
        # FIXUP this and get_parent in a future branch format bump:
728
 
        # read and rewrite the file. RBC 20060125
729
 
        if url is not None:
730
 
            if isinstance(url, unicode):
731
 
                try:
732
 
                    url = url.encode('ascii')
733
 
                except UnicodeEncodeError:
734
 
                    raise errors.InvalidURL(url,
735
 
                        "Urls must be 7-bit ascii, "
736
 
                        "use bzrlib.urlutils.escape")
737
 
            url = urlutils.relative_url(self.base, url)
738
 
        self._set_parent_location(url)
739
 
 
740
 
    @needs_write_lock
741
593
    def set_stacked_on_url(self, url):
742
594
        """Set the URL this branch is stacked against.
743
595
 
747
599
            stacking.
748
600
        """
749
601
        if not self._format.supports_stacking():
750
 
            raise errors.UnstackableBranchFormat(self._format, self.user_url)
751
 
        # XXX: Changing from one fallback repository to another does not check
752
 
        # that all the data you need is present in the new fallback.
753
 
        # Possibly it should.
 
602
            raise errors.UnstackableBranchFormat(self._format, self.base)
754
603
        self._check_stackable_repo()
755
604
        if not url:
756
605
            try:
758
607
            except (errors.NotStacked, errors.UnstackableBranchFormat,
759
608
                errors.UnstackableRepositoryFormat):
760
609
                return
761
 
            self._unstack()
 
610
            url = ''
 
611
            # repositories don't offer an interface to remove fallback
 
612
            # repositories today; take the conceptually simpler option and just
 
613
            # reopen it.
 
614
            self.repository = self.bzrdir.find_repository()
 
615
            # for every revision reference the branch has, ensure it is pulled
 
616
            # in.
 
617
            source_repository = self._get_fallback_repository(old_url)
 
618
            for revision_id in chain([self.last_revision()],
 
619
                self.tags.get_reverse_tag_dict()):
 
620
                self.repository.fetch(source_repository, revision_id,
 
621
                    find_ghosts=True)
762
622
        else:
763
623
            self._activate_fallback_location(url)
764
624
        # write this out after the repository is stacked to avoid setting a
765
625
        # stacked config that doesn't work.
766
626
        self._set_config_location('stacked_on_location', url)
767
627
 
768
 
    def _unstack(self):
769
 
        """Change a branch to be unstacked, copying data as needed.
770
 
        
771
 
        Don't call this directly, use set_stacked_on_url(None).
772
 
        """
773
 
        pb = ui.ui_factory.nested_progress_bar()
774
 
        try:
775
 
            pb.update("Unstacking")
776
 
            # The basic approach here is to fetch the tip of the branch,
777
 
            # including all available ghosts, from the existing stacked
778
 
            # repository into a new repository object without the fallbacks. 
779
 
            #
780
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
781
 
            # correct for CHKMap repostiories
782
 
            old_repository = self.repository
783
 
            if len(old_repository._fallback_repositories) != 1:
784
 
                raise AssertionError("can't cope with fallback repositories "
785
 
                    "of %r" % (self.repository,))
786
 
            # unlock it, including unlocking the fallback
787
 
            old_repository.unlock()
788
 
            old_repository.lock_read()
789
 
            try:
790
 
                # Repositories don't offer an interface to remove fallback
791
 
                # repositories today; take the conceptually simpler option and just
792
 
                # reopen it.  We reopen it starting from the URL so that we
793
 
                # get a separate connection for RemoteRepositories and can
794
 
                # stream from one of them to the other.  This does mean doing
795
 
                # separate SSH connection setup, but unstacking is not a
796
 
                # common operation so it's tolerable.
797
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
798
 
                new_repository = new_bzrdir.find_repository()
799
 
                self.repository = new_repository
800
 
                if self.repository._fallback_repositories:
801
 
                    raise AssertionError("didn't expect %r to have "
802
 
                        "fallback_repositories"
803
 
                        % (self.repository,))
804
 
                # this is not paired with an unlock because it's just restoring
805
 
                # the previous state; the lock's released when set_stacked_on_url
806
 
                # returns
807
 
                self.repository.lock_write()
808
 
                # XXX: If you unstack a branch while it has a working tree
809
 
                # with a pending merge, the pending-merged revisions will no
810
 
                # longer be present.  You can (probably) revert and remerge.
811
 
                #
812
 
                # XXX: This only fetches up to the tip of the repository; it
813
 
                # doesn't bring across any tags.  That's fairly consistent
814
 
                # with how branch works, but perhaps not ideal.
815
 
                self.repository.fetch(old_repository,
816
 
                    revision_id=self.last_revision(),
817
 
                    find_ghosts=True)
818
 
            finally:
819
 
                old_repository.unlock()
820
 
        finally:
821
 
            pb.finished()
822
628
 
823
629
    def _set_tags_bytes(self, bytes):
824
630
        """Mirror method for _get_tags_bytes.
860
666
        self._revision_id_to_revno_cache = None
861
667
        self._last_revision_info_cache = None
862
668
        self._merge_sorted_revisions_cache = None
863
 
        self._partial_revision_history_cache = []
864
 
        self._partial_revision_id_to_revno_cache = {}
865
669
 
866
670
    def _gen_revision_history(self):
867
671
        """Return sequence of revision hashes on to this branch.
904
708
 
905
709
    def unbind(self):
906
710
        """Older format branches cannot bind or unbind."""
907
 
        raise errors.UpgradeRequired(self.user_url)
 
711
        raise errors.UpgradeRequired(self.base)
 
712
 
 
713
    def set_append_revisions_only(self, enabled):
 
714
        """Older format branches are never restricted to append-only"""
 
715
        raise errors.UpgradeRequired(self.base)
908
716
 
909
717
    def last_revision(self):
910
718
        """Return last revision id, or NULL_REVISION."""
991
799
        except ValueError:
992
800
            raise errors.NoSuchRevision(self, revision_id)
993
801
 
994
 
    @needs_read_lock
995
802
    def get_rev_id(self, revno, history=None):
996
803
        """Find the revision id of the specified revno."""
997
804
        if revno == 0:
998
805
            return _mod_revision.NULL_REVISION
999
 
        last_revno, last_revid = self.last_revision_info()
1000
 
        if revno == last_revno:
1001
 
            return last_revid
1002
 
        if revno <= 0 or revno > last_revno:
 
806
        if history is None:
 
807
            history = self.revision_history()
 
808
        if revno <= 0 or revno > len(history):
1003
809
            raise errors.NoSuchRevision(self, revno)
1004
 
        distance_from_last = last_revno - revno
1005
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
1006
 
            self._extend_partial_history(distance_from_last)
1007
 
        return self._partial_revision_history_cache[distance_from_last]
 
810
        return history[revno - 1]
1008
811
 
1009
 
    @needs_write_lock
1010
812
    def pull(self, source, overwrite=False, stop_revision=None,
1011
 
             possible_transports=None, *args, **kwargs):
 
813
             possible_transports=None, _override_hook_target=None):
1012
814
        """Mirror source into this branch.
1013
815
 
1014
816
        This branch is considered to be 'local', having low latency.
1015
817
 
1016
818
        :returns: PullResult instance
1017
819
        """
1018
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
1019
 
            stop_revision=stop_revision,
1020
 
            possible_transports=possible_transports, *args, **kwargs)
 
820
        raise NotImplementedError(self.pull)
1021
821
 
1022
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
1023
 
        **kwargs):
 
822
    def push(self, target, overwrite=False, stop_revision=None):
1024
823
        """Mirror this branch into target.
1025
824
 
1026
825
        This branch is considered to be 'local', having low latency.
1027
826
        """
1028
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
1029
 
            *args, **kwargs)
1030
 
 
1031
 
    def lossy_push(self, target, stop_revision=None):
1032
 
        """Push deltas into another branch.
1033
 
 
1034
 
        :note: This does not, like push, retain the revision ids from 
1035
 
            the source branch and will, rather than adding bzr-specific 
1036
 
            metadata, push only those semantics of the revision that can be 
1037
 
            natively represented by this branch' VCS.
1038
 
 
1039
 
        :param target: Target branch
1040
 
        :param stop_revision: Revision to push, defaults to last revision.
1041
 
        :return: BranchPushResult with an extra member revidmap: 
1042
 
            A dictionary mapping revision ids from the target branch 
1043
 
            to new revision ids in the target branch, for each 
1044
 
            revision that was pushed.
1045
 
        """
1046
 
        inter = InterBranch.get(self, target)
1047
 
        lossy_push = getattr(inter, "lossy_push", None)
1048
 
        if lossy_push is None:
1049
 
            raise errors.LossyPushToSameVCS(self, target)
1050
 
        return lossy_push(stop_revision)
 
827
        raise NotImplementedError(self.push)
1051
828
 
1052
829
    def basis_tree(self):
1053
830
        """Return `Tree` object for last revision."""
1070
847
        try:
1071
848
            return urlutils.join(self.base[:-1], parent)
1072
849
        except errors.InvalidURLJoin, e:
1073
 
            raise errors.InaccessibleParent(parent, self.user_url)
 
850
            raise errors.InaccessibleParent(parent, self.base)
1074
851
 
1075
852
    def _get_parent_location(self):
1076
853
        raise NotImplementedError(self._get_parent_location)
1093
870
            location = None
1094
871
        return location
1095
872
 
1096
 
    def get_child_submit_format(self):
1097
 
        """Return the preferred format of submissions to this branch."""
1098
 
        return self.get_config().get_user_option("child_submit_format")
1099
 
 
1100
873
    def get_submit_branch(self):
1101
874
        """Return the submit location of the branch.
1102
875
 
1161
934
        params = ChangeBranchTipParams(
1162
935
            self, old_revno, new_revno, old_revid, new_revid)
1163
936
        for hook in hooks:
1164
 
            hook(params)
 
937
            try:
 
938
                hook(params)
 
939
            except errors.TipChangeRejected:
 
940
                raise
 
941
            except Exception:
 
942
                exc_info = sys.exc_info()
 
943
                hook_name = Branch.hooks.get_hook_name(hook)
 
944
                raise errors.HookFailed(
 
945
                    'pre_change_branch_tip', hook_name, exc_info)
 
946
 
 
947
    def set_parent(self, url):
 
948
        raise NotImplementedError(self.set_parent)
1165
949
 
1166
950
    @needs_write_lock
1167
951
    def update(self):
1198
982
                     be truncated to end with revision_id.
1199
983
        """
1200
984
        result = to_bzrdir.create_branch()
1201
 
        result.lock_write()
1202
 
        try:
1203
 
            if repository_policy is not None:
1204
 
                repository_policy.configure_branch(result)
1205
 
            self.copy_content_into(result, revision_id=revision_id)
1206
 
        finally:
1207
 
            result.unlock()
1208
 
        return result
 
985
        if repository_policy is not None:
 
986
            repository_policy.configure_branch(result)
 
987
        self.copy_content_into(result, revision_id=revision_id)
 
988
        return  result
1209
989
 
1210
990
    @needs_read_lock
1211
991
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1216
996
        revision_id: if not None, the revision history in the new branch will
1217
997
                     be truncated to end with revision_id.
1218
998
        """
1219
 
        if (repository_policy is not None and
1220
 
            repository_policy.requires_stacking()):
1221
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1222
999
        result = to_bzrdir.create_branch()
1223
 
        result.lock_write()
1224
 
        try:
1225
 
            if repository_policy is not None:
1226
 
                repository_policy.configure_branch(result)
1227
 
            self.copy_content_into(result, revision_id=revision_id)
1228
 
            result.set_parent(self.bzrdir.root_transport.base)
1229
 
        finally:
1230
 
            result.unlock()
 
1000
        if repository_policy is not None:
 
1001
            repository_policy.configure_branch(result)
 
1002
        self.copy_content_into(result, revision_id=revision_id)
 
1003
        result.set_parent(self.bzrdir.root_transport.base)
1231
1004
        return result
1232
1005
 
1233
1006
    def _synchronize_history(self, destination, revision_id):
1245
1018
        source_revno, source_revision_id = self.last_revision_info()
1246
1019
        if revision_id is None:
1247
1020
            revno, revision_id = source_revno, source_revision_id
 
1021
        elif source_revision_id == revision_id:
 
1022
            # we know the revno without needing to walk all of history
 
1023
            revno = source_revno
1248
1024
        else:
1249
 
            graph = self.repository.get_graph()
1250
 
            try:
1251
 
                revno = graph.find_distance_to_null(revision_id, 
1252
 
                    [(source_revision_id, source_revno)])
1253
 
            except errors.GhostRevisionsHaveNoRevno:
1254
 
                # Default to 1, if we can't find anything else
1255
 
                revno = 1
 
1025
            # To figure out the revno for a random revision, we need to build
 
1026
            # the revision history, and count its length.
 
1027
            # We don't care about the order, just how long it is.
 
1028
            # Alternatively, we could start at the current location, and count
 
1029
            # backwards. But there is no guarantee that we will find it since
 
1030
            # it may be a merged revision.
 
1031
            revno = len(list(self.repository.iter_reverse_revision_history(
 
1032
                                                                revision_id)))
1256
1033
        destination.set_last_revision_info(revno, revision_id)
1257
1034
 
1258
1035
    @needs_read_lock
1262
1039
        revision_id: if not None, the revision history in the new branch will
1263
1040
                     be truncated to end with revision_id.
1264
1041
        """
1265
 
        self.update_references(destination)
1266
1042
        self._synchronize_history(destination, revision_id)
1267
1043
        try:
1268
1044
            parent = self.get_parent()
1274
1050
        if self._push_should_merge_tags():
1275
1051
            self.tags.merge_to(destination.tags)
1276
1052
 
1277
 
    def update_references(self, target):
1278
 
        if not getattr(self._format, 'supports_reference_locations', False):
1279
 
            return
1280
 
        reference_dict = self._get_all_reference_info()
1281
 
        if len(reference_dict) == 0:
1282
 
            return
1283
 
        old_base = self.base
1284
 
        new_base = target.base
1285
 
        target_reference_dict = target._get_all_reference_info()
1286
 
        for file_id, (tree_path, branch_location) in (
1287
 
            reference_dict.items()):
1288
 
            branch_location = urlutils.rebase_url(branch_location,
1289
 
                                                  old_base, new_base)
1290
 
            target_reference_dict.setdefault(
1291
 
                file_id, (tree_path, branch_location))
1292
 
        target._set_all_reference_info(target_reference_dict)
1293
 
 
1294
1053
    @needs_read_lock
1295
 
    def check(self, refs):
 
1054
    def check(self):
1296
1055
        """Check consistency of the branch.
1297
1056
 
1298
1057
        In particular this checks that revisions given in the revision-history
1301
1060
 
1302
1061
        Callers will typically also want to check the repository.
1303
1062
 
1304
 
        :param refs: Calculated refs for this branch as specified by
1305
 
            branch._get_check_refs()
1306
1063
        :return: A BranchCheckResult.
1307
1064
        """
1308
 
        result = BranchCheckResult(self)
 
1065
        mainline_parent_id = None
1309
1066
        last_revno, last_revision_id = self.last_revision_info()
1310
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1311
 
        if actual_revno != last_revno:
1312
 
            result.errors.append(errors.BzrCheckError(
1313
 
                'revno does not match len(mainline) %s != %s' % (
1314
 
                last_revno, actual_revno)))
1315
 
        # TODO: We should probably also check that self.revision_history
1316
 
        # matches the repository for older branch formats.
1317
 
        # If looking for the code that cross-checks repository parents against
1318
 
        # the iter_reverse_revision_history output, that is now a repository
1319
 
        # specific check.
1320
 
        return result
 
1067
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
1068
                                last_revision_id))
 
1069
        real_rev_history.reverse()
 
1070
        if len(real_rev_history) != last_revno:
 
1071
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1072
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1073
        # TODO: We should probably also check that real_rev_history actually
 
1074
        #       matches self.revision_history()
 
1075
        for revision_id in real_rev_history:
 
1076
            try:
 
1077
                revision = self.repository.get_revision(revision_id)
 
1078
            except errors.NoSuchRevision, e:
 
1079
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1080
                            % revision_id)
 
1081
            # In general the first entry on the revision history has no parents.
 
1082
            # But it's not illegal for it to have parents listed; this can happen
 
1083
            # in imports from Arch when the parents weren't reachable.
 
1084
            if mainline_parent_id is not None:
 
1085
                if mainline_parent_id not in revision.parent_ids:
 
1086
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1087
                                        "parents of {%s}"
 
1088
                                        % (mainline_parent_id, revision_id))
 
1089
            mainline_parent_id = revision_id
 
1090
        return BranchCheckResult(self)
1321
1091
 
1322
1092
    def _get_checkout_format(self):
1323
1093
        """Return the most suitable metadir for a checkout of this branch.
1333
1103
        return format
1334
1104
 
1335
1105
    def create_clone_on_transport(self, to_transport, revision_id=None,
1336
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1106
        stacked_on=None):
1337
1107
        """Create a clone of this branch and its bzrdir.
1338
1108
 
1339
1109
        :param to_transport: The transport to clone onto.
1340
1110
        :param revision_id: The revision id to use as tip in the new branch.
1341
1111
            If None the tip is obtained from this branch.
1342
1112
        :param stacked_on: An optional URL to stack the clone on.
1343
 
        :param create_prefix: Create any missing directories leading up to
1344
 
            to_transport.
1345
 
        :param use_existing_dir: Use an existing directory if one exists.
1346
1113
        """
1347
1114
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1348
1115
        # clone call. Or something. 20090224 RBC/spiv.
1349
 
        if revision_id is None:
1350
 
            revision_id = self.last_revision()
1351
1116
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1352
 
            revision_id=revision_id, stacked_on=stacked_on,
1353
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1117
            revision_id=revision_id, stacked_on=stacked_on)
1354
1118
        return dir_to.open_branch()
1355
1119
 
1356
1120
    def create_checkout(self, to_location, revision_id=None,
1375
1139
        if lightweight:
1376
1140
            format = self._get_checkout_format()
1377
1141
            checkout = format.initialize_on_transport(t)
1378
 
            from_branch = BranchReferenceFormat().initialize(checkout, 
1379
 
                target_branch=self)
 
1142
            from_branch = BranchReferenceFormat().initialize(checkout, self)
1380
1143
        else:
1381
1144
            format = self._get_checkout_format()
1382
1145
            checkout_branch = bzrdir.BzrDir.create_branch_convenience(
1411
1174
        reconciler.reconcile()
1412
1175
        return reconciler
1413
1176
 
1414
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1177
    def reference_parent(self, file_id, path):
1415
1178
        """Return the parent branch for a tree-reference file_id
1416
1179
        :param file_id: The file_id of the tree reference
1417
1180
        :param path: The path of the file_id in the tree
1418
1181
        :return: A branch associated with the file_id
1419
1182
        """
1420
1183
        # FIXME should provide multiple branches, based on config
1421
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1422
 
                           possible_transports=possible_transports)
 
1184
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1423
1185
 
1424
1186
    def supports_tags(self):
1425
1187
        return self._format.supports_tags()
1426
1188
 
1427
 
    def automatic_tag_name(self, revision_id):
1428
 
        """Try to automatically find the tag name for a revision.
1429
 
 
1430
 
        :param revision_id: Revision id of the revision.
1431
 
        :return: A tag name or None if no tag name could be determined.
1432
 
        """
1433
 
        for hook in Branch.hooks['automatic_tag_name']:
1434
 
            ret = hook(self, revision_id)
1435
 
            if ret is not None:
1436
 
                return ret
1437
 
        return None
1438
 
 
1439
1189
    def _check_if_descendant_or_diverged(self, revision_a, revision_b, graph,
1440
1190
                                         other_branch):
1441
1191
        """Ensure that revision_b is a descendant of revision_a.
1496
1246
    _formats = {}
1497
1247
    """The known formats."""
1498
1248
 
1499
 
    can_set_append_revisions_only = True
1500
 
 
1501
1249
    def __eq__(self, other):
1502
1250
        return self.__class__ is other.__class__
1503
1251
 
1505
1253
        return not (self == other)
1506
1254
 
1507
1255
    @classmethod
1508
 
    def find_format(klass, a_bzrdir, name=None):
 
1256
    def find_format(klass, a_bzrdir):
1509
1257
        """Return the format for the branch object in a_bzrdir."""
1510
1258
        try:
1511
 
            transport = a_bzrdir.get_branch_transport(None, name=name)
1512
 
            format_string = transport.get_bytes("format")
 
1259
            transport = a_bzrdir.get_branch_transport(None)
 
1260
            format_string = transport.get("format").read()
1513
1261
            return klass._formats[format_string]
1514
1262
        except errors.NoSuchFile:
1515
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1263
            raise errors.NotBranchError(path=transport.base)
1516
1264
        except KeyError:
1517
1265
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1518
1266
 
1554
1302
        """Return the short format description for this format."""
1555
1303
        raise NotImplementedError(self.get_format_description)
1556
1304
 
1557
 
    def _run_post_branch_init_hooks(self, a_bzrdir, name, branch):
1558
 
        hooks = Branch.hooks['post_branch_init']
1559
 
        if not hooks:
1560
 
            return
1561
 
        params = BranchInitHookParams(self, a_bzrdir, name, branch)
1562
 
        for hook in hooks:
1563
 
            hook(params)
1564
 
 
1565
 
    def _initialize_helper(self, a_bzrdir, utf8_files, name=None,
1566
 
                           lock_type='metadir', set_format=True):
 
1305
    def _initialize_helper(self, a_bzrdir, utf8_files, lock_type='metadir',
 
1306
                           set_format=True):
1567
1307
        """Initialize a branch in a bzrdir, with specified files
1568
1308
 
1569
1309
        :param a_bzrdir: The bzrdir to initialize the branch in
1570
1310
        :param utf8_files: The files to create as a list of
1571
1311
            (filename, content) tuples
1572
 
        :param name: Name of colocated branch to create, if any
1573
1312
        :param set_format: If True, set the format with
1574
1313
            self.get_format_string.  (BzrBranch4 has its format set
1575
1314
            elsewhere)
1576
1315
        :return: a branch in this format
1577
1316
        """
1578
 
        mutter('creating branch %r in %s', self, a_bzrdir.user_url)
1579
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1317
        mutter('creating branch %r in %s', self, a_bzrdir.transport.base)
 
1318
        branch_transport = a_bzrdir.get_branch_transport(self)
1580
1319
        lock_map = {
1581
1320
            'metadir': ('lock', lockdir.LockDir),
1582
1321
            'branch4': ('branch-lock', lockable_files.TransportLock),
1585
1324
        control_files = lockable_files.LockableFiles(branch_transport,
1586
1325
            lock_name, lock_class)
1587
1326
        control_files.create_lock()
1588
 
        try:
1589
 
            control_files.lock_write()
1590
 
        except errors.LockContention:
1591
 
            if lock_type != 'branch4':
1592
 
                raise
1593
 
            lock_taken = False
1594
 
        else:
1595
 
            lock_taken = True
 
1327
        control_files.lock_write()
1596
1328
        if set_format:
1597
1329
            utf8_files += [('format', self.get_format_string())]
1598
1330
        try:
1601
1333
                    filename, content,
1602
1334
                    mode=a_bzrdir._get_file_mode())
1603
1335
        finally:
1604
 
            if lock_taken:
1605
 
                control_files.unlock()
1606
 
        branch = self.open(a_bzrdir, name, _found=True)
1607
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
1608
 
        return branch
 
1336
            control_files.unlock()
 
1337
        return self.open(a_bzrdir, _found=True)
1609
1338
 
1610
 
    def initialize(self, a_bzrdir, name=None):
1611
 
        """Create a branch of this format in a_bzrdir.
1612
 
        
1613
 
        :param name: Name of the colocated branch to create.
1614
 
        """
 
1339
    def initialize(self, a_bzrdir):
 
1340
        """Create a branch of this format in a_bzrdir."""
1615
1341
        raise NotImplementedError(self.initialize)
1616
1342
 
1617
1343
    def is_supported(self):
1647
1373
        """
1648
1374
        raise NotImplementedError(self.network_name)
1649
1375
 
1650
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1376
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1651
1377
        """Return the branch object for a_bzrdir
1652
1378
 
1653
1379
        :param a_bzrdir: A BzrDir that contains a branch.
1654
 
        :param name: Name of colocated branch to open
1655
1380
        :param _found: a private parameter, do not use it. It is used to
1656
1381
            indicate if format probing has already be done.
1657
1382
        :param ignore_fallbacks: when set, no fallback branches will be opened
1671
1396
    def set_default_format(klass, format):
1672
1397
        klass._default_format = format
1673
1398
 
1674
 
    def supports_set_append_revisions_only(self):
1675
 
        """True if this format supports set_append_revisions_only."""
1676
 
        return False
1677
 
 
1678
1399
    def supports_stacking(self):
1679
1400
        """True if this format records a stacked-on branch."""
1680
1401
        return False
1765
1486
            "multiple hooks installed for transform_fallback_location, "
1766
1487
            "all are called with the url returned from the previous hook."
1767
1488
            "The order is however undefined.", (1, 9), None))
1768
 
        self.create_hook(HookPoint('automatic_tag_name',
1769
 
            "Called to determine an automatic tag name for a revision."
1770
 
            "automatic_tag_name is called with (branch, revision_id) and "
1771
 
            "should return a tag name or None if no tag name could be "
1772
 
            "determined. The first non-None tag name returned will be used.",
1773
 
            (2, 2), None))
1774
 
        self.create_hook(HookPoint('post_branch_init',
1775
 
            "Called after new branch initialization completes. "
1776
 
            "post_branch_init is called with a "
1777
 
            "bzrlib.branch.BranchInitHookParams. "
1778
 
            "Note that init, branch and checkout (both heavyweight and "
1779
 
            "lightweight) will all trigger this hook.", (2, 2), None))
1780
 
        self.create_hook(HookPoint('post_switch',
1781
 
            "Called after a checkout switches branch. "
1782
 
            "post_switch is called with a "
1783
 
            "bzrlib.branch.SwitchHookParams.", (2, 2), None))
1784
 
 
1785
1489
 
1786
1490
 
1787
1491
# install the default hooks into the Branch class.
1826
1530
            self.old_revno, self.old_revid, self.new_revno, self.new_revid)
1827
1531
 
1828
1532
 
1829
 
class BranchInitHookParams(object):
1830
 
    """Object holding parameters passed to *_branch_init hooks.
1831
 
 
1832
 
    There are 4 fields that hooks may wish to access:
1833
 
 
1834
 
    :ivar format: the branch format
1835
 
    :ivar bzrdir: the BzrDir where the branch will be/has been initialized
1836
 
    :ivar name: name of colocated branch, if any (or None)
1837
 
    :ivar branch: the branch created
1838
 
 
1839
 
    Note that for lightweight checkouts, the bzrdir and format fields refer to
1840
 
    the checkout, hence they are different from the corresponding fields in
1841
 
    branch, which refer to the original branch.
1842
 
    """
1843
 
 
1844
 
    def __init__(self, format, a_bzrdir, name, branch):
1845
 
        """Create a group of BranchInitHook parameters.
1846
 
 
1847
 
        :param format: the branch format
1848
 
        :param a_bzrdir: the BzrDir where the branch will be/has been
1849
 
            initialized
1850
 
        :param name: name of colocated branch, if any (or None)
1851
 
        :param branch: the branch created
1852
 
 
1853
 
        Note that for lightweight checkouts, the bzrdir and format fields refer
1854
 
        to the checkout, hence they are different from the corresponding fields
1855
 
        in branch, which refer to the original branch.
1856
 
        """
1857
 
        self.format = format
1858
 
        self.bzrdir = a_bzrdir
1859
 
        self.name = name
1860
 
        self.branch = branch
1861
 
 
1862
 
    def __eq__(self, other):
1863
 
        return self.__dict__ == other.__dict__
1864
 
 
1865
 
    def __repr__(self):
1866
 
        if self.branch:
1867
 
            return "<%s of %s>" % (self.__class__.__name__, self.branch)
1868
 
        else:
1869
 
            return "<%s of format:%s bzrdir:%s>" % (
1870
 
                self.__class__.__name__, self.branch,
1871
 
                self.format, self.bzrdir)
1872
 
 
1873
 
 
1874
 
class SwitchHookParams(object):
1875
 
    """Object holding parameters passed to *_switch hooks.
1876
 
 
1877
 
    There are 4 fields that hooks may wish to access:
1878
 
 
1879
 
    :ivar control_dir: BzrDir of the checkout to change
1880
 
    :ivar to_branch: branch that the checkout is to reference
1881
 
    :ivar force: skip the check for local commits in a heavy checkout
1882
 
    :ivar revision_id: revision ID to switch to (or None)
1883
 
    """
1884
 
 
1885
 
    def __init__(self, control_dir, to_branch, force, revision_id):
1886
 
        """Create a group of SwitchHook parameters.
1887
 
 
1888
 
        :param control_dir: BzrDir of the checkout to change
1889
 
        :param to_branch: branch that the checkout is to reference
1890
 
        :param force: skip the check for local commits in a heavy checkout
1891
 
        :param revision_id: revision ID to switch to (or None)
1892
 
        """
1893
 
        self.control_dir = control_dir
1894
 
        self.to_branch = to_branch
1895
 
        self.force = force
1896
 
        self.revision_id = revision_id
1897
 
 
1898
 
    def __eq__(self, other):
1899
 
        return self.__dict__ == other.__dict__
1900
 
 
1901
 
    def __repr__(self):
1902
 
        return "<%s for %s to (%s, %s)>" % (self.__class__.__name__,
1903
 
            self.control_dir, self.to_branch,
1904
 
            self.revision_id)
1905
 
 
1906
 
 
1907
1533
class BzrBranchFormat4(BranchFormat):
1908
1534
    """Bzr branch format 4.
1909
1535
 
1916
1542
        """See BranchFormat.get_format_description()."""
1917
1543
        return "Branch format 4"
1918
1544
 
1919
 
    def initialize(self, a_bzrdir, name=None):
 
1545
    def initialize(self, a_bzrdir):
1920
1546
        """Create a branch of this format in a_bzrdir."""
1921
1547
        utf8_files = [('revision-history', ''),
1922
1548
                      ('branch-name', ''),
1923
1549
                      ]
1924
 
        return self._initialize_helper(a_bzrdir, utf8_files, name=name,
 
1550
        return self._initialize_helper(a_bzrdir, utf8_files,
1925
1551
                                       lock_type='branch4', set_format=False)
1926
1552
 
1927
1553
    def __init__(self):
1932
1558
        """The network name for this format is the control dirs disk label."""
1933
1559
        return self._matchingbzrdir.get_format_string()
1934
1560
 
1935
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1561
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1936
1562
        """See BranchFormat.open()."""
1937
1563
        if not _found:
1938
1564
            # we are being called directly and must probe.
1940
1566
        return BzrBranch(_format=self,
1941
1567
                         _control_files=a_bzrdir._control_files,
1942
1568
                         a_bzrdir=a_bzrdir,
1943
 
                         name=name,
1944
1569
                         _repository=a_bzrdir.open_repository())
1945
1570
 
1946
1571
    def __str__(self):
1961
1586
        """
1962
1587
        return self.get_format_string()
1963
1588
 
1964
 
    def open(self, a_bzrdir, name=None, _found=False, ignore_fallbacks=False):
 
1589
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1965
1590
        """See BranchFormat.open()."""
1966
1591
        if not _found:
1967
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1592
            format = BranchFormat.find_format(a_bzrdir)
1968
1593
            if format.__class__ != self.__class__:
1969
1594
                raise AssertionError("wrong format %r found for %r" %
1970
1595
                    (format, self))
1971
 
        transport = a_bzrdir.get_branch_transport(None, name=name)
1972
1596
        try:
 
1597
            transport = a_bzrdir.get_branch_transport(None)
1973
1598
            control_files = lockable_files.LockableFiles(transport, 'lock',
1974
1599
                                                         lockdir.LockDir)
1975
1600
            return self._branch_class()(_format=self,
1976
1601
                              _control_files=control_files,
1977
 
                              name=name,
1978
1602
                              a_bzrdir=a_bzrdir,
1979
1603
                              _repository=a_bzrdir.find_repository(),
1980
1604
                              ignore_fallbacks=ignore_fallbacks)
1981
1605
        except errors.NoSuchFile:
1982
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1606
            raise errors.NotBranchError(path=transport.base)
1983
1607
 
1984
1608
    def __init__(self):
1985
1609
        super(BranchFormatMetadir, self).__init__()
2014
1638
        """See BranchFormat.get_format_description()."""
2015
1639
        return "Branch format 5"
2016
1640
 
2017
 
    def initialize(self, a_bzrdir, name=None):
 
1641
    def initialize(self, a_bzrdir):
2018
1642
        """Create a branch of this format in a_bzrdir."""
2019
1643
        utf8_files = [('revision-history', ''),
2020
1644
                      ('branch-name', ''),
2021
1645
                      ]
2022
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
 
1646
        return self._initialize_helper(a_bzrdir, utf8_files)
2023
1647
 
2024
1648
    def supports_tags(self):
2025
1649
        return False
2047
1671
        """See BranchFormat.get_format_description()."""
2048
1672
        return "Branch format 6"
2049
1673
 
2050
 
    def initialize(self, a_bzrdir, name=None):
2051
 
        """Create a branch of this format in a_bzrdir."""
2052
 
        utf8_files = [('last-revision', '0 null:\n'),
2053
 
                      ('branch.conf', ''),
2054
 
                      ('tags', ''),
2055
 
                      ]
2056
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2057
 
 
2058
 
    def make_tags(self, branch):
2059
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2060
 
        return BasicTags(branch)
2061
 
 
2062
 
    def supports_set_append_revisions_only(self):
2063
 
        return True
2064
 
 
2065
 
 
2066
 
class BzrBranchFormat8(BranchFormatMetadir):
2067
 
    """Metadir format supporting storing locations of subtree branches."""
2068
 
 
2069
 
    def _branch_class(self):
2070
 
        return BzrBranch8
2071
 
 
2072
 
    def get_format_string(self):
2073
 
        """See BranchFormat.get_format_string()."""
2074
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
2075
 
 
2076
 
    def get_format_description(self):
2077
 
        """See BranchFormat.get_format_description()."""
2078
 
        return "Branch format 8"
2079
 
 
2080
 
    def initialize(self, a_bzrdir, name=None):
2081
 
        """Create a branch of this format in a_bzrdir."""
2082
 
        utf8_files = [('last-revision', '0 null:\n'),
2083
 
                      ('branch.conf', ''),
2084
 
                      ('tags', ''),
2085
 
                      ('references', '')
2086
 
                      ]
2087
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2088
 
 
2089
 
    def __init__(self):
2090
 
        super(BzrBranchFormat8, self).__init__()
2091
 
        self._matchingbzrdir.repository_format = \
2092
 
            RepositoryFormatKnitPack5RichRoot()
2093
 
 
2094
 
    def make_tags(self, branch):
2095
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
2096
 
        return BasicTags(branch)
2097
 
 
2098
 
    def supports_set_append_revisions_only(self):
2099
 
        return True
2100
 
 
2101
 
    def supports_stacking(self):
2102
 
        return True
2103
 
 
2104
 
    supports_reference_locations = True
2105
 
 
2106
 
 
2107
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1674
    def initialize(self, a_bzrdir):
 
1675
        """Create a branch of this format in a_bzrdir."""
 
1676
        utf8_files = [('last-revision', '0 null:\n'),
 
1677
                      ('branch.conf', ''),
 
1678
                      ('tags', ''),
 
1679
                      ]
 
1680
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1681
 
 
1682
    def make_tags(self, branch):
 
1683
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1684
        return BasicTags(branch)
 
1685
 
 
1686
 
 
1687
 
 
1688
class BzrBranchFormat7(BranchFormatMetadir):
2108
1689
    """Branch format with last-revision, tags, and a stacked location pointer.
2109
1690
 
2110
1691
    The stacked location pointer is passed down to the repository and requires
2113
1694
    This format was introduced in bzr 1.6.
2114
1695
    """
2115
1696
 
2116
 
    def initialize(self, a_bzrdir, name=None):
2117
 
        """Create a branch of this format in a_bzrdir."""
2118
 
        utf8_files = [('last-revision', '0 null:\n'),
2119
 
                      ('branch.conf', ''),
2120
 
                      ('tags', ''),
2121
 
                      ]
2122
 
        return self._initialize_helper(a_bzrdir, utf8_files, name)
2123
 
 
2124
1697
    def _branch_class(self):
2125
1698
        return BzrBranch7
2126
1699
 
2132
1705
        """See BranchFormat.get_format_description()."""
2133
1706
        return "Branch format 7"
2134
1707
 
2135
 
    def supports_set_append_revisions_only(self):
 
1708
    def initialize(self, a_bzrdir):
 
1709
        """Create a branch of this format in a_bzrdir."""
 
1710
        utf8_files = [('last-revision', '0 null:\n'),
 
1711
                      ('branch.conf', ''),
 
1712
                      ('tags', ''),
 
1713
                      ]
 
1714
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1715
 
 
1716
    def __init__(self):
 
1717
        super(BzrBranchFormat7, self).__init__()
 
1718
        self._matchingbzrdir.repository_format = \
 
1719
            RepositoryFormatKnitPack5RichRoot()
 
1720
 
 
1721
    def make_tags(self, branch):
 
1722
        """See bzrlib.branch.BranchFormat.make_tags()."""
 
1723
        return BasicTags(branch)
 
1724
 
 
1725
    def supports_stacking(self):
2136
1726
        return True
2137
1727
 
2138
 
    supports_reference_locations = False
2139
 
 
2140
1728
 
2141
1729
class BranchReferenceFormat(BranchFormat):
2142
1730
    """Bzr branch reference format.
2160
1748
    def get_reference(self, a_bzrdir):
2161
1749
        """See BranchFormat.get_reference()."""
2162
1750
        transport = a_bzrdir.get_branch_transport(None)
2163
 
        return transport.get_bytes('location')
 
1751
        return transport.get('location').read()
2164
1752
 
2165
1753
    def set_reference(self, a_bzrdir, to_branch):
2166
1754
        """See BranchFormat.set_reference()."""
2167
1755
        transport = a_bzrdir.get_branch_transport(None)
2168
1756
        location = transport.put_bytes('location', to_branch.base)
2169
1757
 
2170
 
    def initialize(self, a_bzrdir, name=None, target_branch=None):
 
1758
    def initialize(self, a_bzrdir, target_branch=None):
2171
1759
        """Create a branch of this format in a_bzrdir."""
2172
1760
        if target_branch is None:
2173
1761
            # this format does not implement branch itself, thus the implicit
2174
1762
            # creation contract must see it as uninitializable
2175
1763
            raise errors.UninitializableFormat(self)
2176
 
        mutter('creating branch reference in %s', a_bzrdir.user_url)
2177
 
        branch_transport = a_bzrdir.get_branch_transport(self, name=name)
 
1764
        mutter('creating branch reference in %s', a_bzrdir.transport.base)
 
1765
        branch_transport = a_bzrdir.get_branch_transport(self)
2178
1766
        branch_transport.put_bytes('location',
2179
 
            target_branch.bzrdir.user_url)
 
1767
            target_branch.bzrdir.root_transport.base)
2180
1768
        branch_transport.put_bytes('format', self.get_format_string())
2181
 
        branch = self.open(
2182
 
            a_bzrdir, name, _found=True,
 
1769
        return self.open(
 
1770
            a_bzrdir, _found=True,
2183
1771
            possible_transports=[target_branch.bzrdir.root_transport])
2184
 
        self._run_post_branch_init_hooks(a_bzrdir, name, branch)
2185
 
        return branch
2186
1772
 
2187
1773
    def __init__(self):
2188
1774
        super(BranchReferenceFormat, self).__init__()
2194
1780
        def clone(to_bzrdir, revision_id=None,
2195
1781
            repository_policy=None):
2196
1782
            """See Branch.clone()."""
2197
 
            return format.initialize(to_bzrdir, target_branch=a_branch)
 
1783
            return format.initialize(to_bzrdir, a_branch)
2198
1784
            # cannot obey revision_id limits when cloning a reference ...
2199
1785
            # FIXME RBC 20060210 either nuke revision_id for clone, or
2200
1786
            # emit some sort of warning/error to the caller ?!
2201
1787
        return clone
2202
1788
 
2203
 
    def open(self, a_bzrdir, name=None, _found=False, location=None,
 
1789
    def open(self, a_bzrdir, _found=False, location=None,
2204
1790
             possible_transports=None, ignore_fallbacks=False):
2205
1791
        """Return the branch that the branch reference in a_bzrdir points at.
2206
1792
 
2207
1793
        :param a_bzrdir: A BzrDir that contains a branch.
2208
 
        :param name: Name of colocated branch to open, if any
2209
1794
        :param _found: a private parameter, do not use it. It is used to
2210
1795
            indicate if format probing has already be done.
2211
1796
        :param ignore_fallbacks: when set, no fallback branches will be opened
2216
1801
        :param possible_transports: An optional reusable transports list.
2217
1802
        """
2218
1803
        if not _found:
2219
 
            format = BranchFormat.find_format(a_bzrdir, name=name)
 
1804
            format = BranchFormat.find_format(a_bzrdir)
2220
1805
            if format.__class__ != self.__class__:
2221
1806
                raise AssertionError("wrong format %r found for %r" %
2222
1807
                    (format, self))
2224
1809
            location = self.get_reference(a_bzrdir)
2225
1810
        real_bzrdir = bzrdir.BzrDir.open(
2226
1811
            location, possible_transports=possible_transports)
2227
 
        result = real_bzrdir.open_branch(name=name, 
2228
 
            ignore_fallbacks=ignore_fallbacks)
 
1812
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
2229
1813
        # this changes the behaviour of result.clone to create a new reference
2230
1814
        # rather than a copy of the content of the branch.
2231
1815
        # I did not use a proxy object because that needs much more extensive
2252
1836
__format5 = BzrBranchFormat5()
2253
1837
__format6 = BzrBranchFormat6()
2254
1838
__format7 = BzrBranchFormat7()
2255
 
__format8 = BzrBranchFormat8()
2256
1839
BranchFormat.register_format(__format5)
2257
1840
BranchFormat.register_format(BranchReferenceFormat())
2258
1841
BranchFormat.register_format(__format6)
2259
1842
BranchFormat.register_format(__format7)
2260
 
BranchFormat.register_format(__format8)
2261
 
BranchFormat.set_default_format(__format7)
 
1843
BranchFormat.set_default_format(__format6)
2262
1844
_legacy_formats = [BzrBranchFormat4(),
2263
1845
    ]
2264
1846
network_format_registry.register(
2265
1847
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2266
1848
 
2267
1849
 
2268
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1850
class BzrBranch(Branch):
2269
1851
    """A branch stored in the actual filesystem.
2270
1852
 
2271
1853
    Note that it's "local" in the context of the filesystem; it doesn't
2277
1859
    :ivar repository: Repository for this branch.
2278
1860
    :ivar base: The url of the base directory for this branch; the one
2279
1861
        containing the .bzr directory.
2280
 
    :ivar name: Optional colocated branch name as it exists in the control
2281
 
        directory.
2282
1862
    """
2283
1863
 
2284
1864
    def __init__(self, _format=None,
2285
 
                 _control_files=None, a_bzrdir=None, name=None,
2286
 
                 _repository=None, ignore_fallbacks=False):
 
1865
                 _control_files=None, a_bzrdir=None, _repository=None,
 
1866
                 ignore_fallbacks=False):
2287
1867
        """Create new branch object at a particular location."""
2288
1868
        if a_bzrdir is None:
2289
1869
            raise ValueError('a_bzrdir must be supplied')
2290
1870
        else:
2291
1871
            self.bzrdir = a_bzrdir
2292
1872
        self._base = self.bzrdir.transport.clone('..').base
2293
 
        self.name = name
2294
1873
        # XXX: We should be able to just do
2295
1874
        #   self.base = self.bzrdir.root_transport.base
2296
1875
        # but this does not quite work yet -- mbp 20080522
2303
1882
        Branch.__init__(self)
2304
1883
 
2305
1884
    def __str__(self):
2306
 
        if self.name is None:
2307
 
            return '%s(%s)' % (self.__class__.__name__, self.user_url)
2308
 
        else:
2309
 
            return '%s(%s,%s)' % (self.__class__.__name__, self.user_url,
2310
 
                self.name)
 
1885
        return '%s(%r)' % (self.__class__.__name__, self.base)
2311
1886
 
2312
1887
    __repr__ = __str__
2313
1888
 
2324
1899
        return self.control_files.is_locked()
2325
1900
 
2326
1901
    def lock_write(self, token=None):
2327
 
        if not self.is_locked():
2328
 
            self._note_lock('w')
2329
 
        # All-in-one needs to always unlock/lock.
2330
 
        repo_control = getattr(self.repository, 'control_files', None)
2331
 
        if self.control_files == repo_control or not self.is_locked():
2332
 
            self.repository._warn_if_deprecated(self)
2333
 
            self.repository.lock_write()
2334
 
            took_lock = True
2335
 
        else:
2336
 
            took_lock = False
 
1902
        repo_token = self.repository.lock_write()
2337
1903
        try:
2338
 
            return self.control_files.lock_write(token=token)
 
1904
            token = self.control_files.lock_write(token=token)
2339
1905
        except:
2340
 
            if took_lock:
2341
 
                self.repository.unlock()
 
1906
            self.repository.unlock()
2342
1907
            raise
 
1908
        return token
2343
1909
 
2344
1910
    def lock_read(self):
2345
 
        if not self.is_locked():
2346
 
            self._note_lock('r')
2347
 
        # All-in-one needs to always unlock/lock.
2348
 
        repo_control = getattr(self.repository, 'control_files', None)
2349
 
        if self.control_files == repo_control or not self.is_locked():
2350
 
            self.repository._warn_if_deprecated(self)
2351
 
            self.repository.lock_read()
2352
 
            took_lock = True
2353
 
        else:
2354
 
            took_lock = False
 
1911
        self.repository.lock_read()
2355
1912
        try:
2356
1913
            self.control_files.lock_read()
2357
1914
        except:
2358
 
            if took_lock:
2359
 
                self.repository.unlock()
 
1915
            self.repository.unlock()
2360
1916
            raise
2361
1917
 
2362
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2363
1918
    def unlock(self):
 
1919
        # TODO: test for failed two phase locks. This is known broken.
2364
1920
        try:
2365
1921
            self.control_files.unlock()
2366
1922
        finally:
2367
 
            # All-in-one needs to always unlock/lock.
2368
 
            repo_control = getattr(self.repository, 'control_files', None)
2369
 
            if (self.control_files == repo_control or
2370
 
                not self.control_files.is_locked()):
2371
 
                self.repository.unlock()
2372
 
            if not self.control_files.is_locked():
2373
 
                # we just released the lock
2374
 
                self._clear_cached_state()
 
1923
            self.repository.unlock()
 
1924
        if not self.control_files.is_locked():
 
1925
            # we just released the lock
 
1926
            self._clear_cached_state()
2375
1927
 
2376
1928
    def peek_lock_mode(self):
2377
1929
        if self.control_files._lock_count == 0:
2496
2048
        """See Branch.basis_tree."""
2497
2049
        return self.repository.revision_tree(self.last_revision())
2498
2050
 
 
2051
    @needs_write_lock
 
2052
    def pull(self, source, overwrite=False, stop_revision=None,
 
2053
             _hook_master=None, run_hooks=True, possible_transports=None,
 
2054
             _override_hook_target=None):
 
2055
        """See Branch.pull.
 
2056
 
 
2057
        :param _hook_master: Private parameter - set the branch to
 
2058
            be supplied as the master to pull hooks.
 
2059
        :param run_hooks: Private parameter - if false, this branch
 
2060
            is being called because it's the master of the primary branch,
 
2061
            so it should not run its hooks.
 
2062
        :param _override_hook_target: Private parameter - set the branch to be
 
2063
            supplied as the target_branch to pull hooks.
 
2064
        """
 
2065
        result = PullResult()
 
2066
        result.source_branch = source
 
2067
        if _override_hook_target is None:
 
2068
            result.target_branch = self
 
2069
        else:
 
2070
            result.target_branch = _override_hook_target
 
2071
        source.lock_read()
 
2072
        try:
 
2073
            # We assume that during 'pull' the local repository is closer than
 
2074
            # the remote one.
 
2075
            graph = self.repository.get_graph(source.repository)
 
2076
            result.old_revno, result.old_revid = self.last_revision_info()
 
2077
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
2078
                                  graph=graph)
 
2079
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
2080
            result.new_revno, result.new_revid = self.last_revision_info()
 
2081
            if _hook_master:
 
2082
                result.master_branch = _hook_master
 
2083
                result.local_branch = result.target_branch
 
2084
            else:
 
2085
                result.master_branch = result.target_branch
 
2086
                result.local_branch = None
 
2087
            if run_hooks:
 
2088
                for hook in Branch.hooks['post_pull']:
 
2089
                    hook(result)
 
2090
        finally:
 
2091
            source.unlock()
 
2092
        return result
 
2093
 
2499
2094
    def _get_parent_location(self):
2500
2095
        _locs = ['parent', 'pull', 'x-pull']
2501
2096
        for l in _locs:
2505
2100
                pass
2506
2101
        return None
2507
2102
 
 
2103
    @needs_read_lock
 
2104
    def push(self, target, overwrite=False, stop_revision=None,
 
2105
             _override_hook_source_branch=None):
 
2106
        """See Branch.push.
 
2107
 
 
2108
        This is the basic concrete implementation of push()
 
2109
 
 
2110
        :param _override_hook_source_branch: If specified, run
 
2111
        the hooks passing this Branch as the source, rather than self.
 
2112
        This is for use of RemoteBranch, where push is delegated to the
 
2113
        underlying vfs-based Branch.
 
2114
        """
 
2115
        # TODO: Public option to disable running hooks - should be trivial but
 
2116
        # needs tests.
 
2117
        return _run_with_write_locked_target(
 
2118
            target, self._push_with_bound_branches, target, overwrite,
 
2119
            stop_revision,
 
2120
            _override_hook_source_branch=_override_hook_source_branch)
 
2121
 
 
2122
    def _push_with_bound_branches(self, target, overwrite,
 
2123
            stop_revision,
 
2124
            _override_hook_source_branch=None):
 
2125
        """Push from self into target, and into target's master if any.
 
2126
 
 
2127
        This is on the base BzrBranch class even though it doesn't support
 
2128
        bound branches because the *target* might be bound.
 
2129
        """
 
2130
        def _run_hooks():
 
2131
            if _override_hook_source_branch:
 
2132
                result.source_branch = _override_hook_source_branch
 
2133
            for hook in Branch.hooks['post_push']:
 
2134
                hook(result)
 
2135
 
 
2136
        bound_location = target.get_bound_location()
 
2137
        if bound_location and target.base != bound_location:
 
2138
            # there is a master branch.
 
2139
            #
 
2140
            # XXX: Why the second check?  Is it even supported for a branch to
 
2141
            # be bound to itself? -- mbp 20070507
 
2142
            master_branch = target.get_master_branch()
 
2143
            master_branch.lock_write()
 
2144
            try:
 
2145
                # push into the master from this branch.
 
2146
                self._basic_push(master_branch, overwrite, stop_revision)
 
2147
                # and push into the target branch from this. Note that we push from
 
2148
                # this branch again, because its considered the highest bandwidth
 
2149
                # repository.
 
2150
                result = self._basic_push(target, overwrite, stop_revision)
 
2151
                result.master_branch = master_branch
 
2152
                result.local_branch = target
 
2153
                _run_hooks()
 
2154
                return result
 
2155
            finally:
 
2156
                master_branch.unlock()
 
2157
        else:
 
2158
            # no master branch
 
2159
            result = self._basic_push(target, overwrite, stop_revision)
 
2160
            # TODO: Why set master_branch and local_branch if there's no
 
2161
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2162
            # 20070504
 
2163
            result.master_branch = target
 
2164
            result.local_branch = None
 
2165
            _run_hooks()
 
2166
            return result
 
2167
 
2508
2168
    def _basic_push(self, target, overwrite, stop_revision):
2509
2169
        """Basic implementation of push without bound branches or hooks.
2510
2170
 
2511
 
        Must be called with source read locked and target write locked.
 
2171
        Must be called with self read locked and target write locked.
2512
2172
        """
2513
2173
        result = BranchPushResult()
2514
2174
        result.source_branch = self
2515
2175
        result.target_branch = target
2516
2176
        result.old_revno, result.old_revid = target.last_revision_info()
2517
 
        self.update_references(target)
2518
2177
        if result.old_revid != self.last_revision():
2519
2178
            # We assume that during 'push' this repository is closer than
2520
2179
            # the target.
2521
2180
            graph = self.repository.get_graph(target.repository)
2522
 
            target.update_revisions(self, stop_revision,
2523
 
                overwrite=overwrite, graph=graph)
 
2181
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2182
                                    graph=graph)
2524
2183
        if self._push_should_merge_tags():
2525
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2526
 
                overwrite)
 
2184
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2527
2185
        result.new_revno, result.new_revid = target.last_revision_info()
2528
2186
        return result
2529
2187
 
2530
2188
    def get_stacked_on_url(self):
2531
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2189
        raise errors.UnstackableBranchFormat(self._format, self.base)
2532
2190
 
2533
2191
    def set_push_location(self, location):
2534
2192
        """See Branch.set_push_location."""
2536
2194
            'push_location', location,
2537
2195
            store=_mod_config.STORE_LOCATION_NORECURSE)
2538
2196
 
 
2197
    @needs_write_lock
 
2198
    def set_parent(self, url):
 
2199
        """See Branch.set_parent."""
 
2200
        # TODO: Maybe delete old location files?
 
2201
        # URLs should never be unicode, even on the local fs,
 
2202
        # FIXUP this and get_parent in a future branch format bump:
 
2203
        # read and rewrite the file. RBC 20060125
 
2204
        if url is not None:
 
2205
            if isinstance(url, unicode):
 
2206
                try:
 
2207
                    url = url.encode('ascii')
 
2208
                except UnicodeEncodeError:
 
2209
                    raise errors.InvalidURL(url,
 
2210
                        "Urls must be 7-bit ascii, "
 
2211
                        "use bzrlib.urlutils.escape")
 
2212
            url = urlutils.relative_url(self.base, url)
 
2213
        self._set_parent_location(url)
 
2214
 
2539
2215
    def _set_parent_location(self, url):
2540
2216
        if url is None:
2541
2217
            self._transport.delete('parent')
2550
2226
    It has support for a master_branch which is the data for bound branches.
2551
2227
    """
2552
2228
 
 
2229
    @needs_write_lock
 
2230
    def pull(self, source, overwrite=False, stop_revision=None,
 
2231
             run_hooks=True, possible_transports=None,
 
2232
             _override_hook_target=None):
 
2233
        """Pull from source into self, updating my master if any.
 
2234
 
 
2235
        :param run_hooks: Private parameter - if false, this branch
 
2236
            is being called because it's the master of the primary branch,
 
2237
            so it should not run its hooks.
 
2238
        """
 
2239
        bound_location = self.get_bound_location()
 
2240
        master_branch = None
 
2241
        if bound_location and source.base != bound_location:
 
2242
            # not pulling from master, so we need to update master.
 
2243
            master_branch = self.get_master_branch(possible_transports)
 
2244
            master_branch.lock_write()
 
2245
        try:
 
2246
            if master_branch:
 
2247
                # pull from source into master.
 
2248
                master_branch.pull(source, overwrite, stop_revision,
 
2249
                    run_hooks=False)
 
2250
            return super(BzrBranch5, self).pull(source, overwrite,
 
2251
                stop_revision, _hook_master=master_branch,
 
2252
                run_hooks=run_hooks,
 
2253
                _override_hook_target=_override_hook_target)
 
2254
        finally:
 
2255
            if master_branch:
 
2256
                master_branch.unlock()
 
2257
 
2553
2258
    def get_bound_location(self):
2554
2259
        try:
2555
2260
            return self._transport.get_bytes('bound')[:-1]
2642
2347
        return None
2643
2348
 
2644
2349
 
2645
 
class BzrBranch8(BzrBranch5):
2646
 
    """A branch that stores tree-reference locations."""
 
2350
class BzrBranch7(BzrBranch5):
 
2351
    """A branch with support for a fallback repository."""
2647
2352
 
2648
2353
    def _open_hook(self):
2649
2354
        if self._ignore_fallbacks:
2665
2370
 
2666
2371
    def __init__(self, *args, **kwargs):
2667
2372
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2668
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2373
        super(BzrBranch7, self).__init__(*args, **kwargs)
2669
2374
        self._last_revision_info_cache = None
2670
 
        self._reference_info = None
 
2375
        self._partial_revision_history_cache = []
2671
2376
 
2672
2377
    def _clear_cached_state(self):
2673
 
        super(BzrBranch8, self)._clear_cached_state()
 
2378
        super(BzrBranch7, self)._clear_cached_state()
2674
2379
        self._last_revision_info_cache = None
2675
 
        self._reference_info = None
 
2380
        self._partial_revision_history_cache = []
2676
2381
 
2677
2382
    def _last_revision_info(self):
2678
2383
        revision_string = self._transport.get_bytes('last-revision')
2724
2429
        if _mod_revision.is_null(last_revision):
2725
2430
            return
2726
2431
        if last_revision not in self._lefthand_history(revision_id):
2727
 
            raise errors.AppendRevisionsOnlyViolation(self.user_url)
 
2432
            raise errors.AppendRevisionsOnlyViolation(self.base)
2728
2433
 
2729
2434
    def _gen_revision_history(self):
2730
2435
        """Generate the revision history from last revision
2733
2438
        self._extend_partial_history(stop_index=last_revno-1)
2734
2439
        return list(reversed(self._partial_revision_history_cache))
2735
2440
 
 
2441
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2442
        """Extend the partial history to include a given index
 
2443
 
 
2444
        If a stop_index is supplied, stop when that index has been reached.
 
2445
        If a stop_revision is supplied, stop when that revision is
 
2446
        encountered.  Otherwise, stop when the beginning of history is
 
2447
        reached.
 
2448
 
 
2449
        :param stop_index: The index which should be present.  When it is
 
2450
            present, history extension will stop.
 
2451
        :param revision_id: The revision id which should be present.  When
 
2452
            it is encountered, history extension will stop.
 
2453
        """
 
2454
        repo = self.repository
 
2455
        if len(self._partial_revision_history_cache) == 0:
 
2456
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2457
        else:
 
2458
            start_revision = self._partial_revision_history_cache[-1]
 
2459
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2460
            #skip the last revision in the list
 
2461
            next_revision = iterator.next()
 
2462
        for revision_id in iterator:
 
2463
            self._partial_revision_history_cache.append(revision_id)
 
2464
            if (stop_index is not None and
 
2465
                len(self._partial_revision_history_cache) > stop_index):
 
2466
                break
 
2467
            if revision_id == stop_revision:
 
2468
                break
 
2469
 
2736
2470
    def _write_revision_history(self, history):
2737
2471
        """Factored out of set_revision_history.
2738
2472
 
2759
2493
        """Set the parent branch"""
2760
2494
        return self._get_config_location('parent_location')
2761
2495
 
2762
 
    @needs_write_lock
2763
 
    def _set_all_reference_info(self, info_dict):
2764
 
        """Replace all reference info stored in a branch.
2765
 
 
2766
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2767
 
        """
2768
 
        s = StringIO()
2769
 
        writer = rio.RioWriter(s)
2770
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2771
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2772
 
                                branch_location=branch_location)
2773
 
            writer.write_stanza(stanza)
2774
 
        self._transport.put_bytes('references', s.getvalue())
2775
 
        self._reference_info = info_dict
2776
 
 
2777
 
    @needs_read_lock
2778
 
    def _get_all_reference_info(self):
2779
 
        """Return all the reference info stored in a branch.
2780
 
 
2781
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2782
 
        """
2783
 
        if self._reference_info is not None:
2784
 
            return self._reference_info
2785
 
        rio_file = self._transport.get('references')
2786
 
        try:
2787
 
            stanzas = rio.read_stanzas(rio_file)
2788
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2789
 
                             s['branch_location'])) for s in stanzas)
2790
 
        finally:
2791
 
            rio_file.close()
2792
 
        self._reference_info = info_dict
2793
 
        return info_dict
2794
 
 
2795
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2796
 
        """Set the branch location to use for a tree reference.
2797
 
 
2798
 
        :param file_id: The file-id of the tree reference.
2799
 
        :param tree_path: The path of the tree reference in the tree.
2800
 
        :param branch_location: The location of the branch to retrieve tree
2801
 
            references from.
2802
 
        """
2803
 
        info_dict = self._get_all_reference_info()
2804
 
        info_dict[file_id] = (tree_path, branch_location)
2805
 
        if None in (tree_path, branch_location):
2806
 
            if tree_path is not None:
2807
 
                raise ValueError('tree_path must be None when branch_location'
2808
 
                                 ' is None.')
2809
 
            if branch_location is not None:
2810
 
                raise ValueError('branch_location must be None when tree_path'
2811
 
                                 ' is None.')
2812
 
            del info_dict[file_id]
2813
 
        self._set_all_reference_info(info_dict)
2814
 
 
2815
 
    def get_reference_info(self, file_id):
2816
 
        """Get the tree_path and branch_location for a tree reference.
2817
 
 
2818
 
        :return: a tuple of (tree_path, branch_location)
2819
 
        """
2820
 
        return self._get_all_reference_info().get(file_id, (None, None))
2821
 
 
2822
 
    def reference_parent(self, file_id, path, possible_transports=None):
2823
 
        """Return the parent branch for a tree-reference file_id.
2824
 
 
2825
 
        :param file_id: The file_id of the tree reference
2826
 
        :param path: The path of the file_id in the tree
2827
 
        :return: A branch associated with the file_id
2828
 
        """
2829
 
        branch_location = self.get_reference_info(file_id)[1]
2830
 
        if branch_location is None:
2831
 
            return Branch.reference_parent(self, file_id, path,
2832
 
                                           possible_transports)
2833
 
        branch_location = urlutils.join(self.user_url, branch_location)
2834
 
        return Branch.open(branch_location,
2835
 
                           possible_transports=possible_transports)
2836
 
 
2837
2496
    def set_push_location(self, location):
2838
2497
        """See Branch.set_push_location."""
2839
2498
        self._set_config_location('push_location', location)
2881
2540
            raise errors.NotStacked(self)
2882
2541
        return stacked_url
2883
2542
 
 
2543
    def set_append_revisions_only(self, enabled):
 
2544
        if enabled:
 
2545
            value = 'True'
 
2546
        else:
 
2547
            value = 'False'
 
2548
        self.get_config().set_user_option('append_revisions_only', value,
 
2549
            warn_masked=True)
 
2550
 
2884
2551
    def _get_append_revisions_only(self):
2885
 
        return self.get_config(
2886
 
            ).get_user_option_as_bool('append_revisions_only')
 
2552
        value = self.get_config().get_user_option('append_revisions_only')
 
2553
        return value == 'True'
2887
2554
 
2888
2555
    @needs_write_lock
2889
2556
    def generate_revision_history(self, revision_id, last_rev=None,
2929
2596
        return self.revno() - index
2930
2597
 
2931
2598
 
2932
 
class BzrBranch7(BzrBranch8):
2933
 
    """A branch with support for a fallback repository."""
2934
 
 
2935
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2936
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2937
 
 
2938
 
    def get_reference_info(self, file_id):
2939
 
        Branch.get_reference_info(self, file_id)
2940
 
 
2941
 
    def reference_parent(self, file_id, path, possible_transports=None):
2942
 
        return Branch.reference_parent(self, file_id, path,
2943
 
                                       possible_transports)
2944
 
 
2945
 
 
2946
2599
class BzrBranch6(BzrBranch7):
2947
2600
    """See BzrBranchFormat6 for the capabilities of this branch.
2948
2601
 
2951
2604
    """
2952
2605
 
2953
2606
    def get_stacked_on_url(self):
2954
 
        raise errors.UnstackableBranchFormat(self._format, self.user_url)
 
2607
        raise errors.UnstackableBranchFormat(self._format, self.base)
2955
2608
 
2956
2609
 
2957
2610
######################################################################
3036
2689
 
3037
2690
    def __init__(self, branch):
3038
2691
        self.branch = branch
3039
 
        self.errors = []
3040
2692
 
3041
2693
    def report_results(self, verbose):
3042
2694
        """Report the check results via trace.note.
3044
2696
        :param verbose: Requests more detailed display of what was checked,
3045
2697
            if any.
3046
2698
        """
3047
 
        note('checked branch %s format %s', self.branch.user_url,
3048
 
            self.branch._format)
3049
 
        for error in self.errors:
3050
 
            note('found error:%s', error)
 
2699
        note('checked branch %s format %s',
 
2700
             self.branch.base,
 
2701
             self.branch._format)
3051
2702
 
3052
2703
 
3053
2704
class Converter5to6(object):
3091
2742
        branch._transport.put_bytes('format', format.get_format_string())
3092
2743
 
3093
2744
 
3094
 
class Converter7to8(object):
3095
 
    """Perform an in-place upgrade of format 6 to format 7"""
3096
 
 
3097
 
    def convert(self, branch):
3098
 
        format = BzrBranchFormat8()
3099
 
        branch._transport.put_bytes('references', '')
3100
 
        # update target format
3101
 
        branch._transport.put_bytes('format', format.get_format_string())
3102
 
 
3103
2745
 
3104
2746
def _run_with_write_locked_target(target, callable, *args, **kwargs):
3105
2747
    """Run ``callable(*args, **kwargs)``, write-locking target for the
3148
2790
    @staticmethod
3149
2791
    def _get_branch_formats_to_test():
3150
2792
        """Return a tuple with the Branch formats to use when testing."""
3151
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
3152
 
 
3153
 
    def pull(self, overwrite=False, stop_revision=None,
3154
 
             possible_transports=None, local=False):
3155
 
        """Mirror source into target branch.
3156
 
 
3157
 
        The target branch is considered to be 'local', having low latency.
3158
 
 
3159
 
        :returns: PullResult instance
3160
 
        """
3161
 
        raise NotImplementedError(self.pull)
 
2793
        raise NotImplementedError(self._get_branch_formats_to_test)
3162
2794
 
3163
2795
    def update_revisions(self, stop_revision=None, overwrite=False,
3164
2796
                         graph=None):
3173
2805
        """
3174
2806
        raise NotImplementedError(self.update_revisions)
3175
2807
 
3176
 
    def push(self, overwrite=False, stop_revision=None,
3177
 
             _override_hook_source_branch=None):
3178
 
        """Mirror the source branch into the target branch.
3179
 
 
3180
 
        The source branch is considered to be 'local', having low latency.
3181
 
        """
3182
 
        raise NotImplementedError(self.push)
3183
 
 
3184
2808
 
3185
2809
class GenericInterBranch(InterBranch):
3186
2810
    """InterBranch implementation that uses public Branch functions.
3233
2857
        finally:
3234
2858
            self.source.unlock()
3235
2859
 
3236
 
    def pull(self, overwrite=False, stop_revision=None,
3237
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3238
 
             _override_hook_target=None, local=False):
3239
 
        """See Branch.pull.
3240
 
 
3241
 
        :param _hook_master: Private parameter - set the branch to
3242
 
            be supplied as the master to pull hooks.
3243
 
        :param run_hooks: Private parameter - if false, this branch
3244
 
            is being called because it's the master of the primary branch,
3245
 
            so it should not run its hooks.
3246
 
        :param _override_hook_target: Private parameter - set the branch to be
3247
 
            supplied as the target_branch to pull hooks.
3248
 
        :param local: Only update the local branch, and not the bound branch.
3249
 
        """
3250
 
        # This type of branch can't be bound.
3251
 
        if local:
3252
 
            raise errors.LocalRequiresBoundBranch()
3253
 
        result = PullResult()
3254
 
        result.source_branch = self.source
3255
 
        if _override_hook_target is None:
3256
 
            result.target_branch = self.target
3257
 
        else:
3258
 
            result.target_branch = _override_hook_target
3259
 
        self.source.lock_read()
3260
 
        try:
3261
 
            # We assume that during 'pull' the target repository is closer than
3262
 
            # the source one.
3263
 
            self.source.update_references(self.target)
3264
 
            graph = self.target.repository.get_graph(self.source.repository)
3265
 
            # TODO: Branch formats should have a flag that indicates 
3266
 
            # that revno's are expensive, and pull() should honor that flag.
3267
 
            # -- JRV20090506
3268
 
            result.old_revno, result.old_revid = \
3269
 
                self.target.last_revision_info()
3270
 
            self.target.update_revisions(self.source, stop_revision,
3271
 
                overwrite=overwrite, graph=graph)
3272
 
            # TODO: The old revid should be specified when merging tags, 
3273
 
            # so a tags implementation that versions tags can only 
3274
 
            # pull in the most recent changes. -- JRV20090506
3275
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3276
 
                overwrite)
3277
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3278
 
            if _hook_master:
3279
 
                result.master_branch = _hook_master
3280
 
                result.local_branch = result.target_branch
3281
 
            else:
3282
 
                result.master_branch = result.target_branch
3283
 
                result.local_branch = None
3284
 
            if run_hooks:
3285
 
                for hook in Branch.hooks['post_pull']:
3286
 
                    hook(result)
3287
 
        finally:
3288
 
            self.source.unlock()
3289
 
        return result
3290
 
 
3291
 
    def push(self, overwrite=False, stop_revision=None,
3292
 
             _override_hook_source_branch=None):
3293
 
        """See InterBranch.push.
3294
 
 
3295
 
        This is the basic concrete implementation of push()
3296
 
 
3297
 
        :param _override_hook_source_branch: If specified, run
3298
 
        the hooks passing this Branch as the source, rather than self.
3299
 
        This is for use of RemoteBranch, where push is delegated to the
3300
 
        underlying vfs-based Branch.
3301
 
        """
3302
 
        # TODO: Public option to disable running hooks - should be trivial but
3303
 
        # needs tests.
3304
 
        self.source.lock_read()
3305
 
        try:
3306
 
            return _run_with_write_locked_target(
3307
 
                self.target, self._push_with_bound_branches, overwrite,
3308
 
                stop_revision,
3309
 
                _override_hook_source_branch=_override_hook_source_branch)
3310
 
        finally:
3311
 
            self.source.unlock()
3312
 
 
3313
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3314
 
            _override_hook_source_branch=None):
3315
 
        """Push from source into target, and into target's master if any.
3316
 
        """
3317
 
        def _run_hooks():
3318
 
            if _override_hook_source_branch:
3319
 
                result.source_branch = _override_hook_source_branch
3320
 
            for hook in Branch.hooks['post_push']:
3321
 
                hook(result)
3322
 
 
3323
 
        bound_location = self.target.get_bound_location()
3324
 
        if bound_location and self.target.base != bound_location:
3325
 
            # there is a master branch.
3326
 
            #
3327
 
            # XXX: Why the second check?  Is it even supported for a branch to
3328
 
            # be bound to itself? -- mbp 20070507
3329
 
            master_branch = self.target.get_master_branch()
3330
 
            master_branch.lock_write()
3331
 
            try:
3332
 
                # push into the master from the source branch.
3333
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3334
 
                # and push into the target branch from the source. Note that we
3335
 
                # push from the source branch again, because its considered the
3336
 
                # highest bandwidth repository.
3337
 
                result = self.source._basic_push(self.target, overwrite,
3338
 
                    stop_revision)
3339
 
                result.master_branch = master_branch
3340
 
                result.local_branch = self.target
3341
 
                _run_hooks()
3342
 
                return result
3343
 
            finally:
3344
 
                master_branch.unlock()
3345
 
        else:
3346
 
            # no master branch
3347
 
            result = self.source._basic_push(self.target, overwrite,
3348
 
                stop_revision)
3349
 
            # TODO: Why set master_branch and local_branch if there's no
3350
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3351
 
            # 20070504
3352
 
            result.master_branch = self.target
3353
 
            result.local_branch = None
3354
 
            _run_hooks()
3355
 
            return result
3356
 
 
3357
2860
    @classmethod
3358
2861
    def is_compatible(self, source, target):
3359
2862
        # GenericBranch uses the public API, so always compatible
3360
2863
        return True
3361
2864
 
3362
2865
 
3363
 
class InterToBranch5(GenericInterBranch):
3364
 
 
3365
 
    @staticmethod
3366
 
    def _get_branch_formats_to_test():
3367
 
        return BranchFormat._default_format, BzrBranchFormat5()
3368
 
 
3369
 
    def pull(self, overwrite=False, stop_revision=None,
3370
 
             possible_transports=None, run_hooks=True,
3371
 
             _override_hook_target=None, local=False):
3372
 
        """Pull from source into self, updating my master if any.
3373
 
 
3374
 
        :param run_hooks: Private parameter - if false, this branch
3375
 
            is being called because it's the master of the primary branch,
3376
 
            so it should not run its hooks.
3377
 
        """
3378
 
        bound_location = self.target.get_bound_location()
3379
 
        if local and not bound_location:
3380
 
            raise errors.LocalRequiresBoundBranch()
3381
 
        master_branch = None
3382
 
        if not local and bound_location and self.source.user_url != bound_location:
3383
 
            # not pulling from master, so we need to update master.
3384
 
            master_branch = self.target.get_master_branch(possible_transports)
3385
 
            master_branch.lock_write()
3386
 
        try:
3387
 
            if master_branch:
3388
 
                # pull from source into master.
3389
 
                master_branch.pull(self.source, overwrite, stop_revision,
3390
 
                    run_hooks=False)
3391
 
            return super(InterToBranch5, self).pull(overwrite,
3392
 
                stop_revision, _hook_master=master_branch,
3393
 
                run_hooks=run_hooks,
3394
 
                _override_hook_target=_override_hook_target)
3395
 
        finally:
3396
 
            if master_branch:
3397
 
                master_branch.unlock()
3398
 
 
3399
 
 
3400
2866
InterBranch.register_optimiser(GenericInterBranch)
3401
 
InterBranch.register_optimiser(InterToBranch5)