82
66
size in bytes of the text of the file
69
the revision_id in which the text of this file was introduced
84
71
(reading a version 4 tree created a text_id field.)
86
73
>>> i = Inventory()
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)
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])
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')
80
>>> for j in i.iter_entries():
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))
100
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
101
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
102
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
103
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
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'))
86
Traceback (most recent call last):
88
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')
104
93
>>> i.path2id('src/wibble')
108
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
109
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
97
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
111
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
112
>>> for path, entry in i.iter_entries():
114
... assert i.path2id(path)
100
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
>>> for j in i.iter_entries():
103
... assert i.path2id(j[0])
122
110
>>> i.id2path('2326')
123
111
'src/wibble/wibble.c'
126
# Constants returned by describe_change()
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
# generate them just for one file at a time.
132
MODIFIED_AND_RENAMED = 'modified and renamed'
136
def detect_changes(self, old_entry):
137
"""Return a (text_modified, meta_modified) from this to old_entry.
139
_read_tree_state must have been called on self and old_entry prior to
140
calling detect_changes.
144
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
output_to, reverse=False):
146
"""Perform a diff from this to to_entry.
148
text_diff will be used for textual difference calculation.
149
This is a template method, override _diff in child classes.
151
self._read_tree_state(tree.id2path(self.file_id), tree)
153
# cannot diff from one kind to another - you must do a removal
154
# and an addif they do not match.
155
assert self.kind == to_entry.kind
156
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
158
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
161
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
162
output_to, reverse=False):
163
"""Perform a diff between two entries of the same kind."""
165
def find_previous_heads(self, previous_inventories,
166
versioned_file_store,
169
"""Return the revisions and entries that directly precede this.
171
Returned as a map from revision to inventory entry.
173
This is a map containing the file revisions in all parents
174
for which the file exists, and its revision is not a parent of
175
any other. If the file is new, the set will be empty.
177
:param versioned_file_store: A store where ancestry data on this
178
file id can be queried.
179
:param transaction: The transaction that queries to the versioned
180
file store should be completed under.
181
:param entry_vf: The entry versioned file, if its already available.
183
def get_ancestors(weave, entry):
184
return set(weave.get_ancestry(entry.revision, topo_sorted=False))
185
# revision:ie mapping for each ie found in previous_inventories.
187
# revision:ie mapping with one revision for each head.
189
# revision: ancestor list for each head
191
# identify candidate head revision ids.
192
for inv in previous_inventories:
193
if self.file_id in inv:
194
ie = inv[self.file_id]
195
assert ie.file_id == self.file_id
196
if ie.kind != self.kind:
197
# Can't be a candidate if the kind has changed.
199
if ie.revision in candidates:
200
# same revision value in two different inventories:
201
# correct possible inconsistencies:
202
# * there was a bug in revision updates with 'x' bit
205
if candidates[ie.revision].executable != ie.executable:
206
candidates[ie.revision].executable = False
207
ie.executable = False
208
except AttributeError:
210
# must now be the same.
211
assert candidates[ie.revision] == ie
213
# add this revision as a candidate.
214
candidates[ie.revision] = ie
216
# common case optimisation
217
if len(candidates) == 1:
218
# if there is only one candidate revision found
219
# then we can opening the versioned file to access ancestry:
220
# there cannot be any ancestors to eliminate when there is
221
# only one revision available.
222
heads[ie.revision] = ie
225
# eliminate ancestors amongst the available candidates:
226
# heads are those that are not an ancestor of any other candidate
227
# - this provides convergence at a per-file level.
228
for ie in candidates.values():
229
# may be an ancestor of a known head:
230
already_present = 0 != len(
231
[head for head in heads
232
if ie.revision in head_ancestors[head]])
234
# an ancestor of an analyzed candidate.
236
# not an ancestor of a known head:
237
# load the versioned file for this file id if needed
239
entry_vf = versioned_file_store.get_weave_or_empty(
240
self.file_id, transaction)
241
ancestors = get_ancestors(entry_vf, ie)
242
# may knock something else out:
243
check_heads = list(heads.keys())
244
for head in check_heads:
245
if head in ancestors:
246
# this previously discovered 'head' is not
247
# really a head - its an ancestor of the newly
250
head_ancestors[ie.revision] = ancestors
251
heads[ie.revision] = ie
254
def get_tar_item(self, root, dp, now, tree):
255
"""Get a tarfile item and a file stream for its content."""
256
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
257
# TODO: would be cool to actually set it to the timestamp of the
258
# revision it was last changed
260
fileobj = self._put_in_tar(item, tree)
264
"""Return true if the object this entry represents has textual data.
266
Note that textual data includes binary content.
268
Also note that all entries get weave files created for them.
269
This attribute is primarily used when upgrading from old trees that
270
did not have the weave index for all inventory entries.
274
def __init__(self, file_id, name, parent_id, text_id=None):
114
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
'text_id', 'parent_id', 'children',
116
'text_version', 'name_version', ]
119
def __init__(self, file_id, name, kind, parent_id, text_id=None):
275
120
"""Create an InventoryEntry
277
122
The filename must be a single component, relative to the
278
123
parent directory; it cannot be a whole path or relative name.
280
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
125
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
285
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
130
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
286
131
Traceback (most recent call last):
287
InvalidEntryName: Invalid entry name: src/hello.c
132
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
289
134
assert isinstance(name, basestring), name
290
135
if '/' in name or '\\' in name:
291
raise errors.InvalidEntryName(name=name)
292
self.executable = False
136
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
138
self.text_version = None
139
self.name_version = None
294
140
self.text_sha1 = None
295
141
self.text_size = None
296
142
self.file_id = file_id
297
assert isinstance(file_id, (str, None.__class__)), \
298
'bad type %r for %r' % (type(file_id), file_id)
300
145
self.text_id = text_id
301
146
self.parent_id = parent_id
302
self.symlink_target = None
303
self.reference_revision = None
305
def kind_character(self):
306
"""Return a short kind indicator useful for appending to names."""
307
raise BzrError('unknown kind %r' % self.kind)
309
known_kinds = ('file', 'directory', 'symlink')
311
def _put_in_tar(self, item, tree):
312
"""populate item for stashing in a tar, and return the content stream.
314
If no content is available, return None.
316
raise BzrError("don't know how to export {%s} of kind %r" %
317
(self.file_id, self.kind))
319
def put_on_disk(self, dest, dp, tree):
320
"""Create a representation of self on disk in the prefix dest.
322
This is a template method - implement _put_on_disk in subclasses.
324
fullpath = osutils.pathjoin(dest, dp)
325
self._put_on_disk(fullpath, tree)
326
# mutter(" export {%s} kind %s to %s", self.file_id,
327
# self.kind, fullpath)
329
def _put_on_disk(self, fullpath, tree):
330
"""Put this entry onto disk at fullpath, from tree tree."""
331
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
147
if kind == 'directory':
152
raise BzrError("unhandled entry kind %r" % kind)
333
156
def sorted_children(self):
334
return sorted(self.children.items())
337
def versionable_kind(kind):
338
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
340
def check(self, checker, rev_id, inv, tree):
341
"""Check this inventory entry is intact.
343
This is a template method, override _check for kind specific
346
:param checker: Check object providing context for the checks;
347
can be used to find out what parts of the repository have already
349
:param rev_id: Revision id from which this InventoryEntry was loaded.
350
Not necessarily the last-changed revision for this file.
351
:param inv: Inventory from which the entry was loaded.
352
:param tree: RevisionTree for this entry.
354
if self.parent_id is not None:
355
if not inv.has_id(self.parent_id):
356
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
357
% (self.parent_id, rev_id))
358
self._check(checker, rev_id, tree)
360
def _check(self, checker, rev_id, tree):
361
"""Check this inventory entry for kind specific errors."""
362
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
157
l = self.children.items()
366
"""Clone this inventory entry."""
367
raise NotImplementedError
370
def describe_change(old_entry, new_entry):
371
"""Describe the change between old_entry and this.
373
This smells of being an InterInventoryEntry situation, but as its
374
the first one, we're making it a static method for now.
376
An entry with a different parent, or different name is considered
377
to be renamed. Reparenting is an internal detail.
378
Note that renaming the parent does not trigger a rename for the
381
# TODO: Perhaps return an object rather than just a string
382
if old_entry is new_entry:
383
# also the case of both being None
385
elif old_entry is None:
387
elif new_entry is None:
389
if old_entry.kind != new_entry.kind:
391
text_modified, meta_modified = new_entry.detect_changes(old_entry)
392
if text_modified or meta_modified:
396
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
397
if old_entry.parent_id != new_entry.parent_id:
399
elif old_entry.name != new_entry.name:
403
if renamed and not modified:
404
return InventoryEntry.RENAMED
405
if modified and not renamed:
407
if modified and renamed:
408
return InventoryEntry.MODIFIED_AND_RENAMED
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
other.name_version = self.name_version
170
# note that children are *not* copied; they're pulled across when
411
175
def __repr__(self):
412
return ("%s(%r, %r, parent_id=%r, revision=%r)"
176
return ("%s(%r, %r, kind=%r, parent_id=%r)"
413
177
% (self.__class__.__name__,
419
def snapshot(self, revision, path, previous_entries,
420
work_tree, commit_builder):
421
"""Make a snapshot of this entry which may or may not have changed.
423
This means that all its fields are populated, that it has its
424
text stored in the text store or weave.
426
# mutter('new parents of %s are %r', path, previous_entries)
427
self._read_tree_state(path, work_tree)
428
# TODO: Where should we determine whether to reuse a
429
# previous revision id or create a new revision? 20060606
430
if len(previous_entries) == 1:
431
# cannot be unchanged unless there is only one parent file rev.
432
parent_ie = previous_entries.values()[0]
433
if self._unchanged(parent_ie):
434
# mutter("found unchanged entry")
435
self.revision = parent_ie.revision
437
return self._snapshot_into_revision(revision, previous_entries,
438
work_tree, commit_builder)
440
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
442
"""Record this revision unconditionally into a store.
444
The entry's last-changed revision property (`revision`) is updated to
445
that of the new revision.
447
:param revision: id of the new revision that is being recorded.
449
:returns: String description of the commit (e.g. "merged", "modified"), etc.
451
# mutter('new revision {%s} for {%s}', revision, self.file_id)
452
self.revision = revision
453
self._snapshot_text(previous_entries, work_tree, commit_builder)
455
def _snapshot_text(self, file_parents, work_tree, commit_builder):
456
"""Record the 'text' of this entry, whatever form that takes.
458
This default implementation simply adds an empty text.
460
raise NotImplementedError(self._snapshot_text)
462
184
def __eq__(self, other):
463
185
if not isinstance(other, InventoryEntry):
464
186
return NotImplemented
466
return ((self.file_id == other.file_id)
467
and (self.name == other.name)
468
and (other.symlink_target == self.symlink_target)
469
and (self.text_sha1 == other.text_sha1)
470
and (self.text_size == other.text_size)
471
and (self.text_id == other.text_id)
472
and (self.parent_id == other.parent_id)
473
and (self.kind == other.kind)
474
and (self.revision == other.revision)
475
and (self.executable == other.executable)
476
and (self.reference_revision == other.reference_revision)
188
return (self.file_id == other.file_id) \
189
and (self.name == other.name) \
190
and (self.text_sha1 == other.text_sha1) \
191
and (self.text_size == other.text_size) \
192
and (self.text_id == other.text_id) \
193
and (self.parent_id == other.parent_id) \
194
and (self.kind == other.kind) \
195
and (self.text_version == other.text_version) \
196
and (self.name_version == other.name_version)
479
199
def __ne__(self, other):
480
200
return not (self == other)
541
220
and (self.children == other.children)
544
class InventoryDirectory(InventoryEntry):
545
"""A directory in an inventory."""
547
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
548
'text_id', 'parent_id', 'children', 'executable',
549
'revision', 'symlink_target', 'reference_revision']
551
def _check(self, checker, rev_id, tree):
552
"""See InventoryEntry._check"""
553
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
554
raise BzrCheckError('directory {%s} has text in revision {%s}'
555
% (self.file_id, rev_id))
558
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
559
other.revision = self.revision
560
# note that children are *not* copied; they're pulled across when
564
def __init__(self, file_id, name, parent_id):
565
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
567
self.kind = 'directory'
569
def kind_character(self):
570
"""See InventoryEntry.kind_character."""
573
def _put_in_tar(self, item, tree):
574
"""See InventoryEntry._put_in_tar."""
575
item.type = tarfile.DIRTYPE
582
def _put_on_disk(self, fullpath, tree):
583
"""See InventoryEntry._put_on_disk."""
586
def _snapshot_text(self, file_parents, work_tree, commit_builder):
587
"""See InventoryEntry._snapshot_text."""
588
commit_builder.modified_directory(self.file_id, file_parents)
591
class InventoryFile(InventoryEntry):
592
"""A file in an inventory."""
594
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
595
'text_id', 'parent_id', 'children', 'executable',
596
'revision', 'symlink_target', 'reference_revision']
598
def _check(self, checker, tree_revision_id, tree):
599
"""See InventoryEntry._check"""
600
t = (self.file_id, self.revision)
601
if t in checker.checked_texts:
602
prev_sha = checker.checked_texts[t]
603
if prev_sha != self.text_sha1:
604
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
605
(self.file_id, tree_revision_id))
607
checker.repeated_text_cnt += 1
610
if self.file_id not in checker.checked_weaves:
611
mutter('check weave {%s}', self.file_id)
612
w = tree.get_weave(self.file_id)
613
# Not passing a progress bar, because it creates a new
614
# progress, which overwrites the current progress,
615
# and doesn't look nice
617
checker.checked_weaves[self.file_id] = True
619
w = tree.get_weave(self.file_id)
621
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
622
checker.checked_text_cnt += 1
623
# We can't check the length, because Weave doesn't store that
624
# information, and the whole point of looking at the weave's
625
# sha1sum is that we don't have to extract the text.
626
if self.text_sha1 != w.get_sha1(self.revision):
627
raise BzrCheckError('text {%s} version {%s} wrong sha1'
628
% (self.file_id, self.revision))
629
checker.checked_texts[t] = self.text_sha1
632
other = InventoryFile(self.file_id, self.name, self.parent_id)
633
other.executable = self.executable
634
other.text_id = self.text_id
635
other.text_sha1 = self.text_sha1
636
other.text_size = self.text_size
637
other.revision = self.revision
640
def detect_changes(self, old_entry):
641
"""See InventoryEntry.detect_changes."""
642
assert self.text_sha1 is not None
643
assert old_entry.text_sha1 is not None
644
text_modified = (self.text_sha1 != old_entry.text_sha1)
645
meta_modified = (self.executable != old_entry.executable)
646
return text_modified, meta_modified
648
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
649
output_to, reverse=False):
650
"""See InventoryEntry._diff."""
652
from_text = tree.get_file(self.file_id).readlines()
654
to_text = to_tree.get_file(to_entry.file_id).readlines()
658
text_diff(from_label, from_text,
659
to_label, to_text, output_to)
661
text_diff(to_label, to_text,
662
from_label, from_text, output_to)
663
except errors.BinaryFile:
665
label_pair = (to_label, from_label)
667
label_pair = (from_label, to_label)
668
print >> output_to, "Binary files %s and %s differ" % label_pair
671
"""See InventoryEntry.has_text."""
674
def __init__(self, file_id, name, parent_id):
675
super(InventoryFile, self).__init__(file_id, name, parent_id)
678
def kind_character(self):
679
"""See InventoryEntry.kind_character."""
682
def _put_in_tar(self, item, tree):
683
"""See InventoryEntry._put_in_tar."""
684
item.type = tarfile.REGTYPE
685
fileobj = tree.get_file(self.file_id)
686
item.size = self.text_size
687
if tree.is_executable(self.file_id):
693
def _put_on_disk(self, fullpath, tree):
694
"""See InventoryEntry._put_on_disk."""
695
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
696
if tree.is_executable(self.file_id):
697
os.chmod(fullpath, 0755)
699
def _read_tree_state(self, path, work_tree):
700
"""See InventoryEntry._read_tree_state."""
701
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
702
# FIXME: 20050930 probe for the text size when getting sha1
703
# in _read_tree_state
704
self.executable = work_tree.is_executable(self.file_id, path=path)
707
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
708
% (self.__class__.__name__,
715
def _forget_tree_state(self):
716
self.text_sha1 = None
718
def _snapshot_text(self, file_parents, work_tree, commit_builder):
719
"""See InventoryEntry._snapshot_text."""
720
def get_content_byte_lines():
721
return work_tree.get_file(self.file_id).readlines()
722
self.text_sha1, self.text_size = commit_builder.modified_file_text(
723
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
725
def _unchanged(self, previous_ie):
726
"""See InventoryEntry._unchanged."""
727
compatible = super(InventoryFile, self)._unchanged(previous_ie)
728
if self.text_sha1 != previous_ie.text_sha1:
731
# FIXME: 20050930 probe for the text size when getting sha1
732
# in _read_tree_state
733
self.text_size = previous_ie.text_size
734
if self.executable != previous_ie.executable:
739
class InventoryLink(InventoryEntry):
740
"""A file in an inventory."""
742
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
743
'text_id', 'parent_id', 'children', 'executable',
744
'revision', 'symlink_target', 'reference_revision']
746
def _check(self, checker, rev_id, tree):
747
"""See InventoryEntry._check"""
748
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
749
raise BzrCheckError('symlink {%s} has text in revision {%s}'
750
% (self.file_id, rev_id))
751
if self.symlink_target is None:
752
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
753
% (self.file_id, rev_id))
756
other = InventoryLink(self.file_id, self.name, self.parent_id)
757
other.symlink_target = self.symlink_target
758
other.revision = self.revision
761
def detect_changes(self, old_entry):
762
"""See InventoryEntry.detect_changes."""
763
# FIXME: which _modified field should we use ? RBC 20051003
764
text_modified = (self.symlink_target != old_entry.symlink_target)
766
mutter(" symlink target changed")
767
meta_modified = False
768
return text_modified, meta_modified
770
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
771
output_to, reverse=False):
772
"""See InventoryEntry._diff."""
773
from_text = self.symlink_target
774
if to_entry is not None:
775
to_text = to_entry.symlink_target
780
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
783
print >>output_to, '=== target was %r' % self.symlink_target
785
print >>output_to, '=== target is %r' % self.symlink_target
787
def __init__(self, file_id, name, parent_id):
788
super(InventoryLink, self).__init__(file_id, name, parent_id)
789
self.kind = 'symlink'
791
def kind_character(self):
792
"""See InventoryEntry.kind_character."""
795
def _put_in_tar(self, item, tree):
796
"""See InventoryEntry._put_in_tar."""
797
item.type = tarfile.SYMTYPE
801
item.linkname = self.symlink_target
804
def _put_on_disk(self, fullpath, tree):
805
"""See InventoryEntry._put_on_disk."""
807
os.symlink(self.symlink_target, fullpath)
809
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
811
def _read_tree_state(self, path, work_tree):
812
"""See InventoryEntry._read_tree_state."""
813
self.symlink_target = work_tree.get_symlink_target(self.file_id)
815
def _forget_tree_state(self):
816
self.symlink_target = None
818
def _unchanged(self, previous_ie):
819
"""See InventoryEntry._unchanged."""
820
compatible = super(InventoryLink, self)._unchanged(previous_ie)
821
if self.symlink_target != previous_ie.symlink_target:
825
def _snapshot_text(self, file_parents, work_tree, commit_builder):
826
"""See InventoryEntry._snapshot_text."""
827
commit_builder.modified_link(
828
self.file_id, file_parents, self.symlink_target)
831
class TreeReference(InventoryEntry):
833
kind = 'tree-reference'
835
def __init__(self, file_id, name, parent_id, revision=None,
836
reference_revision=None):
837
InventoryEntry.__init__(self, file_id, name, parent_id)
838
self.revision = revision
839
self.reference_revision = reference_revision
842
return TreeReference(self.file_id, self.name, self.parent_id,
843
self.revision, self.reference_revision)
845
def _snapshot_text(self, file_parents, work_tree, commit_builder):
846
commit_builder.modified_reference(self.file_id, file_parents)
848
def _read_tree_state(self, path, work_tree):
849
"""Populate fields in the inventory entry from the given tree.
851
self.reference_revision = work_tree.get_reference_revision(
854
def _forget_tree_state(self):
855
self.reference_revision = None
858
224
class Inventory(object):
859
225
"""Inventory of versioned files in a tree.
906
269
The inventory is created with a default root directory, with
909
if root_id is not None:
910
assert root_id.__class__ == str
911
self._set_root(InventoryDirectory(root_id, u'', None))
915
self.revision_id = revision_id
917
def _set_root(self, ie):
272
# We are letting Branch(init=True) create a unique inventory
273
# root id. Rather than generating a random one here.
275
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
276
self.root = RootEntry(root_id)
919
277
self._byid = {self.root.file_id: self.root}
922
# TODO: jam 20051218 Should copy also copy the revision_id?
923
entries = self.iter_entries()
924
other = Inventory(entries.next()[1].file_id)
281
other = Inventory(self.root.file_id)
925
282
# copy recursively so we know directories will be added before
926
283
# their children. There are more efficient ways than this...
927
for path, entry in entries():
284
for path, entry in self.iter_entries():
285
if entry == self.root:
928
287
other.add(entry.copy())
931
291
def __iter__(self):
932
292
return iter(self._byid)
934
295
def __len__(self):
935
296
"""Returns number of entries."""
936
297
return len(self._byid)
938
300
def iter_entries(self, from_dir=None):
939
301
"""Return (path, entry) pairs, in order by name."""
941
if self.root is None:
945
elif isinstance(from_dir, basestring):
946
from_dir = self._byid[from_dir]
948
# unrolling the recursive called changed the time from
949
# 440ms/663ms (inline/total) to 116ms/116ms
950
children = from_dir.children.items()
952
children = collections.deque(children)
953
stack = [(u'', children)]
955
from_dir_relpath, children = stack[-1]
958
name, ie = children.popleft()
960
# we know that from_dir_relpath never ends in a slash
961
# and 'f' doesn't begin with one, we can do a string op, rather
962
# than the checks of pathjoin(), though this means that all paths
964
path = from_dir_relpath + '/' + name
968
if ie.kind != 'directory':
971
# But do this child first
972
new_children = ie.children.items()
974
new_children = collections.deque(new_children)
975
stack.append((path, new_children))
976
# Break out of inner loop, so that we start outer loop with child
979
# if we finished all children, pop it off the stack
982
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
983
"""Iterate over the entries in a directory first order.
985
This returns all entries for a directory before returning
986
the entries for children of a directory. This is not
987
lexicographically sorted order, and is a hybrid between
988
depth-first and breadth-first.
990
:return: This yields (path, entry) pairs
992
if specific_file_ids:
993
safe = osutils.safe_file_id
994
specific_file_ids = set(safe(fid) for fid in specific_file_ids)
995
# TODO? Perhaps this should return the from_dir so that the root is
996
# yielded? or maybe an option?
998
if self.root is None:
1000
# Optimize a common case
1001
if specific_file_ids is not None and len(specific_file_ids) == 1:
1002
file_id = list(specific_file_ids)[0]
1004
yield self.id2path(file_id), self[file_id]
1006
from_dir = self.root
1007
if (specific_file_ids is None or
1008
self.root.file_id in specific_file_ids):
1009
yield u'', self.root
1010
elif isinstance(from_dir, basestring):
1011
from_dir = self._byid[from_dir]
1013
if specific_file_ids is not None:
1014
# TODO: jam 20070302 This could really be done as a loop rather
1015
# than a bunch of recursive calls.
1018
def add_ancestors(file_id):
1019
if file_id not in byid:
1021
parent_id = byid[file_id].parent_id
1022
if parent_id is None:
1024
if parent_id not in parents:
1025
parents.add(parent_id)
1026
add_ancestors(parent_id)
1027
for file_id in specific_file_ids:
1028
add_ancestors(file_id)
1032
stack = [(u'', from_dir)]
1034
cur_relpath, cur_dir = stack.pop()
1037
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
1039
child_relpath = cur_relpath + child_name
1041
if (specific_file_ids is None or
1042
child_ie.file_id in specific_file_ids):
1043
yield child_relpath, child_ie
1045
if child_ie.kind == 'directory':
1046
if parents is None or child_ie.file_id in parents:
1047
child_dirs.append((child_relpath+'/', child_ie))
1048
stack.extend(reversed(child_dirs))
305
elif isinstance(from_dir, basestring):
306
from_dir = self._byid[from_dir]
308
kids = from_dir.children.items()
310
for name, ie in kids:
312
if ie.kind == 'directory':
313
for cn, cie in self.iter_entries(from_dir=ie.file_id):
314
yield os.path.join(name, cn), cie
1050
317
def entries(self):
1051
318
"""Return list of (path, ie) for all entries except the root.
1138
399
Returns the new entry object.
1140
401
if entry.file_id in self._byid:
1141
raise errors.DuplicateFileId(entry.file_id,
1142
self._byid[entry.file_id])
1144
if entry.parent_id is None:
1145
assert self.root is None and len(self._byid) == 0
1149
parent = self._byid[entry.parent_id]
1151
raise BzrError("parent_id {%s} not in inventory" %
1154
if entry.name in parent.children:
1155
raise BzrError("%s is already versioned" %
1156
osutils.pathjoin(self.id2path(parent.file_id),
1157
entry.name).encode('utf-8'))
1158
parent.children[entry.name] = entry
1159
return self._add_child(entry)
1161
def add_path(self, relpath, kind, file_id=None, parent_id=None):
402
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
404
if entry.parent_id == ROOT_ID or entry.parent_id is None:
405
entry.parent_id = self.root.file_id
408
parent = self._byid[entry.parent_id]
410
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
412
if parent.children.has_key(entry.name):
413
raise BzrError("%s is already versioned" %
414
appendpath(self.id2path(parent.file_id), entry.name))
416
self._byid[entry.file_id] = entry
417
parent.children[entry.name] = entry
421
def add_path(self, relpath, kind, file_id=None):
1162
422
"""Add entry from a path.
1164
424
The immediate parent must already be versioned.
1166
426
Returns the new entry object."""
427
from bzrlib.branch import gen_file_id
1168
parts = osutils.splitpath(relpath)
429
parts = bzrlib.osutils.splitpath(relpath)
1170
430
if len(parts) == 0:
1172
file_id = generate_ids.gen_root_id()
1174
file_id = osutils.safe_file_id(file_id)
1175
self.root = InventoryDirectory(file_id, '', None)
1176
self._byid = {self.root.file_id: self.root}
1179
parent_path = parts[:-1]
1180
parent_id = self.path2id(parent_path)
1181
if parent_id is None:
1182
raise errors.NotVersionedError(path=parent_path)
1183
ie = make_entry(kind, parts[-1], parent_id, file_id)
431
raise BzrError("cannot re-add root of inventory")
434
file_id = gen_file_id(relpath)
436
parent_path = parts[:-1]
437
parent_id = self.path2id(parent_path)
438
if parent_id == None:
439
raise NotVersionedError(parent_path)
441
ie = InventoryEntry(file_id, parts[-1],
442
kind=kind, parent_id=parent_id)
1184
443
return self.add(ie)
1186
446
def __delitem__(self, file_id):
1187
447
"""Remove entry by id.
1189
449
>>> inv = Inventory()
1190
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1191
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
450
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
451
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
1192
452
>>> '123' in inv
1194
454
>>> del inv['123']
1195
455
>>> '123' in inv
1198
file_id = osutils.safe_file_id(file_id)
1199
458
ie = self[file_id]
1201
assert ie.parent_id is None or \
1202
self[ie.parent_id].children[ie.name] == ie
460
assert self[ie.parent_id].children[ie.name] == ie
462
# TODO: Test deleting all children; maybe hoist to a separate
464
if ie.kind == 'directory':
465
for cie in ie.children.values():
466
del self[cie.file_id]
1204
469
del self._byid[file_id]
1205
if ie.parent_id is not None:
1206
del self[ie.parent_id].children[ie.name]
470
del self[ie.parent_id].children[ie.name]
1208
473
def __eq__(self, other):
1209
474
"""Compare two sets by comparing their contents.
added
removed
bzrlib/inventory.py
