/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/repository.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2009-03-25 04:20:12 UTC
  • mfrom: (3468.3.4 controlfiles)
  • Revision ID: pqm@pqm.ubuntu.com-20090325042012-23a6pm0mraw7g2kg
(mbp) better CountedLock handling of tokens,
        and bzrdir takes more responsibility for default file modes

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
23
23
from bzrlib import (
24
24
    bzrdir,
25
25
    check,
26
 
    chk_map,
27
 
    config,
28
26
    debug,
29
 
    fetch as _mod_fetch,
 
27
    errors,
30
28
    fifo_cache,
31
29
    generate_ids,
32
30
    gpg,
33
31
    graph,
34
 
    inventory,
35
 
    inventory_delta,
36
32
    lazy_regex,
37
33
    lockable_files,
38
34
    lockdir,
39
35
    lru_cache,
40
36
    osutils,
41
37
    revision as _mod_revision,
42
 
    static_tuple,
43
38
    symbol_versioning,
44
 
    trace,
45
39
    tsort,
 
40
    ui,
46
41
    versionedfile,
47
42
    )
48
43
from bzrlib.bundle import serializer
51
46
from bzrlib.testament import Testament
52
47
""")
53
48
 
54
 
from bzrlib import (
55
 
    errors,
56
 
    registry,
57
 
    ui,
58
 
    )
59
 
from bzrlib.decorators import needs_read_lock, needs_write_lock, only_raises
 
49
from bzrlib.decorators import needs_read_lock, needs_write_lock
60
50
from bzrlib.inter import InterObject
61
51
from bzrlib.inventory import (
62
52
    Inventory,
64
54
    ROOT_ID,
65
55
    entry_factory,
66
56
    )
67
 
from bzrlib.recordcounter import RecordCounter
68
 
from bzrlib.lock import _RelockDebugMixin, LogicalLockResult
 
57
from bzrlib import registry
 
58
from bzrlib.symbol_versioning import (
 
59
        deprecated_method,
 
60
        )
69
61
from bzrlib.trace import (
70
62
    log_exception_quietly, note, mutter, mutter_callsite, warning)
71
63
 
74
66
_deprecation_warning_done = False
75
67
 
76
68
 
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
 
 
85
69
class CommitBuilder(object):
86
70
    """Provides an interface to build up a commit.
87
71
 
213
197
 
214
198
    def finish_inventory(self):
215
199
        """Tell the builder that the inventory is finished.
216
 
 
 
200
        
217
201
        :return: The inventory id in the repository, which can be used with
218
202
            repository.get_inventory.
219
203
        """
221
205
            # an inventory delta was accumulated without creating a new
222
206
            # inventory.
223
207
            basis_id = self.basis_delta_revision
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(
 
208
            self.inv_sha1 = self.repository.add_inventory_by_delta(
228
209
                basis_id, self._basis_delta, self._new_revision_id,
229
210
                self.parents)
230
211
        else:
289
270
 
290
271
        :param tree: The tree which is being committed.
291
272
        """
292
 
        if len(self.parents) == 0:
293
 
            raise errors.RootMissing()
 
273
        # NB: if there are no parents then this method is not called, so no
 
274
        # need to guard on parents having length.
294
275
        entry = entry_factory['directory'](tree.path2id(''), '',
295
276
            None)
296
277
        entry.revision = self._new_revision_id
343
324
            raise AssertionError("recording deletes not activated.")
344
325
        delta = (path, None, file_id, None)
345
326
        self._basis_delta.append(delta)
346
 
        self._any_changes = True
347
327
        return delta
348
328
 
349
329
    def will_record_deletes(self):
484
464
            if content_summary[2] is None:
485
465
                raise ValueError("Files must not have executable = None")
486
466
            if not 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:
 
467
                if (# if the file length changed we have to store:
 
468
                    parent_entry.text_size != content_summary[1] or
 
469
                    # if the exec bit has changed we have to store:
490
470
                    parent_entry.executable != content_summary[2]):
491
471
                    store = True
492
472
                elif parent_entry.text_sha1 == content_summary[3]:
511
491
            ie.executable = content_summary[2]
512
492
            file_obj, stat_value = tree.get_file_with_stat(ie.file_id, path)
513
493
            try:
514
 
                text = file_obj.read()
 
494
                lines = file_obj.readlines()
515
495
            finally:
516
496
                file_obj.close()
517
497
            try:
518
498
                ie.text_sha1, ie.text_size = self._add_text_to_weave(
519
 
                    ie.file_id, text, heads, nostore_sha)
 
499
                    ie.file_id, lines, heads, nostore_sha)
520
500
                # Let the caller know we generated a stat fingerprint.
521
501
                fingerprint = (ie.text_sha1, stat_value)
522
502
            except errors.ExistingContent:
534
514
                # carry over:
535
515
                ie.revision = parent_entry.revision
536
516
                return self._get_delta(ie, basis_inv, path), False, None
537
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
517
            lines = []
 
518
            self._add_text_to_weave(ie.file_id, lines, heads, None)
538
519
        elif kind == 'symlink':
539
520
            current_link_target = content_summary[3]
540
521
            if not store:
548
529
                ie.symlink_target = parent_entry.symlink_target
549
530
                return self._get_delta(ie, basis_inv, path), False, None
550
531
            ie.symlink_target = current_link_target
551
 
            self._add_text_to_weave(ie.file_id, '', heads, None)
 
532
            lines = []
 
533
            self._add_text_to_weave(ie.file_id, lines, heads, None)
552
534
        elif kind == 'tree-reference':
553
535
            if not store:
554
536
                if content_summary[3] != parent_entry.reference_revision:
559
541
                ie.revision = parent_entry.revision
560
542
                return self._get_delta(ie, basis_inv, path), False, None
561
543
            ie.reference_revision = content_summary[3]
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)
 
544
            lines = []
 
545
            self._add_text_to_weave(ie.file_id, lines, heads, None)
566
546
        else:
567
547
            raise NotImplementedError('unknown kind')
568
548
        ie.revision = self._new_revision_id
578
558
            has been generated against. Currently assumed to be the same
579
559
            as self.parents[0] - if it is not, errors may occur.
580
560
        :param iter_changes: An iter_changes iterator with the changes to apply
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.
 
561
            to basis_revision_id.
584
562
        :param _entry_factory: Private method to bind entry_factory locally for
585
563
            performance.
586
 
        :return: A generator of (file_id, relpath, fs_hash) tuples for use with
587
 
            tree._observed_sha1.
 
564
        :return: None
588
565
        """
589
566
        # Create an inventory delta based on deltas between all the parents and
590
567
        # deltas between all the parent inventories. We use inventory delta's 
597
574
        # {file_id -> revision_id -> inventory entry, for entries in parent
598
575
        # trees that are not parents[0]
599
576
        parent_entries = {}
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))
 
577
        revtrees = list(self.repository.revision_trees(self.parents))
615
578
        # The basis inventory from a repository 
616
579
        if revtrees:
617
580
            basis_inv = revtrees[0].inventory
619
582
            basis_inv = self.repository.revision_tree(
620
583
                _mod_revision.NULL_REVISION).inventory
621
584
        if len(self.parents) > 0:
622
 
            if basis_revision_id != self.parents[0] and not ghost_basis:
 
585
            if basis_revision_id != self.parents[0]:
623
586
                raise Exception(
624
587
                    "arbitrary basis parents not yet supported with merges")
625
588
            for revtree in revtrees[1:]:
629
592
                        continue
630
593
                    if change[2] not in merged_ids:
631
594
                        if change[0] is not None:
632
 
                            basis_entry = basis_inv[change[2]]
633
595
                            merged_ids[change[2]] = [
634
 
                                # basis revid
635
 
                                basis_entry.revision,
636
 
                                # new tree revid
 
596
                                basis_inv[change[2]].revision,
637
597
                                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
 
                                }
644
598
                        else:
645
599
                            merged_ids[change[2]] = [change[3].revision]
646
 
                            parent_entries[change[2]] = {change[3].revision:change[3]}
 
600
                        parent_entries[change[2]] = {change[3].revision:change[3]}
647
601
                    else:
648
602
                        merged_ids[change[2]].append(change[3].revision)
649
603
                        parent_entries[change[2]][change[3].revision] = change[3]
674
628
            # inv delta  change: (file_id, (path_in_source, path_in_target),
675
629
            #   changed_content, versioned, parent, name, kind,
676
630
            #   executable)
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])
 
631
            basis_entry = basis_inv[file_id]
 
632
            change = (file_id,
 
633
                (basis_inv.id2path(file_id), tree.id2path(file_id)),
 
634
                False, (True, True),
 
635
                (basis_entry.parent_id, basis_entry.parent_id),
 
636
                (basis_entry.name, basis_entry.name),
 
637
                (basis_entry.kind, basis_entry.kind),
 
638
                (basis_entry.executable, basis_entry.executable))
 
639
            changes[file_id] = (change, merged_ids[file_id])
694
640
        # changes contains tuples with the change and a set of inventory
695
641
        # candidates for the file.
696
642
        # inv delta is:
762
708
                        entry.executable = True
763
709
                    else:
764
710
                        entry.executable = False
765
 
                    if (carry_over_possible and
 
711
                    if (carry_over_possible and 
766
712
                        parent_entry.executable == entry.executable):
767
713
                            # Check the file length, content hash after reading
768
714
                            # the file.
771
717
                        nostore_sha = None
772
718
                    file_obj, stat_value = tree.get_file_with_stat(file_id, change[1][1])
773
719
                    try:
774
 
                        text = file_obj.read()
 
720
                        lines = file_obj.readlines()
775
721
                    finally:
776
722
                        file_obj.close()
777
723
                    try:
778
724
                        entry.text_sha1, entry.text_size = self._add_text_to_weave(
779
 
                            file_id, text, heads, nostore_sha)
780
 
                        yield file_id, change[1][1], (entry.text_sha1, stat_value)
 
725
                            file_id, lines, heads, nostore_sha)
781
726
                    except errors.ExistingContent:
782
727
                        # No content change against a carry_over parent
783
 
                        # Perhaps this should also yield a fs hash update?
784
728
                        carried_over = True
785
729
                        entry.text_size = parent_entry.text_size
786
730
                        entry.text_sha1 = parent_entry.text_sha1
789
733
                    entry.symlink_target = tree.get_symlink_target(file_id)
790
734
                    if (carry_over_possible and
791
735
                        parent_entry.symlink_target == entry.symlink_target):
792
 
                        carried_over = True
 
736
                            carried_over = True
793
737
                    else:
794
 
                        self._add_text_to_weave(change[0], '', heads, None)
 
738
                        self._add_text_to_weave(change[0], [], heads, None)
795
739
                elif kind == 'directory':
796
740
                    if carry_over_possible:
797
741
                        carried_over = True
799
743
                        # Nothing to set on the entry.
800
744
                        # XXX: split into the Root and nonRoot versions.
801
745
                        if change[1][1] != '' or self.repository.supports_rich_root():
802
 
                            self._add_text_to_weave(change[0], '', heads, None)
 
746
                            self._add_text_to_weave(change[0], [], heads, None)
803
747
                elif kind == 'tree-reference':
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)
 
748
                    raise AssertionError('unknown kind %r' % kind)
818
749
                else:
819
750
                    raise AssertionError('unknown kind %r' % kind)
820
751
                if not carried_over:
829
760
                seen_root = True
830
761
        self.new_inventory = None
831
762
        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.
835
763
            self._any_changes = True
836
764
        if not seen_root:
837
765
            # housekeeping root entry changes do not affect no-change commits.
838
766
            self._require_root_change(tree)
839
767
        self.basis_delta_revision = basis_revision_id
840
768
 
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]
 
769
    def _add_text_to_weave(self, file_id, new_lines, parents, nostore_sha):
 
770
        # Note: as we read the content directly from the tree, we know its not
 
771
        # been turned into unicode or badly split - but a broken tree
 
772
        # implementation could give us bad output from readlines() so this is
 
773
        # not a guarantee of safety. What would be better is always checking
 
774
        # the content during test suite execution. RBC 20070912
 
775
        parent_keys = tuple((file_id, parent) for parent in parents)
 
776
        return self.repository.texts.add_lines(
 
777
            (file_id, self._new_revision_id), parent_keys, new_lines,
 
778
            nostore_sha=nostore_sha, random_id=self.random_revid,
 
779
            check_content=False)[0:2]
846
780
 
847
781
 
848
782
class RootCommitBuilder(CommitBuilder):
871
805
        # versioned roots do not change unless the tree found a change.
872
806
 
873
807
 
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
 
 
891
808
######################################################################
892
809
# Repositories
893
810
 
894
 
 
895
 
class Repository(_RelockDebugMixin, bzrdir.ControlComponent):
 
811
class Repository(object):
896
812
    """Repository holding history for one or more branches.
897
813
 
898
814
    The repository holds and retrieves historical information including
900
816
    which views a particular line of development through that history.
901
817
 
902
818
    The Repository builds on top of some byte storage facilies (the revisions,
903
 
    signatures, inventories, texts and chk_bytes attributes) and a Transport,
904
 
    which respectively provide byte storage and a means to access the (possibly
 
819
    signatures, inventories and texts attributes) and a Transport, which
 
820
    respectively provide byte storage and a means to access the (possibly
905
821
    remote) disk.
906
822
 
907
823
    The byte storage facilities are addressed via tuples, which we refer to
908
824
    as 'keys' throughout the code base. Revision_keys, inventory_keys and
909
825
    signature_keys are all 1-tuples: (revision_id,). text_keys are two-tuples:
910
 
    (file_id, revision_id). chk_bytes uses CHK keys - a 1-tuple with a single
911
 
    byte string made up of a hash identifier and a hash value.
912
 
    We use this interface because it allows low friction with the underlying
913
 
    code that implements disk indices, network encoding and other parts of
914
 
    bzrlib.
 
826
    (file_id, revision_id). We use this interface because it allows low
 
827
    friction with the underlying code that implements disk indices, network
 
828
    encoding and other parts of bzrlib.
915
829
 
916
830
    :ivar revisions: A bzrlib.versionedfile.VersionedFiles instance containing
917
831
        the serialised revisions for the repository. This can be used to obtain
936
850
        The result of trying to insert data into the repository via this store
937
851
        is undefined: it should be considered read-only except for implementors
938
852
        of repositories.
939
 
    :ivar chk_bytes: A bzrlib.versionedfile.VersionedFiles instance containing
940
 
        any data the repository chooses to store or have indexed by its hash.
941
 
        The result of trying to insert data into the repository via this store
942
 
        is undefined: it should be considered read-only except for implementors
943
 
        of repositories.
944
853
    :ivar _transport: Transport for file access to repository, typically
945
854
        pointing to .bzr/repository.
946
855
    """
967
876
        """
968
877
        if self._write_group is not self.get_transaction():
969
878
            # 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
975
 
            raise errors.BzrError(
976
 
                'mismatched lock context and write group. %r, %r' %
977
 
                (self._write_group, self.get_transaction()))
 
879
            raise errors.BzrError('mismatched lock context and write group.')
978
880
        try:
979
881
            self._abort_write_group()
980
882
        except Exception, exc:
1006
908
        """
1007
909
        if not self._format.supports_external_lookups:
1008
910
            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()
1013
911
        self._check_fallback_repository(repository)
1014
912
        self._fallback_repositories.append(repository)
1015
913
        self.texts.add_fallback_versioned_files(repository.texts)
1016
914
        self.inventories.add_fallback_versioned_files(repository.inventories)
1017
915
        self.revisions.add_fallback_versioned_files(repository.revisions)
1018
916
        self.signatures.add_fallback_versioned_files(repository.signatures)
1019
 
        if self.chk_bytes is not None:
1020
 
            self.chk_bytes.add_fallback_versioned_files(repository.chk_bytes)
1021
917
 
1022
918
    def _check_fallback_repository(self, repository):
1023
919
        """Check that this repository can fallback to repository safely.
1046
942
                " id and insertion revid (%r, %r)"
1047
943
                % (inv.revision_id, revision_id))
1048
944
        if inv.root is None:
1049
 
            raise errors.RootMissing()
1050
 
        return self._add_inventory_checked(revision_id, inv, parents)
1051
 
 
1052
 
    def _add_inventory_checked(self, revision_id, inv, parents):
1053
 
        """Add inv to the repository after checking the inputs.
1054
 
 
1055
 
        This function can be overridden to allow different inventory styles.
1056
 
 
1057
 
        :seealso: add_inventory, for the contract.
1058
 
        """
1059
 
        inv_lines = self._serializer.write_inventory_to_lines(inv)
 
945
            raise AssertionError()
 
946
        inv_lines = self._serialise_inventory_to_lines(inv)
1060
947
        return self._inventory_add_lines(revision_id, parents,
1061
948
            inv_lines, check_content=False)
1062
949
 
1063
950
    def add_inventory_by_delta(self, basis_revision_id, delta, new_revision_id,
1064
 
                               parents, basis_inv=None, propagate_caches=False):
 
951
                               parents):
1065
952
        """Add a new inventory expressed as a delta against another revision.
1066
953
 
1067
 
        See the inventory developers documentation for the theory behind
1068
 
        inventory deltas.
1069
 
 
1070
954
        :param basis_revision_id: The inventory id the delta was created
1071
955
            against. (This does not have to be a direct parent.)
1072
956
        :param delta: The inventory delta (see Inventory.apply_delta for
1078
962
            for repositories that depend on the inventory graph for revision
1079
963
            graph access, as well as for those that pun ancestry with delta
1080
964
            compression.
1081
 
        :param basis_inv: The basis inventory if it is already known,
1082
 
            otherwise None.
1083
 
        :param propagate_caches: If True, the caches for this inventory are
1084
 
          copied to and updated for the result if possible.
1085
965
 
1086
966
        :returns: (validator, new_inv)
1087
967
            The validator(which is a sha1 digest, though what is sha'd is
1098
978
            # inventory implementations may support: A better idiom would be to
1099
979
            # return a new inventory, but as there is no revision tree cache in
1100
980
            # repository this is safe for now - RBC 20081013
1101
 
            if basis_inv is None:
1102
 
                basis_inv = basis_tree.inventory
 
981
            basis_inv = basis_tree.inventory
1103
982
            basis_inv.apply_delta(delta)
1104
983
            basis_inv.revision_id = new_revision_id
1105
984
            return (self.add_inventory(new_revision_id, basis_inv, parents),
1111
990
        check_content=True):
1112
991
        """Store lines in inv_vf and return the sha1 of the inventory."""
1113
992
        parents = [(parent,) for parent in parents]
1114
 
        result = self.inventories.add_lines((revision_id,), parents, lines,
 
993
        return self.inventories.add_lines((revision_id,), parents, lines,
1115
994
            check_content=check_content)[0]
1116
 
        self.inventories._access.flush()
1117
 
        return result
1118
995
 
1119
996
    def add_revision(self, revision_id, rev, inv=None, config=None):
1120
997
        """Add rev to the revision store as revision_id.
1196
1073
        # The old API returned a list, should this actually be a set?
1197
1074
        return parent_map.keys()
1198
1075
 
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
 
 
1312
1076
    @staticmethod
1313
1077
    def create(a_bzrdir):
1314
1078
        """Construct the current default format repository in a_bzrdir."""
1319
1083
 
1320
1084
        :param _format: The format of the repository on disk.
1321
1085
        :param a_bzrdir: The BzrDir of the repository.
 
1086
 
 
1087
        In the future we will have a single api for all stores for
 
1088
        getting file texts, inventories and revisions, then
 
1089
        this construct will accept instances of those things.
1322
1090
        """
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.
1326
1091
        super(Repository, self).__init__()
1327
1092
        self._format = _format
1328
1093
        # the following are part of the public API for Repository:
1334
1099
        self._reconcile_does_inventory_gc = True
1335
1100
        self._reconcile_fixes_text_parents = False
1336
1101
        self._reconcile_backsup_inventory = True
 
1102
        # not right yet - should be more semantically clear ?
 
1103
        #
 
1104
        # TODO: make sure to construct the right store classes, etc, depending
 
1105
        # on whether escaping is required.
 
1106
        self._warn_if_deprecated()
1337
1107
        self._write_group = None
1338
1108
        # Additional places to query for data.
1339
1109
        self._fallback_repositories = []
1340
1110
        # An InventoryEntry cache, used during deserialization
1341
1111
        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
1353
1112
 
1354
1113
    def __repr__(self):
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
 
1114
        return '%s(%r)' % (self.__class__.__name__,
 
1115
                           self.base)
1374
1116
 
1375
1117
    def has_same_location(self, other):
1376
1118
        """Returns a boolean indicating if this repository is at the same
1404
1146
        data during reads, and allows a 'write_group' to be obtained. Write
1405
1147
        groups must be used for actual data insertion.
1406
1148
 
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
 
 
1413
1149
        :param token: if this is already locked, then lock_write will fail
1414
1150
            unless the token matches the existing lock.
1415
1151
        :returns: a token if this instance supports tokens, otherwise None.
1418
1154
        :raises MismatchedToken: if the specified token doesn't match the token
1419
1155
            of the existing lock.
1420
1156
        :seealso: start_write_group.
1421
 
        :return: A RepositoryWriteLockResult.
 
1157
 
 
1158
        A token should be passed in if you know that you have locked the object
 
1159
        some other way, and need to synchronise this object's state with that
 
1160
        fact.
 
1161
 
 
1162
        XXX: this docstring is duplicated in many places, e.g. lockable_files.py
1422
1163
        """
1423
1164
        locked = self.is_locked()
1424
 
        token = self.control_files.lock_write(token=token)
 
1165
        result = self.control_files.lock_write(token=token)
 
1166
        for repo in self._fallback_repositories:
 
1167
            # Writes don't affect fallback repos
 
1168
            repo.lock_read()
1425
1169
        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()
1431
1170
            self._refresh_data()
1432
 
        return RepositoryWriteLockResult(self.unlock, token)
 
1171
        return result
1433
1172
 
1434
1173
    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
 
        """
1440
1174
        locked = self.is_locked()
1441
1175
        self.control_files.lock_read()
 
1176
        for repo in self._fallback_repositories:
 
1177
            repo.lock_read()
1442
1178
        if not locked:
1443
 
            self._warn_if_deprecated()
1444
 
            self._note_lock('r')
1445
 
            for repo in self._fallback_repositories:
1446
 
                repo.lock_read()
1447
1179
            self._refresh_data()
1448
 
        return LogicalLockResult(self.unlock)
1449
1180
 
1450
1181
    def get_physical_lock_status(self):
1451
1182
        return self.control_files.get_physical_lock_status()
1511
1242
 
1512
1243
        # now gather global repository information
1513
1244
        # XXX: This is available for many repos regardless of listability.
1514
 
        if self.user_transport.listable():
 
1245
        if self.bzrdir.root_transport.listable():
1515
1246
            # XXX: do we want to __define len__() ?
1516
1247
            # Maybe the versionedfiles object should provide a different
1517
1248
            # method to get the number of keys.
1527
1258
        :param using: If True, list only branches using this repository.
1528
1259
        """
1529
1260
        if using and not self.is_shared():
1530
 
            return self.bzrdir.list_branches()
 
1261
            try:
 
1262
                return [self.bzrdir.open_branch()]
 
1263
            except errors.NotBranchError:
 
1264
                return []
1531
1265
        class Evaluator(object):
1532
1266
 
1533
1267
            def __init__(self):
1542
1276
                    except errors.NoRepositoryPresent:
1543
1277
                        pass
1544
1278
                    else:
1545
 
                        return False, ([], repository)
 
1279
                        return False, (None, repository)
1546
1280
                self.first_call = False
1547
 
                value = (bzrdir.list_branches(), None)
 
1281
                try:
 
1282
                    value = (bzrdir.open_branch(), None)
 
1283
                except errors.NotBranchError:
 
1284
                    value = (None, None)
1548
1285
                return True, value
1549
1286
 
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)
 
1287
        branches = []
 
1288
        for branch, repository in bzrdir.BzrDir.find_bzrdirs(
 
1289
                self.bzrdir.root_transport, evaluate=Evaluator()):
 
1290
            if branch is not None:
 
1291
                branches.append(branch)
1555
1292
            if not using and repository is not None:
1556
 
                ret.extend(repository.find_branches())
1557
 
        return ret
 
1293
                branches.extend(repository.find_branches())
 
1294
        return branches
1558
1295
 
1559
1296
    @needs_read_lock
1560
1297
    def search_missing_revision_ids(self, other, revision_id=None, find_ghosts=True):
1589
1326
        """Commit the contents accrued within the current write group.
1590
1327
 
1591
1328
        :seealso: start_write_group.
1592
 
        
1593
 
        :return: it may return an opaque hint that can be passed to 'pack'.
1594
1329
        """
1595
1330
        if self._write_group is not self.get_transaction():
1596
1331
            # has an unlock or relock occured ?
1597
1332
            raise errors.BzrError('mismatched lock context %r and '
1598
1333
                'write group %r.' %
1599
1334
                (self.get_transaction(), self._write_group))
1600
 
        result = self._commit_write_group()
 
1335
        self._commit_write_group()
1601
1336
        self._write_group = None
1602
 
        return result
1603
1337
 
1604
1338
    def _commit_write_group(self):
1605
1339
        """Template method for per-repository write group cleanup.
1613
1347
    def suspend_write_group(self):
1614
1348
        raise errors.UnsuspendableWriteGroup(self)
1615
1349
 
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
 
 
1671
1350
    def refresh_data(self):
1672
 
        """Re-read any data needed to synchronise with disk.
 
1351
        """Re-read any data needed to to synchronise with disk.
1673
1352
 
1674
1353
        This method is intended to be called after another repository instance
1675
1354
        (such as one used by a smart server) has inserted data into the
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.
 
1355
        repository. It may not be called during a write group, but may be
 
1356
        called at any other time.
1681
1357
        """
 
1358
        if self.is_in_write_group():
 
1359
            raise errors.InternalBzrError(
 
1360
                "May not refresh_data while in a write group.")
1682
1361
        self._refresh_data()
1683
1362
 
1684
1363
    def resume_write_group(self, tokens):
1722
1401
            raise errors.InternalBzrError(
1723
1402
                "May not fetch while in a write group.")
1724
1403
        # fast path same-url fetch operations
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)):
 
1404
        if self.has_same_location(source) and fetch_spec is None:
1730
1405
            # check that last_revision is in 'from' and then return a
1731
1406
            # no-operation.
1732
1407
            if (revision_id is not None and
1757
1432
        :param revprops: Optional dictionary of revision properties.
1758
1433
        :param revision_id: Optional revision id.
1759
1434
        """
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.")
1764
1435
        result = self._commit_builder_class(self, parents, config,
1765
1436
            timestamp, timezone, committer, revprops, revision_id)
1766
1437
        self.start_write_group()
1767
1438
        return result
1768
1439
 
1769
 
    @only_raises(errors.LockNotHeld, errors.LockBroken)
1770
1440
    def unlock(self):
1771
1441
        if (self.control_files._lock_count == 1 and
1772
1442
            self.control_files._lock_mode == 'w'):
1778
1448
        self.control_files.unlock()
1779
1449
        if self.control_files._lock_count == 0:
1780
1450
            self._inventory_entry_cache.clear()
1781
 
            for repo in self._fallback_repositories:
1782
 
                repo.unlock()
 
1451
        for repo in self._fallback_repositories:
 
1452
            repo.unlock()
1783
1453
 
1784
1454
    @needs_read_lock
1785
1455
    def clone(self, a_bzrdir, revision_id=None):
1894
1564
 
1895
1565
    @needs_read_lock
1896
1566
    def get_revisions(self, revision_ids):
1897
 
        """Get many revisions at once.
1898
 
        
1899
 
        Repositories that need to check data on every revision read should 
1900
 
        subclass this method.
1901
 
        """
 
1567
        """Get many revisions at once."""
1902
1568
        return self._get_revisions(revision_ids)
1903
1569
 
1904
1570
    @needs_read_lock
1905
1571
    def _get_revisions(self, revision_ids):
1906
1572
        """Core work logic to get many revisions without sanity checks."""
 
1573
        for rev_id in revision_ids:
 
1574
            if not rev_id or not isinstance(rev_id, basestring):
 
1575
                raise errors.InvalidRevisionId(revision_id=rev_id, branch=self)
 
1576
        keys = [(key,) for key in revision_ids]
 
1577
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1907
1578
        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
 
1579
        for record in stream:
 
1580
            if record.storage_kind == 'absent':
 
1581
                raise errors.NoSuchRevision(self, record.key[0])
 
1582
            text = record.get_bytes_as('fulltext')
 
1583
            rev = self._serializer.read_revision_from_string(text)
 
1584
            revs[record.key[0]] = rev
1912
1585
        return [revs[revid] for revid in revision_ids]
1913
1586
 
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)
1930
 
        keys = [(key,) for key in revision_ids]
1931
 
        stream = self.revisions.get_record_stream(keys, 'unordered', True)
1932
 
        for record in stream:
1933
 
            revid = record.key[0]
1934
 
            if record.storage_kind == 'absent':
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)
 
1587
    @needs_read_lock
 
1588
    def get_revision_xml(self, revision_id):
 
1589
        # TODO: jam 20070210 This shouldn't be necessary since get_revision
 
1590
        #       would have already do it.
 
1591
        # TODO: jam 20070210 Just use _serializer.write_revision_to_string()
 
1592
        rev = self.get_revision(revision_id)
 
1593
        rev_tmp = cStringIO.StringIO()
 
1594
        # the current serializer..
 
1595
        self._serializer.write_revision(rev, rev_tmp)
 
1596
        rev_tmp.seek(0)
 
1597
        return rev_tmp.getvalue()
1940
1598
 
1941
1599
    def get_deltas_for_revisions(self, revisions, specific_fileids=None):
1942
1600
        """Produce a generator of revision deltas.
2120
1778
                    yield line, revid
2121
1779
 
2122
1780
    def _find_file_ids_from_xml_inventory_lines(self, line_iterator,
2123
 
        revision_keys):
 
1781
        revision_ids):
2124
1782
        """Helper routine for fileids_altered_by_revision_ids.
2125
1783
 
2126
1784
        This performs the translation of xml lines to revision ids.
2127
1785
 
2128
1786
        :param line_iterator: An iterator of lines, origin_version_id
2129
 
        :param revision_keys: The revision ids to filter for. This should be a
 
1787
        :param revision_ids: The revision ids to filter for. This should be a
2130
1788
            set or other type which supports efficient __contains__ lookups, as
2131
 
            the revision key from each parsed line will be looked up in the
2132
 
            revision_keys filter.
 
1789
            the revision id from each parsed line will be looked up in the
 
1790
            revision_ids filter.
2133
1791
        :return: a dictionary mapping altered file-ids to an iterable of
2134
1792
        revision_ids. Each altered file-ids has the exact revision_ids that
2135
1793
        altered it listed explicitly.
2136
1794
        """
2137
1795
        seen = set(self._find_text_key_references_from_xml_inventory_lines(
2138
1796
                line_iterator).iterkeys())
2139
 
        parent_keys = self._find_parent_keys_of_revisions(revision_keys)
 
1797
        # Note that revision_ids are revision keys.
 
1798
        parent_maps = self.revisions.get_parent_map(revision_ids)
 
1799
        parents = set()
 
1800
        map(parents.update, parent_maps.itervalues())
 
1801
        parents.difference_update(revision_ids)
2140
1802
        parent_seen = set(self._find_text_key_references_from_xml_inventory_lines(
2141
 
            self._inventory_xml_lines_for_keys(parent_keys)))
 
1803
            self._inventory_xml_lines_for_keys(parents)))
2142
1804
        new_keys = seen - parent_seen
2143
1805
        result = {}
2144
1806
        setdefault = result.setdefault
2146
1808
            setdefault(key[0], set()).add(key[-1])
2147
1809
        return result
2148
1810
 
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
 
 
2176
1811
    def fileids_altered_by_revision_ids(self, revision_ids, _inv_weave=None):
2177
1812
        """Find the file ids and versions affected by revisions.
2178
1813
 
2185
1820
        """
2186
1821
        selected_keys = set((revid,) for revid in revision_ids)
2187
1822
        w = _inv_weave or self.inventories
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)
 
1823
        pb = ui.ui_factory.nested_progress_bar()
 
1824
        try:
 
1825
            return self._find_file_ids_from_xml_inventory_lines(
 
1826
                w.iter_lines_added_or_present_in_keys(
 
1827
                    selected_keys, pb=pb),
 
1828
                selected_keys)
 
1829
        finally:
 
1830
            pb.finished()
2192
1831
 
2193
1832
    def iter_files_bytes(self, desired_files):
2194
1833
        """Iterate through file versions.
2215
1854
        for record in self.texts.get_record_stream(text_keys, 'unordered', True):
2216
1855
            if record.storage_kind == 'absent':
2217
1856
                raise errors.RevisionNotPresent(record.key, self)
2218
 
            yield text_keys[record.key], record.get_bytes_as('chunked')
 
1857
            yield text_keys[record.key], record.get_bytes_as('fulltext')
2219
1858
 
2220
1859
    def _generate_text_key_index(self, text_key_references=None,
2221
1860
        ancestors=None):
2276
1915
                batch_size]
2277
1916
            if not to_query:
2278
1917
                break
2279
 
            for revision_id in to_query:
 
1918
            for rev_tree in self.revision_trees(to_query):
 
1919
                revision_id = rev_tree.get_revision_id()
2280
1920
                parent_ids = ancestors[revision_id]
2281
1921
                for text_key in revision_keys[revision_id]:
2282
1922
                    pb.update("Calculating text parents", processed_texts)
2301
1941
                            except KeyError:
2302
1942
                                inv = self.revision_tree(parent_id).inventory
2303
1943
                                inventory_cache[parent_id] = inv
2304
 
                            try:
2305
 
                                parent_entry = inv[text_key[0]]
2306
 
                            except (KeyError, errors.NoSuchId):
2307
 
                                parent_entry = None
 
1944
                            parent_entry = inv._byid.get(text_key[0], None)
2308
1945
                            if parent_entry is not None:
2309
1946
                                parent_text_key = (
2310
1947
                                    text_key[0], parent_entry.revision)
2335
1972
            versions).  knit-kind is one of 'file', 'inventory', 'signatures',
2336
1973
            'revisions'.  file-id is None unless knit-kind is 'file'.
2337
1974
        """
2338
 
        for result in self._find_file_keys_to_fetch(revision_ids, _files_pb):
2339
 
            yield result
2340
 
        del _files_pb
2341
 
        for result in self._find_non_file_keys_to_fetch(revision_ids):
2342
 
            yield result
2343
 
 
2344
 
    def _find_file_keys_to_fetch(self, revision_ids, pb):
2345
1975
        # XXX: it's a bit weird to control the inventory weave caching in this
2346
1976
        # generator.  Ideally the caching would be done in fetch.py I think.  Or
2347
1977
        # maybe this generator should explicitly have the contract that it
2354
1984
        count = 0
2355
1985
        num_file_ids = len(file_ids)
2356
1986
        for file_id, altered_versions in file_ids.iteritems():
2357
 
            if pb is not None:
2358
 
                pb.update("Fetch texts", count, num_file_ids)
 
1987
            if _files_pb is not None:
 
1988
                _files_pb.update("fetch texts", count, num_file_ids)
2359
1989
            count += 1
2360
1990
            yield ("file", file_id, altered_versions)
 
1991
        # We're done with the files_pb.  Note that it finished by the caller,
 
1992
        # just as it was created by the caller.
 
1993
        del _files_pb
2361
1994
 
2362
 
    def _find_non_file_keys_to_fetch(self, revision_ids):
2363
1995
        # inventory
2364
1996
        yield ("inventory", None, revision_ids)
2365
1997
 
2382
2014
        """Get Inventory object by revision id."""
2383
2015
        return self.iter_inventories([revision_id]).next()
2384
2016
 
2385
 
    def iter_inventories(self, revision_ids, ordering=None):
 
2017
    def iter_inventories(self, revision_ids):
2386
2018
        """Get many inventories by revision_ids.
2387
2019
 
2388
2020
        This will buffer some or all of the texts used in constructing the
2389
2021
        inventories in memory, but will only parse a single inventory at a
2390
2022
        time.
2391
2023
 
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).
2396
2024
        :return: An iterator of inventories.
2397
2025
        """
2398
2026
        if ((None in revision_ids)
2399
2027
            or (_mod_revision.NULL_REVISION in revision_ids)):
2400
2028
            raise ValueError('cannot get null revision inventory')
2401
 
        return self._iter_inventories(revision_ids, ordering)
 
2029
        return self._iter_inventories(revision_ids)
2402
2030
 
2403
 
    def _iter_inventories(self, revision_ids, ordering):
 
2031
    def _iter_inventories(self, revision_ids):
2404
2032
        """single-document based inventory iteration."""
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)
 
2033
        for text, revision_id in self._iter_inventory_xmls(revision_ids):
 
2034
            yield self.deserialise_inventory(revision_id, text)
2408
2035
 
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
 
2036
    def _iter_inventory_xmls(self, revision_ids):
2415
2037
        keys = [(revision_id,) for revision_id in revision_ids]
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)
 
2038
        stream = self.inventories.get_record_stream(keys, 'unordered', True)
2422
2039
        text_chunks = {}
2423
2040
        for record in stream:
2424
2041
            if record.storage_kind != 'absent':
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]
 
2042
                text_chunks[record.key] = record.get_bytes_as('chunked')
2430
2043
            else:
2431
2044
                raise errors.NoSuchRevision(self, record.key)
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
 
2045
        for key in keys:
 
2046
            chunks = text_chunks.pop(key)
 
2047
            yield ''.join(chunks), key[-1]
2444
2048
 
2445
 
    def _deserialise_inventory(self, revision_id, xml):
 
2049
    def deserialise_inventory(self, revision_id, xml):
2446
2050
        """Transform the xml into an inventory object.
2447
2051
 
2448
2052
        :param revision_id: The expected revision id of the inventory.
2449
2053
        :param xml: A serialised inventory.
2450
2054
        """
2451
2055
        result = self._serializer.read_inventory_from_string(xml, revision_id,
2452
 
                    entry_cache=self._inventory_entry_cache,
2453
 
                    return_from_cache=self._safe_to_return_from_cache)
 
2056
                    entry_cache=self._inventory_entry_cache)
2454
2057
        if result.revision_id != revision_id:
2455
2058
            raise AssertionError('revision id mismatch %s != %s' % (
2456
2059
                result.revision_id, revision_id))
2457
2060
        return result
2458
2061
 
 
2062
    def serialise_inventory(self, inv):
 
2063
        return self._serializer.write_inventory_to_string(inv)
 
2064
 
 
2065
    def _serialise_inventory_to_lines(self, inv):
 
2066
        return self._serializer.write_inventory_to_lines(inv)
 
2067
 
2459
2068
    def get_serializer_format(self):
2460
2069
        return self._serializer.format_num
2461
2070
 
2462
2071
    @needs_read_lock
2463
 
    def _get_inventory_xml(self, revision_id):
2464
 
        """Get serialized inventory as a string."""
2465
 
        texts = self._iter_inventory_xmls([revision_id], 'unordered')
 
2072
    def get_inventory_xml(self, revision_id):
 
2073
        """Get inventory XML as a file object."""
 
2074
        texts = self._iter_inventory_xmls([revision_id])
2466
2075
        try:
2467
2076
            text, revision_id = texts.next()
2468
2077
        except StopIteration:
2469
2078
            raise errors.HistoryMissing(self, 'inventory', revision_id)
2470
2079
        return text
2471
2080
 
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)).
 
2081
    @needs_read_lock
 
2082
    def get_inventory_sha1(self, revision_id):
 
2083
        """Return the sha1 hash of the inventory entry
2479
2084
        """
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])
 
2085
        return self.get_revision(revision_id).inventory_sha1
2506
2086
 
2507
2087
    def iter_reverse_revision_history(self, revision_id):
2508
2088
        """Iterate backwards through revision ids in the lefthand history
2515
2095
        while True:
2516
2096
            if next_id in (None, _mod_revision.NULL_REVISION):
2517
2097
                return
2518
 
            try:
2519
 
                parents = graph.get_parent_map([next_id])[next_id]
2520
 
            except KeyError:
2521
 
                raise errors.RevisionNotPresent(next_id, self)
2522
2098
            yield next_id
 
2099
            # Note: The following line may raise KeyError in the event of
 
2100
            # truncated history. We decided not to have a try:except:raise
 
2101
            # RevisionNotPresent here until we see a use for it, because of the
 
2102
            # cost in an inner loop that is by its very nature O(history).
 
2103
            # Robert Collins 20080326
 
2104
            parents = graph.get_parent_map([next_id])[next_id]
2523
2105
            if len(parents) == 0:
2524
2106
                return
2525
2107
            else:
2526
2108
                next_id = parents[0]
2527
2109
 
 
2110
    @needs_read_lock
 
2111
    def get_revision_inventory(self, revision_id):
 
2112
        """Return inventory of a past revision."""
 
2113
        # TODO: Unify this with get_inventory()
 
2114
        # bzr 0.0.6 and later imposes the constraint that the inventory_id
 
2115
        # must be the same as its revision, so this is trivial.
 
2116
        if revision_id is None:
 
2117
            # This does not make sense: if there is no revision,
 
2118
            # then it is the current tree inventory surely ?!
 
2119
            # and thus get_root_id() is something that looks at the last
 
2120
            # commit on the branch, and the get_root_id is an inventory check.
 
2121
            raise NotImplementedError
 
2122
            # return Inventory(self.get_root_id())
 
2123
        else:
 
2124
            return self.get_inventory(revision_id)
 
2125
 
2528
2126
    def is_shared(self):
2529
2127
        """Return True if this repository is flagged as a shared repository."""
2530
2128
        raise NotImplementedError(self.is_shared)
2564
2162
            return RevisionTree(self, Inventory(root_id=None),
2565
2163
                                _mod_revision.NULL_REVISION)
2566
2164
        else:
2567
 
            inv = self.get_inventory(revision_id)
 
2165
            inv = self.get_revision_inventory(revision_id)
2568
2166
            return RevisionTree(self, inv, revision_id)
2569
2167
 
2570
2168
    def revision_trees(self, revision_ids):
2623
2221
            keys = tsort.topo_sort(parent_map)
2624
2222
        return [None] + list(keys)
2625
2223
 
2626
 
    def pack(self, hint=None, clean_obsolete_packs=False):
 
2224
    def pack(self):
2627
2225
        """Compress the data within the repository.
2628
2226
 
2629
2227
        This operation only makes sense for some repository types. For other
2632
2230
        This stub method does not require a lock, but subclasses should use
2633
2231
        @needs_write_lock as this is a long running call its reasonable to
2634
2232
        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.
2645
2233
        """
2646
2234
 
2647
2235
    def get_transaction(self):
2648
2236
        return self.control_files.get_transaction()
2649
2237
 
2650
2238
    def get_parent_map(self, revision_ids):
2651
 
        """See graph.StackedParentsProvider.get_parent_map"""
 
2239
        """See graph._StackedParentsProvider.get_parent_map"""
2652
2240
        # revisions index works in keys; this just works in revisions
2653
2241
        # therefore wrap and unwrap
2654
2242
        query_keys = []
2663
2251
        for ((revision_id,), parent_keys) in \
2664
2252
                self.revisions.get_parent_map(query_keys).iteritems():
2665
2253
            if parent_keys:
2666
 
                result[revision_id] = tuple([parent_revid
2667
 
                    for (parent_revid,) in parent_keys])
 
2254
                result[revision_id] = tuple(parent_revid
 
2255
                    for (parent_revid,) in parent_keys)
2668
2256
            else:
2669
2257
                result[revision_id] = (_mod_revision.NULL_REVISION,)
2670
2258
        return result
2672
2260
    def _make_parents_provider(self):
2673
2261
        return self
2674
2262
 
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
 
 
2684
2263
    def get_graph(self, other_repository=None):
2685
2264
        """Return the graph walker for this repository format"""
2686
2265
        parents_provider = self._make_parents_provider()
2687
2266
        if (other_repository is not None and
2688
2267
            not self.has_same_location(other_repository)):
2689
 
            parents_provider = graph.StackedParentsProvider(
 
2268
            parents_provider = graph._StackedParentsProvider(
2690
2269
                [parents_provider, other_repository._make_parents_provider()])
2691
2270
        return graph.Graph(parents_provider)
2692
2271
 
2693
 
    def _get_versioned_file_checker(self, text_key_references=None,
2694
 
        ancestors=None):
 
2272
    def _get_versioned_file_checker(self, text_key_references=None):
2695
2273
        """Return an object suitable for checking versioned files.
2696
2274
        
2697
2275
        :param text_key_references: if non-None, an already built
2699
2277
            to whether they were referred to by the inventory of the
2700
2278
            revision_id that they contain. If None, this will be
2701
2279
            calculated.
2702
 
        :param ancestors: Optional result from
2703
 
            self.get_graph().get_parent_map(self.all_revision_ids()) if already
2704
 
            available.
2705
2280
        """
2706
2281
        return _VersionedFileChecker(self,
2707
 
            text_key_references=text_key_references, ancestors=ancestors)
 
2282
            text_key_references=text_key_references)
2708
2283
 
2709
2284
    def revision_ids_to_search_result(self, result_set):
2710
2285
        """Convert a set of revision ids to a graph SearchResult."""
2760
2335
        return record.get_bytes_as('fulltext')
2761
2336
 
2762
2337
    @needs_read_lock
2763
 
    def check(self, revision_ids=None, callback_refs=None, check_repo=True):
 
2338
    def check(self, revision_ids=None):
2764
2339
        """Check consistency of all history of given revision_ids.
2765
2340
 
2766
2341
        Different repository implementations should override _check().
2767
2342
 
2768
2343
        :param revision_ids: A non-empty list of revision_ids whose ancestry
2769
2344
             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.
2775
2345
        """
2776
 
        return self._check(revision_ids, callback_refs=callback_refs,
2777
 
            check_repo=check_repo)
 
2346
        return self._check(revision_ids)
2778
2347
 
2779
 
    def _check(self, revision_ids, callback_refs, check_repo):
2780
 
        result = check.Check(self, check_repo=check_repo)
2781
 
        result.check(callback_refs)
 
2348
    def _check(self, revision_ids):
 
2349
        result = check.Check(self)
 
2350
        result.check()
2782
2351
        return result
2783
2352
 
2784
 
    def _warn_if_deprecated(self, branch=None):
 
2353
    def _warn_if_deprecated(self):
2785
2354
        global _deprecation_warning_done
2786
2355
        if _deprecation_warning_done:
2787
2356
            return
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
 
2357
        _deprecation_warning_done = True
 
2358
        warning("Format %s for %s is deprecated - please use 'bzr upgrade' to get better performance"
 
2359
                % (self._format, self.bzrdir.transport.base))
2800
2360
 
2801
2361
    def supports_rich_root(self):
2802
2362
        return self._format.rich_root_data
2876
2436
    """
2877
2437
    repository.start_write_group()
2878
2438
    try:
2879
 
        inventory_cache = lru_cache.LRUCache(10)
2880
2439
        for n, (revision, revision_tree, signature) in enumerate(iterable):
2881
 
            _install_revision(repository, revision, revision_tree, signature,
2882
 
                inventory_cache)
 
2440
            _install_revision(repository, revision, revision_tree, signature)
2883
2441
            if pb is not None:
2884
2442
                pb.update('Transferring revisions', n + 1, num_revisions)
2885
2443
    except:
2889
2447
        repository.commit_write_group()
2890
2448
 
2891
2449
 
2892
 
def _install_revision(repository, rev, revision_tree, signature,
2893
 
    inventory_cache):
 
2450
def _install_revision(repository, rev, revision_tree, signature):
2894
2451
    """Install all revision data into a repository."""
2895
2452
    present_parents = []
2896
2453
    parent_trees = {}
2933
2490
        repository.texts.add_lines(text_key, text_parents, lines)
2934
2491
    try:
2935
2492
        # install the inventory
2936
 
        if repository._format._commit_inv_deltas and len(rev.parent_ids):
2937
 
            # Cache this inventory
2938
 
            inventory_cache[rev.revision_id] = inv
2939
 
            try:
2940
 
                basis_inv = inventory_cache[rev.parent_ids[0]]
2941
 
            except KeyError:
2942
 
                repository.add_inventory(rev.revision_id, inv, present_parents)
2943
 
            else:
2944
 
                delta = inv._make_delta(basis_inv)
2945
 
                repository.add_inventory_by_delta(rev.parent_ids[0], delta,
2946
 
                    rev.revision_id, present_parents)
2947
 
        else:
2948
 
            repository.add_inventory(rev.revision_id, inv, present_parents)
 
2493
        repository.add_inventory(rev.revision_id, inv, present_parents)
2949
2494
    except errors.RevisionAlreadyPresent:
2950
2495
        pass
2951
2496
    if signature is not None:
3042
2587
 
3043
2588
    Once a format is deprecated, just deprecate the initialize and open
3044
2589
    methods on the format class. Do not deprecate the object, as the
3045
 
    object may be created even when a repository instance hasn't been
 
2590
    object may be created even when a repository instnace hasn't been
3046
2591
    created.
3047
2592
 
3048
2593
    Common instance attributes:
3058
2603
    # Can this repository be given external locations to lookup additional
3059
2604
    # data. Set to True or False in derived classes.
3060
2605
    supports_external_lookups = None
3061
 
    # Does this format support CHK bytestring lookups. Set to True or False in
3062
 
    # derived classes.
3063
 
    supports_chks = None
3064
 
    # Should commit add an inventory, or an inventory delta to the repository.
3065
 
    _commit_inv_deltas = True
3066
2606
    # What order should fetch operations request streams in?
3067
2607
    # The default is unordered as that is the cheapest for an origin to
3068
2608
    # provide.
3078
2618
    # Does this format have < O(tree_size) delta generation. Used to hint what
3079
2619
    # code path for commit, amongst other things.
3080
2620
    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
3090
2621
 
3091
 
    def __repr__(self):
3092
 
        return "%s()" % self.__class__.__name__
 
2622
    def __str__(self):
 
2623
        return "<%s>" % self.__class__.__name__
3093
2624
 
3094
2625
    def __eq__(self, other):
3095
2626
        # format objects are generally stateless
3108
2639
        """
3109
2640
        try:
3110
2641
            transport = a_bzrdir.get_repository_transport(None)
3111
 
            format_string = transport.get_bytes("format")
 
2642
            format_string = transport.get("format").read()
3112
2643
            return format_registry.get(format_string)
3113
2644
        except errors.NoSuchFile:
3114
2645
            raise errors.NoRepositoryPresent(a_bzrdir)
3196
2727
        raise NotImplementedError(self.network_name)
3197
2728
 
3198
2729
    def check_conversion_target(self, target_format):
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)
 
2730
        raise NotImplementedError(self.check_conversion_target)
3208
2731
 
3209
2732
    def open(self, a_bzrdir, _found=False):
3210
2733
        """Return an instance of this format for the bzrdir a_bzrdir.
3213
2736
        """
3214
2737
        raise NotImplementedError(self.open)
3215
2738
 
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
 
 
3225
2739
 
3226
2740
class MetaDirRepositoryFormat(RepositoryFormat):
3227
2741
    """Common base class for the new repositories using the metadir layout."""
3275
2789
# Pre-0.8 formats that don't have a disk format string (because they are
3276
2790
# versioned by the matching control directory). We use the control directories
3277
2791
# disk format string as a key for the network_name because they meet the
3278
 
# constraints (simple string, unique, immutable).
 
2792
# constraints (simple string, unique, immmutable).
3279
2793
network_format_registry.register_lazy(
3280
2794
    "Bazaar-NG branch, format 5\n",
3281
2795
    'bzrlib.repofmt.weaverepo',
3362
2876
    )
3363
2877
 
3364
2878
# Development formats.
3365
 
# Obsolete but kept pending a CHK based subtree format.
 
2879
# 1.7->1.8 go below here
 
2880
format_registry.register_lazy(
 
2881
    "Bazaar development format 2 (needs bzr.dev from before 1.8)\n",
 
2882
    'bzrlib.repofmt.pack_repo',
 
2883
    'RepositoryFormatPackDevelopment2',
 
2884
    )
3366
2885
format_registry.register_lazy(
3367
2886
    ("Bazaar development format 2 with subtree support "
3368
2887
        "(needs bzr.dev from before 1.8)\n"),
3370
2889
    'RepositoryFormatPackDevelopment2Subtree',
3371
2890
    )
3372
2891
 
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',
3391
 
    )
3392
 
 
3393
2892
 
3394
2893
class InterRepository(InterObject):
3395
2894
    """This class represents operations taking place between two repositories.
3432
2931
 
3433
2932
        :param revision_id: if None all content is copied, if NULL_REVISION no
3434
2933
                            content is copied.
3435
 
        :param pb: ignored.
 
2934
        :param pb: optional progress bar to use for progress reports. If not
 
2935
                   provided a default one will be created.
3436
2936
        :return: None.
3437
2937
        """
3438
 
        ui.ui_factory.warn_experimental_format_fetch(self)
3439
2938
        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)
3445
2939
        f = RepoFetcher(to_repository=self.target,
3446
2940
                               from_repository=self.source,
3447
2941
                               last_revision=revision_id,
3448
2942
                               fetch_spec=fetch_spec,
3449
 
                               find_ghosts=find_ghosts)
 
2943
                               pb=pb, find_ghosts=find_ghosts)
3450
2944
 
3451
2945
    def _walk_to_common_revisions(self, revision_ids):
3452
2946
        """Walk out from revision_ids in source to revisions target has.
3456
2950
        """
3457
2951
        target_graph = self.target.get_graph()
3458
2952
        revision_ids = frozenset(revision_ids)
 
2953
        # Fast path for the case where all the revisions are already in the
 
2954
        # target repo.
 
2955
        # (Although this does incur an extra round trip for the
 
2956
        # fairly common case where the target doesn't already have the revision
 
2957
        # we're pushing.)
 
2958
        if set(target_graph.get_parent_map(revision_ids)) == revision_ids:
 
2959
            return graph.SearchResult(revision_ids, set(), 0, set())
3459
2960
        missing_revs = set()
3460
2961
        source_graph = self.source.get_graph()
3461
2962
        # ensure we don't pay silly lookup costs.
3621
3122
                self.target.texts.insert_record_stream(
3622
3123
                    self.source.texts.get_record_stream(
3623
3124
                        self.source.texts.keys(), 'topological', False))
3624
 
                pb.update('Copying inventory', 0, 1)
 
3125
                pb.update('copying inventory', 0, 1)
3625
3126
                self.target.inventories.insert_record_stream(
3626
3127
                    self.source.inventories.get_record_stream(
3627
3128
                        self.source.inventories.keys(), 'topological', False))
3648
3149
        # so the first thing is to get a subset of the revisions to
3649
3150
        # satisfy revision_id in source, and then eliminate those that
3650
3151
        # we do already have.
3651
 
        # this is slow on high latency connection to self, but as this
 
3152
        # this is slow on high latency connection to self, but as as this
3652
3153
        # disk format scales terribly for push anyway due to rewriting
3653
3154
        # inventory.weave, this is considered acceptable.
3654
3155
        # - RBC 20060209
3741
3242
        return self.source.revision_ids_to_search_result(result_set)
3742
3243
 
3743
3244
 
3744
 
class InterDifferingSerializer(InterRepository):
 
3245
class InterPackRepo(InterSameDataRepository):
 
3246
    """Optimised code paths between Pack based repositories."""
 
3247
 
 
3248
    @classmethod
 
3249
    def _get_repo_format_to_test(self):
 
3250
        from bzrlib.repofmt import pack_repo
 
3251
        return pack_repo.RepositoryFormatKnitPack1()
 
3252
 
 
3253
    @staticmethod
 
3254
    def is_compatible(source, target):
 
3255
        """Be compatible with known Pack formats.
 
3256
 
 
3257
        We don't test for the stores being of specific types because that
 
3258
        could lead to confusing results, and there is no need to be
 
3259
        overly general.
 
3260
        """
 
3261
        from bzrlib.repofmt.pack_repo import RepositoryFormatPack
 
3262
        try:
 
3263
            are_packs = (isinstance(source._format, RepositoryFormatPack) and
 
3264
                isinstance(target._format, RepositoryFormatPack))
 
3265
        except AttributeError:
 
3266
            return False
 
3267
        return are_packs and InterRepository._same_model(source, target)
 
3268
 
 
3269
    @needs_write_lock
 
3270
    def fetch(self, revision_id=None, pb=None, find_ghosts=False,
 
3271
            fetch_spec=None):
 
3272
        """See InterRepository.fetch()."""
 
3273
        if (len(self.source._fallback_repositories) > 0 or
 
3274
            len(self.target._fallback_repositories) > 0):
 
3275
            # The pack layer is not aware of fallback repositories, so when
 
3276
            # fetching from a stacked repository or into a stacked repository
 
3277
            # we use the generic fetch logic which uses the VersionedFiles
 
3278
            # attributes on repository.
 
3279
            from bzrlib.fetch import RepoFetcher
 
3280
            fetcher = RepoFetcher(self.target, self.source, revision_id,
 
3281
                    pb, find_ghosts, fetch_spec=fetch_spec)
 
3282
        if fetch_spec is not None:
 
3283
            if len(list(fetch_spec.heads)) != 1:
 
3284
                raise AssertionError(
 
3285
                    "InterPackRepo.fetch doesn't support "
 
3286
                    "fetching multiple heads yet.")
 
3287
            revision_id = list(fetch_spec.heads)[0]
 
3288
            fetch_spec = None
 
3289
        if revision_id is None:
 
3290
            # TODO:
 
3291
            # everything to do - use pack logic
 
3292
            # to fetch from all packs to one without
 
3293
            # inventory parsing etc, IFF nothing to be copied is in the target.
 
3294
            # till then:
 
3295
            source_revision_ids = frozenset(self.source.all_revision_ids())
 
3296
            revision_ids = source_revision_ids - \
 
3297
                frozenset(self.target.get_parent_map(source_revision_ids))
 
3298
            revision_keys = [(revid,) for revid in revision_ids]
 
3299
            index = self.target._pack_collection.revision_index.combined_index
 
3300
            present_revision_ids = set(item[1][0] for item in
 
3301
                index.iter_entries(revision_keys))
 
3302
            revision_ids = set(revision_ids) - present_revision_ids
 
3303
            # implementing the TODO will involve:
 
3304
            # - detecting when all of a pack is selected
 
3305
            # - avoiding as much as possible pre-selection, so the
 
3306
            # more-core routines such as create_pack_from_packs can filter in
 
3307
            # a just-in-time fashion. (though having a HEADS list on a
 
3308
            # repository might make this a lot easier, because we could
 
3309
            # sensibly detect 'new revisions' without doing a full index scan.
 
3310
        elif _mod_revision.is_null(revision_id):
 
3311
            # nothing to do:
 
3312
            return (0, [])
 
3313
        else:
 
3314
            try:
 
3315
                revision_ids = self.search_missing_revision_ids(revision_id,
 
3316
                    find_ghosts=find_ghosts).get_keys()
 
3317
            except errors.NoSuchRevision:
 
3318
                raise errors.InstallFailed([revision_id])
 
3319
            if len(revision_ids) == 0:
 
3320
                return (0, [])
 
3321
        return self._pack(self.source, self.target, revision_ids)
 
3322
 
 
3323
    def _pack(self, source, target, revision_ids):
 
3324
        from bzrlib.repofmt.pack_repo import Packer
 
3325
        packs = source._pack_collection.all_packs()
 
3326
        pack = Packer(self.target._pack_collection, packs, '.fetch',
 
3327
            revision_ids).pack()
 
3328
        if pack is not None:
 
3329
            self.target._pack_collection._save_pack_names()
 
3330
            copied_revs = pack.get_revision_count()
 
3331
            # Trigger an autopack. This may duplicate effort as we've just done
 
3332
            # a pack creation, but for now it is simpler to think about as
 
3333
            # 'upload data, then repack if needed'.
 
3334
            self.target._pack_collection.autopack()
 
3335
            return (copied_revs, [])
 
3336
        else:
 
3337
            return (0, [])
 
3338
 
 
3339
    @needs_read_lock
 
3340
    def search_missing_revision_ids(self, revision_id=None, find_ghosts=True):
 
3341
        """See InterRepository.missing_revision_ids().
 
3342
 
 
3343
        :param find_ghosts: Find ghosts throughout the ancestry of
 
3344
            revision_id.
 
3345
        """
 
3346
        if not find_ghosts and revision_id is not None:
 
3347
            return self._walk_to_common_revisions([revision_id])
 
3348
        elif revision_id is not None:
 
3349
            # Find ghosts: search for revisions pointing from one repository to
 
3350
            # the other, and vice versa, anywhere in the history of revision_id.
 
3351
            graph = self.target.get_graph(other_repository=self.source)
 
3352
            searcher = graph._make_breadth_first_searcher([revision_id])
 
3353
            found_ids = set()
 
3354
            while True:
 
3355
                try:
 
3356
                    next_revs, ghosts = searcher.next_with_ghosts()
 
3357
                except StopIteration:
 
3358
                    break
 
3359
                if revision_id in ghosts:
 
3360
                    raise errors.NoSuchRevision(self.source, revision_id)
 
3361
                found_ids.update(next_revs)
 
3362
                found_ids.update(ghosts)
 
3363
            found_ids = frozenset(found_ids)
 
3364
            # Double query here: should be able to avoid this by changing the
 
3365
            # graph api further.
 
3366
            result_set = found_ids - frozenset(
 
3367
                self.target.get_parent_map(found_ids))
 
3368
        else:
 
3369
            source_ids = self.source.all_revision_ids()
 
3370
            # source_ids is the worst possible case we may need to pull.
 
3371
            # now we want to filter source_ids against what we actually
 
3372
            # have in target, but don't try to check for existence where we know
 
3373
            # we do not have a revision as that would be pointless.
 
3374
            target_ids = set(self.target.all_revision_ids())
 
3375
            result_set = set(source_ids).difference(target_ids)
 
3376
        return self.source.revision_ids_to_search_result(result_set)
 
3377
 
 
3378
 
 
3379
class InterDifferingSerializer(InterKnitRepo):
3745
3380
 
3746
3381
    @classmethod
3747
3382
    def _get_repo_format_to_test(self):
3750
3385
    @staticmethod
3751
3386
    def is_compatible(source, target):
3752
3387
        """Be compatible with Knit2 source and Knit3 target"""
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:///'):
 
3388
        if source.supports_rich_root() != target.supports_rich_root():
 
3389
            return False
 
3390
        # Ideally, we'd support fetching if the source had no tree references
 
3391
        # even if it supported them...
 
3392
        if (getattr(source, '_format.supports_tree_reference', False) and
 
3393
            not getattr(target, '_format.supports_tree_reference', False)):
3774
3394
            return False
3775
3395
        return True
3776
3396
 
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):
 
3397
    def _get_delta_for_revision(self, tree, parent_ids, basis_id, cache):
3795
3398
        """Get the best delta and base for this revision.
3796
3399
 
3797
3400
        :return: (basis_id, delta)
3798
3401
        """
 
3402
        possible_trees = [(parent_id, cache[parent_id])
 
3403
                          for parent_id in parent_ids
 
3404
                           if parent_id in cache]
 
3405
        if len(possible_trees) == 0:
 
3406
            # There either aren't any parents, or the parents aren't in the
 
3407
            # cache, so just use the last converted tree
 
3408
            possible_trees.append((basis_id, cache[basis_id]))
3799
3409
        deltas = []
3800
 
        # Generate deltas against each tree, to find the shortest.
3801
 
        texts_possibly_new_in_tree = set()
3802
3410
        for basis_id, basis_tree in possible_trees:
3803
3411
            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))
3818
3412
            deltas.append((len(delta), basis_id, delta))
3819
3413
        deltas.sort()
3820
3414
        return deltas[0][1:]
3821
3415
 
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):
 
3416
    def _fetch_batch(self, revision_ids, basis_id, cache):
3852
3417
        """Fetch across a few revisions.
3853
3418
 
3854
3419
        :param revision_ids: The revisions to copy
3855
3420
        :param basis_id: The revision_id of a tree that must be in cache, used
3856
3421
            as a basis for delta when no other base is available
3857
3422
        :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.
3860
3423
        :return: The revision_id of the last converted tree. The RevisionTree
3861
3424
            for it will be in cache
3862
3425
        """
3863
3426
        # Walk though all revisions; get inventory deltas, copy referenced
3864
3427
        # texts that delta references, insert the delta, revision and
3865
3428
        # signature.
3866
 
        root_keys_to_create = set()
3867
3429
        text_keys = set()
3868
3430
        pending_deltas = []
3869
3431
        pending_revisions = []
3870
3432
        parent_map = self.source.get_parent_map(revision_ids)
3871
 
        self._fetch_parent_invs_for_stacking(parent_map, cache)
3872
 
        self.source._safe_to_return_from_cache = True
3873
3433
        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.
3876
3434
            current_revision_id = tree.get_revision_id()
3877
3435
            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]))
3884
3436
            basis_id, delta = self._get_delta_for_revision(tree, parent_ids,
3885
 
                                                           possible_trees)
 
3437
                                                           basis_id, cache)
 
3438
            # Find text entries that need to be copied
 
3439
            for old_path, new_path, file_id, entry in delta:
 
3440
                if new_path is not None:
 
3441
                    if not (new_path or self.target.supports_rich_root()):
 
3442
                        # We don't copy the text for the root node unless the
 
3443
                        # target supports_rich_root.
 
3444
                        continue
 
3445
                    text_keys.add((file_id, entry.revision))
3886
3446
            revision = self.source.get_revision(current_revision_id)
3887
3447
            pending_deltas.append((basis_id, delta,
3888
3448
                current_revision_id, revision.parent_ids))
3889
 
            if self._converting_to_rich_root:
3890
 
                self._revision_id_to_root_id[current_revision_id] = \
3891
 
                    tree.get_root_id()
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()
3895
 
            for old_path, new_path, file_id, entry in delta:
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)
3923
3449
            pending_revisions.append(revision)
3924
3450
            cache[current_revision_id] = tree
3925
3451
            basis_id = current_revision_id
3926
 
        self.source._safe_to_return_from_cache = False
3927
3452
        # Copy file texts
3928
3453
        from_texts = self.source.texts
3929
3454
        to_texts = self.target.texts
3930
 
        if root_keys_to_create:
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)
3935
3455
        to_texts.insert_record_stream(from_texts.get_record_stream(
3936
3456
            text_keys, self.target._format._fetch_order,
3937
3457
            not self.target._format._fetch_uses_deltas))
3938
 
        # insert inventory deltas
 
3458
        # insert deltas
3939
3459
        for delta in pending_deltas:
3940
3460
            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)
3970
3461
        # insert signatures and revisions
3971
3462
        for revision in pending_revisions:
3972
3463
            try:
3984
3475
 
3985
3476
        :param revision_ids: The list of revisions to fetch. Must be in
3986
3477
            topological order.
3987
 
        :param pb: A ProgressTask
 
3478
        :param pb: A ProgressBar
3988
3479
        :return: None
3989
3480
        """
3990
3481
        basis_id, basis_tree = self._get_basis(revision_ids[0])
3992
3483
        cache = lru_cache.LRUCache(100)
3993
3484
        cache[basis_id] = basis_tree
3994
3485
        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
 
 
4002
3486
        for offset in range(0, len(revision_ids), batch_size):
4003
3487
            self.target.start_write_group()
4004
3488
            try:
4005
3489
                pb.update('Transferring revisions', offset,
4006
3490
                          len(revision_ids))
4007
3491
                batch = revision_ids[offset:offset+batch_size]
4008
 
                basis_id = self._fetch_batch(batch, basis_id, cache,
4009
 
                                             a_graph=a_graph)
 
3492
                basis_id = self._fetch_batch(batch, basis_id, cache)
4010
3493
            except:
4011
 
                self.source._safe_to_return_from_cache = False
4012
3494
                self.target.abort_write_group()
4013
3495
                raise
4014
3496
            else:
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)
 
3497
                self.target.commit_write_group()
4020
3498
        pb.update('Transferring revisions', len(revision_ids),
4021
3499
                  len(revision_ids))
4022
3500
 
4026
3504
        """See InterRepository.fetch()."""
4027
3505
        if fetch_spec is not None:
4028
3506
            raise AssertionError("Not implemented yet...")
4029
 
        ui.ui_factory.warn_experimental_format_fetch(self)
4030
 
        if (not self.source.supports_rich_root()
4031
 
            and self.target.supports_rich_root()):
4032
 
            self._converting_to_rich_root = True
4033
 
            self._revision_id_to_root_id = {}
4034
 
        else:
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)
4041
3507
        revision_ids = self.target.search_missing_revision_ids(self.source,
4042
3508
            revision_id, find_ghosts=find_ghosts).get_keys()
4043
3509
        if not revision_ids:
4044
3510
            return 0, 0
4045
3511
        revision_ids = tsort.topo_sort(
4046
3512
            self.source.get_graph().get_parent_map(revision_ids))
4047
 
        if not revision_ids:
4048
 
            return 0, 0
4049
 
        # Walk though all revisions; get inventory deltas, copy referenced
4050
 
        # texts that delta references, insert the delta, revision and
4051
 
        # signature.
4052
3513
        if pb is None:
4053
3514
            my_pb = ui.ui_factory.nested_progress_bar()
4054
3515
            pb = my_pb
4091
3552
InterRepository.register_optimiser(InterSameDataRepository)
4092
3553
InterRepository.register_optimiser(InterWeaveRepo)
4093
3554
InterRepository.register_optimiser(InterKnitRepo)
 
3555
InterRepository.register_optimiser(InterPackRepo)
4094
3556
 
4095
3557
 
4096
3558
class CopyConverter(object):
4112
3574
        :param to_convert: The disk object to convert.
4113
3575
        :param pb: a progress bar to use for progress information.
4114
3576
        """
4115
 
        pb = ui.ui_factory.nested_progress_bar()
 
3577
        self.pb = pb
4116
3578
        self.count = 0
4117
3579
        self.total = 4
4118
3580
        # this is only useful with metadir layouts - separated repo content.
4119
3581
        # trigger an assertion if not such
4120
3582
        repo._format.get_format_string()
4121
3583
        self.repo_dir = repo.bzrdir
4122
 
        pb.update('Moving repository to repository.backup')
 
3584
        self.step('Moving repository to repository.backup')
4123
3585
        self.repo_dir.transport.move('repository', 'repository.backup')
4124
3586
        backup_transport =  self.repo_dir.transport.clone('repository.backup')
4125
3587
        repo._format.check_conversion_target(self.target_format)
4126
3588
        self.source_repo = repo._format.open(self.repo_dir,
4127
3589
            _found=True,
4128
3590
            _override_transport=backup_transport)
4129
 
        pb.update('Creating new repository')
 
3591
        self.step('Creating new repository')
4130
3592
        converted = self.target_format.initialize(self.repo_dir,
4131
3593
                                                  self.source_repo.is_shared())
4132
3594
        converted.lock_write()
4133
3595
        try:
4134
 
            pb.update('Copying content')
 
3596
            self.step('Copying content into repository.')
4135
3597
            self.source_repo.copy_content_into(converted)
4136
3598
        finally:
4137
3599
            converted.unlock()
4138
 
        pb.update('Deleting old repository content')
 
3600
        self.step('Deleting old repository content.')
4139
3601
        self.repo_dir.transport.delete_tree('repository.backup')
4140
 
        ui.ui_factory.note('repository converted')
4141
 
        pb.finished()
 
3602
        self.pb.note('repository converted')
 
3603
 
 
3604
    def step(self, message):
 
3605
        """Update the pb by a step."""
 
3606
        self.count +=1
 
3607
        self.pb.update(message, self.count, self.total)
4142
3608
 
4143
3609
 
4144
3610
_unescape_map = {
4173
3639
 
4174
3640
class _VersionedFileChecker(object):
4175
3641
 
4176
 
    def __init__(self, repository, text_key_references=None, ancestors=None):
 
3642
    def __init__(self, repository, text_key_references=None):
4177
3643
        self.repository = repository
4178
3644
        self.text_index = self.repository._generate_text_key_index(
4179
 
            text_key_references=text_key_references, ancestors=ancestors)
 
3645
            text_key_references=text_key_references)
4180
3646
 
4181
3647
    def calculate_file_version_parents(self, text_key):
4182
3648
        """Calculate the correct parents for a file version according to
4200
3666
            revision_id) tuples for versions that are present in this versioned
4201
3667
            file, but not used by the corresponding inventory.
4202
3668
        """
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."""
4215
3669
        wrong_parents = {}
4216
3670
        self.file_ids = set([file_id for file_id, _ in
4217
3671
            self.text_index.iterkeys()])
4218
3672
        # text keys is now grouped by file_id
 
3673
        n_weaves = len(self.file_ids)
 
3674
        files_in_revisions = {}
 
3675
        revisions_of_files = {}
4219
3676
        n_versions = len(self.text_index)
4220
3677
        progress_bar.update('loading text store', 0, n_versions)
4221
3678
        parent_map = self.repository.texts.get_parent_map(self.text_index)
4223
3680
        text_keys = self.repository.texts.keys()
4224
3681
        unused_keys = frozenset(text_keys) - set(self.text_index)
4225
3682
        for num, key in enumerate(self.text_index.iterkeys()):
4226
 
            progress_bar.update('checking text graph', num, n_versions)
 
3683
            if progress_bar is not None:
 
3684
                progress_bar.update('checking text graph', num, n_versions)
4227
3685
            correct_parents = self.calculate_file_version_parents(key)
4228
3686
            try:
4229
3687
                knit_parents = parent_map[key]
4278
3736
        try:
4279
3737
            if resume_tokens:
4280
3738
                self.target_repo.resume_write_group(resume_tokens)
4281
 
                is_resume = True
4282
3739
            else:
4283
3740
                self.target_repo.start_write_group()
4284
 
                is_resume = False
4285
3741
            try:
4286
3742
                # locked_insert_stream performs a commit|suspend.
4287
 
                return self._locked_insert_stream(stream, src_format,
4288
 
                    is_resume)
 
3743
                return self._locked_insert_stream(stream, src_format)
4289
3744
            except:
4290
3745
                self.target_repo.abort_write_group(suppress_errors=True)
4291
3746
                raise
4292
3747
        finally:
4293
3748
            self.target_repo.unlock()
4294
3749
 
4295
 
    def _locked_insert_stream(self, stream, src_format, is_resume):
 
3750
    def _locked_insert_stream(self, stream, src_format):
4296
3751
        to_serializer = self.target_repo._format._serializer
4297
3752
        src_serializer = src_format._serializer
4298
 
        new_pack = None
4299
3753
        if to_serializer == src_serializer:
4300
3754
            # If serializers match and the target is a pack repository, set the
4301
3755
            # write cache size on the new pack.  This avoids poor performance
4315
3769
            else:
4316
3770
                new_pack.set_write_cache_size(1024*1024)
4317
3771
        for substream_type, substream in stream:
4318
 
            if 'stream' in debug.debug_flags:
4319
 
                mutter('inserting substream: %s', substream_type)
4320
3772
            if substream_type == 'texts':
4321
3773
                self.target_repo.texts.insert_record_stream(substream)
4322
3774
            elif substream_type == 'inventories':
4326
3778
                else:
4327
3779
                    self._extract_and_insert_inventories(
4328
3780
                        substream, src_serializer)
4329
 
            elif substream_type == 'inventory-deltas':
4330
 
                self._extract_and_insert_inventory_deltas(
4331
 
                    substream, src_serializer)
4332
 
            elif substream_type == 'chk_bytes':
4333
 
                # XXX: This doesn't support conversions, as it assumes the
4334
 
                #      conversion was done in the fetch code.
4335
 
                self.target_repo.chk_bytes.insert_record_stream(substream)
4336
3781
            elif substream_type == 'revisions':
4337
3782
                # This may fallback to extract-and-insert more often than
4338
3783
                # required if the serializers are different only in terms of
4339
3784
                # the inventory.
4340
3785
                if src_serializer == to_serializer:
4341
 
                    self.target_repo.revisions.insert_record_stream(substream)
 
3786
                    self.target_repo.revisions.insert_record_stream(
 
3787
                        substream)
4342
3788
                else:
4343
3789
                    self._extract_and_insert_revisions(substream,
4344
3790
                        src_serializer)
4346
3792
                self.target_repo.signatures.insert_record_stream(substream)
4347
3793
            else:
4348
3794
                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)
4357
3795
        try:
 
3796
            missing_keys = set()
4358
3797
            for prefix, versioned_file in (
4359
3798
                ('texts', self.target_repo.texts),
4360
3799
                ('inventories', self.target_repo.inventories),
4361
3800
                ('revisions', self.target_repo.revisions),
4362
3801
                ('signatures', self.target_repo.signatures),
4363
 
                ('chk_bytes', self.target_repo.chk_bytes),
4364
3802
                ):
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...
4374
3803
                missing_keys.update((prefix,) + key for key in
4375
3804
                    versioned_file.get_missing_compression_parent_keys())
4376
3805
        except NotImplementedError:
4385
3814
                # missing keys can handle suspending a write group).
4386
3815
                write_group_tokens = self.target_repo.suspend_write_group()
4387
3816
                return write_group_tokens, missing_keys
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)
 
3817
        self.target_repo.commit_write_group()
4392
3818
        return [], set()
4393
3819
 
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):
 
3820
    def _extract_and_insert_inventories(self, substream, serializer):
4415
3821
        """Generate a new inventory versionedfile in target, converting data.
4416
3822
 
4417
3823
        The inventory is retrieved from the source, (deserializing it), and
4418
3824
        stored in the target (reserializing it in a different format).
4419
3825
        """
4420
 
        target_rich_root = self.target_repo._format.rich_root_data
4421
 
        target_tree_refs = self.target_repo._format.supports_tree_reference
4422
3826
        for record in substream:
4423
 
            # It's not a delta, so it must be a fulltext in the source
4424
 
            # serializer's format.
4425
3827
            bytes = record.get_bytes_as('fulltext')
4426
3828
            revision_id = record.key[0]
4427
3829
            inv = serializer.read_inventory_from_string(bytes, revision_id)
4428
3830
            parents = [key[0] for key in record.parents]
4429
3831
            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
4433
3832
 
4434
3833
    def _extract_and_insert_revisions(self, substream, serializer):
4435
3834
        for record in substream:
4452
3851
        """Create a StreamSource streaming from from_repository."""
4453
3852
        self.from_repository = from_repository
4454
3853
        self.to_format = to_format
4455
 
        self._record_counter = RecordCounter()
4456
3854
 
4457
3855
    def delta_on_metadata(self):
4458
3856
        """Return True if delta's are permitted on metadata streams.
4485
3883
        return [('signatures', signatures), ('revisions', revisions)]
4486
3884
 
4487
3885
    def _generate_root_texts(self, revs):
4488
 
        """This will be called by get_stream between fetching weave texts and
 
3886
        """This will be called by __fetch between fetching weave texts and
4489
3887
        fetching the inventory weave.
 
3888
 
 
3889
        Subclasses should override this if they need to generate root texts
 
3890
        after fetching weave texts.
4490
3891
        """
4491
3892
        if self._rich_root_upgrade():
4492
 
            return _mod_fetch.Inter1and2Helper(
 
3893
            import bzrlib.fetch
 
3894
            return bzrlib.fetch.Inter1and2Helper(
4493
3895
                self.from_repository).generate_root_texts(revs)
4494
3896
        else:
4495
3897
            return []
4498
3900
        phase = 'file'
4499
3901
        revs = search.get_keys()
4500
3902
        graph = self.from_repository.get_graph()
4501
 
        revs = tsort.topo_sort(graph.get_parent_map(revs))
 
3903
        revs = list(graph.iter_topo_order(revs))
4502
3904
        data_to_fetch = self.from_repository.item_keys_introduced_by(revs)
4503
3905
        text_keys = []
4504
3906
        for knit_kind, file_id, revisions in data_to_fetch:
4523
3925
                # will be valid.
4524
3926
                for _ in self._generate_root_texts(revs):
4525
3927
                    yield _
 
3928
                # NB: This currently reopens the inventory weave in source;
 
3929
                # using a single stream interface instead would avoid this.
 
3930
                from_weave = self.from_repository.inventories
4526
3931
                # we fetch only the referenced inventories because we do not
4527
3932
                # know for unselected inventories whether all their required
4528
3933
                # texts are present in the other repository - it could be
4529
3934
                # corrupt.
4530
 
                for info in self._get_inventory_stream(revs):
4531
 
                    yield info
 
3935
                yield ('inventories', from_weave.get_record_stream(
 
3936
                    [(rev_id,) for rev_id in revs],
 
3937
                    self.inventory_fetch_order(),
 
3938
                    not self.delta_on_metadata()))
4532
3939
            elif knit_kind == "signatures":
4533
3940
                # Nothing to do here; this will be taken care of when
4534
3941
                # _fetch_revision_texts happens.
4547
3954
        keys['texts'] = set()
4548
3955
        keys['revisions'] = set()
4549
3956
        keys['inventories'] = set()
4550
 
        keys['chk_bytes'] = set()
4551
3957
        keys['signatures'] = set()
4552
3958
        for key in missing_keys:
4553
3959
            keys[key[0]].add(key[1:])
4560
3966
                    keys['revisions'],))
4561
3967
        for substream_kind, keys in keys.iteritems():
4562
3968
            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
 
 
4582
3969
            # Ask for full texts always so that we don't need more round trips
4583
3970
            # after this stream.
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))
 
3971
            stream = vf.get_record_stream(keys,
 
3972
                self.to_format._fetch_order, True)
4590
3973
            yield substream_kind, stream
4591
3974
 
4592
3975
    def inventory_fetch_order(self):
4599
3982
        return (not self.from_repository._format.rich_root_data and
4600
3983
            self.to_format.rich_root_data)
4601
3984
 
4602
 
    def _get_inventory_stream(self, revision_ids, missing=False):
4603
 
        from_format = self.from_repository._format
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)
4620
 
        else:
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)
4625
 
 
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.
4629
 
        from_weave = self.from_repository.inventories
4630
 
        if missing:
4631
 
            delta_closure = True
4632
 
        else:
4633
 
            delta_closure = not self.delta_on_metadata()
4634
 
        yield ('inventories', from_weave.get_record_stream(
4635
 
            [(rev_id,) for rev_id in 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
 
        """
4660
 
        from_repo = self.from_repository
4661
 
        revision_keys = [(rev_id,) for rev_id in revision_ids]
4662
 
        parent_map = from_repo.inventories.get_parent_map(revision_keys)
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:
4679
 
            key = (inv.revision_id,)
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))
4712
 
            yield versionedfile.FulltextContentFactory(
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
4746