15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Maybe also keep the full path of the entry, and the children?
19
# But those depend on its position within a particular inventory, and
20
# it would be nice not to need to hold the backpointer here.
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
23
# directories, etc etc.
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
23
import sys, os.path, types, re
26
37
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
39
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath, sha_strings
29
40
from bzrlib.trace import mutter
30
41
from bzrlib.errors import NotVersionedError
33
44
class InventoryEntry(object):
34
45
"""Description of a versioned file.
36
47
An InventoryEntry has the following fields, which are also
37
48
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.
53
(within the parent directory)
59
file_id of the parent directory, or ROOT_ID
62
the revision_id in which the name or parent of this file was
66
sha-1 of the text of the file
69
size in bytes of the text of the file
72
the revision_id in which the text of this file was introduced
74
(reading a version 4 tree created a text_id field.)
54
76
>>> i = Inventory()
57
79
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
80
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
58
81
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
82
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
59
83
>>> for j in i.iter_entries():
67
91
BzrError: inventory already contains entry with id {2323}
68
92
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
93
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
69
94
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
95
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
70
96
>>> i.path2id('src/wibble')
74
100
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
101
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
76
103
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
>>> for j in i.iter_entries():
79
... assert i.path2id(j[0])
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
106
... assert i.path2id(path)
85
112
src/wibble/wibble.c
113
>>> i.id2path('2326').replace('\\\\', '/')
87
114
'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
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
98
'text_id', 'parent_id', 'children', ]
118
'text_id', 'parent_id', 'children',
119
'text_version', 'name_version', 'symlink_target']
121
def compatible_for_commit(self, previous_ie):
123
# different inv parent
124
if previous_ie.parent_id != self.parent_id:
127
elif previous_ie.name != self.name:
129
# changed link target
130
elif (hasattr(self,'symlink_target')
131
and self.symlink_target != previous_ie.symlink_target):
100
135
def __init__(self, file_id, name, kind, parent_id, text_id=None):
101
136
"""Create an InventoryEntry
112
147
Traceback (most recent call last):
113
148
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
150
assert isinstance(name, basestring), name
115
151
if '/' in name or '\\' in name:
116
152
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
154
self.text_version = None
155
self.name_version = None
118
156
self.text_sha1 = None
119
157
self.text_size = None
121
158
self.file_id = file_id
124
161
self.text_id = text_id
125
162
self.parent_id = parent_id
163
self.symlink_target = None
126
164
if kind == 'directory':
127
165
self.children = {}
128
166
elif kind == 'file':
168
elif kind == 'symlink':
131
171
raise BzrError("unhandled entry kind %r" % kind)
173
def read_symlink_target(self, path):
174
if self.kind == 'symlink':
176
self.symlink_target = os.readlink(path)
178
raise BzrError("os.readlink error, %s" % e)
135
180
def sorted_children(self):
136
181
l = self.children.items()
185
def check(self, checker, rev_id, inv, tree):
186
if self.parent_id != None:
187
if not inv.has_id(self.parent_id):
188
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
189
% (self.parent_id, rev_id))
190
if self.kind == 'file':
191
text_version = self.text_version
192
t = (self.file_id, text_version)
193
if t in checker.checked_texts:
194
prev_sha = checker.checked_texts[t]
195
if prev_sha != self.text_sha1:
196
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
197
(self.file_id, rev_id))
199
checker.repeated_text_cnt += 1
201
mutter('check version {%s} of {%s}', rev_id, self.file_id)
202
file_lines = tree.get_file_lines(self.file_id)
203
checker.checked_text_cnt += 1
204
if self.text_size != sum(map(len, file_lines)):
205
raise BzrCheckError('text {%s} wrong size' % self.text_id)
206
if self.text_sha1 != sha_strings(file_lines):
207
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
208
checker.checked_texts[t] = self.text_sha1
209
elif self.kind == 'directory':
210
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
211
raise BzrCheckError('directory {%s} has text in revision {%s}'
212
% (self.file_id, rev_id))
213
elif self.kind == 'root_directory':
215
elif self.kind == 'symlink':
216
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
217
raise BzrCheckError('symlink {%s} has text in revision {%s}'
218
% (self.file_id, rev_id))
219
if self.symlink_target == None:
220
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
221
% (self.file_id, rev_id))
223
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
142
228
other = InventoryEntry(self.file_id, self.name, self.kind,
143
self.parent_id, text_id=self.text_id)
230
other.text_id = self.text_id
144
231
other.text_sha1 = self.text_sha1
145
232
other.text_size = self.text_size
233
other.symlink_target = self.symlink_target
234
other.text_version = self.text_version
235
other.name_version = self.name_version
146
236
# note that children are *not* copied; they're pulled across when
147
237
# others are added
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
249
def __eq__(self, other):
215
250
if not isinstance(other, InventoryEntry):
216
251
return NotImplemented
218
253
return (self.file_id == other.file_id) \
219
254
and (self.name == other.name) \
255
and (other.symlink_target == self.symlink_target) \
220
256
and (self.text_sha1 == other.text_sha1) \
221
257
and (self.text_size == other.text_size) \
222
258
and (self.text_id == other.text_id) \
223
259
and (self.parent_id == other.parent_id) \
224
and (self.kind == other.kind)
260
and (self.kind == other.kind) \
261
and (self.text_version == other.text_version) \
262
and (self.name_version == other.name_version)
227
264
def __ne__(self, other):
228
265
return not (self == other)
426
480
self._byid[entry.file_id] = entry
427
481
parent.children[entry.name] = entry
430
485
def add_path(self, relpath, kind, file_id=None):
431
486
"""Add entry from a path.
433
The immediate parent must already be versioned"""
488
The immediate parent must already be versioned.
490
Returns the new entry object."""
434
491
from bzrlib.branch import gen_file_id
436
493
parts = bzrlib.osutils.splitpath(relpath)
476
534
del self[ie.parent_id].children[ie.name]
479
def to_element(self):
480
"""Convert to XML Element"""
481
from bzrlib.xml import Element
483
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
487
for path, ie in self.iter_entries():
488
e.append(ie.to_element())
492
def from_element(cls, elt):
493
"""Construct from XML Element
495
>>> inv = Inventory()
496
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
497
>>> elt = inv.to_element()
498
>>> inv2 = Inventory.from_element(elt)
502
# XXXX: doctest doesn't run this properly under python2.3
503
assert elt.tag == 'inventory'
504
root_id = elt.get('file_id') or ROOT_ID
507
ie = InventoryEntry.from_element(e)
508
if ie.parent_id == ROOT_ID:
509
ie.parent_id = root_id
513
from_element = classmethod(from_element)
516
537
def __eq__(self, other):
517
538
"""Compare two sets by comparing their contents.
added
removed
bzrlib/inventory.py
