/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/knit.py

  • Committer: Jean-Francois Roy
  • Date: 2009-03-13 02:40:46 UTC
  • mto: (4149.1.1 bzr.integration)
  • mto: This revision was merged to the branch mainline in revision 4150.
  • Revision ID: jeanfrancois@apple.com-20090313024046-80qx69ppgqbhhzoq
Updated test_config to account for the new credentials keys.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/knit.py
1
 
# Copyright (C) 2006-2010 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007, 2008 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""Knit versionedfile implementation.
18
18
 
53
53
 
54
54
 
55
55
from cStringIO import StringIO
56
 
from itertools import izip
 
56
from itertools import izip, chain
57
57
import operator
58
58
import os
59
59
import sys
69
69
    lru_cache,
70
70
    pack,
71
71
    progress,
72
 
    static_tuple,
73
72
    trace,
74
73
    tsort,
75
74
    tuned_gzip,
76
 
    ui,
77
75
    )
78
76
""")
79
77
from bzrlib import (
301
299
            if self._network_bytes is None:
302
300
                self._create_network_bytes()
303
301
            return self._network_bytes
304
 
        if ('-ft-' in self.storage_kind and
305
 
            storage_kind in ('chunked', 'fulltext')):
306
 
            adapter_key = (self.storage_kind, 'fulltext')
307
 
            adapter_factory = adapter_registry.get(adapter_key)
308
 
            adapter = adapter_factory(None)
309
 
            bytes = adapter.get_bytes(self)
310
 
            if storage_kind == 'chunked':
311
 
                return [bytes]
312
 
            else:
313
 
                return bytes
314
302
        if self._knit is not None:
315
 
            # Not redundant with direct conversion above - that only handles
316
 
            # fulltext cases.
317
303
            if storage_kind == 'chunked':
318
304
                return self._knit.get_lines(self.key[0])
319
305
            elif storage_kind == 'fulltext':
666
652
 
667
653
        see parse_fulltext which this inverts.
668
654
        """
 
655
        # TODO: jam 20070209 We only do the caching thing to make sure that
 
656
        #       the origin is a valid utf-8 line, eventually we could remove it
669
657
        return ['%s %s' % (o, t) for o, t in content._lines]
670
658
 
671
659
    def lower_line_delta(self, delta):
686
674
        content = knit._get_content(key)
687
675
        # adjust for the fact that serialised annotations are only key suffixes
688
676
        # for this factory.
689
 
        if type(key) is tuple:
 
677
        if type(key) == tuple:
690
678
            prefix = key[:-1]
691
679
            origins = content.annotate()
692
680
            result = []
758
746
 
759
747
    def annotate(self, knit, key):
760
748
        annotator = _KnitAnnotator(knit)
761
 
        return annotator.annotate_flat(key)
 
749
        return annotator.annotate(key)
762
750
 
763
751
 
764
752
 
909
897
            # indexes can't directly store that, so we give them
910
898
            # an empty tuple instead.
911
899
            parents = ()
912
 
        line_bytes = ''.join(lines)
913
900
        return self._add(key, lines, parents,
914
 
            parent_texts, left_matching_blocks, nostore_sha, random_id,
915
 
            line_bytes=line_bytes)
916
 
 
917
 
    def _add_text(self, key, parents, text, nostore_sha=None, random_id=False):
918
 
        """See VersionedFiles._add_text()."""
919
 
        self._index._check_write_ok()
920
 
        self._check_add(key, None, random_id, check_content=False)
921
 
        if text.__class__ is not str:
922
 
            raise errors.BzrBadParameterUnicode("text")
923
 
        if parents is None:
924
 
            # The caller might pass None if there is no graph data, but kndx
925
 
            # indexes can't directly store that, so we give them
926
 
            # an empty tuple instead.
927
 
            parents = ()
928
 
        return self._add(key, None, parents,
929
 
            None, None, nostore_sha, random_id,
930
 
            line_bytes=text)
 
901
            parent_texts, left_matching_blocks, nostore_sha, random_id)
931
902
 
932
903
    def _add(self, key, lines, parents, parent_texts,
933
 
        left_matching_blocks, nostore_sha, random_id,
934
 
        line_bytes):
 
904
        left_matching_blocks, nostore_sha, random_id):
935
905
        """Add a set of lines on top of version specified by parents.
936
906
 
937
907
        Any versions not present will be converted into ghosts.
938
 
 
939
 
        :param lines: A list of strings where each one is a single line (has a
940
 
            single newline at the end of the string) This is now optional
941
 
            (callers can pass None). It is left in its location for backwards
942
 
            compatibility. It should ''.join(lines) must == line_bytes
943
 
        :param line_bytes: A single string containing the content
944
 
 
945
 
        We pass both lines and line_bytes because different routes bring the
946
 
        values to this function. And for memory efficiency, we don't want to
947
 
        have to split/join on-demand.
948
908
        """
949
909
        # first thing, if the content is something we don't need to store, find
950
910
        # that out.
 
911
        line_bytes = ''.join(lines)
951
912
        digest = sha_string(line_bytes)
952
913
        if nostore_sha == digest:
953
914
            raise errors.ExistingContent
974
935
 
975
936
        text_length = len(line_bytes)
976
937
        options = []
977
 
        no_eol = False
978
 
        # Note: line_bytes is not modified to add a newline, that is tracked
979
 
        #       via the no_eol flag. 'lines' *is* modified, because that is the
980
 
        #       general values needed by the Content code.
981
 
        if line_bytes and line_bytes[-1] != '\n':
982
 
            options.append('no-eol')
983
 
            no_eol = True
984
 
            # Copy the existing list, or create a new one
985
 
            if lines is None:
986
 
                lines = osutils.split_lines(line_bytes)
987
 
            else:
 
938
        if lines:
 
939
            if lines[-1][-1] != '\n':
 
940
                # copy the contents of lines.
988
941
                lines = lines[:]
989
 
            # Replace the last line with one that ends in a final newline
990
 
            lines[-1] = lines[-1] + '\n'
991
 
        if lines is None:
992
 
            lines = osutils.split_lines(line_bytes)
 
942
                options.append('no-eol')
 
943
                lines[-1] = lines[-1] + '\n'
 
944
                line_bytes += '\n'
993
945
 
994
 
        for element in key[:-1]:
995
 
            if type(element) is not str:
996
 
                raise TypeError("key contains non-strings: %r" % (key,))
997
 
        if key[-1] is None:
998
 
            key = key[:-1] + ('sha1:' + digest,)
999
 
        elif type(key[-1]) is not str:
 
946
        for element in key:
 
947
            if type(element) != str:
1000
948
                raise TypeError("key contains non-strings: %r" % (key,))
1001
949
        # Knit hunks are still last-element only
1002
950
        version_id = key[-1]
1003
951
        content = self._factory.make(lines, version_id)
1004
 
        if no_eol:
 
952
        if 'no-eol' in options:
1005
953
            # Hint to the content object that its text() call should strip the
1006
954
            # EOL.
1007
955
            content._should_strip_eol = True
1022
970
            if self._factory.__class__ is KnitPlainFactory:
1023
971
                # Use the already joined bytes saving iteration time in
1024
972
                # _record_to_data.
1025
 
                dense_lines = [line_bytes]
1026
 
                if no_eol:
1027
 
                    dense_lines.append('\n')
1028
973
                size, bytes = self._record_to_data(key, digest,
1029
 
                    lines, dense_lines)
 
974
                    lines, [line_bytes])
1030
975
            else:
1031
976
                # get mixed annotation + content and feed it into the
1032
977
                # serialiser.
1044
989
        """See VersionedFiles.annotate."""
1045
990
        return self._factory.annotate(self, key)
1046
991
 
1047
 
    def get_annotator(self):
1048
 
        return _KnitAnnotator(self)
1049
 
 
1050
 
    def check(self, progress_bar=None, keys=None):
 
992
    def check(self, progress_bar=None):
1051
993
        """See VersionedFiles.check()."""
1052
 
        if keys is None:
1053
 
            return self._logical_check()
1054
 
        else:
1055
 
            # At the moment, check does not extra work over get_record_stream
1056
 
            return self.get_record_stream(keys, 'unordered', True)
1057
 
 
1058
 
    def _logical_check(self):
1059
994
        # This doesn't actually test extraction of everything, but that will
1060
995
        # impact 'bzr check' substantially, and needs to be integrated with
1061
996
        # care. However, it does check for the obvious problem of a delta with
1075
1010
    def _check_add(self, key, lines, random_id, check_content):
1076
1011
        """check that version_id and lines are safe to add."""
1077
1012
        version_id = key[-1]
1078
 
        if version_id is not None:
1079
 
            if contains_whitespace(version_id):
1080
 
                raise InvalidRevisionId(version_id, self)
1081
 
            self.check_not_reserved_id(version_id)
 
1013
        if contains_whitespace(version_id):
 
1014
            raise InvalidRevisionId(version_id, self)
 
1015
        self.check_not_reserved_id(version_id)
1082
1016
        # TODO: If random_id==False and the key is already present, we should
1083
1017
        # probably check that the existing content is identical to what is
1084
1018
        # being inserted, and otherwise raise an exception.  This would make
1192
1126
        generator = _VFContentMapGenerator(self, [key])
1193
1127
        return generator._get_content(key)
1194
1128
 
1195
 
    def get_known_graph_ancestry(self, keys):
1196
 
        """Get a KnownGraph instance with the ancestry of keys."""
1197
 
        parent_map, missing_keys = self._index.find_ancestry(keys)
1198
 
        for fallback in self._fallback_vfs:
1199
 
            if not missing_keys:
1200
 
                break
1201
 
            (f_parent_map, f_missing_keys) = fallback._index.find_ancestry(
1202
 
                                                missing_keys)
1203
 
            parent_map.update(f_parent_map)
1204
 
            missing_keys = f_missing_keys
1205
 
        kg = _mod_graph.KnownGraph(parent_map)
1206
 
        return kg
1207
 
 
1208
1129
    def get_parent_map(self, keys):
1209
1130
        """Get a map of the graph parents of keys.
1210
1131
 
1511
1432
                                                                non_local_keys,
1512
1433
                                                                positions):
1513
1434
                generator = _VFContentMapGenerator(self, keys, non_local_keys,
1514
 
                                                   global_map,
1515
 
                                                   ordering=ordering)
 
1435
                                                   global_map)
1516
1436
                for record in generator.get_record_stream():
1517
1437
                    yield record
1518
1438
        else:
1520
1440
                if source is parent_maps[0]:
1521
1441
                    # this KnitVersionedFiles
1522
1442
                    records = [(key, positions[key][1]) for key in keys]
1523
 
                    for key, raw_data in self._read_records_iter_unchecked(records):
 
1443
                    for key, raw_data, sha1 in self._read_records_iter_raw(records):
1524
1444
                        (record_details, index_memo, _) = positions[key]
1525
1445
                        yield KnitContentFactory(key, global_map[key],
1526
 
                            record_details, None, raw_data, self._factory.annotated, None)
 
1446
                            record_details, sha1, raw_data, self._factory.annotated, None)
1527
1447
                else:
1528
1448
                    vf = self._fallback_vfs[parent_maps.index(source) - 1]
1529
1449
                    for record in vf.get_record_stream(keys, ordering,
1598
1518
        # key = basis_parent, value = index entry to add
1599
1519
        buffered_index_entries = {}
1600
1520
        for record in stream:
1601
 
            kind = record.storage_kind
1602
 
            if kind.startswith('knit-') and kind.endswith('-gz'):
1603
 
                # Check that the ID in the header of the raw knit bytes matches
1604
 
                # the record metadata.
1605
 
                raw_data = record._raw_record
1606
 
                df, rec = self._parse_record_header(record.key, raw_data)
1607
 
                df.close()
1608
1521
            buffered = False
1609
1522
            parents = record.parents
1610
1523
            if record.storage_kind in delta_types:
1684
1597
                # KnitVersionedFiles doesn't permit deltas (_max_delta_chain ==
1685
1598
                # 0) or because it depends on a base only present in the
1686
1599
                # fallback kvfs.
1687
 
                self._access.flush()
1688
1600
                try:
1689
1601
                    # Try getting a fulltext directly from the record.
1690
1602
                    bytes = record.get_bytes_as('fulltext')
1712
1624
            # There were index entries buffered at the end of the stream,
1713
1625
            # So these need to be added (if the index supports holding such
1714
1626
            # entries for later insertion)
1715
 
            all_entries = []
1716
1627
            for key in buffered_index_entries:
1717
1628
                index_entries = buffered_index_entries[key]
1718
 
                all_entries.extend(index_entries)
1719
 
            self._index.add_records(
1720
 
                all_entries, missing_compression_parents=True)
 
1629
                self._index.add_records(index_entries,
 
1630
                    missing_compression_parents=True)
1721
1631
 
1722
1632
    def get_missing_compression_parent_keys(self):
1723
1633
        """Return an iterable of keys of missing compression parents.
1752
1662
         * If a requested key did not change any lines (or didn't have any
1753
1663
           lines), it may not be mentioned at all in the result.
1754
1664
 
1755
 
        :param pb: Progress bar supplied by caller.
1756
1665
        :return: An iterator over (line, key).
1757
1666
        """
1758
1667
        if pb is None:
1759
 
            pb = ui.ui_factory.nested_progress_bar()
 
1668
            pb = progress.DummyProgress()
1760
1669
        keys = set(keys)
1761
1670
        total = len(keys)
1762
1671
        done = False
1992
1901
            function spends less time resizing the final string.
1993
1902
        :return: (len, a StringIO instance with the raw data ready to read.)
1994
1903
        """
1995
 
        chunks = ["version %s %d %s\n" % (key[-1], len(lines), digest)]
1996
 
        chunks.extend(dense_lines or lines)
1997
 
        chunks.append("end %s\n" % key[-1])
1998
 
        for chunk in chunks:
1999
 
            if type(chunk) is not str:
2000
 
                raise AssertionError(
2001
 
                    'data must be plain bytes was %s' % type(chunk))
 
1904
        # Note: using a string copy here increases memory pressure with e.g.
 
1905
        # ISO's, but it is about 3 seconds faster on a 1.2Ghz intel machine
 
1906
        # when doing the initial commit of a mozilla tree. RBC 20070921
 
1907
        bytes = ''.join(chain(
 
1908
            ["version %s %d %s\n" % (key[-1],
 
1909
                                     len(lines),
 
1910
                                     digest)],
 
1911
            dense_lines or lines,
 
1912
            ["end %s\n" % key[-1]]))
 
1913
        if type(bytes) != str:
 
1914
            raise AssertionError(
 
1915
                'data must be plain bytes was %s' % type(bytes))
2002
1916
        if lines and lines[-1][-1] != '\n':
2003
1917
            raise ValueError('corrupt lines value %r' % lines)
2004
 
        compressed_bytes = tuned_gzip.chunks_to_gzip(chunks)
 
1918
        compressed_bytes = tuned_gzip.bytes_to_gzip(bytes)
2005
1919
        return len(compressed_bytes), compressed_bytes
2006
1920
 
2007
1921
    def _split_header(self, line):
2025
1939
class _ContentMapGenerator(object):
2026
1940
    """Generate texts or expose raw deltas for a set of texts."""
2027
1941
 
2028
 
    def __init__(self, ordering='unordered'):
2029
 
        self._ordering = ordering
2030
 
 
2031
1942
    def _get_content(self, key):
2032
1943
        """Get the content object for key."""
2033
1944
        # Note that _get_content is only called when the _ContentMapGenerator
2067
1978
            # Loop over fallback repositories asking them for texts - ignore
2068
1979
            # any missing from a particular fallback.
2069
1980
            for record in source.get_record_stream(missing_keys,
2070
 
                self._ordering, True):
 
1981
                'unordered', True):
2071
1982
                if record.storage_kind == 'absent':
2072
1983
                    # Not in thie particular stream, may be in one of the
2073
1984
                    # other fallback vfs objects.
2075
1986
                missing_keys.remove(record.key)
2076
1987
                yield record
2077
1988
 
2078
 
        if self._raw_record_map is None:
2079
 
            raise AssertionError('_raw_record_map should have been filled')
 
1989
        self._raw_record_map = self.vf._get_record_map_unparsed(self.keys,
 
1990
            allow_missing=True)
2080
1991
        first = True
2081
1992
        for key in self.keys:
2082
1993
            if key in self.nonlocal_keys:
2205
2116
    """Content map generator reading from a VersionedFiles object."""
2206
2117
 
2207
2118
    def __init__(self, versioned_files, keys, nonlocal_keys=None,
2208
 
        global_map=None, raw_record_map=None, ordering='unordered'):
 
2119
        global_map=None, raw_record_map=None):
2209
2120
        """Create a _ContentMapGenerator.
2210
2121
 
2211
2122
        :param versioned_files: The versioned files that the texts are being
2219
2130
        :param raw_record_map: A unparsed raw record map to use for answering
2220
2131
            contents.
2221
2132
        """
2222
 
        _ContentMapGenerator.__init__(self, ordering=ordering)
2223
2133
        # The vf to source data from
2224
2134
        self.vf = versioned_files
2225
2135
        # The keys desired
2369
2279
    FLAGS is a comma separated list of flags about the record. Values include
2370
2280
        no-eol, line-delta, fulltext.
2371
2281
    BYTE_OFFSET is the ascii representation of the byte offset in the data file
2372
 
        that the compressed data starts at.
 
2282
        that the the compressed data starts at.
2373
2283
    LENGTH is the ascii representation of the length of the data file.
2374
2284
    PARENT_ID a utf-8 revision id prefixed by a '.' that is a parent of
2375
2285
        REVISION_ID.
2446
2356
                    line = "\n%s %s %s %s %s :" % (
2447
2357
                        key[-1], ','.join(options), pos, size,
2448
2358
                        self._dictionary_compress(parents))
2449
 
                    if type(line) is not str:
 
2359
                    if type(line) != str:
2450
2360
                        raise AssertionError(
2451
2361
                            'data must be utf8 was %s' % type(line))
2452
2362
                    lines.append(line)
2584
2494
        except KeyError:
2585
2495
            raise RevisionNotPresent(key, self)
2586
2496
 
2587
 
    def find_ancestry(self, keys):
2588
 
        """See CombinedGraphIndex.find_ancestry()"""
2589
 
        prefixes = set(key[:-1] for key in keys)
2590
 
        self._load_prefixes(prefixes)
2591
 
        result = {}
2592
 
        parent_map = {}
2593
 
        missing_keys = set()
2594
 
        pending_keys = list(keys)
2595
 
        # This assumes that keys will not reference parents in a different
2596
 
        # prefix, which is accurate so far.
2597
 
        while pending_keys:
2598
 
            key = pending_keys.pop()
2599
 
            if key in parent_map:
2600
 
                continue
2601
 
            prefix = key[:-1]
2602
 
            try:
2603
 
                suffix_parents = self._kndx_cache[prefix][0][key[-1]][4]
2604
 
            except KeyError:
2605
 
                missing_keys.add(key)
2606
 
            else:
2607
 
                parent_keys = tuple([prefix + (suffix,)
2608
 
                                     for suffix in suffix_parents])
2609
 
                parent_map[key] = parent_keys
2610
 
                pending_keys.extend([p for p in parent_keys
2611
 
                                        if p not in parent_map])
2612
 
        return parent_map, missing_keys
2613
 
 
2614
2497
    def get_parent_map(self, keys):
2615
2498
        """Get a map of the parents of keys.
2616
2499
 
2668
2551
        result = set()
2669
2552
        # Identify all key prefixes.
2670
2553
        # XXX: A bit hacky, needs polish.
2671
 
        if type(self._mapper) is ConstantMapper:
 
2554
        if type(self._mapper) == ConstantMapper:
2672
2555
            prefixes = [()]
2673
2556
        else:
2674
2557
            relpaths = set()
2706
2589
                    del self._history
2707
2590
                except NoSuchFile:
2708
2591
                    self._kndx_cache[prefix] = ({}, [])
2709
 
                    if type(self._mapper) is ConstantMapper:
 
2592
                    if type(self._mapper) == ConstantMapper:
2710
2593
                        # preserve behaviour for revisions.kndx etc.
2711
2594
                        self._init_index(path)
2712
2595
                    del self._cache
2786
2669
        return key[:-1], key[-1]
2787
2670
 
2788
2671
 
2789
 
class _KeyRefs(object):
2790
 
 
2791
 
    def __init__(self, track_new_keys=False):
2792
 
        # dict mapping 'key' to 'set of keys referring to that key'
2793
 
        self.refs = {}
2794
 
        if track_new_keys:
2795
 
            # set remembering all new keys
2796
 
            self.new_keys = set()
2797
 
        else:
2798
 
            self.new_keys = None
2799
 
 
2800
 
    def clear(self):
2801
 
        if self.refs:
2802
 
            self.refs.clear()
2803
 
        if self.new_keys:
2804
 
            self.new_keys.clear()
2805
 
 
2806
 
    def add_references(self, key, refs):
2807
 
        # Record the new references
2808
 
        for referenced in refs:
2809
 
            try:
2810
 
                needed_by = self.refs[referenced]
2811
 
            except KeyError:
2812
 
                needed_by = self.refs[referenced] = set()
2813
 
            needed_by.add(key)
2814
 
        # Discard references satisfied by the new key
2815
 
        self.add_key(key)
2816
 
 
2817
 
    def get_new_keys(self):
2818
 
        return self.new_keys
2819
 
    
2820
 
    def get_unsatisfied_refs(self):
2821
 
        return self.refs.iterkeys()
2822
 
 
2823
 
    def _satisfy_refs_for_key(self, key):
2824
 
        try:
2825
 
            del self.refs[key]
2826
 
        except KeyError:
2827
 
            # No keys depended on this key.  That's ok.
2828
 
            pass
2829
 
 
2830
 
    def add_key(self, key):
2831
 
        # satisfy refs for key, and remember that we've seen this key.
2832
 
        self._satisfy_refs_for_key(key)
2833
 
        if self.new_keys is not None:
2834
 
            self.new_keys.add(key)
2835
 
 
2836
 
    def satisfy_refs_for_keys(self, keys):
2837
 
        for key in keys:
2838
 
            self._satisfy_refs_for_key(key)
2839
 
 
2840
 
    def get_referrers(self):
2841
 
        result = set()
2842
 
        for referrers in self.refs.itervalues():
2843
 
            result.update(referrers)
2844
 
        return result
2845
 
 
2846
 
 
2847
2672
class _KnitGraphIndex(object):
2848
2673
    """A KnitVersionedFiles index layered on GraphIndex."""
2849
2674
 
2850
2675
    def __init__(self, graph_index, is_locked, deltas=False, parents=True,
2851
 
        add_callback=None, track_external_parent_refs=False):
 
2676
        add_callback=None):
2852
2677
        """Construct a KnitGraphIndex on a graph_index.
2853
2678
 
2854
2679
        :param graph_index: An implementation of bzrlib.index.GraphIndex.
2862
2687
            [(node, value, node_refs), ...]
2863
2688
        :param is_locked: A callback, returns True if the index is locked and
2864
2689
            thus usable.
2865
 
        :param track_external_parent_refs: If True, record all external parent
2866
 
            references parents from added records.  These can be retrieved
2867
 
            later by calling get_missing_parents().
2868
2690
        """
2869
2691
        self._add_callback = add_callback
2870
2692
        self._graph_index = graph_index
2878
2700
        self.has_graph = parents
2879
2701
        self._is_locked = is_locked
2880
2702
        self._missing_compression_parents = set()
2881
 
        if track_external_parent_refs:
2882
 
            self._key_dependencies = _KeyRefs()
2883
 
        else:
2884
 
            self._key_dependencies = None
2885
2703
 
2886
2704
    def __repr__(self):
2887
2705
        return "%s(%r)" % (self.__class__.__name__, self._graph_index)
2911
2729
 
2912
2730
        keys = {}
2913
2731
        compression_parents = set()
2914
 
        key_dependencies = self._key_dependencies
2915
2732
        for (key, options, access_memo, parents) in records:
2916
2733
            if self._parents:
2917
2734
                parents = tuple(parents)
2918
 
                if key_dependencies is not None:
2919
 
                    key_dependencies.add_references(key, parents)
2920
2735
            index, pos, size = access_memo
2921
2736
            if 'no-eol' in options:
2922
2737
                value = 'N'
2946
2761
        if not random_id:
2947
2762
            present_nodes = self._get_entries(keys)
2948
2763
            for (index, key, value, node_refs) in present_nodes:
2949
 
                parents = node_refs[:1]
2950
 
                # Sometimes these are passed as a list rather than a tuple
2951
 
                passed = static_tuple.as_tuples(keys[key])
2952
 
                passed_parents = passed[1][:1]
2953
2764
                if (value[0] != keys[key][0][0] or
2954
 
                    parents != passed_parents):
2955
 
                    node_refs = static_tuple.as_tuples(node_refs)
 
2765
                    node_refs[:1] != keys[key][1][:1]):
2956
2766
                    raise KnitCorrupt(self, "inconsistent details in add_records"
2957
 
                        ": %s %s" % ((value, node_refs), passed))
 
2767
                        ": %s %s" % ((value, node_refs), keys[key]))
2958
2768
                del keys[key]
2959
2769
        result = []
2960
2770
        if self._parents:
2989
2799
            new_missing = graph_index.external_references(ref_list_num=1)
2990
2800
            new_missing.difference_update(self.get_parent_map(new_missing))
2991
2801
            self._missing_compression_parents.update(new_missing)
2992
 
        if self._key_dependencies is not None:
2993
 
            # Add parent refs from graph_index (and discard parent refs that
2994
 
            # the graph_index has).
2995
 
            for node in graph_index.iter_all_entries():
2996
 
                self._key_dependencies.add_references(node[1], node[3][0])
2997
2802
 
2998
2803
    def get_missing_compression_parents(self):
2999
2804
        """Return the keys of missing compression parents.
3003
2808
        """
3004
2809
        return frozenset(self._missing_compression_parents)
3005
2810
 
3006
 
    def get_missing_parents(self):
3007
 
        """Return the keys of missing parents."""
3008
 
        # If updating this, you should also update
3009
 
        # groupcompress._GCGraphIndex.get_missing_parents
3010
 
        # We may have false positives, so filter those out.
3011
 
        self._key_dependencies.satisfy_refs_for_keys(
3012
 
            self.get_parent_map(self._key_dependencies.get_unsatisfied_refs()))
3013
 
        return frozenset(self._key_dependencies.get_unsatisfied_refs())
3014
 
 
3015
2811
    def _check_read(self):
3016
2812
        """raise if reads are not permitted."""
3017
2813
        if not self._is_locked():
3125
2921
            options.append('no-eol')
3126
2922
        return options
3127
2923
 
3128
 
    def find_ancestry(self, keys):
3129
 
        """See CombinedGraphIndex.find_ancestry()"""
3130
 
        return self._graph_index.find_ancestry(keys, 0)
3131
 
 
3132
2924
    def get_parent_map(self, keys):
3133
2925
        """Get a map of the parents of keys.
3134
2926
 
3221
3013
            opaque index memo. For _KnitKeyAccess the memo is (key, pos,
3222
3014
            length), where the key is the record key.
3223
3015
        """
3224
 
        if type(raw_data) is not str:
 
3016
        if type(raw_data) != str:
3225
3017
            raise AssertionError(
3226
3018
                'data must be plain bytes was %s' % type(raw_data))
3227
3019
        result = []
3244
3036
            result.append((key, base, size))
3245
3037
        return result
3246
3038
 
3247
 
    def flush(self):
3248
 
        """Flush pending writes on this access object.
3249
 
        
3250
 
        For .knit files this is a no-op.
3251
 
        """
3252
 
        pass
3253
 
 
3254
3039
    def get_raw_records(self, memos_for_retrieval):
3255
3040
        """Get the raw bytes for a records.
3256
3041
 
3281
3066
class _DirectPackAccess(object):
3282
3067
    """Access to data in one or more packs with less translation."""
3283
3068
 
3284
 
    def __init__(self, index_to_packs, reload_func=None, flush_func=None):
 
3069
    def __init__(self, index_to_packs, reload_func=None):
3285
3070
        """Create a _DirectPackAccess object.
3286
3071
 
3287
3072
        :param index_to_packs: A dict mapping index objects to the transport
3294
3079
        self._write_index = None
3295
3080
        self._indices = index_to_packs
3296
3081
        self._reload_func = reload_func
3297
 
        self._flush_func = flush_func
3298
3082
 
3299
3083
    def add_raw_records(self, key_sizes, raw_data):
3300
3084
        """Add raw knit bytes to a storage area.
3310
3094
            length), where the index field is the write_index object supplied
3311
3095
            to the PackAccess object.
3312
3096
        """
3313
 
        if type(raw_data) is not str:
 
3097
        if type(raw_data) != str:
3314
3098
            raise AssertionError(
3315
3099
                'data must be plain bytes was %s' % type(raw_data))
3316
3100
        result = []
3322
3106
            result.append((self._write_index, p_offset, p_length))
3323
3107
        return result
3324
3108
 
3325
 
    def flush(self):
3326
 
        """Flush pending writes on this access object.
3327
 
 
3328
 
        This will flush any buffered writes to a NewPack.
3329
 
        """
3330
 
        if self._flush_func is not None:
3331
 
            self._flush_func()
3332
 
            
3333
3109
    def get_raw_records(self, memos_for_retrieval):
3334
3110
        """Get the raw bytes for a records.
3335
3111
 
3429
3205
    recommended.
3430
3206
    """
3431
3207
    annotator = _KnitAnnotator(knit)
3432
 
    return iter(annotator.annotate_flat(revision_id))
3433
 
 
3434
 
 
3435
 
class _KnitAnnotator(annotate.Annotator):
 
3208
    return iter(annotator.annotate(revision_id))
 
3209
 
 
3210
 
 
3211
class _KnitAnnotator(object):
3436
3212
    """Build up the annotations for a text."""
3437
3213
 
3438
 
    def __init__(self, vf):
3439
 
        annotate.Annotator.__init__(self, vf)
3440
 
 
3441
 
        # TODO: handle Nodes which cannot be extracted
3442
 
        # self._ghosts = set()
3443
 
 
3444
 
        # Map from (key, parent_key) => matching_blocks, should be 'use once'
3445
 
        self._matching_blocks = {}
3446
 
 
3447
 
        # KnitContent objects
3448
 
        self._content_objects = {}
3449
 
        # The number of children that depend on this fulltext content object
3450
 
        self._num_compression_children = {}
3451
 
        # Delta records that need their compression parent before they can be
3452
 
        # expanded
3453
 
        self._pending_deltas = {}
3454
 
        # Fulltext records that are waiting for their parents fulltexts before
3455
 
        # they can be yielded for annotation
3456
 
        self._pending_annotation = {}
 
3214
    def __init__(self, knit):
 
3215
        self._knit = knit
 
3216
 
 
3217
        # Content objects, differs from fulltexts because of how final newlines
 
3218
        # are treated by knits. the content objects here will always have a
 
3219
        # final newline
 
3220
        self._fulltext_contents = {}
 
3221
 
 
3222
        # Annotated lines of specific revisions
 
3223
        self._annotated_lines = {}
 
3224
 
 
3225
        # Track the raw data for nodes that we could not process yet.
 
3226
        # This maps the revision_id of the base to a list of children that will
 
3227
        # annotated from it.
 
3228
        self._pending_children = {}
 
3229
 
 
3230
        # Nodes which cannot be extracted
 
3231
        self._ghosts = set()
 
3232
 
 
3233
        # Track how many children this node has, so we know if we need to keep
 
3234
        # it
 
3235
        self._annotate_children = {}
 
3236
        self._compression_children = {}
3457
3237
 
3458
3238
        self._all_build_details = {}
 
3239
        # The children => parent revision_id graph
 
3240
        self._revision_id_graph = {}
 
3241
 
 
3242
        self._heads_provider = None
 
3243
 
 
3244
        self._nodes_to_keep_annotations = set()
 
3245
        self._generations_until_keep = 100
 
3246
 
 
3247
    def set_generations_until_keep(self, value):
 
3248
        """Set the number of generations before caching a node.
 
3249
 
 
3250
        Setting this to -1 will cache every merge node, setting this higher
 
3251
        will cache fewer nodes.
 
3252
        """
 
3253
        self._generations_until_keep = value
 
3254
 
 
3255
    def _add_fulltext_content(self, revision_id, content_obj):
 
3256
        self._fulltext_contents[revision_id] = content_obj
 
3257
        # TODO: jam 20080305 It might be good to check the sha1digest here
 
3258
        return content_obj.text()
 
3259
 
 
3260
    def _check_parents(self, child, nodes_to_annotate):
 
3261
        """Check if all parents have been processed.
 
3262
 
 
3263
        :param child: A tuple of (rev_id, parents, raw_content)
 
3264
        :param nodes_to_annotate: If child is ready, add it to
 
3265
            nodes_to_annotate, otherwise put it back in self._pending_children
 
3266
        """
 
3267
        for parent_id in child[1]:
 
3268
            if (parent_id not in self._annotated_lines):
 
3269
                # This parent is present, but another parent is missing
 
3270
                self._pending_children.setdefault(parent_id,
 
3271
                                                  []).append(child)
 
3272
                break
 
3273
        else:
 
3274
            # This one is ready to be processed
 
3275
            nodes_to_annotate.append(child)
 
3276
 
 
3277
    def _add_annotation(self, revision_id, fulltext, parent_ids,
 
3278
                        left_matching_blocks=None):
 
3279
        """Add an annotation entry.
 
3280
 
 
3281
        All parents should already have been annotated.
 
3282
        :return: A list of children that now have their parents satisfied.
 
3283
        """
 
3284
        a = self._annotated_lines
 
3285
        annotated_parent_lines = [a[p] for p in parent_ids]
 
3286
        annotated_lines = list(annotate.reannotate(annotated_parent_lines,
 
3287
            fulltext, revision_id, left_matching_blocks,
 
3288
            heads_provider=self._get_heads_provider()))
 
3289
        self._annotated_lines[revision_id] = annotated_lines
 
3290
        for p in parent_ids:
 
3291
            ann_children = self._annotate_children[p]
 
3292
            ann_children.remove(revision_id)
 
3293
            if (not ann_children
 
3294
                and p not in self._nodes_to_keep_annotations):
 
3295
                del self._annotated_lines[p]
 
3296
                del self._all_build_details[p]
 
3297
                if p in self._fulltext_contents:
 
3298
                    del self._fulltext_contents[p]
 
3299
        # Now that we've added this one, see if there are any pending
 
3300
        # deltas to be done, certainly this parent is finished
 
3301
        nodes_to_annotate = []
 
3302
        for child in self._pending_children.pop(revision_id, []):
 
3303
            self._check_parents(child, nodes_to_annotate)
 
3304
        return nodes_to_annotate
3459
3305
 
3460
3306
    def _get_build_graph(self, key):
3461
3307
        """Get the graphs for building texts and annotations.
3466
3312
        fulltext.)
3467
3313
 
3468
3314
        :return: A list of (key, index_memo) records, suitable for
3469
 
            passing to read_records_iter to start reading in the raw data from
 
3315
            passing to read_records_iter to start reading in the raw data fro/
3470
3316
            the pack file.
3471
3317
        """
 
3318
        if key in self._annotated_lines:
 
3319
            # Nothing to do
 
3320
            return []
3472
3321
        pending = set([key])
3473
3322
        records = []
3474
 
        ann_keys = set()
3475
 
        self._num_needed_children[key] = 1
 
3323
        generation = 0
 
3324
        kept_generation = 0
3476
3325
        while pending:
3477
3326
            # get all pending nodes
 
3327
            generation += 1
3478
3328
            this_iteration = pending
3479
 
            build_details = self._vf._index.get_build_details(this_iteration)
 
3329
            build_details = self._knit._index.get_build_details(this_iteration)
3480
3330
            self._all_build_details.update(build_details)
3481
 
            # new_nodes = self._vf._index._get_entries(this_iteration)
 
3331
            # new_nodes = self._knit._index._get_entries(this_iteration)
3482
3332
            pending = set()
3483
3333
            for key, details in build_details.iteritems():
3484
 
                (index_memo, compression_parent, parent_keys,
 
3334
                (index_memo, compression_parent, parents,
3485
3335
                 record_details) = details
3486
 
                self._parent_map[key] = parent_keys
3487
 
                self._heads_provider = None
 
3336
                self._revision_id_graph[key] = parents
3488
3337
                records.append((key, index_memo))
3489
3338
                # Do we actually need to check _annotated_lines?
3490
 
                pending.update([p for p in parent_keys
3491
 
                                   if p not in self._all_build_details])
3492
 
                if parent_keys:
3493
 
                    for parent_key in parent_keys:
3494
 
                        if parent_key in self._num_needed_children:
3495
 
                            self._num_needed_children[parent_key] += 1
3496
 
                        else:
3497
 
                            self._num_needed_children[parent_key] = 1
 
3339
                pending.update(p for p in parents
 
3340
                                 if p not in self._all_build_details)
3498
3341
                if compression_parent:
3499
 
                    if compression_parent in self._num_compression_children:
3500
 
                        self._num_compression_children[compression_parent] += 1
3501
 
                    else:
3502
 
                        self._num_compression_children[compression_parent] = 1
 
3342
                    self._compression_children.setdefault(compression_parent,
 
3343
                        []).append(key)
 
3344
                if parents:
 
3345
                    for parent in parents:
 
3346
                        self._annotate_children.setdefault(parent,
 
3347
                            []).append(key)
 
3348
                    num_gens = generation - kept_generation
 
3349
                    if ((num_gens >= self._generations_until_keep)
 
3350
                        and len(parents) > 1):
 
3351
                        kept_generation = generation
 
3352
                        self._nodes_to_keep_annotations.add(key)
3503
3353
 
3504
3354
            missing_versions = this_iteration.difference(build_details.keys())
3505
 
            if missing_versions:
3506
 
                for key in missing_versions:
3507
 
                    if key in self._parent_map and key in self._text_cache:
3508
 
                        # We already have this text ready, we just need to
3509
 
                        # yield it later so we get it annotated
3510
 
                        ann_keys.add(key)
3511
 
                        parent_keys = self._parent_map[key]
3512
 
                        for parent_key in parent_keys:
3513
 
                            if parent_key in self._num_needed_children:
3514
 
                                self._num_needed_children[parent_key] += 1
3515
 
                            else:
3516
 
                                self._num_needed_children[parent_key] = 1
3517
 
                        pending.update([p for p in parent_keys
3518
 
                                           if p not in self._all_build_details])
3519
 
                    else:
3520
 
                        raise errors.RevisionNotPresent(key, self._vf)
 
3355
            self._ghosts.update(missing_versions)
 
3356
            for missing_version in missing_versions:
 
3357
                # add a key, no parents
 
3358
                self._revision_id_graph[missing_version] = ()
 
3359
                pending.discard(missing_version) # don't look for it
 
3360
        if self._ghosts.intersection(self._compression_children):
 
3361
            raise KnitCorrupt(
 
3362
                "We cannot have nodes which have a ghost compression parent:\n"
 
3363
                "ghosts: %r\n"
 
3364
                "compression children: %r"
 
3365
                % (self._ghosts, self._compression_children))
 
3366
        # Cleanout anything that depends on a ghost so that we don't wait for
 
3367
        # the ghost to show up
 
3368
        for node in self._ghosts:
 
3369
            if node in self._annotate_children:
 
3370
                # We won't be building this node
 
3371
                del self._annotate_children[node]
3521
3372
        # Generally we will want to read the records in reverse order, because
3522
3373
        # we find the parent nodes after the children
3523
3374
        records.reverse()
3524
 
        return records, ann_keys
3525
 
 
3526
 
    def _get_needed_texts(self, key, pb=None):
3527
 
        # if True or len(self._vf._fallback_vfs) > 0:
3528
 
        if len(self._vf._fallback_vfs) > 0:
3529
 
            # If we have fallbacks, go to the generic path
3530
 
            for v in annotate.Annotator._get_needed_texts(self, key, pb=pb):
3531
 
                yield v
3532
 
            return
3533
 
        while True:
3534
 
            try:
3535
 
                records, ann_keys = self._get_build_graph(key)
3536
 
                for idx, (sub_key, text, num_lines) in enumerate(
3537
 
                                                self._extract_texts(records)):
3538
 
                    if pb is not None:
3539
 
                        pb.update('annotating', idx, len(records))
3540
 
                    yield sub_key, text, num_lines
3541
 
                for sub_key in ann_keys:
3542
 
                    text = self._text_cache[sub_key]
3543
 
                    num_lines = len(text) # bad assumption
3544
 
                    yield sub_key, text, num_lines
3545
 
                return
3546
 
            except errors.RetryWithNewPacks, e:
3547
 
                self._vf._access.reload_or_raise(e)
3548
 
                # The cached build_details are no longer valid
3549
 
                self._all_build_details.clear()
3550
 
 
3551
 
    def _cache_delta_blocks(self, key, compression_parent, delta, lines):
3552
 
        parent_lines = self._text_cache[compression_parent]
3553
 
        blocks = list(KnitContent.get_line_delta_blocks(delta, parent_lines, lines))
3554
 
        self._matching_blocks[(key, compression_parent)] = blocks
3555
 
 
3556
 
    def _expand_record(self, key, parent_keys, compression_parent, record,
3557
 
                       record_details):
3558
 
        delta = None
3559
 
        if compression_parent:
3560
 
            if compression_parent not in self._content_objects:
3561
 
                # Waiting for the parent
3562
 
                self._pending_deltas.setdefault(compression_parent, []).append(
3563
 
                    (key, parent_keys, record, record_details))
3564
 
                return None
3565
 
            # We have the basis parent, so expand the delta
3566
 
            num = self._num_compression_children[compression_parent]
3567
 
            num -= 1
3568
 
            if num == 0:
3569
 
                base_content = self._content_objects.pop(compression_parent)
3570
 
                self._num_compression_children.pop(compression_parent)
3571
 
            else:
3572
 
                self._num_compression_children[compression_parent] = num
3573
 
                base_content = self._content_objects[compression_parent]
3574
 
            # It is tempting to want to copy_base_content=False for the last
3575
 
            # child object. However, whenever noeol=False,
3576
 
            # self._text_cache[parent_key] is content._lines. So mutating it
3577
 
            # gives very bad results.
3578
 
            # The alternative is to copy the lines into text cache, but then we
3579
 
            # are copying anyway, so just do it here.
3580
 
            content, delta = self._vf._factory.parse_record(
3581
 
                key, record, record_details, base_content,
3582
 
                copy_base_content=True)
3583
 
        else:
3584
 
            # Fulltext record
3585
 
            content, _ = self._vf._factory.parse_record(
3586
 
                key, record, record_details, None)
3587
 
        if self._num_compression_children.get(key, 0) > 0:
3588
 
            self._content_objects[key] = content
3589
 
        lines = content.text()
3590
 
        self._text_cache[key] = lines
3591
 
        if delta is not None:
3592
 
            self._cache_delta_blocks(key, compression_parent, delta, lines)
3593
 
        return lines
3594
 
 
3595
 
    def _get_parent_annotations_and_matches(self, key, text, parent_key):
3596
 
        """Get the list of annotations for the parent, and the matching lines.
3597
 
 
3598
 
        :param text: The opaque value given by _get_needed_texts
3599
 
        :param parent_key: The key for the parent text
3600
 
        :return: (parent_annotations, matching_blocks)
3601
 
            parent_annotations is a list as long as the number of lines in
3602
 
                parent
3603
 
            matching_blocks is a list of (parent_idx, text_idx, len) tuples
3604
 
                indicating which lines match between the two texts
3605
 
        """
3606
 
        block_key = (key, parent_key)
3607
 
        if block_key in self._matching_blocks:
3608
 
            blocks = self._matching_blocks.pop(block_key)
3609
 
            parent_annotations = self._annotations_cache[parent_key]
3610
 
            return parent_annotations, blocks
3611
 
        return annotate.Annotator._get_parent_annotations_and_matches(self,
3612
 
            key, text, parent_key)
3613
 
 
3614
 
    def _process_pending(self, key):
3615
 
        """The content for 'key' was just processed.
3616
 
 
3617
 
        Determine if there is any more pending work to be processed.
3618
 
        """
3619
 
        to_return = []
3620
 
        if key in self._pending_deltas:
3621
 
            compression_parent = key
3622
 
            children = self._pending_deltas.pop(key)
3623
 
            for child_key, parent_keys, record, record_details in children:
3624
 
                lines = self._expand_record(child_key, parent_keys,
3625
 
                                            compression_parent,
3626
 
                                            record, record_details)
3627
 
                if self._check_ready_for_annotations(child_key, parent_keys):
3628
 
                    to_return.append(child_key)
3629
 
        # Also check any children that are waiting for this parent to be
3630
 
        # annotation ready
3631
 
        if key in self._pending_annotation:
3632
 
            children = self._pending_annotation.pop(key)
3633
 
            to_return.extend([c for c, p_keys in children
3634
 
                              if self._check_ready_for_annotations(c, p_keys)])
3635
 
        return to_return
3636
 
 
3637
 
    def _check_ready_for_annotations(self, key, parent_keys):
3638
 
        """return true if this text is ready to be yielded.
3639
 
 
3640
 
        Otherwise, this will return False, and queue the text into
3641
 
        self._pending_annotation
3642
 
        """
3643
 
        for parent_key in parent_keys:
3644
 
            if parent_key not in self._annotations_cache:
3645
 
                # still waiting on at least one parent text, so queue it up
3646
 
                # Note that if there are multiple parents, we need to wait
3647
 
                # for all of them.
3648
 
                self._pending_annotation.setdefault(parent_key,
3649
 
                    []).append((key, parent_keys))
3650
 
                return False
3651
 
        return True
3652
 
 
3653
 
    def _extract_texts(self, records):
3654
 
        """Extract the various texts needed based on records"""
 
3375
        return records
 
3376
 
 
3377
    def _annotate_records(self, records):
 
3378
        """Build the annotations for the listed records."""
3655
3379
        # We iterate in the order read, rather than a strict order requested
3656
3380
        # However, process what we can, and put off to the side things that
3657
3381
        # still need parents, cleaning them up when those parents are
3658
3382
        # processed.
3659
 
        # Basic data flow:
3660
 
        #   1) As 'records' are read, see if we can expand these records into
3661
 
        #      Content objects (and thus lines)
3662
 
        #   2) If a given line-delta is waiting on its compression parent, it
3663
 
        #      gets queued up into self._pending_deltas, otherwise we expand
3664
 
        #      it, and put it into self._text_cache and self._content_objects
3665
 
        #   3) If we expanded the text, we will then check to see if all
3666
 
        #      parents have also been processed. If so, this text gets yielded,
3667
 
        #      else this record gets set aside into pending_annotation
3668
 
        #   4) Further, if we expanded the text in (2), we will then check to
3669
 
        #      see if there are any children in self._pending_deltas waiting to
3670
 
        #      also be processed. If so, we go back to (2) for those
3671
 
        #   5) Further again, if we yielded the text, we can then check if that
3672
 
        #      'unlocks' any of the texts in pending_annotations, which should
3673
 
        #      then get yielded as well
3674
 
        # Note that both steps 4 and 5 are 'recursive' in that unlocking one
3675
 
        # compression child could unlock yet another, and yielding a fulltext
3676
 
        # will also 'unlock' the children that are waiting on that annotation.
3677
 
        # (Though also, unlocking 1 parent's fulltext, does not unlock a child
3678
 
        # if other parents are also waiting.)
3679
 
        # We want to yield content before expanding child content objects, so
3680
 
        # that we know when we can re-use the content lines, and the annotation
3681
 
        # code can know when it can stop caching fulltexts, as well.
3682
 
 
3683
 
        # Children that are missing their compression parent
3684
 
        pending_deltas = {}
3685
 
        for (key, record, digest) in self._vf._read_records_iter(records):
3686
 
            # ghosts?
3687
 
            details = self._all_build_details[key]
3688
 
            (_, compression_parent, parent_keys, record_details) = details
3689
 
            lines = self._expand_record(key, parent_keys, compression_parent,
3690
 
                                        record, record_details)
3691
 
            if lines is None:
3692
 
                # Pending delta should be queued up
 
3383
        for (rev_id, record,
 
3384
             digest) in self._knit._read_records_iter(records):
 
3385
            if rev_id in self._annotated_lines:
3693
3386
                continue
3694
 
            # At this point, we may be able to yield this content, if all
3695
 
            # parents are also finished
3696
 
            yield_this_text = self._check_ready_for_annotations(key,
3697
 
                                                                parent_keys)
3698
 
            if yield_this_text:
3699
 
                # All parents present
3700
 
                yield key, lines, len(lines)
3701
 
            to_process = self._process_pending(key)
3702
 
            while to_process:
3703
 
                this_process = to_process
3704
 
                to_process = []
3705
 
                for key in this_process:
3706
 
                    lines = self._text_cache[key]
3707
 
                    yield key, lines, len(lines)
3708
 
                    to_process.extend(self._process_pending(key))
 
3387
            parent_ids = self._revision_id_graph[rev_id]
 
3388
            parent_ids = [p for p in parent_ids if p not in self._ghosts]
 
3389
            details = self._all_build_details[rev_id]
 
3390
            (index_memo, compression_parent, parents,
 
3391
             record_details) = details
 
3392
            nodes_to_annotate = []
 
3393
            # TODO: Remove the punning between compression parents, and
 
3394
            #       parent_ids, we should be able to do this without assuming
 
3395
            #       the build order
 
3396
            if len(parent_ids) == 0:
 
3397
                # There are no parents for this node, so just add it
 
3398
                # TODO: This probably needs to be decoupled
 
3399
                fulltext_content, delta = self._knit._factory.parse_record(
 
3400
                    rev_id, record, record_details, None)
 
3401
                fulltext = self._add_fulltext_content(rev_id, fulltext_content)
 
3402
                nodes_to_annotate.extend(self._add_annotation(rev_id, fulltext,
 
3403
                    parent_ids, left_matching_blocks=None))
 
3404
            else:
 
3405
                child = (rev_id, parent_ids, record)
 
3406
                # Check if all the parents are present
 
3407
                self._check_parents(child, nodes_to_annotate)
 
3408
            while nodes_to_annotate:
 
3409
                # Should we use a queue here instead of a stack?
 
3410
                (rev_id, parent_ids, record) = nodes_to_annotate.pop()
 
3411
                (index_memo, compression_parent, parents,
 
3412
                 record_details) = self._all_build_details[rev_id]
 
3413
                blocks = None
 
3414
                if compression_parent is not None:
 
3415
                    comp_children = self._compression_children[compression_parent]
 
3416
                    if rev_id not in comp_children:
 
3417
                        raise AssertionError("%r not in compression children %r"
 
3418
                            % (rev_id, comp_children))
 
3419
                    # If there is only 1 child, it is safe to reuse this
 
3420
                    # content
 
3421
                    reuse_content = (len(comp_children) == 1
 
3422
                        and compression_parent not in
 
3423
                            self._nodes_to_keep_annotations)
 
3424
                    if reuse_content:
 
3425
                        # Remove it from the cache since it will be changing
 
3426
                        parent_fulltext_content = self._fulltext_contents.pop(compression_parent)
 
3427
                        # Make sure to copy the fulltext since it might be
 
3428
                        # modified
 
3429
                        parent_fulltext = list(parent_fulltext_content.text())
 
3430
                    else:
 
3431
                        parent_fulltext_content = self._fulltext_contents[compression_parent]
 
3432
                        parent_fulltext = parent_fulltext_content.text()
 
3433
                    comp_children.remove(rev_id)
 
3434
                    fulltext_content, delta = self._knit._factory.parse_record(
 
3435
                        rev_id, record, record_details,
 
3436
                        parent_fulltext_content,
 
3437
                        copy_base_content=(not reuse_content))
 
3438
                    fulltext = self._add_fulltext_content(rev_id,
 
3439
                                                          fulltext_content)
 
3440
                    if compression_parent == parent_ids[0]:
 
3441
                        # the compression_parent is the left parent, so we can
 
3442
                        # re-use the delta
 
3443
                        blocks = KnitContent.get_line_delta_blocks(delta,
 
3444
                                parent_fulltext, fulltext)
 
3445
                else:
 
3446
                    fulltext_content = self._knit._factory.parse_fulltext(
 
3447
                        record, rev_id)
 
3448
                    fulltext = self._add_fulltext_content(rev_id,
 
3449
                        fulltext_content)
 
3450
                nodes_to_annotate.extend(
 
3451
                    self._add_annotation(rev_id, fulltext, parent_ids,
 
3452
                                     left_matching_blocks=blocks))
 
3453
 
 
3454
    def _get_heads_provider(self):
 
3455
        """Create a heads provider for resolving ancestry issues."""
 
3456
        if self._heads_provider is not None:
 
3457
            return self._heads_provider
 
3458
        parent_provider = _mod_graph.DictParentsProvider(
 
3459
            self._revision_id_graph)
 
3460
        graph_obj = _mod_graph.Graph(parent_provider)
 
3461
        head_cache = _mod_graph.FrozenHeadsCache(graph_obj)
 
3462
        self._heads_provider = head_cache
 
3463
        return head_cache
 
3464
 
 
3465
    def annotate(self, key):
 
3466
        """Return the annotated fulltext at the given key.
 
3467
 
 
3468
        :param key: The key to annotate.
 
3469
        """
 
3470
        if len(self._knit._fallback_vfs) > 0:
 
3471
            # stacked knits can't use the fast path at present.
 
3472
            return self._simple_annotate(key)
 
3473
        while True:
 
3474
            try:
 
3475
                records = self._get_build_graph(key)
 
3476
                if key in self._ghosts:
 
3477
                    raise errors.RevisionNotPresent(key, self._knit)
 
3478
                self._annotate_records(records)
 
3479
                return self._annotated_lines[key]
 
3480
            except errors.RetryWithNewPacks, e:
 
3481
                self._knit._access.reload_or_raise(e)
 
3482
                # The cached build_details are no longer valid
 
3483
                self._all_build_details.clear()
 
3484
 
 
3485
    def _simple_annotate(self, key):
 
3486
        """Return annotated fulltext, rediffing from the full texts.
 
3487
 
 
3488
        This is slow but makes no assumptions about the repository
 
3489
        being able to produce line deltas.
 
3490
        """
 
3491
        # TODO: this code generates a parent maps of present ancestors; it
 
3492
        # could be split out into a separate method, and probably should use
 
3493
        # iter_ancestry instead. -- mbp and robertc 20080704
 
3494
        graph = _mod_graph.Graph(self._knit)
 
3495
        head_cache = _mod_graph.FrozenHeadsCache(graph)
 
3496
        search = graph._make_breadth_first_searcher([key])
 
3497
        keys = set()
 
3498
        while True:
 
3499
            try:
 
3500
                present, ghosts = search.next_with_ghosts()
 
3501
            except StopIteration:
 
3502
                break
 
3503
            keys.update(present)
 
3504
        parent_map = self._knit.get_parent_map(keys)
 
3505
        parent_cache = {}
 
3506
        reannotate = annotate.reannotate
 
3507
        for record in self._knit.get_record_stream(keys, 'topological', True):
 
3508
            key = record.key
 
3509
            fulltext = osutils.chunks_to_lines(record.get_bytes_as('chunked'))
 
3510
            parents = parent_map[key]
 
3511
            if parents is not None:
 
3512
                parent_lines = [parent_cache[parent] for parent in parent_map[key]]
 
3513
            else:
 
3514
                parent_lines = []
 
3515
            parent_cache[key] = list(
 
3516
                reannotate(parent_lines, fulltext, key, None, head_cache))
 
3517
        try:
 
3518
            return parent_cache[key]
 
3519
        except KeyError, e:
 
3520
            raise errors.RevisionNotPresent(key, self._knit)
 
3521
 
3709
3522
 
3710
3523
try:
3711
 
    from bzrlib._knit_load_data_pyx import _load_data_c as _load_data
3712
 
except ImportError, e:
3713
 
    osutils.failed_to_load_extension(e)
 
3524
    from bzrlib._knit_load_data_c import _load_data_c as _load_data
 
3525
except ImportError:
3714
3526
    from bzrlib._knit_load_data_py import _load_data_py as _load_data