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
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
56
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
57
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
59
58
>>> for j in i.iter_entries():
62
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
61
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
63
62
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
64
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
65
64
Traceback (most recent call last):
67
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'))
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'))
70
69
>>> i.path2id('src/wibble')
74
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
73
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
76
75
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
77
76
>>> for j in i.iter_entries():
86
85
>>> i.id2path('2326')
87
86
'src/wibble/wibble.c'
89
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?
90
89
But those depend on its position within a particular inventory, and
91
90
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):
92
def __init__(self, file_id, name, kind='file', text_id=None,
101
94
"""Create an InventoryEntry
103
96
The filename must be a single component, relative to the
104
97
parent directory; it cannot be a whole path or relative name.
106
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
99
>>> e = InventoryEntry('123', 'hello.c')
111
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
104
>>> e = InventoryEntry('123', 'src/hello.c')
112
105
Traceback (most recent call last):
113
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
106
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
115
if '/' in name or '\\' in name:
116
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
118
self.text_sha1 = None
119
self.text_size = None
109
if len(splitpath(name)) != 1:
110
bailout('InventoryEntry name is not a simple filename: %r'
121
113
self.file_id = file_id
115
assert kind in ['file', 'directory']
124
117
self.text_id = text_id
125
118
self.parent_id = parent_id
126
if kind == 'directory':
131
raise BzrError("unhandled entry kind %r" % kind)
135
def sorted_children(self):
136
l = self.children.items()
119
self.text_sha1 = None
120
self.text_size = None
142
124
other = InventoryEntry(self.file_id, self.name, self.kind,
143
self.parent_id, text_id=self.text_id)
125
self.text_id, self.parent_id)
144
126
other.text_sha1 = self.text_sha1
145
127
other.text_size = self.text_size
146
# note that children are *not* copied; they're pulled across when
160
140
def to_element(self):
161
141
"""Convert to XML element"""
162
from bzrlib.xml import Element
164
142
e = Element('entry')
166
144
e.set('name', self.name)
167
145
e.set('file_id', self.file_id)
168
146
e.set('kind', self.kind)
170
if self.text_size != None:
148
if self.text_size is not None:
171
149
e.set('text_size', '%d' % self.text_size)
173
for f in ['text_id', 'text_sha1']:
151
for f in ['text_id', 'text_sha1', 'parent_id']:
174
152
v = getattr(self, f)
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
161
def from_element(cls, elt):
191
162
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)
163
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
201
164
self.text_id = elt.get('text_id')
202
165
self.text_sha1 = elt.get('text_sha1')
166
self.parent_id = elt.get('parent_id')
204
168
## mutter("read inventoryentry: %r" % (elt.attrib))
212
176
from_element = classmethod(from_element)
214
def __eq__(self, other):
178
def __cmp__(self, other):
215
181
if not isinstance(other, InventoryEntry):
216
182
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)
227
def __ne__(self, other):
228
return not (self == other)
231
raise ValueError('not hashable')
235
class RootEntry(InventoryEntry):
236
def __init__(self, file_id):
237
self.file_id = file_id
239
self.kind = 'root_directory'
240
self.parent_id = None
243
def __eq__(self, other):
244
if not isinstance(other, RootEntry):
245
return NotImplemented
247
return (self.file_id == other.file_id) \
248
and (self.children == other.children)
252
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):
253
195
"""Inventory of versioned files in a tree.
255
This describes which file_id is present at each point in the tree,
256
and possibly the SHA-1 or other information about the file.
257
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.
259
204
The inventory represents a typical unix file tree, with
260
205
directories containing files and subdirectories. We never store
264
209
returned quickly.
266
211
InventoryEntry objects must not be modified after they are
267
inserted, other than through the Inventory API.
269
214
>>> inv = Inventory()
270
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
215
>>> inv.write_xml(sys.stdout)
218
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
271
219
>>> inv['123-123'].name
221
>>> for file_id in inv: print file_id
274
225
May be treated as an iterator or set to look up file ids:
283
234
>>> [x[0] for x in inv.iter_entries()]
285
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
237
>>> inv.write_xml(sys.stdout)
239
<entry file_id="123-123" kind="file" name="hello.c" />
288
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.
289
258
"""Create or read an inventory.
291
260
If a working directory is specified, the inventory is read
292
261
from there. If the file is specified, read from that. If not,
293
262
the inventory is created empty.
295
The inventory is created with a default root directory, with
298
# We are letting Branch(init=True) create a unique inventory
299
# root id. Rather than generating a random one here.
301
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
self.root = RootEntry(root_id)
303
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: {}}
306
271
def __iter__(self):
312
277
return len(self._byid)
315
def iter_entries(self, from_dir=None):
280
def iter_entries(self, parent_id=None):
316
281
"""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()
282
kids = self._tree[parent_id].items()
325
284
for name, ie in kids:
327
286
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
333
"""Return list of (path, ie) for all entries except the root.
335
This may be faster than iter_entries.
338
def descend(dir_ie, dir_path):
339
kids = dir_ie.children.items()
341
for name, ie in kids:
342
child_path = os.path.join(dir_path, name)
343
accum.append((child_path, ie))
344
if ie.kind == 'directory':
345
descend(ie, child_path)
347
descend(self.root, '')
351
def directories(self):
352
"""Return (path, entry) pairs for all directories, including the root.
355
def descend(parent_ie, parent_path):
356
accum.append((parent_path, parent_ie))
358
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
361
for name, child_ie in kids:
362
child_path = os.path.join(parent_path, name)
363
descend(child_ie, child_path)
364
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
369
311
def __contains__(self, file_id):
370
312
"""True if this entry contains a file with given id.
372
314
>>> inv = Inventory()
373
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
315
>>> inv.add(InventoryEntry('123', 'foo.c'))
383
325
"""Return the entry for given file_id.
385
327
>>> inv = Inventory()
386
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
328
>>> inv.add(InventoryEntry('123123', 'hello.c'))
387
329
>>> inv['123123'].name
391
return self._byid[file_id]
394
raise BzrError("can't look up file_id None")
396
raise BzrError("file_id {%s} not in inventory" % file_id)
399
def get_file_kind(self, file_id):
400
return self._byid[file_id].kind
402
def get_child(self, parent_id, filename):
403
return self[parent_id].children.get(filename)
332
return self._byid[file_id]
406
335
def add(self, entry):
409
338
To add a file to a branch ready to be committed, use Branch.add,
410
339
which calls this."""
411
if entry.file_id in self._byid:
412
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
414
if entry.parent_id == ROOT_ID or entry.parent_id is None:
415
entry.parent_id = self.root.file_id
418
parent = self._byid[entry.parent_id]
420
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
422
if parent.children.has_key(entry.name):
423
raise BzrError("%s is already versioned" %
424
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))
426
352
self._byid[entry.file_id] = entry
427
parent.children[entry.name] = entry
430
def add_path(self, relpath, kind, file_id=None):
431
"""Add entry from a path.
433
The immediate parent must already be versioned"""
434
from bzrlib.branch import gen_file_id
436
parts = bzrlib.osutils.splitpath(relpath)
438
raise BzrError("cannot re-add root of inventory")
441
file_id = gen_file_id(relpath)
443
parent_path = parts[:-1]
444
parent_id = self.path2id(parent_path)
445
if parent_id == None:
446
raise NotVersionedError(parent_path)
448
ie = InventoryEntry(file_id, parts[-1],
449
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] = {}
453
359
def __delitem__(self, file_id):
454
360
"""Remove entry by id.
456
362
>>> inv = Inventory()
457
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
363
>>> inv.add(InventoryEntry('123', 'foo.c'))
460
366
>>> del inv['123']
464
370
ie = self[file_id]
466
assert self[ie.parent_id].children[ie.name] == ie
372
assert self._tree[ie.parent_id][ie.name] == ie
468
374
# TODO: Test deleting all children; maybe hoist to a separate
469
375
# deltree method?
470
376
if ie.kind == 'directory':
471
for cie in ie.children.values():
377
for cie in self._tree[file_id].values():
472
378
del self[cie.file_id]
379
del self._tree[file_id]
475
381
del self._byid[file_id]
476
del self[ie.parent_id].children[ie.name]
382
del self._tree[ie.parent_id][ie.name]
386
return Set(self._byid)
479
389
def to_element(self):
480
390
"""Convert to XML Element"""
481
from bzrlib.xml import Element
483
391
e = Element('inventory')
485
if self.root.file_id not in (None, ROOT_ID):
486
e.set('file_id', self.root.file_id)
487
393
for path, ie in self.iter_entries():
488
394
e.append(ie.to_element())
492
398
def from_element(cls, elt):
493
399
"""Construct from XML Element
495
401
>>> inv = Inventory()
496
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
402
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
497
403
>>> elt = inv.to_element()
498
404
>>> inv2 = Inventory.from_element(elt)
502
# XXXX: doctest doesn't run this properly under python2.3
503
408
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
411
o.add(InventoryEntry.from_element(e))
513
414
from_element = classmethod(from_element)
516
def __eq__(self, other):
417
def __cmp__(self, other):
517
418
"""Compare two sets by comparing their contents.
519
420
>>> i1 = Inventory()
520
421
>>> i2 = Inventory()
523
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
424
>>> i1.add(InventoryEntry('123', 'foo'))
526
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
427
>>> i2.add(InventoryEntry('123', 'foo'))
530
434
if not isinstance(other, Inventory):
531
435
return NotImplemented
533
if len(self._byid) != len(other._byid):
534
# shortcut: obviously not the same
537
return self._byid == other._byid
540
def __ne__(self, other):
541
return not (self == other)
545
raise ValueError('not hashable')
549
def get_idpath(self, file_id):
550
"""Return a list of file_ids for the path to an entry.
552
The list contains one element for each directory followed by
553
the id of the file itself. So the length of the returned list
554
is equal to the depth of the file in the tree, counting the
555
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."""
558
450
while file_id != None:
560
ie = self._byid[file_id]
562
raise BzrError("file_id {%s} not found in inventory" % file_id)
563
p.insert(0, ie.file_id)
564
453
file_id = ie.parent_id
568
def id2path(self, file_id):
569
"""Return as a list the path to file_id."""
571
# get all names, skipping root
572
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
573
return os.sep.join(p)
583
464
This returns the entry of the last component in the path,
584
465
which may be either a file or a directory.
586
Returns None iff the path is not found.
588
if isinstance(name, types.StringTypes):
589
name = splitpath(name)
591
mutter("lookup path %r" % name)
467
assert isinstance(name, types.StringTypes)
470
for f in splitpath(name):
596
cie = parent.children[f]
472
cie = self._tree[parent_id][f]
597
473
assert cie.name == f
598
assert cie.parent_id == parent.file_id
474
parent_id = cie.file_id
601
476
# or raise an error?
604
return parent.file_id
482
def get_child(self, parent_id, child_name):
483
return self._tree[parent_id].get(child_name)
607
486
def has_filename(self, names):
611
490
def has_id(self, file_id):
491
assert isinstance(file_id, str)
612
492
return self._byid.has_key(file_id)
615
def rename(self, file_id, new_parent_id, new_name):
616
"""Move a file within the inventory.
618
This can change either the name, or the parent, or both.
620
This does not move the working file."""
621
if not is_valid_name(new_name):
622
raise BzrError("not an acceptable filename: %r" % new_name)
624
new_parent = self._byid[new_parent_id]
625
if new_name in new_parent.children:
626
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
628
new_parent_idpath = self.get_idpath(new_parent_id)
629
if file_id in new_parent_idpath:
630
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
631
% (self.id2path(file_id), self.id2path(new_parent_id)))
633
file_ie = self._byid[file_id]
634
old_parent = self._byid[file_ie.parent_id]
636
# TODO: Don't leave things messed up if this fails
638
del old_parent.children[file_ie.name]
639
new_parent.children[new_name] = file_ie
641
file_ie.name = new_name
642
file_ie.parent_id = new_parent_id
649
def is_valid_name(name):
652
_NAME_RE = re.compile(r'^[^/\\]+$')
654
return bool(_NAME_RE.match(name))
496
if __name__ == '__main__':
497
import doctest, inventory
498
doctest.testmod(inventory)
added
removed
bzrlib/inventory.py
