~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
23
23
# But those depend on its position within a particular inventory, and
24
24
# it would be nice not to need to hold the backpointer here.
25
25
 
 
26
from __future__ import absolute_import
 
27
 
26
28
# This should really be an id randomly assigned when the tree is
27
29
# created, but it's not for now.
28
30
ROOT_ID = "TREE_ROOT"
29
31
 
30
 
import os
31
 
import re
32
 
import sys
33
 
 
34
32
from bzrlib.lazy_import import lazy_import
35
33
lazy_import(globals(), """
36
34
import collections
 
35
import copy
 
36
import re
37
37
import tarfile
38
38
 
39
 
import bzrlib
40
39
from bzrlib import (
 
40
    chk_map,
41
41
    errors,
42
42
    generate_ids,
43
43
    osutils,
44
 
    symbol_versioning,
45
 
    workingtree,
46
44
    )
47
45
""")
48
46
 
49
 
from bzrlib.errors import (
50
 
    BzrCheckError,
51
 
    BzrError,
52
 
    )
53
 
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
54
 
from bzrlib.trace import mutter
 
47
from bzrlib import (
 
48
    lazy_regex,
 
49
    trace,
 
50
    )
 
51
 
 
52
from bzrlib.static_tuple import StaticTuple
 
53
from bzrlib.symbol_versioning import (
 
54
    deprecated_in,
 
55
    deprecated_method,
 
56
    )
55
57
 
56
58
 
57
59
class InventoryEntry(object):
69
71
        file_id of the parent directory, or ROOT_ID
70
72
 
71
73
    revision
72
 
        the revision_id in which this variation of this file was 
 
74
        the revision_id in which this variation of this file was
73
75
        introduced.
74
76
 
75
77
    executable
78
80
 
79
81
    text_sha1
80
82
        sha-1 of the text of the file
81
 
        
 
83
 
82
84
    text_size
83
85
        size in bytes of the text of the file
84
 
        
 
86
 
85
87
    (reading a version 4 tree created a text_id field.)
86
88
 
87
89
    >>> i = Inventory()
90
92
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
91
93
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
92
94
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
93
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
 
95
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
94
96
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
95
97
    >>> for ix, j in enumerate(i.iter_entries()):
96
98
    ...   print (j[0] == shouldbe[ix], j[1])
97
 
    ... 
 
99
    ...
98
100
    (True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
99
101
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
100
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
 
102
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
101
103
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
102
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
 
104
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
103
105
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
104
106
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
105
107
    >>> i.path2id('src/wibble')
106
108
    '2325'
107
 
    >>> '2325' in i
108
 
    True
109
109
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
110
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
110
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
111
111
    >>> i['2326']
112
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
112
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
113
113
    >>> for path, entry in i.iter_entries():
114
114
    ...     print path
115
 
    ... 
 
115
    ...
116
116
    <BLANKLINE>
117
117
    src
118
118
    src/bye.c
125
125
 
126
126
    # Constants returned by describe_change()
127
127
    #
128
 
    # TODO: These should probably move to some kind of FileChangeDescription 
129
 
    # class; that's like what's inside a TreeDelta but we want to be able to 
 
128
    # TODO: These should probably move to some kind of FileChangeDescription
 
129
    # class; that's like what's inside a TreeDelta but we want to be able to
130
130
    # generate them just for one file at a time.
131
131
    RENAMED = 'renamed'
132
132
    MODIFIED_AND_RENAMED = 'modified and renamed'
133
 
    
134
 
    __slots__ = []
 
133
 
 
134
    __slots__ = ['file_id', 'revision', 'parent_id', 'name']
 
135
 
 
136
    # Attributes that all InventoryEntry instances are expected to have, but
 
137
    # that don't vary for all kinds of entry.  (e.g. symlink_target is only
 
138
    # relevant to InventoryLink, so there's no reason to make every
 
139
    # InventoryFile instance allocate space to hold a value for it.)
 
140
    # Attributes that only vary for files: executable, text_sha1, text_size,
 
141
    # text_id
 
142
    executable = False
 
143
    text_sha1 = None
 
144
    text_size = None
 
145
    text_id = None
 
146
    # Attributes that only vary for symlinks: symlink_target
 
147
    symlink_target = None
 
148
    # Attributes that only vary for tree-references: reference_revision
 
149
    reference_revision = None
 
150
 
135
151
 
136
152
    def detect_changes(self, old_entry):
137
153
        """Return a (text_modified, meta_modified) from this to old_entry.
138
 
        
139
 
        _read_tree_state must have been called on self and old_entry prior to 
 
154
 
 
155
        _read_tree_state must have been called on self and old_entry prior to
140
156
        calling detect_changes.
141
157
        """
142
158
        return False, False
144
160
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
161
             output_to, reverse=False):
146
162
        """Perform a diff between two entries of the same kind."""
147
 
    
 
163
 
148
164
    def parent_candidates(self, previous_inventories):
149
165
        """Find possible per-file graph parents.
150
166
 
158
174
        candidates = {}
159
175
        # identify candidate head revision ids.
160
176
        for inv in previous_inventories:
161
 
            if self.file_id in inv:
 
177
            if inv.has_id(self.file_id):
162
178
                ie = inv[self.file_id]
163
179
                if ie.revision in candidates:
164
180
                    # same revision value in two different inventories:
165
181
                    # correct possible inconsistencies:
166
 
                    #     * there was a bug in revision updates with 'x' bit 
 
182
                    #     * there was a bug in revision updates with 'x' bit
167
183
                    #       support.
168
184
                    try:
169
185
                        if candidates[ie.revision].executable != ie.executable:
176
192
                    candidates[ie.revision] = ie
177
193
        return candidates
178
194
 
179
 
    @deprecated_method(deprecated_in((1, 6, 0)))
180
 
    def get_tar_item(self, root, dp, now, tree):
181
 
        """Get a tarfile item and a file stream for its content."""
182
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
183
 
        # TODO: would be cool to actually set it to the timestamp of the
184
 
        # revision it was last changed
185
 
        item.mtime = now
186
 
        fileobj = self._put_in_tar(item, tree)
187
 
        return item, fileobj
188
 
 
189
195
    def has_text(self):
190
196
        """Return true if the object this entry represents has textual data.
191
197
 
197
203
        """
198
204
        return False
199
205
 
200
 
    def __init__(self, file_id, name, parent_id, text_id=None):
 
206
    def __init__(self, file_id, name, parent_id):
201
207
        """Create an InventoryEntry
202
 
        
 
208
 
203
209
        The filename must be a single component, relative to the
204
210
        parent directory; it cannot be a whole path or relative name.
205
211
 
214
220
        """
215
221
        if '/' in name or '\\' in name:
216
222
            raise errors.InvalidEntryName(name=name)
217
 
        self.executable = False
 
223
        self.file_id = file_id
218
224
        self.revision = None
219
 
        self.text_sha1 = None
220
 
        self.text_size = None
221
 
        self.file_id = file_id
222
225
        self.name = name
223
 
        self.text_id = text_id
224
226
        self.parent_id = parent_id
225
 
        self.symlink_target = None
226
 
        self.reference_revision = None
227
227
 
228
228
    def kind_character(self):
229
229
        """Return a short kind indicator useful for appending to names."""
230
 
        raise BzrError('unknown kind %r' % self.kind)
 
230
        raise errors.BzrError('unknown kind %r' % self.kind)
231
231
 
232
232
    known_kinds = ('file', 'directory', 'symlink')
233
233
 
234
 
    def _put_in_tar(self, item, tree):
235
 
        """populate item for stashing in a tar, and return the content stream.
236
 
 
237
 
        If no content is available, return None.
238
 
        """
239
 
        raise BzrError("don't know how to export {%s} of kind %r" %
240
 
                       (self.file_id, self.kind))
241
 
 
242
 
    @deprecated_method(deprecated_in((1, 6, 0)))
243
 
    def put_on_disk(self, dest, dp, tree):
244
 
        """Create a representation of self on disk in the prefix dest.
245
 
        
246
 
        This is a template method - implement _put_on_disk in subclasses.
247
 
        """
248
 
        fullpath = osutils.pathjoin(dest, dp)
249
 
        self._put_on_disk(fullpath, tree)
250
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
251
 
        #         self.kind, fullpath)
252
 
 
253
 
    def _put_on_disk(self, fullpath, tree):
254
 
        """Put this entry onto disk at fullpath, from tree tree."""
255
 
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
256
 
 
257
234
    def sorted_children(self):
258
235
        return sorted(self.children.items())
259
236
 
261
238
    def versionable_kind(kind):
262
239
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
263
240
 
264
 
    def check(self, checker, rev_id, inv, tree):
 
241
    def check(self, checker, rev_id, inv):
265
242
        """Check this inventory entry is intact.
266
243
 
267
244
        This is a template method, override _check for kind specific
268
245
        tests.
269
246
 
270
 
        :param checker: Check object providing context for the checks; 
 
247
        :param checker: Check object providing context for the checks;
271
248
             can be used to find out what parts of the repository have already
272
249
             been checked.
273
250
        :param rev_id: Revision id from which this InventoryEntry was loaded.
274
251
             Not necessarily the last-changed revision for this file.
275
252
        :param inv: Inventory from which the entry was loaded.
276
 
        :param tree: RevisionTree for this entry.
277
253
        """
278
254
        if self.parent_id is not None:
279
255
            if not inv.has_id(self.parent_id):
280
 
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
281
 
                        % (self.parent_id, rev_id))
282
 
        self._check(checker, rev_id, tree)
 
256
                raise errors.BzrCheckError(
 
257
                    'missing parent {%s} in inventory for revision {%s}' % (
 
258
                        self.parent_id, rev_id))
 
259
        checker._add_entry_to_text_key_references(inv, self)
 
260
        self._check(checker, rev_id)
283
261
 
284
 
    def _check(self, checker, rev_id, tree):
 
262
    def _check(self, checker, rev_id):
285
263
        """Check this inventory entry for kind specific errors."""
286
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
287
 
                            (self.kind, rev_id))
 
264
        checker._report_items.append(
 
265
            'unknown entry kind %r in revision {%s}' % (self.kind, rev_id))
288
266
 
289
267
    def copy(self):
290
268
        """Clone this inventory entry."""
293
271
    @staticmethod
294
272
    def describe_change(old_entry, new_entry):
295
273
        """Describe the change between old_entry and this.
296
 
        
 
274
 
297
275
        This smells of being an InterInventoryEntry situation, but as its
298
276
        the first one, we're making it a static method for now.
299
277
 
300
 
        An entry with a different parent, or different name is considered 
 
278
        An entry with a different parent, or different name is considered
301
279
        to be renamed. Reparenting is an internal detail.
302
280
        Note that renaming the parent does not trigger a rename for the
303
281
        child entry itself.
341
319
                   self.revision))
342
320
 
343
321
    def __eq__(self, other):
 
322
        if other is self:
 
323
            # For the case when objects are cached
 
324
            return True
344
325
        if not isinstance(other, InventoryEntry):
345
326
            return NotImplemented
346
327
 
381
362
 
382
363
    def _read_tree_state(self, path, work_tree):
383
364
        """Populate fields in the inventory entry from the given tree.
384
 
        
 
365
 
385
366
        Note that this should be modified to be a noop on virtual trees
386
367
        as all entries created there are prepopulated.
387
368
        """
388
 
        # TODO: Rather than running this manually, we should check the 
 
369
        # TODO: Rather than running this manually, we should check the
389
370
        # working sha1 and other expensive properties when they're
390
371
        # first requested, or preload them if they're already known
391
372
        pass            # nothing to do by default
394
375
        pass
395
376
 
396
377
 
397
 
class RootEntry(InventoryEntry):
398
 
 
399
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
400
 
                 'text_id', 'parent_id', 'children', 'executable',
401
 
                 'revision', 'symlink_target', 'reference_revision']
402
 
 
403
 
    def _check(self, checker, rev_id, tree):
404
 
        """See InventoryEntry._check"""
405
 
 
406
 
    def __init__(self, file_id):
407
 
        self.file_id = file_id
408
 
        self.children = {}
409
 
        self.kind = 'directory'
410
 
        self.parent_id = None
411
 
        self.name = u''
412
 
        self.revision = None
413
 
        symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
414
 
                               '  Please use InventoryDirectory instead.',
415
 
                               DeprecationWarning, stacklevel=2)
416
 
 
417
 
    def __eq__(self, other):
418
 
        if not isinstance(other, RootEntry):
419
 
            return NotImplemented
420
 
        
421
 
        return (self.file_id == other.file_id) \
422
 
               and (self.children == other.children)
423
 
 
424
 
 
425
378
class InventoryDirectory(InventoryEntry):
426
379
    """A directory in an inventory."""
427
380
 
428
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
429
 
                 'text_id', 'parent_id', 'children', 'executable',
430
 
                 'revision', 'symlink_target', 'reference_revision']
431
 
 
432
 
    def _check(self, checker, rev_id, tree):
 
381
    __slots__ = ['children']
 
382
 
 
383
    kind = 'directory'
 
384
 
 
385
    def _check(self, checker, rev_id):
433
386
        """See InventoryEntry._check"""
434
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
435
 
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
 
                                % (self.file_id, rev_id))
 
387
        # In non rich root repositories we do not expect a file graph for the
 
388
        # root.
 
389
        if self.name == '' and not checker.rich_roots:
 
390
            return
 
391
        # Directories are stored as an empty file, but the file should exist
 
392
        # to provide a per-fileid log. The hash of every directory content is
 
393
        # "da..." below (the sha1sum of '').
 
394
        checker.add_pending_item(rev_id,
 
395
            ('texts', self.file_id, self.revision), 'text',
 
396
             'da39a3ee5e6b4b0d3255bfef95601890afd80709')
437
397
 
438
398
    def copy(self):
439
399
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
445
405
    def __init__(self, file_id, name, parent_id):
446
406
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
447
407
        self.children = {}
448
 
        self.kind = 'directory'
449
408
 
450
409
    def kind_character(self):
451
410
        """See InventoryEntry.kind_character."""
452
411
        return '/'
453
412
 
454
 
    def _put_in_tar(self, item, tree):
455
 
        """See InventoryEntry._put_in_tar."""
456
 
        item.type = tarfile.DIRTYPE
457
 
        fileobj = None
458
 
        item.name += '/'
459
 
        item.size = 0
460
 
        item.mode = 0755
461
 
        return fileobj
462
 
 
463
 
    def _put_on_disk(self, fullpath, tree):
464
 
        """See InventoryEntry._put_on_disk."""
465
 
        os.mkdir(fullpath)
466
 
 
467
413
 
468
414
class InventoryFile(InventoryEntry):
469
415
    """A file in an inventory."""
470
416
 
471
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
472
 
                 'text_id', 'parent_id', 'children', 'executable',
473
 
                 'revision', 'symlink_target', 'reference_revision']
474
 
 
475
 
    def _check(self, checker, tree_revision_id, tree):
 
417
    __slots__ = ['text_sha1', 'text_size', 'text_id', 'executable']
 
418
 
 
419
    kind = 'file'
 
420
 
 
421
    def __init__(self, file_id, name, parent_id):
 
422
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
423
        self.text_sha1 = None
 
424
        self.text_size = None
 
425
        self.text_id = None
 
426
        self.executable = False
 
427
 
 
428
    def _check(self, checker, tree_revision_id):
476
429
        """See InventoryEntry._check"""
477
 
        key = (self.file_id, self.revision)
478
 
        if key in checker.checked_texts:
479
 
            prev_sha = checker.checked_texts[key]
480
 
            if prev_sha != self.text_sha1:
481
 
                raise BzrCheckError(
482
 
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
483
 
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
484
 
                     t))
485
 
            else:
486
 
                checker.repeated_text_cnt += 1
487
 
                return
488
 
 
489
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
490
 
        checker.checked_text_cnt += 1
491
 
        # We can't check the length, because Weave doesn't store that
492
 
        # information, and the whole point of looking at the weave's
493
 
        # sha1sum is that we don't have to extract the text.
494
 
        if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
495
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
496
 
        checker.checked_texts[key] = self.text_sha1
 
430
        # TODO: check size too.
 
431
        checker.add_pending_item(tree_revision_id,
 
432
            ('texts', self.file_id, self.revision), 'text',
 
433
             self.text_sha1)
 
434
        if self.text_size is None:
 
435
            checker._report_items.append(
 
436
                'fileid {%s} in {%s} has None for text_size' % (self.file_id,
 
437
                tree_revision_id))
497
438
 
498
439
    def copy(self):
499
440
        other = InventoryFile(self.file_id, self.name, self.parent_id)
531
472
        """See InventoryEntry.has_text."""
532
473
        return True
533
474
 
534
 
    def __init__(self, file_id, name, parent_id):
535
 
        super(InventoryFile, self).__init__(file_id, name, parent_id)
536
 
        self.kind = 'file'
537
 
 
538
475
    def kind_character(self):
539
476
        """See InventoryEntry.kind_character."""
540
477
        return ''
541
478
 
542
 
    def _put_in_tar(self, item, tree):
543
 
        """See InventoryEntry._put_in_tar."""
544
 
        item.type = tarfile.REGTYPE
545
 
        fileobj = tree.get_file(self.file_id)
546
 
        item.size = self.text_size
547
 
        if tree.is_executable(self.file_id):
548
 
            item.mode = 0755
549
 
        else:
550
 
            item.mode = 0644
551
 
        return fileobj
552
 
 
553
 
    def _put_on_disk(self, fullpath, tree):
554
 
        """See InventoryEntry._put_on_disk."""
555
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
556
 
        if tree.is_executable(self.file_id):
557
 
            os.chmod(fullpath, 0755)
558
 
 
559
479
    def _read_tree_state(self, path, work_tree):
560
480
        """See InventoryEntry._read_tree_state."""
561
481
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
564
484
        self.executable = work_tree.is_executable(self.file_id, path=path)
565
485
 
566
486
    def __repr__(self):
567
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
 
487
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s, revision=%s)"
568
488
                % (self.__class__.__name__,
569
489
                   self.file_id,
570
490
                   self.name,
571
491
                   self.parent_id,
572
492
                   self.text_sha1,
573
 
                   self.text_size))
 
493
                   self.text_size,
 
494
                   self.revision))
574
495
 
575
496
    def _forget_tree_state(self):
576
497
        self.text_sha1 = None
592
513
class InventoryLink(InventoryEntry):
593
514
    """A file in an inventory."""
594
515
 
595
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
596
 
                 'text_id', 'parent_id', 'children', 'executable',
597
 
                 'revision', 'symlink_target', 'reference_revision']
598
 
 
599
 
    def _check(self, checker, rev_id, tree):
 
516
    __slots__ = ['symlink_target']
 
517
 
 
518
    kind = 'symlink'
 
519
 
 
520
    def __init__(self, file_id, name, parent_id):
 
521
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
522
        self.symlink_target = None
 
523
 
 
524
    def _check(self, checker, tree_revision_id):
600
525
        """See InventoryEntry._check"""
601
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
602
 
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
 
                    % (self.file_id, rev_id))
604
526
        if self.symlink_target is None:
605
 
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
 
                    % (self.file_id, rev_id))
 
527
            checker._report_items.append(
 
528
                'symlink {%s} has no target in revision {%s}'
 
529
                    % (self.file_id, tree_revision_id))
 
530
        # Symlinks are stored as ''
 
531
        checker.add_pending_item(tree_revision_id,
 
532
            ('texts', self.file_id, self.revision), 'text',
 
533
             'da39a3ee5e6b4b0d3255bfef95601890afd80709')
607
534
 
608
535
    def copy(self):
609
536
        other = InventoryLink(self.file_id, self.name, self.parent_id)
616
543
        # FIXME: which _modified field should we use ? RBC 20051003
617
544
        text_modified = (self.symlink_target != old_entry.symlink_target)
618
545
        if text_modified:
619
 
            mutter("    symlink target changed")
 
546
            trace.mutter("    symlink target changed")
620
547
        meta_modified = False
621
548
        return text_modified, meta_modified
622
549
 
639
566
        differ = DiffSymlink(old_tree, new_tree, output_to)
640
567
        return differ.diff_symlink(old_target, new_target)
641
568
 
642
 
    def __init__(self, file_id, name, parent_id):
643
 
        super(InventoryLink, self).__init__(file_id, name, parent_id)
644
 
        self.kind = 'symlink'
645
 
 
646
569
    def kind_character(self):
647
570
        """See InventoryEntry.kind_character."""
648
571
        return ''
649
572
 
650
 
    def _put_in_tar(self, item, tree):
651
 
        """See InventoryEntry._put_in_tar."""
652
 
        item.type = tarfile.SYMTYPE
653
 
        fileobj = None
654
 
        item.size = 0
655
 
        item.mode = 0755
656
 
        item.linkname = self.symlink_target
657
 
        return fileobj
658
 
 
659
 
    def _put_on_disk(self, fullpath, tree):
660
 
        """See InventoryEntry._put_on_disk."""
661
 
        try:
662
 
            os.symlink(self.symlink_target, fullpath)
663
 
        except OSError,e:
664
 
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
665
 
 
666
573
    def _read_tree_state(self, path, work_tree):
667
574
        """See InventoryEntry._read_tree_state."""
668
575
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
679
586
 
680
587
 
681
588
class TreeReference(InventoryEntry):
682
 
    
 
589
 
 
590
    __slots__ = ['reference_revision']
 
591
 
683
592
    kind = 'tree-reference'
684
 
    
 
593
 
685
594
    def __init__(self, file_id, name, parent_id, revision=None,
686
595
                 reference_revision=None):
687
596
        InventoryEntry.__init__(self, file_id, name, parent_id)
699
608
            self.file_id, path)
700
609
 
701
610
    def _forget_tree_state(self):
702
 
        self.reference_revision = None 
 
611
        self.reference_revision = None
703
612
 
704
613
    def _unchanged(self, previous_ie):
705
614
        """See InventoryEntry._unchanged."""
709
618
        return compatible
710
619
 
711
620
 
712
 
class Inventory(object):
713
 
    """Inventory of versioned files in a tree.
714
 
 
715
 
    This describes which file_id is present at each point in the tree,
716
 
    and possibly the SHA-1 or other information about the file.
 
621
class CommonInventory(object):
 
622
    """Basic inventory logic, defined in terms of primitives like has_id.
 
623
 
 
624
    An inventory is the metadata about the contents of a tree.
 
625
 
 
626
    This is broadly a map from file_id to entries such as directories, files,
 
627
    symlinks and tree references. Each entry maintains its own metadata like
 
628
    SHA1 and length for files, or children for a directory.
 
629
 
717
630
    Entries can be looked up either by path or by file_id.
718
631
 
719
 
    The inventory represents a typical unix file tree, with
720
 
    directories containing files and subdirectories.  We never store
721
 
    the full path to a file, because renaming a directory implicitly
722
 
    moves all of its contents.  This class internally maintains a
723
 
    lookup tree that allows the children under a directory to be
724
 
    returned quickly.
725
 
 
726
632
    InventoryEntry objects must not be modified after they are
727
633
    inserted, other than through the Inventory API.
728
 
 
729
 
    >>> inv = Inventory()
730
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
731
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
732
 
    >>> inv['123-123'].name
733
 
    'hello.c'
734
 
 
735
 
    May be treated as an iterator or set to look up file ids:
736
 
    
737
 
    >>> bool(inv.path2id('hello.c'))
738
 
    True
739
 
    >>> '123-123' in inv
740
 
    True
741
 
 
742
 
    May also look up by name:
743
 
 
744
 
    >>> [x[0] for x in inv.iter_entries()]
745
 
    ['', u'hello.c']
746
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
747
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
748
 
    Traceback (most recent call last):
749
 
    BzrError: parent_id {TREE_ROOT} not in inventory
750
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
751
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
752
634
    """
753
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
754
 
        """Create or read an inventory.
755
 
 
756
 
        If a working directory is specified, the inventory is read
757
 
        from there.  If the file is specified, read from that. If not,
758
 
        the inventory is created empty.
759
 
 
760
 
        The inventory is created with a default root directory, with
761
 
        an id of None.
762
 
        """
763
 
        if root_id is not None:
764
 
            self._set_root(InventoryDirectory(root_id, u'', None))
765
 
        else:
766
 
            self.root = None
767
 
            self._byid = {}
768
 
        self.revision_id = revision_id
769
 
 
770
 
    def __repr__(self):
771
 
        return "<Inventory object at %x, contents=%r>" % (id(self), self._byid)
772
 
 
773
 
    def apply_delta(self, delta):
774
 
        """Apply a delta to this inventory.
775
 
 
776
 
        :param delta: A list of changes to apply. After all the changes are
777
 
            applied the final inventory must be internally consistent, but it
778
 
            is ok to supply changes which, if only half-applied would have an
779
 
            invalid result - such as supplying two changes which rename two
780
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
781
 
            ('B', 'A', 'B-id', b_entry)].
782
 
 
783
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
784
 
            new_entry).
785
 
            
786
 
            When new_path is None, the change indicates the removal of an entry
787
 
            from the inventory and new_entry will be ignored (using None is
788
 
            appropriate). If new_path is not None, then new_entry must be an
789
 
            InventoryEntry instance, which will be incorporated into the
790
 
            inventory (and replace any existing entry with the same file id).
791
 
            
792
 
            When old_path is None, the change indicates the addition of
793
 
            a new entry to the inventory.
794
 
            
795
 
            When neither new_path nor old_path are None, the change is a
796
 
            modification to an entry, such as a rename, reparent, kind change
797
 
            etc. 
798
 
 
799
 
            The children attribute of new_entry is ignored. This is because
800
 
            this method preserves children automatically across alterations to
801
 
            the parent of the children, and cases where the parent id of a
802
 
            child is changing require the child to be passed in as a separate
803
 
            change regardless. E.g. in the recursive deletion of a directory -
804
 
            the directory's children must be included in the delta, or the
805
 
            final inventory will be invalid.
806
 
        """
807
 
        children = {}
808
 
        # Remove all affected items which were in the original inventory,
809
 
        # starting with the longest paths, thus ensuring parents are examined
810
 
        # after their children, which means that everything we examine has no
811
 
        # modified children remaining by the time we examine it.
812
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
813
 
                                        if op is not None), reverse=True):
814
 
            if file_id not in self:
815
 
                # adds come later
816
 
                continue
817
 
            # Preserve unaltered children of file_id for later reinsertion.
818
 
            file_id_children = getattr(self[file_id], 'children', {})
819
 
            if len(file_id_children):
820
 
                children[file_id] = file_id_children
821
 
            # Remove file_id and the unaltered children. If file_id is not
822
 
            # being deleted it will be reinserted back later.
823
 
            self.remove_recursive_id(file_id)
824
 
        # Insert all affected which should be in the new inventory, reattaching
825
 
        # their children if they had any. This is done from shortest path to
826
 
        # longest, ensuring that items which were modified and whose parents in
827
 
        # the resulting inventory were also modified, are inserted after their
828
 
        # parents.
829
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
830
 
                                          delta if np is not None):
831
 
            if new_entry.kind == 'directory':
832
 
                # Pop the child which to allow detection of children whose
833
 
                # parents were deleted and which were not reattached to a new
834
 
                # parent.
835
 
                new_entry.children = children.pop(new_entry.file_id, {})
836
 
            self.add(new_entry)
837
 
        if len(children):
838
 
            # Get the parent id that was deleted
839
 
            parent_id, children = children.popitem()
840
 
            raise errors.InconsistentDelta("<deleted>", parent_id,
841
 
                "The file id was deleted but its children were not deleted.")
842
 
 
843
 
    def _set_root(self, ie):
844
 
        self.root = ie
845
 
        self._byid = {self.root.file_id: self.root}
846
 
 
847
 
    def copy(self):
848
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
849
 
        entries = self.iter_entries()
850
 
        if self.root is None:
851
 
            return Inventory(root_id=None)
852
 
        other = Inventory(entries.next()[1].file_id)
853
 
        other.root.revision = self.root.revision
854
 
        # copy recursively so we know directories will be added before
855
 
        # their children.  There are more efficient ways than this...
856
 
        for path, entry in entries:
857
 
            other.add(entry.copy())
858
 
        return other
859
 
 
860
 
    def __iter__(self):
861
 
        return iter(self._byid)
862
 
 
863
 
    def __len__(self):
864
 
        """Returns number of entries."""
865
 
        return len(self._byid)
866
 
 
867
 
    def iter_entries(self, from_dir=None):
868
 
        """Return (path, entry) pairs, in order by name."""
 
635
 
 
636
    def has_filename(self, filename):
 
637
        return bool(self.path2id(filename))
 
638
 
 
639
    def id2path(self, file_id):
 
640
        """Return as a string the path to file_id.
 
641
 
 
642
        >>> i = Inventory()
 
643
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
644
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
645
        >>> print i.id2path('foo-id')
 
646
        src/foo.c
 
647
 
 
648
        :raises NoSuchId: If file_id is not present in the inventory.
 
649
        """
 
650
        # get all names, skipping root
 
651
        return '/'.join(reversed(
 
652
            [parent.name for parent in
 
653
             self._iter_file_id_parents(file_id)][:-1]))
 
654
 
 
655
    def iter_entries(self, from_dir=None, recursive=True):
 
656
        """Return (path, entry) pairs, in order by name.
 
657
        
 
658
        :param from_dir: if None, start from the root,
 
659
          otherwise start from this directory (either file-id or entry)
 
660
        :param recursive: recurse into directories or not
 
661
        """
869
662
        if from_dir is None:
870
663
            if self.root is None:
871
664
                return
872
665
            from_dir = self.root
873
666
            yield '', self.root
874
667
        elif isinstance(from_dir, basestring):
875
 
            from_dir = self._byid[from_dir]
876
 
            
 
668
            from_dir = self[from_dir]
 
669
 
877
670
        # unrolling the recursive called changed the time from
878
671
        # 440ms/663ms (inline/total) to 116ms/116ms
879
672
        children = from_dir.children.items()
880
673
        children.sort()
 
674
        if not recursive:
 
675
            for name, ie in children:
 
676
                yield name, ie
 
677
            return
881
678
        children = collections.deque(children)
882
679
        stack = [(u'', children)]
883
680
        while stack:
908
705
                # if we finished all children, pop it off the stack
909
706
                stack.pop()
910
707
 
 
708
    def _preload_cache(self):
 
709
        """Populate any caches, we are about to access all items.
 
710
        
 
711
        The default implementation does nothing, because CommonInventory doesn't
 
712
        have a cache.
 
713
        """
 
714
        pass
 
715
    
911
716
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
912
717
        yield_parents=False):
913
718
        """Iterate over the entries in a directory first order.
926
731
            specific_file_ids = set(specific_file_ids)
927
732
        # TODO? Perhaps this should return the from_dir so that the root is
928
733
        # yielded? or maybe an option?
 
734
        if from_dir is None and specific_file_ids is None:
 
735
            # They are iterating from the root, and have not specified any
 
736
            # specific entries to look at. All current callers fully consume the
 
737
            # iterator, so we can safely assume we are accessing all entries
 
738
            self._preload_cache()
929
739
        if from_dir is None:
930
740
            if self.root is None:
931
741
                return
933
743
            if (not yield_parents and specific_file_ids is not None and
934
744
                len(specific_file_ids) == 1):
935
745
                file_id = list(specific_file_ids)[0]
936
 
                if file_id in self:
 
746
                if self.has_id(file_id):
937
747
                    yield self.id2path(file_id), self[file_id]
938
 
                return 
 
748
                return
939
749
            from_dir = self.root
940
750
            if (specific_file_ids is None or yield_parents or
941
751
                self.root.file_id in specific_file_ids):
942
752
                yield u'', self.root
943
753
        elif isinstance(from_dir, basestring):
944
 
            from_dir = self._byid[from_dir]
 
754
            from_dir = self[from_dir]
945
755
 
946
756
        if specific_file_ids is not None:
947
757
            # TODO: jam 20070302 This could really be done as a loop rather
948
758
            #       than a bunch of recursive calls.
949
759
            parents = set()
950
 
            byid = self._byid
 
760
            byid = self
951
761
            def add_ancestors(file_id):
952
 
                if file_id not in byid:
 
762
                if not byid.has_id(file_id):
953
763
                    return
954
764
                parent_id = byid[file_id].parent_id
955
765
                if parent_id is None:
961
771
                add_ancestors(file_id)
962
772
        else:
963
773
            parents = None
964
 
            
 
774
 
965
775
        stack = [(u'', from_dir)]
966
776
        while stack:
967
777
            cur_relpath, cur_dir = stack.pop()
971
781
 
972
782
                child_relpath = cur_relpath + child_name
973
783
 
974
 
                if (specific_file_ids is None or 
 
784
                if (specific_file_ids is None or
975
785
                    child_ie.file_id in specific_file_ids or
976
786
                    (yield_parents and child_ie.file_id in parents)):
977
787
                    yield child_relpath, child_ie
981
791
                        child_dirs.append((child_relpath+'/', child_ie))
982
792
            stack.extend(reversed(child_dirs))
983
793
 
 
794
    def _make_delta(self, old):
 
795
        """Make an inventory delta from two inventories."""
 
796
        old_ids = set(old)
 
797
        new_ids = set(self)
 
798
        adds = new_ids - old_ids
 
799
        deletes = old_ids - new_ids
 
800
        common = old_ids.intersection(new_ids)
 
801
        delta = []
 
802
        for file_id in deletes:
 
803
            delta.append((old.id2path(file_id), None, file_id, None))
 
804
        for file_id in adds:
 
805
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
 
806
        for file_id in common:
 
807
            if old[file_id] != self[file_id]:
 
808
                delta.append((old.id2path(file_id), self.id2path(file_id),
 
809
                    file_id, self[file_id]))
 
810
        return delta
 
811
 
984
812
    def make_entry(self, kind, name, parent_id, file_id=None):
985
813
        """Simple thunk to bzrlib.inventory.make_entry."""
986
814
        return make_entry(kind, name, parent_id, file_id)
1000
828
                if ie.kind == 'directory':
1001
829
                    descend(ie, child_path)
1002
830
 
1003
 
        descend(self.root, u'')
1004
 
        return accum
1005
 
 
1006
 
    def directories(self):
1007
 
        """Return (path, entry) pairs for all directories, including the root.
1008
 
        """
1009
 
        accum = []
1010
 
        def descend(parent_ie, parent_path):
1011
 
            accum.append((parent_path, parent_ie))
1012
 
            
1013
 
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
1014
 
            kids.sort()
1015
 
 
1016
 
            for name, child_ie in kids:
1017
 
                child_path = osutils.pathjoin(parent_path, name)
1018
 
                descend(child_ie, child_path)
1019
 
        descend(self.root, u'')
1020
 
        return accum
 
831
        if self.root is not None:
 
832
            descend(self.root, u'')
 
833
        return accum
 
834
 
 
835
    def path2id(self, relpath):
 
836
        """Walk down through directories to return entry of last component.
 
837
 
 
838
        :param relpath: may be either a list of path components, or a single
 
839
            string, in which case it is automatically split.
 
840
 
 
841
        This returns the entry of the last component in the path,
 
842
        which may be either a file or a directory.
 
843
 
 
844
        Returns None IFF the path is not found.
 
845
        """
 
846
        if isinstance(relpath, basestring):
 
847
            names = osutils.splitpath(relpath)
 
848
        else:
 
849
            names = relpath
 
850
 
 
851
        try:
 
852
            parent = self.root
 
853
        except errors.NoSuchId:
 
854
            # root doesn't exist yet so nothing else can
 
855
            return None
 
856
        if parent is None:
 
857
            return None
 
858
        for f in names:
 
859
            try:
 
860
                children = getattr(parent, 'children', None)
 
861
                if children is None:
 
862
                    return None
 
863
                cie = children[f]
 
864
                parent = cie
 
865
            except KeyError:
 
866
                # or raise an error?
 
867
                return None
 
868
 
 
869
        return parent.file_id
 
870
 
 
871
    def filter(self, specific_fileids):
 
872
        """Get an inventory view filtered against a set of file-ids.
 
873
 
 
874
        Children of directories and parents are included.
 
875
 
 
876
        The result may or may not reference the underlying inventory
 
877
        so it should be treated as immutable.
 
878
        """
 
879
        interesting_parents = set()
 
880
        for fileid in specific_fileids:
 
881
            try:
 
882
                interesting_parents.update(self.get_idpath(fileid))
 
883
            except errors.NoSuchId:
 
884
                # This fileid is not in the inventory - that's ok
 
885
                pass
 
886
        entries = self.iter_entries()
 
887
        if self.root is None:
 
888
            return Inventory(root_id=None)
 
889
        other = Inventory(entries.next()[1].file_id)
 
890
        other.root.revision = self.root.revision
 
891
        other.revision_id = self.revision_id
 
892
        directories_to_expand = set()
 
893
        for path, entry in entries:
 
894
            file_id = entry.file_id
 
895
            if (file_id in specific_fileids
 
896
                or entry.parent_id in directories_to_expand):
 
897
                if entry.kind == 'directory':
 
898
                    directories_to_expand.add(file_id)
 
899
            elif file_id not in interesting_parents:
 
900
                continue
 
901
            other.add(entry.copy())
 
902
        return other
 
903
 
 
904
    def get_idpath(self, file_id):
 
905
        """Return a list of file_ids for the path to an entry.
 
906
 
 
907
        The list contains one element for each directory followed by
 
908
        the id of the file itself.  So the length of the returned list
 
909
        is equal to the depth of the file in the tree, counting the
 
910
        root directory as depth 1.
 
911
        """
 
912
        p = []
 
913
        for parent in self._iter_file_id_parents(file_id):
 
914
            p.insert(0, parent.file_id)
 
915
        return p
 
916
 
 
917
 
 
918
class Inventory(CommonInventory):
 
919
    """Mutable dict based in-memory inventory.
 
920
 
 
921
    We never store the full path to a file, because renaming a directory
 
922
    implicitly moves all of its contents.  This class internally maintains a
 
923
    lookup tree that allows the children under a directory to be
 
924
    returned quickly.
 
925
 
 
926
    >>> inv = Inventory()
 
927
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
928
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
929
    >>> inv['123-123'].name
 
930
    'hello.c'
 
931
 
 
932
    Id's may be looked up from paths:
 
933
 
 
934
    >>> inv.path2id('hello.c')
 
935
    '123-123'
 
936
    >>> inv.has_id('123-123')
 
937
    True
 
938
 
 
939
    There are iterators over the contents:
 
940
 
 
941
    >>> [entry[0] for entry in inv.iter_entries()]
 
942
    ['', u'hello.c']
 
943
    """
 
944
 
 
945
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
946
        """Create or read an inventory.
 
947
 
 
948
        If a working directory is specified, the inventory is read
 
949
        from there.  If the file is specified, read from that. If not,
 
950
        the inventory is created empty.
 
951
 
 
952
        The inventory is created with a default root directory, with
 
953
        an id of None.
 
954
        """
 
955
        if root_id is not None:
 
956
            self._set_root(InventoryDirectory(root_id, u'', None))
 
957
        else:
 
958
            self.root = None
 
959
            self._byid = {}
 
960
        self.revision_id = revision_id
 
961
 
 
962
    def __repr__(self):
 
963
        # More than one page of ouput is not useful anymore to debug
 
964
        max_len = 2048
 
965
        closing = '...}'
 
966
        contents = repr(self._byid)
 
967
        if len(contents) > max_len:
 
968
            contents = contents[:(max_len-len(closing))] + closing
 
969
        return "<Inventory object at %x, contents=%r>" % (id(self), contents)
 
970
 
 
971
    def apply_delta(self, delta):
 
972
        """Apply a delta to this inventory.
 
973
 
 
974
        See the inventory developers documentation for the theory behind
 
975
        inventory deltas.
 
976
 
 
977
        If delta application fails the inventory is left in an indeterminate
 
978
        state and must not be used.
 
979
 
 
980
        :param delta: A list of changes to apply. After all the changes are
 
981
            applied the final inventory must be internally consistent, but it
 
982
            is ok to supply changes which, if only half-applied would have an
 
983
            invalid result - such as supplying two changes which rename two
 
984
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
 
985
            ('B', 'A', 'B-id', b_entry)].
 
986
 
 
987
            Each change is a tuple, of the form (old_path, new_path, file_id,
 
988
            new_entry).
 
989
 
 
990
            When new_path is None, the change indicates the removal of an entry
 
991
            from the inventory and new_entry will be ignored (using None is
 
992
            appropriate). If new_path is not None, then new_entry must be an
 
993
            InventoryEntry instance, which will be incorporated into the
 
994
            inventory (and replace any existing entry with the same file id).
 
995
 
 
996
            When old_path is None, the change indicates the addition of
 
997
            a new entry to the inventory.
 
998
 
 
999
            When neither new_path nor old_path are None, the change is a
 
1000
            modification to an entry, such as a rename, reparent, kind change
 
1001
            etc.
 
1002
 
 
1003
            The children attribute of new_entry is ignored. This is because
 
1004
            this method preserves children automatically across alterations to
 
1005
            the parent of the children, and cases where the parent id of a
 
1006
            child is changing require the child to be passed in as a separate
 
1007
            change regardless. E.g. in the recursive deletion of a directory -
 
1008
            the directory's children must be included in the delta, or the
 
1009
            final inventory will be invalid.
 
1010
 
 
1011
            Note that a file_id must only appear once within a given delta.
 
1012
            An AssertionError is raised otherwise.
 
1013
        """
 
1014
        # Check that the delta is legal. It would be nice if this could be
 
1015
        # done within the loops below but it's safer to validate the delta
 
1016
        # before starting to mutate the inventory, as there isn't a rollback
 
1017
        # facility.
 
1018
        list(_check_delta_unique_ids(_check_delta_unique_new_paths(
 
1019
            _check_delta_unique_old_paths(_check_delta_ids_match_entry(
 
1020
            _check_delta_ids_are_valid(
 
1021
            _check_delta_new_path_entry_both_or_None(
 
1022
            delta)))))))
 
1023
 
 
1024
        children = {}
 
1025
        # Remove all affected items which were in the original inventory,
 
1026
        # starting with the longest paths, thus ensuring parents are examined
 
1027
        # after their children, which means that everything we examine has no
 
1028
        # modified children remaining by the time we examine it.
 
1029
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
 
1030
                                        if op is not None), reverse=True):
 
1031
            # Preserve unaltered children of file_id for later reinsertion.
 
1032
            file_id_children = getattr(self[file_id], 'children', {})
 
1033
            if len(file_id_children):
 
1034
                children[file_id] = file_id_children
 
1035
            if self.id2path(file_id) != old_path:
 
1036
                raise errors.InconsistentDelta(old_path, file_id,
 
1037
                    "Entry was at wrong other path %r." % self.id2path(file_id))
 
1038
            # Remove file_id and the unaltered children. If file_id is not
 
1039
            # being deleted it will be reinserted back later.
 
1040
            self.remove_recursive_id(file_id)
 
1041
        # Insert all affected which should be in the new inventory, reattaching
 
1042
        # their children if they had any. This is done from shortest path to
 
1043
        # longest, ensuring that items which were modified and whose parents in
 
1044
        # the resulting inventory were also modified, are inserted after their
 
1045
        # parents.
 
1046
        for new_path, f, new_entry in sorted((np, f, e) for op, np, f, e in
 
1047
                                          delta if np is not None):
 
1048
            if new_entry.kind == 'directory':
 
1049
                # Pop the child which to allow detection of children whose
 
1050
                # parents were deleted and which were not reattached to a new
 
1051
                # parent.
 
1052
                replacement = InventoryDirectory(new_entry.file_id,
 
1053
                    new_entry.name, new_entry.parent_id)
 
1054
                replacement.revision = new_entry.revision
 
1055
                replacement.children = children.pop(replacement.file_id, {})
 
1056
                new_entry = replacement
 
1057
            try:
 
1058
                self.add(new_entry)
 
1059
            except errors.DuplicateFileId:
 
1060
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1061
                    "New id is already present in target.")
 
1062
            except AttributeError:
 
1063
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1064
                    "Parent is not a directory.")
 
1065
            if self.id2path(new_entry.file_id) != new_path:
 
1066
                raise errors.InconsistentDelta(new_path, new_entry.file_id,
 
1067
                    "New path is not consistent with parent path.")
 
1068
        if len(children):
 
1069
            # Get the parent id that was deleted
 
1070
            parent_id, children = children.popitem()
 
1071
            raise errors.InconsistentDelta("<deleted>", parent_id,
 
1072
                "The file id was deleted but its children were not deleted.")
 
1073
 
 
1074
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
 
1075
                              propagate_caches=False):
 
1076
        """See CHKInventory.create_by_apply_delta()"""
 
1077
        new_inv = self.copy()
 
1078
        new_inv.apply_delta(inventory_delta)
 
1079
        new_inv.revision_id = new_revision_id
 
1080
        return new_inv
 
1081
 
 
1082
    def _set_root(self, ie):
 
1083
        self.root = ie
 
1084
        self._byid = {self.root.file_id: self.root}
 
1085
 
 
1086
    def copy(self):
 
1087
        # TODO: jam 20051218 Should copy also copy the revision_id?
 
1088
        entries = self.iter_entries()
 
1089
        if self.root is None:
 
1090
            return Inventory(root_id=None)
 
1091
        other = Inventory(entries.next()[1].file_id)
 
1092
        other.root.revision = self.root.revision
 
1093
        # copy recursively so we know directories will be added before
 
1094
        # their children.  There are more efficient ways than this...
 
1095
        for path, entry in entries:
 
1096
            other.add(entry.copy())
 
1097
        return other
 
1098
 
 
1099
    def __iter__(self):
 
1100
        """Iterate over all file-ids."""
 
1101
        return iter(self._byid)
 
1102
 
 
1103
    def iter_just_entries(self):
 
1104
        """Iterate over all entries.
1021
1105
        
1022
 
    def __contains__(self, file_id):
1023
 
        """True if this entry contains a file with given id.
 
1106
        Unlike iter_entries(), just the entries are returned (not (path, ie))
 
1107
        and the order of entries is undefined.
1024
1108
 
1025
 
        >>> inv = Inventory()
1026
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1027
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1028
 
        >>> '123' in inv
1029
 
        True
1030
 
        >>> '456' in inv
1031
 
        False
 
1109
        XXX: We may not want to merge this into bzr.dev.
1032
1110
        """
1033
 
        return (file_id in self._byid)
 
1111
        if self.root is None:
 
1112
            return
 
1113
        for _, ie in self._byid.iteritems():
 
1114
            yield ie
 
1115
 
 
1116
    def __len__(self):
 
1117
        """Returns number of entries."""
 
1118
        return len(self._byid)
1034
1119
 
1035
1120
    def __getitem__(self, file_id):
1036
1121
        """Return the entry for given file_id.
1037
1122
 
1038
1123
        >>> inv = Inventory()
1039
1124
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1040
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
1125
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1041
1126
        >>> inv['123123'].name
1042
1127
        'hello.c'
1043
1128
        """
1056
1141
    def _add_child(self, entry):
1057
1142
        """Add an entry to the inventory, without adding it to its parent"""
1058
1143
        if entry.file_id in self._byid:
1059
 
            raise BzrError("inventory already contains entry with id {%s}" %
1060
 
                           entry.file_id)
 
1144
            raise errors.BzrError(
 
1145
                "inventory already contains entry with id {%s}" %
 
1146
                entry.file_id)
1061
1147
        self._byid[entry.file_id] = entry
1062
1148
        for child in getattr(entry, 'children', {}).itervalues():
1063
1149
            self._add_child(child)
1066
1152
    def add(self, entry):
1067
1153
        """Add entry to inventory.
1068
1154
 
1069
 
        To add  a file to a branch ready to be committed, use Branch.add,
1070
 
        which calls this.
1071
 
 
1072
 
        Returns the new entry object.
 
1155
        :return: entry
1073
1156
        """
1074
1157
        if entry.file_id in self._byid:
1075
1158
            raise errors.DuplicateFileId(entry.file_id,
1076
1159
                                         self._byid[entry.file_id])
1077
 
 
1078
1160
        if entry.parent_id is None:
1079
1161
            self.root = entry
1080
1162
        else:
1081
1163
            try:
1082
1164
                parent = self._byid[entry.parent_id]
1083
1165
            except KeyError:
1084
 
                raise BzrError("parent_id {%s} not in inventory" %
1085
 
                               entry.parent_id)
1086
 
 
 
1166
                raise errors.InconsistentDelta("<unknown>", entry.parent_id,
 
1167
                    "Parent not in inventory.")
1087
1168
            if entry.name in parent.children:
1088
 
                raise BzrError("%s is already versioned" %
1089
 
                        osutils.pathjoin(self.id2path(parent.file_id),
1090
 
                        entry.name).encode('utf-8'))
 
1169
                raise errors.InconsistentDelta(
 
1170
                    self.id2path(parent.children[entry.name].file_id),
 
1171
                    entry.file_id,
 
1172
                    "Path already versioned")
1091
1173
            parent.children[entry.name] = entry
1092
1174
        return self._add_child(entry)
1093
1175
 
1097
1179
        The immediate parent must already be versioned.
1098
1180
 
1099
1181
        Returns the new entry object."""
1100
 
        
 
1182
 
1101
1183
        parts = osutils.splitpath(relpath)
1102
1184
 
1103
1185
        if len(parts) == 0:
1119
1201
 
1120
1202
        >>> inv = Inventory()
1121
1203
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1122
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1123
 
        >>> '123' in inv
 
1204
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
1205
        >>> inv.has_id('123')
1124
1206
        True
1125
1207
        >>> del inv['123']
1126
 
        >>> '123' in inv
 
1208
        >>> inv.has_id('123')
1127
1209
        False
1128
1210
        """
1129
1211
        ie = self[file_id]
1139
1221
        >>> i1 == i2
1140
1222
        True
1141
1223
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1142
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1224
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1143
1225
        >>> i1 == i2
1144
1226
        False
1145
1227
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1146
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1228
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1147
1229
        >>> i1 == i2
1148
1230
        True
1149
1231
        """
1168
1250
            yield ie
1169
1251
            file_id = ie.parent_id
1170
1252
 
1171
 
    def get_idpath(self, file_id):
1172
 
        """Return a list of file_ids for the path to an entry.
1173
 
 
1174
 
        The list contains one element for each directory followed by
1175
 
        the id of the file itself.  So the length of the returned list
1176
 
        is equal to the depth of the file in the tree, counting the
1177
 
        root directory as depth 1.
1178
 
        """
1179
 
        p = []
1180
 
        for parent in self._iter_file_id_parents(file_id):
1181
 
            p.insert(0, parent.file_id)
1182
 
        return p
1183
 
 
1184
 
    def id2path(self, file_id):
1185
 
        """Return as a string the path to file_id.
1186
 
        
1187
 
        >>> i = Inventory()
1188
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1189
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1190
 
        >>> print i.id2path('foo-id')
1191
 
        src/foo.c
1192
 
        """
1193
 
        # get all names, skipping root
1194
 
        return '/'.join(reversed(
1195
 
            [parent.name for parent in 
1196
 
             self._iter_file_id_parents(file_id)][:-1]))
1197
 
            
1198
 
    def path2id(self, name):
1199
 
        """Walk down through directories to return entry of last component.
1200
 
 
1201
 
        names may be either a list of path components, or a single
1202
 
        string, in which case it is automatically split.
1203
 
 
1204
 
        This returns the entry of the last component in the path,
1205
 
        which may be either a file or a directory.
1206
 
 
1207
 
        Returns None IFF the path is not found.
1208
 
        """
1209
 
        if isinstance(name, basestring):
1210
 
            name = osutils.splitpath(name)
1211
 
 
1212
 
        # mutter("lookup path %r" % name)
1213
 
 
1214
 
        parent = self.root
1215
 
        if parent is None:
1216
 
            return None
1217
 
        for f in name:
1218
 
            try:
1219
 
                children = getattr(parent, 'children', None)
1220
 
                if children is None:
1221
 
                    return None
1222
 
                cie = children[f]
1223
 
                parent = cie
1224
 
            except KeyError:
1225
 
                # or raise an error?
1226
 
                return None
1227
 
 
1228
 
        return parent.file_id
1229
 
 
1230
 
    def has_filename(self, names):
1231
 
        return bool(self.path2id(names))
1232
 
 
1233
1253
    def has_id(self, file_id):
1234
1254
        return (file_id in self._byid)
1235
1255
 
 
1256
    def _make_delta(self, old):
 
1257
        """Make an inventory delta from two inventories."""
 
1258
        old_getter = getattr(old, '_byid', old)
 
1259
        new_getter = self._byid
 
1260
        old_ids = set(old_getter)
 
1261
        new_ids = set(new_getter)
 
1262
        adds = new_ids - old_ids
 
1263
        deletes = old_ids - new_ids
 
1264
        if not adds and not deletes:
 
1265
            common = new_ids
 
1266
        else:
 
1267
            common = old_ids.intersection(new_ids)
 
1268
        delta = []
 
1269
        for file_id in deletes:
 
1270
            delta.append((old.id2path(file_id), None, file_id, None))
 
1271
        for file_id in adds:
 
1272
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
 
1273
        for file_id in common:
 
1274
            new_ie = new_getter[file_id]
 
1275
            old_ie = old_getter[file_id]
 
1276
            # If xml_serializer returns the cached InventoryEntries (rather
 
1277
            # than always doing .copy()), inlining the 'is' check saves 2.7M
 
1278
            # calls to __eq__.  Under lsprof this saves 20s => 6s.
 
1279
            # It is a minor improvement without lsprof.
 
1280
            if old_ie is new_ie or old_ie == new_ie:
 
1281
                continue
 
1282
            else:
 
1283
                delta.append((old.id2path(file_id), self.id2path(file_id),
 
1284
                              file_id, new_ie))
 
1285
        return delta
 
1286
 
1236
1287
    def remove_recursive_id(self, file_id):
1237
1288
        """Remove file_id, and children, from the inventory.
1238
 
        
 
1289
 
1239
1290
        :param file_id: A file_id to remove.
1240
1291
        """
1241
1292
        to_find_delete = [self._byid[file_id]]
1262
1313
        """
1263
1314
        new_name = ensure_normalized_name(new_name)
1264
1315
        if not is_valid_name(new_name):
1265
 
            raise BzrError("not an acceptable filename: %r" % new_name)
 
1316
            raise errors.BzrError("not an acceptable filename: %r" % new_name)
1266
1317
 
1267
1318
        new_parent = self._byid[new_parent_id]
1268
1319
        if new_name in new_parent.children:
1269
 
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
1320
            raise errors.BzrError("%r already exists in %r" %
 
1321
                (new_name, self.id2path(new_parent_id)))
1270
1322
 
1271
1323
        new_parent_idpath = self.get_idpath(new_parent_id)
1272
1324
        if file_id in new_parent_idpath:
1273
 
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
1325
            raise errors.BzrError(
 
1326
                "cannot move directory %r into a subdirectory of itself, %r"
1274
1327
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
1275
1328
 
1276
1329
        file_ie = self._byid[file_id]
1280
1333
 
1281
1334
        del old_parent.children[file_ie.name]
1282
1335
        new_parent.children[new_name] = file_ie
1283
 
        
 
1336
 
1284
1337
        file_ie.name = new_name
1285
1338
        file_ie.parent_id = new_parent_id
1286
1339
 
1288
1341
        return self.root is not None and file_id == self.root.file_id
1289
1342
 
1290
1343
 
 
1344
class CHKInventory(CommonInventory):
 
1345
    """An inventory persisted in a CHK store.
 
1346
 
 
1347
    By design, a CHKInventory is immutable so many of the methods
 
1348
    supported by Inventory - add, rename, apply_delta, etc - are *not*
 
1349
    supported. To create a new CHKInventory, use create_by_apply_delta()
 
1350
    or from_inventory(), say.
 
1351
 
 
1352
    Internally, a CHKInventory has one or two CHKMaps:
 
1353
 
 
1354
    * id_to_entry - a map from (file_id,) => InventoryEntry as bytes
 
1355
    * parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
 
1356
        => file_id as bytes
 
1357
 
 
1358
    The second map is optional and not present in early CHkRepository's.
 
1359
 
 
1360
    No caching is performed: every method call or item access will perform
 
1361
    requests to the storage layer. As such, keep references to objects you
 
1362
    want to reuse.
 
1363
    """
 
1364
 
 
1365
    def __init__(self, search_key_name):
 
1366
        CommonInventory.__init__(self)
 
1367
        self._fileid_to_entry_cache = {}
 
1368
        self._fully_cached = False
 
1369
        self._path_to_fileid_cache = {}
 
1370
        self._search_key_name = search_key_name
 
1371
        self.root_id = None
 
1372
 
 
1373
    def __eq__(self, other):
 
1374
        """Compare two sets by comparing their contents."""
 
1375
        if not isinstance(other, CHKInventory):
 
1376
            return NotImplemented
 
1377
 
 
1378
        this_key = self.id_to_entry.key()
 
1379
        other_key = other.id_to_entry.key()
 
1380
        this_pid_key = self.parent_id_basename_to_file_id.key()
 
1381
        other_pid_key = other.parent_id_basename_to_file_id.key()
 
1382
        if None in (this_key, this_pid_key, other_key, other_pid_key):
 
1383
            return False
 
1384
        return this_key == other_key and this_pid_key == other_pid_key
 
1385
 
 
1386
    def _entry_to_bytes(self, entry):
 
1387
        """Serialise entry as a single bytestring.
 
1388
 
 
1389
        :param Entry: An inventory entry.
 
1390
        :return: A bytestring for the entry.
 
1391
 
 
1392
        The BNF:
 
1393
        ENTRY ::= FILE | DIR | SYMLINK | TREE
 
1394
        FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
 
1395
        DIR ::= "dir: " COMMON
 
1396
        SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
 
1397
        TREE ::= "tree: " COMMON REFERENCE_REVISION
 
1398
        COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
 
1399
        SEP ::= "\n"
 
1400
        """
 
1401
        if entry.parent_id is not None:
 
1402
            parent_str = entry.parent_id
 
1403
        else:
 
1404
            parent_str = ''
 
1405
        name_str = entry.name.encode("utf8")
 
1406
        if entry.kind == 'file':
 
1407
            if entry.executable:
 
1408
                exec_str = "Y"
 
1409
            else:
 
1410
                exec_str = "N"
 
1411
            return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
 
1412
                entry.file_id, parent_str, name_str, entry.revision,
 
1413
                entry.text_sha1, entry.text_size, exec_str)
 
1414
        elif entry.kind == 'directory':
 
1415
            return "dir: %s\n%s\n%s\n%s" % (
 
1416
                entry.file_id, parent_str, name_str, entry.revision)
 
1417
        elif entry.kind == 'symlink':
 
1418
            return "symlink: %s\n%s\n%s\n%s\n%s" % (
 
1419
                entry.file_id, parent_str, name_str, entry.revision,
 
1420
                entry.symlink_target.encode("utf8"))
 
1421
        elif entry.kind == 'tree-reference':
 
1422
            return "tree: %s\n%s\n%s\n%s\n%s" % (
 
1423
                entry.file_id, parent_str, name_str, entry.revision,
 
1424
                entry.reference_revision)
 
1425
        else:
 
1426
            raise ValueError("unknown kind %r" % entry.kind)
 
1427
 
 
1428
    def _expand_fileids_to_parents_and_children(self, file_ids):
 
1429
        """Give a more wholistic view starting with the given file_ids.
 
1430
 
 
1431
        For any file_id which maps to a directory, we will include all children
 
1432
        of that directory. We will also include all directories which are
 
1433
        parents of the given file_ids, but we will not include their children.
 
1434
 
 
1435
        eg:
 
1436
          /     # TREE_ROOT
 
1437
          foo/  # foo-id
 
1438
            baz # baz-id
 
1439
            frob/ # frob-id
 
1440
              fringle # fringle-id
 
1441
          bar/  # bar-id
 
1442
            bing # bing-id
 
1443
 
 
1444
        if given [foo-id] we will include
 
1445
            TREE_ROOT as interesting parents
 
1446
        and 
 
1447
            foo-id, baz-id, frob-id, fringle-id
 
1448
        As interesting ids.
 
1449
        """
 
1450
        interesting = set()
 
1451
        # TODO: Pre-pass over the list of fileids to see if anything is already
 
1452
        #       deserialized in self._fileid_to_entry_cache
 
1453
 
 
1454
        directories_to_expand = set()
 
1455
        children_of_parent_id = {}
 
1456
        # It is okay if some of the fileids are missing
 
1457
        for entry in self._getitems(file_ids):
 
1458
            if entry.kind == 'directory':
 
1459
                directories_to_expand.add(entry.file_id)
 
1460
            interesting.add(entry.parent_id)
 
1461
            children_of_parent_id.setdefault(entry.parent_id, set()
 
1462
                                             ).add(entry.file_id)
 
1463
 
 
1464
        # Now, interesting has all of the direct parents, but not the
 
1465
        # parents of those parents. It also may have some duplicates with
 
1466
        # specific_fileids
 
1467
        remaining_parents = interesting.difference(file_ids)
 
1468
        # When we hit the TREE_ROOT, we'll get an interesting parent of None,
 
1469
        # but we don't actually want to recurse into that
 
1470
        interesting.add(None) # this will auto-filter it in the loop
 
1471
        remaining_parents.discard(None) 
 
1472
        while remaining_parents:
 
1473
            next_parents = set()
 
1474
            for entry in self._getitems(remaining_parents):
 
1475
                next_parents.add(entry.parent_id)
 
1476
                children_of_parent_id.setdefault(entry.parent_id, set()
 
1477
                                                 ).add(entry.file_id)
 
1478
            # Remove any search tips we've already processed
 
1479
            remaining_parents = next_parents.difference(interesting)
 
1480
            interesting.update(remaining_parents)
 
1481
            # We should probably also .difference(directories_to_expand)
 
1482
        interesting.update(file_ids)
 
1483
        interesting.discard(None)
 
1484
        while directories_to_expand:
 
1485
            # Expand directories by looking in the
 
1486
            # parent_id_basename_to_file_id map
 
1487
            keys = [StaticTuple(f,).intern() for f in directories_to_expand]
 
1488
            directories_to_expand = set()
 
1489
            items = self.parent_id_basename_to_file_id.iteritems(keys)
 
1490
            next_file_ids = set([item[1] for item in items])
 
1491
            next_file_ids = next_file_ids.difference(interesting)
 
1492
            interesting.update(next_file_ids)
 
1493
            for entry in self._getitems(next_file_ids):
 
1494
                if entry.kind == 'directory':
 
1495
                    directories_to_expand.add(entry.file_id)
 
1496
                children_of_parent_id.setdefault(entry.parent_id, set()
 
1497
                                                 ).add(entry.file_id)
 
1498
        return interesting, children_of_parent_id
 
1499
 
 
1500
    def filter(self, specific_fileids):
 
1501
        """Get an inventory view filtered against a set of file-ids.
 
1502
 
 
1503
        Children of directories and parents are included.
 
1504
 
 
1505
        The result may or may not reference the underlying inventory
 
1506
        so it should be treated as immutable.
 
1507
        """
 
1508
        (interesting,
 
1509
         parent_to_children) = self._expand_fileids_to_parents_and_children(
 
1510
                                specific_fileids)
 
1511
        # There is some overlap here, but we assume that all interesting items
 
1512
        # are in the _fileid_to_entry_cache because we had to read them to
 
1513
        # determine if they were a dir we wanted to recurse, or just a file
 
1514
        # This should give us all the entries we'll want to add, so start
 
1515
        # adding
 
1516
        other = Inventory(self.root_id)
 
1517
        other.root.revision = self.root.revision
 
1518
        other.revision_id = self.revision_id
 
1519
        if not interesting or not parent_to_children:
 
1520
            # empty filter, or filtering entrys that don't exist
 
1521
            # (if even 1 existed, then we would have populated
 
1522
            # parent_to_children with at least the tree root.)
 
1523
            return other
 
1524
        cache = self._fileid_to_entry_cache
 
1525
        remaining_children = collections.deque(parent_to_children[self.root_id])
 
1526
        while remaining_children:
 
1527
            file_id = remaining_children.popleft()
 
1528
            ie = cache[file_id]
 
1529
            if ie.kind == 'directory':
 
1530
                ie = ie.copy() # We create a copy to depopulate the .children attribute
 
1531
            # TODO: depending on the uses of 'other' we should probably alwyas
 
1532
            #       '.copy()' to prevent someone from mutating other and
 
1533
            #       invaliding our internal cache
 
1534
            other.add(ie)
 
1535
            if file_id in parent_to_children:
 
1536
                remaining_children.extend(parent_to_children[file_id])
 
1537
        return other
 
1538
 
 
1539
    @staticmethod
 
1540
    def _bytes_to_utf8name_key(bytes):
 
1541
        """Get the file_id, revision_id key out of bytes."""
 
1542
        # We don't normally care about name, except for times when we want
 
1543
        # to filter out empty names because of non rich-root...
 
1544
        sections = bytes.split('\n')
 
1545
        kind, file_id = sections[0].split(': ')
 
1546
        return (sections[2], intern(file_id), intern(sections[3]))
 
1547
 
 
1548
    def _bytes_to_entry(self, bytes):
 
1549
        """Deserialise a serialised entry."""
 
1550
        sections = bytes.split('\n')
 
1551
        if sections[0].startswith("file: "):
 
1552
            result = InventoryFile(sections[0][6:],
 
1553
                sections[2].decode('utf8'),
 
1554
                sections[1])
 
1555
            result.text_sha1 = sections[4]
 
1556
            result.text_size = int(sections[5])
 
1557
            result.executable = sections[6] == "Y"
 
1558
        elif sections[0].startswith("dir: "):
 
1559
            result = CHKInventoryDirectory(sections[0][5:],
 
1560
                sections[2].decode('utf8'),
 
1561
                sections[1], self)
 
1562
        elif sections[0].startswith("symlink: "):
 
1563
            result = InventoryLink(sections[0][9:],
 
1564
                sections[2].decode('utf8'),
 
1565
                sections[1])
 
1566
            result.symlink_target = sections[4].decode('utf8')
 
1567
        elif sections[0].startswith("tree: "):
 
1568
            result = TreeReference(sections[0][6:],
 
1569
                sections[2].decode('utf8'),
 
1570
                sections[1])
 
1571
            result.reference_revision = sections[4]
 
1572
        else:
 
1573
            raise ValueError("Not a serialised entry %r" % bytes)
 
1574
        result.file_id = intern(result.file_id)
 
1575
        result.revision = intern(sections[3])
 
1576
        if result.parent_id == '':
 
1577
            result.parent_id = None
 
1578
        self._fileid_to_entry_cache[result.file_id] = result
 
1579
        return result
 
1580
 
 
1581
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
 
1582
        propagate_caches=False):
 
1583
        """Create a new CHKInventory by applying inventory_delta to this one.
 
1584
 
 
1585
        See the inventory developers documentation for the theory behind
 
1586
        inventory deltas.
 
1587
 
 
1588
        :param inventory_delta: The inventory delta to apply. See
 
1589
            Inventory.apply_delta for details.
 
1590
        :param new_revision_id: The revision id of the resulting CHKInventory.
 
1591
        :param propagate_caches: If True, the caches for this inventory are
 
1592
          copied to and updated for the result.
 
1593
        :return: The new CHKInventory.
 
1594
        """
 
1595
        split = osutils.split
 
1596
        result = CHKInventory(self._search_key_name)
 
1597
        if propagate_caches:
 
1598
            # Just propagate the path-to-fileid cache for now
 
1599
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
 
1600
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
 
1601
        self.id_to_entry._ensure_root()
 
1602
        maximum_size = self.id_to_entry._root_node.maximum_size
 
1603
        result.revision_id = new_revision_id
 
1604
        result.id_to_entry = chk_map.CHKMap(
 
1605
            self.id_to_entry._store,
 
1606
            self.id_to_entry.key(),
 
1607
            search_key_func=search_key_func)
 
1608
        result.id_to_entry._ensure_root()
 
1609
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
 
1610
        # Change to apply to the parent_id_basename delta. The dict maps
 
1611
        # (parent_id, basename) -> (old_key, new_value). We use a dict because
 
1612
        # when a path has its id replaced (e.g. the root is changed, or someone
 
1613
        # does bzr mv a b, bzr mv c a, we should output a single change to this
 
1614
        # map rather than two.
 
1615
        parent_id_basename_delta = {}
 
1616
        if self.parent_id_basename_to_file_id is not None:
 
1617
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
 
1618
                self.parent_id_basename_to_file_id._store,
 
1619
                self.parent_id_basename_to_file_id.key(),
 
1620
                search_key_func=search_key_func)
 
1621
            result.parent_id_basename_to_file_id._ensure_root()
 
1622
            self.parent_id_basename_to_file_id._ensure_root()
 
1623
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
 
1624
            p_id_root = self.parent_id_basename_to_file_id._root_node
 
1625
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
 
1626
            result_p_id_root._key_width = p_id_root._key_width
 
1627
        else:
 
1628
            result.parent_id_basename_to_file_id = None
 
1629
        result.root_id = self.root_id
 
1630
        id_to_entry_delta = []
 
1631
        # inventory_delta is only traversed once, so we just update the
 
1632
        # variable.
 
1633
        # Check for repeated file ids
 
1634
        inventory_delta = _check_delta_unique_ids(inventory_delta)
 
1635
        # Repeated old paths
 
1636
        inventory_delta = _check_delta_unique_old_paths(inventory_delta)
 
1637
        # Check for repeated new paths
 
1638
        inventory_delta = _check_delta_unique_new_paths(inventory_delta)
 
1639
        # Check for entries that don't match the fileid
 
1640
        inventory_delta = _check_delta_ids_match_entry(inventory_delta)
 
1641
        # Check for nonsense fileids
 
1642
        inventory_delta = _check_delta_ids_are_valid(inventory_delta)
 
1643
        # Check for new_path <-> entry consistency
 
1644
        inventory_delta = _check_delta_new_path_entry_both_or_None(
 
1645
            inventory_delta)
 
1646
        # All changed entries need to have their parents be directories and be
 
1647
        # at the right path. This set contains (path, id) tuples.
 
1648
        parents = set()
 
1649
        # When we delete an item, all the children of it must be either deleted
 
1650
        # or altered in their own right. As we batch process the change via
 
1651
        # CHKMap.apply_delta, we build a set of things to use to validate the
 
1652
        # delta.
 
1653
        deletes = set()
 
1654
        altered = set()
 
1655
        for old_path, new_path, file_id, entry in inventory_delta:
 
1656
            # file id changes
 
1657
            if new_path == '':
 
1658
                result.root_id = file_id
 
1659
            if new_path is None:
 
1660
                # Make a delete:
 
1661
                new_key = None
 
1662
                new_value = None
 
1663
                # Update caches
 
1664
                if propagate_caches:
 
1665
                    try:
 
1666
                        del result._path_to_fileid_cache[old_path]
 
1667
                    except KeyError:
 
1668
                        pass
 
1669
                deletes.add(file_id)
 
1670
            else:
 
1671
                new_key = StaticTuple(file_id,)
 
1672
                new_value = result._entry_to_bytes(entry)
 
1673
                # Update caches. It's worth doing this whether
 
1674
                # we're propagating the old caches or not.
 
1675
                result._path_to_fileid_cache[new_path] = file_id
 
1676
                parents.add((split(new_path)[0], entry.parent_id))
 
1677
            if old_path is None:
 
1678
                old_key = None
 
1679
            else:
 
1680
                old_key = StaticTuple(file_id,)
 
1681
                if self.id2path(file_id) != old_path:
 
1682
                    raise errors.InconsistentDelta(old_path, file_id,
 
1683
                        "Entry was at wrong other path %r." %
 
1684
                        self.id2path(file_id))
 
1685
                altered.add(file_id)
 
1686
            id_to_entry_delta.append(StaticTuple(old_key, new_key, new_value))
 
1687
            if result.parent_id_basename_to_file_id is not None:
 
1688
                # parent_id, basename changes
 
1689
                if old_path is None:
 
1690
                    old_key = None
 
1691
                else:
 
1692
                    old_entry = self[file_id]
 
1693
                    old_key = self._parent_id_basename_key(old_entry)
 
1694
                if new_path is None:
 
1695
                    new_key = None
 
1696
                    new_value = None
 
1697
                else:
 
1698
                    new_key = self._parent_id_basename_key(entry)
 
1699
                    new_value = file_id
 
1700
                # If the two keys are the same, the value will be unchanged
 
1701
                # as its always the file id for this entry.
 
1702
                if old_key != new_key:
 
1703
                    # Transform a change into explicit delete/add preserving
 
1704
                    # a possible match on the key from a different file id.
 
1705
                    if old_key is not None:
 
1706
                        parent_id_basename_delta.setdefault(
 
1707
                            old_key, [None, None])[0] = old_key
 
1708
                    if new_key is not None:
 
1709
                        parent_id_basename_delta.setdefault(
 
1710
                            new_key, [None, None])[1] = new_value
 
1711
        # validate that deletes are complete.
 
1712
        for file_id in deletes:
 
1713
            entry = self[file_id]
 
1714
            if entry.kind != 'directory':
 
1715
                continue
 
1716
            # This loop could potentially be better by using the id_basename
 
1717
            # map to just get the child file ids.
 
1718
            for child in entry.children.values():
 
1719
                if child.file_id not in altered:
 
1720
                    raise errors.InconsistentDelta(self.id2path(child.file_id),
 
1721
                        child.file_id, "Child not deleted or reparented when "
 
1722
                        "parent deleted.")
 
1723
        result.id_to_entry.apply_delta(id_to_entry_delta)
 
1724
        if parent_id_basename_delta:
 
1725
            # Transform the parent_id_basename delta data into a linear delta
 
1726
            # with only one record for a given key. Optimally this would allow
 
1727
            # re-keying, but its simpler to just output that as a delete+add
 
1728
            # to spend less time calculating the delta.
 
1729
            delta_list = []
 
1730
            for key, (old_key, value) in parent_id_basename_delta.iteritems():
 
1731
                if value is not None:
 
1732
                    delta_list.append((old_key, key, value))
 
1733
                else:
 
1734
                    delta_list.append((old_key, None, None))
 
1735
            result.parent_id_basename_to_file_id.apply_delta(delta_list)
 
1736
        parents.discard(('', None))
 
1737
        for parent_path, parent in parents:
 
1738
            try:
 
1739
                if result[parent].kind != 'directory':
 
1740
                    raise errors.InconsistentDelta(result.id2path(parent), parent,
 
1741
                        'Not a directory, but given children')
 
1742
            except errors.NoSuchId:
 
1743
                raise errors.InconsistentDelta("<unknown>", parent,
 
1744
                    "Parent is not present in resulting inventory.")
 
1745
            if result.path2id(parent_path) != parent:
 
1746
                raise errors.InconsistentDelta(parent_path, parent,
 
1747
                    "Parent has wrong path %r." % result.path2id(parent_path))
 
1748
        return result
 
1749
 
 
1750
    @classmethod
 
1751
    def deserialise(klass, chk_store, bytes, expected_revision_id):
 
1752
        """Deserialise a CHKInventory.
 
1753
 
 
1754
        :param chk_store: A CHK capable VersionedFiles instance.
 
1755
        :param bytes: The serialised bytes.
 
1756
        :param expected_revision_id: The revision ID we think this inventory is
 
1757
            for.
 
1758
        :return: A CHKInventory
 
1759
        """
 
1760
        lines = bytes.split('\n')
 
1761
        if lines[-1] != '':
 
1762
            raise AssertionError('bytes to deserialize must end with an eol')
 
1763
        lines.pop()
 
1764
        if lines[0] != 'chkinventory:':
 
1765
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
 
1766
        info = {}
 
1767
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
 
1768
                                  'parent_id_basename_to_file_id',
 
1769
                                  'id_to_entry'])
 
1770
        for line in lines[1:]:
 
1771
            key, value = line.split(': ', 1)
 
1772
            if key not in allowed_keys:
 
1773
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
 
1774
                                      % (key, bytes))
 
1775
            if key in info:
 
1776
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
 
1777
                                      % (key, bytes))
 
1778
            info[key] = value
 
1779
        revision_id = intern(info['revision_id'])
 
1780
        root_id = intern(info['root_id'])
 
1781
        search_key_name = intern(info.get('search_key_name', 'plain'))
 
1782
        parent_id_basename_to_file_id = intern(info.get(
 
1783
            'parent_id_basename_to_file_id', None))
 
1784
        if not parent_id_basename_to_file_id.startswith('sha1:'):
 
1785
            raise ValueError('parent_id_basename_to_file_id should be a sha1'
 
1786
                             ' key not %r' % (parent_id_basename_to_file_id,))
 
1787
        id_to_entry = info['id_to_entry']
 
1788
        if not id_to_entry.startswith('sha1:'):
 
1789
            raise ValueError('id_to_entry should be a sha1'
 
1790
                             ' key not %r' % (id_to_entry,))
 
1791
 
 
1792
        result = CHKInventory(search_key_name)
 
1793
        result.revision_id = revision_id
 
1794
        result.root_id = root_id
 
1795
        search_key_func = chk_map.search_key_registry.get(
 
1796
                            result._search_key_name)
 
1797
        if parent_id_basename_to_file_id is not None:
 
1798
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
 
1799
                chk_store, StaticTuple(parent_id_basename_to_file_id,),
 
1800
                search_key_func=search_key_func)
 
1801
        else:
 
1802
            result.parent_id_basename_to_file_id = None
 
1803
 
 
1804
        result.id_to_entry = chk_map.CHKMap(chk_store,
 
1805
                                            StaticTuple(id_to_entry,),
 
1806
                                            search_key_func=search_key_func)
 
1807
        if (result.revision_id,) != expected_revision_id:
 
1808
            raise ValueError("Mismatched revision id and expected: %r, %r" %
 
1809
                (result.revision_id, expected_revision_id))
 
1810
        return result
 
1811
 
 
1812
    @classmethod
 
1813
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
 
1814
        """Create a CHKInventory from an existing inventory.
 
1815
 
 
1816
        The content of inventory is copied into the chk_store, and a
 
1817
        CHKInventory referencing that is returned.
 
1818
 
 
1819
        :param chk_store: A CHK capable VersionedFiles instance.
 
1820
        :param inventory: The inventory to copy.
 
1821
        :param maximum_size: The CHKMap node size limit.
 
1822
        :param search_key_name: The identifier for the search key function
 
1823
        """
 
1824
        result = klass(search_key_name)
 
1825
        result.revision_id = inventory.revision_id
 
1826
        result.root_id = inventory.root.file_id
 
1827
 
 
1828
        entry_to_bytes = result._entry_to_bytes
 
1829
        parent_id_basename_key = result._parent_id_basename_key
 
1830
        id_to_entry_dict = {}
 
1831
        parent_id_basename_dict = {}
 
1832
        for path, entry in inventory.iter_entries():
 
1833
            key = StaticTuple(entry.file_id,).intern()
 
1834
            id_to_entry_dict[key] = entry_to_bytes(entry)
 
1835
            p_id_key = parent_id_basename_key(entry)
 
1836
            parent_id_basename_dict[p_id_key] = entry.file_id
 
1837
 
 
1838
        result._populate_from_dicts(chk_store, id_to_entry_dict,
 
1839
            parent_id_basename_dict, maximum_size=maximum_size)
 
1840
        return result
 
1841
 
 
1842
    def _populate_from_dicts(self, chk_store, id_to_entry_dict,
 
1843
                             parent_id_basename_dict, maximum_size):
 
1844
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
 
1845
        root_key = chk_map.CHKMap.from_dict(chk_store, id_to_entry_dict,
 
1846
                   maximum_size=maximum_size, key_width=1,
 
1847
                   search_key_func=search_key_func)
 
1848
        self.id_to_entry = chk_map.CHKMap(chk_store, root_key,
 
1849
                                          search_key_func)
 
1850
        root_key = chk_map.CHKMap.from_dict(chk_store,
 
1851
                   parent_id_basename_dict,
 
1852
                   maximum_size=maximum_size, key_width=2,
 
1853
                   search_key_func=search_key_func)
 
1854
        self.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
 
1855
                                                    root_key, search_key_func)
 
1856
 
 
1857
    def _parent_id_basename_key(self, entry):
 
1858
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
 
1859
        if entry.parent_id is not None:
 
1860
            parent_id = entry.parent_id
 
1861
        else:
 
1862
            parent_id = ''
 
1863
        return StaticTuple(parent_id, entry.name.encode('utf8')).intern()
 
1864
 
 
1865
    def __getitem__(self, file_id):
 
1866
        """map a single file_id -> InventoryEntry."""
 
1867
        if file_id is None:
 
1868
            raise errors.NoSuchId(self, file_id)
 
1869
        result = self._fileid_to_entry_cache.get(file_id, None)
 
1870
        if result is not None:
 
1871
            return result
 
1872
        try:
 
1873
            return self._bytes_to_entry(
 
1874
                self.id_to_entry.iteritems([StaticTuple(file_id,)]).next()[1])
 
1875
        except StopIteration:
 
1876
            # really we're passing an inventory, not a tree...
 
1877
            raise errors.NoSuchId(self, file_id)
 
1878
 
 
1879
    def _getitems(self, file_ids):
 
1880
        """Similar to __getitem__, but lets you query for multiple.
 
1881
        
 
1882
        The returned order is undefined. And currently if an item doesn't
 
1883
        exist, it isn't included in the output.
 
1884
        """
 
1885
        result = []
 
1886
        remaining = []
 
1887
        for file_id in file_ids:
 
1888
            entry = self._fileid_to_entry_cache.get(file_id, None)
 
1889
            if entry is None:
 
1890
                remaining.append(file_id)
 
1891
            else:
 
1892
                result.append(entry)
 
1893
        file_keys = [StaticTuple(f,).intern() for f in remaining]
 
1894
        for file_key, value in self.id_to_entry.iteritems(file_keys):
 
1895
            entry = self._bytes_to_entry(value)
 
1896
            result.append(entry)
 
1897
            self._fileid_to_entry_cache[entry.file_id] = entry
 
1898
        return result
 
1899
 
 
1900
    def has_id(self, file_id):
 
1901
        # Perhaps have an explicit 'contains' method on CHKMap ?
 
1902
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
 
1903
            return True
 
1904
        return len(list(
 
1905
            self.id_to_entry.iteritems([StaticTuple(file_id,)]))) == 1
 
1906
 
 
1907
    def is_root(self, file_id):
 
1908
        return file_id == self.root_id
 
1909
 
 
1910
    def _iter_file_id_parents(self, file_id):
 
1911
        """Yield the parents of file_id up to the root."""
 
1912
        while file_id is not None:
 
1913
            try:
 
1914
                ie = self[file_id]
 
1915
            except KeyError:
 
1916
                raise errors.NoSuchId(tree=self, file_id=file_id)
 
1917
            yield ie
 
1918
            file_id = ie.parent_id
 
1919
 
 
1920
    def __iter__(self):
 
1921
        """Iterate over all file-ids."""
 
1922
        for key, _ in self.id_to_entry.iteritems():
 
1923
            yield key[-1]
 
1924
 
 
1925
    def iter_just_entries(self):
 
1926
        """Iterate over all entries.
 
1927
 
 
1928
        Unlike iter_entries(), just the entries are returned (not (path, ie))
 
1929
        and the order of entries is undefined.
 
1930
 
 
1931
        XXX: We may not want to merge this into bzr.dev.
 
1932
        """
 
1933
        for key, entry in self.id_to_entry.iteritems():
 
1934
            file_id = key[0]
 
1935
            ie = self._fileid_to_entry_cache.get(file_id, None)
 
1936
            if ie is None:
 
1937
                ie = self._bytes_to_entry(entry)
 
1938
                self._fileid_to_entry_cache[file_id] = ie
 
1939
            yield ie
 
1940
 
 
1941
    def _preload_cache(self):
 
1942
        """Make sure all file-ids are in _fileid_to_entry_cache"""
 
1943
        if self._fully_cached:
 
1944
            return # No need to do it again
 
1945
        # The optimal sort order is to use iteritems() directly
 
1946
        cache = self._fileid_to_entry_cache
 
1947
        for key, entry in self.id_to_entry.iteritems():
 
1948
            file_id = key[0]
 
1949
            if file_id not in cache:
 
1950
                ie = self._bytes_to_entry(entry)
 
1951
                cache[file_id] = ie
 
1952
            else:
 
1953
                ie = cache[file_id]
 
1954
        last_parent_id = last_parent_ie = None
 
1955
        pid_items = self.parent_id_basename_to_file_id.iteritems()
 
1956
        for key, child_file_id in pid_items:
 
1957
            if key == ('', ''): # This is the root
 
1958
                if child_file_id != self.root_id:
 
1959
                    raise ValueError('Data inconsistency detected.'
 
1960
                        ' We expected data with key ("","") to match'
 
1961
                        ' the root id, but %s != %s'
 
1962
                        % (child_file_id, self.root_id))
 
1963
                continue
 
1964
            parent_id, basename = key
 
1965
            ie = cache[child_file_id]
 
1966
            if parent_id == last_parent_id:
 
1967
                parent_ie = last_parent_ie
 
1968
            else:
 
1969
                parent_ie = cache[parent_id]
 
1970
            if parent_ie.kind != 'directory':
 
1971
                raise ValueError('Data inconsistency detected.'
 
1972
                    ' An entry in the parent_id_basename_to_file_id map'
 
1973
                    ' has parent_id {%s} but the kind of that object'
 
1974
                    ' is %r not "directory"' % (parent_id, parent_ie.kind))
 
1975
            if parent_ie._children is None:
 
1976
                parent_ie._children = {}
 
1977
            basename = basename.decode('utf-8')
 
1978
            if basename in parent_ie._children:
 
1979
                existing_ie = parent_ie._children[basename]
 
1980
                if existing_ie != ie:
 
1981
                    raise ValueError('Data inconsistency detected.'
 
1982
                        ' Two entries with basename %r were found'
 
1983
                        ' in the parent entry {%s}'
 
1984
                        % (basename, parent_id))
 
1985
            if basename != ie.name:
 
1986
                raise ValueError('Data inconsistency detected.'
 
1987
                    ' In the parent_id_basename_to_file_id map, file_id'
 
1988
                    ' {%s} is listed as having basename %r, but in the'
 
1989
                    ' id_to_entry map it is %r'
 
1990
                    % (child_file_id, basename, ie.name))
 
1991
            parent_ie._children[basename] = ie
 
1992
        self._fully_cached = True
 
1993
 
 
1994
    def iter_changes(self, basis):
 
1995
        """Generate a Tree.iter_changes change list between this and basis.
 
1996
 
 
1997
        :param basis: Another CHKInventory.
 
1998
        :return: An iterator over the changes between self and basis, as per
 
1999
            tree.iter_changes().
 
2000
        """
 
2001
        # We want: (file_id, (path_in_source, path_in_target),
 
2002
        # changed_content, versioned, parent, name, kind,
 
2003
        # executable)
 
2004
        for key, basis_value, self_value in \
 
2005
            self.id_to_entry.iter_changes(basis.id_to_entry):
 
2006
            file_id = key[0]
 
2007
            if basis_value is not None:
 
2008
                basis_entry = basis._bytes_to_entry(basis_value)
 
2009
                path_in_source = basis.id2path(file_id)
 
2010
                basis_parent = basis_entry.parent_id
 
2011
                basis_name = basis_entry.name
 
2012
                basis_executable = basis_entry.executable
 
2013
            else:
 
2014
                path_in_source = None
 
2015
                basis_parent = None
 
2016
                basis_name = None
 
2017
                basis_executable = None
 
2018
            if self_value is not None:
 
2019
                self_entry = self._bytes_to_entry(self_value)
 
2020
                path_in_target = self.id2path(file_id)
 
2021
                self_parent = self_entry.parent_id
 
2022
                self_name = self_entry.name
 
2023
                self_executable = self_entry.executable
 
2024
            else:
 
2025
                path_in_target = None
 
2026
                self_parent = None
 
2027
                self_name = None
 
2028
                self_executable = None
 
2029
            if basis_value is None:
 
2030
                # add
 
2031
                kind = (None, self_entry.kind)
 
2032
                versioned = (False, True)
 
2033
            elif self_value is None:
 
2034
                # delete
 
2035
                kind = (basis_entry.kind, None)
 
2036
                versioned = (True, False)
 
2037
            else:
 
2038
                kind = (basis_entry.kind, self_entry.kind)
 
2039
                versioned = (True, True)
 
2040
            changed_content = False
 
2041
            if kind[0] != kind[1]:
 
2042
                changed_content = True
 
2043
            elif kind[0] == 'file':
 
2044
                if (self_entry.text_size != basis_entry.text_size or
 
2045
                    self_entry.text_sha1 != basis_entry.text_sha1):
 
2046
                    changed_content = True
 
2047
            elif kind[0] == 'symlink':
 
2048
                if self_entry.symlink_target != basis_entry.symlink_target:
 
2049
                    changed_content = True
 
2050
            elif kind[0] == 'tree-reference':
 
2051
                if (self_entry.reference_revision !=
 
2052
                    basis_entry.reference_revision):
 
2053
                    changed_content = True
 
2054
            parent = (basis_parent, self_parent)
 
2055
            name = (basis_name, self_name)
 
2056
            executable = (basis_executable, self_executable)
 
2057
            if (not changed_content
 
2058
                and parent[0] == parent[1]
 
2059
                and name[0] == name[1]
 
2060
                and executable[0] == executable[1]):
 
2061
                # Could happen when only the revision changed for a directory
 
2062
                # for instance.
 
2063
                continue
 
2064
            yield (file_id, (path_in_source, path_in_target), changed_content,
 
2065
                versioned, parent, name, kind, executable)
 
2066
 
 
2067
    def __len__(self):
 
2068
        """Return the number of entries in the inventory."""
 
2069
        return len(self.id_to_entry)
 
2070
 
 
2071
    def _make_delta(self, old):
 
2072
        """Make an inventory delta from two inventories."""
 
2073
        if type(old) != CHKInventory:
 
2074
            return CommonInventory._make_delta(self, old)
 
2075
        delta = []
 
2076
        for key, old_value, self_value in \
 
2077
            self.id_to_entry.iter_changes(old.id_to_entry):
 
2078
            file_id = key[0]
 
2079
            if old_value is not None:
 
2080
                old_path = old.id2path(file_id)
 
2081
            else:
 
2082
                old_path = None
 
2083
            if self_value is not None:
 
2084
                entry = self._bytes_to_entry(self_value)
 
2085
                self._fileid_to_entry_cache[file_id] = entry
 
2086
                new_path = self.id2path(file_id)
 
2087
            else:
 
2088
                entry = None
 
2089
                new_path = None
 
2090
            delta.append((old_path, new_path, file_id, entry))
 
2091
        return delta
 
2092
 
 
2093
    def path2id(self, relpath):
 
2094
        """See CommonInventory.path2id()."""
 
2095
        # TODO: perhaps support negative hits?
 
2096
        if isinstance(relpath, basestring):
 
2097
            names = osutils.splitpath(relpath)
 
2098
        else:
 
2099
            names = relpath
 
2100
            if relpath == []:
 
2101
                relpath = [""]
 
2102
            relpath = osutils.pathjoin(*relpath)
 
2103
        result = self._path_to_fileid_cache.get(relpath, None)
 
2104
        if result is not None:
 
2105
            return result
 
2106
        current_id = self.root_id
 
2107
        if current_id is None:
 
2108
            return None
 
2109
        parent_id_index = self.parent_id_basename_to_file_id
 
2110
        cur_path = None
 
2111
        for basename in names:
 
2112
            if cur_path is None:
 
2113
                cur_path = basename
 
2114
            else:
 
2115
                cur_path = cur_path + '/' + basename
 
2116
            basename_utf8 = basename.encode('utf8')
 
2117
            file_id = self._path_to_fileid_cache.get(cur_path, None)
 
2118
            if file_id is None:
 
2119
                key_filter = [StaticTuple(current_id, basename_utf8)]
 
2120
                items = parent_id_index.iteritems(key_filter)
 
2121
                for (parent_id, name_utf8), file_id in items:
 
2122
                    if parent_id != current_id or name_utf8 != basename_utf8:
 
2123
                        raise errors.BzrError("corrupt inventory lookup! "
 
2124
                            "%r %r %r %r" % (parent_id, current_id, name_utf8,
 
2125
                            basename_utf8))
 
2126
                if file_id is None:
 
2127
                    return None
 
2128
                else:
 
2129
                    self._path_to_fileid_cache[cur_path] = file_id
 
2130
            current_id = file_id
 
2131
        return current_id
 
2132
 
 
2133
    def to_lines(self):
 
2134
        """Serialise the inventory to lines."""
 
2135
        lines = ["chkinventory:\n"]
 
2136
        if self._search_key_name != 'plain':
 
2137
            # custom ordering grouping things that don't change together
 
2138
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
 
2139
            lines.append("root_id: %s\n" % self.root_id)
 
2140
            lines.append('parent_id_basename_to_file_id: %s\n' %
 
2141
                (self.parent_id_basename_to_file_id.key()[0],))
 
2142
            lines.append("revision_id: %s\n" % self.revision_id)
 
2143
            lines.append("id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
 
2144
        else:
 
2145
            lines.append("revision_id: %s\n" % self.revision_id)
 
2146
            lines.append("root_id: %s\n" % self.root_id)
 
2147
            if self.parent_id_basename_to_file_id is not None:
 
2148
                lines.append('parent_id_basename_to_file_id: %s\n' %
 
2149
                    (self.parent_id_basename_to_file_id.key()[0],))
 
2150
            lines.append("id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
 
2151
        return lines
 
2152
 
 
2153
    @property
 
2154
    def root(self):
 
2155
        """Get the root entry."""
 
2156
        return self[self.root_id]
 
2157
 
 
2158
 
 
2159
class CHKInventoryDirectory(InventoryDirectory):
 
2160
    """A directory in an inventory."""
 
2161
 
 
2162
    __slots__ = ['_children', '_chk_inventory']
 
2163
 
 
2164
    def __init__(self, file_id, name, parent_id, chk_inventory):
 
2165
        # Don't call InventoryDirectory.__init__ - it isn't right for this
 
2166
        # class.
 
2167
        InventoryEntry.__init__(self, file_id, name, parent_id)
 
2168
        self._children = None
 
2169
        self._chk_inventory = chk_inventory
 
2170
 
 
2171
    @property
 
2172
    def children(self):
 
2173
        """Access the list of children of this directory.
 
2174
 
 
2175
        With a parent_id_basename_to_file_id index, loads all the children,
 
2176
        without loads the entire index. Without is bad. A more sophisticated
 
2177
        proxy object might be nice, to allow partial loading of children as
 
2178
        well when specific names are accessed. (So path traversal can be
 
2179
        written in the obvious way but not examine siblings.).
 
2180
        """
 
2181
        if self._children is not None:
 
2182
            return self._children
 
2183
        # No longer supported
 
2184
        if self._chk_inventory.parent_id_basename_to_file_id is None:
 
2185
            raise AssertionError("Inventories without"
 
2186
                " parent_id_basename_to_file_id are no longer supported")
 
2187
        result = {}
 
2188
        # XXX: Todo - use proxy objects for the children rather than loading
 
2189
        # all when the attribute is referenced.
 
2190
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
 
2191
        child_keys = set()
 
2192
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
 
2193
            key_filter=[StaticTuple(self.file_id,)]):
 
2194
            child_keys.add(StaticTuple(file_id,))
 
2195
        cached = set()
 
2196
        for file_id_key in child_keys:
 
2197
            entry = self._chk_inventory._fileid_to_entry_cache.get(
 
2198
                file_id_key[0], None)
 
2199
            if entry is not None:
 
2200
                result[entry.name] = entry
 
2201
                cached.add(file_id_key)
 
2202
        child_keys.difference_update(cached)
 
2203
        # populate; todo: do by name
 
2204
        id_to_entry = self._chk_inventory.id_to_entry
 
2205
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
 
2206
            entry = self._chk_inventory._bytes_to_entry(bytes)
 
2207
            result[entry.name] = entry
 
2208
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
 
2209
        self._children = result
 
2210
        return result
 
2211
 
1291
2212
entry_factory = {
1292
2213
    'directory': InventoryDirectory,
1293
2214
    'file': InventoryFile,
1309
2230
    try:
1310
2231
        factory = entry_factory[kind]
1311
2232
    except KeyError:
1312
 
        raise BzrError("unknown kind %r" % kind)
 
2233
        raise errors.BadFileKindError(name, kind)
1313
2234
    return factory(file_id, name, parent_id)
1314
2235
 
1315
2236
 
1335
2256
    return name
1336
2257
 
1337
2258
 
1338
 
_NAME_RE = None
 
2259
_NAME_RE = lazy_regex.lazy_compile(r'^[^/\\]+$')
1339
2260
 
1340
2261
def is_valid_name(name):
1341
 
    global _NAME_RE
1342
 
    if _NAME_RE is None:
1343
 
        _NAME_RE = re.compile(r'^[^/\\]+$')
1344
 
        
1345
2262
    return bool(_NAME_RE.match(name))
 
2263
 
 
2264
 
 
2265
def _check_delta_unique_ids(delta):
 
2266
    """Decorate a delta and check that the file ids in it are unique.
 
2267
 
 
2268
    :return: A generator over delta.
 
2269
    """
 
2270
    ids = set()
 
2271
    for item in delta:
 
2272
        length = len(ids) + 1
 
2273
        ids.add(item[2])
 
2274
        if len(ids) != length:
 
2275
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2276
                "repeated file_id")
 
2277
        yield item
 
2278
 
 
2279
 
 
2280
def _check_delta_unique_new_paths(delta):
 
2281
    """Decorate a delta and check that the new paths in it are unique.
 
2282
 
 
2283
    :return: A generator over delta.
 
2284
    """
 
2285
    paths = set()
 
2286
    for item in delta:
 
2287
        length = len(paths) + 1
 
2288
        path = item[1]
 
2289
        if path is not None:
 
2290
            paths.add(path)
 
2291
            if len(paths) != length:
 
2292
                raise errors.InconsistentDelta(path, item[2], "repeated path")
 
2293
        yield item
 
2294
 
 
2295
 
 
2296
def _check_delta_unique_old_paths(delta):
 
2297
    """Decorate a delta and check that the old paths in it are unique.
 
2298
 
 
2299
    :return: A generator over delta.
 
2300
    """
 
2301
    paths = set()
 
2302
    for item in delta:
 
2303
        length = len(paths) + 1
 
2304
        path = item[0]
 
2305
        if path is not None:
 
2306
            paths.add(path)
 
2307
            if len(paths) != length:
 
2308
                raise errors.InconsistentDelta(path, item[2], "repeated path")
 
2309
        yield item
 
2310
 
 
2311
 
 
2312
def _check_delta_ids_are_valid(delta):
 
2313
    """Decorate a delta and check that the ids in it are valid.
 
2314
 
 
2315
    :return: A generator over delta.
 
2316
    """
 
2317
    for item in delta:
 
2318
        entry = item[3]
 
2319
        if item[2] is None:
 
2320
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2321
                "entry with file_id None %r" % entry)
 
2322
        if type(item[2]) != str:
 
2323
            raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2324
                "entry with non bytes file_id %r" % entry)
 
2325
        yield item
 
2326
 
 
2327
 
 
2328
def _check_delta_ids_match_entry(delta):
 
2329
    """Decorate a delta and check that the ids in it match the entry.file_id.
 
2330
 
 
2331
    :return: A generator over delta.
 
2332
    """
 
2333
    for item in delta:
 
2334
        entry = item[3]
 
2335
        if entry is not None:
 
2336
            if entry.file_id != item[2]:
 
2337
                raise errors.InconsistentDelta(item[0] or item[1], item[2],
 
2338
                    "mismatched id with %r" % entry)
 
2339
        yield item
 
2340
 
 
2341
 
 
2342
def _check_delta_new_path_entry_both_or_None(delta):
 
2343
    """Decorate a delta and check that the new_path and entry are paired.
 
2344
 
 
2345
    :return: A generator over delta.
 
2346
    """
 
2347
    for item in delta:
 
2348
        new_path = item[1]
 
2349
        entry = item[3]
 
2350
        if new_path is None and entry is not None:
 
2351
            raise errors.InconsistentDelta(item[0], item[1],
 
2352
                "Entry with no new_path")
 
2353
        if new_path is not None and entry is None:
 
2354
            raise errors.InconsistentDelta(new_path, item[1],
 
2355
                "new_path with no entry")
 
2356
        yield item
 
2357
 
 
2358
 
 
2359
def mutable_inventory_from_tree(tree):
 
2360
    """Create a new inventory that has the same contents as a specified tree.
 
2361
 
 
2362
    :param tree: Revision tree to create inventory from
 
2363
    """
 
2364
    entries = tree.iter_entries_by_dir()
 
2365
    inv = Inventory(None, tree.get_revision_id())
 
2366
    for path, inv_entry in entries:
 
2367
        inv.add(inv_entry.copy())
 
2368
    return inv