66
68
size in bytes of the text of the file
69
the revision_id in which the text of this file was introduced
71
70
(reading a version 4 tree created a text_id field.)
73
72
>>> i = Inventory()
76
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
78
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
75
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
76
InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
77
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
78
InventoryFile('2323', 'hello.c', parent_id='123')
80
79
>>> for j in i.iter_entries():
83
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
84
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
85
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
82
('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
83
('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
84
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
86
85
Traceback (most recent call last):
88
87
BzrError: inventory already contains entry with id {2323}
89
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
91
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
88
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
89
InventoryFile('2324', 'bye.c', parent_id='123')
90
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
91
InventoryDirectory('2325', 'wibble', parent_id='123')
93
92
>>> i.path2id('src/wibble')
97
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
96
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
97
InventoryFile('2326', 'wibble.c', parent_id='2325')
100
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
>>> for j in i.iter_entries():
103
... assert i.path2id(j[0])
99
InventoryFile('2326', 'wibble.c', parent_id='2325')
100
>>> for path, entry in i.iter_entries():
101
... print path.replace('\\\\', '/') # for win32 os.sep
102
... assert i.path2id(path)
109
108
src/wibble/wibble.c
110
>>> i.id2path('2326')
109
>>> i.id2path('2326').replace('\\\\', '/')
111
110
'src/wibble/wibble.c'
114
113
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
'text_id', 'parent_id', 'children',
116
'text_version', 'entry_version', ]
119
def __init__(self, file_id, name, kind, parent_id, text_id=None):
114
'text_id', 'parent_id', 'children', 'executable',
117
def _add_text_to_weave(self, new_lines, parents, weave_store):
118
weave_store.add_text(self.file_id, self.revision, new_lines, parents)
120
def detect_changes(self, old_entry):
121
"""Return a (text_modified, meta_modified) from this to old_entry.
123
_read_tree_state must have been called on self and old_entry prior to
124
calling detect_changes.
128
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
129
output_to, reverse=False):
130
"""Perform a diff from this to to_entry.
132
text_diff will be used for textual difference calculation.
133
This is a template method, override _diff in child classes.
135
self._read_tree_state(tree.id2path(self.file_id), tree)
137
# cannot diff from one kind to another - you must do a removal
138
# and an addif they do not match.
139
assert self.kind == to_entry.kind
140
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
142
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
145
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
146
output_to, reverse=False):
147
"""Perform a diff between two entries of the same kind."""
149
def get_tar_item(self, root, dp, now, tree):
150
"""Get a tarfile item and a file stream for its content."""
151
item = tarfile.TarInfo(os.path.join(root, dp))
152
# TODO: would be cool to actually set it to the timestamp of the
153
# revision it was last changed
155
fileobj = self._put_in_tar(item, tree)
159
"""Return true if the object this entry represents has textual data.
161
Note that textual data includes binary content.
165
def __init__(self, file_id, name, parent_id, text_id=None):
120
166
"""Create an InventoryEntry
122
168
The filename must be a single component, relative to the
123
169
parent directory; it cannot be a whole path or relative name.
125
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
171
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
130
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
176
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
131
177
Traceback (most recent call last):
132
178
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
135
181
if '/' in name or '\\' in name:
136
182
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
138
self.text_version = None
139
self.entry_version = None
184
self.executable = False
140
186
self.text_sha1 = None
141
187
self.text_size = None
142
188
self.file_id = file_id
145
190
self.text_id = text_id
146
191
self.parent_id = parent_id
147
if kind == 'directory':
152
raise BzrError("unhandled entry kind %r" % kind)
192
self.symlink_target = None
194
def kind_character(self):
195
"""Return a short kind indicator useful for appending to names."""
196
raise BzrError('unknown kind %r' % self.kind)
198
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
200
def _put_in_tar(self, item, tree):
201
"""populate item for stashing in a tar, and return the content stream.
203
If no content is available, return None.
205
raise BzrError("don't know how to export {%s} of kind %r" %
206
(self.file_id, self.kind))
208
def put_on_disk(self, dest, dp, tree):
209
"""Create a representation of self on disk in the prefix dest.
211
This is a template method - implement _put_on_disk in subclasses.
213
fullpath = appendpath(dest, dp)
214
self._put_on_disk(fullpath, tree)
215
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
217
def _put_on_disk(self, fullpath, tree):
218
"""Put this entry onto disk at fullpath, from tree tree."""
219
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
156
221
def sorted_children(self):
157
222
l = self.children.items()
227
def versionable_kind(kind):
228
return kind in ('file', 'directory', 'symlink')
230
def check(self, checker, rev_id, inv, tree):
231
"""Check this inventory entry is intact.
233
This is a template method, override _check for kind specific
236
if self.parent_id != None:
237
if not inv.has_id(self.parent_id):
238
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
239
% (self.parent_id, rev_id))
240
self._check(checker, rev_id, tree)
242
def _check(self, checker, rev_id, tree):
243
"""Check this inventory entry for kind specific errors."""
244
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
163
other = InventoryEntry(self.file_id, self.name, self.kind,
165
other.text_id = self.text_id
166
other.text_sha1 = self.text_sha1
167
other.text_size = self.text_size
168
other.text_version = self.text_version
169
# note that children are *not* copied; they're pulled across when
249
"""Clone this inventory entry."""
250
raise NotImplementedError
252
def _get_snapshot_change(self, previous_entries):
253
if len(previous_entries) > 1:
255
elif len(previous_entries) == 0:
258
return 'modified/renamed/reparented'
174
260
def __repr__(self):
175
return ("%s(%r, %r, kind=%r, parent_id=%r)"
261
return ("%s(%r, %r, parent_id=%r)"
176
262
% (self.__class__.__name__,
267
def snapshot(self, revision, path, previous_entries, work_tree,
269
"""Make a snapshot of this entry which may or may not have changed.
271
This means that all its fields are populated, that it has its
272
text stored in the text store or weave.
274
mutter('new parents of %s are %r', path, previous_entries)
275
self._read_tree_state(path, work_tree)
276
if len(previous_entries) == 1:
277
# cannot be unchanged unless there is only one parent file rev.
278
parent_ie = previous_entries.values()[0]
279
if self._unchanged(path, parent_ie, work_tree):
280
mutter("found unchanged entry")
281
self.revision = parent_ie.revision
283
return self.snapshot_revision(revision, previous_entries,
284
work_tree, weave_store)
286
def snapshot_revision(self, revision, previous_entries, work_tree,
288
"""Record this revision unconditionally."""
289
mutter('new revision for {%s}', self.file_id)
290
self.revision = revision
291
change = self._get_snapshot_change(previous_entries)
294
def _snapshot_text(self, file_parents, work_tree, weave_store):
295
mutter('storing file {%s} in revision {%s}',
296
self.file_id, self.revision)
297
# special case to avoid diffing on renames or
299
if (len(file_parents) == 1
300
and self.text_sha1 == file_parents.values()[0].text_sha1
301
and self.text_size == file_parents.values()[0].text_size):
302
previous_ie = file_parents.values()[0]
303
weave_store.add_identical_text(
304
self.file_id, previous_ie.revision,
305
self.revision, file_parents)
307
new_lines = work_tree.get_file(self.file_id).readlines()
308
self._add_text_to_weave(new_lines, file_parents, weave_store)
309
self.text_sha1 = sha_strings(new_lines)
310
self.text_size = sum(map(len, new_lines))
183
312
def __eq__(self, other):
184
313
if not isinstance(other, InventoryEntry):
185
314
return NotImplemented
187
return (self.file_id == other.file_id) \
188
and (self.name == other.name) \
189
and (self.text_sha1 == other.text_sha1) \
190
and (self.text_size == other.text_size) \
191
and (self.text_id == other.text_id) \
192
and (self.parent_id == other.parent_id) \
193
and (self.kind == other.kind) \
194
and (self.text_version == other.text_version) \
195
and (self.entry_version == other.entry_version)
316
return ((self.file_id == other.file_id)
317
and (self.name == other.name)
318
and (other.symlink_target == self.symlink_target)
319
and (self.text_sha1 == other.text_sha1)
320
and (self.text_size == other.text_size)
321
and (self.text_id == other.text_id)
322
and (self.parent_id == other.parent_id)
323
and (self.kind == other.kind)
324
and (self.revision == other.revision)
325
and (self.executable == other.executable)
198
328
def __ne__(self, other):
199
329
return not (self == other)
219
373
and (self.children == other.children)
376
class InventoryDirectory(InventoryEntry):
377
"""A directory in an inventory."""
379
def _check(self, checker, rev_id, tree):
380
"""See InventoryEntry._check"""
381
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
382
raise BzrCheckError('directory {%s} has text in revision {%s}'
383
% (self.file_id, rev_id))
386
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
387
other.revision = self.revision
388
# note that children are *not* copied; they're pulled across when
392
def __init__(self, file_id, name, parent_id):
393
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
395
self.kind = 'directory'
397
def kind_character(self):
398
"""See InventoryEntry.kind_character."""
401
def _put_in_tar(self, item, tree):
402
"""See InventoryEntry._put_in_tar."""
403
item.type = tarfile.DIRTYPE
410
def _put_on_disk(self, fullpath, tree):
411
"""See InventoryEntry._put_on_disk."""
415
class InventoryFile(InventoryEntry):
416
"""A file in an inventory."""
418
def _check(self, checker, rev_id, tree):
419
"""See InventoryEntry._check"""
420
revision = self.revision
421
t = (self.file_id, revision)
422
if t in checker.checked_texts:
423
prev_sha = checker.checked_texts[t]
424
if prev_sha != self.text_sha1:
425
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
426
(self.file_id, rev_id))
428
checker.repeated_text_cnt += 1
430
mutter('check version {%s} of {%s}', rev_id, self.file_id)
431
file_lines = tree.get_file_lines(self.file_id)
432
checker.checked_text_cnt += 1
433
if self.text_size != sum(map(len, file_lines)):
434
raise BzrCheckError('text {%s} wrong size' % self.text_id)
435
if self.text_sha1 != sha_strings(file_lines):
436
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
437
checker.checked_texts[t] = self.text_sha1
440
other = InventoryFile(self.file_id, self.name, self.parent_id)
441
other.executable = self.executable
442
other.text_id = self.text_id
443
other.text_sha1 = self.text_sha1
444
other.text_size = self.text_size
445
other.revision = self.revision
448
def detect_changes(self, old_entry):
449
"""See InventoryEntry.detect_changes."""
450
assert self.text_sha1 != None
451
assert old_entry.text_sha1 != None
452
text_modified = (self.text_sha1 != old_entry.text_sha1)
453
meta_modified = (self.executable != old_entry.executable)
454
return text_modified, meta_modified
456
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
457
output_to, reverse=False):
458
"""See InventoryEntry._diff."""
459
from_text = tree.get_file(self.file_id).readlines()
461
to_text = to_tree.get_file(to_entry.file_id).readlines()
465
text_diff(from_label, from_text,
466
to_label, to_text, output_to)
468
text_diff(to_label, to_text,
469
from_label, from_text, output_to)
472
"""See InventoryEntry.has_text."""
475
def __init__(self, file_id, name, parent_id):
476
super(InventoryFile, self).__init__(file_id, name, parent_id)
479
def kind_character(self):
480
"""See InventoryEntry.kind_character."""
483
def _put_in_tar(self, item, tree):
484
"""See InventoryEntry._put_in_tar."""
485
item.type = tarfile.REGTYPE
486
fileobj = tree.get_file(self.file_id)
487
item.size = self.text_size
488
if tree.is_executable(self.file_id):
494
def _put_on_disk(self, fullpath, tree):
495
"""See InventoryEntry._put_on_disk."""
496
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
497
if tree.is_executable(self.file_id):
498
os.chmod(fullpath, 0755)
500
def _read_tree_state(self, path, work_tree):
501
"""See InventoryEntry._read_tree_state."""
502
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
503
self.executable = work_tree.is_executable(self.file_id)
505
def snapshot_revision(self, revision, previous_entries, work_tree,
507
"""See InventoryEntry.snapshot_revision."""
508
change = super(InventoryFile, self).snapshot_revision(revision,
509
previous_entries, work_tree, weave_store)
510
self._snapshot_text(previous_entries, work_tree, weave_store)
513
def _unchanged(self, path, previous_ie, work_tree):
514
"""See InventoryEntry._unchanged."""
515
compatible = super(InventoryFile, self)._unchanged(path, previous_ie,
517
if self.text_sha1 != previous_ie.text_sha1:
520
# FIXME: 20050930 probe for the text size when getting sha1
521
# in _read_tree_state
522
self.text_size = previous_ie.text_size
526
class InventoryLink(InventoryEntry):
527
"""A file in an inventory."""
529
__slots__ = ['symlink_target']
531
def _check(self, checker, rev_id, tree):
532
"""See InventoryEntry._check"""
533
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
534
raise BzrCheckError('symlink {%s} has text in revision {%s}'
535
% (self.file_id, rev_id))
536
if self.symlink_target == None:
537
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
538
% (self.file_id, rev_id))
541
other = InventoryLink(self.file_id, self.name, self.parent_id)
542
other.symlink_target = self.symlink_target
543
other.revision = self.revision
546
def detect_changes(self, old_entry):
547
"""See InventoryEntry.detect_changes."""
548
# FIXME: which _modified field should we use ? RBC 20051003
549
text_modified = (self.symlink_target != old_entry.symlink_target)
551
mutter(" symlink target changed")
552
meta_modified = False
553
return text_modified, meta_modified
555
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
556
output_to, reverse=False):
557
"""See InventoryEntry._diff."""
558
from_text = self.symlink_target
559
if to_entry is not None:
560
to_text = to_entry.symlink_target
565
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
568
print >>output_to, '=== target was %r' % self.symlink_target
570
print >>output_to, '=== target is %r' % self.symlink_target
572
def __init__(self, file_id, name, parent_id):
573
super(InventoryLink, self).__init__(file_id, name, parent_id)
574
self.kind = 'symlink'
576
def kind_character(self):
577
"""See InventoryEntry.kind_character."""
580
def _put_in_tar(self, item, tree):
581
"""See InventoryEntry._put_in_tar."""
582
iterm.type = tarfile.SYMTYPE
586
item.linkname = self.symlink_target
589
def _put_on_disk(self, fullpath, tree):
590
"""See InventoryEntry._put_on_disk."""
592
os.symlink(self.symlink_target, fullpath)
594
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
596
def _read_tree_state(self, path, work_tree):
597
"""See InventoryEntry._read_tree_state."""
598
self.symlink_target = work_tree.get_symlink_target(self.file_id)
600
def _unchanged(self, path, previous_ie, work_tree):
601
"""See InventoryEntry._unchanged."""
602
compatible = super(InventoryLink, self)._unchanged(path, previous_ie,
604
if self.symlink_target != previous_ie.symlink_target:
223
609
class Inventory(object):
224
610
"""Inventory of versioned files in a tree.