~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-11-04 14:33:19 UTC
  • Revision ID: robertc@robertcollins.net-20051104143319-5293770efa92f56d
Remove some unneeded shebangs.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# FIXME: This refactoring of the workingtree code doesn't seem to keep
 
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep 
18
18
# the WorkingTree's copy of the inventory in sync with the branch.  The
19
19
# branch modifies its working inventory when it does a commit to make
20
20
# missing files permanently removed.
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
from copy import deepcopy
31
30
 
32
 
from bzrlib.lazy_import import lazy_import
33
 
lazy_import(globals(), """
34
 
import collections
35
 
import os
 
31
import os.path
36
32
import re
 
33
import sys
37
34
import tarfile
 
35
import types
38
36
 
39
37
import bzrlib
40
 
from bzrlib import (
41
 
    chk_map,
42
 
    errors,
43
 
    generate_ids,
44
 
    osutils,
45
 
    symbol_versioning,
46
 
    workingtree,
47
 
    )
48
 
""")
49
 
 
50
 
from bzrlib.errors import (
51
 
    BzrCheckError,
52
 
    BzrError,
53
 
    )
54
 
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
 
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
39
                            appendpath, sha_strings)
55
40
from bzrlib.trace import mutter
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError)
56
43
 
57
44
 
58
45
class InventoryEntry(object):
70
57
        file_id of the parent directory, or ROOT_ID
71
58
 
72
59
    revision
73
 
        the revision_id in which this variation of this file was
 
60
        the revision_id in which this variation of this file was 
74
61
        introduced.
75
62
 
76
63
    executable
79
66
 
80
67
    text_sha1
81
68
        sha-1 of the text of the file
82
 
 
 
69
        
83
70
    text_size
84
71
        size in bytes of the text of the file
85
 
 
 
72
        
86
73
    (reading a version 4 tree created a text_id field.)
87
74
 
88
75
    >>> i = Inventory()
89
76
    >>> i.path2id('')
90
77
    'TREE_ROOT'
91
78
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
92
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
 
79
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
93
80
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
94
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
95
 
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
96
 
    >>> for ix, j in enumerate(i.iter_entries()):
97
 
    ...   print (j[0] == shouldbe[ix], j[1])
 
81
    InventoryFile('2323', 'hello.c', parent_id='123')
 
82
    >>> for j in i.iter_entries():
 
83
    ...   print j
 
84
    ... 
 
85
    ('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
86
    ('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
 
87
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
88
    Traceback (most recent call last):
98
89
    ...
99
 
    (True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
100
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
101
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
 
90
    BzrError: inventory already contains entry with id {2323}
102
91
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
103
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
 
92
    InventoryFile('2324', 'bye.c', parent_id='123')
104
93
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
105
 
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
 
94
    InventoryDirectory('2325', 'wibble', parent_id='123')
106
95
    >>> i.path2id('src/wibble')
107
96
    '2325'
108
97
    >>> '2325' in i
109
98
    True
110
99
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
111
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
 
100
    InventoryFile('2326', 'wibble.c', parent_id='2325')
112
101
    >>> i['2326']
113
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
 
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
114
103
    >>> for path, entry in i.iter_entries():
115
 
    ...     print path
116
 
    ...
117
 
    <BLANKLINE>
 
104
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
 
105
    ...     assert i.path2id(path)
 
106
    ... 
118
107
    src
119
108
    src/bye.c
120
109
    src/hello.c
121
110
    src/wibble
122
111
    src/wibble/wibble.c
123
 
    >>> i.id2path('2326')
 
112
    >>> i.id2path('2326').replace('\\\\', '/')
124
113
    'src/wibble/wibble.c'
125
114
    """
126
 
 
127
 
    # Constants returned by describe_change()
128
 
    #
129
 
    # TODO: These should probably move to some kind of FileChangeDescription
130
 
    # class; that's like what's inside a TreeDelta but we want to be able to
131
 
    # generate them just for one file at a time.
132
 
    RENAMED = 'renamed'
133
 
    MODIFIED_AND_RENAMED = 'modified and renamed'
134
 
 
135
 
    __slots__ = []
 
115
    
 
116
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
117
                 'text_id', 'parent_id', 'children', 'executable', 
 
118
                 'revision']
 
119
 
 
120
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
 
121
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
 
122
                             transaction)
136
123
 
137
124
    def detect_changes(self, old_entry):
138
125
        """Return a (text_modified, meta_modified) from this to old_entry.
139
 
 
140
 
        _read_tree_state must have been called on self and old_entry prior to
 
126
        
 
127
        _read_tree_state must have been called on self and old_entry prior to 
141
128
        calling detect_changes.
142
129
        """
143
130
        return False, False
144
131
 
 
132
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
133
             output_to, reverse=False):
 
134
        """Perform a diff from this to to_entry.
 
135
 
 
136
        text_diff will be used for textual difference calculation.
 
137
        This is a template method, override _diff in child classes.
 
138
        """
 
139
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
140
        if to_entry:
 
141
            # cannot diff from one kind to another - you must do a removal
 
142
            # and an addif they do not match.
 
143
            assert self.kind == to_entry.kind
 
144
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
145
                                      to_tree)
 
146
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
147
                   output_to, reverse)
 
148
 
145
149
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
146
150
             output_to, reverse=False):
147
151
        """Perform a diff between two entries of the same kind."""
148
152
 
149
 
    def parent_candidates(self, previous_inventories):
150
 
        """Find possible per-file graph parents.
151
 
 
152
 
        This is currently defined by:
153
 
         - Select the last changed revision in the parent inventory.
154
 
         - Do deal with a short lived bug in bzr 0.8's development two entries
155
 
           that have the same last changed but different 'x' bit settings are
156
 
           changed in-place.
 
153
    def find_previous_heads(self, previous_inventories, entry_weave):
 
154
        """Return the revisions and entries that directly preceed this.
 
155
 
 
156
        Returned as a map from revision to inventory entry.
 
157
 
 
158
        This is a map containing the file revisions in all parents
 
159
        for which the file exists, and its revision is not a parent of
 
160
        any other. If the file is new, the set will be empty.
157
161
        """
158
 
        # revision:ie mapping for each ie found in previous_inventories.
159
 
        candidates = {}
160
 
        # identify candidate head revision ids.
 
162
        def get_ancestors(weave, entry):
 
163
            return set(map(weave.idx_to_name,
 
164
                           weave.inclusions([weave.lookup(entry.revision)])))
 
165
        heads = {}
 
166
        head_ancestors = {}
161
167
        for inv in previous_inventories:
162
168
            if self.file_id in inv:
163
169
                ie = inv[self.file_id]
164
 
                if ie.revision in candidates:
165
 
                    # same revision value in two different inventories:
166
 
                    # correct possible inconsistencies:
167
 
                    #     * there was a bug in revision updates with 'x' bit
168
 
                    #       support.
 
170
                assert ie.file_id == self.file_id
 
171
                if ie.revision in heads:
 
172
                    # fixup logic, there was a bug in revision updates.
 
173
                    # with x bit support.
169
174
                    try:
170
 
                        if candidates[ie.revision].executable != ie.executable:
171
 
                            candidates[ie.revision].executable = False
 
175
                        if heads[ie.revision].executable != ie.executable:
 
176
                            heads[ie.revision].executable = False
172
177
                            ie.executable = False
173
178
                    except AttributeError:
174
179
                        pass
 
180
                    assert heads[ie.revision] == ie
175
181
                else:
176
 
                    # add this revision as a candidate.
177
 
                    candidates[ie.revision] = ie
178
 
        return candidates
 
182
                    # may want to add it.
 
183
                    # may already be covered:
 
184
                    already_present = 0 != len(
 
185
                        [head for head in heads 
 
186
                         if ie.revision in head_ancestors[head]])
 
187
                    if already_present:
 
188
                        # an ancestor of a known head.
 
189
                        continue
 
190
                    # definately a head:
 
191
                    ancestors = get_ancestors(entry_weave, ie)
 
192
                    # may knock something else out:
 
193
                    check_heads = list(heads.keys())
 
194
                    for head in check_heads:
 
195
                        if head in ancestors:
 
196
                            # this head is not really a head
 
197
                            heads.pop(head)
 
198
                    head_ancestors[ie.revision] = ancestors
 
199
                    heads[ie.revision] = ie
 
200
        return heads
179
201
 
180
 
    @deprecated_method(deprecated_in((1, 6, 0)))
181
202
    def get_tar_item(self, root, dp, now, tree):
182
203
        """Get a tarfile item and a file stream for its content."""
183
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
 
204
        item = tarfile.TarInfo(os.path.join(root, dp))
184
205
        # TODO: would be cool to actually set it to the timestamp of the
185
206
        # revision it was last changed
186
207
        item.mtime = now
200
221
 
201
222
    def __init__(self, file_id, name, parent_id, text_id=None):
202
223
        """Create an InventoryEntry
203
 
 
 
224
        
204
225
        The filename must be a single component, relative to the
205
226
        parent directory; it cannot be a whole path or relative name.
206
227
 
213
234
        Traceback (most recent call last):
214
235
        InvalidEntryName: Invalid entry name: src/hello.c
215
236
        """
 
237
        assert isinstance(name, basestring), name
216
238
        if '/' in name or '\\' in name:
217
 
            raise errors.InvalidEntryName(name=name)
 
239
            raise InvalidEntryName(name=name)
218
240
        self.executable = False
219
241
        self.revision = None
220
242
        self.text_sha1 = None
224
246
        self.text_id = text_id
225
247
        self.parent_id = parent_id
226
248
        self.symlink_target = None
227
 
        self.reference_revision = None
228
249
 
229
250
    def kind_character(self):
230
251
        """Return a short kind indicator useful for appending to names."""
231
252
        raise BzrError('unknown kind %r' % self.kind)
232
253
 
233
 
    known_kinds = ('file', 'directory', 'symlink')
 
254
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
234
255
 
235
256
    def _put_in_tar(self, item, tree):
236
257
        """populate item for stashing in a tar, and return the content stream.
240
261
        raise BzrError("don't know how to export {%s} of kind %r" %
241
262
                       (self.file_id, self.kind))
242
263
 
243
 
    @deprecated_method(deprecated_in((1, 6, 0)))
244
264
    def put_on_disk(self, dest, dp, tree):
245
265
        """Create a representation of self on disk in the prefix dest.
246
 
 
 
266
        
247
267
        This is a template method - implement _put_on_disk in subclasses.
248
268
        """
249
 
        fullpath = osutils.pathjoin(dest, dp)
 
269
        fullpath = appendpath(dest, dp)
250
270
        self._put_on_disk(fullpath, tree)
251
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
252
 
        #         self.kind, fullpath)
 
271
        mutter("  export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
253
272
 
254
273
    def _put_on_disk(self, fullpath, tree):
255
274
        """Put this entry onto disk at fullpath, from tree tree."""
256
275
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
257
276
 
258
277
    def sorted_children(self):
259
 
        return sorted(self.children.items())
 
278
        l = self.children.items()
 
279
        l.sort()
 
280
        return l
260
281
 
261
282
    @staticmethod
262
283
    def versionable_kind(kind):
263
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
284
        return kind in ('file', 'directory', 'symlink')
264
285
 
265
286
    def check(self, checker, rev_id, inv, tree):
266
287
        """Check this inventory entry is intact.
267
288
 
268
289
        This is a template method, override _check for kind specific
269
290
        tests.
270
 
 
271
 
        :param checker: Check object providing context for the checks;
272
 
             can be used to find out what parts of the repository have already
273
 
             been checked.
274
 
        :param rev_id: Revision id from which this InventoryEntry was loaded.
275
 
             Not necessarily the last-changed revision for this file.
276
 
        :param inv: Inventory from which the entry was loaded.
277
 
        :param tree: RevisionTree for this entry.
278
291
        """
279
 
        if self.parent_id is not None:
 
292
        if self.parent_id != None:
280
293
            if not inv.has_id(self.parent_id):
281
294
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
282
295
                        % (self.parent_id, rev_id))
284
297
 
285
298
    def _check(self, checker, rev_id, tree):
286
299
        """Check this inventory entry for kind specific errors."""
287
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' %
 
300
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
288
301
                            (self.kind, rev_id))
289
302
 
 
303
 
290
304
    def copy(self):
291
305
        """Clone this inventory entry."""
292
306
        raise NotImplementedError
293
307
 
294
 
    @staticmethod
295
 
    def describe_change(old_entry, new_entry):
296
 
        """Describe the change between old_entry and this.
297
 
 
298
 
        This smells of being an InterInventoryEntry situation, but as its
299
 
        the first one, we're making it a static method for now.
300
 
 
301
 
        An entry with a different parent, or different name is considered
302
 
        to be renamed. Reparenting is an internal detail.
303
 
        Note that renaming the parent does not trigger a rename for the
304
 
        child entry itself.
305
 
        """
306
 
        # TODO: Perhaps return an object rather than just a string
307
 
        if old_entry is new_entry:
308
 
            # also the case of both being None
309
 
            return 'unchanged'
310
 
        elif old_entry is None:
 
308
    def _get_snapshot_change(self, previous_entries):
 
309
        if len(previous_entries) > 1:
 
310
            return 'merged'
 
311
        elif len(previous_entries) == 0:
311
312
            return 'added'
312
 
        elif new_entry is None:
313
 
            return 'removed'
314
 
        if old_entry.kind != new_entry.kind:
315
 
            return 'modified'
316
 
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
317
 
        if text_modified or meta_modified:
318
 
            modified = True
319
 
        else:
320
 
            modified = False
321
 
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
322
 
        if old_entry.parent_id != new_entry.parent_id:
323
 
            renamed = True
324
 
        elif old_entry.name != new_entry.name:
325
 
            renamed = True
326
 
        else:
327
 
            renamed = False
328
 
        if renamed and not modified:
329
 
            return InventoryEntry.RENAMED
330
 
        if modified and not renamed:
331
 
            return 'modified'
332
 
        if modified and renamed:
333
 
            return InventoryEntry.MODIFIED_AND_RENAMED
334
 
        return 'unchanged'
 
313
        else:
 
314
            return 'modified/renamed/reparented'
335
315
 
336
316
    def __repr__(self):
337
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
317
        return ("%s(%r, %r, parent_id=%r)"
338
318
                % (self.__class__.__name__,
339
319
                   self.file_id,
340
320
                   self.name,
341
 
                   self.parent_id,
342
 
                   self.revision))
 
321
                   self.parent_id))
 
322
 
 
323
    def snapshot(self, revision, path, previous_entries,
 
324
                 work_tree, weave_store, transaction):
 
325
        """Make a snapshot of this entry which may or may not have changed.
 
326
        
 
327
        This means that all its fields are populated, that it has its
 
328
        text stored in the text store or weave.
 
329
        """
 
330
        mutter('new parents of %s are %r', path, previous_entries)
 
331
        self._read_tree_state(path, work_tree)
 
332
        if len(previous_entries) == 1:
 
333
            # cannot be unchanged unless there is only one parent file rev.
 
334
            parent_ie = previous_entries.values()[0]
 
335
            if self._unchanged(parent_ie):
 
336
                mutter("found unchanged entry")
 
337
                self.revision = parent_ie.revision
 
338
                return "unchanged"
 
339
        return self.snapshot_revision(revision, previous_entries, 
 
340
                                      work_tree, weave_store, transaction)
 
341
 
 
342
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
343
                          weave_store, transaction):
 
344
        """Record this revision unconditionally."""
 
345
        mutter('new revision for {%s}', self.file_id)
 
346
        self.revision = revision
 
347
        change = self._get_snapshot_change(previous_entries)
 
348
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
349
                            transaction)
 
350
        return change
 
351
 
 
352
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
353
        """Record the 'text' of this entry, whatever form that takes.
 
354
        
 
355
        This default implementation simply adds an empty text.
 
356
        """
 
357
        mutter('storing file {%s} in revision {%s}',
 
358
               self.file_id, self.revision)
 
359
        self._add_text_to_weave([], file_parents, weave_store, transaction)
343
360
 
344
361
    def __eq__(self, other):
345
 
        if other is self:
346
 
            # For the case when objects are cached
347
 
            return True
348
362
        if not isinstance(other, InventoryEntry):
349
363
            return NotImplemented
350
364
 
358
372
                and (self.kind == other.kind)
359
373
                and (self.revision == other.revision)
360
374
                and (self.executable == other.executable)
361
 
                and (self.reference_revision == other.reference_revision)
362
375
                )
363
376
 
364
377
    def __ne__(self, other):
370
383
    def _unchanged(self, previous_ie):
371
384
        """Has this entry changed relative to previous_ie.
372
385
 
373
 
        This method should be overridden in child classes.
 
386
        This method should be overriden in child classes.
374
387
        """
375
388
        compatible = True
376
389
        # different inv parent
379
392
        # renamed
380
393
        elif previous_ie.name != self.name:
381
394
            compatible = False
382
 
        elif previous_ie.kind != self.kind:
383
 
            compatible = False
384
395
        return compatible
385
396
 
386
397
    def _read_tree_state(self, path, work_tree):
387
398
        """Populate fields in the inventory entry from the given tree.
388
 
 
 
399
        
389
400
        Note that this should be modified to be a noop on virtual trees
390
401
        as all entries created there are prepopulated.
391
402
        """
392
 
        # TODO: Rather than running this manually, we should check the
 
403
        # TODO: Rather than running this manually, we should check the 
393
404
        # working sha1 and other expensive properties when they're
394
405
        # first requested, or preload them if they're already known
395
406
        pass            # nothing to do by default
396
407
 
397
 
    def _forget_tree_state(self):
398
 
        pass
399
 
 
400
408
 
401
409
class RootEntry(InventoryEntry):
402
410
 
403
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
404
 
                 'text_id', 'parent_id', 'children', 'executable',
405
 
                 'revision', 'symlink_target', 'reference_revision']
406
 
 
407
411
    def _check(self, checker, rev_id, tree):
408
412
        """See InventoryEntry._check"""
409
413
 
410
414
    def __init__(self, file_id):
411
415
        self.file_id = file_id
412
416
        self.children = {}
413
 
        self.kind = 'directory'
 
417
        self.kind = 'root_directory'
414
418
        self.parent_id = None
415
 
        self.name = u''
416
 
        self.revision = None
417
 
        symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
418
 
                               '  Please use InventoryDirectory instead.',
419
 
                               DeprecationWarning, stacklevel=2)
 
419
        self.name = ''
420
420
 
421
421
    def __eq__(self, other):
422
422
        if not isinstance(other, RootEntry):
423
423
            return NotImplemented
424
 
 
 
424
        
425
425
        return (self.file_id == other.file_id) \
426
426
               and (self.children == other.children)
427
427
 
429
429
class InventoryDirectory(InventoryEntry):
430
430
    """A directory in an inventory."""
431
431
 
432
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
433
 
                 'text_id', 'parent_id', 'children', 'executable',
434
 
                 'revision', 'symlink_target', 'reference_revision']
435
 
 
436
432
    def _check(self, checker, rev_id, tree):
437
433
        """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:
 
434
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
439
435
            raise BzrCheckError('directory {%s} has text in revision {%s}'
440
436
                                % (self.file_id, rev_id))
441
437
 
472
468
class InventoryFile(InventoryEntry):
473
469
    """A file in an inventory."""
474
470
 
475
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
476
 
                 'text_id', 'parent_id', 'children', 'executable',
477
 
                 'revision', 'symlink_target', 'reference_revision']
478
 
 
479
 
    def _check(self, checker, tree_revision_id, tree):
 
471
    def _check(self, checker, rev_id, tree):
480
472
        """See InventoryEntry._check"""
481
 
        key = (self.file_id, self.revision)
482
 
        if key in checker.checked_texts:
483
 
            prev_sha = checker.checked_texts[key]
 
473
        revision = self.revision
 
474
        t = (self.file_id, revision)
 
475
        if t in checker.checked_texts:
 
476
            prev_sha = checker.checked_texts[t] 
484
477
            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))
 
478
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
479
                                    (self.file_id, rev_id))
489
480
            else:
490
481
                checker.repeated_text_cnt += 1
491
482
                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
 
483
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
484
        file_lines = tree.get_file_lines(self.file_id)
 
485
        checker.checked_text_cnt += 1 
 
486
        if self.text_size != sum(map(len, file_lines)):
 
487
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
488
        if self.text_sha1 != sha_strings(file_lines):
 
489
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
490
        checker.checked_texts[t] = self.text_sha1
500
491
 
501
492
    def copy(self):
502
493
        other = InventoryFile(self.file_id, self.name, self.parent_id)
509
500
 
510
501
    def detect_changes(self, old_entry):
511
502
        """See InventoryEntry.detect_changes."""
 
503
        assert self.text_sha1 != None
 
504
        assert old_entry.text_sha1 != None
512
505
        text_modified = (self.text_sha1 != old_entry.text_sha1)
513
506
        meta_modified = (self.executable != old_entry.executable)
514
507
        return text_modified, meta_modified
516
509
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
517
510
             output_to, reverse=False):
518
511
        """See InventoryEntry._diff."""
519
 
        from bzrlib.diff import DiffText
520
 
        from_file_id = self.file_id
 
512
        from_text = tree.get_file(self.file_id).readlines()
521
513
        if to_entry:
522
 
            to_file_id = to_entry.file_id
523
 
        else:
524
 
            to_file_id = None
525
 
        if reverse:
526
 
            to_file_id, from_file_id = from_file_id, to_file_id
527
 
            tree, to_tree = to_tree, tree
528
 
            from_label, to_label = to_label, from_label
529
 
        differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
530
 
                          text_diff)
531
 
        return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
 
514
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
515
        else:
 
516
            to_text = []
 
517
        if not reverse:
 
518
            text_diff(from_label, from_text,
 
519
                      to_label, to_text, output_to)
 
520
        else:
 
521
            text_diff(to_label, to_text,
 
522
                      from_label, from_text, output_to)
532
523
 
533
524
    def has_text(self):
534
525
        """See InventoryEntry.has_text."""
555
546
 
556
547
    def _put_on_disk(self, fullpath, tree):
557
548
        """See InventoryEntry._put_on_disk."""
558
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
549
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
559
550
        if tree.is_executable(self.file_id):
560
551
            os.chmod(fullpath, 0755)
561
552
 
562
553
    def _read_tree_state(self, path, work_tree):
563
554
        """See InventoryEntry._read_tree_state."""
564
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
565
 
        # FIXME: 20050930 probe for the text size when getting sha1
566
 
        # in _read_tree_state
567
 
        self.executable = work_tree.is_executable(self.file_id, path=path)
568
 
 
569
 
    def __repr__(self):
570
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s, revision=%s)"
571
 
                % (self.__class__.__name__,
572
 
                   self.file_id,
573
 
                   self.name,
574
 
                   self.parent_id,
575
 
                   self.text_sha1,
576
 
                   self.text_size,
577
 
                   self.revision))
578
 
 
579
 
    def _forget_tree_state(self):
580
 
        self.text_sha1 = None
 
555
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
556
        self.executable = work_tree.is_executable(self.file_id)
 
557
 
 
558
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
559
        """See InventoryEntry._snapshot_text."""
 
560
        mutter('storing file {%s} in revision {%s}',
 
561
               self.file_id, self.revision)
 
562
        # special case to avoid diffing on renames or 
 
563
        # reparenting
 
564
        if (len(file_parents) == 1
 
565
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
566
            and self.text_size == file_parents.values()[0].text_size):
 
567
            previous_ie = file_parents.values()[0]
 
568
            weave_store.add_identical_text(
 
569
                self.file_id, previous_ie.revision, 
 
570
                self.revision, file_parents, transaction)
 
571
        else:
 
572
            new_lines = work_tree.get_file(self.file_id).readlines()
 
573
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
574
                                    transaction)
 
575
            self.text_sha1 = sha_strings(new_lines)
 
576
            self.text_size = sum(map(len, new_lines))
 
577
 
581
578
 
582
579
    def _unchanged(self, previous_ie):
583
580
        """See InventoryEntry._unchanged."""
596
593
class InventoryLink(InventoryEntry):
597
594
    """A file in an inventory."""
598
595
 
599
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
600
 
                 'text_id', 'parent_id', 'children', 'executable',
601
 
                 'revision', 'symlink_target', 'reference_revision']
 
596
    __slots__ = ['symlink_target']
602
597
 
603
598
    def _check(self, checker, rev_id, tree):
604
599
        """See InventoryEntry._check"""
605
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
600
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
606
601
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
607
602
                    % (self.file_id, rev_id))
608
 
        if self.symlink_target is None:
 
603
        if self.symlink_target == None:
609
604
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
610
605
                    % (self.file_id, rev_id))
611
606
 
627
622
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
628
623
             output_to, reverse=False):
629
624
        """See InventoryEntry._diff."""
630
 
        from bzrlib.diff import DiffSymlink
631
 
        old_target = self.symlink_target
 
625
        from_text = self.symlink_target
632
626
        if to_entry is not None:
633
 
            new_target = to_entry.symlink_target
634
 
        else:
635
 
            new_target = None
636
 
        if not reverse:
637
 
            old_tree = tree
638
 
            new_tree = to_tree
639
 
        else:
640
 
            old_tree = to_tree
641
 
            new_tree = tree
642
 
            new_target, old_target = old_target, new_target
643
 
        differ = DiffSymlink(old_tree, new_tree, output_to)
644
 
        return differ.diff_symlink(old_target, new_target)
 
627
            to_text = to_entry.symlink_target
 
628
            if reverse:
 
629
                temp = from_text
 
630
                from_text = to_text
 
631
                to_text = temp
 
632
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
633
        else:
 
634
            if not reverse:
 
635
                print >>output_to, '=== target was %r' % self.symlink_target
 
636
            else:
 
637
                print >>output_to, '=== target is %r' % self.symlink_target
645
638
 
646
639
    def __init__(self, file_id, name, parent_id):
647
640
        super(InventoryLink, self).__init__(file_id, name, parent_id)
653
646
 
654
647
    def _put_in_tar(self, item, tree):
655
648
        """See InventoryEntry._put_in_tar."""
656
 
        item.type = tarfile.SYMTYPE
 
649
        iterm.type = tarfile.SYMTYPE
657
650
        fileobj = None
658
651
        item.size = 0
659
652
        item.mode = 0755
671
664
        """See InventoryEntry._read_tree_state."""
672
665
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
673
666
 
674
 
    def _forget_tree_state(self):
675
 
        self.symlink_target = None
676
 
 
677
667
    def _unchanged(self, previous_ie):
678
668
        """See InventoryEntry._unchanged."""
679
669
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
682
672
        return compatible
683
673
 
684
674
 
685
 
class TreeReference(InventoryEntry):
686
 
 
687
 
    kind = 'tree-reference'
688
 
 
689
 
    def __init__(self, file_id, name, parent_id, revision=None,
690
 
                 reference_revision=None):
691
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
692
 
        self.revision = revision
693
 
        self.reference_revision = reference_revision
694
 
 
695
 
    def copy(self):
696
 
        return TreeReference(self.file_id, self.name, self.parent_id,
697
 
                             self.revision, self.reference_revision)
698
 
 
699
 
    def _read_tree_state(self, path, work_tree):
700
 
        """Populate fields in the inventory entry from the given tree.
701
 
        """
702
 
        self.reference_revision = work_tree.get_reference_revision(
703
 
            self.file_id, path)
704
 
 
705
 
    def _forget_tree_state(self):
706
 
        self.reference_revision = None
707
 
 
708
 
    def _unchanged(self, previous_ie):
709
 
        """See InventoryEntry._unchanged."""
710
 
        compatible = super(TreeReference, self)._unchanged(previous_ie)
711
 
        if self.reference_revision != previous_ie.reference_revision:
712
 
            compatible = False
713
 
        return compatible
714
 
 
715
 
 
716
 
class CommonInventory(object):
717
 
    """Basic inventory logic, defined in terms of primitives like has_id."""
718
 
 
719
 
    def __contains__(self, file_id):
720
 
        """True if this entry contains a file with given id.
721
 
 
722
 
        >>> inv = Inventory()
723
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
724
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
725
 
        >>> '123' in inv
726
 
        True
727
 
        >>> '456' in inv
728
 
        False
729
 
 
730
 
        Note that this method along with __iter__ are not encouraged for use as
731
 
        they are less clear than specific query methods - they may be rmeoved
732
 
        in the future.
733
 
        """
734
 
        return self.has_id(file_id)
735
 
 
736
 
    def id2path(self, file_id):
737
 
        """Return as a string the path to file_id.
738
 
 
739
 
        >>> i = Inventory()
740
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
741
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
742
 
        >>> print i.id2path('foo-id')
743
 
        src/foo.c
744
 
        """
745
 
        # get all names, skipping root
746
 
        return '/'.join(reversed(
747
 
            [parent.name for parent in
748
 
             self._iter_file_id_parents(file_id)][:-1]))
749
 
 
750
 
    def iter_entries(self, from_dir=None):
751
 
        """Return (path, entry) pairs, in order by name."""
752
 
        if from_dir is None:
753
 
            if self.root is None:
754
 
                return
755
 
            from_dir = self.root
756
 
            yield '', self.root
757
 
        elif isinstance(from_dir, basestring):
758
 
            from_dir = self[from_dir]
759
 
 
760
 
        # unrolling the recursive called changed the time from
761
 
        # 440ms/663ms (inline/total) to 116ms/116ms
762
 
        children = from_dir.children.items()
763
 
        children.sort()
764
 
        children = collections.deque(children)
765
 
        stack = [(u'', children)]
766
 
        while stack:
767
 
            from_dir_relpath, children = stack[-1]
768
 
 
769
 
            while children:
770
 
                name, ie = children.popleft()
771
 
 
772
 
                # we know that from_dir_relpath never ends in a slash
773
 
                # and 'f' doesn't begin with one, we can do a string op, rather
774
 
                # than the checks of pathjoin(), though this means that all paths
775
 
                # start with a slash
776
 
                path = from_dir_relpath + '/' + name
777
 
 
778
 
                yield path[1:], ie
779
 
 
780
 
                if ie.kind != 'directory':
781
 
                    continue
782
 
 
783
 
                # But do this child first
784
 
                new_children = ie.children.items()
785
 
                new_children.sort()
786
 
                new_children = collections.deque(new_children)
787
 
                stack.append((path, new_children))
788
 
                # Break out of inner loop, so that we start outer loop with child
789
 
                break
790
 
            else:
791
 
                # if we finished all children, pop it off the stack
792
 
                stack.pop()
793
 
 
794
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
795
 
        yield_parents=False):
796
 
        """Iterate over the entries in a directory first order.
797
 
 
798
 
        This returns all entries for a directory before returning
799
 
        the entries for children of a directory. This is not
800
 
        lexicographically sorted order, and is a hybrid between
801
 
        depth-first and breadth-first.
802
 
 
803
 
        :param yield_parents: If True, yield the parents from the root leading
804
 
            down to specific_file_ids that have been requested. This has no
805
 
            impact if specific_file_ids is None.
806
 
        :return: This yields (path, entry) pairs
807
 
        """
808
 
        if specific_file_ids and not isinstance(specific_file_ids, set):
809
 
            specific_file_ids = set(specific_file_ids)
810
 
        # TODO? Perhaps this should return the from_dir so that the root is
811
 
        # yielded? or maybe an option?
812
 
        if from_dir is None:
813
 
            if self.root is None:
814
 
                return
815
 
            # Optimize a common case
816
 
            if (not yield_parents and specific_file_ids is not None and
817
 
                len(specific_file_ids) == 1):
818
 
                file_id = list(specific_file_ids)[0]
819
 
                if file_id in self:
820
 
                    yield self.id2path(file_id), self[file_id]
821
 
                return
822
 
            from_dir = self.root
823
 
            if (specific_file_ids is None or yield_parents or
824
 
                self.root.file_id in specific_file_ids):
825
 
                yield u'', self.root
826
 
        elif isinstance(from_dir, basestring):
827
 
            from_dir = self[from_dir]
828
 
 
829
 
        if specific_file_ids is not None:
830
 
            # TODO: jam 20070302 This could really be done as a loop rather
831
 
            #       than a bunch of recursive calls.
832
 
            parents = set()
833
 
            byid = self
834
 
            def add_ancestors(file_id):
835
 
                if file_id not in byid:
836
 
                    return
837
 
                parent_id = byid[file_id].parent_id
838
 
                if parent_id is None:
839
 
                    return
840
 
                if parent_id not in parents:
841
 
                    parents.add(parent_id)
842
 
                    add_ancestors(parent_id)
843
 
            for file_id in specific_file_ids:
844
 
                add_ancestors(file_id)
845
 
        else:
846
 
            parents = None
847
 
 
848
 
        stack = [(u'', from_dir)]
849
 
        while stack:
850
 
            cur_relpath, cur_dir = stack.pop()
851
 
 
852
 
            child_dirs = []
853
 
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
854
 
 
855
 
                child_relpath = cur_relpath + child_name
856
 
 
857
 
                if (specific_file_ids is None or
858
 
                    child_ie.file_id in specific_file_ids or
859
 
                    (yield_parents and child_ie.file_id in parents)):
860
 
                    yield child_relpath, child_ie
861
 
 
862
 
                if child_ie.kind == 'directory':
863
 
                    if parents is None or child_ie.file_id in parents:
864
 
                        child_dirs.append((child_relpath+'/', child_ie))
865
 
            stack.extend(reversed(child_dirs))
866
 
 
867
 
    def _make_delta(self, old):
868
 
        """Make an inventory delta from two inventories."""
869
 
        old_ids = set(old)
870
 
        new_ids = set(self)
871
 
        adds = new_ids - old_ids
872
 
        deletes = old_ids - new_ids
873
 
        common = old_ids.intersection(new_ids)
874
 
        delta = []
875
 
        for file_id in deletes:
876
 
            delta.append((old.id2path(file_id), None, file_id, None))
877
 
        for file_id in adds:
878
 
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
879
 
        for file_id in common:
880
 
            if old[file_id] != self[file_id]:
881
 
                delta.append((old.id2path(file_id), self.id2path(file_id),
882
 
                    file_id, self[file_id]))
883
 
        return delta
884
 
 
885
 
    def _get_mutable_inventory(self):
886
 
        """Returns a mutable copy of the object.
887
 
 
888
 
        Some inventories are immutable, yet working trees, for example, needs
889
 
        to mutate exisiting inventories instead of creating a new one.
890
 
        """
891
 
        raise NotImplementedError(self._get_mutable_inventory)
892
 
 
893
 
    def make_entry(self, kind, name, parent_id, file_id=None):
894
 
        """Simple thunk to bzrlib.inventory.make_entry."""
895
 
        return make_entry(kind, name, parent_id, file_id)
896
 
 
897
 
    def entries(self):
898
 
        """Return list of (path, ie) for all entries except the root.
899
 
 
900
 
        This may be faster than iter_entries.
901
 
        """
902
 
        accum = []
903
 
        def descend(dir_ie, dir_path):
904
 
            kids = dir_ie.children.items()
905
 
            kids.sort()
906
 
            for name, ie in kids:
907
 
                child_path = osutils.pathjoin(dir_path, name)
908
 
                accum.append((child_path, ie))
909
 
                if ie.kind == 'directory':
910
 
                    descend(ie, child_path)
911
 
 
912
 
        descend(self.root, u'')
913
 
        return accum
914
 
 
915
 
    def directories(self):
916
 
        """Return (path, entry) pairs for all directories, including the root.
917
 
        """
918
 
        accum = []
919
 
        def descend(parent_ie, parent_path):
920
 
            accum.append((parent_path, parent_ie))
921
 
 
922
 
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
923
 
            kids.sort()
924
 
 
925
 
            for name, child_ie in kids:
926
 
                child_path = osutils.pathjoin(parent_path, name)
927
 
                descend(child_ie, child_path)
928
 
        descend(self.root, u'')
929
 
        return accum
930
 
 
931
 
    def path2id(self, name):
932
 
        """Walk down through directories to return entry of last component.
933
 
 
934
 
        names may be either a list of path components, or a single
935
 
        string, in which case it is automatically split.
936
 
 
937
 
        This returns the entry of the last component in the path,
938
 
        which may be either a file or a directory.
939
 
 
940
 
        Returns None IFF the path is not found.
941
 
        """
942
 
        if isinstance(name, basestring):
943
 
            name = osutils.splitpath(name)
944
 
 
945
 
        # mutter("lookup path %r" % name)
946
 
 
947
 
        try:
948
 
            parent = self.root
949
 
        except errors.NoSuchId:
950
 
            # root doesn't exist yet so nothing else can
951
 
            return None
952
 
        if parent is None:
953
 
            return None
954
 
        for f in name:
955
 
            try:
956
 
                children = getattr(parent, 'children', None)
957
 
                if children is None:
958
 
                    return None
959
 
                cie = children[f]
960
 
                parent = cie
961
 
            except KeyError:
962
 
                # or raise an error?
963
 
                return None
964
 
 
965
 
        return parent.file_id
966
 
 
967
 
    def filter(self, specific_fileids):
968
 
        """Get an inventory view filtered against a set of file-ids.
969
 
 
970
 
        Children of directories and parents are included.
971
 
 
972
 
        The result may or may not reference the underlying inventory
973
 
        so it should be treated as immutable.
974
 
        """
975
 
        interesting_parents = set()
976
 
        for fileid in specific_fileids:
977
 
            try:
978
 
                interesting_parents.update(self.get_idpath(fileid))
979
 
            except errors.NoSuchId:
980
 
                # This fileid is not in the inventory - that's ok
981
 
                pass
982
 
        entries = self.iter_entries()
983
 
        if self.root is None:
984
 
            return Inventory(root_id=None)
985
 
        other = Inventory(entries.next()[1].file_id)
986
 
        other.root.revision = self.root.revision
987
 
        other.revision_id = self.revision_id
988
 
        directories_to_expand = set()
989
 
        for path, entry in entries:
990
 
            file_id = entry.file_id
991
 
            if (file_id in specific_fileids
992
 
                or entry.parent_id in directories_to_expand):
993
 
                if entry.kind == 'directory':
994
 
                    directories_to_expand.add(file_id)
995
 
            elif file_id not in interesting_parents:
996
 
                continue
997
 
            other.add(entry.copy())
998
 
        return other
999
 
 
1000
 
    def get_idpath(self, file_id):
1001
 
        """Return a list of file_ids for the path to an entry.
1002
 
 
1003
 
        The list contains one element for each directory followed by
1004
 
        the id of the file itself.  So the length of the returned list
1005
 
        is equal to the depth of the file in the tree, counting the
1006
 
        root directory as depth 1.
1007
 
        """
1008
 
        p = []
1009
 
        for parent in self._iter_file_id_parents(file_id):
1010
 
            p.insert(0, parent.file_id)
1011
 
        return p
1012
 
 
1013
 
 
1014
 
class Inventory(CommonInventory):
 
675
class Inventory(object):
1015
676
    """Inventory of versioned files in a tree.
1016
677
 
1017
678
    This describes which file_id is present at each point in the tree,
1030
691
 
1031
692
    >>> inv = Inventory()
1032
693
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1033
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
694
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
1034
695
    >>> inv['123-123'].name
1035
696
    'hello.c'
1036
697
 
1037
698
    May be treated as an iterator or set to look up file ids:
1038
 
 
 
699
    
1039
700
    >>> bool(inv.path2id('hello.c'))
1040
701
    True
1041
702
    >>> '123-123' in inv
1044
705
    May also look up by name:
1045
706
 
1046
707
    >>> [x[0] for x in inv.iter_entries()]
1047
 
    ['', u'hello.c']
 
708
    ['hello.c']
1048
709
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
1049
710
    >>> 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)
 
711
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
1054
712
    """
1055
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
713
    def __init__(self, root_id=ROOT_ID):
1056
714
        """Create or read an inventory.
1057
715
 
1058
716
        If a working directory is specified, the inventory is read
1062
720
        The inventory is created with a default root directory, with
1063
721
        an id of None.
1064
722
        """
1065
 
        if root_id is not None:
1066
 
            self._set_root(InventoryDirectory(root_id, u'', None))
1067
 
        else:
1068
 
            self.root = None
1069
 
            self._byid = {}
1070
 
        self.revision_id = revision_id
1071
 
 
1072
 
    def __repr__(self):
1073
 
        # More than one page of ouput is not useful anymore to debug
1074
 
        max_len = 2048
1075
 
        closing = '...}'
1076
 
        contents = repr(self._byid)
1077
 
        if len(contents) > max_len:
1078
 
            contents = contents[:(max_len-len(closing))] + closing
1079
 
        return "<Inventory object at %x, contents=%r>" % (id(self), contents)
1080
 
 
1081
 
    def apply_delta(self, delta):
1082
 
        """Apply a delta to this inventory.
1083
 
 
1084
 
        :param delta: A list of changes to apply. After all the changes are
1085
 
            applied the final inventory must be internally consistent, but it
1086
 
            is ok to supply changes which, if only half-applied would have an
1087
 
            invalid result - such as supplying two changes which rename two
1088
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
1089
 
            ('B', 'A', 'B-id', b_entry)].
1090
 
 
1091
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
1092
 
            new_entry).
1093
 
 
1094
 
            When new_path is None, the change indicates the removal of an entry
1095
 
            from the inventory and new_entry will be ignored (using None is
1096
 
            appropriate). If new_path is not None, then new_entry must be an
1097
 
            InventoryEntry instance, which will be incorporated into the
1098
 
            inventory (and replace any existing entry with the same file id).
1099
 
 
1100
 
            When old_path is None, the change indicates the addition of
1101
 
            a new entry to the inventory.
1102
 
 
1103
 
            When neither new_path nor old_path are None, the change is a
1104
 
            modification to an entry, such as a rename, reparent, kind change
1105
 
            etc.
1106
 
 
1107
 
            The children attribute of new_entry is ignored. This is because
1108
 
            this method preserves children automatically across alterations to
1109
 
            the parent of the children, and cases where the parent id of a
1110
 
            child is changing require the child to be passed in as a separate
1111
 
            change regardless. E.g. in the recursive deletion of a directory -
1112
 
            the directory's children must be included in the delta, or the
1113
 
            final inventory will be invalid.
1114
 
 
1115
 
            Note that a file_id must only appear once within a given delta.
1116
 
            An AssertionError is raised otherwise.
1117
 
        """
1118
 
        # Check that the delta is legal. It would be nice if this could be
1119
 
        # 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
1126
 
 
1127
 
        children = {}
1128
 
        # Remove all affected items which were in the original inventory,
1129
 
        # starting with the longest paths, thus ensuring parents are examined
1130
 
        # after their children, which means that everything we examine has no
1131
 
        # modified children remaining by the time we examine it.
1132
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1133
 
                                        if op is not None), reverse=True):
1134
 
            if file_id not in self:
1135
 
                # adds come later
1136
 
                continue
1137
 
            # Preserve unaltered children of file_id for later reinsertion.
1138
 
            file_id_children = getattr(self[file_id], 'children', {})
1139
 
            if len(file_id_children):
1140
 
                children[file_id] = file_id_children
1141
 
            # Remove file_id and the unaltered children. If file_id is not
1142
 
            # being deleted it will be reinserted back later.
1143
 
            self.remove_recursive_id(file_id)
1144
 
        # Insert all affected which should be in the new inventory, reattaching
1145
 
        # their children if they had any. This is done from shortest path to
1146
 
        # longest, ensuring that items which were modified and whose parents in
1147
 
        # the resulting inventory were also modified, are inserted after their
1148
 
        # parents.
1149
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
1150
 
                                          delta if np is not None):
1151
 
            if new_entry.kind == 'directory':
1152
 
                # Pop the child which to allow detection of children whose
1153
 
                # parents were deleted and which were not reattached to a new
1154
 
                # parent.
1155
 
                replacement = InventoryDirectory(new_entry.file_id,
1156
 
                    new_entry.name, new_entry.parent_id)
1157
 
                replacement.revision = new_entry.revision
1158
 
                replacement.children = children.pop(replacement.file_id, {})
1159
 
                new_entry = replacement
1160
 
            self.add(new_entry)
1161
 
        if len(children):
1162
 
            # Get the parent id that was deleted
1163
 
            parent_id, children = children.popitem()
1164
 
            raise errors.InconsistentDelta("<deleted>", parent_id,
1165
 
                "The file id was deleted but its children were not deleted.")
1166
 
 
1167
 
    def _set_root(self, ie):
1168
 
        self.root = ie
 
723
        # We are letting Branch.initialize() create a unique inventory
 
724
        # root id. Rather than generating a random one here.
 
725
        #if root_id is None:
 
726
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
727
        self.root = RootEntry(root_id)
1169
728
        self._byid = {self.root.file_id: self.root}
1170
729
 
 
730
 
1171
731
    def copy(self):
1172
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
1173
 
        entries = self.iter_entries()
1174
 
        if self.root is None:
1175
 
            return Inventory(root_id=None)
1176
 
        other = Inventory(entries.next()[1].file_id)
1177
 
        other.root.revision = self.root.revision
 
732
        other = Inventory(self.root.file_id)
1178
733
        # copy recursively so we know directories will be added before
1179
734
        # their children.  There are more efficient ways than this...
1180
 
        for path, entry in entries:
 
735
        for path, entry in self.iter_entries():
 
736
            if entry == self.root:
 
737
                continue
1181
738
            other.add(entry.copy())
1182
739
        return other
1183
740
 
1184
 
    def _get_mutable_inventory(self):
1185
 
        """See CommonInventory._get_mutable_inventory."""
1186
 
        return deepcopy(self)
1187
741
 
1188
742
    def __iter__(self):
1189
 
        """Iterate over all file-ids."""
1190
743
        return iter(self._byid)
1191
744
 
1192
 
    def iter_just_entries(self):
1193
 
        """Iterate over all entries.
1194
 
        
1195
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
1196
 
        and the order of entries is undefined.
1197
 
 
1198
 
        XXX: We may not want to merge this into bzr.dev.
1199
 
        """
1200
 
        if self.root is None:
1201
 
            return
1202
 
        for _, ie in self._byid.iteritems():
1203
 
            yield ie
1204
745
 
1205
746
    def __len__(self):
1206
747
        """Returns number of entries."""
1207
748
        return len(self._byid)
1208
749
 
 
750
 
 
751
    def iter_entries(self, from_dir=None):
 
752
        """Return (path, entry) pairs, in order by name."""
 
753
        if from_dir == None:
 
754
            assert self.root
 
755
            from_dir = self.root
 
756
        elif isinstance(from_dir, basestring):
 
757
            from_dir = self._byid[from_dir]
 
758
            
 
759
        kids = from_dir.children.items()
 
760
        kids.sort()
 
761
        for name, ie in kids:
 
762
            yield name, ie
 
763
            if ie.kind == 'directory':
 
764
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
765
                    yield os.path.join(name, cn), cie
 
766
 
 
767
 
 
768
    def entries(self):
 
769
        """Return list of (path, ie) for all entries except the root.
 
770
 
 
771
        This may be faster than iter_entries.
 
772
        """
 
773
        accum = []
 
774
        def descend(dir_ie, dir_path):
 
775
            kids = dir_ie.children.items()
 
776
            kids.sort()
 
777
            for name, ie in kids:
 
778
                child_path = os.path.join(dir_path, name)
 
779
                accum.append((child_path, ie))
 
780
                if ie.kind == 'directory':
 
781
                    descend(ie, child_path)
 
782
 
 
783
        descend(self.root, '')
 
784
        return accum
 
785
 
 
786
 
 
787
    def directories(self):
 
788
        """Return (path, entry) pairs for all directories, including the root.
 
789
        """
 
790
        accum = []
 
791
        def descend(parent_ie, parent_path):
 
792
            accum.append((parent_path, parent_ie))
 
793
            
 
794
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
795
            kids.sort()
 
796
 
 
797
            for name, child_ie in kids:
 
798
                child_path = os.path.join(parent_path, name)
 
799
                descend(child_ie, child_path)
 
800
        descend(self.root, '')
 
801
        return accum
 
802
        
 
803
 
 
804
 
 
805
    def __contains__(self, file_id):
 
806
        """True if this entry contains a file with given id.
 
807
 
 
808
        >>> inv = Inventory()
 
809
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
810
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
811
        >>> '123' in inv
 
812
        True
 
813
        >>> '456' in inv
 
814
        False
 
815
        """
 
816
        return file_id in self._byid
 
817
 
 
818
 
1209
819
    def __getitem__(self, file_id):
1210
820
        """Return the entry for given file_id.
1211
821
 
1212
822
        >>> inv = Inventory()
1213
823
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1214
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
824
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1215
825
        >>> inv['123123'].name
1216
826
        'hello.c'
1217
827
        """
1218
828
        try:
1219
829
            return self._byid[file_id]
1220
830
        except KeyError:
1221
 
            # really we're passing an inventory, not a tree...
1222
 
            raise errors.NoSuchId(self, file_id)
 
831
            if file_id == None:
 
832
                raise BzrError("can't look up file_id None")
 
833
            else:
 
834
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
835
 
1223
836
 
1224
837
    def get_file_kind(self, file_id):
1225
838
        return self._byid[file_id].kind
1227
840
    def get_child(self, parent_id, filename):
1228
841
        return self[parent_id].children.get(filename)
1229
842
 
1230
 
    def _add_child(self, entry):
1231
 
        """Add an entry to the inventory, without adding it to its parent"""
1232
 
        if entry.file_id in self._byid:
1233
 
            raise BzrError("inventory already contains entry with id {%s}" %
1234
 
                           entry.file_id)
1235
 
        self._byid[entry.file_id] = entry
1236
 
        for child in getattr(entry, 'children', {}).itervalues():
1237
 
            self._add_child(child)
1238
 
        return entry
1239
843
 
1240
844
    def add(self, entry):
1241
845
        """Add entry to inventory.
1246
850
        Returns the new entry object.
1247
851
        """
1248
852
        if entry.file_id in self._byid:
1249
 
            raise errors.DuplicateFileId(entry.file_id,
1250
 
                                         self._byid[entry.file_id])
1251
 
 
1252
 
        if entry.parent_id is None:
1253
 
            self.root = entry
1254
 
        else:
1255
 
            try:
1256
 
                parent = self._byid[entry.parent_id]
1257
 
            except KeyError:
1258
 
                raise BzrError("parent_id {%s} not in inventory" %
1259
 
                               entry.parent_id)
1260
 
 
1261
 
            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'))
1265
 
            parent.children[entry.name] = entry
1266
 
        return self._add_child(entry)
1267
 
 
1268
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
853
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
854
 
 
855
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
856
            entry.parent_id = self.root.file_id
 
857
 
 
858
        try:
 
859
            parent = self._byid[entry.parent_id]
 
860
        except KeyError:
 
861
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
862
 
 
863
        if parent.children.has_key(entry.name):
 
864
            raise BzrError("%s is already versioned" %
 
865
                    appendpath(self.id2path(parent.file_id), entry.name))
 
866
 
 
867
        self._byid[entry.file_id] = entry
 
868
        parent.children[entry.name] = entry
 
869
        return entry
 
870
 
 
871
 
 
872
    def add_path(self, relpath, kind, file_id=None):
1269
873
        """Add entry from a path.
1270
874
 
1271
875
        The immediate parent must already be versioned.
1272
876
 
1273
877
        Returns the new entry object."""
1274
 
 
1275
 
        parts = osutils.splitpath(relpath)
1276
 
 
 
878
        from bzrlib.branch import gen_file_id
 
879
        
 
880
        parts = bzrlib.osutils.splitpath(relpath)
1277
881
        if len(parts) == 0:
1278
 
            if file_id is None:
1279
 
                file_id = generate_ids.gen_root_id()
1280
 
            self.root = InventoryDirectory(file_id, '', None)
1281
 
            self._byid = {self.root.file_id: self.root}
1282
 
            return self.root
 
882
            raise BzrError("cannot re-add root of inventory")
 
883
 
 
884
        if file_id == None:
 
885
            file_id = gen_file_id(relpath)
 
886
 
 
887
        parent_path = parts[:-1]
 
888
        parent_id = self.path2id(parent_path)
 
889
        if parent_id == None:
 
890
            raise NotVersionedError(path=parent_path)
 
891
        if kind == 'directory':
 
892
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
893
        elif kind == 'file':
 
894
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
895
        elif kind == 'symlink':
 
896
            ie = InventoryLink(file_id, parts[-1], parent_id)
1283
897
        else:
1284
 
            parent_path = parts[:-1]
1285
 
            parent_id = self.path2id(parent_path)
1286
 
            if parent_id is None:
1287
 
                raise errors.NotVersionedError(path=parent_path)
1288
 
        ie = make_entry(kind, parts[-1], parent_id, file_id)
 
898
            raise BzrError("unknown kind %r" % kind)
1289
899
        return self.add(ie)
1290
900
 
 
901
 
1291
902
    def __delitem__(self, file_id):
1292
903
        """Remove entry by id.
1293
904
 
1294
905
        >>> inv = Inventory()
1295
906
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1296
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
907
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1297
908
        >>> '123' in inv
1298
909
        True
1299
910
        >>> del inv['123']
1301
912
        False
1302
913
        """
1303
914
        ie = self[file_id]
 
915
 
 
916
        assert self[ie.parent_id].children[ie.name] == ie
 
917
        
 
918
        # TODO: Test deleting all children; maybe hoist to a separate
 
919
        # deltree method?
 
920
        if ie.kind == 'directory':
 
921
            for cie in ie.children.values():
 
922
                del self[cie.file_id]
 
923
            del ie.children
 
924
 
1304
925
        del self._byid[file_id]
1305
 
        if ie.parent_id is not None:
1306
 
            del self[ie.parent_id].children[ie.name]
 
926
        del self[ie.parent_id].children[ie.name]
 
927
 
1307
928
 
1308
929
    def __eq__(self, other):
1309
930
        """Compare two sets by comparing their contents.
1313
934
        >>> i1 == i2
1314
935
        True
1315
936
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1316
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
937
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1317
938
        >>> i1 == i2
1318
939
        False
1319
940
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1320
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
941
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1321
942
        >>> i1 == i2
1322
943
        True
1323
944
        """
1324
945
        if not isinstance(other, Inventory):
1325
946
            return NotImplemented
1326
947
 
 
948
        if len(self._byid) != len(other._byid):
 
949
            # shortcut: obviously not the same
 
950
            return False
 
951
 
1327
952
        return self._byid == other._byid
1328
953
 
 
954
 
1329
955
    def __ne__(self, other):
1330
956
        return not self.__eq__(other)
1331
957
 
 
958
 
1332
959
    def __hash__(self):
1333
960
        raise ValueError('not hashable')
1334
961
 
1335
 
    def _iter_file_id_parents(self, file_id):
1336
 
        """Yield the parents of file_id up to the root."""
1337
 
        while file_id is not None:
 
962
 
 
963
    def get_idpath(self, file_id):
 
964
        """Return a list of file_ids for the path to an entry.
 
965
 
 
966
        The list contains one element for each directory followed by
 
967
        the id of the file itself.  So the length of the returned list
 
968
        is equal to the depth of the file in the tree, counting the
 
969
        root directory as depth 1.
 
970
        """
 
971
        p = []
 
972
        while file_id != None:
1338
973
            try:
1339
974
                ie = self._byid[file_id]
1340
975
            except KeyError:
1341
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
1342
 
            yield ie
 
976
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
977
            p.insert(0, ie.file_id)
1343
978
            file_id = ie.parent_id
1344
 
 
1345
 
    def has_filename(self, filename):
1346
 
        return bool(self.path2id(filename))
 
979
        return p
 
980
 
 
981
 
 
982
    def id2path(self, file_id):
 
983
        """Return as a list the path to file_id.
 
984
        
 
985
        >>> i = Inventory()
 
986
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
987
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
988
        >>> print i.id2path('foo-id').replace(os.sep, '/')
 
989
        src/foo.c
 
990
        """
 
991
        # get all names, skipping root
 
992
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
993
        return os.sep.join(p)
 
994
            
 
995
 
 
996
 
 
997
    def path2id(self, name):
 
998
        """Walk down through directories to return entry of last component.
 
999
 
 
1000
        names may be either a list of path components, or a single
 
1001
        string, in which case it is automatically split.
 
1002
 
 
1003
        This returns the entry of the last component in the path,
 
1004
        which may be either a file or a directory.
 
1005
 
 
1006
        Returns None iff the path is not found.
 
1007
        """
 
1008
        if isinstance(name, types.StringTypes):
 
1009
            name = splitpath(name)
 
1010
 
 
1011
        mutter("lookup path %r" % name)
 
1012
 
 
1013
        parent = self.root
 
1014
        for f in name:
 
1015
            try:
 
1016
                cie = parent.children[f]
 
1017
                assert cie.name == f
 
1018
                assert cie.parent_id == parent.file_id
 
1019
                parent = cie
 
1020
            except KeyError:
 
1021
                # or raise an error?
 
1022
                return None
 
1023
 
 
1024
        return parent.file_id
 
1025
 
 
1026
 
 
1027
    def has_filename(self, names):
 
1028
        return bool(self.path2id(names))
 
1029
 
1347
1030
 
1348
1031
    def has_id(self, file_id):
1349
 
        return (file_id in self._byid)
1350
 
 
1351
 
    def _make_delta(self, old):
1352
 
        """Make an inventory delta from two inventories."""
1353
 
        old_getter = getattr(old, '_byid', old)
1354
 
        new_getter = self._byid
1355
 
        old_ids = set(old_getter)
1356
 
        new_ids = set(new_getter)
1357
 
        adds = new_ids - old_ids
1358
 
        deletes = old_ids - new_ids
1359
 
        if not adds and not deletes:
1360
 
            common = new_ids
1361
 
        else:
1362
 
            common = old_ids.intersection(new_ids)
1363
 
        delta = []
1364
 
        for file_id in deletes:
1365
 
            delta.append((old.id2path(file_id), None, file_id, None))
1366
 
        for file_id in adds:
1367
 
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
1368
 
        for file_id in common:
1369
 
            new_ie = new_getter[file_id]
1370
 
            old_ie = old_getter[file_id]
1371
 
            # If xml_serializer returns the cached InventoryEntries (rather
1372
 
            # than always doing .copy()), inlining the 'is' check saves 2.7M
1373
 
            # calls to __eq__.  Under lsprof this saves 20s => 6s.
1374
 
            # It is a minor improvement without lsprof.
1375
 
            if old_ie is new_ie or old_ie == new_ie:
1376
 
                continue
1377
 
            else:
1378
 
                delta.append((old.id2path(file_id), self.id2path(file_id),
1379
 
                              file_id, new_ie))
1380
 
        return delta
1381
 
 
1382
 
    def remove_recursive_id(self, file_id):
1383
 
        """Remove file_id, and children, from the inventory.
1384
 
 
1385
 
        :param file_id: A file_id to remove.
1386
 
        """
1387
 
        to_find_delete = [self._byid[file_id]]
1388
 
        to_delete = []
1389
 
        while to_find_delete:
1390
 
            ie = to_find_delete.pop()
1391
 
            to_delete.append(ie.file_id)
1392
 
            if ie.kind == 'directory':
1393
 
                to_find_delete.extend(ie.children.values())
1394
 
        for file_id in reversed(to_delete):
1395
 
            ie = self[file_id]
1396
 
            del self._byid[file_id]
1397
 
        if ie.parent_id is not None:
1398
 
            del self[ie.parent_id].children[ie.name]
1399
 
        else:
1400
 
            self.root = None
 
1032
        return self._byid.has_key(file_id)
 
1033
 
1401
1034
 
1402
1035
    def rename(self, file_id, new_parent_id, new_name):
1403
1036
        """Move a file within the inventory.
1404
1037
 
1405
1038
        This can change either the name, or the parent, or both.
1406
1039
 
1407
 
        This does not move the working file.
1408
 
        """
1409
 
        new_name = ensure_normalized_name(new_name)
 
1040
        This does not move the working file."""
1410
1041
        if not is_valid_name(new_name):
1411
1042
            raise BzrError("not an acceptable filename: %r" % new_name)
1412
1043
 
1426
1057
 
1427
1058
        del old_parent.children[file_ie.name]
1428
1059
        new_parent.children[new_name] = file_ie
1429
 
 
 
1060
        
1430
1061
        file_ie.name = new_name
1431
1062
        file_ie.parent_id = new_parent_id
1432
1063
 
1433
 
    def is_root(self, file_id):
1434
 
        return self.root is not None and file_id == self.root.file_id
1435
 
 
1436
 
 
1437
 
class CHKInventory(CommonInventory):
1438
 
    """An inventory persisted in a CHK store.
1439
 
 
1440
 
    By design, a CHKInventory is immutable so many of the methods
1441
 
    supported by Inventory - add, rename, apply_delta, etc - are *not*
1442
 
    supported. To create a new CHKInventory, use create_by_apply_delta()
1443
 
    or from_inventory(), say.
1444
 
 
1445
 
    Internally, a CHKInventory has one or two CHKMaps:
1446
 
 
1447
 
    * id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1448
 
    * parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1449
 
        => file_id as bytes
1450
 
 
1451
 
    The second map is optional and not present in early CHkRepository's.
1452
 
 
1453
 
    No caching is performed: every method call or item access will perform
1454
 
    requests to the storage layer. As such, keep references to objects you
1455
 
    want to reuse.
1456
 
    """
1457
 
 
1458
 
    def __init__(self, search_key_name):
1459
 
        CommonInventory.__init__(self)
1460
 
        self._fileid_to_entry_cache = {}
1461
 
        self._path_to_fileid_cache = {}
1462
 
        self._search_key_name = search_key_name
1463
 
 
1464
 
    def _entry_to_bytes(self, entry):
1465
 
        """Serialise entry as a single bytestring.
1466
 
 
1467
 
        :param Entry: An inventory entry.
1468
 
        :return: A bytestring for the entry.
1469
 
 
1470
 
        The BNF:
1471
 
        ENTRY ::= FILE | DIR | SYMLINK | TREE
1472
 
        FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
1473
 
        DIR ::= "dir: " COMMON
1474
 
        SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
1475
 
        TREE ::= "tree: " COMMON REFERENCE_REVISION
1476
 
        COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
1477
 
        SEP ::= "\n"
1478
 
        """
1479
 
        if entry.parent_id is not None:
1480
 
            parent_str = entry.parent_id
1481
 
        else:
1482
 
            parent_str = ''
1483
 
        name_str = entry.name.encode("utf8")
1484
 
        if entry.kind == 'file':
1485
 
            if entry.executable:
1486
 
                exec_str = "Y"
1487
 
            else:
1488
 
                exec_str = "N"
1489
 
            return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
1490
 
                entry.file_id, parent_str, name_str, entry.revision,
1491
 
                entry.text_sha1, entry.text_size, exec_str)
1492
 
        elif entry.kind == 'directory':
1493
 
            return "dir: %s\n%s\n%s\n%s" % (
1494
 
                entry.file_id, parent_str, name_str, entry.revision)
1495
 
        elif entry.kind == 'symlink':
1496
 
            return "symlink: %s\n%s\n%s\n%s\n%s" % (
1497
 
                entry.file_id, parent_str, name_str, entry.revision,
1498
 
                entry.symlink_target.encode("utf8"))
1499
 
        elif entry.kind == 'tree-reference':
1500
 
            return "tree: %s\n%s\n%s\n%s\n%s" % (
1501
 
                entry.file_id, parent_str, name_str, entry.revision,
1502
 
                entry.reference_revision)
1503
 
        else:
1504
 
            raise ValueError("unknown kind %r" % entry.kind)
1505
 
 
1506
 
    @staticmethod
1507
 
    def _bytes_to_utf8name_key(bytes):
1508
 
        """Get the file_id, revision_id key out of bytes."""
1509
 
        # We don't normally care about name, except for times when we want
1510
 
        # to filter out empty names because of non rich-root...
1511
 
        sections = bytes.split('\n')
1512
 
        kind, file_id = sections[0].split(': ')
1513
 
        return (sections[2], file_id, sections[3])
1514
 
 
1515
 
    def _bytes_to_entry(self, bytes):
1516
 
        """Deserialise a serialised entry."""
1517
 
        sections = bytes.split('\n')
1518
 
        if sections[0].startswith("file: "):
1519
 
            result = InventoryFile(sections[0][6:],
1520
 
                sections[2].decode('utf8'),
1521
 
                sections[1])
1522
 
            result.text_sha1 = sections[4]
1523
 
            result.text_size = int(sections[5])
1524
 
            result.executable = sections[6] == "Y"
1525
 
        elif sections[0].startswith("dir: "):
1526
 
            result = CHKInventoryDirectory(sections[0][5:],
1527
 
                sections[2].decode('utf8'),
1528
 
                sections[1], self)
1529
 
        elif sections[0].startswith("symlink: "):
1530
 
            result = InventoryLink(sections[0][9:],
1531
 
                sections[2].decode('utf8'),
1532
 
                sections[1])
1533
 
            result.symlink_target = sections[4].decode('utf8')
1534
 
        elif sections[0].startswith("tree: "):
1535
 
            result = TreeReference(sections[0][6:],
1536
 
                sections[2].decode('utf8'),
1537
 
                sections[1])
1538
 
            result.reference_revision = sections[4]
1539
 
        else:
1540
 
            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
 
        inv = Inventory(None, self.revision_id)
1551
 
        for path, inv_entry in entries:
1552
 
            inv.add(inv_entry.copy())
1553
 
        return inv
1554
 
 
1555
 
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
1556
 
        propagate_caches=False):
1557
 
        """Create a new CHKInventory by applying inventory_delta to this one.
1558
 
 
1559
 
        :param inventory_delta: The inventory delta to apply. See
1560
 
            Inventory.apply_delta for details.
1561
 
        :param new_revision_id: The revision id of the resulting CHKInventory.
1562
 
        :param propagate_caches: If True, the caches for this inventory are
1563
 
          copied to and updated for the result.
1564
 
        :return: The new CHKInventory.
1565
 
        """
1566
 
        result = CHKInventory(self._search_key_name)
1567
 
        if propagate_caches:
1568
 
            # Just propagate the path-to-fileid cache for now
1569
 
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
1570
 
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1571
 
        self.id_to_entry._ensure_root()
1572
 
        maximum_size = self.id_to_entry._root_node.maximum_size
1573
 
        result.revision_id = new_revision_id
1574
 
        result.id_to_entry = chk_map.CHKMap(
1575
 
            self.id_to_entry._store,
1576
 
            self.id_to_entry.key(),
1577
 
            search_key_func=search_key_func)
1578
 
        result.id_to_entry._ensure_root()
1579
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1580
 
        parent_id_basename_delta = []
1581
 
        if self.parent_id_basename_to_file_id is not None:
1582
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1583
 
                self.parent_id_basename_to_file_id._store,
1584
 
                self.parent_id_basename_to_file_id.key(),
1585
 
                search_key_func=search_key_func)
1586
 
            result.parent_id_basename_to_file_id._ensure_root()
1587
 
            self.parent_id_basename_to_file_id._ensure_root()
1588
 
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
1589
 
            p_id_root = self.parent_id_basename_to_file_id._root_node
1590
 
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1591
 
            result_p_id_root._key_width = p_id_root._key_width
1592
 
        else:
1593
 
            result.parent_id_basename_to_file_id = None
1594
 
        result.root_id = self.root_id
1595
 
        id_to_entry_delta = []
1596
 
        for old_path, new_path, file_id, entry in inventory_delta:
1597
 
            # file id changes
1598
 
            if new_path == '':
1599
 
                result.root_id = file_id
1600
 
            if new_path is None:
1601
 
                # Make a delete:
1602
 
                new_key = None
1603
 
                new_value = None
1604
 
                # Update caches
1605
 
                if propagate_caches:
1606
 
                    try:
1607
 
                        del result._path_to_fileid_cache[old_path]
1608
 
                    except KeyError:
1609
 
                        pass
1610
 
            else:
1611
 
                new_key = (file_id,)
1612
 
                new_value = result._entry_to_bytes(entry)
1613
 
                # Update caches. It's worth doing this whether
1614
 
                # we're propagating the old caches or not.
1615
 
                result._path_to_fileid_cache[new_path] = file_id
1616
 
            if old_path is None:
1617
 
                old_key = None
1618
 
            else:
1619
 
                old_key = (file_id,)
1620
 
            id_to_entry_delta.append((old_key, new_key, new_value))
1621
 
            if result.parent_id_basename_to_file_id is not None:
1622
 
                # parent_id, basename changes
1623
 
                if old_path is None:
1624
 
                    old_key = None
1625
 
                else:
1626
 
                    old_entry = self[file_id]
1627
 
                    old_key = self._parent_id_basename_key(old_entry)
1628
 
                if new_path is None:
1629
 
                    new_key = None
1630
 
                    new_value = None
1631
 
                else:
1632
 
                    new_key = self._parent_id_basename_key(entry)
1633
 
                    new_value = file_id
1634
 
                if old_key != new_key:
1635
 
                    # If the two keys are the same, the value will be unchanged
1636
 
                    # as its always the file id.
1637
 
                    parent_id_basename_delta.append((old_key, new_key, new_value))
1638
 
        result.id_to_entry.apply_delta(id_to_entry_delta)
1639
 
        if parent_id_basename_delta:
1640
 
            result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
1641
 
        return result
1642
 
 
1643
 
    @classmethod
1644
 
    def deserialise(klass, chk_store, bytes, expected_revision_id):
1645
 
        """Deserialise a CHKInventory.
1646
 
 
1647
 
        :param chk_store: A CHK capable VersionedFiles instance.
1648
 
        :param bytes: The serialised bytes.
1649
 
        :param expected_revision_id: The revision ID we think this inventory is
1650
 
            for.
1651
 
        :return: A CHKInventory
1652
 
        """
1653
 
        lines = bytes.split('\n')
1654
 
        if lines[-1] != '':
1655
 
            raise AssertionError('bytes to deserialize must end with an eol')
1656
 
        lines.pop()
1657
 
        if lines[0] != 'chkinventory:':
1658
 
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
1659
 
        info = {}
1660
 
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
1661
 
                                  'parent_id_basename_to_file_id',
1662
 
                                  'id_to_entry'])
1663
 
        for line in lines[1:]:
1664
 
            key, value = line.split(': ', 1)
1665
 
            if key not in allowed_keys:
1666
 
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
1667
 
                                      % (key, bytes))
1668
 
            if key in info:
1669
 
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1670
 
                                      % (key, bytes))
1671
 
            info[key] = value
1672
 
        revision_id = info['revision_id']
1673
 
        root_id = info['root_id']
1674
 
        search_key_name = info.get('search_key_name', 'plain')
1675
 
        parent_id_basename_to_file_id = info.get(
1676
 
            'parent_id_basename_to_file_id', None)
1677
 
        id_to_entry = info['id_to_entry']
1678
 
 
1679
 
        result = CHKInventory(search_key_name)
1680
 
        result.revision_id = revision_id
1681
 
        result.root_id = root_id
1682
 
        search_key_func = chk_map.search_key_registry.get(
1683
 
                            result._search_key_name)
1684
 
        if parent_id_basename_to_file_id is not None:
1685
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1686
 
                chk_store, (parent_id_basename_to_file_id,),
1687
 
                search_key_func=search_key_func)
1688
 
        else:
1689
 
            result.parent_id_basename_to_file_id = None
1690
 
 
1691
 
        result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
1692
 
                                            search_key_func=search_key_func)
1693
 
        if (result.revision_id,) != expected_revision_id:
1694
 
            raise ValueError("Mismatched revision id and expected: %r, %r" %
1695
 
                (result.revision_id, expected_revision_id))
1696
 
        return result
1697
 
 
1698
 
    @classmethod
1699
 
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
1700
 
        """Create a CHKInventory from an existing inventory.
1701
 
 
1702
 
        The content of inventory is copied into the chk_store, and a
1703
 
        CHKInventory referencing that is returned.
1704
 
 
1705
 
        :param chk_store: A CHK capable VersionedFiles instance.
1706
 
        :param inventory: The inventory to copy.
1707
 
        :param maximum_size: The CHKMap node size limit.
1708
 
        :param search_key_name: The identifier for the search key function
1709
 
        """
1710
 
        result = CHKInventory(search_key_name)
1711
 
        result.revision_id = inventory.revision_id
1712
 
        result.root_id = inventory.root.file_id
1713
 
        search_key_func = chk_map.search_key_registry.get(search_key_name)
1714
 
        result.id_to_entry = chk_map.CHKMap(chk_store, None, search_key_func)
1715
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1716
 
        file_id_delta = []
1717
 
        result.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1718
 
            None, search_key_func)
1719
 
        result.parent_id_basename_to_file_id._root_node.set_maximum_size(
1720
 
            maximum_size)
1721
 
        result.parent_id_basename_to_file_id._root_node._key_width = 2
1722
 
        parent_id_delta = []
1723
 
        for path, entry in inventory.iter_entries():
1724
 
            file_id_delta.append((None, (entry.file_id,),
1725
 
                result._entry_to_bytes(entry)))
1726
 
            parent_id_delta.append(
1727
 
                (None, result._parent_id_basename_key(entry),
1728
 
                 entry.file_id))
1729
 
        result.id_to_entry.apply_delta(file_id_delta)
1730
 
        result.parent_id_basename_to_file_id.apply_delta(parent_id_delta)
1731
 
        return result
1732
 
 
1733
 
    def _parent_id_basename_key(self, entry):
1734
 
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
1735
 
        if entry.parent_id is not None:
1736
 
            parent_id = entry.parent_id
1737
 
        else:
1738
 
            parent_id = ''
1739
 
        return parent_id, entry.name.encode('utf8')
1740
 
 
1741
 
    def __getitem__(self, file_id):
1742
 
        """map a single file_id -> InventoryEntry."""
1743
 
        if file_id is None:
1744
 
            raise errors.NoSuchId(self, file_id)
1745
 
        result = self._fileid_to_entry_cache.get(file_id, None)
1746
 
        if result is not None:
1747
 
            return result
1748
 
        try:
1749
 
            return self._bytes_to_entry(
1750
 
                self.id_to_entry.iteritems([(file_id,)]).next()[1])
1751
 
        except StopIteration:
1752
 
            # really we're passing an inventory, not a tree...
1753
 
            raise errors.NoSuchId(self, file_id)
1754
 
 
1755
 
    def has_id(self, file_id):
1756
 
        # Perhaps have an explicit 'contains' method on CHKMap ?
1757
 
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
1758
 
            return True
1759
 
        return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
1760
 
 
1761
 
    def is_root(self, file_id):
1762
 
        return file_id == self.root_id
1763
 
 
1764
 
    def _iter_file_id_parents(self, file_id):
1765
 
        """Yield the parents of file_id up to the root."""
1766
 
        while file_id is not None:
1767
 
            try:
1768
 
                ie = self[file_id]
1769
 
            except KeyError:
1770
 
                raise errors.NoSuchId(tree=self, file_id=file_id)
1771
 
            yield ie
1772
 
            file_id = ie.parent_id
1773
 
 
1774
 
    def __iter__(self):
1775
 
        """Iterate over all file-ids."""
1776
 
        for key, _ in self.id_to_entry.iteritems():
1777
 
            yield key[-1]
1778
 
 
1779
 
    def iter_just_entries(self):
1780
 
        """Iterate over all entries.
1781
 
        
1782
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
1783
 
        and the order of entries is undefined.
1784
 
 
1785
 
        XXX: We may not want to merge this into bzr.dev.
1786
 
        """
1787
 
        for key, entry in self.id_to_entry.iteritems():
1788
 
            file_id = key[0]
1789
 
            ie = self._fileid_to_entry_cache.get(file_id, None)
1790
 
            if ie is None:
1791
 
                ie = self._bytes_to_entry(entry)
1792
 
                self._fileid_to_entry_cache[file_id] = ie
1793
 
            yield ie
1794
 
 
1795
 
    def iter_changes(self, basis):
1796
 
        """Generate a Tree.iter_changes change list between this and basis.
1797
 
 
1798
 
        :param basis: Another CHKInventory.
1799
 
        :return: An iterator over the changes between self and basis, as per
1800
 
            tree.iter_changes().
1801
 
        """
1802
 
        # We want: (file_id, (path_in_source, path_in_target),
1803
 
        # changed_content, versioned, parent, name, kind,
1804
 
        # executable)
1805
 
        for key, basis_value, self_value in \
1806
 
            self.id_to_entry.iter_changes(basis.id_to_entry):
1807
 
            file_id = key[0]
1808
 
            if basis_value is not None:
1809
 
                basis_entry = basis._bytes_to_entry(basis_value)
1810
 
                path_in_source = basis.id2path(file_id)
1811
 
                basis_parent = basis_entry.parent_id
1812
 
                basis_name = basis_entry.name
1813
 
                basis_executable = basis_entry.executable
1814
 
            else:
1815
 
                path_in_source = None
1816
 
                basis_parent = None
1817
 
                basis_name = None
1818
 
                basis_executable = None
1819
 
            if self_value is not None:
1820
 
                self_entry = self._bytes_to_entry(self_value)
1821
 
                path_in_target = self.id2path(file_id)
1822
 
                self_parent = self_entry.parent_id
1823
 
                self_name = self_entry.name
1824
 
                self_executable = self_entry.executable
1825
 
            else:
1826
 
                path_in_target = None
1827
 
                self_parent = None
1828
 
                self_name = None
1829
 
                self_executable = None
1830
 
            if basis_value is None:
1831
 
                # add
1832
 
                kind = (None, self_entry.kind)
1833
 
                versioned = (False, True)
1834
 
            elif self_value is None:
1835
 
                # delete
1836
 
                kind = (basis_entry.kind, None)
1837
 
                versioned = (True, False)
1838
 
            else:
1839
 
                kind = (basis_entry.kind, self_entry.kind)
1840
 
                versioned = (True, True)
1841
 
            changed_content = False
1842
 
            if kind[0] != kind[1]:
1843
 
                changed_content = True
1844
 
            elif kind[0] == 'file':
1845
 
                if (self_entry.text_size != basis_entry.text_size or
1846
 
                    self_entry.text_sha1 != basis_entry.text_sha1):
1847
 
                    changed_content = True
1848
 
            elif kind[0] == 'symlink':
1849
 
                if self_entry.symlink_target != basis_entry.symlink_target:
1850
 
                    changed_content = True
1851
 
            elif kind[0] == 'tree-reference':
1852
 
                if (self_entry.reference_revision !=
1853
 
                    basis_entry.reference_revision):
1854
 
                    changed_content = True
1855
 
            parent = (basis_parent, self_parent)
1856
 
            name = (basis_name, self_name)
1857
 
            executable = (basis_executable, self_executable)
1858
 
            if (not changed_content
1859
 
                and parent[0] == parent[1]
1860
 
                and name[0] == name[1]
1861
 
                and executable[0] == executable[1]):
1862
 
                # Could happen when only the revision changed for a directory
1863
 
                # for instance.
1864
 
                continue
1865
 
            yield (file_id, (path_in_source, path_in_target), changed_content,
1866
 
                versioned, parent, name, kind, executable)
1867
 
 
1868
 
    def __len__(self):
1869
 
        """Return the number of entries in the inventory."""
1870
 
        return len(self.id_to_entry)
1871
 
 
1872
 
    def _make_delta(self, old):
1873
 
        """Make an inventory delta from two inventories."""
1874
 
        if type(old) != CHKInventory:
1875
 
            return CommonInventory._make_delta(self, old)
1876
 
        delta = []
1877
 
        for key, old_value, self_value in \
1878
 
            self.id_to_entry.iter_changes(old.id_to_entry):
1879
 
            file_id = key[0]
1880
 
            if old_value is not None:
1881
 
                old_path = old.id2path(file_id)
1882
 
            else:
1883
 
                old_path = None
1884
 
            if self_value is not None:
1885
 
                entry = self._bytes_to_entry(self_value)
1886
 
                self._fileid_to_entry_cache[file_id] = entry
1887
 
                new_path = self.id2path(file_id)
1888
 
            else:
1889
 
                entry = None
1890
 
                new_path = None
1891
 
            delta.append((old_path, new_path, file_id, entry))
1892
 
        return delta
1893
 
 
1894
 
    def path2id(self, name):
1895
 
        """See CommonInventory.path2id()."""
1896
 
        result = self._path_to_fileid_cache.get(name, None)
1897
 
        if result is None:
1898
 
            result = CommonInventory.path2id(self, name)
1899
 
            self._path_to_fileid_cache[name] = result
1900
 
        return result
1901
 
 
1902
 
    def to_lines(self):
1903
 
        """Serialise the inventory to lines."""
1904
 
        lines = ["chkinventory:\n"]
1905
 
        if self._search_key_name != 'plain':
1906
 
            # custom ordering grouping things that don't change together
1907
 
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
1908
 
            lines.append("root_id: %s\n" % self.root_id)
1909
 
            lines.append('parent_id_basename_to_file_id: %s\n' %
1910
 
                self.parent_id_basename_to_file_id.key())
1911
 
            lines.append("revision_id: %s\n" % self.revision_id)
1912
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1913
 
        else:
1914
 
            lines.append("revision_id: %s\n" % self.revision_id)
1915
 
            lines.append("root_id: %s\n" % self.root_id)
1916
 
            if self.parent_id_basename_to_file_id is not None:
1917
 
                lines.append('parent_id_basename_to_file_id: %s\n' %
1918
 
                    self.parent_id_basename_to_file_id.key())
1919
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1920
 
        return lines
1921
 
 
1922
 
    @property
1923
 
    def root(self):
1924
 
        """Get the root entry."""
1925
 
        return self[self.root_id]
1926
 
 
1927
 
 
1928
 
class CHKInventoryDirectory(InventoryDirectory):
1929
 
    """A directory in an inventory."""
1930
 
 
1931
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1932
 
                 'text_id', 'parent_id', '_children', 'executable',
1933
 
                 'revision', 'symlink_target', 'reference_revision',
1934
 
                 '_chk_inventory']
1935
 
 
1936
 
    def __init__(self, file_id, name, parent_id, chk_inventory):
1937
 
        # Don't call InventoryDirectory.__init__ - it isn't right for this
1938
 
        # class.
1939
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
1940
 
        self._children = None
1941
 
        self.kind = 'directory'
1942
 
        self._chk_inventory = chk_inventory
1943
 
 
1944
 
    @property
1945
 
    def children(self):
1946
 
        """Access the list of children of this directory.
1947
 
 
1948
 
        With a parent_id_basename_to_file_id index, loads all the children,
1949
 
        without loads the entire index. Without is bad. A more sophisticated
1950
 
        proxy object might be nice, to allow partial loading of children as
1951
 
        well when specific names are accessed. (So path traversal can be
1952
 
        written in the obvious way but not examine siblings.).
1953
 
        """
1954
 
        if self._children is not None:
1955
 
            return self._children
1956
 
        # No longer supported
1957
 
        if self._chk_inventory.parent_id_basename_to_file_id is None:
1958
 
            raise AssertionError("Inventories without"
1959
 
                " parent_id_basename_to_file_id are no longer supported")
1960
 
        result = {}
1961
 
        # XXX: Todo - use proxy objects for the children rather than loading
1962
 
        # all when the attribute is referenced.
1963
 
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
1964
 
        child_keys = set()
1965
 
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
1966
 
            key_filter=[(self.file_id,)]):
1967
 
            child_keys.add((file_id,))
1968
 
        cached = set()
1969
 
        for file_id_key in child_keys:
1970
 
            entry = self._chk_inventory._fileid_to_entry_cache.get(
1971
 
                file_id_key[0], None)
1972
 
            if entry is not None:
1973
 
                result[entry.name] = entry
1974
 
                cached.add(file_id_key)
1975
 
        child_keys.difference_update(cached)
1976
 
        # populate; todo: do by name
1977
 
        id_to_entry = self._chk_inventory.id_to_entry
1978
 
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
1979
 
            entry = self._chk_inventory._bytes_to_entry(bytes)
1980
 
            result[entry.name] = entry
1981
 
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
1982
 
        self._children = result
1983
 
        return result
1984
 
 
1985
 
entry_factory = {
1986
 
    'directory': InventoryDirectory,
1987
 
    'file': InventoryFile,
1988
 
    'symlink': InventoryLink,
1989
 
    'tree-reference': TreeReference
1990
 
}
1991
 
 
1992
 
def make_entry(kind, name, parent_id, file_id=None):
1993
 
    """Create an inventory entry.
1994
 
 
1995
 
    :param kind: the type of inventory entry to create.
1996
 
    :param name: the basename of the entry.
1997
 
    :param parent_id: the parent_id of the entry.
1998
 
    :param file_id: the file_id to use. if None, one will be created.
1999
 
    """
2000
 
    if file_id is None:
2001
 
        file_id = generate_ids.gen_file_id(name)
2002
 
    name = ensure_normalized_name(name)
2003
 
    try:
2004
 
        factory = entry_factory[kind]
2005
 
    except KeyError:
2006
 
        raise BzrError("unknown kind %r" % kind)
2007
 
    return factory(file_id, name, parent_id)
2008
 
 
2009
 
 
2010
 
def ensure_normalized_name(name):
2011
 
    """Normalize name.
2012
 
 
2013
 
    :raises InvalidNormalization: When name is not normalized, and cannot be
2014
 
        accessed on this platform by the normalized path.
2015
 
    :return: The NFC normalised version of name.
2016
 
    """
2017
 
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
2018
 
    # keep them synchronised.
2019
 
    # we dont import normalized_filename directly because we want to be
2020
 
    # able to change the implementation at runtime for tests.
2021
 
    norm_name, can_access = osutils.normalized_filename(name)
2022
 
    if norm_name != name:
2023
 
        if can_access:
2024
 
            return norm_name
2025
 
        else:
2026
 
            # TODO: jam 20060701 This would probably be more useful
2027
 
            #       if the error was raised with the full path
2028
 
            raise errors.InvalidNormalization(name)
2029
 
    return name
 
1064
 
2030
1065
 
2031
1066
 
2032
1067
_NAME_RE = None
2033
1068
 
2034
1069
def is_valid_name(name):
2035
1070
    global _NAME_RE
2036
 
    if _NAME_RE is None:
 
1071
    if _NAME_RE == None:
2037
1072
        _NAME_RE = re.compile(r'^[^/\\]+$')
2038
 
 
 
1073
        
2039
1074
    return bool(_NAME_RE.match(name))