← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin
  • Date: 2010-05-16 15:18:43 UTC
  • mfrom: (5235 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5239.
  • Revision ID: gzlist@googlemail.com-20100516151843-lu53u7caehm3ie3i
Merge bzr.dev to resolve conflicts in NEWS and _chk_map_pyx

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inventory.py
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
from copy import deepcopy
31
 
 
32
30
from bzrlib.lazy_import import lazy_import
33
31
lazy_import(globals(), """
34
32
import collections
 
33
import copy
35
34
import os
36
35
import re
37
36
import tarfile
43
42
    generate_ids,
44
43
    osutils,
45
44
    symbol_versioning,
46
 
    workingtree,
47
45
    )
48
46
""")
49
47
 
53
51
    )
54
52
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
55
53
from bzrlib.trace import mutter
 
54
from bzrlib.static_tuple import StaticTuple
56
55
 
57
56
 
58
57
class InventoryEntry(object):
262
261
    def versionable_kind(kind):
263
262
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
264
263
 
265
 
    def check(self, checker, rev_id, inv, tree):
 
264
    def check(self, checker, rev_id, inv):
266
265
        """Check this inventory entry is intact.
267
266
 
268
267
        This is a template method, override _check for kind specific
274
273
        :param rev_id: Revision id from which this InventoryEntry was loaded.
275
274
             Not necessarily the last-changed revision for this file.
276
275
        :param inv: Inventory from which the entry was loaded.
277
 
        :param tree: RevisionTree for this entry.
278
276
        """
279
277
        if self.parent_id is not None:
280
278
            if not inv.has_id(self.parent_id):
281
279
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
282
280
                        % (self.parent_id, rev_id))
283
 
        self._check(checker, rev_id, tree)
 
281
        checker._add_entry_to_text_key_references(inv, self)
 
282
        self._check(checker, rev_id)
284
283
 
285
 
    def _check(self, checker, rev_id, tree):
 
284
    def _check(self, checker, rev_id):
286
285
        """Check this inventory entry for kind specific errors."""
287
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' %
288
 
                            (self.kind, rev_id))
 
286
        checker._report_items.append(
 
287
            'unknown entry kind %r in revision {%s}' % (self.kind, rev_id))
289
288
 
290
289
    def copy(self):
291
290
        """Clone this inventory entry."""
404
403
                 'text_id', 'parent_id', 'children', 'executable',
405
404
                 'revision', 'symlink_target', 'reference_revision']
406
405
 
407
 
    def _check(self, checker, rev_id, tree):
 
406
    def _check(self, checker, rev_id):
408
407
        """See InventoryEntry._check"""
409
408
 
410
409
    def __init__(self, file_id):
433
432
                 'text_id', 'parent_id', 'children', 'executable',
434
433
                 'revision', 'symlink_target', 'reference_revision']
435
434
 
436
 
    def _check(self, checker, rev_id, tree):
 
435
    def _check(self, checker, rev_id):
437
436
        """See InventoryEntry._check"""
438
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
439
 
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
437
        if (self.text_sha1 is not None or self.text_size is not None or
 
438
            self.text_id is not None):
 
439
            checker._report_items.append('directory {%s} has text in revision {%s}'
440
440
                                % (self.file_id, rev_id))
 
441
        # In non rich root repositories we do not expect a file graph for the
 
442
        # root.
 
443
        if self.name == '' and not checker.rich_roots:
 
444
            return
 
445
        # Directories are stored as an empty file, but the file should exist
 
446
        # to provide a per-fileid log. The hash of every directory content is
 
447
        # "da..." below (the sha1sum of '').
 
448
        checker.add_pending_item(rev_id,
 
449
            ('texts', self.file_id, self.revision), 'text',
 
450
             'da39a3ee5e6b4b0d3255bfef95601890afd80709')
441
451
 
442
452
    def copy(self):
443
453
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
476
486
                 'text_id', 'parent_id', 'children', 'executable',
477
487
                 'revision', 'symlink_target', 'reference_revision']
478
488
 
479
 
    def _check(self, checker, tree_revision_id, tree):
 
489
    def _check(self, checker, tree_revision_id):
480
490
        """See InventoryEntry._check"""
481
 
        key = (self.file_id, self.revision)
482
 
        if key in checker.checked_texts:
483
 
            prev_sha = checker.checked_texts[key]
484
 
            if prev_sha != self.text_sha1:
485
 
                raise BzrCheckError(
486
 
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
487
 
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
488
 
                     t))
489
 
            else:
490
 
                checker.repeated_text_cnt += 1
491
 
                return
492
 
 
493
 
        checker.checked_text_cnt += 1
494
 
        # We can't check the length, because Weave doesn't store that
495
 
        # information, and the whole point of looking at the weave's
496
 
        # sha1sum is that we don't have to extract the text.
497
 
        if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
498
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
499
 
        checker.checked_texts[key] = self.text_sha1
 
491
        # TODO: check size too.
 
492
        checker.add_pending_item(tree_revision_id,
 
493
            ('texts', self.file_id, self.revision), 'text',
 
494
             self.text_sha1)
 
495
        if self.text_size is None:
 
496
            checker._report_items.append(
 
497
                'fileid {%s} in {%s} has None for text_size' % (self.file_id,
 
498
                tree_revision_id))
500
499
 
501
500
    def copy(self):
502
501
        other = InventoryFile(self.file_id, self.name, self.parent_id)
600
599
                 'text_id', 'parent_id', 'children', 'executable',
601
600
                 'revision', 'symlink_target', 'reference_revision']
602
601
 
603
 
    def _check(self, checker, rev_id, tree):
 
602
    def _check(self, checker, tree_revision_id):
604
603
        """See InventoryEntry._check"""
605
604
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
606
 
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
607
 
                    % (self.file_id, rev_id))
 
605
            checker._report_items.append(
 
606
               'symlink {%s} has text in revision {%s}'
 
607
                    % (self.file_id, tree_revision_id))
608
608
        if self.symlink_target is None:
609
 
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
610
 
                    % (self.file_id, rev_id))
 
609
            checker._report_items.append(
 
610
                'symlink {%s} has no target in revision {%s}'
 
611
                    % (self.file_id, tree_revision_id))
 
612
        # Symlinks are stored as ''
 
613
        checker.add_pending_item(tree_revision_id,
 
614
            ('texts', self.file_id, self.revision), 'text',
 
615
             'da39a3ee5e6b4b0d3255bfef95601890afd80709')
611
616
 
612
617
    def copy(self):
613
618
        other = InventoryLink(self.file_id, self.name, self.parent_id)
714
719
 
715
720
 
716
721
class CommonInventory(object):
717
 
    """Basic inventory logic, defined in terms of primitives like has_id."""
 
722
    """Basic inventory logic, defined in terms of primitives like has_id.
 
723
 
 
724
    An inventory is the metadata about the contents of a tree.
 
725
 
 
726
    This is broadly a map from file_id to entries such as directories, files,
 
727
    symlinks and tree references. Each entry maintains its own metadata like
 
728
    SHA1 and length for files, or children for a directory.
 
729
 
 
730
    Entries can be looked up either by path or by file_id.
 
731
 
 
732
    InventoryEntry objects must not be modified after they are
 
733
    inserted, other than through the Inventory API.
 
734
    """
718
735
 
719
736
    def __contains__(self, file_id):
720
737
        """True if this entry contains a file with given id.
733
750
        """
734
751
        return self.has_id(file_id)
735
752
 
 
753
    def has_filename(self, filename):
 
754
        return bool(self.path2id(filename))
 
755
 
736
756
    def id2path(self, file_id):
737
757
        """Return as a string the path to file_id.
738
758
 
741
761
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
742
762
        >>> print i.id2path('foo-id')
743
763
        src/foo.c
 
764
 
 
765
        :raises NoSuchId: If file_id is not present in the inventory.
744
766
        """
745
767
        # get all names, skipping root
746
768
        return '/'.join(reversed(
747
769
            [parent.name for parent in
748
770
             self._iter_file_id_parents(file_id)][:-1]))
749
771
 
750
 
    def iter_entries(self, from_dir=None):
751
 
        """Return (path, entry) pairs, in order by name."""
 
772
    def iter_entries(self, from_dir=None, recursive=True):
 
773
        """Return (path, entry) pairs, in order by name.
 
774
        
 
775
        :param from_dir: if None, start from the root,
 
776
          otherwise start from this directory (either file-id or entry)
 
777
        :param recursive: recurse into directories or not
 
778
        """
752
779
        if from_dir is None:
753
780
            if self.root is None:
754
781
                return
761
788
        # 440ms/663ms (inline/total) to 116ms/116ms
762
789
        children = from_dir.children.items()
763
790
        children.sort()
 
791
        if not recursive:
 
792
            for name, ie in children:
 
793
                yield name, ie
 
794
            return
764
795
        children = collections.deque(children)
765
796
        stack = [(u'', children)]
766
797
        while stack:
928
959
        descend(self.root, u'')
929
960
        return accum
930
961
 
931
 
    def path2id(self, name):
 
962
    def path2id(self, relpath):
932
963
        """Walk down through directories to return entry of last component.
933
964
 
934
 
        names may be either a list of path components, or a single
935
 
        string, in which case it is automatically split.
 
965
        :param relpath: may be either a list of path components, or a single
 
966
            string, in which case it is automatically split.
936
967
 
937
968
        This returns the entry of the last component in the path,
938
969
        which may be either a file or a directory.
939
970
 
940
971
        Returns None IFF the path is not found.
941
972
        """
942
 
        if isinstance(name, basestring):
943
 
            name = osutils.splitpath(name)
944
 
 
945
 
        # mutter("lookup path %r" % name)
 
973
        if isinstance(relpath, basestring):
 
974
            names = osutils.splitpath(relpath)
 
975
        else:
 
976
            names = relpath
946
977
 
947
978
        try:
948
979
            parent = self.root
951
982
            return None
952
983
        if parent is None:
953
984
            return None
954
 
        for f in name:
 
985
        for f in names:
955
986
            try:
956
987
                children = getattr(parent, 'children', None)
957
988
                if children is None:
1012
1043
 
1013
1044
 
1014
1045
class Inventory(CommonInventory):
1015
 
    """Inventory of versioned files in a tree.
1016
 
 
1017
 
    This describes which file_id is present at each point in the tree,
1018
 
    and possibly the SHA-1 or other information about the file.
1019
 
    Entries can be looked up either by path or by file_id.
1020
 
 
1021
 
    The inventory represents a typical unix file tree, with
1022
 
    directories containing files and subdirectories.  We never store
1023
 
    the full path to a file, because renaming a directory implicitly
1024
 
    moves all of its contents.  This class internally maintains a
 
1046
    """Mutable dict based in-memory inventory.
 
1047
 
 
1048
    We never store the full path to a file, because renaming a directory
 
1049
    implicitly moves all of its contents.  This class internally maintains a
1025
1050
    lookup tree that allows the children under a directory to be
1026
1051
    returned quickly.
1027
1052
 
1028
 
    InventoryEntry objects must not be modified after they are
1029
 
    inserted, other than through the Inventory API.
1030
 
 
1031
1053
    >>> inv = Inventory()
1032
1054
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1033
1055
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1034
1056
    >>> inv['123-123'].name
1035
1057
    'hello.c'
1036
1058
 
1037
 
    May be treated as an iterator or set to look up file ids:
 
1059
    Id's may be looked up from paths:
1038
1060
 
1039
 
    >>> bool(inv.path2id('hello.c'))
1040
 
    True
 
1061
    >>> inv.path2id('hello.c')
 
1062
    '123-123'
1041
1063
    >>> '123-123' in inv
1042
1064
    True
1043
1065
 
1044
 
    May also look up by name:
 
1066
    There are iterators over the contents:
1045
1067
 
1046
 
    >>> [x[0] for x in inv.iter_entries()]
 
1068
    >>> [entry[0] for entry in inv.iter_entries()]
1047
1069
    ['', u'hello.c']
1048
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
1049
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1050
 
    Traceback (most recent call last):
1051
 
    BzrError: parent_id {TREE_ROOT} not in inventory
1052
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
1053
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None, revision=None)
1054
1070
    """
 
1071
 
1055
1072
    def __init__(self, root_id=ROOT_ID, revision_id=None):
1056
1073
        """Create or read an inventory.
1057
1074
 
1081
1098
    def apply_delta(self, delta):
1082
1099
        """Apply a delta to this inventory.
1083
1100
 
 
1101
        See the inventory developers documentation for the theory behind
 
1102
        inventory deltas.
 
1103
 
 
1104
        If delta application fails the inventory is left in an indeterminate
 
1105
        state and must not be used.
 
1106
 
1084
1107
        :param delta: A list of changes to apply. After all the changes are
1085
1108
            applied the final inventory must be internally consistent, but it
1086
1109
            is ok to supply changes which, if only half-applied would have an
1117
1140
        """
1118
1141
        # Check that the delta is legal. It would be nice if this could be
1119
1142
        # done within the loops below but it's safer to validate the delta
1120
 
        # before starting to mutate the inventory.
1121
 
        unique_file_ids = set([f for _, _, f, _ in delta])
1122
 
        if len(unique_file_ids) != len(delta):
1123
 
            raise AssertionError("a file-id appears multiple times in %r"
1124
 
                    % (delta,))
1125
 
        del unique_file_ids
 
1143
        # before starting to mutate the inventory, as there isn't a rollback
 
1144
        # facility.
 
1145
        list(_check_delta_unique_ids(_check_delta_unique_new_paths(
 
1146
            _check_delta_unique_old_paths(_check_delta_ids_match_entry(
 
1147
            _check_delta_ids_are_valid(
 
1148
            _check_delta_new_path_entry_both_or_None(
 
1149
            delta)))))))
1126
1150
 
1127
1151
        children = {}
1128
1152
        # Remove all affected items which were in the original inventory,
1131
1155
        # modified children remaining by the time we examine it.
1132
1156
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1133
1157
                                        if op is not None), reverse=True):
1134
 
            if file_id not in self:
1135
 
                # adds come later
1136
 
                continue
1137
1158
            # Preserve unaltered children of file_id for later reinsertion.
1138
1159
            file_id_children = getattr(self[file_id], 'children', {})
1139
1160
            if len(file_id_children):
1140
1161
                children[file_id] = file_id_children
 
1162
            if self.id2path(file_id) != old_path:
 
1163
                raise errors.InconsistentDelta(old_path, file_id,
 
1164
                    "Entry was at wrong other path %r." % self.id2path(file_id))
1141
1165
            # Remove file_id and the unaltered children. If file_id is not
1142
1166
            # being deleted it will be reinserted back later.
1143
1167
            self.remove_recursive_id(file_id)
1146
1170
        # longest, ensuring that items which were modified and whose parents in
1147
1171
        # the resulting inventory were also modified, are inserted after their
1148
1172
        # parents.
1149
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
 
1173
        for new_path, f, new_entry in sorted((np, f, e) for op, np, f, e in
1150
1174
                                          delta if np is not None):
1151
1175
            if new_entry.kind == 'directory':
1152
1176
                # Pop the child which to allow detection of children whose
1157
1181
                replacement.revision = new_entry.revision
1158
1182
                replacement.children = children.pop(replacement.file_id, {})
1159
1183
                new_entry = replacement
1160
 
            self.add(new_entry)
 
1184
            try:
 
1185
                self.add(new_entry)
 
1186
            except errors.DuplicateFileId:
 
1187
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1188
                    "New id is already present in target.")
 
1189
            except AttributeError:
 
1190
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1191
                    "Parent is not a directory.")
 
1192
            if self.id2path(new_entry.file_id) != new_path:
 
1193
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1194
                    "New path is not consistent with parent path.")
1161
1195
        if len(children):
1162
1196
            # Get the parent id that was deleted
1163
1197
            parent_id, children = children.popitem()
1164
1198
            raise errors.InconsistentDelta("<deleted>", parent_id,
1165
1199
                "The file id was deleted but its children were not deleted.")
1166
1200
 
 
1201
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
 
1202
                              propagate_caches=False):
 
1203
        """See CHKInventory.create_by_apply_delta()"""
 
1204
        new_inv = self.copy()
 
1205
        new_inv.apply_delta(inventory_delta)
 
1206
        new_inv.revision_id = new_revision_id
 
1207
        return new_inv
 
1208
 
1167
1209
    def _set_root(self, ie):
1168
1210
        self.root = ie
1169
1211
        self._byid = {self.root.file_id: self.root}
1183
1225
 
1184
1226
    def _get_mutable_inventory(self):
1185
1227
        """See CommonInventory._get_mutable_inventory."""
1186
 
        return deepcopy(self)
 
1228
        return copy.deepcopy(self)
1187
1229
 
1188
1230
    def __iter__(self):
1189
1231
        """Iterate over all file-ids."""
1243
1285
        To add  a file to a branch ready to be committed, use Branch.add,
1244
1286
        which calls this.
1245
1287
 
1246
 
        Returns the new entry object.
 
1288
        :return: entry
1247
1289
        """
1248
1290
        if entry.file_id in self._byid:
1249
1291
            raise errors.DuplicateFileId(entry.file_id,
1250
1292
                                         self._byid[entry.file_id])
1251
 
 
1252
1293
        if entry.parent_id is None:
1253
1294
            self.root = entry
1254
1295
        else:
1255
1296
            try:
1256
1297
                parent = self._byid[entry.parent_id]
1257
1298
            except KeyError:
1258
 
                raise BzrError("parent_id {%s} not in inventory" %
1259
 
                               entry.parent_id)
1260
 
 
 
1299
                raise errors.InconsistentDelta("<unknown>", entry.parent_id,
 
1300
                    "Parent not in inventory.")
1261
1301
            if entry.name in parent.children:
1262
 
                raise BzrError("%s is already versioned" %
1263
 
                        osutils.pathjoin(self.id2path(parent.file_id),
1264
 
                        entry.name).encode('utf-8'))
 
1302
                raise errors.InconsistentDelta(
 
1303
                    self.id2path(parent.children[entry.name].file_id),
 
1304
                    entry.file_id,
 
1305
                    "Path already versioned")
1265
1306
            parent.children[entry.name] = entry
1266
1307
        return self._add_child(entry)
1267
1308
 
1342
1383
            yield ie
1343
1384
            file_id = ie.parent_id
1344
1385
 
1345
 
    def has_filename(self, names):
1346
 
        return bool(self.path2id(names))
1347
 
 
1348
1386
    def has_id(self, file_id):
1349
1387
        return (file_id in self._byid)
1350
1388
 
1460
1498
        self._fileid_to_entry_cache = {}
1461
1499
        self._path_to_fileid_cache = {}
1462
1500
        self._search_key_name = search_key_name
 
1501
        self.root_id = None
 
1502
 
 
1503
    def __eq__(self, other):
 
1504
        """Compare two sets by comparing their contents."""
 
1505
        if not isinstance(other, CHKInventory):
 
1506
            return NotImplemented
 
1507
 
 
1508
        this_key = self.id_to_entry.key()
 
1509
        other_key = other.id_to_entry.key()
 
1510
        this_pid_key = self.parent_id_basename_to_file_id.key()
 
1511
        other_pid_key = other.parent_id_basename_to_file_id.key()
 
1512
        if None in (this_key, this_pid_key, other_key, other_pid_key):
 
1513
            return False
 
1514
        return this_key == other_key and this_pid_key == other_pid_key
1463
1515
 
1464
1516
    def _entry_to_bytes(self, entry):
1465
1517
        """Serialise entry as a single bytestring.
1503
1555
        else:
1504
1556
            raise ValueError("unknown kind %r" % entry.kind)
1505
1557
 
 
1558
    def _expand_fileids_to_parents_and_children(self, file_ids):
 
1559
        """Give a more wholistic view starting with the given file_ids.
 
1560
 
 
1561
        For any file_id which maps to a directory, we will include all children
 
1562
        of that directory. We will also include all directories which are
 
1563
        parents of the given file_ids, but we will not include their children.
 
1564
 
 
1565
        eg:
 
1566
          /     # TREE_ROOT
 
1567
          foo/  # foo-id
 
1568
            baz # baz-id
 
1569
            frob/ # frob-id
 
1570
              fringle # fringle-id
 
1571
          bar/  # bar-id
 
1572
            bing # bing-id
 
1573
 
 
1574
        if given [foo-id] we will include
 
1575
            TREE_ROOT as interesting parents
 
1576
        and 
 
1577
            foo-id, baz-id, frob-id, fringle-id
 
1578
        As interesting ids.
 
1579
        """
 
1580
        interesting = set()
 
1581
        # TODO: Pre-pass over the list of fileids to see if anything is already
 
1582
        #       deserialized in self._fileid_to_entry_cache
 
1583
 
 
1584
        directories_to_expand = set()
 
1585
        children_of_parent_id = {}
 
1586
        # It is okay if some of the fileids are missing
 
1587
        for entry in self._getitems(file_ids):
 
1588
            if entry.kind == 'directory':
 
1589
                directories_to_expand.add(entry.file_id)
 
1590
            interesting.add(entry.parent_id)
 
1591
            children_of_parent_id.setdefault(entry.parent_id, []
 
1592
                                             ).append(entry.file_id)
 
1593
 
 
1594
        # Now, interesting has all of the direct parents, but not the
 
1595
        # parents of those parents. It also may have some duplicates with
 
1596
        # specific_fileids
 
1597
        remaining_parents = interesting.difference(file_ids)
 
1598
        # When we hit the TREE_ROOT, we'll get an interesting parent of None,
 
1599
        # but we don't actually want to recurse into that
 
1600
        interesting.add(None) # this will auto-filter it in the loop
 
1601
        remaining_parents.discard(None) 
 
1602
        while remaining_parents:
 
1603
            next_parents = set()
 
1604
            for entry in self._getitems(remaining_parents):
 
1605
                next_parents.add(entry.parent_id)
 
1606
                children_of_parent_id.setdefault(entry.parent_id, []
 
1607
                                                 ).append(entry.file_id)
 
1608
            # Remove any search tips we've already processed
 
1609
            remaining_parents = next_parents.difference(interesting)
 
1610
            interesting.update(remaining_parents)
 
1611
            # We should probably also .difference(directories_to_expand)
 
1612
        interesting.update(file_ids)
 
1613
        interesting.discard(None)
 
1614
        while directories_to_expand:
 
1615
            # Expand directories by looking in the
 
1616
            # parent_id_basename_to_file_id map
 
1617
            keys = [StaticTuple(f,).intern() for f in directories_to_expand]
 
1618
            directories_to_expand = set()
 
1619
            items = self.parent_id_basename_to_file_id.iteritems(keys)
 
1620
            next_file_ids = set([item[1] for item in items])
 
1621
            next_file_ids = next_file_ids.difference(interesting)
 
1622
            interesting.update(next_file_ids)
 
1623
            for entry in self._getitems(next_file_ids):
 
1624
                if entry.kind == 'directory':
 
1625
                    directories_to_expand.add(entry.file_id)
 
1626
                children_of_parent_id.setdefault(entry.parent_id, []
 
1627
                                                 ).append(entry.file_id)
 
1628
        return interesting, children_of_parent_id
 
1629
 
 
1630
    def filter(self, specific_fileids):
 
1631
        """Get an inventory view filtered against a set of file-ids.
 
1632
 
 
1633
        Children of directories and parents are included.
 
1634
 
 
1635
        The result may or may not reference the underlying inventory
 
1636
        so it should be treated as immutable.
 
1637
        """
 
1638
        (interesting,
 
1639
         parent_to_children) = self._expand_fileids_to_parents_and_children(
 
1640
                                specific_fileids)
 
1641
        # There is some overlap here, but we assume that all interesting items
 
1642
        # are in the _fileid_to_entry_cache because we had to read them to
 
1643
        # determine if they were a dir we wanted to recurse, or just a file
 
1644
        # This should give us all the entries we'll want to add, so start
 
1645
        # adding
 
1646
        other = Inventory(self.root_id)
 
1647
        other.root.revision = self.root.revision
 
1648
        other.revision_id = self.revision_id
 
1649
        if not interesting or not parent_to_children:
 
1650
            # empty filter, or filtering entrys that don't exist
 
1651
            # (if even 1 existed, then we would have populated
 
1652
            # parent_to_children with at least the tree root.)
 
1653
            return other
 
1654
        cache = self._fileid_to_entry_cache
 
1655
        remaining_children = collections.deque(parent_to_children[self.root_id])
 
1656
        while remaining_children:
 
1657
            file_id = remaining_children.popleft()
 
1658
            ie = cache[file_id]
 
1659
            if ie.kind == 'directory':
 
1660
                ie = ie.copy() # We create a copy to depopulate the .children attribute
 
1661
            # TODO: depending on the uses of 'other' we should probably alwyas
 
1662
            #       '.copy()' to prevent someone from mutating other and
 
1663
            #       invaliding our internal cache
 
1664
            other.add(ie)
 
1665
            if file_id in parent_to_children:
 
1666
                remaining_children.extend(parent_to_children[file_id])
 
1667
        return other
 
1668
 
1506
1669
    @staticmethod
1507
1670
    def _bytes_to_utf8name_key(bytes):
1508
1671
        """Get the file_id, revision_id key out of bytes."""
1510
1673
        # to filter out empty names because of non rich-root...
1511
1674
        sections = bytes.split('\n')
1512
1675
        kind, file_id = sections[0].split(': ')
1513
 
        return (sections[2], file_id, sections[3])
 
1676
        return (sections[2], intern(file_id), intern(sections[3]))
1514
1677
 
1515
1678
    def _bytes_to_entry(self, bytes):
1516
1679
        """Deserialise a serialised entry."""
1538
1701
            result.reference_revision = sections[4]
1539
1702
        else:
1540
1703
            raise ValueError("Not a serialised entry %r" % bytes)
1541
 
        result.revision = sections[3]
1542
 
        if result.parent_id == '':
1543
 
            result.parent_id = None
1544
 
        self._fileid_to_entry_cache[result.file_id] = result
1545
 
        return result
1546
 
 
1547
 
    def _get_mutable_inventory(self):
1548
 
        """See CommonInventory._get_mutable_inventory."""
1549
 
        entries = self.iter_entries()
1550
 
        if self.root_id is not None:
1551
 
            entries.next()
1552
 
        inv = Inventory(self.root_id, self.revision_id)
1553
 
        for path, inv_entry in entries:
1554
 
            inv.add(inv_entry)
1555
 
        return inv
1556
 
 
1557
 
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
1558
 
        propagate_caches=False):
1559
 
        """Create a new CHKInventory by applying inventory_delta to this one.
1560
 
 
1561
 
        :param inventory_delta: The inventory delta to apply. See
1562
 
            Inventory.apply_delta for details.
1563
 
        :param new_revision_id: The revision id of the resulting CHKInventory.
1564
 
        :param propagate_caches: If True, the caches for this inventory are
1565
 
          copied to and updated for the result.
1566
 
        :return: The new CHKInventory.
1567
 
        """
1568
 
        result = CHKInventory(self._search_key_name)
1569
 
        if propagate_caches:
1570
 
            # Just propagate the path-to-fileid cache for now
1571
 
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
1572
 
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1573
 
        self.id_to_entry._ensure_root()
1574
 
        maximum_size = self.id_to_entry._root_node.maximum_size
1575
 
        result.revision_id = new_revision_id
1576
 
        result.id_to_entry = chk_map.CHKMap(
1577
 
            self.id_to_entry._store,
1578
 
            self.id_to_entry.key(),
1579
 
            search_key_func=search_key_func)
1580
 
        result.id_to_entry._ensure_root()
1581
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1582
 
        parent_id_basename_delta = []
1583
 
        if self.parent_id_basename_to_file_id is not None:
1584
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1585
 
                self.parent_id_basename_to_file_id._store,
1586
 
                self.parent_id_basename_to_file_id.key(),
1587
 
                search_key_func=search_key_func)
1588
 
            result.parent_id_basename_to_file_id._ensure_root()
1589
 
            self.parent_id_basename_to_file_id._ensure_root()
1590
 
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
1591
 
            p_id_root = self.parent_id_basename_to_file_id._root_node
1592
 
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1593
 
            result_p_id_root._key_width = p_id_root._key_width
1594
 
        else:
1595
 
            result.parent_id_basename_to_file_id = None
1596
 
        result.root_id = self.root_id
1597
 
        id_to_entry_delta = []
1598
 
        for old_path, new_path, file_id, entry in inventory_delta:
1599
 
            # file id changes
1600
 
            if new_path == '':
1601
 
                result.root_id = file_id
1602
 
            if new_path is None:
1603
 
                # Make a delete:
1604
 
                new_key = None
1605
 
                new_value = None
1606
 
                # Update caches
1607
 
                if propagate_caches:
1608
 
                    try:
1609
 
                        del result._path_to_fileid_cache[old_path]
1610
 
                    except KeyError:
1611
 
                        pass
1612
 
            else:
1613
 
                new_key = (file_id,)
1614
 
                new_value = result._entry_to_bytes(entry)
1615
 
                # Update caches. It's worth doing this whether
1616
 
                # we're propagating the old caches or not.
1617
 
                result._path_to_fileid_cache[new_path] = file_id
1618
 
            if old_path is None:
1619
 
                old_key = None
1620
 
            else:
1621
 
                old_key = (file_id,)
1622
 
            id_to_entry_delta.append((old_key, new_key, new_value))
1623
 
            if result.parent_id_basename_to_file_id is not None:
1624
 
                # parent_id, basename changes
1625
 
                if old_path is None:
1626
 
                    old_key = None
1627
 
                else:
1628
 
                    old_entry = self[file_id]
1629
 
                    old_key = self._parent_id_basename_key(old_entry)
1630
 
                if new_path is None:
1631
 
                    new_key = None
1632
 
                    new_value = None
1633
 
                else:
1634
 
                    new_key = self._parent_id_basename_key(entry)
1635
 
                    new_value = file_id
1636
 
                if old_key != new_key:
1637
 
                    # If the two keys are the same, the value will be unchanged
1638
 
                    # as its always the file id.
1639
 
                    parent_id_basename_delta.append((old_key, new_key, new_value))
1640
 
        result.id_to_entry.apply_delta(id_to_entry_delta)
1641
 
        if parent_id_basename_delta:
1642
 
            result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
1643
 
        return result
1644
 
 
1645
 
    @classmethod
1646
 
    def deserialise(klass, chk_store, bytes, expected_revision_id):
1647
 
        """Deserialise a CHKInventory.
1648
 
 
1649
 
        :param chk_store: A CHK capable VersionedFiles instance.
1650
 
        :param bytes: The serialised bytes.
1651
 
        :param expected_revision_id: The revision ID we think this inventory is
1652
 
            for.
1653
 
        :return: A CHKInventory
1654
 
        """
1655
 
        lines = bytes.split('\n')
1656
 
        assert lines[-1] == ''
1657
 
        lines.pop()
1658
 
        if lines[0] != 'chkinventory:':
1659
 
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
1660
 
        info = {}
1661
 
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
1662
 
                                  'parent_id_basename_to_file_id',
1663
 
                                  'id_to_entry'])
1664
 
        for line in lines[1:]:
1665
 
            key, value = line.split(': ', 1)
1666
 
            if key not in allowed_keys:
1667
 
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
1668
 
                                      % (key, bytes))
1669
 
            if key in info:
1670
 
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1671
 
                                      % (key, bytes))
1672
 
            info[key] = value
1673
 
        revision_id = info['revision_id']
1674
 
        root_id = info['root_id']
1675
 
        search_key_name = info.get('search_key_name', 'plain')
1676
 
        parent_id_basename_to_file_id = info.get(
1677
 
            'parent_id_basename_to_file_id', None)
1678
 
        id_to_entry = info['id_to_entry']
1679
 
 
1680
 
        result = CHKInventory(search_key_name)
1681
 
        result.revision_id = revision_id
1682
 
        result.root_id = root_id
1683
 
        search_key_func = chk_map.search_key_registry.get(
1684
 
                            result._search_key_name)
1685
 
        if parent_id_basename_to_file_id is not None:
1686
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1687
 
                chk_store, (parent_id_basename_to_file_id,),
1688
 
                search_key_func=search_key_func)
1689
 
        else:
1690
 
            result.parent_id_basename_to_file_id = None
1691
 
 
1692
 
        result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
1693
 
                                            search_key_func=search_key_func)
1694
 
        if (result.revision_id,) != expected_revision_id:
1695
 
            raise ValueError("Mismatched revision id and expected: %r, %r" %
1696
 
                (result.revision_id, expected_revision_id))
1697
 
        return result
1698
 
 
1699
 
    @classmethod
1700
 
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
1701
 
        """Create a CHKInventory from an existing inventory.
1702
 
 
1703
 
        The content of inventory is copied into the chk_store, and a
1704
 
        CHKInventory referencing that is returned.
1705
 
 
1706
 
        :param chk_store: A CHK capable VersionedFiles instance.
1707
 
        :param inventory: The inventory to copy.
1708
 
        :param maximum_size: The CHKMap node size limit.
1709
 
        :param search_key_name: The identifier for the search key function
1710
 
        """
1711
 
        result = CHKInventory(search_key_name)
1712
 
        result.revision_id = inventory.revision_id
1713
 
        result.root_id = inventory.root.file_id
1714
 
        search_key_func = chk_map.search_key_registry.get(search_key_name)
1715
 
        result.id_to_entry = chk_map.CHKMap(chk_store, None, search_key_func)
1716
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1717
 
        file_id_delta = []
1718
 
        result.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1719
 
            None, search_key_func)
1720
 
        result.parent_id_basename_to_file_id._root_node.set_maximum_size(
1721
 
            maximum_size)
1722
 
        result.parent_id_basename_to_file_id._root_node._key_width = 2
1723
 
        parent_id_delta = []
1724
 
        for path, entry in inventory.iter_entries():
1725
 
            file_id_delta.append((None, (entry.file_id,),
1726
 
                result._entry_to_bytes(entry)))
1727
 
            parent_id_delta.append(
1728
 
                (None, result._parent_id_basename_key(entry),
1729
 
                 entry.file_id))
1730
 
        result.id_to_entry.apply_delta(file_id_delta)
1731
 
        result.parent_id_basename_to_file_id.apply_delta(parent_id_delta)
1732
 
        return result
1733
 
 
1734
 
    def _parent_id_basename_key(self, entry):
1735
 
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
1736
 
        if entry.parent_id is not None:
1737
 
            parent_id = entry.parent_id
1738
 
        else:
1739
 
            parent_id = ''
1740
 
        return parent_id, entry.name.encode('utf8')
1741
 
 
1742
 
    def __getitem__(self, file_id):
1743
 
        """map a single file_id -> InventoryEntry."""
1744
 
        if file_id is None:
1745
 
            raise errors.NoSuchId(self, file_id)
1746
 
        result = self._fileid_to_entry_cache.get(file_id, None)
1747
 
        if result is not None:
1748
 
            return result
1749
 
        try:
1750
 
            return self._bytes_to_entry(
1751
 
                self.id_to_entry.iteritems([(file_id,)]).next()[1])
1752
 
        except StopIteration:
1753
 
            # really we're passing an inventory, not a tree...
1754
 
            raise errors.NoSuchId(self, file_id)
1755
 
 
1756
 
    def has_id(self, file_id):
1757
 
        # Perhaps have an explicit 'contains' method on CHKMap ?
1758
 
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
1759
 
            return True
1760
 
        return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
1761
 
 
1762
 
    def is_root(self, file_id):
1763
 
        return file_id == self.root_id
1764
 
 
1765
 
    def _iter_file_id_parents(self, file_id):
1766
 
        """Yield the parents of file_id up to the root."""
1767
 
        while file_id is not None:
1768
 
            try:
1769
 
                ie = self[file_id]
1770
 
            except KeyError:
1771
 
                raise errors.NoSuchId(tree=self, file_id=file_id)
1772
 
            yield ie
1773
 
            file_id = ie.parent_id
1774
 
 
1775
 
    def __iter__(self):
1776
 
        """Iterate over all file-ids."""
1777
 
        for key, _ in self.id_to_entry.iteritems():
1778
 
            yield key[-1]
1779
 
 
1780
 
    def iter_just_entries(self):
1781
 
        """Iterate over all entries.
1782
 
        
1783
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
1784
 
        and the order of entries is undefined.
1785
 
 
1786
 
        XXX: We may not want to merge this into bzr.dev.
1787
 
        """
1788
 
        for key, entry in self.id_to_entry.iteritems():
1789
 
            file_id = key[0]
1790
 
            ie = self._fileid_to_entry_cache.get(file_id, None)
1791
 
            if ie is None:
1792
 
                ie = self._bytes_to_entry(entry)
1793
 
                self._fileid_to_entry_cache[file_id] = ie
1794
 
            yield ie
1795
 
 
1796
 
    def iter_changes(self, basis):
1797
 
        """Generate a Tree.iter_changes change list between this and basis.
1798
 
 
1799
 
        :param basis: Another CHKInventory.
1800
 
        :return: An iterator over the changes between self and basis, as per
1801
 
            tree.iter_changes().
1802
 
        """
1803
 
        # We want: (file_id, (path_in_source, path_in_target),
1804
 
        # changed_content, versioned, parent, name, kind,
1805
 
        # executable)
1806
 
        for key, basis_value, self_value in \
1807
 
            self.id_to_entry.iter_changes(basis.id_to_entry):
1808
 
            file_id = key[0]
1809
 
            if basis_value is not None:
1810
 
                basis_entry = basis._bytes_to_entry(basis_value)
1811
 
                path_in_source = basis.id2path(file_id)
1812
 
                basis_parent = basis_entry.parent_id
1813
 
                basis_name = basis_entry.name
1814
 
                basis_executable = basis_entry.executable
1815
 
            else:
1816
 
                path_in_source = None
1817
 
                basis_parent = None
1818
 
                basis_name = None
1819
 
                basis_executable = None
1820
 
            if self_value is not None:
1821
 
                self_entry = self._bytes_to_entry(self_value)
1822
 
                path_in_target = self.id2path(file_id)
1823
 
                self_parent = self_entry.parent_id
1824
 
                self_name = self_entry.name
1825
 
                self_executable = self_entry.executable
1826
 
            else:
1827
 
                path_in_target = None
1828
 
                self_parent = None
1829
 
                self_name = None
1830
 
                self_executable = None
1831
 
            if basis_value is None:
1832
 
                # add
1833
 
                kind = (None, self_entry.kind)
1834
 
                versioned = (False, True)
1835
 
            elif self_value is None:
1836
 
                # delete
1837
 
                kind = (basis_entry.kind, None)
1838
 
                versioned = (True, False)
1839
 
            else:
1840
 
                kind = (basis_entry.kind, self_entry.kind)
1841
 
                versioned = (True, True)
1842
 
            changed_content = False
1843
 
            if kind[0] != kind[1]:
1844
 
                changed_content = True
1845
 
            elif kind[0] == 'file':
1846
 
                if (self_entry.text_size != basis_entry.text_size or
1847
 
                    self_entry.text_sha1 != basis_entry.text_sha1):
1848
 
                    changed_content = True
1849
 
            elif kind[0] == 'symlink':
1850
 
                if self_entry.symlink_target != basis_entry.symlink_target:
1851
 
                    changed_content = True
1852
 
            elif kind[0] == 'tree-reference':
1853
 
                if (self_entry.reference_revision !=
1854
 
                    basis_entry.reference_revision):
1855
 
                    changed_content = True
1856
 
            parent = (basis_parent, self_parent)
1857
 
            name = (basis_name, self_name)
1858
 
            executable = (basis_executable, self_executable)
1859
 
            if (not changed_content
1860
 
                and parent[0] == parent[1]
1861
 
                and name[0] == name[1]
1862
 
                and executable[0] == executable[1]):
1863
 
                # Could happen when only the revision changed for a directory
1864
 
                # for instance.
1865
 
                continue
1866
 
            yield (file_id, (path_in_source, path_in_target), changed_content,
1867
 
                versioned, parent, name, kind, executable)
1868
 
 
1869
 
    def __len__(self):
1870
 
        """Return the number of entries in the inventory."""
1871
 
        return len(self.id_to_entry)
1872
 
 
1873
 
    def _make_delta(self, old):
1874
 
        """Make an inventory delta from two inventories."""
1875
 
        if type(old) != CHKInventory:
1876
 
            return CommonInventory._make_delta(self, old)
1877
 
        delta = []
1878
 
        for key, old_value, self_value in \
1879
 
            self.id_to_entry.iter_changes(old.id_to_entry):
1880
 
            file_id = key[0]
1881
 
            if old_value is not None:
1882
 
                old_path = old.id2path(file_id)
1883
 
            else:
1884
 
                old_path = None
1885
 
            if self_value is not None:
1886
 
                entry = self._bytes_to_entry(self_value)
1887
 
                self._fileid_to_entry_cache[file_id] = entry
1888
 
                new_path = self.id2path(file_id)
1889
 
            else:
1890
 
                entry = None
1891
 
                new_path = None
1892
 
            delta.append((old_path, new_path, file_id, entry))
1893
 
        return delta
1894
 
 
1895
 
    def path2id(self, name):
1896
 
        """See CommonInventory.path2id()."""
1897
 
        result = self._path_to_fileid_cache.get(name, None)
1898
 
        if result is None:
1899
 
            result = CommonInventory.path2id(self, name)
1900
 
            self._path_to_fileid_cache[name] = result
1901
 
        return result
1902
 
 
1903
 
    def to_lines(self):
1904
 
        """Serialise the inventory to lines."""
1905
 
        lines = ["chkinventory:\n"]
1906
 
        if self._search_key_name != 'plain':
1907
 
            # custom ordering grouping things that don't change together
1908
 
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
1909
 
            lines.append("root_id: %s\n" % self.root_id)
1910
 
            lines.append('parent_id_basename_to_file_id: %s\n' %
1911
 
                self.parent_id_basename_to_file_id.key())
1912
 
            lines.append("revision_id: %s\n" % self.revision_id)
1913
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1914
 
        else:
1915
 
            lines.append("revision_id: %s\n" % self.revision_id)
1916
 
            lines.append("root_id: %s\n" % self.root_id)
1917
 
            if self.parent_id_basename_to_file_id is not None:
1918
 
                lines.append('parent_id_basename_to_file_id: %s\n' %
1919
 
                    self.parent_id_basename_to_file_id.key())
1920
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1921
 
        return lines
1922
 
 
1923
 
    @property
1924
 
    def root(self):
1925
 
        """Get the root entry."""
1926
 
        return self[self.root_id]
1927
 
 
1928
 
 
1929
 
class CHKInventoryDirectory(InventoryDirectory):
1930
 
    """A directory in an inventory."""
1931
 
 
1932
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1933
 
                 'text_id', 'parent_id', '_children', 'executable',
1934
 
                 'revision', 'symlink_target', 'reference_revision',
1935
 
                 '_chk_inventory']
1936
 
 
1937
 
    def __init__(self, file_id, name, parent_id, chk_inventory):
1938
 
        # Don't call InventoryDirectory.__init__ - it isn't right for this
1939
 
        # class.
1940
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
1941
 
        self._children = None
1942
 
        self.kind = 'directory'
1943
 
        self._chk_inventory = chk_inventory
1944
 
 
1945
 
    @property
1946
 
    def children(self):
1947
 
        """Access the list of children of this directory.
1948
 
 
1949
 
        With a parent_id_basename_to_file_id index, loads all the children,
1950
 
        without loads the entire index. Without is bad. A more sophisticated
1951
 
        proxy object might be nice, to allow partial loading of children as
1952
 
        well when specific names are accessed. (So path traversal can be
1953
 
        written in the obvious way but not examine siblings.).
1954
 
        """
1955
 
        if self._children is not None:
1956
 
            return self._children
1957
 
        # No longer supported
1958
 
        if self._chk_inventory.parent_id_basename_to_file_id is None:
1959
 
            raise AssertionError("Inventories without"
1960
 
                " parent_id_basename_to_file_id are no longer supported")
1961
 
        result = {}
1962
 
        # XXX: Todo - use proxy objects for the children rather than loading
1963
 
        # all when the attribute is referenced.
1964
 
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
1965
 
        child_keys = set()
1966
 
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
1967
 
            key_filter=[(self.file_id,)]):
1968
 
            child_keys.add((file_id,))
1969
 
        cached = set()
1970
 
        for file_id_key in child_keys:
1971
 
            entry = self._chk_inventory._fileid_to_entry_cache.get(
1972
 
                file_id_key[0], None)
1973
 
            if entry is not None:
1974
 
                result[entry.name] = entry
1975
 
                cached.add(file_id_key)
1976
 
        child_keys.difference_update(cached)
1977
 
        # populate; todo: do by name
1978
 
        id_to_entry = self._chk_inventory.id_to_entry
1979
 
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
1980
 
            entry = self._chk_inventory._bytes_to_entry(bytes)
1981
 
            result[entry.name] = entry
1982
 
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
1983
 
        self._children = result
1984
 
        return result
1985
 
 
1986
 
 
1987
 
class CHKInventory(CommonInventory):
1988
 
    """An inventory persisted in a CHK store.
1989
 
 
1990
 
    By design, a CHKInventory is immutable so many of the methods
1991
 
    supported by Inventory - add, rename, apply_delta, etc - are *not*
1992
 
    supported. To create a new CHKInventory, use create_by_apply_delta()
1993
 
    or from_inventory(), say.
1994
 
 
1995
 
    Internally, a CHKInventory has one or two CHKMaps:
1996
 
 
1997
 
    * id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1998
 
    * parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1999
 
        => file_id as bytes
2000
 
 
2001
 
    The second map is optional and not present in early CHkRepository's.
2002
 
 
2003
 
    No caching is performed: every method call or item access will perform
2004
 
    requests to the storage layer. As such, keep references to objects you
2005
 
    want to reuse.
2006
 
    """
2007
 
 
2008
 
    def __init__(self, search_key_name):
2009
 
        CommonInventory.__init__(self)
2010
 
        self._fileid_to_entry_cache = {}
2011
 
        self._path_to_fileid_cache = {}
2012
 
        self._search_key_name = search_key_name
2013
 
 
2014
 
    def _entry_to_bytes(self, entry):
2015
 
        """Serialise entry as a single bytestring.
2016
 
 
2017
 
        :param Entry: An inventory entry.
2018
 
        :return: A bytestring for the entry.
2019
 
 
2020
 
        The BNF:
2021
 
        ENTRY ::= FILE | DIR | SYMLINK | TREE
2022
 
        FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
2023
 
        DIR ::= "dir: " COMMON
2024
 
        SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
2025
 
        TREE ::= "tree: " COMMON REFERENCE_REVISION
2026
 
        COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
2027
 
        SEP ::= "\n"
2028
 
        """
2029
 
        if entry.parent_id is not None:
2030
 
            parent_str = entry.parent_id
2031
 
        else:
2032
 
            parent_str = ''
2033
 
        name_str = entry.name.encode("utf8")
2034
 
        if entry.kind == 'file':
2035
 
            if entry.executable:
2036
 
                exec_str = "Y"
2037
 
            else:
2038
 
                exec_str = "N"
2039
 
            return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
2040
 
                entry.file_id, parent_str, name_str, entry.revision,
2041
 
                entry.text_sha1, entry.text_size, exec_str)
2042
 
        elif entry.kind == 'directory':
2043
 
            return "dir: %s\n%s\n%s\n%s" % (
2044
 
                entry.file_id, parent_str, name_str, entry.revision)
2045
 
        elif entry.kind == 'symlink':
2046
 
            return "symlink: %s\n%s\n%s\n%s\n%s" % (
2047
 
                entry.file_id, parent_str, name_str, entry.revision,
2048
 
                entry.symlink_target.encode("utf8"))
2049
 
        elif entry.kind == 'tree-reference':
2050
 
            return "tree: %s\n%s\n%s\n%s\n%s" % (
2051
 
                entry.file_id, parent_str, name_str, entry.revision,
2052
 
                entry.reference_revision)
2053
 
        else:
2054
 
            raise ValueError("unknown kind %r" % entry.kind)
2055
 
 
2056
 
    def _bytes_to_entry(self, bytes):
2057
 
        """Deserialise a serialised entry."""
2058
 
        sections = bytes.split('\n')
2059
 
        if sections[0].startswith("file: "):
2060
 
            result = InventoryFile(sections[0][6:],
2061
 
                sections[2].decode('utf8'),
2062
 
                sections[1])
2063
 
            result.text_sha1 = sections[4]
2064
 
            result.text_size = int(sections[5])
2065
 
            result.executable = sections[6] == "Y"
2066
 
        elif sections[0].startswith("dir: "):
2067
 
            result = CHKInventoryDirectory(sections[0][5:],
2068
 
                sections[2].decode('utf8'),
2069
 
                sections[1], self)
2070
 
        elif sections[0].startswith("symlink: "):
2071
 
            result = InventoryLink(sections[0][9:],
2072
 
                sections[2].decode('utf8'),
2073
 
                sections[1])
2074
 
            result.symlink_target = sections[4]
2075
 
        elif sections[0].startswith("tree: "):
2076
 
            result = TreeReference(sections[0][6:],
2077
 
                sections[2].decode('utf8'),
2078
 
                sections[1])
2079
 
            result.reference_revision = sections[4]
2080
 
        else:
2081
 
            raise ValueError("Not a serialised entry %r" % bytes)
2082
 
        result.revision = sections[3]
2083
 
        if result.parent_id == '':
2084
 
            result.parent_id = None
2085
 
        self._fileid_to_entry_cache[result.file_id] = result
2086
 
        return result
2087
 
 
2088
 
    def _get_mutable_inventory(self):
2089
 
        """See CommonInventory._get_mutable_inventory."""
2090
 
        entries = self.iter_entries()
2091
 
        if self.root_id is not None:
2092
 
            entries.next()
2093
 
        inv = Inventory(self.root_id, self.revision_id)
2094
 
        for path, inv_entry in entries:
2095
 
            inv.add(inv_entry)
2096
 
        return inv
2097
 
 
2098
 
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
2099
 
        propagate_caches=False):
2100
 
        """Create a new CHKInventory by applying inventory_delta to this one.
2101
 
 
2102
 
        :param inventory_delta: The inventory delta to apply. See
2103
 
            Inventory.apply_delta for details.
2104
 
        :param new_revision_id: The revision id of the resulting CHKInventory.
2105
 
        :param propagate_caches: If True, the caches for this inventory are
2106
 
          copied to and updated for the result.
2107
 
        :return: The new CHKInventory.
2108
 
        """
2109
 
        result = CHKInventory(self._search_key_name)
2110
 
        if propagate_caches:
2111
 
            # Just propagate the path-to-fileid cache for now
2112
 
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
2113
 
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
2114
 
        self.id_to_entry._ensure_root()
2115
 
        maximum_size = self.id_to_entry._root_node.maximum_size
2116
 
        result.revision_id = new_revision_id
2117
 
        result.id_to_entry = chk_map.CHKMap(
2118
 
            self.id_to_entry._store,
2119
 
            self.id_to_entry.key(),
2120
 
            search_key_func=search_key_func)
2121
 
        result.id_to_entry._ensure_root()
2122
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
2123
 
        parent_id_basename_delta = []
2124
 
        if self.parent_id_basename_to_file_id is not None:
2125
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
2126
 
                self.parent_id_basename_to_file_id._store,
2127
 
                self.parent_id_basename_to_file_id.key(),
2128
 
                search_key_func=search_key_func)
2129
 
            result.parent_id_basename_to_file_id._ensure_root()
2130
 
            self.parent_id_basename_to_file_id._ensure_root()
2131
 
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
2132
 
            p_id_root = self.parent_id_basename_to_file_id._root_node
2133
 
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
2134
 
            result_p_id_root._key_width = p_id_root._key_width
2135
 
        else:
2136
 
            result.parent_id_basename_to_file_id = None
2137
 
        result.root_id = self.root_id
2138
 
        id_to_entry_delta = []
2139
 
        for old_path, new_path, file_id, entry in inventory_delta:
2140
 
            # file id changes
2141
 
            if new_path == '':
2142
 
                result.root_id = file_id
2143
 
            if new_path is None:
2144
 
                # Make a delete:
2145
 
                new_key = None
2146
 
                new_value = None
2147
 
                # Update caches
2148
 
                if propagate_caches:
2149
 
                    try:
2150
 
                        del result._path_to_fileid_cache[old_path]
2151
 
                    except KeyError:
2152
 
                        pass
2153
 
            else:
2154
 
                new_key = (file_id,)
2155
 
                new_value = result._entry_to_bytes(entry)
2156
 
                # Update caches. It's worth doing this whether
2157
 
                # we're propagating the old caches or not.
2158
 
                result._path_to_fileid_cache[new_path] = file_id
2159
 
            if old_path is None:
2160
 
                old_key = None
2161
 
            else:
2162
 
                old_key = (file_id,)
2163
 
            id_to_entry_delta.append((old_key, new_key, new_value))
2164
 
            if result.parent_id_basename_to_file_id is not None:
2165
 
                # parent_id, basename changes
2166
 
                if old_path is None:
2167
 
                    old_key = None
2168
 
                else:
2169
 
                    old_entry = self[file_id]
2170
 
                    old_key = self._parent_id_basename_key(old_entry)
2171
 
                if new_path is None:
2172
 
                    new_key = None
2173
 
                    new_value = None
2174
 
                else:
2175
 
                    new_key = self._parent_id_basename_key(entry)
2176
 
                    new_value = file_id
2177
 
                if old_key != new_key:
2178
 
                    # If the two keys are the same, the value will be unchanged
2179
 
                    # as its always the file id.
2180
 
                    parent_id_basename_delta.append((old_key, new_key, new_value))
2181
 
        result.id_to_entry.apply_delta(id_to_entry_delta)
2182
 
        if parent_id_basename_delta:
2183
 
            result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
2184
 
        return result
2185
 
 
2186
 
    @classmethod
2187
 
    def deserialise(klass, chk_store, bytes, expected_revision_id):
2188
 
        """Deserialise a CHKInventory.
2189
 
 
2190
 
        :param chk_store: A CHK capable VersionedFiles instance.
2191
 
        :param bytes: The serialised bytes.
2192
 
        :param expected_revision_id: The revision ID we think this inventory is
2193
 
            for.
2194
 
        :return: A CHKInventory
2195
 
        """
2196
 
        lines = bytes.split('\n')
2197
 
        assert lines[-1] == ''
2198
 
        lines.pop()
2199
 
        if lines[0] != 'chkinventory:':
2200
 
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
2201
 
        info = {}
2202
 
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
2203
 
                                  'parent_id_basename_to_file_id',
2204
 
                                  'id_to_entry'])
2205
 
        for line in lines[1:]:
2206
 
            key, value = line.split(': ', 1)
2207
 
            if key not in allowed_keys:
2208
 
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
2209
 
                                      % (key, bytes))
2210
 
            if key in info:
2211
 
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
2212
 
                                      % (key, bytes))
2213
 
            info[key] = value
2214
 
        revision_id = info['revision_id']
2215
 
        root_id = info['root_id']
2216
 
        search_key_name = info.get('search_key_name', 'plain')
2217
 
        parent_id_basename_to_file_id = info.get(
2218
 
            'parent_id_basename_to_file_id', None)
2219
 
        id_to_entry = info['id_to_entry']
2220
 
 
2221
 
        result = CHKInventory(search_key_name)
2222
 
        result.revision_id = revision_id
2223
 
        result.root_id = root_id
2224
 
        search_key_func = chk_map.search_key_registry.get(
2225
 
                            result._search_key_name)
2226
 
        if parent_id_basename_to_file_id is not None:
2227
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
2228
 
                chk_store, (parent_id_basename_to_file_id,),
2229
 
                search_key_func=search_key_func)
2230
 
        else:
2231
 
            result.parent_id_basename_to_file_id = None
2232
 
 
2233
 
        result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
2234
 
                                            search_key_func=search_key_func)
2235
 
        if (result.revision_id,) != expected_revision_id:
2236
 
            raise ValueError("Mismatched revision id and expected: %r, %r" %
2237
 
                (result.revision_id, expected_revision_id))
2238
 
        return result
2239
 
 
2240
 
    @classmethod
2241
 
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
2242
 
        """Create a CHKInventory from an existing inventory.
2243
 
 
2244
 
        The content of inventory is copied into the chk_store, and a
2245
 
        CHKInventory referencing that is returned.
2246
 
 
2247
 
        :param chk_store: A CHK capable VersionedFiles instance.
2248
 
        :param inventory: The inventory to copy.
2249
 
        :param maximum_size: The CHKMap node size limit.
2250
 
        :param search_key_name: The identifier for the search key function
2251
 
        """
2252
 
        result = CHKInventory(search_key_name)
2253
 
        result.revision_id = inventory.revision_id
2254
 
        result.root_id = inventory.root.file_id
2255
 
        search_key_func = chk_map.search_key_registry.get(search_key_name)
2256
 
        result.id_to_entry = chk_map.CHKMap(chk_store, None, search_key_func)
2257
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
2258
 
        file_id_delta = []
2259
 
        result.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
2260
 
            None, search_key_func)
2261
 
        result.parent_id_basename_to_file_id._root_node.set_maximum_size(
2262
 
            maximum_size)
2263
 
        result.parent_id_basename_to_file_id._root_node._key_width = 2
2264
 
        parent_id_delta = []
2265
 
        for path, entry in inventory.iter_entries():
2266
 
            file_id_delta.append((None, (entry.file_id,),
2267
 
                result._entry_to_bytes(entry)))
2268
 
            parent_id_delta.append(
2269
 
                (None, result._parent_id_basename_key(entry),
2270
 
                 entry.file_id))
2271
 
        result.id_to_entry.apply_delta(file_id_delta)
2272
 
        result.parent_id_basename_to_file_id.apply_delta(parent_id_delta)
2273
 
        return result
2274
 
 
2275
 
    def _parent_id_basename_key(self, entry):
2276
 
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
2277
 
        if entry.parent_id is not None:
2278
 
            parent_id = entry.parent_id
2279
 
        else:
2280
 
            parent_id = ''
2281
 
        return parent_id, entry.name.encode('utf8')
2282
 
 
2283
 
    def __getitem__(self, file_id):
2284
 
        """map a single file_id -> InventoryEntry."""
2285
 
        if file_id is None:
2286
 
            raise errors.NoSuchId(self, file_id)
2287
 
        result = self._fileid_to_entry_cache.get(file_id, None)
2288
 
        if result is not None:
2289
 
            return result
2290
 
        try:
2291
 
            return self._bytes_to_entry(
2292
 
                self.id_to_entry.iteritems([(file_id,)]).next()[1])
2293
 
        except StopIteration:
2294
 
            # really we're passing an inventory, not a tree...
2295
 
            raise errors.NoSuchId(self, file_id)
2296
 
 
2297
 
    def has_id(self, file_id):
2298
 
        # Perhaps have an explicit 'contains' method on CHKMap ?
2299
 
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
2300
 
            return True
2301
 
        return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
2302
 
 
2303
 
    def is_root(self, file_id):
2304
 
        return file_id == self.root_id
2305
 
 
2306
 
    def _iter_file_id_parents(self, file_id):
2307
 
        """Yield the parents of file_id up to the root."""
2308
 
        while file_id is not None:
2309
 
            try:
2310
 
                ie = self[file_id]
2311
 
            except KeyError:
2312
 
                raise errors.NoSuchId(tree=self, file_id=file_id)
2313
 
            yield ie
2314
 
            file_id = ie.parent_id
2315
 
 
2316
 
    def __iter__(self):
2317
 
        """Iterate over all file-ids."""
2318
 
        for key, _ in self.id_to_entry.iteritems():
2319
 
            yield key[-1]
2320
 
 
2321
 
    def iter_just_entries(self):
2322
 
        """Iterate over all entries.
2323
 
        
2324
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
2325
 
        and the order of entries is undefined.
2326
 
 
2327
 
        XXX: We may not want to merge this into bzr.dev.
2328
 
        """
2329
 
        for key, entry in self.id_to_entry.iteritems():
2330
 
            file_id = key[0]
2331
 
            ie = self._fileid_to_entry_cache.get(file_id, None)
2332
 
            if ie is None:
2333
 
                ie = self._bytes_to_entry(entry)
2334
 
                self._fileid_to_entry_cache[file_id] = ie
2335
 
            yield ie
2336
 
 
2337
 
    def iter_changes(self, basis):
2338
 
        """Generate a Tree.iter_changes change list between this and basis.
2339
 
 
2340
 
        :param basis: Another CHKInventory.
2341
 
        :return: An iterator over the changes between self and basis, as per
2342
 
            tree.iter_changes().
2343
 
        """
2344
 
        # We want: (file_id, (path_in_source, path_in_target),
2345
 
        # changed_content, versioned, parent, name, kind,
2346
 
        # executable)
2347
 
        for key, basis_value, self_value in \
2348
 
            self.id_to_entry.iter_changes(basis.id_to_entry):
2349
 
            file_id = key[0]
2350
 
            if basis_value is not None:
2351
 
                basis_entry = basis._bytes_to_entry(basis_value)
2352
 
                path_in_source = basis.id2path(file_id)
2353
 
                basis_parent = basis_entry.parent_id
2354
 
                basis_name = basis_entry.name
2355
 
                basis_executable = basis_entry.executable
2356
 
            else:
2357
 
                path_in_source = None
2358
 
                basis_parent = None
2359
 
                basis_name = None
2360
 
                basis_executable = None
2361
 
            if self_value is not None:
2362
 
                self_entry = self._bytes_to_entry(self_value)
2363
 
                path_in_target = self.id2path(file_id)
2364
 
                self_parent = self_entry.parent_id
2365
 
                self_name = self_entry.name
2366
 
                self_executable = self_entry.executable
2367
 
            else:
2368
 
                path_in_target = None
2369
 
                self_parent = None
2370
 
                self_name = None
2371
 
                self_executable = None
2372
 
            if basis_value is None:
2373
 
                # add
2374
 
                kind = (None, self_entry.kind)
2375
 
                versioned = (False, True)
2376
 
            elif self_value is None:
2377
 
                # delete
2378
 
                kind = (basis_entry.kind, None)
2379
 
                versioned = (True, False)
2380
 
            else:
2381
 
                kind = (basis_entry.kind, self_entry.kind)
2382
 
                versioned = (True, True)
2383
 
            changed_content = False
2384
 
            if kind[0] != kind[1]:
2385
 
                changed_content = True
2386
 
            elif kind[0] == 'file':
2387
 
                if (self_entry.text_size != basis_entry.text_size or
2388
 
                    self_entry.text_sha1 != basis_entry.text_sha1):
2389
 
                    changed_content = True
2390
 
            elif kind[0] == 'symlink':
2391
 
                if self_entry.symlink_target != basis_entry.symlink_target:
2392
 
                    changed_content = True
2393
 
            elif kind[0] == 'tree-reference':
2394
 
                if (self_entry.reference_revision !=
2395
 
                    basis_entry.reference_revision):
2396
 
                    changed_content = True
2397
 
            parent = (basis_parent, self_parent)
2398
 
            name = (basis_name, self_name)
2399
 
            executable = (basis_executable, self_executable)
2400
 
            if (not changed_content
2401
 
                and parent[0] == parent[1]
2402
 
                and name[0] == name[1]
2403
 
                and executable[0] == executable[1]):
2404
 
                # Could happen when only the revision changed for a directory
2405
 
                # for instance.
2406
 
                continue
2407
 
            yield (file_id, (path_in_source, path_in_target), changed_content,
2408
 
                versioned, parent, name, kind, executable)
2409
 
 
2410
 
    def __len__(self):
2411
 
        """Return the number of entries in the inventory."""
2412
 
        return len(self.id_to_entry)
2413
 
 
2414
 
    def _make_delta(self, old):
2415
 
        """Make an inventory delta from two inventories."""
2416
 
        if type(old) != CHKInventory:
2417
 
            return CommonInventory._make_delta(self, old)
2418
 
        delta = []
2419
 
        for key, old_value, self_value in \
2420
 
            self.id_to_entry.iter_changes(old.id_to_entry):
2421
 
            file_id = key[0]
2422
 
            if old_value is not None:
2423
 
                old_path = old.id2path(file_id)
2424
 
            else:
2425
 
                old_path = None
2426
 
            if self_value is not None:
2427
 
                entry = self._bytes_to_entry(self_value)
2428
 
                self._fileid_to_entry_cache[file_id] = entry
2429
 
                new_path = self.id2path(file_id)
2430
 
            else:
2431
 
                entry = None
2432
 
                new_path = None
2433
 
            delta.append((old_path, new_path, file_id, entry))
2434
 
        return delta
2435
 
 
2436
 
    def path2id(self, name):
2437
 
        """See CommonInventory.path2id()."""
2438
 
        result = self._path_to_fileid_cache.get(name, None)
2439
 
        if result is None:
2440
 
            result = CommonInventory.path2id(self, name)
2441
 
            self._path_to_fileid_cache[name] = result
2442
 
        return result
2443
 
 
2444
 
    def to_lines(self):
2445
 
        """Serialise the inventory to lines."""
2446
 
        lines = ["chkinventory:\n"]
2447
 
        if self._search_key_name != 'plain':
2448
 
            # custom ordering grouping things that don't change together
2449
 
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
2450
 
            lines.append("root_id: %s\n" % self.root_id)
2451
 
            lines.append('parent_id_basename_to_file_id: %s\n' %
2452
 
                self.parent_id_basename_to_file_id.key())
2453
 
            lines.append("revision_id: %s\n" % self.revision_id)
2454
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
2455
 
        else:
2456
 
            lines.append("revision_id: %s\n" % self.revision_id)
2457
 
            lines.append("root_id: %s\n" % self.root_id)
2458
 
            if self.parent_id_basename_to_file_id is not None:
2459
 
                lines.append('parent_id_basename_to_file_id: %s\n' %
2460
 
                    self.parent_id_basename_to_file_id.key())
2461
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
2462
 
        return lines
2463
 
 
2464
 
    @property
2465
 
    def root(self):
2466
 
        """Get the root entry."""
2467
 
        return self[self.root_id]
2468
 
 
2469
 
 
2470
 
class CHKInventoryDirectory(InventoryDirectory):
2471
 
    """A directory in an inventory."""
2472
 
 
2473
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
2474
 
                 'text_id', 'parent_id', '_children', 'executable',
2475
 
                 'revision', 'symlink_target', 'reference_revision',
2476
 
                 '_chk_inventory']
2477
 
 
2478
 
    def __init__(self, file_id, name, parent_id, chk_inventory):
2479
 
        # Don't call InventoryDirectory.__init__ - it isn't right for this
2480
 
        # class.
2481
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
2482
 
        self._children = None
2483
 
        self.kind = 'directory'
2484
 
        self._chk_inventory = chk_inventory
2485
 
 
2486
 
    @property
2487
 
    def children(self):
2488
 
        """Access the list of children of this directory.
2489
 
 
2490
 
        With a parent_id_basename_to_file_id index, loads all the children,
2491
 
        without loads the entire index. Without is bad. A more sophisticated
2492
 
        proxy object might be nice, to allow partial loading of children as
2493
 
        well when specific names are accessed. (So path traversal can be
2494
 
        written in the obvious way but not examine siblings.).
2495
 
        """
2496
 
        if self._children is not None:
2497
 
            return self._children
2498
 
        # No longer supported
2499
 
        if self._chk_inventory.parent_id_basename_to_file_id is None:
2500
 
            raise AssertionError("Inventories without"
2501
 
                " parent_id_basename_to_file_id are no longer supported")
2502
 
        result = {}
2503
 
        # XXX: Todo - use proxy objects for the children rather than loading
2504
 
        # all when the attribute is referenced.
2505
 
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
2506
 
        child_keys = set()
2507
 
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
2508
 
            key_filter=[(self.file_id,)]):
2509
 
            child_keys.add((file_id,))
2510
 
        cached = set()
2511
 
        for file_id_key in child_keys:
2512
 
            entry = self._chk_inventory._fileid_to_entry_cache.get(
2513
 
                file_id_key[0], None)
2514
 
            if entry is not None:
2515
 
                result[entry.name] = entry
2516
 
                cached.add(file_id_key)
2517
 
        child_keys.difference_update(cached)
2518
 
        # populate; todo: do by name
2519
 
        id_to_entry = self._chk_inventory.id_to_entry
2520
 
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
2521
 
            entry = self._chk_inventory._bytes_to_entry(bytes)
2522
 
            result[entry.name] = entry
2523
 
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
2524
 
        self._children = result
2525
 
        return result
2526
 
 
 
1704
        result.file_id = intern(result.file_id)
 
1705
        result.revision = intern(sections[3])
 
1706
        if result.parent_id == '':
 
1707
            result.parent_id = None
 
1708
        self._fileid_to_entry_cache[result.file_id] = result
 
1709
        return result
 
1710
 
 
1711
    def _get_mutable_inventory(self):
 
1712
        """See CommonInventory._get_mutable_inventory."""
 
1713
        entries = self.iter_entries()
 
1714
        inv = Inventory(None, self.revision_id)
 
1715
        for path, inv_entry in entries:
 
1716
            inv.add(inv_entry.copy())
 
1717
        return inv
 
1718
 
 
1719
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
 
1720
        propagate_caches=False):
 
1721
        """Create a new CHKInventory by applying inventory_delta to this one.
 
1722
 
 
1723
        See the inventory developers documentation for the theory behind
 
1724
        inventory deltas.
 
1725
 
 
1726
        :param inventory_delta: The inventory delta to apply. See
 
1727
            Inventory.apply_delta for details.
 
1728
        :param new_revision_id: The revision id of the resulting CHKInventory.
 
1729
        :param propagate_caches: If True, the caches for this inventory are
 
1730
          copied to and updated for the result.
 
1731
        :return: The new CHKInventory.
 
1732
        """
 
1733
        split = osutils.split
 
1734
        result = CHKInventory(self._search_key_name)
 
1735
        if propagate_caches:
 
1736
            # Just propagate the path-to-fileid cache for now
 
1737
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
 
1738
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
 
1739
        self.id_to_entry._ensure_root()
 
1740
        maximum_size = self.id_to_entry._root_node.maximum_size
 
1741
        result.revision_id = new_revision_id
 
1742
        result.id_to_entry = chk_map.CHKMap(
 
1743
            self.id_to_entry._store,
 
1744
            self.id_to_entry.key(),
 
1745
            search_key_func=search_key_func)
 
1746
        result.id_to_entry._ensure_root()
 
1747
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
 
1748
        # Change to apply to the parent_id_basename delta. The dict maps
 
1749
        # (parent_id, basename) -> (old_key, new_value). We use a dict because
 
1750
        # when a path has its id replaced (e.g. the root is changed, or someone
 
1751
        # does bzr mv a b, bzr mv c a, we should output a single change to this
 
1752
        # map rather than two.
 
1753
        parent_id_basename_delta = {}
 
1754
        if self.parent_id_basename_to_file_id is not None:
 
1755
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
 
1756
                self.parent_id_basename_to_file_id._store,
 
1757
                self.parent_id_basename_to_file_id.key(),
 
1758
                search_key_func=search_key_func)
 
1759
            result.parent_id_basename_to_file_id._ensure_root()
 
1760
            self.parent_id_basename_to_file_id._ensure_root()
 
1761
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
 
1762
            p_id_root = self.parent_id_basename_to_file_id._root_node
 
1763
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
 
1764
            result_p_id_root._key_width = p_id_root._key_width
 
1765
        else:
 
1766
            result.parent_id_basename_to_file_id = None
 
1767
        result.root_id = self.root_id
 
1768
        id_to_entry_delta = []
 
1769
        # inventory_delta is only traversed once, so we just update the
 
1770
        # variable.
 
1771
        # Check for repeated file ids
 
1772
        inventory_delta = _check_delta_unique_ids(inventory_delta)
 
1773
        # Repeated old paths
 
1774
        inventory_delta = _check_delta_unique_old_paths(inventory_delta)
 
1775
        # Check for repeated new paths
 
1776
        inventory_delta = _check_delta_unique_new_paths(inventory_delta)
 
1777
        # Check for entries that don't match the fileid
 
1778
        inventory_delta = _check_delta_ids_match_entry(inventory_delta)
 
1779
        # Check for nonsense fileids
 
1780
        inventory_delta = _check_delta_ids_are_valid(inventory_delta)
 
1781
        # Check for new_path <-> entry consistency
 
1782
        inventory_delta = _check_delta_new_path_entry_both_or_None(
 
1783
            inventory_delta)
 
1784
        # All changed entries need to have their parents be directories and be
 
1785
        # at the right path. This set contains (path, id) tuples.
 
1786
        parents = set()
 
1787
        # When we delete an item, all the children of it must be either deleted
 
1788
        # or altered in their own right. As we batch process the change via
 
1789
        # CHKMap.apply_delta, we build a set of things to use to validate the
 
1790
        # delta.
 
1791
        deletes = set()
 
1792
        altered = set()
 
1793
        for old_path, new_path, file_id, entry in inventory_delta:
 
1794
            # file id changes
 
1795
            if new_path == '':
 
1796
                result.root_id = file_id
 
1797
            if new_path is None:
 
1798
                # Make a delete:
 
1799
                new_key = None
 
1800
                new_value = None
 
1801
                # Update caches
 
1802
                if propagate_caches:
 
1803
                    try:
 
1804
                        del result._path_to_fileid_cache[old_path]
 
1805
                    except KeyError:
 
1806
                        pass
 
1807
                deletes.add(file_id)
 
1808
            else:
 
1809
                new_key = StaticTuple(file_id,)
 
1810
                new_value = result._entry_to_bytes(entry)
 
1811
                # Update caches. It's worth doing this whether
 
1812
                # we're propagating the old caches or not.
 
1813
                result._path_to_fileid_cache[new_path] = file_id
 
1814
                parents.add((split(new_path)[0], entry.parent_id))
 
1815
            if old_path is None:
 
1816
                old_key = None
 
1817
            else:
 
1818
                old_key = StaticTuple(file_id,)
 
1819
                if self.id2path(file_id) != old_path:
 
1820
                    raise errors.InconsistentDelta(old_path, file_id,
 
1821
                        "Entry was at wrong other path %r." %
 
1822
                        self.id2path(file_id))
 
1823
                altered.add(file_id)
 
1824
            id_to_entry_delta.append(StaticTuple(old_key, new_key, new_value))
 
1825
            if result.parent_id_basename_to_file_id is not None:
 
1826
                # parent_id, basename changes
 
1827
                if old_path is None:
 
1828
                    old_key = None
 
1829
                else:
 
1830
                    old_entry = self[file_id]
 
1831
                    old_key = self._parent_id_basename_key(old_entry)
 
1832
                if new_path is None:
 
1833
                    new_key = None
 
1834
                    new_value = None
 
1835
                else:
 
1836
                    new_key = self._parent_id_basename_key(entry)
 
1837
                    new_value = file_id
 
1838
                # If the two keys are the same, the value will be unchanged
 
1839
                # as its always the file id for this entry.
 
1840
                if old_key != new_key:
 
1841
                    # Transform a change into explicit delete/add preserving
 
1842
                    # a possible match on the key from a different file id.
 
1843
                    if old_key is not None:
 
1844
                        parent_id_basename_delta.setdefault(
 
1845
                            old_key, [None, None])[0] = old_key
 
1846
                    if new_key is not None:
 
1847
                        parent_id_basename_delta.setdefault(
 
1848
                            new_key, [None, None])[1] = new_value
 
1849
        # validate that deletes are complete.
 
1850
        for file_id in deletes:
 
1851
            entry = self[file_id]
 
1852
            if entry.kind != 'directory':
 
1853
                continue
 
1854
            # This loop could potentially be better by using the id_basename
 
1855
            # map to just get the child file ids.
 
1856
            for child in entry.children.values():
 
1857
                if child.file_id not in altered:
 
1858
                    raise errors.InconsistentDelta(self.id2path(child.file_id),
 
1859
                        child.file_id, "Child not deleted or reparented when "
 
1860
                        "parent deleted.")
 
1861
        result.id_to_entry.apply_delta(id_to_entry_delta)
 
1862
        if parent_id_basename_delta:
 
1863
            # Transform the parent_id_basename delta data into a linear delta
 
1864
            # with only one record for a given key. Optimally this would allow
 
1865
            # re-keying, but its simpler to just output that as a delete+add
 
1866
            # to spend less time calculating the delta.
 
1867
            delta_list = []
 
1868
            for key, (old_key, value) in parent_id_basename_delta.iteritems():
 
1869
                if value is not None:
 
1870
                    delta_list.append((old_key, key, value))
 
1871
                else:
 
1872
                    delta_list.append((old_key, None, None))
 
1873
            result.parent_id_basename_to_file_id.apply_delta(delta_list)
 
1874
        parents.discard(('', None))
 
1875
        for parent_path, parent in parents:
 
1876
            try:
 
1877
                if result[parent].kind != 'directory':
 
1878
                    raise errors.InconsistentDelta(result.id2path(parent), parent,
 
1879
                        'Not a directory, but given children')
 
1880
            except errors.NoSuchId:
 
1881
                raise errors.InconsistentDelta("<unknown>", parent,
 
1882
                    "Parent is not present in resulting inventory.")
 
1883
            if result.path2id(parent_path) != parent:
 
1884
                raise errors.InconsistentDelta(parent_path, parent,
 
1885
                    "Parent has wrong path %r." % result.path2id(parent_path))
 
1886
        return result
 
1887
 
 
1888
    @classmethod
 
1889
    def deserialise(klass, chk_store, bytes, expected_revision_id):
 
1890
        """Deserialise a CHKInventory.
 
1891
 
 
1892
        :param chk_store: A CHK capable VersionedFiles instance.
 
1893
        :param bytes: The serialised bytes.
 
1894
        :param expected_revision_id: The revision ID we think this inventory is
 
1895
            for.
 
1896
        :return: A CHKInventory
 
1897
        """
 
1898
        lines = bytes.split('\n')
 
1899
        if lines[-1] != '':
 
1900
            raise AssertionError('bytes to deserialize must end with an eol')
 
1901
        lines.pop()
 
1902
        if lines[0] != 'chkinventory:':
 
1903
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
 
1904
        info = {}
 
1905
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
 
1906
                                  'parent_id_basename_to_file_id',
 
1907
                                  'id_to_entry'])
 
1908
        for line in lines[1:]:
 
1909
            key, value = line.split(': ', 1)
 
1910
            if key not in allowed_keys:
 
1911
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
 
1912
                                      % (key, bytes))
 
1913
            if key in info:
 
1914
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
 
1915
                                      % (key, bytes))
 
1916
            info[key] = value
 
1917
        revision_id = intern(info['revision_id'])
 
1918
        root_id = intern(info['root_id'])
 
1919
        search_key_name = intern(info.get('search_key_name', 'plain'))
 
1920
        parent_id_basename_to_file_id = intern(info.get(
 
1921
            'parent_id_basename_to_file_id', None))
 
1922
        if not parent_id_basename_to_file_id.startswith('sha1:'):
 
1923
            raise ValueError('parent_id_basename_to_file_id should be a sha1'
 
1924
                             ' key not %r' % (parent_id_basename_to_file_id,))
 
1925
        id_to_entry = info['id_to_entry']
 
1926
        if not id_to_entry.startswith('sha1:'):
 
1927
            raise ValueError('id_to_entry should be a sha1'
 
1928
                             ' key not %r' % (id_to_entry,))
 
1929
 
 
1930
        result = CHKInventory(search_key_name)
 
1931
        result.revision_id = revision_id
 
1932
        result.root_id = root_id
 
1933
        search_key_func = chk_map.search_key_registry.get(
 
1934
                            result._search_key_name)
 
1935
        if parent_id_basename_to_file_id is not None:
 
1936
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
 
1937
                chk_store, StaticTuple(parent_id_basename_to_file_id,),
 
1938
                search_key_func=search_key_func)
 
1939
        else:
 
1940
            result.parent_id_basename_to_file_id = None
 
1941
 
 
1942
        result.id_to_entry = chk_map.CHKMap(chk_store,
 
1943
                                            StaticTuple(id_to_entry,),
 
1944
                                            search_key_func=search_key_func)
 
1945
        if (result.revision_id,) != expected_revision_id:
 
1946
            raise ValueError("Mismatched revision id and expected: %r, %r" %
 
1947
                (result.revision_id, expected_revision_id))
 
1948
        return result
 
1949
 
 
1950
    @classmethod
 
1951
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
 
1952
        """Create a CHKInventory from an existing inventory.
 
1953
 
 
1954
        The content of inventory is copied into the chk_store, and a
 
1955
        CHKInventory referencing that is returned.
 
1956
 
 
1957
        :param chk_store: A CHK capable VersionedFiles instance.
 
1958
        :param inventory: The inventory to copy.
 
1959
        :param maximum_size: The CHKMap node size limit.
 
1960
        :param search_key_name: The identifier for the search key function
 
1961
        """
 
1962
        result = klass(search_key_name)
 
1963
        result.revision_id = inventory.revision_id
 
1964
        result.root_id = inventory.root.file_id
 
1965
 
 
1966
        entry_to_bytes = result._entry_to_bytes
 
1967
        parent_id_basename_key = result._parent_id_basename_key
 
1968
        id_to_entry_dict = {}
 
1969
        parent_id_basename_dict = {}
 
1970
        for path, entry in inventory.iter_entries():
 
1971
            key = StaticTuple(entry.file_id,).intern()
 
1972
            id_to_entry_dict[key] = entry_to_bytes(entry)
 
1973
            p_id_key = parent_id_basename_key(entry)
 
1974
            parent_id_basename_dict[p_id_key] = entry.file_id
 
1975
 
 
1976
        result._populate_from_dicts(chk_store, id_to_entry_dict,
 
1977
            parent_id_basename_dict, maximum_size=maximum_size)
 
1978
        return result
 
1979
 
 
1980
    def _populate_from_dicts(self, chk_store, id_to_entry_dict,
 
1981
                             parent_id_basename_dict, maximum_size):
 
1982
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
 
1983
        root_key = chk_map.CHKMap.from_dict(chk_store, id_to_entry_dict,
 
1984
                   maximum_size=maximum_size, key_width=1,
 
1985
                   search_key_func=search_key_func)
 
1986
        self.id_to_entry = chk_map.CHKMap(chk_store, root_key,
 
1987
                                          search_key_func)
 
1988
        root_key = chk_map.CHKMap.from_dict(chk_store,
 
1989
                   parent_id_basename_dict,
 
1990
                   maximum_size=maximum_size, key_width=2,
 
1991
                   search_key_func=search_key_func)
 
1992
        self.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
 
1993
                                                    root_key, search_key_func)
 
1994
 
 
1995
    def _parent_id_basename_key(self, entry):
 
1996
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
 
1997
        if entry.parent_id is not None:
 
1998
            parent_id = entry.parent_id
 
1999
        else:
 
2000
            parent_id = ''
 
2001
        return StaticTuple(parent_id, entry.name.encode('utf8')).intern()
 
2002
 
 
2003
    def __getitem__(self, file_id):
 
2004
        """map a single file_id -> InventoryEntry."""
 
2005
        if file_id is None:
 
2006
            raise errors.NoSuchId(self, file_id)
 
2007
        result = self._fileid_to_entry_cache.get(file_id, None)
 
2008
        if result is not None:
 
2009
            return result
 
2010
        try:
 
2011
            return self._bytes_to_entry(
 
2012
                self.id_to_entry.iteritems([StaticTuple(file_id,)]).next()[1])
 
2013
        except StopIteration:
 
2014
            # really we're passing an inventory, not a tree...
 
2015
            raise errors.NoSuchId(self, file_id)
 
2016
 
 
2017
    def _getitems(self, file_ids):
 
2018
        """Similar to __getitem__, but lets you query for multiple.
 
2019
        
 
2020
        The returned order is undefined. And currently if an item doesn't
 
2021
        exist, it isn't included in the output.
 
2022
        """
 
2023
        result = []
 
2024
        remaining = []
 
2025
        for file_id in file_ids:
 
2026
            entry = self._fileid_to_entry_cache.get(file_id, None)
 
2027
            if entry is None:
 
2028
                remaining.append(file_id)
 
2029
            else:
 
2030
                result.append(entry)
 
2031
        file_keys = [StaticTuple(f,).intern() for f in remaining]
 
2032
        for file_key, value in self.id_to_entry.iteritems(file_keys):
 
2033
            entry = self._bytes_to_entry(value)
 
2034
            result.append(entry)
 
2035
            self._fileid_to_entry_cache[entry.file_id] = entry
 
2036
        return result
 
2037
 
 
2038
    def has_id(self, file_id):
 
2039
        # Perhaps have an explicit 'contains' method on CHKMap ?
 
2040
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
 
2041
            return True
 
2042
        return len(list(
 
2043
            self.id_to_entry.iteritems([StaticTuple(file_id,)]))) == 1
 
2044
 
 
2045
    def is_root(self, file_id):
 
2046
        return file_id == self.root_id
 
2047
 
 
2048
    def _iter_file_id_parents(self, file_id):
 
2049
        """Yield the parents of file_id up to the root."""
 
2050
        while file_id is not None:
 
2051
            try:
 
2052
                ie = self[file_id]
 
2053
            except KeyError:
 
2054
                raise errors.NoSuchId(tree=self, file_id=file_id)
 
2055
            yield ie
 
2056
            file_id = ie.parent_id
 
2057
 
 
2058
    def __iter__(self):
 
2059
        """Iterate over all file-ids."""
 
2060
        for key, _ in self.id_to_entry.iteritems():
 
2061
            yield key[-1]
 
2062
 
 
2063
    def iter_just_entries(self):
 
2064
        """Iterate over all entries.
 
2065
        
 
2066
        Unlike iter_entries(), just the entries are returned (not (path, ie))
 
2067
        and the order of entries is undefined.
 
2068
 
 
2069
        XXX: We may not want to merge this into bzr.dev.
 
2070
        """
 
2071
        for key, entry in self.id_to_entry.iteritems():
 
2072
            file_id = key[0]
 
2073
            ie = self._fileid_to_entry_cache.get(file_id, None)
 
2074
            if ie is None:
 
2075
                ie = self._bytes_to_entry(entry)
 
2076
                self._fileid_to_entry_cache[file_id] = ie
 
2077
            yield ie
 
2078
 
 
2079
    def iter_changes(self, basis):
 
2080
        """Generate a Tree.iter_changes change list between this and basis.
 
2081
 
 
2082
        :param basis: Another CHKInventory.
 
2083
        :return: An iterator over the changes between self and basis, as per
 
2084
            tree.iter_changes().
 
2085
        """
 
2086
        # We want: (file_id, (path_in_source, path_in_target),
 
2087
        # changed_content, versioned, parent, name, kind,
 
2088
        # executable)
 
2089
        for key, basis_value, self_value in \
 
2090
            self.id_to_entry.iter_changes(basis.id_to_entry):
 
2091
            file_id = key[0]
 
2092
            if basis_value is not None:
 
2093
                basis_entry = basis._bytes_to_entry(basis_value)
 
2094
                path_in_source = basis.id2path(file_id)
 
2095
                basis_parent = basis_entry.parent_id
 
2096
                basis_name = basis_entry.name
 
2097
                basis_executable = basis_entry.executable
 
2098
            else:
 
2099
                path_in_source = None
 
2100
                basis_parent = None
 
2101
                basis_name = None
 
2102
                basis_executable = None
 
2103
            if self_value is not None:
 
2104
                self_entry = self._bytes_to_entry(self_value)
 
2105
                path_in_target = self.id2path(file_id)
 
2106
                self_parent = self_entry.parent_id
 
2107
                self_name = self_entry.name
 
2108
                self_executable = self_entry.executable
 
2109
            else:
 
2110
                path_in_target = None
 
2111
                self_parent = None
 
2112
                self_name = None
 
2113
                self_executable = None
 
2114
            if basis_value is None:
 
2115
                # add
 
2116
                kind = (None, self_entry.kind)
 
2117
                versioned = (False, True)
 
2118
            elif self_value is None:
 
2119
                # delete
 
2120
                kind = (basis_entry.kind, None)
 
2121
                versioned = (True, False)
 
2122
            else:
 
2123
                kind = (basis_entry.kind, self_entry.kind)
 
2124
                versioned = (True, True)
 
2125
            changed_content = False
 
2126
            if kind[0] != kind[1]:
 
2127
                changed_content = True
 
2128
            elif kind[0] == 'file':
 
2129
                if (self_entry.text_size != basis_entry.text_size or
 
2130
                    self_entry.text_sha1 != basis_entry.text_sha1):
 
2131
                    changed_content = True
 
2132
            elif kind[0] == 'symlink':
 
2133
                if self_entry.symlink_target != basis_entry.symlink_target:
 
2134
                    changed_content = True
 
2135
            elif kind[0] == 'tree-reference':
 
2136
                if (self_entry.reference_revision !=
 
2137
                    basis_entry.reference_revision):
 
2138
                    changed_content = True
 
2139
            parent = (basis_parent, self_parent)
 
2140
            name = (basis_name, self_name)
 
2141
            executable = (basis_executable, self_executable)
 
2142
            if (not changed_content
 
2143
                and parent[0] == parent[1]
 
2144
                and name[0] == name[1]
 
2145
                and executable[0] == executable[1]):
 
2146
                # Could happen when only the revision changed for a directory
 
2147
                # for instance.
 
2148
                continue
 
2149
            yield (file_id, (path_in_source, path_in_target), changed_content,
 
2150
                versioned, parent, name, kind, executable)
 
2151
 
 
2152
    def __len__(self):
 
2153
        """Return the number of entries in the inventory."""
 
2154
        return len(self.id_to_entry)
 
2155
 
 
2156
    def _make_delta(self, old):
 
2157
        """Make an inventory delta from two inventories."""
 
2158
        if type(old) != CHKInventory:
 
2159
            return CommonInventory._make_delta(self, old)
 
2160
        delta = []
 
2161
        for key, old_value, self_value in \
 
2162
            self.id_to_entry.iter_changes(old.id_to_entry):
 
2163
            file_id = key[0]
 
2164
            if old_value is not None:
 
2165
                old_path = old.id2path(file_id)
 
2166
            else:
 
2167
                old_path = None
 
2168
            if self_value is not None:
 
2169
                entry = self._bytes_to_entry(self_value)
 
2170
                self._fileid_to_entry_cache[file_id] = entry
 
2171
                new_path = self.id2path(file_id)
 
2172
            else:
 
2173
                entry = None
 
2174
                new_path = None
 
2175
            delta.append((old_path, new_path, file_id, entry))
 
2176
        return delta
 
2177
 
 
2178
    def path2id(self, relpath):
 
2179
        """See CommonInventory.path2id()."""
 
2180
        # TODO: perhaps support negative hits?
 
2181
        result = self._path_to_fileid_cache.get(relpath, None)
 
2182
        if result is not None:
 
2183
            return result
 
2184
        if isinstance(relpath, basestring):
 
2185
            names = osutils.splitpath(relpath)
 
2186
        else:
 
2187
            names = relpath
 
2188
        current_id = self.root_id
 
2189
        if current_id is None:
 
2190
            return None
 
2191
        parent_id_index = self.parent_id_basename_to_file_id
 
2192
        cur_path = None
 
2193
        for basename in names:
 
2194
            if cur_path is None:
 
2195
                cur_path = basename
 
2196
            else:
 
2197
                cur_path = cur_path + '/' + basename
 
2198
            basename_utf8 = basename.encode('utf8')
 
2199
            file_id = self._path_to_fileid_cache.get(cur_path, None)
 
2200
            if file_id is None:
 
2201
                key_filter = [StaticTuple(current_id, basename_utf8)]
 
2202
                items = parent_id_index.iteritems(key_filter)
 
2203
                for (parent_id, name_utf8), file_id in items:
 
2204
                    if parent_id != current_id or name_utf8 != basename_utf8:
 
2205
                        raise errors.BzrError("corrupt inventory lookup! "
 
2206
                            "%r %r %r %r" % (parent_id, current_id, name_utf8,
 
2207
                            basename_utf8))
 
2208
                if file_id is None:
 
2209
                    return None
 
2210
                else:
 
2211
                    self._path_to_fileid_cache[cur_path] = file_id
 
2212
            current_id = file_id
 
2213
        return current_id
 
2214
 
 
2215
    def to_lines(self):
 
2216
        """Serialise the inventory to lines."""
 
2217
        lines = ["chkinventory:\n"]
 
2218
        if self._search_key_name != 'plain':
 
2219
            # custom ordering grouping things that don't change together
 
2220
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
 
2221
            lines.append("root_id: %s\n" % self.root_id)
 
2222
            lines.append('parent_id_basename_to_file_id: %s\n' %
 
2223
                (self.parent_id_basename_to_file_id.key()[0],))
 
2224
            lines.append("revision_id: %s\n" % self.revision_id)
 
2225
            lines.append("id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
 
2226
        else:
 
2227
            lines.append("revision_id: %s\n" % self.revision_id)
 
2228
            lines.append("root_id: %s\n" % self.root_id)
 
2229
            if self.parent_id_basename_to_file_id is not None:
 
2230
                lines.append('parent_id_basename_to_file_id: %s\n' %
 
2231
                    (self.parent_id_basename_to_file_id.key()[0],))
 
2232
            lines.append("id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
 
2233
        return lines
 
2234
 
 
2235
    @property
 
2236
    def root(self):
 
2237
        """Get the root entry."""
 
2238
        return self[self.root_id]
 
2239
 
 
2240
 
 
2241
class CHKInventoryDirectory(InventoryDirectory):
 
2242
    """A directory in an inventory."""
 
2243
 
 
2244
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
2245
                 'text_id', 'parent_id', '_children', 'executable',
 
2246
                 'revision', 'symlink_target', 'reference_revision',
 
2247
                 '_chk_inventory']
 
2248
 
 
2249
    def __init__(self, file_id, name, parent_id, chk_inventory):
 
2250
        # Don't call InventoryDirectory.__init__ - it isn't right for this
 
2251
        # class.
 
2252
        InventoryEntry.__init__(self, file_id, name, parent_id)
 
2253
        self._children = None
 
2254
        self.kind = 'directory'
 
2255
        self._chk_inventory = chk_inventory
 
2256
 
 
2257
    @property
 
2258
    def children(self):
 
2259
        """Access the list of children of this directory.
 
2260
 
 
2261
        With a parent_id_basename_to_file_id index, loads all the children,
 
2262
        without loads the entire index. Without is bad. A more sophisticated
 
2263
        proxy object might be nice, to allow partial loading of children as
 
2264
        well when specific names are accessed. (So path traversal can be
 
2265
        written in the obvious way but not examine siblings.).
 
2266
        """
 
2267
        if self._children is not None:
 
2268
            return self._children
 
2269
        # No longer supported
 
2270
        if self._chk_inventory.parent_id_basename_to_file_id is None:
 
2271
            raise AssertionError("Inventories without"
 
2272
                " parent_id_basename_to_file_id are no longer supported")
 
2273
        result = {}
 
2274
        # XXX: Todo - use proxy objects for the children rather than loading
 
2275
        # all when the attribute is referenced.
 
2276
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
 
2277
        child_keys = set()
 
2278
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
 
2279
            key_filter=[StaticTuple(self.file_id,)]):
 
2280
            child_keys.add(StaticTuple(file_id,))
 
2281
        cached = set()
 
2282
        for file_id_key in child_keys:
 
2283
            entry = self._chk_inventory._fileid_to_entry_cache.get(
 
2284
                file_id_key[0], None)
 
2285
            if entry is not None:
 
2286
                result[entry.name] = entry
 
2287
                cached.add(file_id_key)
 
2288
        child_keys.difference_update(cached)
 
2289
        # populate; todo: do by name
 
2290
        id_to_entry = self._chk_inventory.id_to_entry
 
2291
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
 
2292
            entry = self._chk_inventory._bytes_to_entry(bytes)
 
2293
            result[entry.name] = entry
 
2294
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
 
2295
        self._children = result
 
2296
        return result
2527
2297
 
2528
2298
entry_factory = {
2529
2299
    'directory': InventoryDirectory,
2546
2316
    try:
2547
2317
        factory = entry_factory[kind]
2548
2318
    except KeyError:
2549
 
        raise BzrError("unknown kind %r" % kind)
 
2319
        raise errors.BadFileKindError(name, kind)
2550
2320
    return factory(file_id, name, parent_id)
2551
2321
 
2552
2322
 
2580
2350
        _NAME_RE = re.compile(r'^[^/\\]+$')
2581
2351
 
2582
2352
    return bool(_NAME_RE.match(name))
 
2353
 
 
2354
 
 
2355
def _check_delta_unique_ids(delta):
 
2356
    """Decorate a delta and check that the file ids in it are unique.
 
2357
 
 
2358
    :return: A generator over delta.
 
2359
    """
 
2360
    ids = set()
 
2361
    for item in delta:
 
2362
        length = len(ids) + 1
 
2363
        ids.add(item[2])
 
2364
        if len(ids) != length:
 
2365
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2366
                "repeated file_id")
 
2367
        yield item
 
2368
 
 
2369
 
 
2370
def _check_delta_unique_new_paths(delta):
 
2371
    """Decorate a delta and check that the new paths in it are unique.
 
2372
 
 
2373
    :return: A generator over delta.
 
2374
    """
 
2375
    paths = set()
 
2376
    for item in delta:
 
2377
        length = len(paths) + 1
 
2378
        path = item[1]
 
2379
        if path is not None:
 
2380
            paths.add(path)
 
2381
            if len(paths) != length:
 
2382
                raise errors.InconsistentDelta(path, item[2], "repeated path")
 
2383
        yield item
 
2384
 
 
2385
 
 
2386
def _check_delta_unique_old_paths(delta):
 
2387
    """Decorate a delta and check that the old paths in it are unique.
 
2388
 
 
2389
    :return: A generator over delta.
 
2390
    """
 
2391
    paths = set()
 
2392
    for item in delta:
 
2393
        length = len(paths) + 1
 
2394
        path = item[0]
 
2395
        if path is not None:
 
2396
            paths.add(path)
 
2397
            if len(paths) != length:
 
2398
                raise errors.InconsistentDelta(path, item[2], "repeated path")
 
2399
        yield item
 
2400
 
 
2401
 
 
2402
def _check_delta_ids_are_valid(delta):
 
2403
    """Decorate a delta and check that the ids in it are valid.
 
2404
 
 
2405
    :return: A generator over delta.
 
2406
    """
 
2407
    for item in delta:
 
2408
        entry = item[3]
 
2409
        if item[2] is None:
 
2410
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2411
                "entry with file_id None %r" % entry)
 
2412
        if type(item[2]) != str:
 
2413
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2414
                "entry with non bytes file_id %r" % entry)
 
2415
        yield item
 
2416
 
 
2417
 
 
2418
def _check_delta_ids_match_entry(delta):
 
2419
    """Decorate a delta and check that the ids in it match the entry.file_id.
 
2420
 
 
2421
    :return: A generator over delta.
 
2422
    """
 
2423
    for item in delta:
 
2424
        entry = item[3]
 
2425
        if entry is not None:
 
2426
            if entry.file_id != item[2]:
 
2427
                raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2428
                    "mismatched id with %r" % entry)
 
2429
        yield item
 
2430
 
 
2431
 
 
2432
def _check_delta_new_path_entry_both_or_None(delta):
 
2433
    """Decorate a delta and check that the new_path and entry are paired.
 
2434
 
 
2435
    :return: A generator over delta.
 
2436
    """
 
2437
    for item in delta:
 
2438
        new_path = item[1]
 
2439
        entry = item[3]
 
2440
        if new_path is None and entry is not None:
 
2441
            raise errors.InconsistentDelta(item[0], item[1],
 
2442
                "Entry with no new_path")
 
2443
        if new_path is not None and entry is None:
 
2444
            raise errors.InconsistentDelta(new_path, item[1],
 
2445
                "new_path with no entry")
 
2446
        yield item