36
59
An InventoryEntry has the following fields, which are also
37
60
present in the XML inventory-entry element:
40
* *name*: (only the basename within the directory, must not
42
* *kind*: "directory" or "file"
43
* *directory_id*: (if absent/null means the branch root directory)
44
* *text_sha1*: only for files
45
* *text_size*: in bytes, only for files
46
* *text_id*: identifier for the text version, only for files
48
InventoryEntries can also exist inside a WorkingTree
49
inventory, in which case they are not yet bound to a
50
particular revision of the file. In that case the text_sha1,
51
text_size and text_id are absent.
65
(within the parent directory)
68
file_id of the parent directory, or ROOT_ID
71
the revision_id in which this variation of this file was
75
Indicates that this file should be executable on systems
79
sha-1 of the text of the file
82
size in bytes of the text of the file
84
(reading a version 4 tree created a text_id field.)
54
86
>>> i = Inventory()
57
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
58
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
59
>>> for j in i.iter_entries():
62
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
63
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
64
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
65
Traceback (most recent call last):
89
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
90
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
91
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
92
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
93
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
94
>>> for ix, j in enumerate(i.iter_entries()):
95
... print (j[0] == shouldbe[ix], j[1])
67
BzrError: inventory already contains entry with id {2323}
68
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
69
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
97
(True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
98
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
99
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
100
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
101
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
102
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
103
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
70
104
>>> i.path2id('src/wibble')
74
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
108
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
109
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
76
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
>>> for j in i.iter_entries():
79
... assert i.path2id(j[0])
111
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
112
>>> for path, entry in i.iter_entries():
85
120
src/wibble/wibble.c
86
121
>>> i.id2path('2326')
87
122
'src/wibble/wibble.c'
89
TODO: Maybe also keep the full path of the entry, and the children?
90
But those depend on its position within a particular inventory, and
91
it would be nice not to need to hold the backpointer here.
94
# TODO: split InventoryEntry into subclasses for files,
95
# directories, etc etc.
97
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
100
def __init__(self, file_id, name, kind, parent_id, text_id=None):
125
# Constants returned by describe_change()
127
# TODO: These should probably move to some kind of FileChangeDescription
128
# class; that's like what's inside a TreeDelta but we want to be able to
129
# generate them just for one file at a time.
131
MODIFIED_AND_RENAMED = 'modified and renamed'
135
def detect_changes(self, old_entry):
136
"""Return a (text_modified, meta_modified) from this to old_entry.
138
_read_tree_state must have been called on self and old_entry prior to
139
calling detect_changes.
143
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
144
output_to, reverse=False):
145
"""Perform a diff between two entries of the same kind."""
147
def parent_candidates(self, previous_inventories):
148
"""Find possible per-file graph parents.
150
This is currently defined by:
151
- Select the last changed revision in the parent inventory.
152
- Do deal with a short lived bug in bzr 0.8's development two entries
153
that have the same last changed but different 'x' bit settings are
156
# revision:ie mapping for each ie found in previous_inventories.
158
# identify candidate head revision ids.
159
for inv in previous_inventories:
160
if self.file_id in inv:
161
ie = inv[self.file_id]
162
if ie.revision in candidates:
163
# same revision value in two different inventories:
164
# correct possible inconsistencies:
165
# * there was a bug in revision updates with 'x' bit
168
if candidates[ie.revision].executable != ie.executable:
169
candidates[ie.revision].executable = False
170
ie.executable = False
171
except AttributeError:
174
# add this revision as a candidate.
175
candidates[ie.revision] = ie
178
@deprecated_method(deprecated_in((1, 6, 0)))
179
def get_tar_item(self, root, dp, now, tree):
180
"""Get a tarfile item and a file stream for its content."""
181
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
182
# TODO: would be cool to actually set it to the timestamp of the
183
# revision it was last changed
185
fileobj = self._put_in_tar(item, tree)
189
"""Return true if the object this entry represents has textual data.
191
Note that textual data includes binary content.
193
Also note that all entries get weave files created for them.
194
This attribute is primarily used when upgrading from old trees that
195
did not have the weave index for all inventory entries.
199
def __init__(self, file_id, name, parent_id, text_id=None):
101
200
"""Create an InventoryEntry
103
202
The filename must be a single component, relative to the
104
203
parent directory; it cannot be a whole path or relative name.
106
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
205
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
111
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
210
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
112
211
Traceback (most recent call last):
113
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
212
InvalidEntryName: Invalid entry name: src/hello.c
115
214
if '/' in name or '\\' in name:
116
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
215
raise errors.InvalidEntryName(name=name)
216
self.executable = False
118
218
self.text_sha1 = None
119
219
self.text_size = None
121
220
self.file_id = file_id
124
222
self.text_id = text_id
125
223
self.parent_id = parent_id
126
if kind == 'directory':
131
raise BzrError("unhandled entry kind %r" % kind)
224
self.symlink_target = None
225
self.reference_revision = None
227
def kind_character(self):
228
"""Return a short kind indicator useful for appending to names."""
229
raise BzrError('unknown kind %r' % self.kind)
231
known_kinds = ('file', 'directory', 'symlink')
233
def _put_in_tar(self, item, tree):
234
"""populate item for stashing in a tar, and return the content stream.
236
If no content is available, return None.
238
raise BzrError("don't know how to export {%s} of kind %r" %
239
(self.file_id, self.kind))
241
@deprecated_method(deprecated_in((1, 6, 0)))
242
def put_on_disk(self, dest, dp, tree):
243
"""Create a representation of self on disk in the prefix dest.
245
This is a template method - implement _put_on_disk in subclasses.
247
fullpath = osutils.pathjoin(dest, dp)
248
self._put_on_disk(fullpath, tree)
249
# mutter(" export {%s} kind %s to %s", self.file_id,
250
# self.kind, fullpath)
252
def _put_on_disk(self, fullpath, tree):
253
"""Put this entry onto disk at fullpath, from tree tree."""
254
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
135
256
def sorted_children(self):
136
l = self.children.items()
257
return sorted(self.children.items())
260
def versionable_kind(kind):
261
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
263
def check(self, checker, rev_id, inv, tree):
264
"""Check this inventory entry is intact.
266
This is a template method, override _check for kind specific
269
:param checker: Check object providing context for the checks;
270
can be used to find out what parts of the repository have already
272
:param rev_id: Revision id from which this InventoryEntry was loaded.
273
Not necessarily the last-changed revision for this file.
274
:param inv: Inventory from which the entry was loaded.
275
:param tree: RevisionTree for this entry.
277
if self.parent_id is not None:
278
if not inv.has_id(self.parent_id):
279
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
280
% (self.parent_id, rev_id))
281
self._check(checker, rev_id, tree)
283
def _check(self, checker, rev_id, tree):
284
"""Check this inventory entry for kind specific errors."""
285
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
142
other = InventoryEntry(self.file_id, self.name, self.kind,
143
self.parent_id, text_id=self.text_id)
144
other.text_sha1 = self.text_sha1
145
other.text_size = self.text_size
146
# note that children are *not* copied; they're pulled across when
289
"""Clone this inventory entry."""
290
raise NotImplementedError
293
def describe_change(old_entry, new_entry):
294
"""Describe the change between old_entry and this.
296
This smells of being an InterInventoryEntry situation, but as its
297
the first one, we're making it a static method for now.
299
An entry with a different parent, or different name is considered
300
to be renamed. Reparenting is an internal detail.
301
Note that renaming the parent does not trigger a rename for the
304
# TODO: Perhaps return an object rather than just a string
305
if old_entry is new_entry:
306
# also the case of both being None
308
elif old_entry is None:
310
elif new_entry is None:
312
if old_entry.kind != new_entry.kind:
314
text_modified, meta_modified = new_entry.detect_changes(old_entry)
315
if text_modified or meta_modified:
319
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
320
if old_entry.parent_id != new_entry.parent_id:
322
elif old_entry.name != new_entry.name:
326
if renamed and not modified:
327
return InventoryEntry.RENAMED
328
if modified and not renamed:
330
if modified and renamed:
331
return InventoryEntry.MODIFIED_AND_RENAMED
151
334
def __repr__(self):
152
return ("%s(%r, %r, kind=%r, parent_id=%r)"
335
return ("%s(%r, %r, parent_id=%r, revision=%r)"
153
336
% (self.__class__.__name__,
160
def to_element(self):
161
"""Convert to XML element"""
162
from bzrlib.xml import Element
166
e.set('name', self.name)
167
e.set('file_id', self.file_id)
168
e.set('kind', self.kind)
170
if self.text_size != None:
171
e.set('text_size', '%d' % self.text_size)
173
for f in ['text_id', 'text_sha1']:
178
# to be conservative, we don't externalize the root pointers
179
# for now, leaving them as null in the xml form. in a future
180
# version it will be implied by nested elements.
181
if self.parent_id != ROOT_ID:
182
assert isinstance(self.parent_id, basestring)
183
e.set('parent_id', self.parent_id)
190
def from_element(cls, elt):
191
assert elt.tag == 'entry'
193
## original format inventories don't have a parent_id for
194
## nodes in the root directory, but it's cleaner to use one
196
parent_id = elt.get('parent_id')
197
if parent_id == None:
200
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
201
self.text_id = elt.get('text_id')
202
self.text_sha1 = elt.get('text_sha1')
204
## mutter("read inventoryentry: %r" % (elt.attrib))
206
v = elt.get('text_size')
207
self.text_size = v and int(v)
212
from_element = classmethod(from_element)
214
342
def __eq__(self, other):
344
# For the case when objects are cached
215
346
if not isinstance(other, InventoryEntry):
216
347
return NotImplemented
218
return (self.file_id == other.file_id) \
219
and (self.name == other.name) \
220
and (self.text_sha1 == other.text_sha1) \
221
and (self.text_size == other.text_size) \
222
and (self.text_id == other.text_id) \
223
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
349
return ((self.file_id == other.file_id)
350
and (self.name == other.name)
351
and (other.symlink_target == self.symlink_target)
352
and (self.text_sha1 == other.text_sha1)
353
and (self.text_size == other.text_size)
354
and (self.text_id == other.text_id)
355
and (self.parent_id == other.parent_id)
356
and (self.kind == other.kind)
357
and (self.revision == other.revision)
358
and (self.executable == other.executable)
359
and (self.reference_revision == other.reference_revision)
227
362
def __ne__(self, other):
228
363
return not (self == other)
230
365
def __hash__(self):
231
366
raise ValueError('not hashable')
368
def _unchanged(self, previous_ie):
369
"""Has this entry changed relative to previous_ie.
371
This method should be overridden in child classes.
374
# different inv parent
375
if previous_ie.parent_id != self.parent_id:
378
elif previous_ie.name != self.name:
380
elif previous_ie.kind != self.kind:
384
def _read_tree_state(self, path, work_tree):
385
"""Populate fields in the inventory entry from the given tree.
387
Note that this should be modified to be a noop on virtual trees
388
as all entries created there are prepopulated.
390
# TODO: Rather than running this manually, we should check the
391
# working sha1 and other expensive properties when they're
392
# first requested, or preload them if they're already known
393
pass # nothing to do by default
395
def _forget_tree_state(self):
235
399
class RootEntry(InventoryEntry):
401
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
402
'text_id', 'parent_id', 'children', 'executable',
403
'revision', 'symlink_target', 'reference_revision']
405
def _check(self, checker, rev_id, tree):
406
"""See InventoryEntry._check"""
236
408
def __init__(self, file_id):
237
409
self.file_id = file_id
238
410
self.children = {}
239
self.kind = 'root_directory'
411
self.kind = 'directory'
240
412
self.parent_id = None
415
symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
416
' Please use InventoryDirectory instead.',
417
DeprecationWarning, stacklevel=2)
243
419
def __eq__(self, other):
244
420
if not isinstance(other, RootEntry):
245
421
return NotImplemented
247
423
return (self.file_id == other.file_id) \
248
424
and (self.children == other.children)
252
class Inventory(object):
427
class InventoryDirectory(InventoryEntry):
428
"""A directory in an inventory."""
430
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
431
'text_id', 'parent_id', 'children', 'executable',
432
'revision', 'symlink_target', 'reference_revision']
434
def _check(self, checker, rev_id, tree):
435
"""See InventoryEntry._check"""
436
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
437
raise BzrCheckError('directory {%s} has text in revision {%s}'
438
% (self.file_id, rev_id))
441
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
442
other.revision = self.revision
443
# note that children are *not* copied; they're pulled across when
447
def __init__(self, file_id, name, parent_id):
448
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
450
self.kind = 'directory'
452
def kind_character(self):
453
"""See InventoryEntry.kind_character."""
456
def _put_in_tar(self, item, tree):
457
"""See InventoryEntry._put_in_tar."""
458
item.type = tarfile.DIRTYPE
465
def _put_on_disk(self, fullpath, tree):
466
"""See InventoryEntry._put_on_disk."""
470
class InventoryFile(InventoryEntry):
471
"""A file in an inventory."""
473
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
474
'text_id', 'parent_id', 'children', 'executable',
475
'revision', 'symlink_target', 'reference_revision']
477
def _check(self, checker, tree_revision_id, tree):
478
"""See InventoryEntry._check"""
479
key = (self.file_id, self.revision)
480
if key in checker.checked_texts:
481
prev_sha = checker.checked_texts[key]
482
if prev_sha != self.text_sha1:
484
'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
485
(self.file_id, tree_revision_id, prev_sha, self.text_sha1,
488
checker.repeated_text_cnt += 1
491
checker.checked_text_cnt += 1
492
# We can't check the length, because Weave doesn't store that
493
# information, and the whole point of looking at the weave's
494
# sha1sum is that we don't have to extract the text.
495
if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
496
raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
497
checker.checked_texts[key] = self.text_sha1
500
other = InventoryFile(self.file_id, self.name, self.parent_id)
501
other.executable = self.executable
502
other.text_id = self.text_id
503
other.text_sha1 = self.text_sha1
504
other.text_size = self.text_size
505
other.revision = self.revision
508
def detect_changes(self, old_entry):
509
"""See InventoryEntry.detect_changes."""
510
text_modified = (self.text_sha1 != old_entry.text_sha1)
511
meta_modified = (self.executable != old_entry.executable)
512
return text_modified, meta_modified
514
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
515
output_to, reverse=False):
516
"""See InventoryEntry._diff."""
517
from bzrlib.diff import DiffText
518
from_file_id = self.file_id
520
to_file_id = to_entry.file_id
524
to_file_id, from_file_id = from_file_id, to_file_id
525
tree, to_tree = to_tree, tree
526
from_label, to_label = to_label, from_label
527
differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
529
return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
532
"""See InventoryEntry.has_text."""
535
def __init__(self, file_id, name, parent_id):
536
super(InventoryFile, self).__init__(file_id, name, parent_id)
539
def kind_character(self):
540
"""See InventoryEntry.kind_character."""
543
def _put_in_tar(self, item, tree):
544
"""See InventoryEntry._put_in_tar."""
545
item.type = tarfile.REGTYPE
546
fileobj = tree.get_file(self.file_id)
547
item.size = self.text_size
548
if tree.is_executable(self.file_id):
554
def _put_on_disk(self, fullpath, tree):
555
"""See InventoryEntry._put_on_disk."""
556
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
557
if tree.is_executable(self.file_id):
558
os.chmod(fullpath, 0755)
560
def _read_tree_state(self, path, work_tree):
561
"""See InventoryEntry._read_tree_state."""
562
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
563
# FIXME: 20050930 probe for the text size when getting sha1
564
# in _read_tree_state
565
self.executable = work_tree.is_executable(self.file_id, path=path)
568
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s, revision=%s)"
569
% (self.__class__.__name__,
577
def _forget_tree_state(self):
578
self.text_sha1 = None
580
def _unchanged(self, previous_ie):
581
"""See InventoryEntry._unchanged."""
582
compatible = super(InventoryFile, self)._unchanged(previous_ie)
583
if self.text_sha1 != previous_ie.text_sha1:
586
# FIXME: 20050930 probe for the text size when getting sha1
587
# in _read_tree_state
588
self.text_size = previous_ie.text_size
589
if self.executable != previous_ie.executable:
594
class InventoryLink(InventoryEntry):
595
"""A file in an inventory."""
597
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
598
'text_id', 'parent_id', 'children', 'executable',
599
'revision', 'symlink_target', 'reference_revision']
601
def _check(self, checker, rev_id, tree):
602
"""See InventoryEntry._check"""
603
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
604
raise BzrCheckError('symlink {%s} has text in revision {%s}'
605
% (self.file_id, rev_id))
606
if self.symlink_target is None:
607
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
608
% (self.file_id, rev_id))
611
other = InventoryLink(self.file_id, self.name, self.parent_id)
612
other.symlink_target = self.symlink_target
613
other.revision = self.revision
616
def detect_changes(self, old_entry):
617
"""See InventoryEntry.detect_changes."""
618
# FIXME: which _modified field should we use ? RBC 20051003
619
text_modified = (self.symlink_target != old_entry.symlink_target)
621
mutter(" symlink target changed")
622
meta_modified = False
623
return text_modified, meta_modified
625
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
626
output_to, reverse=False):
627
"""See InventoryEntry._diff."""
628
from bzrlib.diff import DiffSymlink
629
old_target = self.symlink_target
630
if to_entry is not None:
631
new_target = to_entry.symlink_target
640
new_target, old_target = old_target, new_target
641
differ = DiffSymlink(old_tree, new_tree, output_to)
642
return differ.diff_symlink(old_target, new_target)
644
def __init__(self, file_id, name, parent_id):
645
super(InventoryLink, self).__init__(file_id, name, parent_id)
646
self.kind = 'symlink'
648
def kind_character(self):
649
"""See InventoryEntry.kind_character."""
652
def _put_in_tar(self, item, tree):
653
"""See InventoryEntry._put_in_tar."""
654
item.type = tarfile.SYMTYPE
658
item.linkname = self.symlink_target
661
def _put_on_disk(self, fullpath, tree):
662
"""See InventoryEntry._put_on_disk."""
664
os.symlink(self.symlink_target, fullpath)
666
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
668
def _read_tree_state(self, path, work_tree):
669
"""See InventoryEntry._read_tree_state."""
670
self.symlink_target = work_tree.get_symlink_target(self.file_id)
672
def _forget_tree_state(self):
673
self.symlink_target = None
675
def _unchanged(self, previous_ie):
676
"""See InventoryEntry._unchanged."""
677
compatible = super(InventoryLink, self)._unchanged(previous_ie)
678
if self.symlink_target != previous_ie.symlink_target:
683
class TreeReference(InventoryEntry):
685
kind = 'tree-reference'
687
def __init__(self, file_id, name, parent_id, revision=None,
688
reference_revision=None):
689
InventoryEntry.__init__(self, file_id, name, parent_id)
690
self.revision = revision
691
self.reference_revision = reference_revision
694
return TreeReference(self.file_id, self.name, self.parent_id,
695
self.revision, self.reference_revision)
697
def _read_tree_state(self, path, work_tree):
698
"""Populate fields in the inventory entry from the given tree.
700
self.reference_revision = work_tree.get_reference_revision(
703
def _forget_tree_state(self):
704
self.reference_revision = None
706
def _unchanged(self, previous_ie):
707
"""See InventoryEntry._unchanged."""
708
compatible = super(TreeReference, self)._unchanged(previous_ie)
709
if self.reference_revision != previous_ie.reference_revision:
714
class CommonInventory(object):
715
"""Basic inventory logic, defined in terms of primitives like has_id."""
717
def __contains__(self, file_id):
718
"""True if this entry contains a file with given id.
720
>>> inv = Inventory()
721
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
722
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
728
Note that this method along with __iter__ are not encouraged for use as
729
they are less clear than specific query methods - they may be rmeoved
732
return self.has_id(file_id)
734
def id2path(self, file_id):
735
"""Return as a string the path to file_id.
738
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
739
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
740
>>> print i.id2path('foo-id')
743
# get all names, skipping root
744
return '/'.join(reversed(
745
[parent.name for parent in
746
self._iter_file_id_parents(file_id)][:-1]))
748
def iter_entries(self, from_dir=None, recursive=True):
749
"""Return (path, entry) pairs, in order by name.
751
:param from_dir: if None, start from the root,
752
otherwise start from this directory (either file-id or entry)
753
:param recursive: recurse into directories or not
756
if self.root is None:
760
elif isinstance(from_dir, basestring):
761
from_dir = self[from_dir]
763
# unrolling the recursive called changed the time from
764
# 440ms/663ms (inline/total) to 116ms/116ms
765
children = from_dir.children.items()
768
for name, ie in children:
771
children = collections.deque(children)
772
stack = [(u'', children)]
774
from_dir_relpath, children = stack[-1]
777
name, ie = children.popleft()
779
# we know that from_dir_relpath never ends in a slash
780
# and 'f' doesn't begin with one, we can do a string op, rather
781
# than the checks of pathjoin(), though this means that all paths
783
path = from_dir_relpath + '/' + name
787
if ie.kind != 'directory':
790
# But do this child first
791
new_children = ie.children.items()
793
new_children = collections.deque(new_children)
794
stack.append((path, new_children))
795
# Break out of inner loop, so that we start outer loop with child
798
# if we finished all children, pop it off the stack
801
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
802
yield_parents=False):
803
"""Iterate over the entries in a directory first order.
805
This returns all entries for a directory before returning
806
the entries for children of a directory. This is not
807
lexicographically sorted order, and is a hybrid between
808
depth-first and breadth-first.
810
:param yield_parents: If True, yield the parents from the root leading
811
down to specific_file_ids that have been requested. This has no
812
impact if specific_file_ids is None.
813
:return: This yields (path, entry) pairs
815
if specific_file_ids and not isinstance(specific_file_ids, set):
816
specific_file_ids = set(specific_file_ids)
817
# TODO? Perhaps this should return the from_dir so that the root is
818
# yielded? or maybe an option?
820
if self.root is None:
822
# Optimize a common case
823
if (not yield_parents and specific_file_ids is not None and
824
len(specific_file_ids) == 1):
825
file_id = list(specific_file_ids)[0]
827
yield self.id2path(file_id), self[file_id]
830
if (specific_file_ids is None or yield_parents or
831
self.root.file_id in specific_file_ids):
833
elif isinstance(from_dir, basestring):
834
from_dir = self[from_dir]
836
if specific_file_ids is not None:
837
# TODO: jam 20070302 This could really be done as a loop rather
838
# than a bunch of recursive calls.
841
def add_ancestors(file_id):
842
if file_id not in byid:
844
parent_id = byid[file_id].parent_id
845
if parent_id is None:
847
if parent_id not in parents:
848
parents.add(parent_id)
849
add_ancestors(parent_id)
850
for file_id in specific_file_ids:
851
add_ancestors(file_id)
855
stack = [(u'', from_dir)]
857
cur_relpath, cur_dir = stack.pop()
860
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
862
child_relpath = cur_relpath + child_name
864
if (specific_file_ids is None or
865
child_ie.file_id in specific_file_ids or
866
(yield_parents and child_ie.file_id in parents)):
867
yield child_relpath, child_ie
869
if child_ie.kind == 'directory':
870
if parents is None or child_ie.file_id in parents:
871
child_dirs.append((child_relpath+'/', child_ie))
872
stack.extend(reversed(child_dirs))
874
def _make_delta(self, old):
875
"""Make an inventory delta from two inventories."""
878
adds = new_ids - old_ids
879
deletes = old_ids - new_ids
880
common = old_ids.intersection(new_ids)
882
for file_id in deletes:
883
delta.append((old.id2path(file_id), None, file_id, None))
885
delta.append((None, self.id2path(file_id), file_id, self[file_id]))
886
for file_id in common:
887
if old[file_id] != self[file_id]:
888
delta.append((old.id2path(file_id), self.id2path(file_id),
889
file_id, self[file_id]))
892
def _get_mutable_inventory(self):
893
"""Returns a mutable copy of the object.
895
Some inventories are immutable, yet working trees, for example, needs
896
to mutate exisiting inventories instead of creating a new one.
898
raise NotImplementedError(self._get_mutable_inventory)
900
def make_entry(self, kind, name, parent_id, file_id=None):
901
"""Simple thunk to bzrlib.inventory.make_entry."""
902
return make_entry(kind, name, parent_id, file_id)
905
"""Return list of (path, ie) for all entries except the root.
907
This may be faster than iter_entries.
910
def descend(dir_ie, dir_path):
911
kids = dir_ie.children.items()
913
for name, ie in kids:
914
child_path = osutils.pathjoin(dir_path, name)
915
accum.append((child_path, ie))
916
if ie.kind == 'directory':
917
descend(ie, child_path)
919
descend(self.root, u'')
922
def directories(self):
923
"""Return (path, entry) pairs for all directories, including the root.
926
def descend(parent_ie, parent_path):
927
accum.append((parent_path, parent_ie))
929
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
932
for name, child_ie in kids:
933
child_path = osutils.pathjoin(parent_path, name)
934
descend(child_ie, child_path)
935
descend(self.root, u'')
938
def path2id(self, name):
939
"""Walk down through directories to return entry of last component.
941
names may be either a list of path components, or a single
942
string, in which case it is automatically split.
944
This returns the entry of the last component in the path,
945
which may be either a file or a directory.
947
Returns None IFF the path is not found.
949
if isinstance(name, basestring):
950
name = osutils.splitpath(name)
952
# mutter("lookup path %r" % name)
956
except errors.NoSuchId:
957
# root doesn't exist yet so nothing else can
963
children = getattr(parent, 'children', None)
972
return parent.file_id
974
def filter(self, specific_fileids):
975
"""Get an inventory view filtered against a set of file-ids.
977
Children of directories and parents are included.
979
The result may or may not reference the underlying inventory
980
so it should be treated as immutable.
982
interesting_parents = set()
983
for fileid in specific_fileids:
985
interesting_parents.update(self.get_idpath(fileid))
986
except errors.NoSuchId:
987
# This fileid is not in the inventory - that's ok
989
entries = self.iter_entries()
990
if self.root is None:
991
return Inventory(root_id=None)
992
other = Inventory(entries.next()[1].file_id)
993
other.root.revision = self.root.revision
994
other.revision_id = self.revision_id
995
directories_to_expand = set()
996
for path, entry in entries:
997
file_id = entry.file_id
998
if (file_id in specific_fileids
999
or entry.parent_id in directories_to_expand):
1000
if entry.kind == 'directory':
1001
directories_to_expand.add(file_id)
1002
elif file_id not in interesting_parents:
1004
other.add(entry.copy())
1007
def get_idpath(self, file_id):
1008
"""Return a list of file_ids for the path to an entry.
1010
The list contains one element for each directory followed by
1011
the id of the file itself. So the length of the returned list
1012
is equal to the depth of the file in the tree, counting the
1013
root directory as depth 1.
1016
for parent in self._iter_file_id_parents(file_id):
1017
p.insert(0, parent.file_id)
1021
class Inventory(CommonInventory):
253
1022
"""Inventory of versioned files in a tree.
255
1024
This describes which file_id is present at each point in the tree,
295
1069
The inventory is created with a default root directory, with
298
# We are letting Branch(init=True) create a unique inventory
299
# root id. Rather than generating a random one here.
301
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
self.root = RootEntry(root_id)
1072
if root_id is not None:
1073
self._set_root(InventoryDirectory(root_id, u'', None))
1077
self.revision_id = revision_id
1080
# More than one page of ouput is not useful anymore to debug
1083
contents = repr(self._byid)
1084
if len(contents) > max_len:
1085
contents = contents[:(max_len-len(closing))] + closing
1086
return "<Inventory object at %x, contents=%r>" % (id(self), contents)
1088
def apply_delta(self, delta):
1089
"""Apply a delta to this inventory.
1091
See the inventory developers documentation for the theory behind
1094
:param delta: A list of changes to apply. After all the changes are
1095
applied the final inventory must be internally consistent, but it
1096
is ok to supply changes which, if only half-applied would have an
1097
invalid result - such as supplying two changes which rename two
1098
files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
1099
('B', 'A', 'B-id', b_entry)].
1101
Each change is a tuple, of the form (old_path, new_path, file_id,
1104
When new_path is None, the change indicates the removal of an entry
1105
from the inventory and new_entry will be ignored (using None is
1106
appropriate). If new_path is not None, then new_entry must be an
1107
InventoryEntry instance, which will be incorporated into the
1108
inventory (and replace any existing entry with the same file id).
1110
When old_path is None, the change indicates the addition of
1111
a new entry to the inventory.
1113
When neither new_path nor old_path are None, the change is a
1114
modification to an entry, such as a rename, reparent, kind change
1117
The children attribute of new_entry is ignored. This is because
1118
this method preserves children automatically across alterations to
1119
the parent of the children, and cases where the parent id of a
1120
child is changing require the child to be passed in as a separate
1121
change regardless. E.g. in the recursive deletion of a directory -
1122
the directory's children must be included in the delta, or the
1123
final inventory will be invalid.
1125
Note that a file_id must only appear once within a given delta.
1126
An AssertionError is raised otherwise.
1128
# Check that the delta is legal. It would be nice if this could be
1129
# done within the loops below but it's safer to validate the delta
1130
# before starting to mutate the inventory.
1131
unique_file_ids = set([f for _, _, f, _ in delta])
1132
if len(unique_file_ids) != len(delta):
1133
raise AssertionError("a file-id appears multiple times in %r"
1138
# Remove all affected items which were in the original inventory,
1139
# starting with the longest paths, thus ensuring parents are examined
1140
# after their children, which means that everything we examine has no
1141
# modified children remaining by the time we examine it.
1142
for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1143
if op is not None), reverse=True):
1144
if file_id not in self:
1147
# Preserve unaltered children of file_id for later reinsertion.
1148
file_id_children = getattr(self[file_id], 'children', {})
1149
if len(file_id_children):
1150
children[file_id] = file_id_children
1151
# Remove file_id and the unaltered children. If file_id is not
1152
# being deleted it will be reinserted back later.
1153
self.remove_recursive_id(file_id)
1154
# Insert all affected which should be in the new inventory, reattaching
1155
# their children if they had any. This is done from shortest path to
1156
# longest, ensuring that items which were modified and whose parents in
1157
# the resulting inventory were also modified, are inserted after their
1159
for new_path, new_entry in sorted((np, e) for op, np, f, e in
1160
delta if np is not None):
1161
if new_entry.kind == 'directory':
1162
# Pop the child which to allow detection of children whose
1163
# parents were deleted and which were not reattached to a new
1165
replacement = InventoryDirectory(new_entry.file_id,
1166
new_entry.name, new_entry.parent_id)
1167
replacement.revision = new_entry.revision
1168
replacement.children = children.pop(replacement.file_id, {})
1169
new_entry = replacement
1172
# Get the parent id that was deleted
1173
parent_id, children = children.popitem()
1174
raise errors.InconsistentDelta("<deleted>", parent_id,
1175
"The file id was deleted but its children were not deleted.")
1177
def _set_root(self, ie):
303
1179
self._byid = {self.root.file_id: self.root}
1182
# TODO: jam 20051218 Should copy also copy the revision_id?
1183
entries = self.iter_entries()
1184
if self.root is None:
1185
return Inventory(root_id=None)
1186
other = Inventory(entries.next()[1].file_id)
1187
other.root.revision = self.root.revision
1188
# copy recursively so we know directories will be added before
1189
# their children. There are more efficient ways than this...
1190
for path, entry in entries:
1191
other.add(entry.copy())
1194
def _get_mutable_inventory(self):
1195
"""See CommonInventory._get_mutable_inventory."""
1196
return copy.deepcopy(self)
306
1198
def __iter__(self):
1199
"""Iterate over all file-ids."""
307
1200
return iter(self._byid)
1202
def iter_just_entries(self):
1203
"""Iterate over all entries.
1205
Unlike iter_entries(), just the entries are returned (not (path, ie))
1206
and the order of entries is undefined.
1208
XXX: We may not want to merge this into bzr.dev.
1210
if self.root is None:
1212
for _, ie in self._byid.iteritems():
310
1215
def __len__(self):
311
1216
"""Returns number of entries."""
312
1217
return len(self._byid)
315
def iter_entries(self, from_dir=None):
316
"""Return (path, entry) pairs, in order by name."""
320
elif isinstance(from_dir, basestring):
321
from_dir = self._byid[from_dir]
323
kids = from_dir.children.items()
325
for name, ie in kids:
327
if ie.kind == 'directory':
328
for cn, cie in self.iter_entries(from_dir=ie.file_id):
329
yield os.path.join(name, cn), cie
333
"""Return list of (path, ie) for all entries except the root.
335
This may be faster than iter_entries.
338
def descend(dir_ie, dir_path):
339
kids = dir_ie.children.items()
341
for name, ie in kids:
342
child_path = os.path.join(dir_path, name)
343
accum.append((child_path, ie))
344
if ie.kind == 'directory':
345
descend(ie, child_path)
347
descend(self.root, '')
351
def directories(self):
352
"""Return (path, entry) pairs for all directories, including the root.
355
def descend(parent_ie, parent_path):
356
accum.append((parent_path, parent_ie))
358
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
361
for name, child_ie in kids:
362
child_path = os.path.join(parent_path, name)
363
descend(child_ie, child_path)
364
descend(self.root, '')
369
def __contains__(self, file_id):
370
"""True if this entry contains a file with given id.
372
>>> inv = Inventory()
373
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
379
return file_id in self._byid
382
1219
def __getitem__(self, file_id):
383
1220
"""Return the entry for given file_id.
385
1222
>>> inv = Inventory()
386
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
1223
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1224
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
387
1225
>>> inv['123123'].name
391
1229
return self._byid[file_id]
392
1230
except KeyError:
394
raise BzrError("can't look up file_id None")
396
raise BzrError("file_id {%s} not in inventory" % file_id)
1231
# really we're passing an inventory, not a tree...
1232
raise errors.NoSuchId(self, file_id)
399
1234
def get_file_kind(self, file_id):
400
1235
return self._byid[file_id].kind
520
1322
>>> i2 = Inventory()
523
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
1325
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1326
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
526
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
1329
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1330
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
530
1334
if not isinstance(other, Inventory):
531
1335
return NotImplemented
533
if len(self._byid) != len(other._byid):
534
# shortcut: obviously not the same
537
1337
return self._byid == other._byid
540
1339
def __ne__(self, other):
541
return not (self == other)
1340
return not self.__eq__(other)
544
1342
def __hash__(self):
545
1343
raise ValueError('not hashable')
549
def get_idpath(self, file_id):
550
"""Return a list of file_ids for the path to an entry.
552
The list contains one element for each directory followed by
553
the id of the file itself. So the length of the returned list
554
is equal to the depth of the file in the tree, counting the
555
root directory as depth 1.
558
while file_id != None:
1345
def _iter_file_id_parents(self, file_id):
1346
"""Yield the parents of file_id up to the root."""
1347
while file_id is not None:
560
1349
ie = self._byid[file_id]
561
1350
except KeyError:
562
raise BzrError("file_id {%s} not found in inventory" % file_id)
563
p.insert(0, ie.file_id)
1351
raise errors.NoSuchId(tree=None, file_id=file_id)
564
1353
file_id = ie.parent_id
568
def id2path(self, file_id):
569
"""Return as a list the path to file_id."""
571
# get all names, skipping root
572
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
573
return os.sep.join(p)
577
def path2id(self, name):
578
"""Walk down through directories to return entry of last component.
580
names may be either a list of path components, or a single
581
string, in which case it is automatically split.
583
This returns the entry of the last component in the path,
584
which may be either a file or a directory.
586
Returns None iff the path is not found.
1355
def has_filename(self, filename):
1356
return bool(self.path2id(filename))
1358
def has_id(self, file_id):
1359
return (file_id in self._byid)
1361
def _make_delta(self, old):
1362
"""Make an inventory delta from two inventories."""
1363
old_getter = getattr(old, '_byid', old)
1364
new_getter = self._byid
1365
old_ids = set(old_getter)
1366
new_ids = set(new_getter)
1367
adds = new_ids - old_ids
1368
deletes = old_ids - new_ids
1369
if not adds and not deletes:
1372
common = old_ids.intersection(new_ids)
1374
for file_id in deletes:
1375
delta.append((old.id2path(file_id), None, file_id, None))
1376
for file_id in adds:
1377
delta.append((None, self.id2path(file_id), file_id, self[file_id]))
1378
for file_id in common:
1379
new_ie = new_getter[file_id]
1380
old_ie = old_getter[file_id]
1381
# If xml_serializer returns the cached InventoryEntries (rather
1382
# than always doing .copy()), inlining the 'is' check saves 2.7M
1383
# calls to __eq__. Under lsprof this saves 20s => 6s.
1384
# It is a minor improvement without lsprof.
1385
if old_ie is new_ie or old_ie == new_ie:
1388
delta.append((old.id2path(file_id), self.id2path(file_id),
1392
def remove_recursive_id(self, file_id):
1393
"""Remove file_id, and children, from the inventory.
1395
:param file_id: A file_id to remove.
588
if isinstance(name, types.StringTypes):
589
name = splitpath(name)
591
mutter("lookup path %r" % name)
596
cie = parent.children[f]
598
assert cie.parent_id == parent.file_id
604
return parent.file_id
607
def has_filename(self, names):
608
return bool(self.path2id(names))
611
def has_id(self, file_id):
612
return self._byid.has_key(file_id)
1397
to_find_delete = [self._byid[file_id]]
1399
while to_find_delete:
1400
ie = to_find_delete.pop()
1401
to_delete.append(ie.file_id)
1402
if ie.kind == 'directory':
1403
to_find_delete.extend(ie.children.values())
1404
for file_id in reversed(to_delete):
1406
del self._byid[file_id]
1407
if ie.parent_id is not None:
1408
del self[ie.parent_id].children[ie.name]
615
1412
def rename(self, file_id, new_parent_id, new_name):
616
1413
"""Move a file within the inventory.
618
1415
This can change either the name, or the parent, or both.
620
This does not move the working file."""
1417
This does not move the working file.
1419
new_name = ensure_normalized_name(new_name)
621
1420
if not is_valid_name(new_name):
622
1421
raise BzrError("not an acceptable filename: %r" % new_name)
638
1437
del old_parent.children[file_ie.name]
639
1438
new_parent.children[new_name] = file_ie
641
1440
file_ie.name = new_name
642
1441
file_ie.parent_id = new_parent_id
1443
def is_root(self, file_id):
1444
return self.root is not None and file_id == self.root.file_id
1447
class CHKInventory(CommonInventory):
1448
"""An inventory persisted in a CHK store.
1450
By design, a CHKInventory is immutable so many of the methods
1451
supported by Inventory - add, rename, apply_delta, etc - are *not*
1452
supported. To create a new CHKInventory, use create_by_apply_delta()
1453
or from_inventory(), say.
1455
Internally, a CHKInventory has one or two CHKMaps:
1457
* id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1458
* parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1461
The second map is optional and not present in early CHkRepository's.
1463
No caching is performed: every method call or item access will perform
1464
requests to the storage layer. As such, keep references to objects you
1468
def __init__(self, search_key_name):
1469
CommonInventory.__init__(self)
1470
self._fileid_to_entry_cache = {}
1471
self._path_to_fileid_cache = {}
1472
self._search_key_name = search_key_name
1474
def __eq__(self, other):
1475
"""Compare two sets by comparing their contents."""
1476
if not isinstance(other, CHKInventory):
1477
return NotImplemented
1479
this_key = self.id_to_entry.key()
1480
other_key = other.id_to_entry.key()
1481
this_pid_key = self.parent_id_basename_to_file_id.key()
1482
other_pid_key = other.parent_id_basename_to_file_id.key()
1483
if None in (this_key, this_pid_key, other_key, other_pid_key):
1485
return this_key == other_key and this_pid_key == other_pid_key
1487
def _entry_to_bytes(self, entry):
1488
"""Serialise entry as a single bytestring.
1490
:param Entry: An inventory entry.
1491
:return: A bytestring for the entry.
1494
ENTRY ::= FILE | DIR | SYMLINK | TREE
1495
FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
1496
DIR ::= "dir: " COMMON
1497
SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
1498
TREE ::= "tree: " COMMON REFERENCE_REVISION
1499
COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
1502
if entry.parent_id is not None:
1503
parent_str = entry.parent_id
1506
name_str = entry.name.encode("utf8")
1507
if entry.kind == 'file':
1508
if entry.executable:
1512
return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
1513
entry.file_id, parent_str, name_str, entry.revision,
1514
entry.text_sha1, entry.text_size, exec_str)
1515
elif entry.kind == 'directory':
1516
return "dir: %s\n%s\n%s\n%s" % (
1517
entry.file_id, parent_str, name_str, entry.revision)
1518
elif entry.kind == 'symlink':
1519
return "symlink: %s\n%s\n%s\n%s\n%s" % (
1520
entry.file_id, parent_str, name_str, entry.revision,
1521
entry.symlink_target.encode("utf8"))
1522
elif entry.kind == 'tree-reference':
1523
return "tree: %s\n%s\n%s\n%s\n%s" % (
1524
entry.file_id, parent_str, name_str, entry.revision,
1525
entry.reference_revision)
1527
raise ValueError("unknown kind %r" % entry.kind)
1530
def _bytes_to_utf8name_key(bytes):
1531
"""Get the file_id, revision_id key out of bytes."""
1532
# We don't normally care about name, except for times when we want
1533
# to filter out empty names because of non rich-root...
1534
sections = bytes.split('\n')
1535
kind, file_id = sections[0].split(': ')
1536
return (sections[2], file_id, sections[3])
1538
def _bytes_to_entry(self, bytes):
1539
"""Deserialise a serialised entry."""
1540
sections = bytes.split('\n')
1541
if sections[0].startswith("file: "):
1542
result = InventoryFile(sections[0][6:],
1543
sections[2].decode('utf8'),
1545
result.text_sha1 = sections[4]
1546
result.text_size = int(sections[5])
1547
result.executable = sections[6] == "Y"
1548
elif sections[0].startswith("dir: "):
1549
result = CHKInventoryDirectory(sections[0][5:],
1550
sections[2].decode('utf8'),
1552
elif sections[0].startswith("symlink: "):
1553
result = InventoryLink(sections[0][9:],
1554
sections[2].decode('utf8'),
1556
result.symlink_target = sections[4].decode('utf8')
1557
elif sections[0].startswith("tree: "):
1558
result = TreeReference(sections[0][6:],
1559
sections[2].decode('utf8'),
1561
result.reference_revision = sections[4]
1563
raise ValueError("Not a serialised entry %r" % bytes)
1564
result.revision = sections[3]
1565
if result.parent_id == '':
1566
result.parent_id = None
1567
self._fileid_to_entry_cache[result.file_id] = result
1570
def _get_mutable_inventory(self):
1571
"""See CommonInventory._get_mutable_inventory."""
1572
entries = self.iter_entries()
1573
inv = Inventory(None, self.revision_id)
1574
for path, inv_entry in entries:
1575
inv.add(inv_entry.copy())
1578
def create_by_apply_delta(self, inventory_delta, new_revision_id,
1579
propagate_caches=False):
1580
"""Create a new CHKInventory by applying inventory_delta to this one.
1582
See the inventory developers documentation for the theory behind
1585
:param inventory_delta: The inventory delta to apply. See
1586
Inventory.apply_delta for details.
1587
:param new_revision_id: The revision id of the resulting CHKInventory.
1588
:param propagate_caches: If True, the caches for this inventory are
1589
copied to and updated for the result.
1590
:return: The new CHKInventory.
1592
result = CHKInventory(self._search_key_name)
1593
if propagate_caches:
1594
# Just propagate the path-to-fileid cache for now
1595
result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
1596
search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1597
self.id_to_entry._ensure_root()
1598
maximum_size = self.id_to_entry._root_node.maximum_size
1599
result.revision_id = new_revision_id
1600
result.id_to_entry = chk_map.CHKMap(
1601
self.id_to_entry._store,
1602
self.id_to_entry.key(),
1603
search_key_func=search_key_func)
1604
result.id_to_entry._ensure_root()
1605
result.id_to_entry._root_node.set_maximum_size(maximum_size)
1606
parent_id_basename_delta = []
1607
if self.parent_id_basename_to_file_id is not None:
1608
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1609
self.parent_id_basename_to_file_id._store,
1610
self.parent_id_basename_to_file_id.key(),
1611
search_key_func=search_key_func)
1612
result.parent_id_basename_to_file_id._ensure_root()
1613
self.parent_id_basename_to_file_id._ensure_root()
1614
result_p_id_root = result.parent_id_basename_to_file_id._root_node
1615
p_id_root = self.parent_id_basename_to_file_id._root_node
1616
result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1617
result_p_id_root._key_width = p_id_root._key_width
1619
result.parent_id_basename_to_file_id = None
1620
result.root_id = self.root_id
1621
id_to_entry_delta = []
1622
for old_path, new_path, file_id, entry in inventory_delta:
1625
result.root_id = file_id
1626
if new_path is None:
1631
if propagate_caches:
1633
del result._path_to_fileid_cache[old_path]
1637
new_key = (file_id,)
1638
new_value = result._entry_to_bytes(entry)
1639
# Update caches. It's worth doing this whether
1640
# we're propagating the old caches or not.
1641
result._path_to_fileid_cache[new_path] = file_id
1642
if old_path is None:
1645
old_key = (file_id,)
1646
id_to_entry_delta.append((old_key, new_key, new_value))
1647
if result.parent_id_basename_to_file_id is not None:
1648
# parent_id, basename changes
1649
if old_path is None:
1652
old_entry = self[file_id]
1653
old_key = self._parent_id_basename_key(old_entry)
1654
if new_path is None:
1658
new_key = self._parent_id_basename_key(entry)
1660
if old_key != new_key:
1661
# If the two keys are the same, the value will be unchanged
1662
# as its always the file id.
1663
parent_id_basename_delta.append((old_key, new_key, new_value))
1664
result.id_to_entry.apply_delta(id_to_entry_delta)
1665
if parent_id_basename_delta:
1666
result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
1670
def deserialise(klass, chk_store, bytes, expected_revision_id):
1671
"""Deserialise a CHKInventory.
1673
:param chk_store: A CHK capable VersionedFiles instance.
1674
:param bytes: The serialised bytes.
1675
:param expected_revision_id: The revision ID we think this inventory is
1677
:return: A CHKInventory
1679
lines = bytes.split('\n')
1681
raise AssertionError('bytes to deserialize must end with an eol')
1683
if lines[0] != 'chkinventory:':
1684
raise ValueError("not a serialised CHKInventory: %r" % bytes)
1686
allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
1687
'parent_id_basename_to_file_id',
1689
for line in lines[1:]:
1690
key, value = line.split(': ', 1)
1691
if key not in allowed_keys:
1692
raise errors.BzrError('Unknown key in inventory: %r\n%r'
1695
raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1698
revision_id = info['revision_id']
1699
root_id = info['root_id']
1700
search_key_name = info.get('search_key_name', 'plain')
1701
parent_id_basename_to_file_id = info.get(
1702
'parent_id_basename_to_file_id', None)
1703
id_to_entry = info['id_to_entry']
1705
result = CHKInventory(search_key_name)
1706
result.revision_id = revision_id
1707
result.root_id = root_id
1708
search_key_func = chk_map.search_key_registry.get(
1709
result._search_key_name)
1710
if parent_id_basename_to_file_id is not None:
1711
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1712
chk_store, (parent_id_basename_to_file_id,),
1713
search_key_func=search_key_func)
1715
result.parent_id_basename_to_file_id = None
1717
result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
1718
search_key_func=search_key_func)
1719
if (result.revision_id,) != expected_revision_id:
1720
raise ValueError("Mismatched revision id and expected: %r, %r" %
1721
(result.revision_id, expected_revision_id))
1725
def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
1726
"""Create a CHKInventory from an existing inventory.
1728
The content of inventory is copied into the chk_store, and a
1729
CHKInventory referencing that is returned.
1731
:param chk_store: A CHK capable VersionedFiles instance.
1732
:param inventory: The inventory to copy.
1733
:param maximum_size: The CHKMap node size limit.
1734
:param search_key_name: The identifier for the search key function
1736
result = klass(search_key_name)
1737
result.revision_id = inventory.revision_id
1738
result.root_id = inventory.root.file_id
1740
entry_to_bytes = result._entry_to_bytes
1741
parent_id_basename_key = result._parent_id_basename_key
1742
id_to_entry_dict = {}
1743
parent_id_basename_dict = {}
1744
for path, entry in inventory.iter_entries():
1745
id_to_entry_dict[(entry.file_id,)] = entry_to_bytes(entry)
1746
p_id_key = parent_id_basename_key(entry)
1747
parent_id_basename_dict[p_id_key] = entry.file_id
1749
result._populate_from_dicts(chk_store, id_to_entry_dict,
1750
parent_id_basename_dict, maximum_size=maximum_size)
1753
def _populate_from_dicts(self, chk_store, id_to_entry_dict,
1754
parent_id_basename_dict, maximum_size):
1755
search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1756
root_key = chk_map.CHKMap.from_dict(chk_store, id_to_entry_dict,
1757
maximum_size=maximum_size, key_width=1,
1758
search_key_func=search_key_func)
1759
self.id_to_entry = chk_map.CHKMap(chk_store, root_key,
1761
root_key = chk_map.CHKMap.from_dict(chk_store,
1762
parent_id_basename_dict,
1763
maximum_size=maximum_size, key_width=2,
1764
search_key_func=search_key_func)
1765
self.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1766
root_key, search_key_func)
1768
def _parent_id_basename_key(self, entry):
1769
"""Create a key for a entry in a parent_id_basename_to_file_id index."""
1770
if entry.parent_id is not None:
1771
parent_id = entry.parent_id
1774
return parent_id, entry.name.encode('utf8')
1776
def __getitem__(self, file_id):
1777
"""map a single file_id -> InventoryEntry."""
1779
raise errors.NoSuchId(self, file_id)
1780
result = self._fileid_to_entry_cache.get(file_id, None)
1781
if result is not None:
1784
return self._bytes_to_entry(
1785
self.id_to_entry.iteritems([(file_id,)]).next()[1])
1786
except StopIteration:
1787
# really we're passing an inventory, not a tree...
1788
raise errors.NoSuchId(self, file_id)
1790
def has_id(self, file_id):
1791
# Perhaps have an explicit 'contains' method on CHKMap ?
1792
if self._fileid_to_entry_cache.get(file_id, None) is not None:
1794
return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
1796
def is_root(self, file_id):
1797
return file_id == self.root_id
1799
def _iter_file_id_parents(self, file_id):
1800
"""Yield the parents of file_id up to the root."""
1801
while file_id is not None:
1805
raise errors.NoSuchId(tree=self, file_id=file_id)
1807
file_id = ie.parent_id
1810
"""Iterate over all file-ids."""
1811
for key, _ in self.id_to_entry.iteritems():
1814
def iter_just_entries(self):
1815
"""Iterate over all entries.
1817
Unlike iter_entries(), just the entries are returned (not (path, ie))
1818
and the order of entries is undefined.
1820
XXX: We may not want to merge this into bzr.dev.
1822
for key, entry in self.id_to_entry.iteritems():
1824
ie = self._fileid_to_entry_cache.get(file_id, None)
1826
ie = self._bytes_to_entry(entry)
1827
self._fileid_to_entry_cache[file_id] = ie
1830
def iter_changes(self, basis):
1831
"""Generate a Tree.iter_changes change list between this and basis.
1833
:param basis: Another CHKInventory.
1834
:return: An iterator over the changes between self and basis, as per
1835
tree.iter_changes().
1837
# We want: (file_id, (path_in_source, path_in_target),
1838
# changed_content, versioned, parent, name, kind,
1840
for key, basis_value, self_value in \
1841
self.id_to_entry.iter_changes(basis.id_to_entry):
1843
if basis_value is not None:
1844
basis_entry = basis._bytes_to_entry(basis_value)
1845
path_in_source = basis.id2path(file_id)
1846
basis_parent = basis_entry.parent_id
1847
basis_name = basis_entry.name
1848
basis_executable = basis_entry.executable
1850
path_in_source = None
1853
basis_executable = None
1854
if self_value is not None:
1855
self_entry = self._bytes_to_entry(self_value)
1856
path_in_target = self.id2path(file_id)
1857
self_parent = self_entry.parent_id
1858
self_name = self_entry.name
1859
self_executable = self_entry.executable
1861
path_in_target = None
1864
self_executable = None
1865
if basis_value is None:
1867
kind = (None, self_entry.kind)
1868
versioned = (False, True)
1869
elif self_value is None:
1871
kind = (basis_entry.kind, None)
1872
versioned = (True, False)
1874
kind = (basis_entry.kind, self_entry.kind)
1875
versioned = (True, True)
1876
changed_content = False
1877
if kind[0] != kind[1]:
1878
changed_content = True
1879
elif kind[0] == 'file':
1880
if (self_entry.text_size != basis_entry.text_size or
1881
self_entry.text_sha1 != basis_entry.text_sha1):
1882
changed_content = True
1883
elif kind[0] == 'symlink':
1884
if self_entry.symlink_target != basis_entry.symlink_target:
1885
changed_content = True
1886
elif kind[0] == 'tree-reference':
1887
if (self_entry.reference_revision !=
1888
basis_entry.reference_revision):
1889
changed_content = True
1890
parent = (basis_parent, self_parent)
1891
name = (basis_name, self_name)
1892
executable = (basis_executable, self_executable)
1893
if (not changed_content
1894
and parent[0] == parent[1]
1895
and name[0] == name[1]
1896
and executable[0] == executable[1]):
1897
# Could happen when only the revision changed for a directory
1900
yield (file_id, (path_in_source, path_in_target), changed_content,
1901
versioned, parent, name, kind, executable)
1904
"""Return the number of entries in the inventory."""
1905
return len(self.id_to_entry)
1907
def _make_delta(self, old):
1908
"""Make an inventory delta from two inventories."""
1909
if type(old) != CHKInventory:
1910
return CommonInventory._make_delta(self, old)
1912
for key, old_value, self_value in \
1913
self.id_to_entry.iter_changes(old.id_to_entry):
1915
if old_value is not None:
1916
old_path = old.id2path(file_id)
1919
if self_value is not None:
1920
entry = self._bytes_to_entry(self_value)
1921
self._fileid_to_entry_cache[file_id] = entry
1922
new_path = self.id2path(file_id)
1926
delta.append((old_path, new_path, file_id, entry))
1929
def path2id(self, name):
1930
"""See CommonInventory.path2id()."""
1931
result = self._path_to_fileid_cache.get(name, None)
1933
result = CommonInventory.path2id(self, name)
1934
self._path_to_fileid_cache[name] = result
1938
"""Serialise the inventory to lines."""
1939
lines = ["chkinventory:\n"]
1940
if self._search_key_name != 'plain':
1941
# custom ordering grouping things that don't change together
1942
lines.append('search_key_name: %s\n' % (self._search_key_name,))
1943
lines.append("root_id: %s\n" % self.root_id)
1944
lines.append('parent_id_basename_to_file_id: %s\n' %
1945
self.parent_id_basename_to_file_id.key())
1946
lines.append("revision_id: %s\n" % self.revision_id)
1947
lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1949
lines.append("revision_id: %s\n" % self.revision_id)
1950
lines.append("root_id: %s\n" % self.root_id)
1951
if self.parent_id_basename_to_file_id is not None:
1952
lines.append('parent_id_basename_to_file_id: %s\n' %
1953
self.parent_id_basename_to_file_id.key())
1954
lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1959
"""Get the root entry."""
1960
return self[self.root_id]
1963
class CHKInventoryDirectory(InventoryDirectory):
1964
"""A directory in an inventory."""
1966
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1967
'text_id', 'parent_id', '_children', 'executable',
1968
'revision', 'symlink_target', 'reference_revision',
1971
def __init__(self, file_id, name, parent_id, chk_inventory):
1972
# Don't call InventoryDirectory.__init__ - it isn't right for this
1974
InventoryEntry.__init__(self, file_id, name, parent_id)
1975
self._children = None
1976
self.kind = 'directory'
1977
self._chk_inventory = chk_inventory
1981
"""Access the list of children of this directory.
1983
With a parent_id_basename_to_file_id index, loads all the children,
1984
without loads the entire index. Without is bad. A more sophisticated
1985
proxy object might be nice, to allow partial loading of children as
1986
well when specific names are accessed. (So path traversal can be
1987
written in the obvious way but not examine siblings.).
1989
if self._children is not None:
1990
return self._children
1991
# No longer supported
1992
if self._chk_inventory.parent_id_basename_to_file_id is None:
1993
raise AssertionError("Inventories without"
1994
" parent_id_basename_to_file_id are no longer supported")
1996
# XXX: Todo - use proxy objects for the children rather than loading
1997
# all when the attribute is referenced.
1998
parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
2000
for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
2001
key_filter=[(self.file_id,)]):
2002
child_keys.add((file_id,))
2004
for file_id_key in child_keys:
2005
entry = self._chk_inventory._fileid_to_entry_cache.get(
2006
file_id_key[0], None)
2007
if entry is not None:
2008
result[entry.name] = entry
2009
cached.add(file_id_key)
2010
child_keys.difference_update(cached)
2011
# populate; todo: do by name
2012
id_to_entry = self._chk_inventory.id_to_entry
2013
for file_id_key, bytes in id_to_entry.iteritems(child_keys):
2014
entry = self._chk_inventory._bytes_to_entry(bytes)
2015
result[entry.name] = entry
2016
self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
2017
self._children = result
2021
'directory': InventoryDirectory,
2022
'file': InventoryFile,
2023
'symlink': InventoryLink,
2024
'tree-reference': TreeReference
2027
def make_entry(kind, name, parent_id, file_id=None):
2028
"""Create an inventory entry.
2030
:param kind: the type of inventory entry to create.
2031
:param name: the basename of the entry.
2032
:param parent_id: the parent_id of the entry.
2033
:param file_id: the file_id to use. if None, one will be created.
2036
file_id = generate_ids.gen_file_id(name)
2037
name = ensure_normalized_name(name)
2039
factory = entry_factory[kind]
2041
raise BzrError("unknown kind %r" % kind)
2042
return factory(file_id, name, parent_id)
2045
def ensure_normalized_name(name):
2048
:raises InvalidNormalization: When name is not normalized, and cannot be
2049
accessed on this platform by the normalized path.
2050
:return: The NFC normalised version of name.
2052
#------- This has been copied to bzrlib.dirstate.DirState.add, please
2053
# keep them synchronised.
2054
# we dont import normalized_filename directly because we want to be
2055
# able to change the implementation at runtime for tests.
2056
norm_name, can_access = osutils.normalized_filename(name)
2057
if norm_name != name:
2061
# TODO: jam 20060701 This would probably be more useful
2062
# if the error was raised with the full path
2063
raise errors.InvalidNormalization(name)
649
2069
def is_valid_name(name):
2071
if _NAME_RE is None:
652
2072
_NAME_RE = re.compile(r'^[^/\\]+$')
654
2074
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
