14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# This should really be an id randomly assigned when the tree is
19
# created, but it's not for now.
23
import sys, os.path, types, re
26
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
from bzrlib.trace import mutter
30
from bzrlib.errors import NotVersionedError
33
class InventoryEntry(object):
18
"""Inventories map files to their name in a revision."""
21
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
22
__author__ = "Martin Pool <mbp@canonical.com>"
24
import sys, os.path, types
27
from xml import XMLMixin
28
from ElementTree import ElementTree, Element
29
from errors import bailout
30
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
31
from trace import mutter
33
class InventoryEntry(XMLMixin):
34
34
"""Description of a versioned file.
36
36
An InventoryEntry has the following fields, which are also
54
54
>>> i = Inventory()
57
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
58
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
59
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
60
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
56
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
57
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
61
58
>>> for j in i.iter_entries():
64
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
61
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
65
62
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
66
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
67
64
Traceback (most recent call last):
69
BzrError: inventory already contains entry with id {2323}
70
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
71
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
72
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
73
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
66
BzrError: ('inventory already contains entry with id {2323}', [])
67
>>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
68
>>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
74
69
>>> i.path2id('src/wibble')
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
73
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
81
75
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
76
>>> for j in i.iter_entries():
91
85
>>> i.id2path('2326')
92
86
'src/wibble/wibble.c'
94
TODO: Maybe also keep the full path of the entry, and the children?
88
:todo: Maybe also keep the full path of the entry, and the children?
95
89
But those depend on its position within a particular inventory, and
96
90
it would be nice not to need to hold the backpointer here.
99
# TODO: split InventoryEntry into subclasses for files,
100
# directories, etc etc.
102
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
'text_id', 'parent_id', 'children',
104
'text_version', 'entry_version', ]
107
def __init__(self, file_id, name, kind, parent_id, text_id=None):
92
def __init__(self, file_id, name, kind='file', text_id=None,
108
94
"""Create an InventoryEntry
110
96
The filename must be a single component, relative to the
111
97
parent directory; it cannot be a whole path or relative name.
113
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
99
>>> e = InventoryEntry('123', 'hello.c')
118
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
104
>>> e = InventoryEntry('123', 'src/hello.c')
119
105
Traceback (most recent call last):
120
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
106
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
122
assert isinstance(name, basestring), name
123
if '/' in name or '\\' in name:
124
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
126
self.text_version = None
127
self.entry_version = None
128
self.text_sha1 = None
129
self.text_size = None
109
if len(splitpath(name)) != 1:
110
bailout('InventoryEntry name is not a simple filename: %r'
130
113
self.file_id = file_id
115
assert kind in ['file', 'directory']
133
117
self.text_id = text_id
134
118
self.parent_id = parent_id
135
if kind == 'directory':
140
raise BzrError("unhandled entry kind %r" % kind)
144
def sorted_children(self):
145
l = self.children.items()
119
self.text_sha1 = None
120
self.text_size = None
151
124
other = InventoryEntry(self.file_id, self.name, self.kind,
152
self.parent_id, text_id=self.text_id)
125
self.text_id, self.parent_id)
153
126
other.text_sha1 = self.text_sha1
154
127
other.text_size = self.text_size
155
# note that children are *not* copied; they're pulled across when
169
def __eq__(self, other):
140
def to_element(self):
141
"""Convert to XML element"""
144
e.set('name', self.name)
145
e.set('file_id', self.file_id)
146
e.set('kind', self.kind)
148
if self.text_size is not None:
149
e.set('text_size', '%d' % self.text_size)
151
for f in ['text_id', 'text_sha1', 'parent_id']:
161
def from_element(cls, elt):
162
assert elt.tag == 'entry'
163
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
164
self.text_id = elt.get('text_id')
165
self.text_sha1 = elt.get('text_sha1')
166
self.parent_id = elt.get('parent_id')
168
## mutter("read inventoryentry: %r" % (elt.attrib))
170
v = elt.get('text_size')
171
self.text_size = v and int(v)
176
from_element = classmethod(from_element)
178
def __cmp__(self, other):
170
181
if not isinstance(other, InventoryEntry):
171
182
return NotImplemented
173
return (self.file_id == other.file_id) \
174
and (self.name == other.name) \
175
and (self.text_sha1 == other.text_sha1) \
176
and (self.text_size == other.text_size) \
177
and (self.text_id == other.text_id) \
178
and (self.parent_id == other.parent_id) \
179
and (self.kind == other.kind) \
180
and (self.text_version == other.text_version) \
181
and (self.entry_version == other.entry_version)
184
def __ne__(self, other):
185
return not (self == other)
188
raise ValueError('not hashable')
192
class RootEntry(InventoryEntry):
193
def __init__(self, file_id):
194
self.file_id = file_id
196
self.kind = 'root_directory'
197
self.parent_id = None
200
def __eq__(self, other):
201
if not isinstance(other, RootEntry):
202
return NotImplemented
204
return (self.file_id == other.file_id) \
205
and (self.children == other.children)
209
class Inventory(object):
184
return cmp(self.file_id, other.file_id) \
185
or cmp(self.name, other.name) \
186
or cmp(self.text_sha1, other.text_sha1) \
187
or cmp(self.text_size, other.text_size) \
188
or cmp(self.text_id, other.text_id) \
189
or cmp(self.parent_id, other.parent_id) \
190
or cmp(self.kind, other.kind)
194
class Inventory(XMLMixin):
210
195
"""Inventory of versioned files in a tree.
212
This describes which file_id is present at each point in the tree,
213
and possibly the SHA-1 or other information about the file.
214
Entries can be looked up either by path or by file_id.
197
An Inventory acts like a set of InventoryEntry items. You can
198
also look files up by their file_id or name.
200
May be read from and written to a metadata file in a tree. To
201
manipulate the inventory (for example to add a file), it is read
202
in, modified, and then written back out.
216
204
The inventory represents a typical unix file tree, with
217
205
directories containing files and subdirectories. We never store
221
209
returned quickly.
223
211
InventoryEntry objects must not be modified after they are
224
inserted, other than through the Inventory API.
226
214
>>> inv = Inventory()
227
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
228
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
215
>>> inv.write_xml(sys.stdout)
218
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
229
219
>>> inv['123-123'].name
221
>>> for file_id in inv: print file_id
232
225
May be treated as an iterator or set to look up file ids:
241
234
>>> [x[0] for x in inv.iter_entries()]
243
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
244
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
245
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
237
>>> inv.write_xml(sys.stdout)
239
<entry file_id="123-123" kind="file" name="hello.c" />
247
def __init__(self, root_id=ROOT_ID):
244
## TODO: Clear up handling of files in subdirectories; we probably
245
## do want to be able to just look them up by name but this
246
## probably means gradually walking down the path, looking up as we go.
248
## TODO: Make sure only canonical filenames are stored.
250
## TODO: Do something sensible about the possible collisions on
251
## case-losing filesystems. Perhaps we should just always forbid
254
## _tree should probably just be stored as
255
## InventoryEntry._children on each directory.
248
258
"""Create or read an inventory.
250
260
If a working directory is specified, the inventory is read
251
261
from there. If the file is specified, read from that. If not,
252
262
the inventory is created empty.
254
The inventory is created with a default root directory, with
257
# We are letting Branch(init=True) create a unique inventory
258
# root id. Rather than generating a random one here.
260
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
261
self.root = RootEntry(root_id)
262
self._byid = {self.root.file_id: self.root}
266
# _tree is indexed by parent_id; at each level a map from name
267
# to ie. The None entry is the root.
268
self._tree = {None: {}}
265
271
def __iter__(self):
271
277
return len(self._byid)
274
def iter_entries(self, from_dir=None):
280
def iter_entries(self, parent_id=None):
275
281
"""Return (path, entry) pairs, in order by name."""
279
elif isinstance(from_dir, basestring):
280
from_dir = self._byid[from_dir]
282
kids = from_dir.children.items()
282
kids = self._tree[parent_id].items()
284
284
for name, ie in kids:
286
286
if ie.kind == 'directory':
287
for cn, cie in self.iter_entries(from_dir=ie.file_id):
288
yield os.path.join(name, cn), cie
292
"""Return list of (path, ie) for all entries except the root.
294
This may be faster than iter_entries.
297
def descend(dir_ie, dir_path):
298
kids = dir_ie.children.items()
300
for name, ie in kids:
301
child_path = os.path.join(dir_path, name)
302
accum.append((child_path, ie))
303
if ie.kind == 'directory':
304
descend(ie, child_path)
306
descend(self.root, '')
310
def directories(self):
311
"""Return (path, entry) pairs for all directories, including the root.
314
def descend(parent_ie, parent_path):
315
accum.append((parent_path, parent_ie))
317
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
320
for name, child_ie in kids:
321
child_path = os.path.join(parent_path, name)
322
descend(child_ie, child_path)
323
descend(self.root, '')
287
for cn, cie in self.iter_entries(parent_id=ie.file_id):
288
yield joinpath([name, cn]), cie
291
def directories(self, include_root=True):
292
"""Return (path, entry) pairs for all directories.
296
for path, entry in self.iter_entries():
297
if entry.kind == 'directory':
302
def children(self, parent_id):
303
"""Return entries that are direct children of parent_id."""
304
return self._tree[parent_id]
308
# TODO: return all paths and entries
328
311
def __contains__(self, file_id):
329
312
"""True if this entry contains a file with given id.
331
314
>>> inv = Inventory()
332
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
333
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
315
>>> inv.add(InventoryEntry('123', 'foo.c'))
343
325
"""Return the entry for given file_id.
345
327
>>> inv = Inventory()
346
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
347
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
328
>>> inv.add(InventoryEntry('123123', 'hello.c'))
348
329
>>> inv['123123'].name
352
return self._byid[file_id]
355
raise BzrError("can't look up file_id None")
357
raise BzrError("file_id {%s} not in inventory" % file_id)
360
def get_file_kind(self, file_id):
361
return self._byid[file_id].kind
363
def get_child(self, parent_id, filename):
364
return self[parent_id].children.get(filename)
332
return self._byid[file_id]
367
335
def add(self, entry):
368
336
"""Add entry to inventory.
370
338
To add a file to a branch ready to be committed, use Branch.add,
373
Returns the new entry object.
375
if entry.file_id in self._byid:
376
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
378
if entry.parent_id == ROOT_ID or entry.parent_id is None:
379
entry.parent_id = self.root.file_id
382
parent = self._byid[entry.parent_id]
384
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
386
if parent.children.has_key(entry.name):
387
raise BzrError("%s is already versioned" %
388
appendpath(self.id2path(parent.file_id), entry.name))
340
if entry.file_id in self:
341
bailout("inventory already contains entry with id {%s}" % entry.file_id)
343
if entry.parent_id != None:
344
if entry.parent_id not in self:
345
bailout("parent_id %s of new entry not found in inventory"
348
if self._tree[entry.parent_id].has_key(entry.name):
349
bailout("%s is already versioned"
350
% appendpath(self.id2path(entry.parent_id), entry.name))
390
352
self._byid[entry.file_id] = entry
391
parent.children[entry.name] = entry
395
def add_path(self, relpath, kind, file_id=None):
396
"""Add entry from a path.
398
The immediate parent must already be versioned.
400
Returns the new entry object."""
401
from bzrlib.branch import gen_file_id
403
parts = bzrlib.osutils.splitpath(relpath)
405
raise BzrError("cannot re-add root of inventory")
408
file_id = gen_file_id(relpath)
410
parent_path = parts[:-1]
411
parent_id = self.path2id(parent_path)
412
if parent_id == None:
413
raise NotVersionedError(parent_path)
415
ie = InventoryEntry(file_id, parts[-1],
416
kind=kind, parent_id=parent_id)
353
self._tree[entry.parent_id][entry.name] = entry
355
if entry.kind == 'directory':
356
self._tree[entry.file_id] = {}
420
359
def __delitem__(self, file_id):
421
360
"""Remove entry by id.
423
362
>>> inv = Inventory()
424
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
425
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
363
>>> inv.add(InventoryEntry('123', 'foo.c'))
428
366
>>> del inv['123']
432
370
ie = self[file_id]
434
assert self[ie.parent_id].children[ie.name] == ie
372
assert self._tree[ie.parent_id][ie.name] == ie
436
374
# TODO: Test deleting all children; maybe hoist to a separate
437
375
# deltree method?
438
376
if ie.kind == 'directory':
439
for cie in ie.children.values():
377
for cie in self._tree[file_id].values():
440
378
del self[cie.file_id]
379
del self._tree[file_id]
443
381
del self._byid[file_id]
444
del self[ie.parent_id].children[ie.name]
447
def __eq__(self, other):
382
del self._tree[ie.parent_id][ie.name]
386
return Set(self._byid)
389
def to_element(self):
390
"""Convert to XML Element"""
391
e = Element('inventory')
393
for path, ie in self.iter_entries():
394
e.append(ie.to_element())
398
def from_element(cls, elt):
399
"""Construct from XML Element
401
>>> inv = Inventory()
402
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
403
>>> elt = inv.to_element()
404
>>> inv2 = Inventory.from_element(elt)
408
assert elt.tag == 'inventory'
411
o.add(InventoryEntry.from_element(e))
414
from_element = classmethod(from_element)
417
def __cmp__(self, other):
448
418
"""Compare two sets by comparing their contents.
450
420
>>> i1 = Inventory()
451
421
>>> i2 = Inventory()
454
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
455
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
424
>>> i1.add(InventoryEntry('123', 'foo'))
458
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
459
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
427
>>> i2.add(InventoryEntry('123', 'foo'))
463
434
if not isinstance(other, Inventory):
464
435
return NotImplemented
466
if len(self._byid) != len(other._byid):
467
# shortcut: obviously not the same
470
return self._byid == other._byid
473
def __ne__(self, other):
474
return not (self == other)
478
raise ValueError('not hashable')
481
def get_idpath(self, file_id):
482
"""Return a list of file_ids for the path to an entry.
484
The list contains one element for each directory followed by
485
the id of the file itself. So the length of the returned list
486
is equal to the depth of the file in the tree, counting the
487
root directory as depth 1.
437
if self.id_set() ^ other.id_set():
440
for file_id in self._byid:
441
c = cmp(self[file_id], other[file_id])
447
def id2path(self, file_id):
448
"""Return as a list the path to file_id."""
490
450
while file_id != None:
492
ie = self._byid[file_id]
494
raise BzrError("file_id {%s} not found in inventory" % file_id)
495
p.insert(0, ie.file_id)
496
453
file_id = ie.parent_id
500
def id2path(self, file_id):
501
"""Return as a list the path to file_id."""
503
# get all names, skipping root
504
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
505
return os.sep.join(p)
515
464
This returns the entry of the last component in the path,
516
465
which may be either a file or a directory.
518
Returns None iff the path is not found.
520
if isinstance(name, types.StringTypes):
521
name = splitpath(name)
523
mutter("lookup path %r" % name)
467
assert isinstance(name, types.StringTypes)
470
for f in splitpath(name):
528
cie = parent.children[f]
472
cie = self._tree[parent_id][f]
529
473
assert cie.name == f
530
assert cie.parent_id == parent.file_id
474
parent_id = cie.file_id
533
476
# or raise an error?
536
return parent.file_id
482
def get_child(self, parent_id, child_name):
483
return self._tree[parent_id].get(child_name)
539
486
def has_filename(self, names):
543
490
def has_id(self, file_id):
491
assert isinstance(file_id, str)
544
492
return self._byid.has_key(file_id)
547
def rename(self, file_id, new_parent_id, new_name):
548
"""Move a file within the inventory.
550
This can change either the name, or the parent, or both.
552
This does not move the working file."""
553
if not is_valid_name(new_name):
554
raise BzrError("not an acceptable filename: %r" % new_name)
556
new_parent = self._byid[new_parent_id]
557
if new_name in new_parent.children:
558
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
560
new_parent_idpath = self.get_idpath(new_parent_id)
561
if file_id in new_parent_idpath:
562
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
563
% (self.id2path(file_id), self.id2path(new_parent_id)))
565
file_ie = self._byid[file_id]
566
old_parent = self._byid[file_ie.parent_id]
568
# TODO: Don't leave things messed up if this fails
570
del old_parent.children[file_ie.name]
571
new_parent.children[new_name] = file_ie
573
file_ie.name = new_name
574
file_ie.parent_id = new_parent_id
581
def is_valid_name(name):
584
_NAME_RE = re.compile(r'^[^/\\]+$')
586
return bool(_NAME_RE.match(name))
496
if __name__ == '__main__':
497
import doctest, inventory
498
doctest.testmod(inventory)
added
removed
bzrlib/inventory.py
