~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/branch.py

  • Committer: John Arbash Meinel
  • Date: 2009-03-06 20:42:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4088.
  • Revision ID: john@arbash-meinel.com-20090306204240-mzjavv31z3gu1x7i
Fix a small bug in setup.py when an extension fails to build

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
 
 
17
 
 
18
 
from cStringIO import StringIO
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
 
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
 
        symbol_versioning,
36
33
        transport,
37
34
        tsort,
38
35
        ui,
39
36
        urlutils,
40
37
        )
41
 
from bzrlib.config import BranchConfig, TransportConfig
 
38
from bzrlib.config import BranchConfig
42
39
from bzrlib.repofmt.pack_repo import RepositoryFormatKnitPack5RichRoot
43
40
from bzrlib.tag import (
44
41
    BasicTags,
46
43
    )
47
44
""")
48
45
 
49
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
50
 
from bzrlib.hooks import HookPoint, Hooks
 
46
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
47
from bzrlib.hooks import Hooks
51
48
from bzrlib.inter import InterObject
52
 
from bzrlib.lock import _RelockDebugMixin
53
49
from bzrlib import registry
54
50
from bzrlib.symbol_versioning import (
55
51
    deprecated_in,
87
83
    # - RBC 20060112
88
84
    base = None
89
85
 
 
86
    # override this to set the strategy for storing tags
 
87
    def _make_tags(self):
 
88
        return DisabledTags(self)
 
89
 
90
90
    def __init__(self, *ignored, **ignored_too):
91
 
        self.tags = self._format.make_tags(self)
 
91
        self.tags = self._make_tags()
92
92
        self._revision_history_cache = None
93
93
        self._revision_id_to_revno_cache = None
94
94
        self._partial_revision_id_to_revno_cache = {}
95
 
        self._partial_revision_history_cache = []
96
95
        self._last_revision_info_cache = None
97
96
        self._merge_sorted_revisions_cache = None
98
97
        self._open_hook()
103
102
    def _open_hook(self):
104
103
        """Called by init to allow simpler extension of the base class."""
105
104
 
106
 
    def _activate_fallback_location(self, url):
107
 
        """Activate the branch/repository from url as a fallback repository."""
108
 
        repo = self._get_fallback_repository(url)
109
 
        if repo.has_same_location(self.repository):
110
 
            raise errors.UnstackableLocationError(self.base, url)
111
 
        self.repository.add_fallback_repository(repo)
112
 
 
113
105
    def break_lock(self):
114
106
        """Break a lock if one is present from another instance.
115
107
 
124
116
        if master is not None:
125
117
            master.break_lock()
126
118
 
127
 
    def _check_stackable_repo(self):
128
 
        if not self.repository._format.supports_external_lookups:
129
 
            raise errors.UnstackableRepositoryFormat(self.repository._format,
130
 
                self.repository.base)
131
 
 
132
 
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
133
 
        """Extend the partial history to include a given index
134
 
 
135
 
        If a stop_index is supplied, stop when that index has been reached.
136
 
        If a stop_revision is supplied, stop when that revision is
137
 
        encountered.  Otherwise, stop when the beginning of history is
138
 
        reached.
139
 
 
140
 
        :param stop_index: The index which should be present.  When it is
141
 
            present, history extension will stop.
142
 
        :param stop_revision: The revision id which should be present.  When
143
 
            it is encountered, history extension will stop.
144
 
        """
145
 
        if len(self._partial_revision_history_cache) == 0:
146
 
            self._partial_revision_history_cache = [self.last_revision()]
147
 
        repository._iter_for_revno(
148
 
            self.repository, self._partial_revision_history_cache,
149
 
            stop_index=stop_index, stop_revision=stop_revision)
150
 
        if self._partial_revision_history_cache[-1] == _mod_revision.NULL_REVISION:
151
 
            self._partial_revision_history_cache.pop()
152
 
 
153
 
    def _get_check_refs(self):
154
 
        """Get the references needed for check().
155
 
 
156
 
        See bzrlib.check.
157
 
        """
158
 
        revid = self.last_revision()
159
 
        return [('revision-existence', revid), ('lefthand-distance', revid)]
160
 
 
161
119
    @staticmethod
162
120
    def open(base, _unsupported=False, possible_transports=None):
163
121
        """Open the branch rooted at base.
197
155
        The default implementation returns False if this branch has no tags,
198
156
        and True the rest of the time.  Subclasses may override this.
199
157
        """
200
 
        return self.supports_tags() and self.tags.get_tag_dict()
 
158
        return self.tags.supports_tags() and self.tags.get_tag_dict()
201
159
 
202
160
    def get_config(self):
203
161
        return BranchConfig(self)
204
162
 
205
 
    def _get_config(self):
206
 
        """Get the concrete config for just the config in this branch.
207
 
 
208
 
        This is not intended for client use; see Branch.get_config for the
209
 
        public API.
210
 
 
211
 
        Added in 1.14.
212
 
 
213
 
        :return: An object supporting get_option and set_option.
214
 
        """
215
 
        raise NotImplementedError(self._get_config)
216
 
 
217
 
    def _get_fallback_repository(self, url):
218
 
        """Get the repository we fallback to at url."""
219
 
        url = urlutils.join(self.base, url)
220
 
        a_bzrdir = bzrdir.BzrDir.open(url,
221
 
            possible_transports=[self.bzrdir.root_transport])
222
 
        return a_bzrdir.open_branch().repository
223
 
 
224
 
    def _get_tags_bytes(self):
225
 
        """Get the bytes of a serialised tags dict.
226
 
 
227
 
        Note that not all branches support tags, nor do all use the same tags
228
 
        logic: this method is specific to BasicTags. Other tag implementations
229
 
        may use the same method name and behave differently, safely, because
230
 
        of the double-dispatch via
231
 
        format.make_tags->tags_instance->get_tags_dict.
232
 
 
233
 
        :return: The bytes of the tags file.
234
 
        :seealso: Branch._set_tags_bytes.
235
 
        """
236
 
        return self._transport.get_bytes('tags')
237
 
 
238
163
    def _get_nick(self, local=False, possible_transports=None):
239
164
        config = self.get_config()
240
165
        # explicit overrides master, but don't look for master if local is True
447
372
        # start_revision_id.
448
373
        if self._merge_sorted_revisions_cache is None:
449
374
            last_revision = self.last_revision()
450
 
            last_key = (last_revision,)
451
 
            known_graph = self.repository.revisions.get_known_graph_ancestry(
452
 
                [last_key])
453
 
            self._merge_sorted_revisions_cache = known_graph.merge_sort(
454
 
                last_key)
 
375
            graph = self.repository.get_graph()
 
376
            parent_map = dict(((key, value) for key, value in
 
377
                     graph.iter_ancestry([last_revision]) if value is not None))
 
378
            revision_graph = repository._strip_NULL_ghosts(parent_map)
 
379
            revs = tsort.merge_sort(revision_graph, last_revision, None,
 
380
                generate_revno=True)
 
381
            # Drop the sequence # before caching
 
382
            self._merge_sorted_revisions_cache = [r[1:] for r in revs]
 
383
 
455
384
        filtered = self._filter_merge_sorted_revisions(
456
385
            self._merge_sorted_revisions_cache, start_revision_id,
457
386
            stop_revision_id, stop_rule)
467
396
        """Iterate over an inclusive range of sorted revisions."""
468
397
        rev_iter = iter(merge_sorted_revisions)
469
398
        if start_revision_id is not None:
470
 
            for node in rev_iter:
471
 
                rev_id = node.key[-1]
 
399
            for rev_id, depth, revno, end_of_merge in rev_iter:
472
400
                if rev_id != start_revision_id:
473
401
                    continue
474
402
                else:
475
403
                    # The decision to include the start or not
476
404
                    # depends on the stop_rule if a stop is provided
477
 
                    # so pop this node back into the iterator
478
 
                    rev_iter = chain(iter([node]), rev_iter)
 
405
                    rev_iter = chain(
 
406
                        iter([(rev_id, depth, revno, end_of_merge)]),
 
407
                        rev_iter)
479
408
                    break
480
409
        if stop_revision_id is None:
481
 
            # Yield everything
482
 
            for node in rev_iter:
483
 
                rev_id = node.key[-1]
484
 
                yield (rev_id, node.merge_depth, node.revno,
485
 
                       node.end_of_merge)
 
410
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
411
                yield rev_id, depth, revno, end_of_merge
486
412
        elif stop_rule == 'exclude':
487
 
            for node in rev_iter:
488
 
                rev_id = node.key[-1]
 
413
            for rev_id, depth, revno, end_of_merge in rev_iter:
489
414
                if rev_id == stop_revision_id:
490
415
                    return
491
 
                yield (rev_id, node.merge_depth, node.revno,
492
 
                       node.end_of_merge)
 
416
                yield rev_id, depth, revno, end_of_merge
493
417
        elif stop_rule == 'include':
494
 
            for node in rev_iter:
495
 
                rev_id = node.key[-1]
496
 
                yield (rev_id, node.merge_depth, node.revno,
497
 
                       node.end_of_merge)
 
418
            for rev_id, depth, revno, end_of_merge in rev_iter:
 
419
                yield rev_id, depth, revno, end_of_merge
498
420
                if rev_id == stop_revision_id:
499
421
                    return
500
422
        elif stop_rule == 'with-merges':
503
425
                left_parent = stop_rev.parent_ids[0]
504
426
            else:
505
427
                left_parent = _mod_revision.NULL_REVISION
506
 
            # left_parent is the actual revision we want to stop logging at,
507
 
            # since we want to show the merged revisions after the stop_rev too
508
 
            reached_stop_revision_id = False
509
 
            revision_id_whitelist = []
510
 
            for node in rev_iter:
511
 
                rev_id = node.key[-1]
 
428
            for rev_id, depth, revno, end_of_merge in rev_iter:
512
429
                if rev_id == left_parent:
513
 
                    # reached the left parent after the stop_revision
514
430
                    return
515
 
                if (not reached_stop_revision_id or
516
 
                        rev_id in revision_id_whitelist):
517
 
                    yield (rev_id, node.merge_depth, node.revno,
518
 
                       node.end_of_merge)
519
 
                    if reached_stop_revision_id or rev_id == stop_revision_id:
520
 
                        # only do the merged revs of rev_id from now on
521
 
                        rev = self.repository.get_revision(rev_id)
522
 
                        if rev.parent_ids:
523
 
                            reached_stop_revision_id = True
524
 
                            revision_id_whitelist.extend(rev.parent_ids)
 
431
                yield rev_id, depth, revno, end_of_merge
525
432
        else:
526
433
            raise ValueError('invalid stop_rule %r' % stop_rule)
527
434
 
549
456
        """
550
457
        raise errors.UpgradeRequired(self.base)
551
458
 
552
 
    def set_append_revisions_only(self, enabled):
553
 
        if not self._format.supports_set_append_revisions_only():
554
 
            raise errors.UpgradeRequired(self.base)
555
 
        if enabled:
556
 
            value = 'True'
557
 
        else:
558
 
            value = 'False'
559
 
        self.get_config().set_user_option('append_revisions_only', value,
560
 
            warn_masked=True)
561
 
 
562
 
    def set_reference_info(self, file_id, tree_path, branch_location):
563
 
        """Set the branch location to use for a tree reference."""
564
 
        raise errors.UnsupportedOperation(self.set_reference_info, self)
565
 
 
566
 
    def get_reference_info(self, file_id):
567
 
        """Get the tree_path and branch_location for a tree reference."""
568
 
        raise errors.UnsupportedOperation(self.get_reference_info, self)
569
 
 
570
459
    @needs_write_lock
571
460
    def fetch(self, from_branch, last_revision=None, pb=None):
572
461
        """Copy revisions from from_branch into this branch.
579
468
        """
580
469
        if self.base == from_branch.base:
581
470
            return (0, [])
582
 
        if pb is not None:
583
 
            symbol_versioning.warn(
584
 
                symbol_versioning.deprecated_in((1, 14, 0))
585
 
                % "pb parameter to fetch()")
 
471
        if pb is None:
 
472
            nested_pb = ui.ui_factory.nested_progress_bar()
 
473
            pb = nested_pb
 
474
        else:
 
475
            nested_pb = None
 
476
 
586
477
        from_branch.lock_read()
587
478
        try:
588
479
            if last_revision is None:
 
480
                pb.update('get source history')
589
481
                last_revision = from_branch.last_revision()
590
482
                last_revision = _mod_revision.ensure_null(last_revision)
591
483
            return self.repository.fetch(from_branch.repository,
592
484
                                         revision_id=last_revision,
593
 
                                         pb=pb)
 
485
                                         pb=nested_pb)
594
486
        finally:
 
487
            if nested_pb is not None:
 
488
                nested_pb.finished()
595
489
            from_branch.unlock()
596
490
 
597
491
    def get_bound_location(self):
661
555
    def set_revision_history(self, rev_history):
662
556
        raise NotImplementedError(self.set_revision_history)
663
557
 
664
 
    @needs_write_lock
665
 
    def set_parent(self, url):
666
 
        """See Branch.set_parent."""
667
 
        # TODO: Maybe delete old location files?
668
 
        # URLs should never be unicode, even on the local fs,
669
 
        # FIXUP this and get_parent in a future branch format bump:
670
 
        # read and rewrite the file. RBC 20060125
671
 
        if url is not None:
672
 
            if isinstance(url, unicode):
673
 
                try:
674
 
                    url = url.encode('ascii')
675
 
                except UnicodeEncodeError:
676
 
                    raise errors.InvalidURL(url,
677
 
                        "Urls must be 7-bit ascii, "
678
 
                        "use bzrlib.urlutils.escape")
679
 
            url = urlutils.relative_url(self.base, url)
680
 
        self._set_parent_location(url)
681
 
 
682
 
    @needs_write_lock
683
558
    def set_stacked_on_url(self, url):
684
559
        """Set the URL this branch is stacked against.
685
560
 
688
563
        :raises UnstackableRepositoryFormat: If the repository does not support
689
564
            stacking.
690
565
        """
691
 
        if not self._format.supports_stacking():
692
 
            raise errors.UnstackableBranchFormat(self._format, self.base)
693
 
        # XXX: Changing from one fallback repository to another does not check
694
 
        # that all the data you need is present in the new fallback.
695
 
        # Possibly it should.
696
 
        self._check_stackable_repo()
697
 
        if not url:
698
 
            try:
699
 
                old_url = self.get_stacked_on_url()
700
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
701
 
                errors.UnstackableRepositoryFormat):
702
 
                return
703
 
            self._unstack()
704
 
        else:
705
 
            self._activate_fallback_location(url)
706
 
        # write this out after the repository is stacked to avoid setting a
707
 
        # stacked config that doesn't work.
708
 
        self._set_config_location('stacked_on_location', url)
709
 
 
710
 
    def _unstack(self):
711
 
        """Change a branch to be unstacked, copying data as needed.
712
 
        
713
 
        Don't call this directly, use set_stacked_on_url(None).
714
 
        """
715
 
        pb = ui.ui_factory.nested_progress_bar()
716
 
        try:
717
 
            pb.update("Unstacking")
718
 
            # The basic approach here is to fetch the tip of the branch,
719
 
            # including all available ghosts, from the existing stacked
720
 
            # repository into a new repository object without the fallbacks. 
721
 
            #
722
 
            # XXX: See <https://launchpad.net/bugs/397286> - this may not be
723
 
            # correct for CHKMap repostiories
724
 
            old_repository = self.repository
725
 
            if len(old_repository._fallback_repositories) != 1:
726
 
                raise AssertionError("can't cope with fallback repositories "
727
 
                    "of %r" % (self.repository,))
728
 
            # unlock it, including unlocking the fallback
729
 
            old_repository.unlock()
730
 
            old_repository.lock_read()
731
 
            try:
732
 
                # Repositories don't offer an interface to remove fallback
733
 
                # repositories today; take the conceptually simpler option and just
734
 
                # reopen it.  We reopen it starting from the URL so that we
735
 
                # get a separate connection for RemoteRepositories and can
736
 
                # stream from one of them to the other.  This does mean doing
737
 
                # separate SSH connection setup, but unstacking is not a
738
 
                # common operation so it's tolerable.
739
 
                new_bzrdir = bzrdir.BzrDir.open(self.bzrdir.root_transport.base)
740
 
                new_repository = new_bzrdir.find_repository()
741
 
                self.repository = new_repository
742
 
                if self.repository._fallback_repositories:
743
 
                    raise AssertionError("didn't expect %r to have "
744
 
                        "fallback_repositories"
745
 
                        % (self.repository,))
746
 
                # this is not paired with an unlock because it's just restoring
747
 
                # the previous state; the lock's released when set_stacked_on_url
748
 
                # returns
749
 
                self.repository.lock_write()
750
 
                # XXX: If you unstack a branch while it has a working tree
751
 
                # with a pending merge, the pending-merged revisions will no
752
 
                # longer be present.  You can (probably) revert and remerge.
753
 
                #
754
 
                # XXX: This only fetches up to the tip of the repository; it
755
 
                # doesn't bring across any tags.  That's fairly consistent
756
 
                # with how branch works, but perhaps not ideal.
757
 
                self.repository.fetch(old_repository,
758
 
                    revision_id=self.last_revision(),
759
 
                    find_ghosts=True)
760
 
            finally:
761
 
                old_repository.unlock()
762
 
        finally:
763
 
            pb.finished()
764
 
 
765
 
    def _set_tags_bytes(self, bytes):
766
 
        """Mirror method for _get_tags_bytes.
767
 
 
768
 
        :seealso: Branch._get_tags_bytes.
769
 
        """
770
 
        return _run_with_write_locked_target(self, self._transport.put_bytes,
771
 
            'tags', bytes)
 
566
        raise NotImplementedError(self.set_stacked_on_url)
772
567
 
773
568
    def _cache_revision_history(self, rev_history):
774
569
        """Set the cached revision history to rev_history.
802
597
        self._revision_id_to_revno_cache = None
803
598
        self._last_revision_info_cache = None
804
599
        self._merge_sorted_revisions_cache = None
805
 
        self._partial_revision_history_cache = []
806
 
        self._partial_revision_id_to_revno_cache = {}
807
600
 
808
601
    def _gen_revision_history(self):
809
602
        """Return sequence of revision hashes on to this branch.
848
641
        """Older format branches cannot bind or unbind."""
849
642
        raise errors.UpgradeRequired(self.base)
850
643
 
 
644
    def set_append_revisions_only(self, enabled):
 
645
        """Older format branches are never restricted to append-only"""
 
646
        raise errors.UpgradeRequired(self.base)
 
647
 
851
648
    def last_revision(self):
852
649
        """Return last revision id, or NULL_REVISION."""
853
650
        return self.last_revision_info()[1]
933
730
        except ValueError:
934
731
            raise errors.NoSuchRevision(self, revision_id)
935
732
 
936
 
    @needs_read_lock
937
733
    def get_rev_id(self, revno, history=None):
938
734
        """Find the revision id of the specified revno."""
939
735
        if revno == 0:
940
736
            return _mod_revision.NULL_REVISION
941
 
        last_revno, last_revid = self.last_revision_info()
942
 
        if revno == last_revno:
943
 
            return last_revid
944
 
        if revno <= 0 or revno > last_revno:
 
737
        if history is None:
 
738
            history = self.revision_history()
 
739
        if revno <= 0 or revno > len(history):
945
740
            raise errors.NoSuchRevision(self, revno)
946
 
        distance_from_last = last_revno - revno
947
 
        if len(self._partial_revision_history_cache) <= distance_from_last:
948
 
            self._extend_partial_history(distance_from_last)
949
 
        return self._partial_revision_history_cache[distance_from_last]
 
741
        return history[revno - 1]
950
742
 
951
 
    @needs_write_lock
952
743
    def pull(self, source, overwrite=False, stop_revision=None,
953
 
             possible_transports=None, *args, **kwargs):
 
744
             possible_transports=None, _override_hook_target=None):
954
745
        """Mirror source into this branch.
955
746
 
956
747
        This branch is considered to be 'local', having low latency.
957
748
 
958
749
        :returns: PullResult instance
959
750
        """
960
 
        return InterBranch.get(source, self).pull(overwrite=overwrite,
961
 
            stop_revision=stop_revision,
962
 
            possible_transports=possible_transports, *args, **kwargs)
 
751
        raise NotImplementedError(self.pull)
963
752
 
964
 
    def push(self, target, overwrite=False, stop_revision=None, *args,
965
 
        **kwargs):
 
753
    def push(self, target, overwrite=False, stop_revision=None):
966
754
        """Mirror this branch into target.
967
755
 
968
756
        This branch is considered to be 'local', having low latency.
969
757
        """
970
 
        return InterBranch.get(self, target).push(overwrite, stop_revision,
971
 
            *args, **kwargs)
972
 
 
973
 
    def lossy_push(self, target, stop_revision=None):
974
 
        """Push deltas into another branch.
975
 
 
976
 
        :note: This does not, like push, retain the revision ids from 
977
 
            the source branch and will, rather than adding bzr-specific 
978
 
            metadata, push only those semantics of the revision that can be 
979
 
            natively represented by this branch' VCS.
980
 
 
981
 
        :param target: Target branch
982
 
        :param stop_revision: Revision to push, defaults to last revision.
983
 
        :return: BranchPushResult with an extra member revidmap: 
984
 
            A dictionary mapping revision ids from the target branch 
985
 
            to new revision ids in the target branch, for each 
986
 
            revision that was pushed.
987
 
        """
988
 
        inter = InterBranch.get(self, target)
989
 
        lossy_push = getattr(inter, "lossy_push", None)
990
 
        if lossy_push is None:
991
 
            raise errors.LossyPushToSameVCS(self, target)
992
 
        return lossy_push(stop_revision)
 
758
        raise NotImplementedError(self.push)
993
759
 
994
760
    def basis_tree(self):
995
761
        """Return `Tree` object for last revision."""
1035
801
            location = None
1036
802
        return location
1037
803
 
1038
 
    def get_child_submit_format(self):
1039
 
        """Return the preferred format of submissions to this branch."""
1040
 
        return self.get_config().get_user_option("child_submit_format")
1041
 
 
1042
804
    def get_submit_branch(self):
1043
805
        """Return the submit location of the branch.
1044
806
 
1061
823
    def get_public_branch(self):
1062
824
        """Return the public location of the branch.
1063
825
 
1064
 
        This is used by merge directives.
 
826
        This is is used by merge directives.
1065
827
        """
1066
828
        return self._get_config_location('public_branch')
1067
829
 
1103
865
        params = ChangeBranchTipParams(
1104
866
            self, old_revno, new_revno, old_revid, new_revid)
1105
867
        for hook in hooks:
1106
 
            hook(params)
 
868
            try:
 
869
                hook(params)
 
870
            except errors.TipChangeRejected:
 
871
                raise
 
872
            except Exception:
 
873
                exc_info = sys.exc_info()
 
874
                hook_name = Branch.hooks.get_hook_name(hook)
 
875
                raise errors.HookFailed(
 
876
                    'pre_change_branch_tip', hook_name, exc_info)
 
877
 
 
878
    def set_parent(self, url):
 
879
        raise NotImplementedError(self.set_parent)
1107
880
 
1108
881
    @needs_write_lock
1109
882
    def update(self):
1140
913
                     be truncated to end with revision_id.
1141
914
        """
1142
915
        result = to_bzrdir.create_branch()
1143
 
        result.lock_write()
1144
 
        try:
1145
 
            if repository_policy is not None:
1146
 
                repository_policy.configure_branch(result)
1147
 
            self.copy_content_into(result, revision_id=revision_id)
1148
 
        finally:
1149
 
            result.unlock()
1150
 
        return result
 
916
        if repository_policy is not None:
 
917
            repository_policy.configure_branch(result)
 
918
        self.copy_content_into(result, revision_id=revision_id)
 
919
        return  result
1151
920
 
1152
921
    @needs_read_lock
1153
922
    def sprout(self, to_bzrdir, revision_id=None, repository_policy=None):
1158
927
        revision_id: if not None, the revision history in the new branch will
1159
928
                     be truncated to end with revision_id.
1160
929
        """
1161
 
        if (repository_policy is not None and
1162
 
            repository_policy.requires_stacking()):
1163
 
            to_bzrdir._format.require_stacking(_skip_repo=True)
1164
930
        result = to_bzrdir.create_branch()
1165
 
        result.lock_write()
1166
 
        try:
1167
 
            if repository_policy is not None:
1168
 
                repository_policy.configure_branch(result)
1169
 
            self.copy_content_into(result, revision_id=revision_id)
1170
 
            result.set_parent(self.bzrdir.root_transport.base)
1171
 
        finally:
1172
 
            result.unlock()
 
931
        if repository_policy is not None:
 
932
            repository_policy.configure_branch(result)
 
933
        self.copy_content_into(result, revision_id=revision_id)
 
934
        result.set_parent(self.bzrdir.root_transport.base)
1173
935
        return result
1174
936
 
1175
937
    def _synchronize_history(self, destination, revision_id):
1187
949
        source_revno, source_revision_id = self.last_revision_info()
1188
950
        if revision_id is None:
1189
951
            revno, revision_id = source_revno, source_revision_id
 
952
        elif source_revision_id == revision_id:
 
953
            # we know the revno without needing to walk all of history
 
954
            revno = source_revno
1190
955
        else:
1191
 
            graph = self.repository.get_graph()
1192
 
            try:
1193
 
                revno = graph.find_distance_to_null(revision_id, 
1194
 
                    [(source_revision_id, source_revno)])
1195
 
            except errors.GhostRevisionsHaveNoRevno:
1196
 
                # Default to 1, if we can't find anything else
1197
 
                revno = 1
 
956
            # To figure out the revno for a random revision, we need to build
 
957
            # the revision history, and count its length.
 
958
            # We don't care about the order, just how long it is.
 
959
            # Alternatively, we could start at the current location, and count
 
960
            # backwards. But there is no guarantee that we will find it since
 
961
            # it may be a merged revision.
 
962
            revno = len(list(self.repository.iter_reverse_revision_history(
 
963
                                                                revision_id)))
1198
964
        destination.set_last_revision_info(revno, revision_id)
1199
965
 
1200
966
    @needs_read_lock
1204
970
        revision_id: if not None, the revision history in the new branch will
1205
971
                     be truncated to end with revision_id.
1206
972
        """
1207
 
        self.update_references(destination)
1208
973
        self._synchronize_history(destination, revision_id)
1209
974
        try:
1210
975
            parent = self.get_parent()
1216
981
        if self._push_should_merge_tags():
1217
982
            self.tags.merge_to(destination.tags)
1218
983
 
1219
 
    def update_references(self, target):
1220
 
        if not getattr(self._format, 'supports_reference_locations', False):
1221
 
            return
1222
 
        reference_dict = self._get_all_reference_info()
1223
 
        if len(reference_dict) == 0:
1224
 
            return
1225
 
        old_base = self.base
1226
 
        new_base = target.base
1227
 
        target_reference_dict = target._get_all_reference_info()
1228
 
        for file_id, (tree_path, branch_location) in (
1229
 
            reference_dict.items()):
1230
 
            branch_location = urlutils.rebase_url(branch_location,
1231
 
                                                  old_base, new_base)
1232
 
            target_reference_dict.setdefault(
1233
 
                file_id, (tree_path, branch_location))
1234
 
        target._set_all_reference_info(target_reference_dict)
1235
 
 
1236
984
    @needs_read_lock
1237
 
    def check(self, refs):
 
985
    def check(self):
1238
986
        """Check consistency of the branch.
1239
987
 
1240
988
        In particular this checks that revisions given in the revision-history
1243
991
 
1244
992
        Callers will typically also want to check the repository.
1245
993
 
1246
 
        :param refs: Calculated refs for this branch as specified by
1247
 
            branch._get_check_refs()
1248
994
        :return: A BranchCheckResult.
1249
995
        """
1250
 
        result = BranchCheckResult(self)
 
996
        mainline_parent_id = None
1251
997
        last_revno, last_revision_id = self.last_revision_info()
1252
 
        actual_revno = refs[('lefthand-distance', last_revision_id)]
1253
 
        if actual_revno != last_revno:
1254
 
            result.errors.append(errors.BzrCheckError(
1255
 
                'revno does not match len(mainline) %s != %s' % (
1256
 
                last_revno, actual_revno)))
1257
 
        # TODO: We should probably also check that self.revision_history
1258
 
        # matches the repository for older branch formats.
1259
 
        # If looking for the code that cross-checks repository parents against
1260
 
        # the iter_reverse_revision_history output, that is now a repository
1261
 
        # specific check.
1262
 
        return result
 
998
        real_rev_history = list(self.repository.iter_reverse_revision_history(
 
999
                                last_revision_id))
 
1000
        real_rev_history.reverse()
 
1001
        if len(real_rev_history) != last_revno:
 
1002
            raise errors.BzrCheckError('revno does not match len(mainline)'
 
1003
                ' %s != %s' % (last_revno, len(real_rev_history)))
 
1004
        # TODO: We should probably also check that real_rev_history actually
 
1005
        #       matches self.revision_history()
 
1006
        for revision_id in real_rev_history:
 
1007
            try:
 
1008
                revision = self.repository.get_revision(revision_id)
 
1009
            except errors.NoSuchRevision, e:
 
1010
                raise errors.BzrCheckError("mainline revision {%s} not in repository"
 
1011
                            % revision_id)
 
1012
            # In general the first entry on the revision history has no parents.
 
1013
            # But it's not illegal for it to have parents listed; this can happen
 
1014
            # in imports from Arch when the parents weren't reachable.
 
1015
            if mainline_parent_id is not None:
 
1016
                if mainline_parent_id not in revision.parent_ids:
 
1017
                    raise errors.BzrCheckError("previous revision {%s} not listed among "
 
1018
                                        "parents of {%s}"
 
1019
                                        % (mainline_parent_id, revision_id))
 
1020
            mainline_parent_id = revision_id
 
1021
        return BranchCheckResult(self)
1263
1022
 
1264
1023
    def _get_checkout_format(self):
1265
1024
        """Return the most suitable metadir for a checkout of this branch.
1275
1034
        return format
1276
1035
 
1277
1036
    def create_clone_on_transport(self, to_transport, revision_id=None,
1278
 
        stacked_on=None, create_prefix=False, use_existing_dir=False):
 
1037
        stacked_on=None):
1279
1038
        """Create a clone of this branch and its bzrdir.
1280
1039
 
1281
1040
        :param to_transport: The transport to clone onto.
1282
1041
        :param revision_id: The revision id to use as tip in the new branch.
1283
1042
            If None the tip is obtained from this branch.
1284
1043
        :param stacked_on: An optional URL to stack the clone on.
1285
 
        :param create_prefix: Create any missing directories leading up to
1286
 
            to_transport.
1287
 
        :param use_existing_dir: Use an existing directory if one exists.
1288
1044
        """
1289
1045
        # XXX: Fix the bzrdir API to allow getting the branch back from the
1290
1046
        # clone call. Or something. 20090224 RBC/spiv.
1291
 
        if revision_id is None:
1292
 
            revision_id = self.last_revision()
1293
1047
        dir_to = self.bzrdir.clone_on_transport(to_transport,
1294
 
            revision_id=revision_id, stacked_on=stacked_on,
1295
 
            create_prefix=create_prefix, use_existing_dir=use_existing_dir)
 
1048
            revision_id=revision_id, stacked_on=stacked_on)
1296
1049
        return dir_to.open_branch()
1297
1050
 
1298
1051
    def create_checkout(self, to_location, revision_id=None,
1352
1105
        reconciler.reconcile()
1353
1106
        return reconciler
1354
1107
 
1355
 
    def reference_parent(self, file_id, path, possible_transports=None):
 
1108
    def reference_parent(self, file_id, path):
1356
1109
        """Return the parent branch for a tree-reference file_id
1357
1110
        :param file_id: The file_id of the tree reference
1358
1111
        :param path: The path of the file_id in the tree
1359
1112
        :return: A branch associated with the file_id
1360
1113
        """
1361
1114
        # FIXME should provide multiple branches, based on config
1362
 
        return Branch.open(self.bzrdir.root_transport.clone(path).base,
1363
 
                           possible_transports=possible_transports)
 
1115
        return Branch.open(self.bzrdir.root_transport.clone(path).base)
1364
1116
 
1365
1117
    def supports_tags(self):
1366
1118
        return self._format.supports_tags()
1425
1177
    _formats = {}
1426
1178
    """The known formats."""
1427
1179
 
1428
 
    can_set_append_revisions_only = True
1429
 
 
1430
1180
    def __eq__(self, other):
1431
1181
        return self.__class__ is other.__class__
1432
1182
 
1438
1188
        """Return the format for the branch object in a_bzrdir."""
1439
1189
        try:
1440
1190
            transport = a_bzrdir.get_branch_transport(None)
1441
 
            format_string = transport.get_bytes("format")
 
1191
            format_string = transport.get("format").read()
1442
1192
            return klass._formats[format_string]
1443
1193
        except errors.NoSuchFile:
1444
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1194
            raise errors.NotBranchError(path=transport.base)
1445
1195
        except KeyError:
1446
1196
            raise errors.UnknownFormatError(format=format_string, kind='branch')
1447
1197
 
1505
1255
        control_files = lockable_files.LockableFiles(branch_transport,
1506
1256
            lock_name, lock_class)
1507
1257
        control_files.create_lock()
1508
 
        try:
1509
 
            control_files.lock_write()
1510
 
        except errors.LockContention:
1511
 
            if lock_type != 'branch4':
1512
 
                raise
1513
 
            lock_taken = False
1514
 
        else:
1515
 
            lock_taken = True
 
1258
        control_files.lock_write()
1516
1259
        if set_format:
1517
1260
            utf8_files += [('format', self.get_format_string())]
1518
1261
        try:
1521
1264
                    filename, content,
1522
1265
                    mode=a_bzrdir._get_file_mode())
1523
1266
        finally:
1524
 
            if lock_taken:
1525
 
                control_files.unlock()
 
1267
            control_files.unlock()
1526
1268
        return self.open(a_bzrdir, _found=True)
1527
1269
 
1528
1270
    def initialize(self, a_bzrdir):
1538
1280
        """
1539
1281
        return True
1540
1282
 
1541
 
    def make_tags(self, branch):
1542
 
        """Create a tags object for branch.
1543
 
 
1544
 
        This method is on BranchFormat, because BranchFormats are reflected
1545
 
        over the wire via network_name(), whereas full Branch instances require
1546
 
        multiple VFS method calls to operate at all.
1547
 
 
1548
 
        The default implementation returns a disabled-tags instance.
1549
 
 
1550
 
        Note that it is normal for branch to be a RemoteBranch when using tags
1551
 
        on a RemoteBranch.
1552
 
        """
1553
 
        return DisabledTags(branch)
1554
 
 
1555
1283
    def network_name(self):
1556
1284
        """A simple byte string uniquely identifying this format for RPC calls.
1557
1285
 
1562
1290
        """
1563
1291
        raise NotImplementedError(self.network_name)
1564
1292
 
1565
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
 
1293
    def open(self, a_bzrdir, _found=False):
1566
1294
        """Return the branch object for a_bzrdir
1567
1295
 
1568
 
        :param a_bzrdir: A BzrDir that contains a branch.
1569
 
        :param _found: a private parameter, do not use it. It is used to
1570
 
            indicate if format probing has already be done.
1571
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
1572
 
            (if there are any).  Default is to open fallbacks.
 
1296
        _found is a private parameter, do not use it. It is used to indicate
 
1297
               if format probing has already be done.
1573
1298
        """
1574
1299
        raise NotImplementedError(self.open)
1575
1300
 
1585
1310
    def set_default_format(klass, format):
1586
1311
        klass._default_format = format
1587
1312
 
1588
 
    def supports_set_append_revisions_only(self):
1589
 
        """True if this format supports set_append_revisions_only."""
1590
 
        return False
1591
 
 
1592
1313
    def supports_stacking(self):
1593
1314
        """True if this format records a stacked-on branch."""
1594
1315
        return False
1619
1340
        notified.
1620
1341
        """
1621
1342
        Hooks.__init__(self)
1622
 
        self.create_hook(HookPoint('set_rh',
1623
 
            "Invoked whenever the revision history has been set via "
1624
 
            "set_revision_history. The api signature is (branch, "
1625
 
            "revision_history), and the branch will be write-locked. "
1626
 
            "The set_rh hook can be expensive for bzr to trigger, a better "
1627
 
            "hook to use is Branch.post_change_branch_tip.", (0, 15), None))
1628
 
        self.create_hook(HookPoint('open',
1629
 
            "Called with the Branch object that has been opened after a "
1630
 
            "branch is opened.", (1, 8), None))
1631
 
        self.create_hook(HookPoint('post_push',
1632
 
            "Called after a push operation completes. post_push is called "
1633
 
            "with a bzrlib.branch.BranchPushResult object and only runs in the "
1634
 
            "bzr client.", (0, 15), None))
1635
 
        self.create_hook(HookPoint('post_pull',
1636
 
            "Called after a pull operation completes. post_pull is called "
1637
 
            "with a bzrlib.branch.PullResult object and only runs in the "
1638
 
            "bzr client.", (0, 15), None))
1639
 
        self.create_hook(HookPoint('pre_commit',
1640
 
            "Called after a commit is calculated but before it is is "
1641
 
            "completed. pre_commit is called with (local, master, old_revno, "
1642
 
            "old_revid, future_revno, future_revid, tree_delta, future_tree"
1643
 
            "). old_revid is NULL_REVISION for the first commit to a branch, "
1644
 
            "tree_delta is a TreeDelta object describing changes from the "
1645
 
            "basis revision. hooks MUST NOT modify this delta. "
1646
 
            " future_tree is an in-memory tree obtained from "
1647
 
            "CommitBuilder.revision_tree() and hooks MUST NOT modify this "
1648
 
            "tree.", (0,91), None))
1649
 
        self.create_hook(HookPoint('post_commit',
1650
 
            "Called in the bzr client after a commit has completed. "
1651
 
            "post_commit is called with (local, master, old_revno, old_revid, "
1652
 
            "new_revno, new_revid). old_revid is NULL_REVISION for the first "
1653
 
            "commit to a branch.", (0, 15), None))
1654
 
        self.create_hook(HookPoint('post_uncommit',
1655
 
            "Called in the bzr client after an uncommit completes. "
1656
 
            "post_uncommit is called with (local, master, old_revno, "
1657
 
            "old_revid, new_revno, new_revid) where local is the local branch "
1658
 
            "or None, master is the target branch, and an empty branch "
1659
 
            "receives new_revno of 0, new_revid of None.", (0, 15), None))
1660
 
        self.create_hook(HookPoint('pre_change_branch_tip',
1661
 
            "Called in bzr client and server before a change to the tip of a "
1662
 
            "branch is made. pre_change_branch_tip is called with a "
1663
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1664
 
            "commit, uncommit will all trigger this hook.", (1, 6), None))
1665
 
        self.create_hook(HookPoint('post_change_branch_tip',
1666
 
            "Called in bzr client and server after a change to the tip of a "
1667
 
            "branch is made. post_change_branch_tip is called with a "
1668
 
            "bzrlib.branch.ChangeBranchTipParams. Note that push, pull, "
1669
 
            "commit, uncommit will all trigger this hook.", (1, 4), None))
1670
 
        self.create_hook(HookPoint('transform_fallback_location',
1671
 
            "Called when a stacked branch is activating its fallback "
1672
 
            "locations. transform_fallback_location is called with (branch, "
1673
 
            "url), and should return a new url. Returning the same url "
1674
 
            "allows it to be used as-is, returning a different one can be "
1675
 
            "used to cause the branch to stack on a closer copy of that "
1676
 
            "fallback_location. Note that the branch cannot have history "
1677
 
            "accessing methods called on it during this hook because the "
1678
 
            "fallback locations have not been activated. When there are "
1679
 
            "multiple hooks installed for transform_fallback_location, "
1680
 
            "all are called with the url returned from the previous hook."
1681
 
            "The order is however undefined.", (1, 9), None))
 
1343
        # Introduced in 0.15:
 
1344
        # invoked whenever the revision history has been set
 
1345
        # with set_revision_history. The api signature is
 
1346
        # (branch, revision_history), and the branch will
 
1347
        # be write-locked.
 
1348
        self['set_rh'] = []
 
1349
        # Invoked after a branch is opened. The api signature is (branch).
 
1350
        self['open'] = []
 
1351
        # invoked after a push operation completes.
 
1352
        # the api signature is
 
1353
        # (push_result)
 
1354
        # containing the members
 
1355
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1356
        # where local is the local target branch or None, master is the target
 
1357
        # master branch, and the rest should be self explanatory. The source
 
1358
        # is read locked and the target branches write locked. Source will
 
1359
        # be the local low-latency branch.
 
1360
        self['post_push'] = []
 
1361
        # invoked after a pull operation completes.
 
1362
        # the api signature is
 
1363
        # (pull_result)
 
1364
        # containing the members
 
1365
        # (source, local, master, old_revno, old_revid, new_revno, new_revid)
 
1366
        # where local is the local branch or None, master is the target
 
1367
        # master branch, and the rest should be self explanatory. The source
 
1368
        # is read locked and the target branches write locked. The local
 
1369
        # branch is the low-latency branch.
 
1370
        self['post_pull'] = []
 
1371
        # invoked before a commit operation takes place.
 
1372
        # the api signature is
 
1373
        # (local, master, old_revno, old_revid, future_revno, future_revid,
 
1374
        #  tree_delta, future_tree).
 
1375
        # old_revid is NULL_REVISION for the first commit to a branch
 
1376
        # tree_delta is a TreeDelta object describing changes from the basis
 
1377
        # revision, hooks MUST NOT modify this delta
 
1378
        # future_tree is an in-memory tree obtained from
 
1379
        # CommitBuilder.revision_tree() and hooks MUST NOT modify this tree
 
1380
        self['pre_commit'] = []
 
1381
        # invoked after a commit operation completes.
 
1382
        # the api signature is
 
1383
        # (local, master, old_revno, old_revid, new_revno, new_revid)
 
1384
        # old_revid is NULL_REVISION for the first commit to a branch.
 
1385
        self['post_commit'] = []
 
1386
        # invoked after a uncommit operation completes.
 
1387
        # the api signature is
 
1388
        # (local, master, old_revno, old_revid, new_revno, new_revid) where
 
1389
        # local is the local branch or None, master is the target branch,
 
1390
        # and an empty branch recieves new_revno of 0, new_revid of None.
 
1391
        self['post_uncommit'] = []
 
1392
        # Introduced in 1.6
 
1393
        # Invoked before the tip of a branch changes.
 
1394
        # the api signature is
 
1395
        # (params) where params is a ChangeBranchTipParams with the members
 
1396
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1397
        self['pre_change_branch_tip'] = []
 
1398
        # Introduced in 1.4
 
1399
        # Invoked after the tip of a branch changes.
 
1400
        # the api signature is
 
1401
        # (params) where params is a ChangeBranchTipParams with the members
 
1402
        # (branch, old_revno, new_revno, old_revid, new_revid)
 
1403
        self['post_change_branch_tip'] = []
 
1404
        # Introduced in 1.9
 
1405
        # Invoked when a stacked branch activates its fallback locations and
 
1406
        # allows the transformation of the url of said location.
 
1407
        # the api signature is
 
1408
        # (branch, url) where branch is the branch having its fallback
 
1409
        # location activated and url is the url for the fallback location.
 
1410
        # The hook should return a url.
 
1411
        self['transform_fallback_location'] = []
1682
1412
 
1683
1413
 
1684
1414
# install the default hooks into the Branch class.
1751
1481
        """The network name for this format is the control dirs disk label."""
1752
1482
        return self._matchingbzrdir.get_format_string()
1753
1483
 
1754
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1755
 
        """See BranchFormat.open()."""
 
1484
    def open(self, a_bzrdir, _found=False):
 
1485
        """Return the branch object for a_bzrdir
 
1486
 
 
1487
        _found is a private parameter, do not use it. It is used to indicate
 
1488
               if format probing has already be done.
 
1489
        """
1756
1490
        if not _found:
1757
1491
            # we are being called directly and must probe.
1758
1492
            raise NotImplementedError
1779
1513
        """
1780
1514
        return self.get_format_string()
1781
1515
 
1782
 
    def open(self, a_bzrdir, _found=False, ignore_fallbacks=False):
1783
 
        """See BranchFormat.open()."""
 
1516
    def open(self, a_bzrdir, _found=False):
 
1517
        """Return the branch object for a_bzrdir.
 
1518
 
 
1519
        _found is a private parameter, do not use it. It is used to indicate
 
1520
               if format probing has already be done.
 
1521
        """
1784
1522
        if not _found:
1785
1523
            format = BranchFormat.find_format(a_bzrdir)
1786
1524
            if format.__class__ != self.__class__:
1793
1531
            return self._branch_class()(_format=self,
1794
1532
                              _control_files=control_files,
1795
1533
                              a_bzrdir=a_bzrdir,
1796
 
                              _repository=a_bzrdir.find_repository(),
1797
 
                              ignore_fallbacks=ignore_fallbacks)
 
1534
                              _repository=a_bzrdir.find_repository())
1798
1535
        except errors.NoSuchFile:
1799
 
            raise errors.NotBranchError(path=transport.base, bzrdir=a_bzrdir)
 
1536
            raise errors.NotBranchError(path=transport.base)
1800
1537
 
1801
1538
    def __init__(self):
1802
1539
        super(BranchFormatMetadir, self).__init__()
1872
1609
                      ]
1873
1610
        return self._initialize_helper(a_bzrdir, utf8_files)
1874
1611
 
1875
 
    def make_tags(self, branch):
1876
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1877
 
        return BasicTags(branch)
1878
 
 
1879
 
    def supports_set_append_revisions_only(self):
1880
 
        return True
1881
 
 
1882
 
 
1883
 
class BzrBranchFormat8(BranchFormatMetadir):
1884
 
    """Metadir format supporting storing locations of subtree branches."""
1885
 
 
1886
 
    def _branch_class(self):
1887
 
        return BzrBranch8
1888
 
 
1889
 
    def get_format_string(self):
1890
 
        """See BranchFormat.get_format_string()."""
1891
 
        return "Bazaar Branch Format 8 (needs bzr 1.15)\n"
1892
 
 
1893
 
    def get_format_description(self):
1894
 
        """See BranchFormat.get_format_description()."""
1895
 
        return "Branch format 8"
1896
 
 
1897
 
    def initialize(self, a_bzrdir):
1898
 
        """Create a branch of this format in a_bzrdir."""
1899
 
        utf8_files = [('last-revision', '0 null:\n'),
1900
 
                      ('branch.conf', ''),
1901
 
                      ('tags', ''),
1902
 
                      ('references', '')
1903
 
                      ]
1904
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1905
 
 
1906
 
    def __init__(self):
1907
 
        super(BzrBranchFormat8, self).__init__()
1908
 
        self._matchingbzrdir.repository_format = \
1909
 
            RepositoryFormatKnitPack5RichRoot()
1910
 
 
1911
 
    def make_tags(self, branch):
1912
 
        """See bzrlib.branch.BranchFormat.make_tags()."""
1913
 
        return BasicTags(branch)
1914
 
 
1915
 
    def supports_set_append_revisions_only(self):
1916
 
        return True
1917
 
 
1918
 
    def supports_stacking(self):
1919
 
        return True
1920
 
 
1921
 
    supports_reference_locations = True
1922
 
 
1923
 
 
1924
 
class BzrBranchFormat7(BzrBranchFormat8):
 
1612
 
 
1613
class BzrBranchFormat7(BranchFormatMetadir):
1925
1614
    """Branch format with last-revision, tags, and a stacked location pointer.
1926
1615
 
1927
1616
    The stacked location pointer is passed down to the repository and requires
1930
1619
    This format was introduced in bzr 1.6.
1931
1620
    """
1932
1621
 
1933
 
    def initialize(self, a_bzrdir):
1934
 
        """Create a branch of this format in a_bzrdir."""
1935
 
        utf8_files = [('last-revision', '0 null:\n'),
1936
 
                      ('branch.conf', ''),
1937
 
                      ('tags', ''),
1938
 
                      ]
1939
 
        return self._initialize_helper(a_bzrdir, utf8_files)
1940
 
 
1941
1622
    def _branch_class(self):
1942
1623
        return BzrBranch7
1943
1624
 
1949
1630
        """See BranchFormat.get_format_description()."""
1950
1631
        return "Branch format 7"
1951
1632
 
1952
 
    def supports_set_append_revisions_only(self):
 
1633
    def initialize(self, a_bzrdir):
 
1634
        """Create a branch of this format in a_bzrdir."""
 
1635
        utf8_files = [('last-revision', '0 null:\n'),
 
1636
                      ('branch.conf', ''),
 
1637
                      ('tags', ''),
 
1638
                      ]
 
1639
        return self._initialize_helper(a_bzrdir, utf8_files)
 
1640
 
 
1641
    def __init__(self):
 
1642
        super(BzrBranchFormat7, self).__init__()
 
1643
        self._matchingbzrdir.repository_format = \
 
1644
            RepositoryFormatKnitPack5RichRoot()
 
1645
 
 
1646
    def supports_stacking(self):
1953
1647
        return True
1954
1648
 
1955
 
    supports_reference_locations = False
1956
 
 
1957
1649
 
1958
1650
class BranchReferenceFormat(BranchFormat):
1959
1651
    """Bzr branch reference format.
1977
1669
    def get_reference(self, a_bzrdir):
1978
1670
        """See BranchFormat.get_reference()."""
1979
1671
        transport = a_bzrdir.get_branch_transport(None)
1980
 
        return transport.get_bytes('location')
 
1672
        return transport.get('location').read()
1981
1673
 
1982
1674
    def set_reference(self, a_bzrdir, to_branch):
1983
1675
        """See BranchFormat.set_reference()."""
2016
1708
        return clone
2017
1709
 
2018
1710
    def open(self, a_bzrdir, _found=False, location=None,
2019
 
             possible_transports=None, ignore_fallbacks=False):
 
1711
             possible_transports=None):
2020
1712
        """Return the branch that the branch reference in a_bzrdir points at.
2021
1713
 
2022
 
        :param a_bzrdir: A BzrDir that contains a branch.
2023
 
        :param _found: a private parameter, do not use it. It is used to
2024
 
            indicate if format probing has already be done.
2025
 
        :param ignore_fallbacks: when set, no fallback branches will be opened
2026
 
            (if there are any).  Default is to open fallbacks.
2027
 
        :param location: The location of the referenced branch.  If
2028
 
            unspecified, this will be determined from the branch reference in
2029
 
            a_bzrdir.
2030
 
        :param possible_transports: An optional reusable transports list.
 
1714
        _found is a private parameter, do not use it. It is used to indicate
 
1715
               if format probing has already be done.
2031
1716
        """
2032
1717
        if not _found:
2033
1718
            format = BranchFormat.find_format(a_bzrdir)
2038
1723
            location = self.get_reference(a_bzrdir)
2039
1724
        real_bzrdir = bzrdir.BzrDir.open(
2040
1725
            location, possible_transports=possible_transports)
2041
 
        result = real_bzrdir.open_branch(ignore_fallbacks=ignore_fallbacks)
 
1726
        result = real_bzrdir.open_branch()
2042
1727
        # this changes the behaviour of result.clone to create a new reference
2043
1728
        # rather than a copy of the content of the branch.
2044
1729
        # I did not use a proxy object because that needs much more extensive
2065
1750
__format5 = BzrBranchFormat5()
2066
1751
__format6 = BzrBranchFormat6()
2067
1752
__format7 = BzrBranchFormat7()
2068
 
__format8 = BzrBranchFormat8()
2069
1753
BranchFormat.register_format(__format5)
2070
1754
BranchFormat.register_format(BranchReferenceFormat())
2071
1755
BranchFormat.register_format(__format6)
2072
1756
BranchFormat.register_format(__format7)
2073
 
BranchFormat.register_format(__format8)
2074
 
BranchFormat.set_default_format(__format7)
 
1757
BranchFormat.set_default_format(__format6)
2075
1758
_legacy_formats = [BzrBranchFormat4(),
2076
1759
    ]
2077
1760
network_format_registry.register(
2078
1761
    _legacy_formats[0].network_name(), _legacy_formats[0].__class__)
2079
1762
 
2080
1763
 
2081
 
class BzrBranch(Branch, _RelockDebugMixin):
 
1764
class BzrBranch(Branch):
2082
1765
    """A branch stored in the actual filesystem.
2083
1766
 
2084
1767
    Note that it's "local" in the context of the filesystem; it doesn't
2093
1776
    """
2094
1777
 
2095
1778
    def __init__(self, _format=None,
2096
 
                 _control_files=None, a_bzrdir=None, _repository=None,
2097
 
                 ignore_fallbacks=False):
 
1779
                 _control_files=None, a_bzrdir=None, _repository=None):
2098
1780
        """Create new branch object at a particular location."""
2099
1781
        if a_bzrdir is None:
2100
1782
            raise ValueError('a_bzrdir must be supplied')
2123
1805
 
2124
1806
    base = property(_get_base, doc="The URL for the root of this branch.")
2125
1807
 
2126
 
    def _get_config(self):
2127
 
        return TransportConfig(self._transport, 'branch.conf')
2128
 
 
2129
1808
    def is_locked(self):
2130
1809
        return self.control_files.is_locked()
2131
1810
 
2132
1811
    def lock_write(self, token=None):
2133
 
        if not self.is_locked():
2134
 
            self._note_lock('w')
2135
 
        # All-in-one needs to always unlock/lock.
2136
 
        repo_control = getattr(self.repository, 'control_files', None)
2137
 
        if self.control_files == repo_control or not self.is_locked():
2138
 
            self.repository._warn_if_deprecated(self)
2139
 
            self.repository.lock_write()
2140
 
            took_lock = True
2141
 
        else:
2142
 
            took_lock = False
 
1812
        repo_token = self.repository.lock_write()
2143
1813
        try:
2144
 
            return self.control_files.lock_write(token=token)
 
1814
            token = self.control_files.lock_write(token=token)
2145
1815
        except:
2146
 
            if took_lock:
2147
 
                self.repository.unlock()
 
1816
            self.repository.unlock()
2148
1817
            raise
 
1818
        return token
2149
1819
 
2150
1820
    def lock_read(self):
2151
 
        if not self.is_locked():
2152
 
            self._note_lock('r')
2153
 
        # All-in-one needs to always unlock/lock.
2154
 
        repo_control = getattr(self.repository, 'control_files', None)
2155
 
        if self.control_files == repo_control or not self.is_locked():
2156
 
            self.repository._warn_if_deprecated(self)
2157
 
            self.repository.lock_read()
2158
 
            took_lock = True
2159
 
        else:
2160
 
            took_lock = False
 
1821
        self.repository.lock_read()
2161
1822
        try:
2162
1823
            self.control_files.lock_read()
2163
1824
        except:
2164
 
            if took_lock:
2165
 
                self.repository.unlock()
 
1825
            self.repository.unlock()
2166
1826
            raise
2167
1827
 
2168
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
2169
1828
    def unlock(self):
 
1829
        # TODO: test for failed two phase locks. This is known broken.
2170
1830
        try:
2171
1831
            self.control_files.unlock()
2172
1832
        finally:
2173
 
            # All-in-one needs to always unlock/lock.
2174
 
            repo_control = getattr(self.repository, 'control_files', None)
2175
 
            if (self.control_files == repo_control or
2176
 
                not self.control_files.is_locked()):
2177
 
                self.repository.unlock()
2178
 
            if not self.control_files.is_locked():
2179
 
                # we just released the lock
2180
 
                self._clear_cached_state()
 
1833
            self.repository.unlock()
 
1834
        if not self.control_files.is_locked():
 
1835
            # we just released the lock
 
1836
            self._clear_cached_state()
2181
1837
 
2182
1838
    def peek_lock_mode(self):
2183
1839
        if self.control_files._lock_count == 0:
2302
1958
        """See Branch.basis_tree."""
2303
1959
        return self.repository.revision_tree(self.last_revision())
2304
1960
 
 
1961
    @needs_write_lock
 
1962
    def pull(self, source, overwrite=False, stop_revision=None,
 
1963
             _hook_master=None, run_hooks=True, possible_transports=None,
 
1964
             _override_hook_target=None):
 
1965
        """See Branch.pull.
 
1966
 
 
1967
        :param _hook_master: Private parameter - set the branch to
 
1968
            be supplied as the master to pull hooks.
 
1969
        :param run_hooks: Private parameter - if false, this branch
 
1970
            is being called because it's the master of the primary branch,
 
1971
            so it should not run its hooks.
 
1972
        :param _override_hook_target: Private parameter - set the branch to be
 
1973
            supplied as the target_branch to pull hooks.
 
1974
        """
 
1975
        result = PullResult()
 
1976
        result.source_branch = source
 
1977
        if _override_hook_target is None:
 
1978
            result.target_branch = self
 
1979
        else:
 
1980
            result.target_branch = _override_hook_target
 
1981
        source.lock_read()
 
1982
        try:
 
1983
            # We assume that during 'pull' the local repository is closer than
 
1984
            # the remote one.
 
1985
            graph = self.repository.get_graph(source.repository)
 
1986
            result.old_revno, result.old_revid = self.last_revision_info()
 
1987
            self.update_revisions(source, stop_revision, overwrite=overwrite,
 
1988
                                  graph=graph)
 
1989
            result.tag_conflicts = source.tags.merge_to(self.tags, overwrite)
 
1990
            result.new_revno, result.new_revid = self.last_revision_info()
 
1991
            if _hook_master:
 
1992
                result.master_branch = _hook_master
 
1993
                result.local_branch = result.target_branch
 
1994
            else:
 
1995
                result.master_branch = result.target_branch
 
1996
                result.local_branch = None
 
1997
            if run_hooks:
 
1998
                for hook in Branch.hooks['post_pull']:
 
1999
                    hook(result)
 
2000
        finally:
 
2001
            source.unlock()
 
2002
        return result
 
2003
 
2305
2004
    def _get_parent_location(self):
2306
2005
        _locs = ['parent', 'pull', 'x-pull']
2307
2006
        for l in _locs:
2311
2010
                pass
2312
2011
        return None
2313
2012
 
 
2013
    @needs_read_lock
 
2014
    def push(self, target, overwrite=False, stop_revision=None,
 
2015
             _override_hook_source_branch=None):
 
2016
        """See Branch.push.
 
2017
 
 
2018
        This is the basic concrete implementation of push()
 
2019
 
 
2020
        :param _override_hook_source_branch: If specified, run
 
2021
        the hooks passing this Branch as the source, rather than self.
 
2022
        This is for use of RemoteBranch, where push is delegated to the
 
2023
        underlying vfs-based Branch.
 
2024
        """
 
2025
        # TODO: Public option to disable running hooks - should be trivial but
 
2026
        # needs tests.
 
2027
        return _run_with_write_locked_target(
 
2028
            target, self._push_with_bound_branches, target, overwrite,
 
2029
            stop_revision,
 
2030
            _override_hook_source_branch=_override_hook_source_branch)
 
2031
 
 
2032
    def _push_with_bound_branches(self, target, overwrite,
 
2033
            stop_revision,
 
2034
            _override_hook_source_branch=None):
 
2035
        """Push from self into target, and into target's master if any.
 
2036
 
 
2037
        This is on the base BzrBranch class even though it doesn't support
 
2038
        bound branches because the *target* might be bound.
 
2039
        """
 
2040
        def _run_hooks():
 
2041
            if _override_hook_source_branch:
 
2042
                result.source_branch = _override_hook_source_branch
 
2043
            for hook in Branch.hooks['post_push']:
 
2044
                hook(result)
 
2045
 
 
2046
        bound_location = target.get_bound_location()
 
2047
        if bound_location and target.base != bound_location:
 
2048
            # there is a master branch.
 
2049
            #
 
2050
            # XXX: Why the second check?  Is it even supported for a branch to
 
2051
            # be bound to itself? -- mbp 20070507
 
2052
            master_branch = target.get_master_branch()
 
2053
            master_branch.lock_write()
 
2054
            try:
 
2055
                # push into the master from this branch.
 
2056
                self._basic_push(master_branch, overwrite, stop_revision)
 
2057
                # and push into the target branch from this. Note that we push from
 
2058
                # this branch again, because its considered the highest bandwidth
 
2059
                # repository.
 
2060
                result = self._basic_push(target, overwrite, stop_revision)
 
2061
                result.master_branch = master_branch
 
2062
                result.local_branch = target
 
2063
                _run_hooks()
 
2064
                return result
 
2065
            finally:
 
2066
                master_branch.unlock()
 
2067
        else:
 
2068
            # no master branch
 
2069
            result = self._basic_push(target, overwrite, stop_revision)
 
2070
            # TODO: Why set master_branch and local_branch if there's no
 
2071
            # binding?  Maybe cleaner to just leave them unset? -- mbp
 
2072
            # 20070504
 
2073
            result.master_branch = target
 
2074
            result.local_branch = None
 
2075
            _run_hooks()
 
2076
            return result
 
2077
 
2314
2078
    def _basic_push(self, target, overwrite, stop_revision):
2315
2079
        """Basic implementation of push without bound branches or hooks.
2316
2080
 
2317
 
        Must be called with source read locked and target write locked.
 
2081
        Must be called with self read locked and target write locked.
2318
2082
        """
2319
 
        result = BranchPushResult()
 
2083
        result = PushResult()
2320
2084
        result.source_branch = self
2321
2085
        result.target_branch = target
2322
2086
        result.old_revno, result.old_revid = target.last_revision_info()
2323
 
        self.update_references(target)
2324
2087
        if result.old_revid != self.last_revision():
2325
2088
            # We assume that during 'push' this repository is closer than
2326
2089
            # the target.
2327
2090
            graph = self.repository.get_graph(target.repository)
2328
 
            target.update_revisions(self, stop_revision,
2329
 
                overwrite=overwrite, graph=graph)
 
2091
            target.update_revisions(self, stop_revision, overwrite=overwrite,
 
2092
                                    graph=graph)
2330
2093
        if self._push_should_merge_tags():
2331
 
            result.tag_conflicts = self.tags.merge_to(target.tags,
2332
 
                overwrite)
 
2094
            result.tag_conflicts = self.tags.merge_to(target.tags, overwrite)
2333
2095
        result.new_revno, result.new_revid = target.last_revision_info()
2334
2096
        return result
2335
2097
 
2342
2104
            'push_location', location,
2343
2105
            store=_mod_config.STORE_LOCATION_NORECURSE)
2344
2106
 
 
2107
    @needs_write_lock
 
2108
    def set_parent(self, url):
 
2109
        """See Branch.set_parent."""
 
2110
        # TODO: Maybe delete old location files?
 
2111
        # URLs should never be unicode, even on the local fs,
 
2112
        # FIXUP this and get_parent in a future branch format bump:
 
2113
        # read and rewrite the file. RBC 20060125
 
2114
        if url is not None:
 
2115
            if isinstance(url, unicode):
 
2116
                try:
 
2117
                    url = url.encode('ascii')
 
2118
                except UnicodeEncodeError:
 
2119
                    raise errors.InvalidURL(url,
 
2120
                        "Urls must be 7-bit ascii, "
 
2121
                        "use bzrlib.urlutils.escape")
 
2122
            url = urlutils.relative_url(self.base, url)
 
2123
        self._set_parent_location(url)
 
2124
 
2345
2125
    def _set_parent_location(self, url):
2346
2126
        if url is None:
2347
2127
            self._transport.delete('parent')
2349
2129
            self._transport.put_bytes('parent', url + '\n',
2350
2130
                mode=self.bzrdir._get_file_mode())
2351
2131
 
 
2132
    def set_stacked_on_url(self, url):
 
2133
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2134
 
2352
2135
 
2353
2136
class BzrBranch5(BzrBranch):
2354
2137
    """A format 5 branch. This supports new features over plain branches.
2356
2139
    It has support for a master_branch which is the data for bound branches.
2357
2140
    """
2358
2141
 
 
2142
    @needs_write_lock
 
2143
    def pull(self, source, overwrite=False, stop_revision=None,
 
2144
             run_hooks=True, possible_transports=None,
 
2145
             _override_hook_target=None):
 
2146
        """Pull from source into self, updating my master if any.
 
2147
 
 
2148
        :param run_hooks: Private parameter - if false, this branch
 
2149
            is being called because it's the master of the primary branch,
 
2150
            so it should not run its hooks.
 
2151
        """
 
2152
        bound_location = self.get_bound_location()
 
2153
        master_branch = None
 
2154
        if bound_location and source.base != bound_location:
 
2155
            # not pulling from master, so we need to update master.
 
2156
            master_branch = self.get_master_branch(possible_transports)
 
2157
            master_branch.lock_write()
 
2158
        try:
 
2159
            if master_branch:
 
2160
                # pull from source into master.
 
2161
                master_branch.pull(source, overwrite, stop_revision,
 
2162
                    run_hooks=False)
 
2163
            return super(BzrBranch5, self).pull(source, overwrite,
 
2164
                stop_revision, _hook_master=master_branch,
 
2165
                run_hooks=run_hooks,
 
2166
                _override_hook_target=_override_hook_target)
 
2167
        finally:
 
2168
            if master_branch:
 
2169
                master_branch.unlock()
 
2170
 
2359
2171
    def get_bound_location(self):
2360
2172
        try:
2361
2173
            return self._transport.get_bytes('bound')[:-1]
2448
2260
        return None
2449
2261
 
2450
2262
 
2451
 
class BzrBranch8(BzrBranch5):
2452
 
    """A branch that stores tree-reference locations."""
 
2263
class BzrBranch7(BzrBranch5):
 
2264
    """A branch with support for a fallback repository."""
 
2265
 
 
2266
    def _get_fallback_repository(self, url):
 
2267
        """Get the repository we fallback to at url."""
 
2268
        url = urlutils.join(self.base, url)
 
2269
        a_bzrdir = bzrdir.BzrDir.open(url,
 
2270
                                      possible_transports=[self._transport])
 
2271
        return a_bzrdir.open_branch().repository
 
2272
 
 
2273
    def _activate_fallback_location(self, url):
 
2274
        """Activate the branch/repository from url as a fallback repository."""
 
2275
        self.repository.add_fallback_repository(
 
2276
            self._get_fallback_repository(url))
2453
2277
 
2454
2278
    def _open_hook(self):
2455
 
        if self._ignore_fallbacks:
2456
 
            return
2457
2279
        try:
2458
2280
            url = self.get_stacked_on_url()
2459
2281
        except (errors.UnstackableRepositoryFormat, errors.NotStacked,
2469
2291
                        "None, not a URL." % hook_name)
2470
2292
            self._activate_fallback_location(url)
2471
2293
 
 
2294
    def _check_stackable_repo(self):
 
2295
        if not self.repository._format.supports_external_lookups:
 
2296
            raise errors.UnstackableRepositoryFormat(self.repository._format,
 
2297
                self.repository.base)
 
2298
 
2472
2299
    def __init__(self, *args, **kwargs):
2473
 
        self._ignore_fallbacks = kwargs.get('ignore_fallbacks', False)
2474
 
        super(BzrBranch8, self).__init__(*args, **kwargs)
 
2300
        super(BzrBranch7, self).__init__(*args, **kwargs)
2475
2301
        self._last_revision_info_cache = None
2476
 
        self._reference_info = None
 
2302
        self._partial_revision_history_cache = []
2477
2303
 
2478
2304
    def _clear_cached_state(self):
2479
 
        super(BzrBranch8, self)._clear_cached_state()
 
2305
        super(BzrBranch7, self)._clear_cached_state()
2480
2306
        self._last_revision_info_cache = None
2481
 
        self._reference_info = None
 
2307
        self._partial_revision_history_cache = []
2482
2308
 
2483
2309
    def _last_revision_info(self):
2484
2310
        revision_string = self._transport.get_bytes('last-revision')
2539
2365
        self._extend_partial_history(stop_index=last_revno-1)
2540
2366
        return list(reversed(self._partial_revision_history_cache))
2541
2367
 
 
2368
    def _extend_partial_history(self, stop_index=None, stop_revision=None):
 
2369
        """Extend the partial history to include a given index
 
2370
 
 
2371
        If a stop_index is supplied, stop when that index has been reached.
 
2372
        If a stop_revision is supplied, stop when that revision is
 
2373
        encountered.  Otherwise, stop when the beginning of history is
 
2374
        reached.
 
2375
 
 
2376
        :param stop_index: The index which should be present.  When it is
 
2377
            present, history extension will stop.
 
2378
        :param revision_id: The revision id which should be present.  When
 
2379
            it is encountered, history extension will stop.
 
2380
        """
 
2381
        repo = self.repository
 
2382
        if len(self._partial_revision_history_cache) == 0:
 
2383
            iterator = repo.iter_reverse_revision_history(self.last_revision())
 
2384
        else:
 
2385
            start_revision = self._partial_revision_history_cache[-1]
 
2386
            iterator = repo.iter_reverse_revision_history(start_revision)
 
2387
            #skip the last revision in the list
 
2388
            next_revision = iterator.next()
 
2389
        for revision_id in iterator:
 
2390
            self._partial_revision_history_cache.append(revision_id)
 
2391
            if (stop_index is not None and
 
2392
                len(self._partial_revision_history_cache) > stop_index):
 
2393
                break
 
2394
            if revision_id == stop_revision:
 
2395
                break
 
2396
 
2542
2397
    def _write_revision_history(self, history):
2543
2398
        """Factored out of set_revision_history.
2544
2399
 
2565
2420
        """Set the parent branch"""
2566
2421
        return self._get_config_location('parent_location')
2567
2422
 
2568
 
    @needs_write_lock
2569
 
    def _set_all_reference_info(self, info_dict):
2570
 
        """Replace all reference info stored in a branch.
2571
 
 
2572
 
        :param info_dict: A dict of {file_id: (tree_path, branch_location)}
2573
 
        """
2574
 
        s = StringIO()
2575
 
        writer = rio.RioWriter(s)
2576
 
        for key, (tree_path, branch_location) in info_dict.iteritems():
2577
 
            stanza = rio.Stanza(file_id=key, tree_path=tree_path,
2578
 
                                branch_location=branch_location)
2579
 
            writer.write_stanza(stanza)
2580
 
        self._transport.put_bytes('references', s.getvalue())
2581
 
        self._reference_info = info_dict
2582
 
 
2583
 
    @needs_read_lock
2584
 
    def _get_all_reference_info(self):
2585
 
        """Return all the reference info stored in a branch.
2586
 
 
2587
 
        :return: A dict of {file_id: (tree_path, branch_location)}
2588
 
        """
2589
 
        if self._reference_info is not None:
2590
 
            return self._reference_info
2591
 
        rio_file = self._transport.get('references')
2592
 
        try:
2593
 
            stanzas = rio.read_stanzas(rio_file)
2594
 
            info_dict = dict((s['file_id'], (s['tree_path'],
2595
 
                             s['branch_location'])) for s in stanzas)
2596
 
        finally:
2597
 
            rio_file.close()
2598
 
        self._reference_info = info_dict
2599
 
        return info_dict
2600
 
 
2601
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2602
 
        """Set the branch location to use for a tree reference.
2603
 
 
2604
 
        :param file_id: The file-id of the tree reference.
2605
 
        :param tree_path: The path of the tree reference in the tree.
2606
 
        :param branch_location: The location of the branch to retrieve tree
2607
 
            references from.
2608
 
        """
2609
 
        info_dict = self._get_all_reference_info()
2610
 
        info_dict[file_id] = (tree_path, branch_location)
2611
 
        if None in (tree_path, branch_location):
2612
 
            if tree_path is not None:
2613
 
                raise ValueError('tree_path must be None when branch_location'
2614
 
                                 ' is None.')
2615
 
            if branch_location is not None:
2616
 
                raise ValueError('branch_location must be None when tree_path'
2617
 
                                 ' is None.')
2618
 
            del info_dict[file_id]
2619
 
        self._set_all_reference_info(info_dict)
2620
 
 
2621
 
    def get_reference_info(self, file_id):
2622
 
        """Get the tree_path and branch_location for a tree reference.
2623
 
 
2624
 
        :return: a tuple of (tree_path, branch_location)
2625
 
        """
2626
 
        return self._get_all_reference_info().get(file_id, (None, None))
2627
 
 
2628
 
    def reference_parent(self, file_id, path, possible_transports=None):
2629
 
        """Return the parent branch for a tree-reference file_id.
2630
 
 
2631
 
        :param file_id: The file_id of the tree reference
2632
 
        :param path: The path of the file_id in the tree
2633
 
        :return: A branch associated with the file_id
2634
 
        """
2635
 
        branch_location = self.get_reference_info(file_id)[1]
2636
 
        if branch_location is None:
2637
 
            return Branch.reference_parent(self, file_id, path,
2638
 
                                           possible_transports)
2639
 
        branch_location = urlutils.join(self.base, branch_location)
2640
 
        return Branch.open(branch_location,
2641
 
                           possible_transports=possible_transports)
2642
 
 
2643
2423
    def set_push_location(self, location):
2644
2424
        """See Branch.set_push_location."""
2645
2425
        self._set_config_location('push_location', location)
2687
2467
            raise errors.NotStacked(self)
2688
2468
        return stacked_url
2689
2469
 
 
2470
    def set_append_revisions_only(self, enabled):
 
2471
        if enabled:
 
2472
            value = 'True'
 
2473
        else:
 
2474
            value = 'False'
 
2475
        self.get_config().set_user_option('append_revisions_only', value,
 
2476
            warn_masked=True)
 
2477
 
 
2478
    def set_stacked_on_url(self, url):
 
2479
        self._check_stackable_repo()
 
2480
        if not url:
 
2481
            try:
 
2482
                old_url = self.get_stacked_on_url()
 
2483
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
2484
                errors.UnstackableRepositoryFormat):
 
2485
                return
 
2486
            url = ''
 
2487
            # repositories don't offer an interface to remove fallback
 
2488
            # repositories today; take the conceptually simpler option and just
 
2489
            # reopen it.
 
2490
            self.repository = self.bzrdir.find_repository()
 
2491
            # for every revision reference the branch has, ensure it is pulled
 
2492
            # in.
 
2493
            source_repository = self._get_fallback_repository(old_url)
 
2494
            for revision_id in chain([self.last_revision()],
 
2495
                self.tags.get_reverse_tag_dict()):
 
2496
                self.repository.fetch(source_repository, revision_id,
 
2497
                    find_ghosts=True)
 
2498
        else:
 
2499
            self._activate_fallback_location(url)
 
2500
        # write this out after the repository is stacked to avoid setting a
 
2501
        # stacked config that doesn't work.
 
2502
        self._set_config_location('stacked_on_location', url)
 
2503
 
2690
2504
    def _get_append_revisions_only(self):
2691
2505
        value = self.get_config().get_user_option('append_revisions_only')
2692
2506
        return value == 'True'
2693
2507
 
 
2508
    def _make_tags(self):
 
2509
        return BasicTags(self)
 
2510
 
2694
2511
    @needs_write_lock
2695
2512
    def generate_revision_history(self, revision_id, last_rev=None,
2696
2513
                                  other_branch=None):
2735
2552
        return self.revno() - index
2736
2553
 
2737
2554
 
2738
 
class BzrBranch7(BzrBranch8):
2739
 
    """A branch with support for a fallback repository."""
2740
 
 
2741
 
    def set_reference_info(self, file_id, tree_path, branch_location):
2742
 
        Branch.set_reference_info(self, file_id, tree_path, branch_location)
2743
 
 
2744
 
    def get_reference_info(self, file_id):
2745
 
        Branch.get_reference_info(self, file_id)
2746
 
 
2747
 
    def reference_parent(self, file_id, path, possible_transports=None):
2748
 
        return Branch.reference_parent(self, file_id, path,
2749
 
                                       possible_transports)
2750
 
 
2751
 
 
2752
2555
class BzrBranch6(BzrBranch7):
2753
2556
    """See BzrBranchFormat6 for the capabilities of this branch.
2754
2557
 
2759
2562
    def get_stacked_on_url(self):
2760
2563
        raise errors.UnstackableBranchFormat(self._format, self.base)
2761
2564
 
 
2565
    def set_stacked_on_url(self, url):
 
2566
        raise errors.UnstackableBranchFormat(self._format, self.base)
 
2567
 
2762
2568
 
2763
2569
######################################################################
2764
2570
# results of operations
2781
2587
    :ivar new_revno: Revision number after pull.
2782
2588
    :ivar old_revid: Tip revision id before pull.
2783
2589
    :ivar new_revid: Tip revision id after pull.
2784
 
    :ivar source_branch: Source (local) branch object. (read locked)
 
2590
    :ivar source_branch: Source (local) branch object.
2785
2591
    :ivar master_branch: Master branch of the target, or the target if no
2786
2592
        Master
2787
2593
    :ivar local_branch: target branch if there is a Master, else None
2788
 
    :ivar target_branch: Target/destination branch object. (write locked)
 
2594
    :ivar target_branch: Target/destination branch object.
2789
2595
    :ivar tag_conflicts: A list of tag conflicts, see BasicTags.merge_to
2790
2596
    """
2791
2597
 
2802
2608
        self._show_tag_conficts(to_file)
2803
2609
 
2804
2610
 
2805
 
class BranchPushResult(_Result):
 
2611
class PushResult(_Result):
2806
2612
    """Result of a Branch.push operation.
2807
2613
 
2808
 
    :ivar old_revno: Revision number (eg 10) of the target before push.
2809
 
    :ivar new_revno: Revision number (eg 12) of the target after push.
2810
 
    :ivar old_revid: Tip revision id (eg joe@foo.com-1234234-aoeua34) of target
2811
 
        before the push.
2812
 
    :ivar new_revid: Tip revision id (eg joe@foo.com-5676566-boa234a) of target
2813
 
        after the push.
2814
 
    :ivar source_branch: Source branch object that the push was from. This is
2815
 
        read locked, and generally is a local (and thus low latency) branch.
2816
 
    :ivar master_branch: If target is a bound branch, the master branch of
2817
 
        target, or target itself. Always write locked.
2818
 
    :ivar target_branch: The direct Branch where data is being sent (write
2819
 
        locked).
2820
 
    :ivar local_branch: If the target is a bound branch this will be the
2821
 
        target, otherwise it will be None.
 
2614
    :ivar old_revno: Revision number before push.
 
2615
    :ivar new_revno: Revision number after push.
 
2616
    :ivar old_revid: Tip revision id before push.
 
2617
    :ivar new_revid: Tip revision id after push.
 
2618
    :ivar source_branch: Source branch object.
 
2619
    :ivar master_branch: Master branch of the target, or None.
 
2620
    :ivar target_branch: Target/destination branch object.
2822
2621
    """
2823
2622
 
2824
2623
    def __int__(self):
2842
2641
 
2843
2642
    def __init__(self, branch):
2844
2643
        self.branch = branch
2845
 
        self.errors = []
2846
2644
 
2847
2645
    def report_results(self, verbose):
2848
2646
        """Report the check results via trace.note.
2850
2648
        :param verbose: Requests more detailed display of what was checked,
2851
2649
            if any.
2852
2650
        """
2853
 
        note('checked branch %s format %s', self.branch.base,
2854
 
            self.branch._format)
2855
 
        for error in self.errors:
2856
 
            note('found error:%s', error)
 
2651
        note('checked branch %s format %s',
 
2652
             self.branch.base,
 
2653
             self.branch._format)
2857
2654
 
2858
2655
 
2859
2656
class Converter5to6(object):
2897
2694
        branch._transport.put_bytes('format', format.get_format_string())
2898
2695
 
2899
2696
 
2900
 
class Converter7to8(object):
2901
 
    """Perform an in-place upgrade of format 6 to format 7"""
2902
 
 
2903
 
    def convert(self, branch):
2904
 
        format = BzrBranchFormat8()
2905
 
        branch._transport.put_bytes('references', '')
2906
 
        # update target format
2907
 
        branch._transport.put_bytes('format', format.get_format_string())
2908
 
 
2909
2697
 
2910
2698
def _run_with_write_locked_target(target, callable, *args, **kwargs):
2911
2699
    """Run ``callable(*args, **kwargs)``, write-locking target for the
2954
2742
    @staticmethod
2955
2743
    def _get_branch_formats_to_test():
2956
2744
        """Return a tuple with the Branch formats to use when testing."""
2957
 
        raise NotImplementedError(InterBranch._get_branch_formats_to_test)
2958
 
 
2959
 
    def pull(self, overwrite=False, stop_revision=None,
2960
 
             possible_transports=None, local=False):
2961
 
        """Mirror source into target branch.
2962
 
 
2963
 
        The target branch is considered to be 'local', having low latency.
2964
 
 
2965
 
        :returns: PullResult instance
2966
 
        """
2967
 
        raise NotImplementedError(self.pull)
 
2745
        raise NotImplementedError(self._get_branch_formats_to_test)
2968
2746
 
2969
2747
    def update_revisions(self, stop_revision=None, overwrite=False,
2970
2748
                         graph=None):
2979
2757
        """
2980
2758
        raise NotImplementedError(self.update_revisions)
2981
2759
 
2982
 
    def push(self, overwrite=False, stop_revision=None,
2983
 
             _override_hook_source_branch=None):
2984
 
        """Mirror the source branch into the target branch.
2985
 
 
2986
 
        The source branch is considered to be 'local', having low latency.
2987
 
        """
2988
 
        raise NotImplementedError(self.push)
2989
 
 
2990
2760
 
2991
2761
class GenericInterBranch(InterBranch):
2992
2762
    """InterBranch implementation that uses public Branch functions.
3039
2809
        finally:
3040
2810
            self.source.unlock()
3041
2811
 
3042
 
    def pull(self, overwrite=False, stop_revision=None,
3043
 
             possible_transports=None, _hook_master=None, run_hooks=True,
3044
 
             _override_hook_target=None, local=False):
3045
 
        """See Branch.pull.
3046
 
 
3047
 
        :param _hook_master: Private parameter - set the branch to
3048
 
            be supplied as the master to pull hooks.
3049
 
        :param run_hooks: Private parameter - if false, this branch
3050
 
            is being called because it's the master of the primary branch,
3051
 
            so it should not run its hooks.
3052
 
        :param _override_hook_target: Private parameter - set the branch to be
3053
 
            supplied as the target_branch to pull hooks.
3054
 
        :param local: Only update the local branch, and not the bound branch.
3055
 
        """
3056
 
        # This type of branch can't be bound.
3057
 
        if local:
3058
 
            raise errors.LocalRequiresBoundBranch()
3059
 
        result = PullResult()
3060
 
        result.source_branch = self.source
3061
 
        if _override_hook_target is None:
3062
 
            result.target_branch = self.target
3063
 
        else:
3064
 
            result.target_branch = _override_hook_target
3065
 
        self.source.lock_read()
3066
 
        try:
3067
 
            # We assume that during 'pull' the target repository is closer than
3068
 
            # the source one.
3069
 
            self.source.update_references(self.target)
3070
 
            graph = self.target.repository.get_graph(self.source.repository)
3071
 
            # TODO: Branch formats should have a flag that indicates 
3072
 
            # that revno's are expensive, and pull() should honor that flag.
3073
 
            # -- JRV20090506
3074
 
            result.old_revno, result.old_revid = \
3075
 
                self.target.last_revision_info()
3076
 
            self.target.update_revisions(self.source, stop_revision,
3077
 
                overwrite=overwrite, graph=graph)
3078
 
            # TODO: The old revid should be specified when merging tags, 
3079
 
            # so a tags implementation that versions tags can only 
3080
 
            # pull in the most recent changes. -- JRV20090506
3081
 
            result.tag_conflicts = self.source.tags.merge_to(self.target.tags,
3082
 
                overwrite)
3083
 
            result.new_revno, result.new_revid = self.target.last_revision_info()
3084
 
            if _hook_master:
3085
 
                result.master_branch = _hook_master
3086
 
                result.local_branch = result.target_branch
3087
 
            else:
3088
 
                result.master_branch = result.target_branch
3089
 
                result.local_branch = None
3090
 
            if run_hooks:
3091
 
                for hook in Branch.hooks['post_pull']:
3092
 
                    hook(result)
3093
 
        finally:
3094
 
            self.source.unlock()
3095
 
        return result
3096
 
 
3097
 
    def push(self, overwrite=False, stop_revision=None,
3098
 
             _override_hook_source_branch=None):
3099
 
        """See InterBranch.push.
3100
 
 
3101
 
        This is the basic concrete implementation of push()
3102
 
 
3103
 
        :param _override_hook_source_branch: If specified, run
3104
 
        the hooks passing this Branch as the source, rather than self.
3105
 
        This is for use of RemoteBranch, where push is delegated to the
3106
 
        underlying vfs-based Branch.
3107
 
        """
3108
 
        # TODO: Public option to disable running hooks - should be trivial but
3109
 
        # needs tests.
3110
 
        self.source.lock_read()
3111
 
        try:
3112
 
            return _run_with_write_locked_target(
3113
 
                self.target, self._push_with_bound_branches, overwrite,
3114
 
                stop_revision,
3115
 
                _override_hook_source_branch=_override_hook_source_branch)
3116
 
        finally:
3117
 
            self.source.unlock()
3118
 
 
3119
 
    def _push_with_bound_branches(self, overwrite, stop_revision,
3120
 
            _override_hook_source_branch=None):
3121
 
        """Push from source into target, and into target's master if any.
3122
 
        """
3123
 
        def _run_hooks():
3124
 
            if _override_hook_source_branch:
3125
 
                result.source_branch = _override_hook_source_branch
3126
 
            for hook in Branch.hooks['post_push']:
3127
 
                hook(result)
3128
 
 
3129
 
        bound_location = self.target.get_bound_location()
3130
 
        if bound_location and self.target.base != bound_location:
3131
 
            # there is a master branch.
3132
 
            #
3133
 
            # XXX: Why the second check?  Is it even supported for a branch to
3134
 
            # be bound to itself? -- mbp 20070507
3135
 
            master_branch = self.target.get_master_branch()
3136
 
            master_branch.lock_write()
3137
 
            try:
3138
 
                # push into the master from the source branch.
3139
 
                self.source._basic_push(master_branch, overwrite, stop_revision)
3140
 
                # and push into the target branch from the source. Note that we
3141
 
                # push from the source branch again, because its considered the
3142
 
                # highest bandwidth repository.
3143
 
                result = self.source._basic_push(self.target, overwrite,
3144
 
                    stop_revision)
3145
 
                result.master_branch = master_branch
3146
 
                result.local_branch = self.target
3147
 
                _run_hooks()
3148
 
                return result
3149
 
            finally:
3150
 
                master_branch.unlock()
3151
 
        else:
3152
 
            # no master branch
3153
 
            result = self.source._basic_push(self.target, overwrite,
3154
 
                stop_revision)
3155
 
            # TODO: Why set master_branch and local_branch if there's no
3156
 
            # binding?  Maybe cleaner to just leave them unset? -- mbp
3157
 
            # 20070504
3158
 
            result.master_branch = self.target
3159
 
            result.local_branch = None
3160
 
            _run_hooks()
3161
 
            return result
3162
 
 
3163
2812
    @classmethod
3164
2813
    def is_compatible(self, source, target):
3165
2814
        # GenericBranch uses the public API, so always compatible
3166
2815
        return True
3167
2816
 
3168
2817
 
3169
 
class InterToBranch5(GenericInterBranch):
3170
 
 
3171
 
    @staticmethod
3172
 
    def _get_branch_formats_to_test():
3173
 
        return BranchFormat._default_format, BzrBranchFormat5()
3174
 
 
3175
 
    def pull(self, overwrite=False, stop_revision=None,
3176
 
             possible_transports=None, run_hooks=True,
3177
 
             _override_hook_target=None, local=False):
3178
 
        """Pull from source into self, updating my master if any.
3179
 
 
3180
 
        :param run_hooks: Private parameter - if false, this branch
3181
 
            is being called because it's the master of the primary branch,
3182
 
            so it should not run its hooks.
3183
 
        """
3184
 
        bound_location = self.target.get_bound_location()
3185
 
        if local and not bound_location:
3186
 
            raise errors.LocalRequiresBoundBranch()
3187
 
        master_branch = None
3188
 
        if not local and bound_location and self.source.base != bound_location:
3189
 
            # not pulling from master, so we need to update master.
3190
 
            master_branch = self.target.get_master_branch(possible_transports)
3191
 
            master_branch.lock_write()
3192
 
        try:
3193
 
            if master_branch:
3194
 
                # pull from source into master.
3195
 
                master_branch.pull(self.source, overwrite, stop_revision,
3196
 
                    run_hooks=False)
3197
 
            return super(InterToBranch5, self).pull(overwrite,
3198
 
                stop_revision, _hook_master=master_branch,
3199
 
                run_hooks=run_hooks,
3200
 
                _override_hook_target=_override_hook_target)
3201
 
        finally:
3202
 
            if master_branch:
3203
 
                master_branch.unlock()
3204
 
 
3205
 
 
3206
2818
InterBranch.register_optimiser(GenericInterBranch)
3207
 
InterBranch.register_optimiser(InterToBranch5)