~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Martin Pool
  • Date: 2010-07-16 15:20:17 UTC
  • mfrom: (5346.3.1 pathnotchild)
  • mto: This revision was merged to the branch mainline in revision 5351.
  • Revision ID: mbp@canonical.com-20100716152017-t4c73h9y1uoih7fb
PathNotChild should not give a traceback.

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-2010 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
24
24
    bzrdir,
25
25
    check,
26
26
    chk_map,
 
27
    config,
27
28
    debug,
28
 
    errors,
 
29
    fetch as _mod_fetch,
29
30
    fifo_cache,
30
31
    generate_ids,
31
32
    gpg,
32
33
    graph,
33
34
    inventory,
 
35
    inventory_delta,
34
36
    lazy_regex,
35
37
    lockable_files,
36
38
    lockdir,
37
39
    lru_cache,
38
40
    osutils,
39
41
    revision as _mod_revision,
 
42
    static_tuple,
40
43
    symbol_versioning,
 
44
    trace,
41
45
    tsort,
42
 
    ui,
43
46
    versionedfile,
44
47
    )
45
48
from bzrlib.bundle import serializer
48
51
from bzrlib.testament import Testament
49
52
""")
50
53
 
51
 
from bzrlib.decorators import needs_read_lock, needs_write_lock
 
54
from bzrlib import (
 
55
    errors,
 
56
    registry,
 
57
    ui,
 
58
    )
 
59
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
52
60
from bzrlib.inter import InterObject
53
61
from bzrlib.inventory import (
54
62
    Inventory,
56
64
    ROOT_ID,
57
65
    entry_factory,
58
66
    )
59
 
from bzrlib import registry
60
 
from bzrlib.symbol_versioning import (
61
 
        deprecated_method,
62
 
        )
 
67
from bzrlib.recordcounter import RecordCounter
 
68
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
63
69
from bzrlib.trace import (
64
70
    log_exception_quietly, note, mutter, mutter_callsite, warning)
65
71
 
68
74
_deprecation_warning_done = False
69
75
 
70
76
 
 
77
class IsInWriteGroupError(errors.InternalBzrError):
 
78
 
 
79
    _fmt = "May not refresh_data of repo %(repo)s while in a write group."
 
80
 
 
81
    def __init__(self, repo):
 
82
        errors.InternalBzrError.__init__(self, repo=repo)
 
83
 
 
84
 
71
85
class CommitBuilder(object):
72
86
    """Provides an interface to build up a commit.
73
87
 
204
218
            repository.get_inventory.
205
219
        """
206
220
        if self.new_inventory is None:
207
 
            # XXX: Using these asserts causes test failures. However, at least
208
 
            #      "self._recording_deletes" seems like a useful check to do,
209
 
            #      as it ensure the delta is completely valid. Most likely this
210
 
            #      just exposes that the test suite isn't using CommitBuilder
211
 
            #      100% correctly.
212
 
            # if (not self.repository._format._commit_inv_deltas
213
 
            #     or not self._recording_deletes):
214
 
            #     raise AssertionError('new_inventory is None, but we did not'
215
 
            #         ' set the flag that the repository format supports'
216
 
            #         ' partial inventory generation.')
217
221
            # an inventory delta was accumulated without creating a new
218
222
            # inventory.
219
223
            basis_id = self.basis_delta_revision
220
 
            self.inv_sha1 = self.repository.add_inventory_by_delta(
 
224
            # We ignore the 'inventory' returned by add_inventory_by_delta
 
225
            # because self.new_inventory is used to hint to the rest of the
 
226
            # system what code path was taken
 
227
            self.inv_sha1, _ = self.repository.add_inventory_by_delta(
221
228
                basis_id, self._basis_delta, self._new_revision_id,
222
229
                self.parents)
223
230
        else:
282
289
 
283
290
        :param tree: The tree which is being committed.
284
291
        """
285
 
        # NB: if there are no parents then this method is not called, so no
286
 
        # need to guard on parents having length.
 
292
        if len(self.parents) == 0:
 
293
            raise errors.RootMissing()
287
294
        entry = entry_factory['directory'](tree.path2id(''), '',
288
295
            None)
289
296
        entry.revision = self._new_revision_id
336
343
            raise AssertionError("recording deletes not activated.")
337
344
        delta = (path, None, file_id, None)
338
345
        self._basis_delta.append(delta)
 
346
        self._any_changes = True
339
347
        return delta
340
348
 
341
349
    def will_record_deletes(self):
476
484
            if content_summary[2] is None:
477
485
                raise ValueError("Files must not have executable = None")
478
486
            if not store:
479
 
                if (# if the file length changed we have to store:
480
 
                    parent_entry.text_size != content_summary[1] or
481
 
                    # if the exec bit has changed we have to store:
 
487
                # We can't trust a check of the file length because of content
 
488
                # filtering...
 
489
                if (# if the exec bit has changed we have to store:
482
490
                    parent_entry.executable != content_summary[2]):
483
491
                    store = True
484
492
                elif parent_entry.text_sha1 == content_summary[3]:
503
511
            ie.executable = content_summary[2]
504
512
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
505
513
            try:
506
 
                lines = file_obj.readlines()
 
514
                text = file_obj.read()
507
515
            finally:
508
516
                file_obj.close()
509
517
            try:
510
518
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
511
 
                    ie.file_id, lines, heads, nostore_sha)
 
519
                    ie.file_id, text, heads, nostore_sha)
512
520
                # Let the caller know we generated a stat fingerprint.
513
521
                fingerprint = (ie.text_sha1, stat_value)
514
522
            except errors.ExistingContent:
526
534
                # carry over:
527
535
                ie.revision = parent_entry.revision
528
536
                return self._get_delta(ie, basis_inv, path), False, None
529
 
            lines = []
530
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
537
            self._add_text_to_weave(ie.file_id, '', heads, None)
531
538
        elif kind == 'symlink':
532
539
            current_link_target = content_summary[3]
533
540
            if not store:
541
548
                ie.symlink_target = parent_entry.symlink_target
542
549
                return self._get_delta(ie, basis_inv, path), False, None
543
550
            ie.symlink_target = current_link_target
544
 
            lines = []
545
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
551
            self._add_text_to_weave(ie.file_id, '', heads, None)
546
552
        elif kind == 'tree-reference':
547
553
            if not store:
548
554
                if content_summary[3] != parent_entry.reference_revision:
553
559
                ie.revision = parent_entry.revision
554
560
                return self._get_delta(ie, basis_inv, path), False, None
555
561
            ie.reference_revision = content_summary[3]
556
 
            lines = []
557
 
            self._add_text_to_weave(ie.file_id, lines, heads, None)
 
562
            if ie.reference_revision is None:
 
563
                raise AssertionError("invalid content_summary for nested tree: %r"
 
564
                    % (content_summary,))
 
565
            self._add_text_to_weave(ie.file_id, '', heads, None)
558
566
        else:
559
567
            raise NotImplementedError('unknown kind')
560
568
        ie.revision = self._new_revision_id
570
578
            has been generated against. Currently assumed to be the same
571
579
            as self.parents[0] - if it is not, errors may occur.
572
580
        :param iter_changes: An iter_changes iterator with the changes to apply
573
 
            to basis_revision_id.
 
581
            to basis_revision_id. The iterator must not include any items with
 
582
            a current kind of None - missing items must be either filtered out
 
583
            or errored-on beefore record_iter_changes sees the item.
574
584
        :param _entry_factory: Private method to bind entry_factory locally for
575
585
            performance.
576
 
        :return: None
 
586
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
 
587
            tree._observed_sha1.
577
588
        """
578
589
        # Create an inventory delta based on deltas between all the parents and
579
590
        # deltas between all the parent inventories. We use inventory delta's 
586
597
        # {file_id -> revision_id -> inventory entry, for entries in parent
587
598
        # trees that are not parents[0]
588
599
        parent_entries = {}
589
 
        revtrees = list(self.repository.revision_trees(self.parents))
 
600
        ghost_basis = False
 
601
        try:
 
602
            revtrees = list(self.repository.revision_trees(self.parents))
 
603
        except errors.NoSuchRevision:
 
604
            # one or more ghosts, slow path.
 
605
            revtrees = []
 
606
            for revision_id in self.parents:
 
607
                try:
 
608
                    revtrees.append(self.repository.revision_tree(revision_id))
 
609
                except errors.NoSuchRevision:
 
610
                    if not revtrees:
 
611
                        basis_revision_id = _mod_revision.NULL_REVISION
 
612
                        ghost_basis = True
 
613
                    revtrees.append(self.repository.revision_tree(
 
614
                        _mod_revision.NULL_REVISION))
590
615
        # The basis inventory from a repository 
591
616
        if revtrees:
592
617
            basis_inv = revtrees[0].inventory
594
619
            basis_inv = self.repository.revision_tree(
595
620
                _mod_revision.NULL_REVISION).inventory
596
621
        if len(self.parents) > 0:
597
 
            if basis_revision_id != self.parents[0]:
 
622
            if basis_revision_id != self.parents[0] and not ghost_basis:
598
623
                raise Exception(
599
624
                    "arbitrary basis parents not yet supported with merges")
600
625
            for revtree in revtrees[1:]:
604
629
                        continue
605
630
                    if change[2] not in merged_ids:
606
631
                        if change[0] is not None:
 
632
                            basis_entry = basis_inv[change[2]]
607
633
                            merged_ids[change[2]] = [
608
 
                                basis_inv[change[2]].revision,
 
634
                                # basis revid
 
635
                                basis_entry.revision,
 
636
                                # new tree revid
609
637
                                change[3].revision]
 
638
                            parent_entries[change[2]] = {
 
639
                                # basis parent
 
640
                                basis_entry.revision:basis_entry,
 
641
                                # this parent 
 
642
                                change[3].revision:change[3],
 
643
                                }
610
644
                        else:
611
645
                            merged_ids[change[2]] = [change[3].revision]
612
 
                        parent_entries[change[2]] = {change[3].revision:change[3]}
 
646
                            parent_entries[change[2]] = {change[3].revision:change[3]}
613
647
                    else:
614
648
                        merged_ids[change[2]].append(change[3].revision)
615
649
                        parent_entries[change[2]][change[3].revision] = change[3]
640
674
            # inv delta  change: (file_id, (path_in_source, path_in_target),
641
675
            #   changed_content, versioned, parent, name, kind,
642
676
            #   executable)
643
 
            basis_entry = basis_inv[file_id]
644
 
            change = (file_id,
645
 
                (basis_inv.id2path(file_id), tree.id2path(file_id)),
646
 
                False, (True, True),
647
 
                (basis_entry.parent_id, basis_entry.parent_id),
648
 
                (basis_entry.name, basis_entry.name),
649
 
                (basis_entry.kind, basis_entry.kind),
650
 
                (basis_entry.executable, basis_entry.executable))
651
 
            changes[file_id] = (change, merged_ids[file_id])
 
677
            try:
 
678
                basis_entry = basis_inv[file_id]
 
679
            except errors.NoSuchId:
 
680
                # a change from basis->some_parents but file_id isn't in basis
 
681
                # so was new in the merge, which means it must have changed
 
682
                # from basis -> current, and as it hasn't the add was reverted
 
683
                # by the user. So we discard this change.
 
684
                pass
 
685
            else:
 
686
                change = (file_id,
 
687
                    (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
688
                    False, (True, True),
 
689
                    (basis_entry.parent_id, basis_entry.parent_id),
 
690
                    (basis_entry.name, basis_entry.name),
 
691
                    (basis_entry.kind, basis_entry.kind),
 
692
                    (basis_entry.executable, basis_entry.executable))
 
693
                changes[file_id] = (change, merged_ids[file_id])
652
694
        # changes contains tuples with the change and a set of inventory
653
695
        # candidates for the file.
654
696
        # inv delta is:
720
762
                        entry.executable = True
721
763
                    else:
722
764
                        entry.executable = False
723
 
                    if (carry_over_possible and 
 
765
                    if (carry_over_possible and
724
766
                        parent_entry.executable == entry.executable):
725
767
                            # Check the file length, content hash after reading
726
768
                            # the file.
729
771
                        nostore_sha = None
730
772
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
731
773
                    try:
732
 
                        lines = file_obj.readlines()
 
774
                        text = file_obj.read()
733
775
                    finally:
734
776
                        file_obj.close()
735
777
                    try:
736
778
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
737
 
                            file_id, lines, heads, nostore_sha)
 
779
                            file_id, text, heads, nostore_sha)
 
780
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
738
781
                    except errors.ExistingContent:
739
782
                        # No content change against a carry_over parent
 
783
                        # Perhaps this should also yield a fs hash update?
740
784
                        carried_over = True
741
785
                        entry.text_size = parent_entry.text_size
742
786
                        entry.text_sha1 = parent_entry.text_sha1
745
789
                    entry.symlink_target = tree.get_symlink_target(file_id)
746
790
                    if (carry_over_possible and
747
791
                        parent_entry.symlink_target == entry.symlink_target):
748
 
                            carried_over = True
 
792
                        carried_over = True
749
793
                    else:
750
 
                        self._add_text_to_weave(change[0], [], heads, None)
 
794
                        self._add_text_to_weave(change[0], '', heads, None)
751
795
                elif kind == 'directory':
752
796
                    if carry_over_possible:
753
797
                        carried_over = True
755
799
                        # Nothing to set on the entry.
756
800
                        # XXX: split into the Root and nonRoot versions.
757
801
                        if change[1][1] != '' or self.repository.supports_rich_root():
758
 
                            self._add_text_to_weave(change[0], [], heads, None)
 
802
                            self._add_text_to_weave(change[0], '', heads, None)
759
803
                elif kind == 'tree-reference':
760
 
                    raise AssertionError('unknown kind %r' % kind)
 
804
                    if not self.repository._format.supports_tree_reference:
 
805
                        # This isn't quite sane as an error, but we shouldn't
 
806
                        # ever see this code path in practice: tree's don't
 
807
                        # permit references when the repo doesn't support tree
 
808
                        # references.
 
809
                        raise errors.UnsupportedOperation(tree.add_reference,
 
810
                            self.repository)
 
811
                    reference_revision = tree.get_reference_revision(change[0])
 
812
                    entry.reference_revision = reference_revision
 
813
                    if (carry_over_possible and
 
814
                        parent_entry.reference_revision == reference_revision):
 
815
                        carried_over = True
 
816
                    else:
 
817
                        self._add_text_to_weave(change[0], '', heads, None)
761
818
                else:
762
819
                    raise AssertionError('unknown kind %r' % kind)
763
820
                if not carried_over:
772
829
                seen_root = True
773
830
        self.new_inventory = None
774
831
        if len(inv_delta):
 
832
            # This should perhaps be guarded by a check that the basis we
 
833
            # commit against is the basis for the commit and if not do a delta
 
834
            # against the basis.
775
835
            self._any_changes = True
776
836
        if not seen_root:
777
837
            # housekeeping root entry changes do not affect no-change commits.
778
838
            self._require_root_change(tree)
779
839
        self.basis_delta_revision = basis_revision_id
780
840
 
781
 
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
782
 
        # Note: as we read the content directly from the tree, we know its not
783
 
        # been turned into unicode or badly split - but a broken tree
784
 
        # implementation could give us bad output from readlines() so this is
785
 
        # not a guarantee of safety. What would be better is always checking
786
 
        # the content during test suite execution. RBC 20070912
787
 
        parent_keys = tuple((file_id, parent) for parent in parents)
788
 
        return self.repository.texts.add_lines(
789
 
            (file_id, self._new_revision_id), parent_keys, new_lines,
790
 
            nostore_sha=nostore_sha, random_id=self.random_revid,
791
 
            check_content=False)[0:2]
 
841
    def _add_text_to_weave(self, file_id, new_text, parents, nostore_sha):
 
842
        parent_keys = tuple([(file_id, parent) for parent in parents])
 
843
        return self.repository.texts._add_text(
 
844
            (file_id, self._new_revision_id), parent_keys, new_text,
 
845
            nostore_sha=nostore_sha, random_id=self.random_revid)[0:2]
792
846
 
793
847
 
794
848
class RootCommitBuilder(CommitBuilder):
817
871
        # versioned roots do not change unless the tree found a change.
818
872
 
819
873
 
 
874
class RepositoryWriteLockResult(LogicalLockResult):
 
875
    """The result of write locking a repository.
 
876
 
 
877
    :ivar repository_token: The token obtained from the underlying lock, or
 
878
        None.
 
879
    :ivar unlock: A callable which will unlock the lock.
 
880
    """
 
881
 
 
882
    def __init__(self, unlock, repository_token):
 
883
        LogicalLockResult.__init__(self, unlock)
 
884
        self.repository_token = repository_token
 
885
 
 
886
    def __repr__(self):
 
887
        return "RepositoryWriteLockResult(%s, %s)" % (self.repository_token,
 
888
            self.unlock)
 
889
 
 
890
 
820
891
######################################################################
821
892
# Repositories
822
893
 
823
 
class Repository(object):
 
894
 
 
895
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
824
896
    """Repository holding history for one or more branches.
825
897
 
826
898
    The repository holds and retrieves historical information including
864
936
        The result of trying to insert data into the repository via this store
865
937
        is undefined: it should be considered read-only except for implementors
866
938
        of repositories.
867
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersioedFiles instance containing
 
939
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
868
940
        any data the repository chooses to store or have indexed by its hash.
869
941
        The result of trying to insert data into the repository via this store
870
942
        is undefined: it should be considered read-only except for implementors
895
967
        """
896
968
        if self._write_group is not self.get_transaction():
897
969
            # has an unlock or relock occured ?
 
970
            if suppress_errors:
 
971
                mutter(
 
972
                '(suppressed) mismatched lock context and write group. %r, %r',
 
973
                self._write_group, self.get_transaction())
 
974
                return
898
975
            raise errors.BzrError(
899
976
                'mismatched lock context and write group. %r, %r' %
900
977
                (self._write_group, self.get_transaction()))
929
1006
        """
930
1007
        if not self._format.supports_external_lookups:
931
1008
            raise errors.UnstackableRepositoryFormat(self._format, self.base)
 
1009
        if self.is_locked():
 
1010
            # This repository will call fallback.unlock() when we transition to
 
1011
            # the unlocked state, so we make sure to increment the lock count
 
1012
            repository.lock_read()
932
1013
        self._check_fallback_repository(repository)
933
1014
        self._fallback_repositories.append(repository)
934
1015
        self.texts.add_fallback_versioned_files(repository.texts)
937
1018
        self.signatures.add_fallback_versioned_files(repository.signatures)
938
1019
        if self.chk_bytes is not None:
939
1020
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
940
 
        self._fetch_order = 'topological'
941
1021
 
942
1022
    def _check_fallback_repository(self, repository):
943
1023
        """Check that this repository can fallback to repository safely.
966
1046
                " id and insertion revid (%r, %r)"
967
1047
                % (inv.revision_id, revision_id))
968
1048
        if inv.root is None:
969
 
            raise AssertionError()
 
1049
            raise errors.RootMissing()
970
1050
        return self._add_inventory_checked(revision_id, inv, parents)
971
1051
 
972
1052
    def _add_inventory_checked(self, revision_id, inv, parents):
976
1056
 
977
1057
        :seealso: add_inventory, for the contract.
978
1058
        """
979
 
        inv_lines = self._serialise_inventory_to_lines(inv)
 
1059
        inv_lines = self._serializer.write_inventory_to_lines(inv)
980
1060
        return self._inventory_add_lines(revision_id, parents,
981
1061
            inv_lines, check_content=False)
982
1062
 
984
1064
                               parents, basis_inv=None, propagate_caches=False):
985
1065
        """Add a new inventory expressed as a delta against another revision.
986
1066
 
 
1067
        See the inventory developers documentation for the theory behind
 
1068
        inventory deltas.
 
1069
 
987
1070
        :param basis_revision_id: The inventory id the delta was created
988
1071
            against. (This does not have to be a direct parent.)
989
1072
        :param delta: The inventory delta (see Inventory.apply_delta for
1028
1111
        check_content=True):
1029
1112
        """Store lines in inv_vf and return the sha1 of the inventory."""
1030
1113
        parents = [(parent,) for parent in parents]
1031
 
        return self.inventories.add_lines((revision_id,), parents, lines,
 
1114
        result = self.inventories.add_lines((revision_id,), parents, lines,
1032
1115
            check_content=check_content)[0]
 
1116
        self.inventories._access.flush()
 
1117
        return result
1033
1118
 
1034
1119
    def add_revision(self, revision_id, rev, inv=None, config=None):
1035
1120
        """Add rev to the revision store as revision_id.
1111
1196
        # The old API returned a list, should this actually be a set?
1112
1197
        return parent_map.keys()
1113
1198
 
 
1199
    def _check_inventories(self, checker):
 
1200
        """Check the inventories found from the revision scan.
 
1201
        
 
1202
        This is responsible for verifying the sha1 of inventories and
 
1203
        creating a pending_keys set that covers data referenced by inventories.
 
1204
        """
 
1205
        bar = ui.ui_factory.nested_progress_bar()
 
1206
        try:
 
1207
            self._do_check_inventories(checker, bar)
 
1208
        finally:
 
1209
            bar.finished()
 
1210
 
 
1211
    def _do_check_inventories(self, checker, bar):
 
1212
        """Helper for _check_inventories."""
 
1213
        revno = 0
 
1214
        keys = {'chk_bytes':set(), 'inventories':set(), 'texts':set()}
 
1215
        kinds = ['chk_bytes', 'texts']
 
1216
        count = len(checker.pending_keys)
 
1217
        bar.update("inventories", 0, 2)
 
1218
        current_keys = checker.pending_keys
 
1219
        checker.pending_keys = {}
 
1220
        # Accumulate current checks.
 
1221
        for key in current_keys:
 
1222
            if key[0] != 'inventories' and key[0] not in kinds:
 
1223
                checker._report_items.append('unknown key type %r' % (key,))
 
1224
            keys[key[0]].add(key[1:])
 
1225
        if keys['inventories']:
 
1226
            # NB: output order *should* be roughly sorted - topo or
 
1227
            # inverse topo depending on repository - either way decent
 
1228
            # to just delta against. However, pre-CHK formats didn't
 
1229
            # try to optimise inventory layout on disk. As such the
 
1230
            # pre-CHK code path does not use inventory deltas.
 
1231
            last_object = None
 
1232
            for record in self.inventories.check(keys=keys['inventories']):
 
1233
                if record.storage_kind == 'absent':
 
1234
                    checker._report_items.append(
 
1235
                        'Missing inventory {%s}' % (record.key,))
 
1236
                else:
 
1237
                    last_object = self._check_record('inventories', record,
 
1238
                        checker, last_object,
 
1239
                        current_keys[('inventories',) + record.key])
 
1240
            del keys['inventories']
 
1241
        else:
 
1242
            return
 
1243
        bar.update("texts", 1)
 
1244
        while (checker.pending_keys or keys['chk_bytes']
 
1245
            or keys['texts']):
 
1246
            # Something to check.
 
1247
            current_keys = checker.pending_keys
 
1248
            checker.pending_keys = {}
 
1249
            # Accumulate current checks.
 
1250
            for key in current_keys:
 
1251
                if key[0] not in kinds:
 
1252
                    checker._report_items.append('unknown key type %r' % (key,))
 
1253
                keys[key[0]].add(key[1:])
 
1254
            # Check the outermost kind only - inventories || chk_bytes || texts
 
1255
            for kind in kinds:
 
1256
                if keys[kind]:
 
1257
                    last_object = None
 
1258
                    for record in getattr(self, kind).check(keys=keys[kind]):
 
1259
                        if record.storage_kind == 'absent':
 
1260
                            checker._report_items.append(
 
1261
                                'Missing %s {%s}' % (kind, record.key,))
 
1262
                        else:
 
1263
                            last_object = self._check_record(kind, record,
 
1264
                                checker, last_object, current_keys[(kind,) + record.key])
 
1265
                    keys[kind] = set()
 
1266
                    break
 
1267
 
 
1268
    def _check_record(self, kind, record, checker, last_object, item_data):
 
1269
        """Check a single text from this repository."""
 
1270
        if kind == 'inventories':
 
1271
            rev_id = record.key[0]
 
1272
            inv = self._deserialise_inventory(rev_id,
 
1273
                record.get_bytes_as('fulltext'))
 
1274
            if last_object is not None:
 
1275
                delta = inv._make_delta(last_object)
 
1276
                for old_path, path, file_id, ie in delta:
 
1277
                    if ie is None:
 
1278
                        continue
 
1279
                    ie.check(checker, rev_id, inv)
 
1280
            else:
 
1281
                for path, ie in inv.iter_entries():
 
1282
                    ie.check(checker, rev_id, inv)
 
1283
            if self._format.fast_deltas:
 
1284
                return inv
 
1285
        elif kind == 'chk_bytes':
 
1286
            # No code written to check chk_bytes for this repo format.
 
1287
            checker._report_items.append(
 
1288
                'unsupported key type chk_bytes for %s' % (record.key,))
 
1289
        elif kind == 'texts':
 
1290
            self._check_text(record, checker, item_data)
 
1291
        else:
 
1292
            checker._report_items.append(
 
1293
                'unknown key type %s for %s' % (kind, record.key))
 
1294
 
 
1295
    def _check_text(self, record, checker, item_data):
 
1296
        """Check a single text."""
 
1297
        # Check it is extractable.
 
1298
        # TODO: check length.
 
1299
        if record.storage_kind == 'chunked':
 
1300
            chunks = record.get_bytes_as(record.storage_kind)
 
1301
            sha1 = osutils.sha_strings(chunks)
 
1302
            length = sum(map(len, chunks))
 
1303
        else:
 
1304
            content = record.get_bytes_as('fulltext')
 
1305
            sha1 = osutils.sha_string(content)
 
1306
            length = len(content)
 
1307
        if item_data and sha1 != item_data[1]:
 
1308
            checker._report_items.append(
 
1309
                'sha1 mismatch: %s has sha1 %s expected %s referenced by %s' %
 
1310
                (record.key, sha1, item_data[1], item_data[2]))
 
1311
 
1114
1312
    @staticmethod
1115
1313
    def create(a_bzrdir):
1116
1314
        """Construct the current default format repository in a_bzrdir."""
1121
1319
 
1122
1320
        :param _format: The format of the repository on disk.
1123
1321
        :param a_bzrdir: The BzrDir of the repository.
1124
 
 
1125
 
        In the future we will have a single api for all stores for
1126
 
        getting file texts, inventories and revisions, then
1127
 
        this construct will accept instances of those things.
1128
1322
        """
 
1323
        # In the future we will have a single api for all stores for
 
1324
        # getting file texts, inventories and revisions, then
 
1325
        # this construct will accept instances of those things.
1129
1326
        super(Repository, self).__init__()
1130
1327
        self._format = _format
1131
1328
        # the following are part of the public API for Repository:
1137
1334
        self._reconcile_does_inventory_gc = True
1138
1335
        self._reconcile_fixes_text_parents = False
1139
1336
        self._reconcile_backsup_inventory = True
1140
 
        # not right yet - should be more semantically clear ?
1141
 
        #
1142
 
        # TODO: make sure to construct the right store classes, etc, depending
1143
 
        # on whether escaping is required.
1144
 
        self._warn_if_deprecated()
1145
1337
        self._write_group = None
1146
1338
        # Additional places to query for data.
1147
1339
        self._fallback_repositories = []
1148
1340
        # An InventoryEntry cache, used during deserialization
1149
1341
        self._inventory_entry_cache = fifo_cache.FIFOCache(10*1024)
 
1342
        # Is it safe to return inventory entries directly from the entry cache,
 
1343
        # rather copying them?
 
1344
        self._safe_to_return_from_cache = False
 
1345
 
 
1346
    @property
 
1347
    def user_transport(self):
 
1348
        return self.bzrdir.user_transport
 
1349
 
 
1350
    @property
 
1351
    def control_transport(self):
 
1352
        return self._transport
1150
1353
 
1151
1354
    def __repr__(self):
1152
 
        return '%s(%r)' % (self.__class__.__name__,
1153
 
                           self.base)
 
1355
        if self._fallback_repositories:
 
1356
            return '%s(%r, fallback_repositories=%r)' % (
 
1357
                self.__class__.__name__,
 
1358
                self.base,
 
1359
                self._fallback_repositories)
 
1360
        else:
 
1361
            return '%s(%r)' % (self.__class__.__name__,
 
1362
                               self.base)
 
1363
 
 
1364
    def _has_same_fallbacks(self, other_repo):
 
1365
        """Returns true if the repositories have the same fallbacks."""
 
1366
        my_fb = self._fallback_repositories
 
1367
        other_fb = other_repo._fallback_repositories
 
1368
        if len(my_fb) != len(other_fb):
 
1369
            return False
 
1370
        for f, g in zip(my_fb, other_fb):
 
1371
            if not f.has_same_location(g):
 
1372
                return False
 
1373
        return True
1154
1374
 
1155
1375
    def has_same_location(self, other):
1156
1376
        """Returns a boolean indicating if this repository is at the same
1184
1404
        data during reads, and allows a 'write_group' to be obtained. Write
1185
1405
        groups must be used for actual data insertion.
1186
1406
 
 
1407
        A token should be passed in if you know that you have locked the object
 
1408
        some other way, and need to synchronise this object's state with that
 
1409
        fact.
 
1410
 
 
1411
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1412
 
1187
1413
        :param token: if this is already locked, then lock_write will fail
1188
1414
            unless the token matches the existing lock.
1189
1415
        :returns: a token if this instance supports tokens, otherwise None.
1192
1418
        :raises MismatchedToken: if the specified token doesn't match the token
1193
1419
            of the existing lock.
1194
1420
        :seealso: start_write_group.
1195
 
 
1196
 
        A token should be passed in if you know that you have locked the object
1197
 
        some other way, and need to synchronise this object's state with that
1198
 
        fact.
1199
 
 
1200
 
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
 
1421
        :return: A RepositoryWriteLockResult.
1201
1422
        """
1202
1423
        locked = self.is_locked()
1203
 
        result = self.control_files.lock_write(token=token)
1204
 
        for repo in self._fallback_repositories:
1205
 
            # Writes don't affect fallback repos
1206
 
            repo.lock_read()
 
1424
        token = self.control_files.lock_write(token=token)
1207
1425
        if not locked:
 
1426
            self._warn_if_deprecated()
 
1427
            self._note_lock('w')
 
1428
            for repo in self._fallback_repositories:
 
1429
                # Writes don't affect fallback repos
 
1430
                repo.lock_read()
1208
1431
            self._refresh_data()
1209
 
        return result
 
1432
        return RepositoryWriteLockResult(self.unlock, token)
1210
1433
 
1211
1434
    def lock_read(self):
 
1435
        """Lock the repository for read operations.
 
1436
 
 
1437
        :return: An object with an unlock method which will release the lock
 
1438
            obtained.
 
1439
        """
1212
1440
        locked = self.is_locked()
1213
1441
        self.control_files.lock_read()
1214
 
        for repo in self._fallback_repositories:
1215
 
            repo.lock_read()
1216
1442
        if not locked:
 
1443
            self._warn_if_deprecated()
 
1444
            self._note_lock('r')
 
1445
            for repo in self._fallback_repositories:
 
1446
                repo.lock_read()
1217
1447
            self._refresh_data()
 
1448
        return LogicalLockResult(self.unlock)
1218
1449
 
1219
1450
    def get_physical_lock_status(self):
1220
1451
        return self.control_files.get_physical_lock_status()
1280
1511
 
1281
1512
        # now gather global repository information
1282
1513
        # XXX: This is available for many repos regardless of listability.
1283
 
        if self.bzrdir.root_transport.listable():
 
1514
        if self.user_transport.listable():
1284
1515
            # XXX: do we want to __define len__() ?
1285
1516
            # Maybe the versionedfiles object should provide a different
1286
1517
            # method to get the number of keys.
1296
1527
        :param using: If True, list only branches using this repository.
1297
1528
        """
1298
1529
        if using and not self.is_shared():
1299
 
            try:
1300
 
                return [self.bzrdir.open_branch()]
1301
 
            except errors.NotBranchError:
1302
 
                return []
 
1530
            return self.bzrdir.list_branches()
1303
1531
        class Evaluator(object):
1304
1532
 
1305
1533
            def __init__(self):
1314
1542
                    except errors.NoRepositoryPresent:
1315
1543
                        pass
1316
1544
                    else:
1317
 
                        return False, (None, repository)
 
1545
                        return False, ([], repository)
1318
1546
                self.first_call = False
1319
 
                try:
1320
 
                    value = (bzrdir.open_branch(), None)
1321
 
                except errors.NotBranchError:
1322
 
                    value = (None, None)
 
1547
                value = (bzrdir.list_branches(), None)
1323
1548
                return True, value
1324
1549
 
1325
 
        branches = []
1326
 
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
1327
 
                self.bzrdir.root_transport, evaluate=Evaluator()):
1328
 
            if branch is not None:
1329
 
                branches.append(branch)
 
1550
        ret = []
 
1551
        for branches, repository in bzrdir.BzrDir.find_bzrdirs(
 
1552
                self.user_transport, evaluate=Evaluator()):
 
1553
            if branches is not None:
 
1554
                ret.extend(branches)
1330
1555
            if not using and repository is not None:
1331
 
                branches.extend(repository.find_branches())
1332
 
        return branches
 
1556
                ret.extend(repository.find_branches())
 
1557
        return ret
1333
1558
 
1334
1559
    @needs_read_lock
1335
1560
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1364
1589
        """Commit the contents accrued within the current write group.
1365
1590
 
1366
1591
        :seealso: start_write_group.
 
1592
        
 
1593
        :return: it may return an opaque hint that can be passed to 'pack'.
1367
1594
        """
1368
1595
        if self._write_group is not self.get_transaction():
1369
1596
            # has an unlock or relock occured ?
1370
1597
            raise errors.BzrError('mismatched lock context %r and '
1371
1598
                'write group %r.' %
1372
1599
                (self.get_transaction(), self._write_group))
1373
 
        self._commit_write_group()
 
1600
        result = self._commit_write_group()
1374
1601
        self._write_group = None
 
1602
        return result
1375
1603
 
1376
1604
    def _commit_write_group(self):
1377
1605
        """Template method for per-repository write group cleanup.
1385
1613
    def suspend_write_group(self):
1386
1614
        raise errors.UnsuspendableWriteGroup(self)
1387
1615
 
 
1616
    def get_missing_parent_inventories(self, check_for_missing_texts=True):
 
1617
        """Return the keys of missing inventory parents for revisions added in
 
1618
        this write group.
 
1619
 
 
1620
        A revision is not complete if the inventory delta for that revision
 
1621
        cannot be calculated.  Therefore if the parent inventories of a
 
1622
        revision are not present, the revision is incomplete, and e.g. cannot
 
1623
        be streamed by a smart server.  This method finds missing inventory
 
1624
        parents for revisions added in this write group.
 
1625
        """
 
1626
        if not self._format.supports_external_lookups:
 
1627
            # This is only an issue for stacked repositories
 
1628
            return set()
 
1629
        if not self.is_in_write_group():
 
1630
            raise AssertionError('not in a write group')
 
1631
 
 
1632
        # XXX: We assume that every added revision already has its
 
1633
        # corresponding inventory, so we only check for parent inventories that
 
1634
        # might be missing, rather than all inventories.
 
1635
        parents = set(self.revisions._index.get_missing_parents())
 
1636
        parents.discard(_mod_revision.NULL_REVISION)
 
1637
        unstacked_inventories = self.inventories._index
 
1638
        present_inventories = unstacked_inventories.get_parent_map(
 
1639
            key[-1:] for key in parents)
 
1640
        parents.difference_update(present_inventories)
 
1641
        if len(parents) == 0:
 
1642
            # No missing parent inventories.
 
1643
            return set()
 
1644
        if not check_for_missing_texts:
 
1645
            return set(('inventories', rev_id) for (rev_id,) in parents)
 
1646
        # Ok, now we have a list of missing inventories.  But these only matter
 
1647
        # if the inventories that reference them are missing some texts they
 
1648
        # appear to introduce.
 
1649
        # XXX: Texts referenced by all added inventories need to be present,
 
1650
        # but at the moment we're only checking for texts referenced by
 
1651
        # inventories at the graph's edge.
 
1652
        key_deps = self.revisions._index._key_dependencies
 
1653
        key_deps.satisfy_refs_for_keys(present_inventories)
 
1654
        referrers = frozenset(r[0] for r in key_deps.get_referrers())
 
1655
        file_ids = self.fileids_altered_by_revision_ids(referrers)
 
1656
        missing_texts = set()
 
1657
        for file_id, version_ids in file_ids.iteritems():
 
1658
            missing_texts.update(
 
1659
                (file_id, version_id) for version_id in version_ids)
 
1660
        present_texts = self.texts.get_parent_map(missing_texts)
 
1661
        missing_texts.difference_update(present_texts)
 
1662
        if not missing_texts:
 
1663
            # No texts are missing, so all revisions and their deltas are
 
1664
            # reconstructable.
 
1665
            return set()
 
1666
        # Alternatively the text versions could be returned as the missing
 
1667
        # keys, but this is likely to be less data.
 
1668
        missing_keys = set(('inventories', rev_id) for (rev_id,) in parents)
 
1669
        return missing_keys
 
1670
 
1388
1671
    def refresh_data(self):
1389
 
        """Re-read any data needed to to synchronise with disk.
 
1672
        """Re-read any data needed to synchronise with disk.
1390
1673
 
1391
1674
        This method is intended to be called after another repository instance
1392
1675
        (such as one used by a smart server) has inserted data into the
1393
 
        repository. It may not be called during a write group, but may be
1394
 
        called at any other time.
 
1676
        repository. On all repositories this will work outside of write groups.
 
1677
        Some repository formats (pack and newer for bzrlib native formats)
 
1678
        support refresh_data inside write groups. If called inside a write
 
1679
        group on a repository that does not support refreshing in a write group
 
1680
        IsInWriteGroupError will be raised.
1395
1681
        """
1396
 
        if self.is_in_write_group():
1397
 
            raise errors.InternalBzrError(
1398
 
                "May not refresh_data while in a write group.")
1399
1682
        self._refresh_data()
1400
1683
 
1401
1684
    def resume_write_group(self, tokens):
1439
1722
            raise errors.InternalBzrError(
1440
1723
                "May not fetch while in a write group.")
1441
1724
        # fast path same-url fetch operations
1442
 
        if self.has_same_location(source) and fetch_spec is None:
 
1725
        # TODO: lift out to somewhere common with RemoteRepository
 
1726
        # <https://bugs.launchpad.net/bzr/+bug/401646>
 
1727
        if (self.has_same_location(source)
 
1728
            and fetch_spec is None
 
1729
            and self._has_same_fallbacks(source)):
1443
1730
            # check that last_revision is in 'from' and then return a
1444
1731
            # no-operation.
1445
1732
            if (revision_id is not None and
1470
1757
        :param revprops: Optional dictionary of revision properties.
1471
1758
        :param revision_id: Optional revision id.
1472
1759
        """
 
1760
        if self._fallback_repositories:
 
1761
            raise errors.BzrError("Cannot commit from a lightweight checkout "
 
1762
                "to a stacked branch. See "
 
1763
                "https://bugs.launchpad.net/bzr/+bug/375013 for details.")
1473
1764
        result = self._commit_builder_class(self, parents, config,
1474
1765
            timestamp, timezone, committer, revprops, revision_id)
1475
1766
        self.start_write_group()
1476
1767
        return result
1477
1768
 
 
1769
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1478
1770
    def unlock(self):
1479
1771
        if (self.control_files._lock_count == 1 and
1480
1772
            self.control_files._lock_mode == 'w'):
1486
1778
        self.control_files.unlock()
1487
1779
        if self.control_files._lock_count == 0:
1488
1780
            self._inventory_entry_cache.clear()
1489
 
        for repo in self._fallback_repositories:
1490
 
            repo.unlock()
 
1781
            for repo in self._fallback_repositories:
 
1782
                repo.unlock()
1491
1783
 
1492
1784
    @needs_read_lock
1493
1785
    def clone(self, a_bzrdir, revision_id=None):
1602
1894
 
1603
1895
    @needs_read_lock
1604
1896
    def get_revisions(self, revision_ids):
1605
 
        """Get many revisions at once."""
 
1897
        """Get many revisions at once.
 
1898
        
 
1899
        Repositories that need to check data on every revision read should 
 
1900
        subclass this method.
 
1901
        """
1606
1902
        return self._get_revisions(revision_ids)
1607
1903
 
1608
1904
    @needs_read_lock
1609
1905
    def _get_revisions(self, revision_ids):
1610
1906
        """Core work logic to get many revisions without sanity checks."""
1611
 
        for rev_id in revision_ids:
1612
 
            if not rev_id or not isinstance(rev_id, basestring):
1613
 
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1907
        revs = {}
 
1908
        for revid, rev in self._iter_revisions(revision_ids):
 
1909
            if rev is None:
 
1910
                raise errors.NoSuchRevision(self, revid)
 
1911
            revs[revid] = rev
 
1912
        return [revs[revid] for revid in revision_ids]
 
1913
 
 
1914
    def _iter_revisions(self, revision_ids):
 
1915
        """Iterate over revision objects.
 
1916
 
 
1917
        :param revision_ids: An iterable of revisions to examine. None may be
 
1918
            passed to request all revisions known to the repository. Note that
 
1919
            not all repositories can find unreferenced revisions; for those
 
1920
            repositories only referenced ones will be returned.
 
1921
        :return: An iterator of (revid, revision) tuples. Absent revisions (
 
1922
            those asked for but not available) are returned as (revid, None).
 
1923
        """
 
1924
        if revision_ids is None:
 
1925
            revision_ids = self.all_revision_ids()
 
1926
        else:
 
1927
            for rev_id in revision_ids:
 
1928
                if not rev_id or not isinstance(rev_id, basestring):
 
1929
                    raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
1614
1930
        keys = [(key,) for key in revision_ids]
1615
1931
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1616
 
        revs = {}
1617
1932
        for record in stream:
 
1933
            revid = record.key[0]
1618
1934
            if record.storage_kind == 'absent':
1619
 
                raise errors.NoSuchRevision(self, record.key[0])
1620
 
            text = record.get_bytes_as('fulltext')
1621
 
            rev = self._serializer.read_revision_from_string(text)
1622
 
            revs[record.key[0]] = rev
1623
 
        return [revs[revid] for revid in revision_ids]
1624
 
 
1625
 
    @needs_read_lock
1626
 
    def get_revision_xml(self, revision_id):
1627
 
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
1628
 
        #       would have already do it.
1629
 
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
1630
 
        rev = self.get_revision(revision_id)
1631
 
        rev_tmp = cStringIO.StringIO()
1632
 
        # the current serializer..
1633
 
        self._serializer.write_revision(rev, rev_tmp)
1634
 
        rev_tmp.seek(0)
1635
 
        return rev_tmp.getvalue()
 
1935
                yield (revid, None)
 
1936
            else:
 
1937
                text = record.get_bytes_as('fulltext')
 
1938
                rev = self._serializer.read_revision_from_string(text)
 
1939
                yield (revid, rev)
1636
1940
 
1637
1941
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1638
1942
        """Produce a generator of revision deltas.
1816
2120
                    yield line, revid
1817
2121
 
1818
2122
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
1819
 
        revision_ids):
 
2123
        revision_keys):
1820
2124
        """Helper routine for fileids_altered_by_revision_ids.
1821
2125
 
1822
2126
        This performs the translation of xml lines to revision ids.
1823
2127
 
1824
2128
        :param line_iterator: An iterator of lines, origin_version_id
1825
 
        :param revision_ids: The revision ids to filter for. This should be a
 
2129
        :param revision_keys: The revision ids to filter for. This should be a
1826
2130
            set or other type which supports efficient __contains__ lookups, as
1827
 
            the revision id from each parsed line will be looked up in the
1828
 
            revision_ids filter.
 
2131
            the revision key from each parsed line will be looked up in the
 
2132
            revision_keys filter.
1829
2133
        :return: a dictionary mapping altered file-ids to an iterable of
1830
2134
        revision_ids. Each altered file-ids has the exact revision_ids that
1831
2135
        altered it listed explicitly.
1832
2136
        """
1833
2137
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
1834
2138
                line_iterator).iterkeys())
1835
 
        # Note that revision_ids are revision keys.
1836
 
        parent_maps = self.revisions.get_parent_map(revision_ids)
1837
 
        parents = set()
1838
 
        map(parents.update, parent_maps.itervalues())
1839
 
        parents.difference_update(revision_ids)
 
2139
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
1840
2140
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
1841
 
            self._inventory_xml_lines_for_keys(parents)))
 
2141
            self._inventory_xml_lines_for_keys(parent_keys)))
1842
2142
        new_keys = seen - parent_seen
1843
2143
        result = {}
1844
2144
        setdefault = result.setdefault
1846
2146
            setdefault(key[0], set()).add(key[-1])
1847
2147
        return result
1848
2148
 
 
2149
    def _find_parent_ids_of_revisions(self, revision_ids):
 
2150
        """Find all parent ids that are mentioned in the revision graph.
 
2151
 
 
2152
        :return: set of revisions that are parents of revision_ids which are
 
2153
            not part of revision_ids themselves
 
2154
        """
 
2155
        parent_map = self.get_parent_map(revision_ids)
 
2156
        parent_ids = set()
 
2157
        map(parent_ids.update, parent_map.itervalues())
 
2158
        parent_ids.difference_update(revision_ids)
 
2159
        parent_ids.discard(_mod_revision.NULL_REVISION)
 
2160
        return parent_ids
 
2161
 
 
2162
    def _find_parent_keys_of_revisions(self, revision_keys):
 
2163
        """Similar to _find_parent_ids_of_revisions, but used with keys.
 
2164
 
 
2165
        :param revision_keys: An iterable of revision_keys.
 
2166
        :return: The parents of all revision_keys that are not already in
 
2167
            revision_keys
 
2168
        """
 
2169
        parent_map = self.revisions.get_parent_map(revision_keys)
 
2170
        parent_keys = set()
 
2171
        map(parent_keys.update, parent_map.itervalues())
 
2172
        parent_keys.difference_update(revision_keys)
 
2173
        parent_keys.discard(_mod_revision.NULL_REVISION)
 
2174
        return parent_keys
 
2175
 
1849
2176
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
1850
2177
        """Find the file ids and versions affected by revisions.
1851
2178
 
1858
2185
        """
1859
2186
        selected_keys = set((revid,) for revid in revision_ids)
1860
2187
        w = _inv_weave or self.inventories
1861
 
        pb = ui.ui_factory.nested_progress_bar()
1862
 
        try:
1863
 
            return self._find_file_ids_from_xml_inventory_lines(
1864
 
                w.iter_lines_added_or_present_in_keys(
1865
 
                    selected_keys, pb=pb),
1866
 
                selected_keys)
1867
 
        finally:
1868
 
            pb.finished()
 
2188
        return self._find_file_ids_from_xml_inventory_lines(
 
2189
            w.iter_lines_added_or_present_in_keys(
 
2190
                selected_keys, pb=None),
 
2191
            selected_keys)
1869
2192
 
1870
2193
    def iter_files_bytes(self, desired_files):
1871
2194
        """Iterate through file versions.
1953
2276
                batch_size]
1954
2277
            if not to_query:
1955
2278
                break
1956
 
            for rev_tree in self.revision_trees(to_query):
1957
 
                revision_id = rev_tree.get_revision_id()
 
2279
            for revision_id in to_query:
1958
2280
                parent_ids = ancestors[revision_id]
1959
2281
                for text_key in revision_keys[revision_id]:
1960
2282
                    pb.update("Calculating text parents", processed_texts)
2033
2355
        num_file_ids = len(file_ids)
2034
2356
        for file_id, altered_versions in file_ids.iteritems():
2035
2357
            if pb is not None:
2036
 
                pb.update("fetch texts", count, num_file_ids)
 
2358
                pb.update("Fetch texts", count, num_file_ids)
2037
2359
            count += 1
2038
2360
            yield ("file", file_id, altered_versions)
2039
2361
 
2060
2382
        """Get Inventory object by revision id."""
2061
2383
        return self.iter_inventories([revision_id]).next()
2062
2384
 
2063
 
    def iter_inventories(self, revision_ids):
 
2385
    def iter_inventories(self, revision_ids, ordering=None):
2064
2386
        """Get many inventories by revision_ids.
2065
2387
 
2066
2388
        This will buffer some or all of the texts used in constructing the
2068
2390
        time.
2069
2391
 
2070
2392
        :param revision_ids: The expected revision ids of the inventories.
 
2393
        :param ordering: optional ordering, e.g. 'topological'.  If not
 
2394
            specified, the order of revision_ids will be preserved (by
 
2395
            buffering if necessary).
2071
2396
        :return: An iterator of inventories.
2072
2397
        """
2073
2398
        if ((None in revision_ids)
2074
2399
            or (_mod_revision.NULL_REVISION in revision_ids)):
2075
2400
            raise ValueError('cannot get null revision inventory')
2076
 
        return self._iter_inventories(revision_ids)
 
2401
        return self._iter_inventories(revision_ids, ordering)
2077
2402
 
2078
 
    def _iter_inventories(self, revision_ids):
 
2403
    def _iter_inventories(self, revision_ids, ordering):
2079
2404
        """single-document based inventory iteration."""
2080
 
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
2081
 
            yield self.deserialise_inventory(revision_id, text)
 
2405
        inv_xmls = self._iter_inventory_xmls(revision_ids, ordering)
 
2406
        for text, revision_id in inv_xmls:
 
2407
            yield self._deserialise_inventory(revision_id, text)
2082
2408
 
2083
 
    def _iter_inventory_xmls(self, revision_ids):
 
2409
    def _iter_inventory_xmls(self, revision_ids, ordering):
 
2410
        if ordering is None:
 
2411
            order_as_requested = True
 
2412
            ordering = 'unordered'
 
2413
        else:
 
2414
            order_as_requested = False
2084
2415
        keys = [(revision_id,) for revision_id in revision_ids]
2085
 
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
 
2416
        if not keys:
 
2417
            return
 
2418
        if order_as_requested:
 
2419
            key_iter = iter(keys)
 
2420
            next_key = key_iter.next()
 
2421
        stream = self.inventories.get_record_stream(keys, ordering, True)
2086
2422
        text_chunks = {}
2087
2423
        for record in stream:
2088
2424
            if record.storage_kind != 'absent':
2089
 
                text_chunks[record.key] = record.get_bytes_as('chunked')
 
2425
                chunks = record.get_bytes_as('chunked')
 
2426
                if order_as_requested:
 
2427
                    text_chunks[record.key] = chunks
 
2428
                else:
 
2429
                    yield ''.join(chunks), record.key[-1]
2090
2430
            else:
2091
2431
                raise errors.NoSuchRevision(self, record.key)
2092
 
        for key in keys:
2093
 
            chunks = text_chunks.pop(key)
2094
 
            yield ''.join(chunks), key[-1]
 
2432
            if order_as_requested:
 
2433
                # Yield as many results as we can while preserving order.
 
2434
                while next_key in text_chunks:
 
2435
                    chunks = text_chunks.pop(next_key)
 
2436
                    yield ''.join(chunks), next_key[-1]
 
2437
                    try:
 
2438
                        next_key = key_iter.next()
 
2439
                    except StopIteration:
 
2440
                        # We still want to fully consume the get_record_stream,
 
2441
                        # just in case it is not actually finished at this point
 
2442
                        next_key = None
 
2443
                        break
2095
2444
 
2096
 
    def deserialise_inventory(self, revision_id, xml):
 
2445
    def _deserialise_inventory(self, revision_id, xml):
2097
2446
        """Transform the xml into an inventory object.
2098
2447
 
2099
2448
        :param revision_id: The expected revision id of the inventory.
2100
2449
        :param xml: A serialised inventory.
2101
2450
        """
2102
2451
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2103
 
                    entry_cache=self._inventory_entry_cache)
 
2452
                    entry_cache=self._inventory_entry_cache,
 
2453
                    return_from_cache=self._safe_to_return_from_cache)
2104
2454
        if result.revision_id != revision_id:
2105
2455
            raise AssertionError('revision id mismatch %s != %s' % (
2106
2456
                result.revision_id, revision_id))
2107
2457
        return result
2108
2458
 
2109
 
    def serialise_inventory(self, inv):
2110
 
        return self._serializer.write_inventory_to_string(inv)
2111
 
 
2112
 
    def _serialise_inventory_to_lines(self, inv):
2113
 
        return self._serializer.write_inventory_to_lines(inv)
2114
 
 
2115
2459
    def get_serializer_format(self):
2116
2460
        return self._serializer.format_num
2117
2461
 
2118
2462
    @needs_read_lock
2119
 
    def get_inventory_xml(self, revision_id):
2120
 
        """Get inventory XML as a file object."""
2121
 
        texts = self._iter_inventory_xmls([revision_id])
 
2463
    def _get_inventory_xml(self, revision_id):
 
2464
        """Get serialized inventory as a string."""
 
2465
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
2122
2466
        try:
2123
2467
            text, revision_id = texts.next()
2124
2468
        except StopIteration:
2125
2469
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2126
2470
        return text
2127
2471
 
2128
 
    @needs_read_lock
2129
 
    def get_inventory_sha1(self, revision_id):
2130
 
        """Return the sha1 hash of the inventory entry
 
2472
    def get_rev_id_for_revno(self, revno, known_pair):
 
2473
        """Return the revision id of a revno, given a later (revno, revid)
 
2474
        pair in the same history.
 
2475
 
 
2476
        :return: if found (True, revid).  If the available history ran out
 
2477
            before reaching the revno, then this returns
 
2478
            (False, (closest_revno, closest_revid)).
2131
2479
        """
2132
 
        return self.get_revision(revision_id).inventory_sha1
 
2480
        known_revno, known_revid = known_pair
 
2481
        partial_history = [known_revid]
 
2482
        distance_from_known = known_revno - revno
 
2483
        if distance_from_known < 0:
 
2484
            raise ValueError(
 
2485
                'requested revno (%d) is later than given known revno (%d)'
 
2486
                % (revno, known_revno))
 
2487
        try:
 
2488
            _iter_for_revno(
 
2489
                self, partial_history, stop_index=distance_from_known)
 
2490
        except errors.RevisionNotPresent, err:
 
2491
            if err.revision_id == known_revid:
 
2492
                # The start revision (known_revid) wasn't found.
 
2493
                raise
 
2494
            # This is a stacked repository with no fallbacks, or a there's a
 
2495
            # left-hand ghost.  Either way, even though the revision named in
 
2496
            # the error isn't in this repo, we know it's the next step in this
 
2497
            # left-hand history.
 
2498
            partial_history.append(err.revision_id)
 
2499
        if len(partial_history) <= distance_from_known:
 
2500
            # Didn't find enough history to get a revid for the revno.
 
2501
            earliest_revno = known_revno - len(partial_history) + 1
 
2502
            return (False, (earliest_revno, partial_history[-1]))
 
2503
        if len(partial_history) - 1 > distance_from_known:
 
2504
            raise AssertionError('_iter_for_revno returned too much history')
 
2505
        return (True, partial_history[-1])
2133
2506
 
2134
2507
    def iter_reverse_revision_history(self, revision_id):
2135
2508
        """Iterate backwards through revision ids in the lefthand history
2142
2515
        while True:
2143
2516
            if next_id in (None, _mod_revision.NULL_REVISION):
2144
2517
                return
 
2518
            try:
 
2519
                parents = graph.get_parent_map([next_id])[next_id]
 
2520
            except KeyError:
 
2521
                raise errors.RevisionNotPresent(next_id, self)
2145
2522
            yield next_id
2146
 
            # Note: The following line may raise KeyError in the event of
2147
 
            # truncated history. We decided not to have a try:except:raise
2148
 
            # RevisionNotPresent here until we see a use for it, because of the
2149
 
            # cost in an inner loop that is by its very nature O(history).
2150
 
            # Robert Collins 20080326
2151
 
            parents = graph.get_parent_map([next_id])[next_id]
2152
2523
            if len(parents) == 0:
2153
2524
                return
2154
2525
            else:
2155
2526
                next_id = parents[0]
2156
2527
 
2157
 
    @needs_read_lock
2158
 
    def get_revision_inventory(self, revision_id):
2159
 
        """Return inventory of a past revision."""
2160
 
        # TODO: Unify this with get_inventory()
2161
 
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
2162
 
        # must be the same as its revision, so this is trivial.
2163
 
        if revision_id is None:
2164
 
            # This does not make sense: if there is no revision,
2165
 
            # then it is the current tree inventory surely ?!
2166
 
            # and thus get_root_id() is something that looks at the last
2167
 
            # commit on the branch, and the get_root_id is an inventory check.
2168
 
            raise NotImplementedError
2169
 
            # return Inventory(self.get_root_id())
2170
 
        else:
2171
 
            return self.get_inventory(revision_id)
2172
 
 
2173
2528
    def is_shared(self):
2174
2529
        """Return True if this repository is flagged as a shared repository."""
2175
2530
        raise NotImplementedError(self.is_shared)
2209
2564
            return RevisionTree(self, Inventory(root_id=None),
2210
2565
                                _mod_revision.NULL_REVISION)
2211
2566
        else:
2212
 
            inv = self.get_revision_inventory(revision_id)
 
2567
            inv = self.get_inventory(revision_id)
2213
2568
            return RevisionTree(self, inv, revision_id)
2214
2569
 
2215
2570
    def revision_trees(self, revision_ids):
2268
2623
            keys = tsort.topo_sort(parent_map)
2269
2624
        return [None] + list(keys)
2270
2625
 
2271
 
    def pack(self):
 
2626
    def pack(self, hint=None, clean_obsolete_packs=False):
2272
2627
        """Compress the data within the repository.
2273
2628
 
2274
2629
        This operation only makes sense for some repository types. For other
2277
2632
        This stub method does not require a lock, but subclasses should use
2278
2633
        @needs_write_lock as this is a long running call its reasonable to
2279
2634
        implicitly lock for the user.
 
2635
 
 
2636
        :param hint: If not supplied, the whole repository is packed.
 
2637
            If supplied, the repository may use the hint parameter as a
 
2638
            hint for the parts of the repository to pack. A hint can be
 
2639
            obtained from the result of commit_write_group(). Out of
 
2640
            date hints are simply ignored, because concurrent operations
 
2641
            can obsolete them rapidly.
 
2642
 
 
2643
        :param clean_obsolete_packs: Clean obsolete packs immediately after
 
2644
            the pack operation.
2280
2645
        """
2281
2646
 
2282
2647
    def get_transaction(self):
2283
2648
        return self.control_files.get_transaction()
2284
2649
 
2285
2650
    def get_parent_map(self, revision_ids):
2286
 
        """See graph._StackedParentsProvider.get_parent_map"""
 
2651
        """See graph.StackedParentsProvider.get_parent_map"""
2287
2652
        # revisions index works in keys; this just works in revisions
2288
2653
        # therefore wrap and unwrap
2289
2654
        query_keys = []
2298
2663
        for ((revision_id,), parent_keys) in \
2299
2664
                self.revisions.get_parent_map(query_keys).iteritems():
2300
2665
            if parent_keys:
2301
 
                result[revision_id] = tuple(parent_revid
2302
 
                    for (parent_revid,) in parent_keys)
 
2666
                result[revision_id] = tuple([parent_revid
 
2667
                    for (parent_revid,) in parent_keys])
2303
2668
            else:
2304
2669
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2305
2670
        return result
2307
2672
    def _make_parents_provider(self):
2308
2673
        return self
2309
2674
 
 
2675
    @needs_read_lock
 
2676
    def get_known_graph_ancestry(self, revision_ids):
 
2677
        """Return the known graph for a set of revision ids and their ancestors.
 
2678
        """
 
2679
        st = static_tuple.StaticTuple
 
2680
        revision_keys = [st(r_id).intern() for r_id in revision_ids]
 
2681
        known_graph = self.revisions.get_known_graph_ancestry(revision_keys)
 
2682
        return graph.GraphThunkIdsToKeys(known_graph)
 
2683
 
2310
2684
    def get_graph(self, other_repository=None):
2311
2685
        """Return the graph walker for this repository format"""
2312
2686
        parents_provider = self._make_parents_provider()
2313
2687
        if (other_repository is not None and
2314
2688
            not self.has_same_location(other_repository)):
2315
 
            parents_provider = graph._StackedParentsProvider(
 
2689
            parents_provider = graph.StackedParentsProvider(
2316
2690
                [parents_provider, other_repository._make_parents_provider()])
2317
2691
        return graph.Graph(parents_provider)
2318
2692
 
2319
 
    def _get_versioned_file_checker(self, text_key_references=None):
 
2693
    def _get_versioned_file_checker(self, text_key_references=None,
 
2694
        ancestors=None):
2320
2695
        """Return an object suitable for checking versioned files.
2321
2696
        
2322
2697
        :param text_key_references: if non-None, an already built
2324
2699
            to whether they were referred to by the inventory of the
2325
2700
            revision_id that they contain. If None, this will be
2326
2701
            calculated.
 
2702
        :param ancestors: Optional result from
 
2703
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
 
2704
            available.
2327
2705
        """
2328
2706
        return _VersionedFileChecker(self,
2329
 
            text_key_references=text_key_references)
 
2707
            text_key_references=text_key_references, ancestors=ancestors)
2330
2708
 
2331
2709
    def revision_ids_to_search_result(self, result_set):
2332
2710
        """Convert a set of revision ids to a graph SearchResult."""
2382
2760
        return record.get_bytes_as('fulltext')
2383
2761
 
2384
2762
    @needs_read_lock
2385
 
    def check(self, revision_ids=None):
 
2763
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
2386
2764
        """Check consistency of all history of given revision_ids.
2387
2765
 
2388
2766
        Different repository implementations should override _check().
2389
2767
 
2390
2768
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2391
2769
             will be checked.  Typically the last revision_id of a branch.
 
2770
        :param callback_refs: A dict of check-refs to resolve and callback
 
2771
            the check/_check method on the items listed as wanting the ref.
 
2772
            see bzrlib.check.
 
2773
        :param check_repo: If False do not check the repository contents, just 
 
2774
            calculate the data callback_refs requires and call them back.
2392
2775
        """
2393
 
        return self._check(revision_ids)
 
2776
        return self._check(revision_ids, callback_refs=callback_refs,
 
2777
            check_repo=check_repo)
2394
2778
 
2395
 
    def _check(self, revision_ids):
2396
 
        result = check.Check(self)
2397
 
        result.check()
 
2779
    def _check(self, revision_ids, callback_refs, check_repo):
 
2780
        result = check.Check(self, check_repo=check_repo)
 
2781
        result.check(callback_refs)
2398
2782
        return result
2399
2783
 
2400
 
    def _warn_if_deprecated(self):
 
2784
    def _warn_if_deprecated(self, branch=None):
2401
2785
        global _deprecation_warning_done
2402
2786
        if _deprecation_warning_done:
2403
2787
            return
2404
 
        _deprecation_warning_done = True
2405
 
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
2406
 
                % (self._format, self.bzrdir.transport.base))
 
2788
        try:
 
2789
            if branch is None:
 
2790
                conf = config.GlobalConfig()
 
2791
            else:
 
2792
                conf = branch.get_config()
 
2793
            if conf.suppress_warning('format_deprecation'):
 
2794
                return
 
2795
            warning("Format %s for %s is deprecated -"
 
2796
                    " please use 'bzr upgrade' to get better performance"
 
2797
                    % (self._format, self.bzrdir.transport.base))
 
2798
        finally:
 
2799
            _deprecation_warning_done = True
2407
2800
 
2408
2801
    def supports_rich_root(self):
2409
2802
        return self._format.rich_root_data
2649
3042
 
2650
3043
    Once a format is deprecated, just deprecate the initialize and open
2651
3044
    methods on the format class. Do not deprecate the object, as the
2652
 
    object may be created even when a repository instnace hasn't been
 
3045
    object may be created even when a repository instance hasn't been
2653
3046
    created.
2654
3047
 
2655
3048
    Common instance attributes:
2685
3078
    # Does this format have < O(tree_size) delta generation. Used to hint what
2686
3079
    # code path for commit, amongst other things.
2687
3080
    fast_deltas = None
 
3081
    # Does doing a pack operation compress data? Useful for the pack UI command
 
3082
    # (so if there is one pack, the operation can still proceed because it may
 
3083
    # help), and for fetching when data won't have come from the same
 
3084
    # compressor.
 
3085
    pack_compresses = False
 
3086
    # Does the repository inventory storage understand references to trees?
 
3087
    supports_tree_reference = None
 
3088
    # Is the format experimental ?
 
3089
    experimental = False
2688
3090
 
2689
 
    def __str__(self):
2690
 
        return "<%s>" % self.__class__.__name__
 
3091
    def __repr__(self):
 
3092
        return "%s()" % self.__class__.__name__
2691
3093
 
2692
3094
    def __eq__(self, other):
2693
3095
        # format objects are generally stateless
2706
3108
        """
2707
3109
        try:
2708
3110
            transport = a_bzrdir.get_repository_transport(None)
2709
 
            format_string = transport.get("format").read()
 
3111
            format_string = transport.get_bytes("format")
2710
3112
            return format_registry.get(format_string)
2711
3113
        except errors.NoSuchFile:
2712
3114
            raise errors.NoRepositoryPresent(a_bzrdir)
2794
3196
        raise NotImplementedError(self.network_name)
2795
3197
 
2796
3198
    def check_conversion_target(self, target_format):
2797
 
        raise NotImplementedError(self.check_conversion_target)
 
3199
        if self.rich_root_data and not target_format.rich_root_data:
 
3200
            raise errors.BadConversionTarget(
 
3201
                'Does not support rich root data.', target_format,
 
3202
                from_format=self)
 
3203
        if (self.supports_tree_reference and 
 
3204
            not getattr(target_format, 'supports_tree_reference', False)):
 
3205
            raise errors.BadConversionTarget(
 
3206
                'Does not support nested trees', target_format,
 
3207
                from_format=self)
2798
3208
 
2799
3209
    def open(self, a_bzrdir, _found=False):
2800
3210
        """Return an instance of this format for the bzrdir a_bzrdir.
2803
3213
        """
2804
3214
        raise NotImplementedError(self.open)
2805
3215
 
 
3216
    def _run_post_repo_init_hooks(self, repository, a_bzrdir, shared):
 
3217
        from bzrlib.bzrdir import BzrDir, RepoInitHookParams
 
3218
        hooks = BzrDir.hooks['post_repo_init']
 
3219
        if not hooks:
 
3220
            return
 
3221
        params = RepoInitHookParams(repository, self, a_bzrdir, shared)
 
3222
        for hook in hooks:
 
3223
            hook(params)
 
3224
 
2806
3225
 
2807
3226
class MetaDirRepositoryFormat(RepositoryFormat):
2808
3227
    """Common base class for the new repositories using the metadir layout."""
2856
3275
# Pre-0.8 formats that don't have a disk format string (because they are
2857
3276
# versioned by the matching control directory). We use the control directories
2858
3277
# disk format string as a key for the network_name because they meet the
2859
 
# constraints (simple string, unique, immmutable).
 
3278
# constraints (simple string, unique, immutable).
2860
3279
network_format_registry.register_lazy(
2861
3280
    "Bazaar-NG branch, format 5\n",
2862
3281
    'bzrlib.repofmt.weaverepo',
2943
3362
    )
2944
3363
 
2945
3364
# Development formats.
2946
 
# 1.7->1.8 go below here
2947
 
format_registry.register_lazy(
2948
 
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
2949
 
    'bzrlib.repofmt.pack_repo',
2950
 
    'RepositoryFormatPackDevelopment2',
2951
 
    )
 
3365
# Obsolete but kept pending a CHK based subtree format.
2952
3366
format_registry.register_lazy(
2953
3367
    ("Bazaar development format 2 with subtree support "
2954
3368
        "(needs bzr.dev from before 1.8)\n"),
2955
3369
    'bzrlib.repofmt.pack_repo',
2956
3370
    'RepositoryFormatPackDevelopment2Subtree',
2957
3371
    )
2958
 
# 1.9->1.110 go below here
2959
 
format_registry.register_lazy(
2960
 
    # merge-bbc-dev4-to-bzr.dev
2961
 
    "Bazaar development format 5 (needs bzr.dev from before 1.13)\n",
2962
 
    'bzrlib.repofmt.pack_repo',
2963
 
    'RepositoryFormatPackDevelopment5',
2964
 
    )
2965
 
format_registry.register_lazy(
2966
 
    # merge-bbc-dev4-to-bzr.dev
2967
 
    ("Bazaar development format 5 with subtree support"
2968
 
     " (needs bzr.dev from before 1.13)\n"),
2969
 
    'bzrlib.repofmt.pack_repo',
2970
 
    'RepositoryFormatPackDevelopment5Subtree',
2971
 
    )
2972
 
format_registry.register_lazy(
2973
 
    # merge-bbc-dev4-to-bzr.dev
2974
 
    ('Bazaar development format 5 hash 16'
2975
 
     ' (needs bzr.dev from before 1.13)\n'),
2976
 
    'bzrlib.repofmt.pack_repo',
2977
 
    'RepositoryFormatPackDevelopment5Hash16',
2978
 
    )
2979
 
format_registry.register_lazy(
2980
 
    # merge-bbc-dev4-to-bzr.dev
2981
 
    ('Bazaar development format 5 hash 255'
2982
 
     ' (needs bzr.dev from before 1.13)\n'),
2983
 
    'bzrlib.repofmt.pack_repo',
2984
 
    'RepositoryFormatPackDevelopment5Hash255',
2985
 
    )
2986
 
format_registry.register_lazy(
2987
 
    'Bazaar development format - hash16chk+gc rich-root (needs bzr.dev from 1.14)\n',
2988
 
    'bzrlib.repofmt.groupcompress_repo',
2989
 
    'RepositoryFormatPackGCCHK16',
2990
 
    )
2991
 
format_registry.register_lazy(
2992
 
    'Bazaar development format - hash255chk+gc rich-root (needs bzr.dev from 1.14)\n',
2993
 
    'bzrlib.repofmt.groupcompress_repo',
2994
 
    'RepositoryFormatPackGCCHK255',
2995
 
    )
2996
 
format_registry.register_lazy(
2997
 
    'Bazaar development format - hash255chk+gc rich-root bigpage (needs bzr.dev from 1.14)\n',
2998
 
    'bzrlib.repofmt.groupcompress_repo',
2999
 
    'RepositoryFormatPackGCCHK255Big',
 
3372
 
 
3373
# 1.14->1.16 go below here
 
3374
format_registry.register_lazy(
 
3375
    'Bazaar development format - group compression and chk inventory'
 
3376
        ' (needs bzr.dev from 1.14)\n',
 
3377
    'bzrlib.repofmt.groupcompress_repo',
 
3378
    'RepositoryFormatCHK1',
 
3379
    )
 
3380
 
 
3381
format_registry.register_lazy(
 
3382
    'Bazaar development format - chk repository with bencode revision '
 
3383
        'serialization (needs bzr.dev from 1.16)\n',
 
3384
    'bzrlib.repofmt.groupcompress_repo',
 
3385
    'RepositoryFormatCHK2',
 
3386
    )
 
3387
format_registry.register_lazy(
 
3388
    'Bazaar repository format 2a (needs bzr 1.16 or later)\n',
 
3389
    'bzrlib.repofmt.groupcompress_repo',
 
3390
    'RepositoryFormat2a',
3000
3391
    )
3001
3392
 
3002
3393
 
3041
3432
 
3042
3433
        :param revision_id: if None all content is copied, if NULL_REVISION no
3043
3434
                            content is copied.
3044
 
        :param pb: optional progress bar to use for progress reports. If not
3045
 
                   provided a default one will be created.
 
3435
        :param pb: ignored.
3046
3436
        :return: None.
3047
3437
        """
 
3438
        ui.ui_factory.warn_experimental_format_fetch(self)
3048
3439
        from bzrlib.fetch import RepoFetcher
 
3440
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
3441
        if self.source._format.network_name() != self.target._format.network_name():
 
3442
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
3443
                from_format=self.source._format,
 
3444
                to_format=self.target._format)
3049
3445
        f = RepoFetcher(to_repository=self.target,
3050
3446
                               from_repository=self.source,
3051
3447
                               last_revision=revision_id,
3052
3448
                               fetch_spec=fetch_spec,
3053
 
                               pb=pb, find_ghosts=find_ghosts)
 
3449
                               find_ghosts=find_ghosts)
3054
3450
 
3055
3451
    def _walk_to_common_revisions(self, revision_ids):
3056
3452
        """Walk out from revision_ids in source to revisions target has.
3060
3456
        """
3061
3457
        target_graph = self.target.get_graph()
3062
3458
        revision_ids = frozenset(revision_ids)
3063
 
        # Fast path for the case where all the revisions are already in the
3064
 
        # target repo.
3065
 
        # (Although this does incur an extra round trip for the
3066
 
        # fairly common case where the target doesn't already have the revision
3067
 
        # we're pushing.)
3068
 
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
3069
 
            return graph.SearchResult(revision_ids, set(), 0, set())
3070
3459
        missing_revs = set()
3071
3460
        source_graph = self.source.get_graph()
3072
3461
        # ensure we don't pay silly lookup costs.
3232
3621
                self.target.texts.insert_record_stream(
3233
3622
                    self.source.texts.get_record_stream(
3234
3623
                        self.source.texts.keys(), 'topological', False))
3235
 
                pb.update('copying inventory', 0, 1)
 
3624
                pb.update('Copying inventory', 0, 1)
3236
3625
                self.target.inventories.insert_record_stream(
3237
3626
                    self.source.inventories.get_record_stream(
3238
3627
                        self.source.inventories.keys(), 'topological', False))
3259
3648
        # so the first thing is to get a subset of the revisions to
3260
3649
        # satisfy revision_id in source, and then eliminate those that
3261
3650
        # we do already have.
3262
 
        # this is slow on high latency connection to self, but as as this
 
3651
        # this is slow on high latency connection to self, but as this
3263
3652
        # disk format scales terribly for push anyway due to rewriting
3264
3653
        # inventory.weave, this is considered acceptable.
3265
3654
        # - RBC 20060209
3352
3741
        return self.source.revision_ids_to_search_result(result_set)
3353
3742
 
3354
3743
 
3355
 
class InterPackRepo(InterSameDataRepository):
3356
 
    """Optimised code paths between Pack based repositories."""
3357
 
 
3358
 
    @classmethod
3359
 
    def _get_repo_format_to_test(self):
3360
 
        from bzrlib.repofmt import pack_repo
3361
 
        return pack_repo.RepositoryFormatKnitPack1()
3362
 
 
3363
 
    @staticmethod
3364
 
    def is_compatible(source, target):
3365
 
        """Be compatible with known Pack formats.
3366
 
 
3367
 
        We don't test for the stores being of specific types because that
3368
 
        could lead to confusing results, and there is no need to be
3369
 
        overly general.
3370
 
 
3371
 
        Do not support CHK based repositories at this point.
3372
 
        """
3373
 
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
3374
 
        # XXX: This format is scheduled for termination
3375
 
        # from bzrlib.repofmt.groupcompress_repo import (
3376
 
        #     RepositoryFormatPackGCPlain,
3377
 
        #     )
3378
 
        try:
3379
 
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
3380
 
                isinstance(target._format, RepositoryFormatPack))
3381
 
        except AttributeError:
3382
 
            return False
3383
 
        if not are_packs:
3384
 
            return False
3385
 
        # if (isinstance(source._format, RepositoryFormatPackGCPlain)
3386
 
        #     or isinstance(target._format, RepositoryFormatPackGCPlain)):
3387
 
        #     return False
3388
 
        return (InterRepository._same_model(source, target) and
3389
 
            not source._format.supports_chks)
3390
 
 
3391
 
    @needs_write_lock
3392
 
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
3393
 
            fetch_spec=None):
3394
 
        """See InterRepository.fetch()."""
3395
 
        if (len(self.source._fallback_repositories) > 0 or
3396
 
            len(self.target._fallback_repositories) > 0):
3397
 
            # The pack layer is not aware of fallback repositories, so when
3398
 
            # fetching from a stacked repository or into a stacked repository
3399
 
            # we use the generic fetch logic which uses the VersionedFiles
3400
 
            # attributes on repository.
3401
 
            from bzrlib.fetch import RepoFetcher
3402
 
            fetcher = RepoFetcher(self.target, self.source, revision_id,
3403
 
                    pb, find_ghosts, fetch_spec=fetch_spec)
3404
 
        if fetch_spec is not None:
3405
 
            if len(list(fetch_spec.heads)) != 1:
3406
 
                raise AssertionError(
3407
 
                    "InterPackRepo.fetch doesn't support "
3408
 
                    "fetching multiple heads yet.")
3409
 
            revision_id = list(fetch_spec.heads)[0]
3410
 
            fetch_spec = None
3411
 
        if revision_id is None:
3412
 
            # TODO:
3413
 
            # everything to do - use pack logic
3414
 
            # to fetch from all packs to one without
3415
 
            # inventory parsing etc, IFF nothing to be copied is in the target.
3416
 
            # till then:
3417
 
            source_revision_ids = frozenset(self.source.all_revision_ids())
3418
 
            revision_ids = source_revision_ids - \
3419
 
                frozenset(self.target.get_parent_map(source_revision_ids))
3420
 
            revision_keys = [(revid,) for revid in revision_ids]
3421
 
            index = self.target._pack_collection.revision_index.combined_index
3422
 
            present_revision_ids = set(item[1][0] for item in
3423
 
                index.iter_entries(revision_keys))
3424
 
            revision_ids = set(revision_ids) - present_revision_ids
3425
 
            # implementing the TODO will involve:
3426
 
            # - detecting when all of a pack is selected
3427
 
            # - avoiding as much as possible pre-selection, so the
3428
 
            # more-core routines such as create_pack_from_packs can filter in
3429
 
            # a just-in-time fashion. (though having a HEADS list on a
3430
 
            # repository might make this a lot easier, because we could
3431
 
            # sensibly detect 'new revisions' without doing a full index scan.
3432
 
        elif _mod_revision.is_null(revision_id):
3433
 
            # nothing to do:
3434
 
            return (0, [])
3435
 
        else:
3436
 
            try:
3437
 
                revision_ids = self.search_missing_revision_ids(revision_id,
3438
 
                    find_ghosts=find_ghosts).get_keys()
3439
 
            except errors.NoSuchRevision:
3440
 
                raise errors.InstallFailed([revision_id])
3441
 
            if len(revision_ids) == 0:
3442
 
                return (0, [])
3443
 
        return self._pack(self.source, self.target, revision_ids)
3444
 
 
3445
 
    def _pack(self, source, target, revision_ids):
3446
 
        from bzrlib.repofmt.pack_repo import Packer
3447
 
        packs = source._pack_collection.all_packs()
3448
 
        pack = Packer(self.target._pack_collection, packs, '.fetch',
3449
 
            revision_ids).pack()
3450
 
        if pack is not None:
3451
 
            self.target._pack_collection._save_pack_names()
3452
 
            copied_revs = pack.get_revision_count()
3453
 
            # Trigger an autopack. This may duplicate effort as we've just done
3454
 
            # a pack creation, but for now it is simpler to think about as
3455
 
            # 'upload data, then repack if needed'.
3456
 
            self.target._pack_collection.autopack()
3457
 
            return (copied_revs, [])
3458
 
        else:
3459
 
            return (0, [])
3460
 
 
3461
 
    @needs_read_lock
3462
 
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
3463
 
        """See InterRepository.missing_revision_ids().
3464
 
 
3465
 
        :param find_ghosts: Find ghosts throughout the ancestry of
3466
 
            revision_id.
3467
 
        """
3468
 
        if not find_ghosts and revision_id is not None:
3469
 
            return self._walk_to_common_revisions([revision_id])
3470
 
        elif revision_id is not None:
3471
 
            # Find ghosts: search for revisions pointing from one repository to
3472
 
            # the other, and vice versa, anywhere in the history of revision_id.
3473
 
            graph = self.target.get_graph(other_repository=self.source)
3474
 
            searcher = graph._make_breadth_first_searcher([revision_id])
3475
 
            found_ids = set()
3476
 
            while True:
3477
 
                try:
3478
 
                    next_revs, ghosts = searcher.next_with_ghosts()
3479
 
                except StopIteration:
3480
 
                    break
3481
 
                if revision_id in ghosts:
3482
 
                    raise errors.NoSuchRevision(self.source, revision_id)
3483
 
                found_ids.update(next_revs)
3484
 
                found_ids.update(ghosts)
3485
 
            found_ids = frozenset(found_ids)
3486
 
            # Double query here: should be able to avoid this by changing the
3487
 
            # graph api further.
3488
 
            result_set = found_ids - frozenset(
3489
 
                self.target.get_parent_map(found_ids))
3490
 
        else:
3491
 
            source_ids = self.source.all_revision_ids()
3492
 
            # source_ids is the worst possible case we may need to pull.
3493
 
            # now we want to filter source_ids against what we actually
3494
 
            # have in target, but don't try to check for existence where we know
3495
 
            # we do not have a revision as that would be pointless.
3496
 
            target_ids = set(self.target.all_revision_ids())
3497
 
            result_set = set(source_ids).difference(target_ids)
3498
 
        return self.source.revision_ids_to_search_result(result_set)
3499
 
 
3500
 
 
3501
 
class InterDifferingSerializer(InterKnitRepo):
 
3744
class InterDifferingSerializer(InterRepository):
3502
3745
 
3503
3746
    @classmethod
3504
3747
    def _get_repo_format_to_test(self):
3507
3750
    @staticmethod
3508
3751
    def is_compatible(source, target):
3509
3752
        """Be compatible with Knit2 source and Knit3 target"""
3510
 
        # XXX: What do we need to do to support fetching them?
3511
 
        # if source.supports_rich_root() != target.supports_rich_root():
3512
 
        #     return False
3513
 
        # Ideally, we'd support fetching if the source had no tree references
3514
 
        # even if it supported them...
3515
 
        # XXX: What do we need to do to support fetching them?
3516
 
        # if (getattr(source._format, 'supports_tree_reference', False) and
3517
 
        #     not getattr(target._format, 'supports_tree_reference', False)):
3518
 
        #    return False
 
3753
        # This is redundant with format.check_conversion_target(), however that
 
3754
        # raises an exception, and we just want to say "False" as in we won't
 
3755
        # support converting between these formats.
 
3756
        if 'IDS_never' in debug.debug_flags:
 
3757
            return False
 
3758
        if source.supports_rich_root() and not target.supports_rich_root():
 
3759
            return False
 
3760
        if (source._format.supports_tree_reference
 
3761
            and not target._format.supports_tree_reference):
 
3762
            return False
 
3763
        if target._fallback_repositories and target._format.supports_chks:
 
3764
            # IDS doesn't know how to copy CHKs for the parent inventories it
 
3765
            # adds to stacked repos.
 
3766
            return False
 
3767
        if 'IDS_always' in debug.debug_flags:
 
3768
            return True
 
3769
        # Only use this code path for local source and target.  IDS does far
 
3770
        # too much IO (both bandwidth and roundtrips) over a network.
 
3771
        if not source.bzrdir.transport.base.startswith('file:///'):
 
3772
            return False
 
3773
        if not target.bzrdir.transport.base.startswith('file:///'):
 
3774
            return False
3519
3775
        return True
3520
3776
 
3521
 
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
 
3777
    def _get_trees(self, revision_ids, cache):
 
3778
        possible_trees = []
 
3779
        for rev_id in revision_ids:
 
3780
            if rev_id in cache:
 
3781
                possible_trees.append((rev_id, cache[rev_id]))
 
3782
            else:
 
3783
                # Not cached, but inventory might be present anyway.
 
3784
                try:
 
3785
                    tree = self.source.revision_tree(rev_id)
 
3786
                except errors.NoSuchRevision:
 
3787
                    # Nope, parent is ghost.
 
3788
                    pass
 
3789
                else:
 
3790
                    cache[rev_id] = tree
 
3791
                    possible_trees.append((rev_id, tree))
 
3792
        return possible_trees
 
3793
 
 
3794
    def _get_delta_for_revision(self, tree, parent_ids, possible_trees):
3522
3795
        """Get the best delta and base for this revision.
3523
3796
 
3524
3797
        :return: (basis_id, delta)
3525
3798
        """
3526
 
        possible_trees = [(parent_id, cache[parent_id])
3527
 
                          for parent_id in parent_ids
3528
 
                           if parent_id in cache]
3529
 
        if len(possible_trees) == 0:
3530
 
            # There either aren't any parents, or the parents aren't in the
3531
 
            # cache, so just use the last converted tree
3532
 
            possible_trees.append((basis_id, cache[basis_id]))
3533
3799
        deltas = []
 
3800
        # Generate deltas against each tree, to find the shortest.
 
3801
        texts_possibly_new_in_tree = set()
3534
3802
        for basis_id, basis_tree in possible_trees:
3535
3803
            delta = tree.inventory._make_delta(basis_tree.inventory)
 
3804
            for old_path, new_path, file_id, new_entry in delta:
 
3805
                if new_path is None:
 
3806
                    # This file_id isn't present in the new rev, so we don't
 
3807
                    # care about it.
 
3808
                    continue
 
3809
                if not new_path:
 
3810
                    # Rich roots are handled elsewhere...
 
3811
                    continue
 
3812
                kind = new_entry.kind
 
3813
                if kind != 'directory' and kind != 'file':
 
3814
                    # No text record associated with this inventory entry.
 
3815
                    continue
 
3816
                # This is a directory or file that has changed somehow.
 
3817
                texts_possibly_new_in_tree.add((file_id, new_entry.revision))
3536
3818
            deltas.append((len(delta), basis_id, delta))
3537
3819
        deltas.sort()
3538
3820
        return deltas[0][1:]
3539
3821
 
3540
 
    def _fetch_batch(self, revision_ids, basis_id, cache):
 
3822
    def _fetch_parent_invs_for_stacking(self, parent_map, cache):
 
3823
        """Find all parent revisions that are absent, but for which the
 
3824
        inventory is present, and copy those inventories.
 
3825
 
 
3826
        This is necessary to preserve correctness when the source is stacked
 
3827
        without fallbacks configured.  (Note that in cases like upgrade the
 
3828
        source may be not have _fallback_repositories even though it is
 
3829
        stacked.)
 
3830
        """
 
3831
        parent_revs = set()
 
3832
        for parents in parent_map.values():
 
3833
            parent_revs.update(parents)
 
3834
        present_parents = self.source.get_parent_map(parent_revs)
 
3835
        absent_parents = set(parent_revs).difference(present_parents)
 
3836
        parent_invs_keys_for_stacking = self.source.inventories.get_parent_map(
 
3837
            (rev_id,) for rev_id in absent_parents)
 
3838
        parent_inv_ids = [key[-1] for key in parent_invs_keys_for_stacking]
 
3839
        for parent_tree in self.source.revision_trees(parent_inv_ids):
 
3840
            current_revision_id = parent_tree.get_revision_id()
 
3841
            parents_parents_keys = parent_invs_keys_for_stacking[
 
3842
                (current_revision_id,)]
 
3843
            parents_parents = [key[-1] for key in parents_parents_keys]
 
3844
            basis_id = _mod_revision.NULL_REVISION
 
3845
            basis_tree = self.source.revision_tree(basis_id)
 
3846
            delta = parent_tree.inventory._make_delta(basis_tree.inventory)
 
3847
            self.target.add_inventory_by_delta(
 
3848
                basis_id, delta, current_revision_id, parents_parents)
 
3849
            cache[current_revision_id] = parent_tree
 
3850
 
 
3851
    def _fetch_batch(self, revision_ids, basis_id, cache, a_graph=None):
3541
3852
        """Fetch across a few revisions.
3542
3853
 
3543
3854
        :param revision_ids: The revisions to copy
3544
3855
        :param basis_id: The revision_id of a tree that must be in cache, used
3545
3856
            as a basis for delta when no other base is available
3546
3857
        :param cache: A cache of RevisionTrees that we can use.
 
3858
        :param a_graph: A Graph object to determine the heads() of the
 
3859
            rich-root data stream.
3547
3860
        :return: The revision_id of the last converted tree. The RevisionTree
3548
3861
            for it will be in cache
3549
3862
        """
3555
3868
        pending_deltas = []
3556
3869
        pending_revisions = []
3557
3870
        parent_map = self.source.get_parent_map(revision_ids)
3558
 
        # NB: This fails with dubious inventory data (when inv A has rev OLD
3559
 
        # for file F, and in B, after A, has rev A for file F) when A and B are
3560
 
        # in different groups.
 
3871
        self._fetch_parent_invs_for_stacking(parent_map, cache)
 
3872
        self.source._safe_to_return_from_cache = True
3561
3873
        for tree in self.source.revision_trees(revision_ids):
 
3874
            # Find a inventory delta for this revision.
 
3875
            # Find text entries that need to be copied, too.
3562
3876
            current_revision_id = tree.get_revision_id()
3563
3877
            parent_ids = parent_map.get(current_revision_id, ())
 
3878
            parent_trees = self._get_trees(parent_ids, cache)
 
3879
            possible_trees = list(parent_trees)
 
3880
            if len(possible_trees) == 0:
 
3881
                # There either aren't any parents, or the parents are ghosts,
 
3882
                # so just use the last converted tree.
 
3883
                possible_trees.append((basis_id, cache[basis_id]))
3564
3884
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3565
 
                                                           basis_id, cache)
 
3885
                                                           possible_trees)
 
3886
            revision = self.source.get_revision(current_revision_id)
 
3887
            pending_deltas.append((basis_id, delta,
 
3888
                current_revision_id, revision.parent_ids))
3566
3889
            if self._converting_to_rich_root:
3567
3890
                self._revision_id_to_root_id[current_revision_id] = \
3568
3891
                    tree.get_root_id()
3569
 
            # Find text entries that need to be copied
 
3892
            # Determine which texts are in present in this revision but not in
 
3893
            # any of the available parents.
 
3894
            texts_possibly_new_in_tree = set()
3570
3895
            for old_path, new_path, file_id, entry in delta:
3571
 
                if new_path is not None:
3572
 
                    if not new_path:
3573
 
                        # This is the root
3574
 
                        if not self.target.supports_rich_root():
3575
 
                            # The target doesn't support rich root, so we don't
3576
 
                            # copy
3577
 
                            continue
3578
 
                        if self._converting_to_rich_root:
3579
 
                            # This can't be copied normally, we have to insert
3580
 
                            # it specially
3581
 
                            root_keys_to_create.add((file_id, entry.revision))
3582
 
                            continue
3583
 
                    text_keys.add((file_id, entry.revision))
3584
 
            revision = self.source.get_revision(current_revision_id)
3585
 
            pending_deltas.append((basis_id, delta,
3586
 
                current_revision_id, revision.parent_ids))
 
3896
                if new_path is None:
 
3897
                    # This file_id isn't present in the new rev
 
3898
                    continue
 
3899
                if not new_path:
 
3900
                    # This is the root
 
3901
                    if not self.target.supports_rich_root():
 
3902
                        # The target doesn't support rich root, so we don't
 
3903
                        # copy
 
3904
                        continue
 
3905
                    if self._converting_to_rich_root:
 
3906
                        # This can't be copied normally, we have to insert
 
3907
                        # it specially
 
3908
                        root_keys_to_create.add((file_id, entry.revision))
 
3909
                        continue
 
3910
                kind = entry.kind
 
3911
                texts_possibly_new_in_tree.add((file_id, entry.revision))
 
3912
            for basis_id, basis_tree in possible_trees:
 
3913
                basis_inv = basis_tree.inventory
 
3914
                for file_key in list(texts_possibly_new_in_tree):
 
3915
                    file_id, file_revision = file_key
 
3916
                    try:
 
3917
                        entry = basis_inv[file_id]
 
3918
                    except errors.NoSuchId:
 
3919
                        continue
 
3920
                    if entry.revision == file_revision:
 
3921
                        texts_possibly_new_in_tree.remove(file_key)
 
3922
            text_keys.update(texts_possibly_new_in_tree)
3587
3923
            pending_revisions.append(revision)
3588
3924
            cache[current_revision_id] = tree
3589
3925
            basis_id = current_revision_id
 
3926
        self.source._safe_to_return_from_cache = False
3590
3927
        # Copy file texts
3591
3928
        from_texts = self.source.texts
3592
3929
        to_texts = self.target.texts
3593
3930
        if root_keys_to_create:
3594
 
            NULL_REVISION = _mod_revision.NULL_REVISION
3595
 
            def _get_parent_keys(root_key):
3596
 
                root_id, rev_id = root_key
3597
 
                # Include direct parents of the revision, but only if they used
3598
 
                # the same root_id.
3599
 
                parent_keys = tuple([(root_id, parent_id)
3600
 
                    for parent_id in parent_map[rev_id]
3601
 
                    if parent_id != NULL_REVISION and
3602
 
                        self._revision_id_to_root_id.get(parent_id, root_id) == root_id])
3603
 
                return parent_keys
3604
 
            def new_root_data_stream():
3605
 
                for root_key in root_keys_to_create:
3606
 
                    parent_keys = _get_parent_keys(root_key)
3607
 
                    yield versionedfile.FulltextContentFactory(root_key,
3608
 
                        parent_keys, None, '')
3609
 
            to_texts.insert_record_stream(new_root_data_stream())
 
3931
            root_stream = _mod_fetch._new_root_data_stream(
 
3932
                root_keys_to_create, self._revision_id_to_root_id, parent_map,
 
3933
                self.source, graph=a_graph)
 
3934
            to_texts.insert_record_stream(root_stream)
3610
3935
        to_texts.insert_record_stream(from_texts.get_record_stream(
3611
3936
            text_keys, self.target._format._fetch_order,
3612
3937
            not self.target._format._fetch_uses_deltas))
3613
 
        # insert deltas
 
3938
        # insert inventory deltas
3614
3939
        for delta in pending_deltas:
3615
3940
            self.target.add_inventory_by_delta(*delta)
 
3941
        if self.target._fallback_repositories:
 
3942
            # Make sure this stacked repository has all the parent inventories
 
3943
            # for the new revisions that we are about to insert.  We do this
 
3944
            # before adding the revisions so that no revision is added until
 
3945
            # all the inventories it may depend on are added.
 
3946
            # Note that this is overzealous, as we may have fetched these in an
 
3947
            # earlier batch.
 
3948
            parent_ids = set()
 
3949
            revision_ids = set()
 
3950
            for revision in pending_revisions:
 
3951
                revision_ids.add(revision.revision_id)
 
3952
                parent_ids.update(revision.parent_ids)
 
3953
            parent_ids.difference_update(revision_ids)
 
3954
            parent_ids.discard(_mod_revision.NULL_REVISION)
 
3955
            parent_map = self.source.get_parent_map(parent_ids)
 
3956
            # we iterate over parent_map and not parent_ids because we don't
 
3957
            # want to try copying any revision which is a ghost
 
3958
            for parent_tree in self.source.revision_trees(parent_map):
 
3959
                current_revision_id = parent_tree.get_revision_id()
 
3960
                parents_parents = parent_map[current_revision_id]
 
3961
                possible_trees = self._get_trees(parents_parents, cache)
 
3962
                if len(possible_trees) == 0:
 
3963
                    # There either aren't any parents, or the parents are
 
3964
                    # ghosts, so just use the last converted tree.
 
3965
                    possible_trees.append((basis_id, cache[basis_id]))
 
3966
                basis_id, delta = self._get_delta_for_revision(parent_tree,
 
3967
                    parents_parents, possible_trees)
 
3968
                self.target.add_inventory_by_delta(
 
3969
                    basis_id, delta, current_revision_id, parents_parents)
3616
3970
        # insert signatures and revisions
3617
3971
        for revision in pending_revisions:
3618
3972
            try:
3630
3984
 
3631
3985
        :param revision_ids: The list of revisions to fetch. Must be in
3632
3986
            topological order.
3633
 
        :param pb: A ProgressBar
 
3987
        :param pb: A ProgressTask
3634
3988
        :return: None
3635
3989
        """
3636
3990
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3638
3992
        cache = lru_cache.LRUCache(100)
3639
3993
        cache[basis_id] = basis_tree
3640
3994
        del basis_tree # We don't want to hang on to it here
 
3995
        hints = []
 
3996
        if self._converting_to_rich_root and len(revision_ids) > 100:
 
3997
            a_graph = _mod_fetch._get_rich_root_heads_graph(self.source,
 
3998
                                                            revision_ids)
 
3999
        else:
 
4000
            a_graph = None
 
4001
 
3641
4002
        for offset in range(0, len(revision_ids), batch_size):
3642
4003
            self.target.start_write_group()
3643
4004
            try:
3644
4005
                pb.update('Transferring revisions', offset,
3645
4006
                          len(revision_ids))
3646
4007
                batch = revision_ids[offset:offset+batch_size]
3647
 
                basis_id = self._fetch_batch(batch, basis_id, cache)
 
4008
                basis_id = self._fetch_batch(batch, basis_id, cache,
 
4009
                                             a_graph=a_graph)
3648
4010
            except:
 
4011
                self.source._safe_to_return_from_cache = False
3649
4012
                self.target.abort_write_group()
3650
4013
                raise
3651
4014
            else:
3652
 
                self.target.commit_write_group()
 
4015
                hint = self.target.commit_write_group()
 
4016
                if hint:
 
4017
                    hints.extend(hint)
 
4018
        if hints and self.target._format.pack_compresses:
 
4019
            self.target.pack(hint=hints)
3653
4020
        pb.update('Transferring revisions', len(revision_ids),
3654
4021
                  len(revision_ids))
3655
4022
 
3659
4026
        """See InterRepository.fetch()."""
3660
4027
        if fetch_spec is not None:
3661
4028
            raise AssertionError("Not implemented yet...")
 
4029
        ui.ui_factory.warn_experimental_format_fetch(self)
3662
4030
        if (not self.source.supports_rich_root()
3663
4031
            and self.target.supports_rich_root()):
3664
4032
            self._converting_to_rich_root = True
3665
4033
            self._revision_id_to_root_id = {}
3666
4034
        else:
3667
4035
            self._converting_to_rich_root = False
 
4036
        # See <https://launchpad.net/bugs/456077> asking for a warning here
 
4037
        if self.source._format.network_name() != self.target._format.network_name():
 
4038
            ui.ui_factory.show_user_warning('cross_format_fetch',
 
4039
                from_format=self.source._format,
 
4040
                to_format=self.target._format)
3668
4041
        revision_ids = self.target.search_missing_revision_ids(self.source,
3669
4042
            revision_id, find_ghosts=find_ghosts).get_keys()
3670
4043
        if not revision_ids:
3676
4049
        # Walk though all revisions; get inventory deltas, copy referenced
3677
4050
        # texts that delta references, insert the delta, revision and
3678
4051
        # signature.
3679
 
        first_rev = self.source.get_revision(revision_ids[0])
3680
4052
        if pb is None:
3681
4053
            my_pb = ui.ui_factory.nested_progress_bar()
3682
4054
            pb = my_pb
3719
4091
InterRepository.register_optimiser(InterSameDataRepository)
3720
4092
InterRepository.register_optimiser(InterWeaveRepo)
3721
4093
InterRepository.register_optimiser(InterKnitRepo)
3722
 
InterRepository.register_optimiser(InterPackRepo)
3723
4094
 
3724
4095
 
3725
4096
class CopyConverter(object):
3741
4112
        :param to_convert: The disk object to convert.
3742
4113
        :param pb: a progress bar to use for progress information.
3743
4114
        """
3744
 
        self.pb = pb
 
4115
        pb = ui.ui_factory.nested_progress_bar()
3745
4116
        self.count = 0
3746
4117
        self.total = 4
3747
4118
        # this is only useful with metadir layouts - separated repo content.
3748
4119
        # trigger an assertion if not such
3749
4120
        repo._format.get_format_string()
3750
4121
        self.repo_dir = repo.bzrdir
3751
 
        self.step('Moving repository to repository.backup')
 
4122
        pb.update('Moving repository to repository.backup')
3752
4123
        self.repo_dir.transport.move('repository', 'repository.backup')
3753
4124
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
3754
4125
        repo._format.check_conversion_target(self.target_format)
3755
4126
        self.source_repo = repo._format.open(self.repo_dir,
3756
4127
            _found=True,
3757
4128
            _override_transport=backup_transport)
3758
 
        self.step('Creating new repository')
 
4129
        pb.update('Creating new repository')
3759
4130
        converted = self.target_format.initialize(self.repo_dir,
3760
4131
                                                  self.source_repo.is_shared())
3761
4132
        converted.lock_write()
3762
4133
        try:
3763
 
            self.step('Copying content into repository.')
 
4134
            pb.update('Copying content')
3764
4135
            self.source_repo.copy_content_into(converted)
3765
4136
        finally:
3766
4137
            converted.unlock()
3767
 
        self.step('Deleting old repository content.')
 
4138
        pb.update('Deleting old repository content')
3768
4139
        self.repo_dir.transport.delete_tree('repository.backup')
3769
 
        self.pb.note('repository converted')
3770
 
 
3771
 
    def step(self, message):
3772
 
        """Update the pb by a step."""
3773
 
        self.count +=1
3774
 
        self.pb.update(message, self.count, self.total)
 
4140
        ui.ui_factory.note('repository converted')
 
4141
        pb.finished()
3775
4142
 
3776
4143
 
3777
4144
_unescape_map = {
3806
4173
 
3807
4174
class _VersionedFileChecker(object):
3808
4175
 
3809
 
    def __init__(self, repository, text_key_references=None):
 
4176
    def __init__(self, repository, text_key_references=None, ancestors=None):
3810
4177
        self.repository = repository
3811
4178
        self.text_index = self.repository._generate_text_key_index(
3812
 
            text_key_references=text_key_references)
 
4179
            text_key_references=text_key_references, ancestors=ancestors)
3813
4180
 
3814
4181
    def calculate_file_version_parents(self, text_key):
3815
4182
        """Calculate the correct parents for a file version according to
3833
4200
            revision_id) tuples for versions that are present in this versioned
3834
4201
            file, but not used by the corresponding inventory.
3835
4202
        """
 
4203
        local_progress = None
 
4204
        if progress_bar is None:
 
4205
            local_progress = ui.ui_factory.nested_progress_bar()
 
4206
            progress_bar = local_progress
 
4207
        try:
 
4208
            return self._check_file_version_parents(texts, progress_bar)
 
4209
        finally:
 
4210
            if local_progress:
 
4211
                local_progress.finished()
 
4212
 
 
4213
    def _check_file_version_parents(self, texts, progress_bar):
 
4214
        """See check_file_version_parents."""
3836
4215
        wrong_parents = {}
3837
4216
        self.file_ids = set([file_id for file_id, _ in
3838
4217
            self.text_index.iterkeys()])
3839
4218
        # text keys is now grouped by file_id
3840
 
        n_weaves = len(self.file_ids)
3841
 
        files_in_revisions = {}
3842
 
        revisions_of_files = {}
3843
4219
        n_versions = len(self.text_index)
3844
4220
        progress_bar.update('loading text store', 0, n_versions)
3845
4221
        parent_map = self.repository.texts.get_parent_map(self.text_index)
3847
4223
        text_keys = self.repository.texts.keys()
3848
4224
        unused_keys = frozenset(text_keys) - set(self.text_index)
3849
4225
        for num, key in enumerate(self.text_index.iterkeys()):
3850
 
            if progress_bar is not None:
3851
 
                progress_bar.update('checking text graph', num, n_versions)
 
4226
            progress_bar.update('checking text graph', num, n_versions)
3852
4227
            correct_parents = self.calculate_file_version_parents(key)
3853
4228
            try:
3854
4229
                knit_parents = parent_map[key]
3903
4278
        try:
3904
4279
            if resume_tokens:
3905
4280
                self.target_repo.resume_write_group(resume_tokens)
 
4281
                is_resume = True
3906
4282
            else:
3907
4283
                self.target_repo.start_write_group()
 
4284
                is_resume = False
3908
4285
            try:
3909
4286
                # locked_insert_stream performs a commit|suspend.
3910
 
                return self._locked_insert_stream(stream, src_format)
 
4287
                return self._locked_insert_stream(stream, src_format,
 
4288
                    is_resume)
3911
4289
            except:
3912
4290
                self.target_repo.abort_write_group(suppress_errors=True)
3913
4291
                raise
3914
4292
        finally:
3915
4293
            self.target_repo.unlock()
3916
4294
 
3917
 
    def _locked_insert_stream(self, stream, src_format):
 
4295
    def _locked_insert_stream(self, stream, src_format, is_resume):
3918
4296
        to_serializer = self.target_repo._format._serializer
3919
4297
        src_serializer = src_format._serializer
 
4298
        new_pack = None
3920
4299
        if to_serializer == src_serializer:
3921
4300
            # If serializers match and the target is a pack repository, set the
3922
4301
            # write cache size on the new pack.  This avoids poor performance
3936
4315
            else:
3937
4316
                new_pack.set_write_cache_size(1024*1024)
3938
4317
        for substream_type, substream in stream:
 
4318
            if 'stream' in debug.debug_flags:
 
4319
                mutter('inserting substream: %s', substream_type)
3939
4320
            if substream_type == 'texts':
3940
4321
                self.target_repo.texts.insert_record_stream(substream)
3941
4322
            elif substream_type == 'inventories':
3945
4326
                else:
3946
4327
                    self._extract_and_insert_inventories(
3947
4328
                        substream, src_serializer)
 
4329
            elif substream_type == 'inventory-deltas':
 
4330
                self._extract_and_insert_inventory_deltas(
 
4331
                    substream, src_serializer)
3948
4332
            elif substream_type == 'chk_bytes':
3949
4333
                # XXX: This doesn't support conversions, as it assumes the
3950
4334
                #      conversion was done in the fetch code.
3954
4338
                # required if the serializers are different only in terms of
3955
4339
                # the inventory.
3956
4340
                if src_serializer == to_serializer:
3957
 
                    self.target_repo.revisions.insert_record_stream(
3958
 
                        substream)
 
4341
                    self.target_repo.revisions.insert_record_stream(substream)
3959
4342
                else:
3960
4343
                    self._extract_and_insert_revisions(substream,
3961
4344
                        src_serializer)
3963
4346
                self.target_repo.signatures.insert_record_stream(substream)
3964
4347
            else:
3965
4348
                raise AssertionError('kaboom! %s' % (substream_type,))
 
4349
        # Done inserting data, and the missing_keys calculations will try to
 
4350
        # read back from the inserted data, so flush the writes to the new pack
 
4351
        # (if this is pack format).
 
4352
        if new_pack is not None:
 
4353
            new_pack._write_data('', flush=True)
 
4354
        # Find all the new revisions (including ones from resume_tokens)
 
4355
        missing_keys = self.target_repo.get_missing_parent_inventories(
 
4356
            check_for_missing_texts=is_resume)
3966
4357
        try:
3967
 
            missing_keys = set()
3968
4358
            for prefix, versioned_file in (
3969
4359
                ('texts', self.target_repo.texts),
3970
4360
                ('inventories', self.target_repo.inventories),
3971
4361
                ('revisions', self.target_repo.revisions),
3972
4362
                ('signatures', self.target_repo.signatures),
 
4363
                ('chk_bytes', self.target_repo.chk_bytes),
3973
4364
                ):
 
4365
                if versioned_file is None:
 
4366
                    continue
 
4367
                # TODO: key is often going to be a StaticTuple object
 
4368
                #       I don't believe we can define a method by which
 
4369
                #       (prefix,) + StaticTuple will work, though we could
 
4370
                #       define a StaticTuple.sq_concat that would allow you to
 
4371
                #       pass in either a tuple or a StaticTuple as the second
 
4372
                #       object, so instead we could have:
 
4373
                #       StaticTuple(prefix) + key here...
3974
4374
                missing_keys.update((prefix,) + key for key in
3975
4375
                    versioned_file.get_missing_compression_parent_keys())
3976
4376
        except NotImplementedError:
3985
4385
                # missing keys can handle suspending a write group).
3986
4386
                write_group_tokens = self.target_repo.suspend_write_group()
3987
4387
                return write_group_tokens, missing_keys
3988
 
        self.target_repo.commit_write_group()
 
4388
        hint = self.target_repo.commit_write_group()
 
4389
        if (to_serializer != src_serializer and
 
4390
            self.target_repo._format.pack_compresses):
 
4391
            self.target_repo.pack(hint=hint)
3989
4392
        return [], set()
3990
4393
 
3991
 
    def _extract_and_insert_inventories(self, substream, serializer):
 
4394
    def _extract_and_insert_inventory_deltas(self, substream, serializer):
 
4395
        target_rich_root = self.target_repo._format.rich_root_data
 
4396
        target_tree_refs = self.target_repo._format.supports_tree_reference
 
4397
        for record in substream:
 
4398
            # Insert the delta directly
 
4399
            inventory_delta_bytes = record.get_bytes_as('fulltext')
 
4400
            deserialiser = inventory_delta.InventoryDeltaDeserializer()
 
4401
            try:
 
4402
                parse_result = deserialiser.parse_text_bytes(
 
4403
                    inventory_delta_bytes)
 
4404
            except inventory_delta.IncompatibleInventoryDelta, err:
 
4405
                trace.mutter("Incompatible delta: %s", err.msg)
 
4406
                raise errors.IncompatibleRevision(self.target_repo._format)
 
4407
            basis_id, new_id, rich_root, tree_refs, inv_delta = parse_result
 
4408
            revision_id = new_id
 
4409
            parents = [key[0] for key in record.parents]
 
4410
            self.target_repo.add_inventory_by_delta(
 
4411
                basis_id, inv_delta, revision_id, parents)
 
4412
 
 
4413
    def _extract_and_insert_inventories(self, substream, serializer,
 
4414
            parse_delta=None):
3992
4415
        """Generate a new inventory versionedfile in target, converting data.
3993
4416
 
3994
4417
        The inventory is retrieved from the source, (deserializing it), and
3995
4418
        stored in the target (reserializing it in a different format).
3996
4419
        """
 
4420
        target_rich_root = self.target_repo._format.rich_root_data
 
4421
        target_tree_refs = self.target_repo._format.supports_tree_reference
3997
4422
        for record in substream:
 
4423
            # It's not a delta, so it must be a fulltext in the source
 
4424
            # serializer's format.
3998
4425
            bytes = record.get_bytes_as('fulltext')
3999
4426
            revision_id = record.key[0]
4000
4427
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4001
4428
            parents = [key[0] for key in record.parents]
4002
4429
            self.target_repo.add_inventory(revision_id, inv, parents)
 
4430
            # No need to keep holding this full inv in memory when the rest of
 
4431
            # the substream is likely to be all deltas.
 
4432
            del inv
4003
4433
 
4004
4434
    def _extract_and_insert_revisions(self, substream, serializer):
4005
4435
        for record in substream:
4022
4452
        """Create a StreamSource streaming from from_repository."""
4023
4453
        self.from_repository = from_repository
4024
4454
        self.to_format = to_format
 
4455
        self._record_counter = RecordCounter()
4025
4456
 
4026
4457
    def delta_on_metadata(self):
4027
4458
        """Return True if delta's are permitted on metadata streams.
4054
4485
        return [('signatures', signatures), ('revisions', revisions)]
4055
4486
 
4056
4487
    def _generate_root_texts(self, revs):
4057
 
        """This will be called by __fetch between fetching weave texts and
 
4488
        """This will be called by get_stream between fetching weave texts and
4058
4489
        fetching the inventory weave.
4059
 
 
4060
 
        Subclasses should override this if they need to generate root texts
4061
 
        after fetching weave texts.
4062
4490
        """
4063
4491
        if self._rich_root_upgrade():
4064
 
            import bzrlib.fetch
4065
 
            return bzrlib.fetch.Inter1and2Helper(
 
4492
            return _mod_fetch.Inter1and2Helper(
4066
4493
                self.from_repository).generate_root_texts(revs)
4067
4494
        else:
4068
4495
            return []
4071
4498
        phase = 'file'
4072
4499
        revs = search.get_keys()
4073
4500
        graph = self.from_repository.get_graph()
4074
 
        revs = list(graph.iter_topo_order(revs))
 
4501
        revs = tsort.topo_sort(graph.get_parent_map(revs))
4075
4502
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4076
4503
        text_keys = []
4077
4504
        for knit_kind, file_id, revisions in data_to_fetch:
4096
4523
                # will be valid.
4097
4524
                for _ in self._generate_root_texts(revs):
4098
4525
                    yield _
4099
 
                # NB: This currently reopens the inventory weave in source;
4100
 
                # using a single stream interface instead would avoid this.
4101
 
                from_weave = self.from_repository.inventories
4102
4526
                # we fetch only the referenced inventories because we do not
4103
4527
                # know for unselected inventories whether all their required
4104
4528
                # texts are present in the other repository - it could be
4123
4547
        keys['texts'] = set()
4124
4548
        keys['revisions'] = set()
4125
4549
        keys['inventories'] = set()
 
4550
        keys['chk_bytes'] = set()
4126
4551
        keys['signatures'] = set()
4127
4552
        for key in missing_keys:
4128
4553
            keys[key[0]].add(key[1:])
4135
4560
                    keys['revisions'],))
4136
4561
        for substream_kind, keys in keys.iteritems():
4137
4562
            vf = getattr(self.from_repository, substream_kind)
 
4563
            if vf is None and keys:
 
4564
                    raise AssertionError(
 
4565
                        "cannot fill in keys for a versioned file we don't"
 
4566
                        " have: %s needs %s" % (substream_kind, keys))
 
4567
            if not keys:
 
4568
                # No need to stream something we don't have
 
4569
                continue
 
4570
            if substream_kind == 'inventories':
 
4571
                # Some missing keys are genuinely ghosts, filter those out.
 
4572
                present = self.from_repository.inventories.get_parent_map(keys)
 
4573
                revs = [key[0] for key in present]
 
4574
                # Get the inventory stream more-or-less as we do for the
 
4575
                # original stream; there's no reason to assume that records
 
4576
                # direct from the source will be suitable for the sink.  (Think
 
4577
                # e.g. 2a -> 1.9-rich-root).
 
4578
                for info in self._get_inventory_stream(revs, missing=True):
 
4579
                    yield info
 
4580
                continue
 
4581
 
4138
4582
            # Ask for full texts always so that we don't need more round trips
4139
4583
            # after this stream.
4140
 
            stream = vf.get_record_stream(keys,
4141
 
                self.to_format._fetch_order, True)
 
4584
            # Some of the missing keys are genuinely ghosts, so filter absent
 
4585
            # records. The Sink is responsible for doing another check to
 
4586
            # ensure that ghosts don't introduce missing data for future
 
4587
            # fetches.
 
4588
            stream = versionedfile.filter_absent(vf.get_record_stream(keys,
 
4589
                self.to_format._fetch_order, True))
4142
4590
            yield substream_kind, stream
4143
4591
 
4144
4592
    def inventory_fetch_order(self):
4151
4599
        return (not self.from_repository._format.rich_root_data and
4152
4600
            self.to_format.rich_root_data)
4153
4601
 
4154
 
    def _get_inventory_stream(self, revision_ids):
 
4602
    def _get_inventory_stream(self, revision_ids, missing=False):
4155
4603
        from_format = self.from_repository._format
4156
 
        if (from_format.supports_chks and self.to_format.supports_chks
4157
 
            and (from_format._serializer == self.to_format._serializer)):
4158
 
            # Both sides support chks, and they use the same serializer, so it
4159
 
            # is safe to transmit the chk pages and inventory pages across
4160
 
            # as-is.
4161
 
            return self._get_chk_inventory_stream(revision_ids)
4162
 
        elif (not from_format.supports_chks):
4163
 
            # Source repository doesn't support chks. So we can transmit the
4164
 
            # inventories 'as-is' and either they are just accepted on the
4165
 
            # target, or the Sink will properly convert it.
4166
 
            return self._get_simple_inventory_stream(revision_ids)
 
4604
        if (from_format.supports_chks and self.to_format.supports_chks and
 
4605
            from_format.network_name() == self.to_format.network_name()):
 
4606
            raise AssertionError(
 
4607
                "this case should be handled by GroupCHKStreamSource")
 
4608
        elif 'forceinvdeltas' in debug.debug_flags:
 
4609
            return self._get_convertable_inventory_stream(revision_ids,
 
4610
                    delta_versus_null=missing)
 
4611
        elif from_format.network_name() == self.to_format.network_name():
 
4612
            # Same format.
 
4613
            return self._get_simple_inventory_stream(revision_ids,
 
4614
                    missing=missing)
 
4615
        elif (not from_format.supports_chks and not self.to_format.supports_chks
 
4616
                and from_format._serializer == self.to_format._serializer):
 
4617
            # Essentially the same format.
 
4618
            return self._get_simple_inventory_stream(revision_ids,
 
4619
                    missing=missing)
4167
4620
        else:
4168
 
            # XXX: Hack to make not-chk->chk fetch: copy the inventories as
4169
 
            #      inventories. Note that this should probably be done somehow
4170
 
            #      as part of bzrlib.repository.StreamSink. Except JAM couldn't
4171
 
            #      figure out how a non-chk repository could possibly handle
4172
 
            #      deserializing an inventory stream from a chk repo, as it
4173
 
            #      doesn't have a way to understand individual pages.
4174
 
            return self._get_convertable_inventory_stream(revision_ids)
 
4621
            # Any time we switch serializations, we want to use an
 
4622
            # inventory-delta based approach.
 
4623
            return self._get_convertable_inventory_stream(revision_ids,
 
4624
                    delta_versus_null=missing)
4175
4625
 
4176
 
    def _get_simple_inventory_stream(self, revision_ids):
 
4626
    def _get_simple_inventory_stream(self, revision_ids, missing=False):
 
4627
        # NB: This currently reopens the inventory weave in source;
 
4628
        # using a single stream interface instead would avoid this.
4177
4629
        from_weave = self.from_repository.inventories
 
4630
        if missing:
 
4631
            delta_closure = True
 
4632
        else:
 
4633
            delta_closure = not self.delta_on_metadata()
4178
4634
        yield ('inventories', from_weave.get_record_stream(
4179
4635
            [(rev_id,) for rev_id in revision_ids],
4180
 
            self.inventory_fetch_order(),
4181
 
            not self.delta_on_metadata()))
4182
 
 
4183
 
    def _get_chk_inventory_stream(self, revision_ids):
4184
 
        """Fetch the inventory texts, along with the associated chk maps."""
4185
 
        # We want an inventory outside of the search set, so that we can filter
4186
 
        # out uninteresting chk pages. For now we use
4187
 
        # _find_revision_outside_set, but if we had a Search with cut_revs, we
4188
 
        # could use that instead.
4189
 
        start_rev_id = self.from_repository._find_revision_outside_set(
4190
 
                            revision_ids)
4191
 
        start_rev_key = (start_rev_id,)
4192
 
        inv_keys_to_fetch = [(rev_id,) for rev_id in revision_ids]
4193
 
        if start_rev_id != _mod_revision.NULL_REVISION:
4194
 
            inv_keys_to_fetch.append((start_rev_id,))
4195
 
        # Any repo that supports chk_bytes must also support out-of-order
4196
 
        # insertion. At least, that is how we expect it to work
4197
 
        # We use get_record_stream instead of iter_inventories because we want
4198
 
        # to be able to insert the stream as well. We could instead fetch
4199
 
        # allowing deltas, and then iter_inventories, but we don't know whether
4200
 
        # source or target is more 'local' anway.
4201
 
        inv_stream = self.from_repository.inventories.get_record_stream(
4202
 
            inv_keys_to_fetch, 'unordered',
4203
 
            True) # We need them as full-texts so we can find their references
4204
 
        uninteresting_chk_roots = set()
4205
 
        interesting_chk_roots = set()
4206
 
        def filter_inv_stream(inv_stream):
4207
 
            for idx, record in enumerate(inv_stream):
4208
 
                ### child_pb.update('fetch inv', idx, len(inv_keys_to_fetch))
4209
 
                bytes = record.get_bytes_as('fulltext')
4210
 
                chk_inv = inventory.CHKInventory.deserialise(
4211
 
                    self.from_repository.chk_bytes, bytes, record.key)
4212
 
                if record.key == start_rev_key:
4213
 
                    uninteresting_chk_roots.add(chk_inv.id_to_entry.key())
4214
 
                    p_id_map = chk_inv.parent_id_basename_to_file_id
4215
 
                    if p_id_map is not None:
4216
 
                        uninteresting_chk_roots.add(p_id_map.key())
4217
 
                else:
4218
 
                    yield record
4219
 
                    interesting_chk_roots.add(chk_inv.id_to_entry.key())
4220
 
                    p_id_map = chk_inv.parent_id_basename_to_file_id
4221
 
                    if p_id_map is not None:
4222
 
                        interesting_chk_roots.add(p_id_map.key())
4223
 
        ### pb.update('fetch inventory', 0, 2)
4224
 
        yield ('inventories', filter_inv_stream(inv_stream))
4225
 
        # Now that we have worked out all of the interesting root nodes, grab
4226
 
        # all of the interesting pages and insert them
4227
 
        ### pb.update('fetch inventory', 1, 2)
4228
 
        interesting = chk_map.iter_interesting_nodes(
4229
 
            self.from_repository.chk_bytes, interesting_chk_roots,
4230
 
            uninteresting_chk_roots)
4231
 
        def to_stream_adapter():
4232
 
            """Adapt the iter_interesting_nodes result to a single stream.
4233
 
 
4234
 
            iter_interesting_nodes returns records as it processes them, which
4235
 
            can be in batches. But we only want a single stream to be inserted.
4236
 
            """
4237
 
            for record, items in interesting:
4238
 
                for value in record.itervalues():
4239
 
                    yield value
4240
 
        # XXX: We could instead call get_record_stream(records.keys())
4241
 
        #      ATM, this will always insert the records as fulltexts, and
4242
 
        #      requires that you can hang on to records once you have gone
4243
 
        #      on to the next one. Further, it causes the target to
4244
 
        #      recompress the data. Testing shows it to be faster than
4245
 
        #      requesting the records again, though.
4246
 
        yield ('chk_bytes', to_stream_adapter())
4247
 
        ### pb.update('fetch inventory', 2, 2)
4248
 
 
4249
 
    def _get_convertable_inventory_stream(self, revision_ids):
4250
 
        # XXX: One of source or target is using chks, and they don't have
4251
 
        #      compatible serializations. The StreamSink code expects to be
4252
 
        #      able to convert on the target, so we need to put
4253
 
        #      bytes-on-the-wire that can be converted
4254
 
        yield ('inventories', self._stream_invs_as_fulltexts(revision_ids))
4255
 
 
4256
 
    def _stream_invs_as_fulltexts(self, revision_ids):
 
4636
            self.inventory_fetch_order(), delta_closure))
 
4637
 
 
4638
    def _get_convertable_inventory_stream(self, revision_ids,
 
4639
                                          delta_versus_null=False):
 
4640
        # The two formats are sufficiently different that there is no fast
 
4641
        # path, so we need to send just inventorydeltas, which any
 
4642
        # sufficiently modern client can insert into any repository.
 
4643
        # The StreamSink code expects to be able to
 
4644
        # convert on the target, so we need to put bytes-on-the-wire that can
 
4645
        # be converted.  That means inventory deltas (if the remote is <1.19,
 
4646
        # RemoteStreamSink will fallback to VFS to insert the deltas).
 
4647
        yield ('inventory-deltas',
 
4648
           self._stream_invs_as_deltas(revision_ids,
 
4649
                                       delta_versus_null=delta_versus_null))
 
4650
 
 
4651
    def _stream_invs_as_deltas(self, revision_ids, delta_versus_null=False):
 
4652
        """Return a stream of inventory-deltas for the given rev ids.
 
4653
 
 
4654
        :param revision_ids: The list of inventories to transmit
 
4655
        :param delta_versus_null: Don't try to find a minimal delta for this
 
4656
            entry, instead compute the delta versus the NULL_REVISION. This
 
4657
            effectively streams a complete inventory. Used for stuff like
 
4658
            filling in missing parents, etc.
 
4659
        """
4257
4660
        from_repo = self.from_repository
4258
 
        from_serializer = from_repo._format._serializer
4259
4661
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4260
4662
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
4261
 
        for inv in self.from_repository.iter_inventories(revision_ids):
4262
 
            # XXX: This is a bit hackish, but it works. Basically,
4263
 
            #      CHKSerializer 'accidentally' supports
4264
 
            #      read/write_inventory_to_string, even though that is never
4265
 
            #      the format that is stored on disk. It *does* give us a
4266
 
            #      single string representation for an inventory, so live with
4267
 
            #      it for now.
4268
 
            #      This would be far better if we had a 'serialized inventory
4269
 
            #      delta' form. Then we could use 'inventory._make_delta', and
4270
 
            #      transmit that. This would both be faster to generate, and
4271
 
            #      result in fewer bytes-on-the-wire.
4272
 
            as_bytes = from_serializer.write_inventory_to_string(inv)
 
4663
        # XXX: possibly repos could implement a more efficient iter_inv_deltas
 
4664
        # method...
 
4665
        inventories = self.from_repository.iter_inventories(
 
4666
            revision_ids, 'topological')
 
4667
        format = from_repo._format
 
4668
        invs_sent_so_far = set([_mod_revision.NULL_REVISION])
 
4669
        inventory_cache = lru_cache.LRUCache(50)
 
4670
        null_inventory = from_repo.revision_tree(
 
4671
            _mod_revision.NULL_REVISION).inventory
 
4672
        # XXX: ideally the rich-root/tree-refs flags would be per-revision, not
 
4673
        # per-repo (e.g.  streaming a non-rich-root revision out of a rich-root
 
4674
        # repo back into a non-rich-root repo ought to be allowed)
 
4675
        serializer = inventory_delta.InventoryDeltaSerializer(
 
4676
            versioned_root=format.rich_root_data,
 
4677
            tree_references=format.supports_tree_reference)
 
4678
        for inv in inventories:
4273
4679
            key = (inv.revision_id,)
4274
4680
            parent_keys = parent_map.get(key, ())
 
4681
            delta = None
 
4682
            if not delta_versus_null and parent_keys:
 
4683
                # The caller did not ask for complete inventories and we have
 
4684
                # some parents that we can delta against.  Make a delta against
 
4685
                # each parent so that we can find the smallest.
 
4686
                parent_ids = [parent_key[0] for parent_key in parent_keys]
 
4687
                for parent_id in parent_ids:
 
4688
                    if parent_id not in invs_sent_so_far:
 
4689
                        # We don't know that the remote side has this basis, so
 
4690
                        # we can't use it.
 
4691
                        continue
 
4692
                    if parent_id == _mod_revision.NULL_REVISION:
 
4693
                        parent_inv = null_inventory
 
4694
                    else:
 
4695
                        parent_inv = inventory_cache.get(parent_id, None)
 
4696
                        if parent_inv is None:
 
4697
                            parent_inv = from_repo.get_inventory(parent_id)
 
4698
                    candidate_delta = inv._make_delta(parent_inv)
 
4699
                    if (delta is None or
 
4700
                        len(delta) > len(candidate_delta)):
 
4701
                        delta = candidate_delta
 
4702
                        basis_id = parent_id
 
4703
            if delta is None:
 
4704
                # Either none of the parents ended up being suitable, or we
 
4705
                # were asked to delta against NULL
 
4706
                basis_id = _mod_revision.NULL_REVISION
 
4707
                delta = inv._make_delta(null_inventory)
 
4708
            invs_sent_so_far.add(inv.revision_id)
 
4709
            inventory_cache[inv.revision_id] = inv
 
4710
            delta_serialized = ''.join(
 
4711
                serializer.delta_to_lines(basis_id, key[-1], delta))
4275
4712
            yield versionedfile.FulltextContentFactory(
4276
 
                key, parent_keys, None, as_bytes)
 
4713
                key, parent_keys, None, delta_serialized)
 
4714
 
 
4715
 
 
4716
def _iter_for_revno(repo, partial_history_cache, stop_index=None,
 
4717
                    stop_revision=None):
 
4718
    """Extend the partial history to include a given index
 
4719
 
 
4720
    If a stop_index is supplied, stop when that index has been reached.
 
4721
    If a stop_revision is supplied, stop when that revision is
 
4722
    encountered.  Otherwise, stop when the beginning of history is
 
4723
    reached.
 
4724
 
 
4725
    :param stop_index: The index which should be present.  When it is
 
4726
        present, history extension will stop.
 
4727
    :param stop_revision: The revision id which should be present.  When
 
4728
        it is encountered, history extension will stop.
 
4729
    """
 
4730
    start_revision = partial_history_cache[-1]
 
4731
    iterator = repo.iter_reverse_revision_history(start_revision)
 
4732
    try:
 
4733
        #skip the last revision in the list
 
4734
        iterator.next()
 
4735
        while True:
 
4736
            if (stop_index is not None and
 
4737
                len(partial_history_cache) > stop_index):
 
4738
                break
 
4739
            if partial_history_cache[-1] == stop_revision:
 
4740
                break
 
4741
            revision_id = iterator.next()
 
4742
            partial_history_cache.append(revision_id)
 
4743
    except StopIteration:
 
4744
        # No more history
 
4745
        return
4277
4746