15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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
28
from cElementTree import Element, ElementTree, SubElement
30
from elementtree.ElementTree import Element, ElementTree, SubElement
32
from xml import XMLMixin
33
from errors import bailout
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
36
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
37
29
from bzrlib.trace import mutter
30
from bzrlib.errors import NotVersionedError
39
class InventoryEntry(XMLMixin):
33
class InventoryEntry(object):
40
34
"""Description of a versioned file.
42
36
An InventoryEntry has the following fields, which are also
60
54
>>> i = Inventory()
62
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
63
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
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')
64
61
>>> for j in i.iter_entries():
67
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
64
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
68
65
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
69
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
66
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
70
67
Traceback (most recent call last):
72
BzrError: ('inventory already contains entry with id {2323}', [])
73
>>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
74
>>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
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')
75
74
>>> i.path2id('src/wibble')
79
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
81
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
82
>>> for j in i.iter_entries():
91
91
>>> i.id2path('2326')
92
92
'src/wibble/wibble.c'
94
:todo: Maybe also keep the full path of the entry, and the children?
94
TODO: Maybe also keep the full path of the entry, and the children?
95
95
But those depend on its position within a particular inventory, and
96
96
it would be nice not to need to hold the backpointer here.
98
def __init__(self, file_id, name, kind='file', text_id=None,
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):
100
108
"""Create an InventoryEntry
102
110
The filename must be a single component, relative to the
103
111
parent directory; it cannot be a whole path or relative name.
105
>>> e = InventoryEntry('123', 'hello.c')
113
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
110
>>> e = InventoryEntry('123', 'src/hello.c')
118
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
111
119
Traceback (most recent call last):
112
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
120
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
115
if len(splitpath(name)) != 1:
116
bailout('InventoryEntry name is not a simple filename: %r'
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
119
130
self.file_id = file_id
121
assert kind in ['file', 'directory']
123
133
self.text_id = text_id
124
134
self.parent_id = parent_id
125
self.text_sha1 = None
126
self.text_size = None
135
if kind == 'directory':
140
raise BzrError("unhandled entry kind %r" % kind)
144
def sorted_children(self):
145
l = self.children.items()
130
151
other = InventoryEntry(self.file_id, self.name, self.kind,
131
self.text_id, self.parent_id)
152
self.parent_id, text_id=self.text_id)
132
153
other.text_sha1 = self.text_sha1
133
154
other.text_size = self.text_size
155
# note that children are *not* copied; they're pulled across when
146
def to_element(self):
147
"""Convert to XML element"""
150
e.set('name', self.name)
151
e.set('file_id', self.file_id)
152
e.set('kind', self.kind)
154
if self.text_size is not None:
155
e.set('text_size', '%d' % self.text_size)
157
for f in ['text_id', 'text_sha1', 'parent_id']:
167
def from_element(cls, elt):
168
assert elt.tag == 'entry'
169
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
170
self.text_id = elt.get('text_id')
171
self.text_sha1 = elt.get('text_sha1')
172
self.parent_id = elt.get('parent_id')
174
## mutter("read inventoryentry: %r" % (elt.attrib))
176
v = elt.get('text_size')
177
self.text_size = v and int(v)
182
from_element = classmethod(from_element)
184
def __cmp__(self, other):
169
def __eq__(self, other):
187
170
if not isinstance(other, InventoryEntry):
188
171
return NotImplemented
190
return cmp(self.file_id, other.file_id) \
191
or cmp(self.name, other.name) \
192
or cmp(self.text_sha1, other.text_sha1) \
193
or cmp(self.text_size, other.text_size) \
194
or cmp(self.text_id, other.text_id) \
195
or cmp(self.parent_id, other.parent_id) \
196
or cmp(self.kind, other.kind)
200
class Inventory(XMLMixin):
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):
201
210
"""Inventory of versioned files in a tree.
203
An Inventory acts like a set of InventoryEntry items. You can
204
also look files up by their file_id or name.
206
May be read from and written to a metadata file in a tree. To
207
manipulate the inventory (for example to add a file), it is read
208
in, modified, and then written back out.
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.
210
216
The inventory represents a typical unix file tree, with
211
217
directories containing files and subdirectories. We never store
215
221
returned quickly.
217
223
InventoryEntry objects must not be modified after they are
224
inserted, other than through the Inventory API.
220
226
>>> inv = Inventory()
221
>>> inv.write_xml(sys.stdout)
224
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
227
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
228
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
225
229
>>> inv['123-123'].name
227
>>> for file_id in inv: print file_id
231
232
May be treated as an iterator or set to look up file ids:
240
241
>>> [x[0] for x in inv.iter_entries()]
243
>>> inv.write_xml(sys.stdout)
245
<entry file_id="123-123" kind="file" name="hello.c" />
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')
250
## TODO: Clear up handling of files in subdirectories; we probably
251
## do want to be able to just look them up by name but this
252
## probably means gradually walking down the path, looking up as we go.
254
## TODO: Make sure only canonical filenames are stored.
256
## TODO: Do something sensible about the possible collisions on
257
## case-losing filesystems. Perhaps we should just always forbid
260
## _tree should probably just be stored as
261
## InventoryEntry._children on each directory.
247
def __init__(self, root_id=ROOT_ID):
264
248
"""Create or read an inventory.
266
250
If a working directory is specified, the inventory is read
267
251
from there. If the file is specified, read from that. If not,
268
252
the inventory is created empty.
254
The inventory is created with a default root directory, with
272
# _tree is indexed by parent_id; at each level a map from name
273
# to ie. The None entry is the root.
274
self._tree = {None: {}}
257
# We are letting Branch.initialize() 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}
277
265
def __iter__(self):
283
271
return len(self._byid)
286
def iter_entries(self, parent_id=None):
274
def iter_entries(self, from_dir=None):
287
275
"""Return (path, entry) pairs, in order by name."""
288
kids = self._tree[parent_id].items()
279
elif isinstance(from_dir, basestring):
280
from_dir = self._byid[from_dir]
282
kids = from_dir.children.items()
290
284
for name, ie in kids:
292
286
if ie.kind == 'directory':
293
for cn, cie in self.iter_entries(parent_id=ie.file_id):
294
yield joinpath([name, cn]), cie
297
def directories(self, include_root=True):
298
"""Return (path, entry) pairs for all directories.
302
for path, entry in self.iter_entries():
303
if entry.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, '')
308
def children(self, parent_id):
309
"""Return entries that are direct children of parent_id."""
310
return self._tree[parent_id]
314
# TODO: return all paths and entries
317
328
def __contains__(self, file_id):
318
329
"""True if this entry contains a file with given id.
320
331
>>> inv = Inventory()
321
>>> inv.add(InventoryEntry('123', 'foo.c'))
332
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
333
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
331
343
"""Return the entry for given file_id.
333
345
>>> inv = Inventory()
334
>>> inv.add(InventoryEntry('123123', 'hello.c'))
346
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
347
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
335
348
>>> inv['123123'].name
338
return self._byid[file_id]
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)
341
367
def add(self, entry):
342
368
"""Add entry to inventory.
344
370
To add a file to a branch ready to be committed, use Branch.add,
346
if entry.file_id in self:
347
bailout("inventory already contains entry with id {%s}" % entry.file_id)
349
if entry.parent_id != None:
350
if entry.parent_id not in self:
351
bailout("parent_id %s of new entry not found in inventory"
354
if self._tree[entry.parent_id].has_key(entry.name):
355
bailout("%s is already versioned"
356
% appendpath(self.id2path(entry.parent_id), entry.name))
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))
358
390
self._byid[entry.file_id] = entry
359
self._tree[entry.parent_id][entry.name] = entry
361
if entry.kind == 'directory':
362
self._tree[entry.file_id] = {}
391
parent.children[entry.name] = entry
365
395
def add_path(self, relpath, kind, file_id=None):
366
396
"""Add entry from a path.
368
The immediate parent must already be versioned"""
398
The immediate parent must already be versioned.
400
Returns the new entry object."""
401
from bzrlib.branch import gen_file_id
369
403
parts = bzrlib.osutils.splitpath(relpath)
370
404
if len(parts) == 0:
371
bailout("cannot re-add root of inventory")
374
file_id = bzrlib.branch.gen_file_id(relpath)
376
parent_id = self.path2id(parts[:-1])
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)
377
415
ie = InventoryEntry(file_id, parts[-1],
378
416
kind=kind, parent_id=parent_id)
379
417
return self.add(ie)
393
432
ie = self[file_id]
395
assert self._tree[ie.parent_id][ie.name] == ie
434
assert self[ie.parent_id].children[ie.name] == ie
397
436
# TODO: Test deleting all children; maybe hoist to a separate
398
437
# deltree method?
399
438
if ie.kind == 'directory':
400
for cie in self._tree[file_id].values():
439
for cie in ie.children.values():
401
440
del self[cie.file_id]
402
del self._tree[file_id]
404
443
del self._byid[file_id]
405
del self._tree[ie.parent_id][ie.name]
409
return Set(self._byid)
412
def to_element(self):
413
"""Convert to XML Element"""
414
e = Element('inventory')
416
for path, ie in self.iter_entries():
417
e.append(ie.to_element())
421
def from_element(cls, elt):
422
"""Construct from XML Element
424
>>> inv = Inventory()
425
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
426
>>> elt = inv.to_element()
427
>>> inv2 = Inventory.from_element(elt)
431
assert elt.tag == 'inventory'
434
o.add(InventoryEntry.from_element(e))
437
from_element = classmethod(from_element)
440
def __cmp__(self, other):
444
del self[ie.parent_id].children[ie.name]
447
def __eq__(self, other):
441
448
"""Compare two sets by comparing their contents.
443
450
>>> i1 = Inventory()
444
451
>>> i2 = Inventory()
447
>>> i1.add(InventoryEntry('123', 'foo'))
454
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
455
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
450
>>> i2.add(InventoryEntry('123', 'foo'))
458
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
459
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
457
463
if not isinstance(other, Inventory):
458
464
return NotImplemented
460
if self.id_set() ^ other.id_set():
463
for file_id in self._byid:
464
c = cmp(self[file_id], other[file_id])
470
def id2path(self, file_id):
471
"""Return as a list the path to file_id."""
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.
473
490
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)
476
496
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)
487
515
This returns the entry of the last component in the path,
488
516
which may be either a file or a directory.
518
Returns None iff the path is not found.
490
520
if isinstance(name, types.StringTypes):
491
521
name = splitpath(name)
523
mutter("lookup path %r" % name)
496
cie = self._tree[parent_id][f]
528
cie = parent.children[f]
497
529
assert cie.name == f
498
parent_id = cie.file_id
530
assert cie.parent_id == parent.file_id
500
533
# or raise an error?
506
def get_child(self, parent_id, child_name):
507
return self._tree[parent_id].get(child_name)
536
return parent.file_id
510
539
def has_filename(self, names):
514
543
def has_id(self, file_id):
515
assert isinstance(file_id, str)
516
544
return self._byid.has_key(file_id)
522
if __name__ == '__main__':
523
import doctest, inventory
524
doctest.testmod(inventory)
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))
added
removed
bzrlib/inventory.py
