36
50
An InventoryEntry has the following fields, which are also
37
51
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.
56
(within the parent directory)
59
file_id of the parent directory, or ROOT_ID
62
the revision_id in which this variation of this file was
66
Indicates that this file should be executable on systems
70
sha-1 of the text of the file
73
size in bytes of the text of the file
75
(reading a version 4 tree created a text_id field.)
54
77
>>> 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():
80
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
81
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
82
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
83
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
84
>>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
85
>>> for ix, j in enumerate(i.iter_entries()):
86
... print (j[0] == shouldbe[ix], j[1])
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'))
88
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
89
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
90
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
65
91
Traceback (most recent call last):
67
93
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'))
94
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
95
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
96
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
97
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
70
98
>>> i.path2id('src/wibble')
74
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
102
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
103
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
76
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
>>> for j in i.iter_entries():
79
... assert i.path2id(j[0])
105
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
106
>>> for path, entry in i.iter_entries():
108
... assert i.path2id(path)
85
114
src/wibble/wibble.c
86
115
>>> i.id2path('2326')
87
116
'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):
119
# Constants returned by describe_change()
121
# TODO: These should probably move to some kind of FileChangeDescription
122
# class; that's like what's inside a TreeDelta but we want to be able to
123
# generate them just for one file at a time.
125
MODIFIED_AND_RENAMED = 'modified and renamed'
129
def detect_changes(self, old_entry):
130
"""Return a (text_modified, meta_modified) from this to old_entry.
132
_read_tree_state must have been called on self and old_entry prior to
133
calling detect_changes.
137
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
138
output_to, reverse=False):
139
"""Perform a diff from this to to_entry.
141
text_diff will be used for textual difference calculation.
142
This is a template method, override _diff in child classes.
144
self._read_tree_state(tree.id2path(self.file_id), tree)
146
# cannot diff from one kind to another - you must do a removal
147
# and an addif they do not match.
148
assert self.kind == to_entry.kind
149
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
151
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
154
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
155
output_to, reverse=False):
156
"""Perform a diff between two entries of the same kind."""
158
def find_previous_heads(self, previous_inventories,
159
versioned_file_store,
162
"""Return the revisions and entries that directly precede this.
164
Returned as a map from revision to inventory entry.
166
This is a map containing the file revisions in all parents
167
for which the file exists, and its revision is not a parent of
168
any other. If the file is new, the set will be empty.
170
:param versioned_file_store: A store where ancestry data on this
171
file id can be queried.
172
:param transaction: The transaction that queries to the versioned
173
file store should be completed under.
174
:param entry_vf: The entry versioned file, if its already available.
176
def get_ancestors(weave, entry):
177
return set(weave.get_ancestry(entry.revision))
178
# revision:ie mapping for each ie found in previous_inventories.
180
# revision:ie mapping with one revision for each head.
182
# revision: ancestor list for each head
184
# identify candidate head revision ids.
185
for inv in previous_inventories:
186
if self.file_id in inv:
187
ie = inv[self.file_id]
188
assert ie.file_id == self.file_id
189
if ie.revision in candidates:
190
# same revision value in two different inventories:
191
# correct possible inconsistencies:
192
# * there was a bug in revision updates with 'x' bit
195
if candidates[ie.revision].executable != ie.executable:
196
candidates[ie.revision].executable = False
197
ie.executable = False
198
except AttributeError:
200
# must now be the same.
201
assert candidates[ie.revision] == ie
203
# add this revision as a candidate.
204
candidates[ie.revision] = ie
206
# common case optimisation
207
if len(candidates) == 1:
208
# if there is only one candidate revision found
209
# then we can opening the versioned file to access ancestry:
210
# there cannot be any ancestors to eliminate when there is
211
# only one revision available.
212
heads[ie.revision] = ie
215
# eliminate ancestors amongst the available candidates:
216
# heads are those that are not an ancestor of any other candidate
217
# - this provides convergence at a per-file level.
218
for ie in candidates.values():
219
# may be an ancestor of a known head:
220
already_present = 0 != len(
221
[head for head in heads
222
if ie.revision in head_ancestors[head]])
224
# an ancestor of an analyzed candidate.
226
# not an ancestor of a known head:
227
# load the versioned file for this file id if needed
229
entry_vf = versioned_file_store.get_weave_or_empty(
230
self.file_id, transaction)
231
ancestors = get_ancestors(entry_vf, ie)
232
# may knock something else out:
233
check_heads = list(heads.keys())
234
for head in check_heads:
235
if head in ancestors:
236
# this previously discovered 'head' is not
237
# really a head - its an ancestor of the newly
240
head_ancestors[ie.revision] = ancestors
241
heads[ie.revision] = ie
244
def get_tar_item(self, root, dp, now, tree):
245
"""Get a tarfile item and a file stream for its content."""
246
item = tarfile.TarInfo(pathjoin(root, dp))
247
# TODO: would be cool to actually set it to the timestamp of the
248
# revision it was last changed
250
fileobj = self._put_in_tar(item, tree)
254
"""Return true if the object this entry represents has textual data.
256
Note that textual data includes binary content.
258
Also note that all entries get weave files created for them.
259
This attribute is primarily used when upgrading from old trees that
260
did not have the weave index for all inventory entries.
264
def __init__(self, file_id, name, parent_id, text_id=None):
101
265
"""Create an InventoryEntry
103
267
The filename must be a single component, relative to the
104
268
parent directory; it cannot be a whole path or relative name.
106
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
270
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
111
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
275
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
112
276
Traceback (most recent call last):
113
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
277
InvalidEntryName: Invalid entry name: src/hello.c
279
assert isinstance(name, basestring), name
115
280
if '/' in name or '\\' in name:
116
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
281
raise InvalidEntryName(name=name)
282
self.executable = False
118
284
self.text_sha1 = None
119
285
self.text_size = None
121
286
self.file_id = file_id
124
288
self.text_id = text_id
125
289
self.parent_id = parent_id
126
if kind == 'directory':
131
raise BzrError("unhandled entry kind %r" % kind)
290
self.symlink_target = None
292
def kind_character(self):
293
"""Return a short kind indicator useful for appending to names."""
294
raise BzrError('unknown kind %r' % self.kind)
296
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
298
def _put_in_tar(self, item, tree):
299
"""populate item for stashing in a tar, and return the content stream.
301
If no content is available, return None.
303
raise BzrError("don't know how to export {%s} of kind %r" %
304
(self.file_id, self.kind))
306
def put_on_disk(self, dest, dp, tree):
307
"""Create a representation of self on disk in the prefix dest.
309
This is a template method - implement _put_on_disk in subclasses.
311
fullpath = pathjoin(dest, dp)
312
self._put_on_disk(fullpath, tree)
313
mutter(" export {%s} kind %s to %s", self.file_id,
316
def _put_on_disk(self, fullpath, tree):
317
"""Put this entry onto disk at fullpath, from tree tree."""
318
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
135
320
def sorted_children(self):
136
l = self.children.items()
321
return sorted(self.children.items())
324
def versionable_kind(kind):
325
return kind in ('file', 'directory', 'symlink')
327
def check(self, checker, rev_id, inv, tree):
328
"""Check this inventory entry is intact.
330
This is a template method, override _check for kind specific
333
:param checker: Check object providing context for the checks;
334
can be used to find out what parts of the repository have already
336
:param rev_id: Revision id from which this InventoryEntry was loaded.
337
Not necessarily the last-changed revision for this file.
338
:param inv: Inventory from which the entry was loaded.
339
:param tree: RevisionTree for this entry.
341
if self.parent_id is not None:
342
if not inv.has_id(self.parent_id):
343
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
344
% (self.parent_id, rev_id))
345
self._check(checker, rev_id, tree)
347
def _check(self, checker, rev_id, tree):
348
"""Check this inventory entry for kind specific errors."""
349
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
353
"""Clone this inventory entry."""
354
raise NotImplementedError
357
def describe_change(old_entry, new_entry):
358
"""Describe the change between old_entry and this.
360
This smells of being an InterInventoryEntry situation, but as its
361
the first one, we're making it a static method for now.
363
An entry with a different parent, or different name is considered
364
to be renamed. Reparenting is an internal detail.
365
Note that renaming the parent does not trigger a rename for the
368
# TODO: Perhaps return an object rather than just a string
369
if old_entry is new_entry:
370
# also the case of both being None
372
elif old_entry is None:
374
elif new_entry is None:
376
text_modified, meta_modified = new_entry.detect_changes(old_entry)
377
if text_modified or meta_modified:
381
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
382
if old_entry.parent_id != new_entry.parent_id:
384
elif old_entry.name != new_entry.name:
388
if renamed and not modified:
389
return InventoryEntry.RENAMED
390
if modified and not renamed:
392
if modified and renamed:
393
return InventoryEntry.MODIFIED_AND_RENAMED
151
396
def __repr__(self):
152
return ("%s(%r, %r, kind=%r, parent_id=%r)"
397
return ("%s(%r, %r, parent_id=%r, revision=%r)"
153
398
% (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)
404
def snapshot(self, revision, path, previous_entries,
405
work_tree, commit_builder):
406
"""Make a snapshot of this entry which may or may not have changed.
408
This means that all its fields are populated, that it has its
409
text stored in the text store or weave.
411
mutter('new parents of %s are %r', path, previous_entries)
412
self._read_tree_state(path, work_tree)
413
# TODO: Where should we determine whether to reuse a
414
# previous revision id or create a new revision? 20060606
415
if len(previous_entries) == 1:
416
# cannot be unchanged unless there is only one parent file rev.
417
parent_ie = previous_entries.values()[0]
418
if self._unchanged(parent_ie):
419
mutter("found unchanged entry")
420
self.revision = parent_ie.revision
422
return self._snapshot_into_revision(revision, previous_entries,
423
work_tree, commit_builder)
425
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
427
"""Record this revision unconditionally into a store.
429
The entry's last-changed revision property (`revision`) is updated to
430
that of the new revision.
432
:param revision: id of the new revision that is being recorded.
434
:returns: String description of the commit (e.g. "merged", "modified"), etc.
436
mutter('new revision {%s} for {%s}', revision, self.file_id)
437
self.revision = revision
438
self._snapshot_text(previous_entries, work_tree, commit_builder)
440
def _snapshot_text(self, file_parents, work_tree, commit_builder):
441
"""Record the 'text' of this entry, whatever form that takes.
443
This default implementation simply adds an empty text.
445
raise NotImplementedError(self._snapshot_text)
214
447
def __eq__(self, other):
215
448
if not isinstance(other, InventoryEntry):
216
449
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)
451
return ((self.file_id == other.file_id)
452
and (self.name == other.name)
453
and (other.symlink_target == self.symlink_target)
454
and (self.text_sha1 == other.text_sha1)
455
and (self.text_size == other.text_size)
456
and (self.text_id == other.text_id)
457
and (self.parent_id == other.parent_id)
458
and (self.kind == other.kind)
459
and (self.revision == other.revision)
460
and (self.executable == other.executable)
227
463
def __ne__(self, other):
228
464
return not (self == other)
248
520
and (self.children == other.children)
523
class InventoryDirectory(InventoryEntry):
524
"""A directory in an inventory."""
526
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
527
'text_id', 'parent_id', 'children', 'executable',
528
'revision', 'symlink_target']
530
def _check(self, checker, rev_id, tree):
531
"""See InventoryEntry._check"""
532
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
533
raise BzrCheckError('directory {%s} has text in revision {%s}'
534
% (self.file_id, rev_id))
537
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
538
other.revision = self.revision
539
# note that children are *not* copied; they're pulled across when
543
def __init__(self, file_id, name, parent_id):
544
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
546
self.kind = 'directory'
548
def kind_character(self):
549
"""See InventoryEntry.kind_character."""
552
def _put_in_tar(self, item, tree):
553
"""See InventoryEntry._put_in_tar."""
554
item.type = tarfile.DIRTYPE
561
def _put_on_disk(self, fullpath, tree):
562
"""See InventoryEntry._put_on_disk."""
565
def _snapshot_text(self, file_parents, work_tree, commit_builder):
566
"""See InventoryEntry._snapshot_text."""
567
commit_builder.modified_directory(self.file_id, file_parents)
570
class InventoryFile(InventoryEntry):
571
"""A file in an inventory."""
573
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
574
'text_id', 'parent_id', 'children', 'executable',
575
'revision', 'symlink_target']
577
def _check(self, checker, tree_revision_id, tree):
578
"""See InventoryEntry._check"""
579
t = (self.file_id, self.revision)
580
if t in checker.checked_texts:
581
prev_sha = checker.checked_texts[t]
582
if prev_sha != self.text_sha1:
583
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
584
(self.file_id, tree_revision_id))
586
checker.repeated_text_cnt += 1
589
if self.file_id not in checker.checked_weaves:
590
mutter('check weave {%s}', self.file_id)
591
w = tree.get_weave(self.file_id)
592
# Not passing a progress bar, because it creates a new
593
# progress, which overwrites the current progress,
594
# and doesn't look nice
596
checker.checked_weaves[self.file_id] = True
598
w = tree.get_weave(self.file_id)
600
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
601
checker.checked_text_cnt += 1
602
# We can't check the length, because Weave doesn't store that
603
# information, and the whole point of looking at the weave's
604
# sha1sum is that we don't have to extract the text.
605
if self.text_sha1 != w.get_sha1(self.revision):
606
raise BzrCheckError('text {%s} version {%s} wrong sha1'
607
% (self.file_id, self.revision))
608
checker.checked_texts[t] = self.text_sha1
611
other = InventoryFile(self.file_id, self.name, self.parent_id)
612
other.executable = self.executable
613
other.text_id = self.text_id
614
other.text_sha1 = self.text_sha1
615
other.text_size = self.text_size
616
other.revision = self.revision
619
def detect_changes(self, old_entry):
620
"""See InventoryEntry.detect_changes."""
621
assert self.text_sha1 is not None
622
assert old_entry.text_sha1 is not None
623
text_modified = (self.text_sha1 != old_entry.text_sha1)
624
meta_modified = (self.executable != old_entry.executable)
625
return text_modified, meta_modified
627
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
628
output_to, reverse=False):
629
"""See InventoryEntry._diff."""
631
from_text = tree.get_file(self.file_id).readlines()
633
to_text = to_tree.get_file(to_entry.file_id).readlines()
637
text_diff(from_label, from_text,
638
to_label, to_text, output_to)
640
text_diff(to_label, to_text,
641
from_label, from_text, output_to)
644
label_pair = (to_label, from_label)
646
label_pair = (from_label, to_label)
647
print >> output_to, "Binary files %s and %s differ" % label_pair
650
"""See InventoryEntry.has_text."""
653
def __init__(self, file_id, name, parent_id):
654
super(InventoryFile, self).__init__(file_id, name, parent_id)
657
def kind_character(self):
658
"""See InventoryEntry.kind_character."""
661
def _put_in_tar(self, item, tree):
662
"""See InventoryEntry._put_in_tar."""
663
item.type = tarfile.REGTYPE
664
fileobj = tree.get_file(self.file_id)
665
item.size = self.text_size
666
if tree.is_executable(self.file_id):
672
def _put_on_disk(self, fullpath, tree):
673
"""See InventoryEntry._put_on_disk."""
674
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
675
if tree.is_executable(self.file_id):
676
os.chmod(fullpath, 0755)
678
def _read_tree_state(self, path, work_tree):
679
"""See InventoryEntry._read_tree_state."""
680
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
681
# FIXME: 20050930 probe for the text size when getting sha1
682
# in _read_tree_state
683
self.executable = work_tree.is_executable(self.file_id, path=path)
686
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
687
% (self.__class__.__name__,
694
def _forget_tree_state(self):
695
self.text_sha1 = None
697
def _snapshot_text(self, file_parents, work_tree, commit_builder):
698
"""See InventoryEntry._snapshot_text."""
699
def get_content_byte_lines():
700
return work_tree.get_file(self.file_id).readlines()
701
self.text_sha1, self.text_size = commit_builder.modified_file_text(
702
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
704
def _unchanged(self, previous_ie):
705
"""See InventoryEntry._unchanged."""
706
compatible = super(InventoryFile, self)._unchanged(previous_ie)
707
if self.text_sha1 != previous_ie.text_sha1:
710
# FIXME: 20050930 probe for the text size when getting sha1
711
# in _read_tree_state
712
self.text_size = previous_ie.text_size
713
if self.executable != previous_ie.executable:
718
class InventoryLink(InventoryEntry):
719
"""A file in an inventory."""
721
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
722
'text_id', 'parent_id', 'children', 'executable',
723
'revision', 'symlink_target']
725
def _check(self, checker, rev_id, tree):
726
"""See InventoryEntry._check"""
727
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
728
raise BzrCheckError('symlink {%s} has text in revision {%s}'
729
% (self.file_id, rev_id))
730
if self.symlink_target is None:
731
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
732
% (self.file_id, rev_id))
735
other = InventoryLink(self.file_id, self.name, self.parent_id)
736
other.symlink_target = self.symlink_target
737
other.revision = self.revision
740
def detect_changes(self, old_entry):
741
"""See InventoryEntry.detect_changes."""
742
# FIXME: which _modified field should we use ? RBC 20051003
743
text_modified = (self.symlink_target != old_entry.symlink_target)
745
mutter(" symlink target changed")
746
meta_modified = False
747
return text_modified, meta_modified
749
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
750
output_to, reverse=False):
751
"""See InventoryEntry._diff."""
752
from_text = self.symlink_target
753
if to_entry is not None:
754
to_text = to_entry.symlink_target
759
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
762
print >>output_to, '=== target was %r' % self.symlink_target
764
print >>output_to, '=== target is %r' % self.symlink_target
766
def __init__(self, file_id, name, parent_id):
767
super(InventoryLink, self).__init__(file_id, name, parent_id)
768
self.kind = 'symlink'
770
def kind_character(self):
771
"""See InventoryEntry.kind_character."""
774
def _put_in_tar(self, item, tree):
775
"""See InventoryEntry._put_in_tar."""
776
item.type = tarfile.SYMTYPE
780
item.linkname = self.symlink_target
783
def _put_on_disk(self, fullpath, tree):
784
"""See InventoryEntry._put_on_disk."""
786
os.symlink(self.symlink_target, fullpath)
788
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
790
def _read_tree_state(self, path, work_tree):
791
"""See InventoryEntry._read_tree_state."""
792
self.symlink_target = work_tree.get_symlink_target(self.file_id)
794
def _forget_tree_state(self):
795
self.symlink_target = None
797
def _unchanged(self, previous_ie):
798
"""See InventoryEntry._unchanged."""
799
compatible = super(InventoryLink, self)._unchanged(previous_ie)
800
if self.symlink_target != previous_ie.symlink_target:
804
def _snapshot_text(self, file_parents, work_tree, commit_builder):
805
"""See InventoryEntry._snapshot_text."""
806
commit_builder.modified_link(
807
self.file_id, file_parents, self.symlink_target)
252
810
class Inventory(object):
253
811
"""Inventory of versioned files in a tree.
295
855
The inventory is created with a default root directory, with
298
# We are letting Branch(init=True) create a unique inventory
858
# We are letting Branch.create() create a unique inventory
299
859
# root id. Rather than generating a random one here.
300
860
#if root_id is None:
301
861
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
862
self.root = RootEntry(root_id)
863
# FIXME: this isn't ever used, changing it to self.revision may break
864
# things. TODO make everything use self.revision_id
865
self.revision_id = revision_id
303
866
self._byid = {self.root.file_id: self.root}
869
# TODO: jam 20051218 Should copy also copy the revision_id?
870
other = Inventory(self.root.file_id)
871
# copy recursively so we know directories will be added before
872
# their children. There are more efficient ways than this...
873
for path, entry in self.iter_entries():
874
if entry == self.root:
876
other.add(entry.copy())
306
879
def __iter__(self):
307
880
return iter(self._byid)
310
882
def __len__(self):
311
883
"""Returns number of entries."""
312
884
return len(self._byid)
315
886
def iter_entries(self, from_dir=None):
316
887
"""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
891
elif isinstance(from_dir, basestring):
892
from_dir = self._byid[from_dir]
894
# unrolling the recursive called changed the time from
895
# 440ms/663ms (inline/total) to 116ms/116ms
896
children = from_dir.children.items()
898
children = collections.deque(children)
899
stack = [(u'', children)]
901
from_dir_relpath, children = stack[-1]
904
name, ie = children.popleft()
906
# we know that from_dir_relpath never ends in a slash
907
# and 'f' doesn't begin with one, we can do a string op, rather
908
# than the checks of pathjoin(), though this means that all paths
910
path = from_dir_relpath + '/' + name
914
if ie.kind != 'directory':
917
# But do this child first
918
new_children = ie.children.items()
920
new_children = collections.deque(new_children)
921
stack.append((path, new_children))
922
# Break out of inner loop, so that we start outer loop with child
925
# if we finished all children, pop it off the stack
928
def iter_entries_by_dir(self, from_dir=None):
929
"""Iterate over the entries in a directory first order.
931
This returns all entries for a directory before returning
932
the entries for children of a directory. This is not
933
lexicographically sorted order, and is a hybrid between
934
depth-first and breadth-first.
936
:return: This yields (path, entry) pairs
938
# TODO? Perhaps this should return the from_dir so that the root is
939
# yielded? or maybe an option?
943
elif isinstance(from_dir, basestring):
944
from_dir = self._byid[from_dir]
946
stack = [(u'', from_dir)]
948
cur_relpath, cur_dir = stack.pop()
951
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
953
child_relpath = cur_relpath + child_name
955
yield child_relpath, child_ie
957
if child_ie.kind == 'directory':
958
child_dirs.append((child_relpath+'/', child_ie))
959
stack.extend(reversed(child_dirs))
332
961
def entries(self):
333
962
"""Return list of (path, ie) for all entries except the root.
added
removed
bzrlib/inventory.py
