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 import Element, ElementTree, SubElement
32
from xml import XMLMixin
33
from errors import bailout
34
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
35
from trace import mutter
37
class InventoryEntry(XMLMixin):
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.branch import gen_file_id
31
from bzrlib.errors import NotVersionedError
34
class InventoryEntry(object):
38
35
"""Description of a versioned file.
40
37
An InventoryEntry has the following fields, which are also
58
55
>>> i = Inventory()
60
>>> i.add(InventoryEntry('123', 'src', kind='directory'))
61
>>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
58
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
59
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
62
60
>>> for j in i.iter_entries():
65
('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
63
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
66
64
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
67
>>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
65
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
68
66
Traceback (most recent call last):
70
BzrError: ('inventory already contains entry with id {2323}', [])
71
>>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
72
>>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
68
BzrError: inventory already contains entry with id {2323}
69
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
70
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
73
71
>>> i.path2id('src/wibble')
77
>>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
75
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
77
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
78
>>> for j in i.iter_entries():
89
87
>>> i.id2path('2326')
90
88
'src/wibble/wibble.c'
92
:todo: Maybe also keep the full path of the entry, and the children?
90
TODO: Maybe also keep the full path of the entry, and the children?
93
91
But those depend on its position within a particular inventory, and
94
92
it would be nice not to need to hold the backpointer here.
96
def __init__(self, file_id, name, kind='file', text_id=None,
95
# TODO: split InventoryEntry into subclasses for files,
96
# directories, etc etc.
98
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
99
'text_id', 'parent_id', 'children', ]
101
def __init__(self, file_id, name, kind, parent_id, text_id=None):
98
102
"""Create an InventoryEntry
100
104
The filename must be a single component, relative to the
101
105
parent directory; it cannot be a whole path or relative name.
103
>>> e = InventoryEntry('123', 'hello.c')
107
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
108
>>> e = InventoryEntry('123', 'src/hello.c')
112
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
109
113
Traceback (most recent call last):
110
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
114
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
113
if len(splitpath(name)) != 1:
114
bailout('InventoryEntry name is not a simple filename: %r'
116
if '/' in name or '\\' in name:
117
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
119
self.text_sha1 = None
120
self.text_size = None
117
122
self.file_id = file_id
119
assert kind in ['file', 'directory']
121
125
self.text_id = text_id
122
126
self.parent_id = parent_id
123
self.text_sha1 = None
124
self.text_size = None
127
if kind == 'directory':
132
raise BzrError("unhandled entry kind %r" % kind)
136
def sorted_children(self):
137
l = self.children.items()
128
143
other = InventoryEntry(self.file_id, self.name, self.kind,
129
self.text_id, self.parent_id)
144
self.parent_id, text_id=self.text_id)
130
145
other.text_sha1 = self.text_sha1
131
146
other.text_size = self.text_size
147
# note that children are *not* copied; they're pulled across when
144
161
def to_element(self):
145
162
"""Convert to XML element"""
163
from bzrlib.xml import Element
146
165
e = Element('entry')
148
167
e.set('name', self.name)
149
168
e.set('file_id', self.file_id)
150
169
e.set('kind', self.kind)
152
if self.text_size is not None:
171
if self.text_size != None:
153
172
e.set('text_size', '%d' % self.text_size)
155
for f in ['text_id', 'text_sha1', 'parent_id']:
174
for f in ['text_id', 'text_sha1']:
156
175
v = getattr(self, f)
179
# to be conservative, we don't externalize the root pointers
180
# for now, leaving them as null in the xml form. in a future
181
# version it will be implied by nested elements.
182
if self.parent_id != ROOT_ID:
183
assert isinstance(self.parent_id, basestring)
184
e.set('parent_id', self.parent_id)
165
191
def from_element(cls, elt):
166
192
assert elt.tag == 'entry'
167
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
194
## original format inventories don't have a parent_id for
195
## nodes in the root directory, but it's cleaner to use one
197
parent_id = elt.get('parent_id')
198
if parent_id == None:
201
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
168
202
self.text_id = elt.get('text_id')
169
203
self.text_sha1 = elt.get('text_sha1')
170
self.parent_id = elt.get('parent_id')
172
205
## mutter("read inventoryentry: %r" % (elt.attrib))
180
213
from_element = classmethod(from_element)
182
def __cmp__(self, other):
215
def __eq__(self, other):
185
216
if not isinstance(other, InventoryEntry):
186
217
return NotImplemented
188
return cmp(self.file_id, other.file_id) \
189
or cmp(self.name, other.name) \
190
or cmp(self.text_sha1, other.text_sha1) \
191
or cmp(self.text_size, other.text_size) \
192
or cmp(self.text_id, other.text_id) \
193
or cmp(self.parent_id, other.parent_id) \
194
or cmp(self.kind, other.kind)
198
class Inventory(XMLMixin):
219
return (self.file_id == other.file_id) \
220
and (self.name == other.name) \
221
and (self.text_sha1 == other.text_sha1) \
222
and (self.text_size == other.text_size) \
223
and (self.text_id == other.text_id) \
224
and (self.parent_id == other.parent_id) \
225
and (self.kind == other.kind)
228
def __ne__(self, other):
229
return not (self == other)
232
raise ValueError('not hashable')
236
class RootEntry(InventoryEntry):
237
def __init__(self, file_id):
238
self.file_id = file_id
240
self.kind = 'root_directory'
241
self.parent_id = None
244
def __eq__(self, other):
245
if not isinstance(other, RootEntry):
246
return NotImplemented
248
return (self.file_id == other.file_id) \
249
and (self.children == other.children)
253
class Inventory(object):
199
254
"""Inventory of versioned files in a tree.
201
An Inventory acts like a set of InventoryEntry items. You can
202
also look files up by their file_id or name.
204
May be read from and written to a metadata file in a tree. To
205
manipulate the inventory (for example to add a file), it is read
206
in, modified, and then written back out.
256
This describes which file_id is present at each point in the tree,
257
and possibly the SHA-1 or other information about the file.
258
Entries can be looked up either by path or by file_id.
208
260
The inventory represents a typical unix file tree, with
209
261
directories containing files and subdirectories. We never store
213
265
returned quickly.
215
267
InventoryEntry objects must not be modified after they are
268
inserted, other than through the Inventory API.
218
270
>>> inv = Inventory()
219
>>> inv.write_xml(sys.stdout)
222
>>> inv.add(InventoryEntry('123-123', 'hello.c'))
271
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
223
272
>>> inv['123-123'].name
225
>>> for file_id in inv: print file_id
229
275
May be treated as an iterator or set to look up file ids:
238
284
>>> [x[0] for x in inv.iter_entries()]
241
>>> inv.write_xml(sys.stdout)
243
<entry file_id="123-123" kind="file" name="hello.c" />
286
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
287
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
248
## TODO: Clear up handling of files in subdirectories; we probably
249
## do want to be able to just look them up by name but this
250
## probably means gradually walking down the path, looking up as we go.
252
## TODO: Make sure only canonical filenames are stored.
254
## TODO: Do something sensible about the possible collisions on
255
## case-losing filesystems. Perhaps we should just always forbid
258
## _tree should probably just be stored as
259
## InventoryEntry._children on each directory.
289
def __init__(self, root_id=ROOT_ID):
262
290
"""Create or read an inventory.
264
292
If a working directory is specified, the inventory is read
265
293
from there. If the file is specified, read from that. If not,
266
294
the inventory is created empty.
296
The inventory is created with a default root directory, with
270
# _tree is indexed by parent_id; at each level a map from name
271
# to ie. The None entry is the root.
272
self._tree = {None: {}}
299
# We are letting Branch(init=True) create a unique inventory
300
# root id. Rather than generating a random one here.
302
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
303
self.root = RootEntry(root_id)
304
self._byid = {self.root.file_id: self.root}
275
307
def __iter__(self):
281
313
return len(self._byid)
284
def iter_entries(self, parent_id=None):
316
def iter_entries(self, from_dir=None):
285
317
"""Return (path, entry) pairs, in order by name."""
286
kids = self._tree[parent_id].items()
321
elif isinstance(from_dir, basestring):
322
from_dir = self._byid[from_dir]
324
kids = from_dir.children.items()
288
326
for name, ie in kids:
290
328
if ie.kind == 'directory':
291
for cn, cie in self.iter_entries(parent_id=ie.file_id):
292
yield joinpath([name, cn]), cie
295
def directories(self, include_root=True):
296
"""Return (path, entry) pairs for all directories.
300
for path, entry in self.iter_entries():
301
if entry.kind == 'directory':
329
for cn, cie in self.iter_entries(from_dir=ie.file_id):
330
yield os.path.join(name, cn), cie
334
"""Return list of (path, ie) for all entries except the root.
336
This may be faster than iter_entries.
339
def descend(dir_ie, dir_path):
340
kids = dir_ie.children.items()
342
for name, ie in kids:
343
child_path = os.path.join(dir_path, name)
344
accum.append((child_path, ie))
345
if ie.kind == 'directory':
346
descend(ie, child_path)
348
descend(self.root, '')
352
def directories(self):
353
"""Return (path, entry) pairs for all directories, including the root.
356
def descend(parent_ie, parent_path):
357
accum.append((parent_path, parent_ie))
359
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
362
for name, child_ie in kids:
363
child_path = os.path.join(parent_path, name)
364
descend(child_ie, child_path)
365
descend(self.root, '')
306
def children(self, parent_id):
307
"""Return entries that are direct children of parent_id."""
308
return self._tree[parent_id]
312
# TODO: return all paths and entries
315
370
def __contains__(self, file_id):
316
371
"""True if this entry contains a file with given id.
318
373
>>> inv = Inventory()
319
>>> inv.add(InventoryEntry('123', 'foo.c'))
374
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
329
384
"""Return the entry for given file_id.
331
386
>>> inv = Inventory()
332
>>> inv.add(InventoryEntry('123123', 'hello.c'))
387
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
333
388
>>> inv['123123'].name
336
return self._byid[file_id]
392
return self._byid[file_id]
395
raise BzrError("can't look up file_id None")
397
raise BzrError("file_id {%s} not in inventory" % file_id)
400
def get_file_kind(self, file_id):
401
return self._byid[file_id].kind
403
def get_child(self, parent_id, filename):
404
return self[parent_id].children.get(filename)
339
407
def add(self, entry):
342
410
To add a file to a branch ready to be committed, use Branch.add,
343
411
which calls this."""
344
if entry.file_id in self:
345
bailout("inventory already contains entry with id {%s}" % entry.file_id)
347
if entry.parent_id != None:
348
if entry.parent_id not in self:
349
bailout("parent_id %s of new entry not found in inventory"
352
if self._tree[entry.parent_id].has_key(entry.name):
353
bailout("%s is already versioned"
354
% appendpath(self.id2path(entry.parent_id), entry.name))
412
if entry.file_id in self._byid:
413
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
415
if entry.parent_id == ROOT_ID or entry.parent_id is None:
416
entry.parent_id = self.root.file_id
419
parent = self._byid[entry.parent_id]
421
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
423
if parent.children.has_key(entry.name):
424
raise BzrError("%s is already versioned" %
425
appendpath(self.id2path(parent.file_id), entry.name))
356
427
self._byid[entry.file_id] = entry
357
self._tree[entry.parent_id][entry.name] = entry
359
if entry.kind == 'directory':
360
self._tree[entry.file_id] = {}
428
parent.children[entry.name] = entry
431
def add_path(self, relpath, kind, file_id=None):
432
"""Add entry from a path.
434
The immediate parent must already be versioned"""
435
parts = bzrlib.osutils.splitpath(relpath)
437
raise BzrError("cannot re-add root of inventory")
440
file_id = gen_file_id(relpath)
442
parent_path = parts[:-1]
443
parent_id = self.path2id(parent_path)
444
if parent_id == None:
445
raise NotVersionedError(parent_path)
447
ie = InventoryEntry(file_id, parts[-1],
448
kind=kind, parent_id=parent_id)
363
452
def __delitem__(self, file_id):
364
453
"""Remove entry by id.
366
455
>>> inv = Inventory()
367
>>> inv.add(InventoryEntry('123', 'foo.c'))
456
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
370
459
>>> del inv['123']
374
463
ie = self[file_id]
376
assert self._tree[ie.parent_id][ie.name] == ie
465
assert self[ie.parent_id].children[ie.name] == ie
378
467
# TODO: Test deleting all children; maybe hoist to a separate
379
468
# deltree method?
380
469
if ie.kind == 'directory':
381
for cie in self._tree[file_id].values():
470
for cie in ie.children.values():
382
471
del self[cie.file_id]
383
del self._tree[file_id]
385
474
del self._byid[file_id]
386
del self._tree[ie.parent_id][ie.name]
390
return Set(self._byid)
475
del self[ie.parent_id].children[ie.name]
393
478
def to_element(self):
394
479
"""Convert to XML Element"""
480
from bzrlib.xml import Element
395
482
e = Element('inventory')
484
if self.root.file_id not in (None, ROOT_ID):
485
e.set('file_id', self.root.file_id)
397
486
for path, ie in self.iter_entries():
398
487
e.append(ie.to_element())
402
491
def from_element(cls, elt):
403
492
"""Construct from XML Element
405
494
>>> inv = Inventory()
406
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
495
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
407
496
>>> elt = inv.to_element()
408
497
>>> inv2 = Inventory.from_element(elt)
501
# XXXX: doctest doesn't run this properly under python2.3
412
502
assert elt.tag == 'inventory'
503
root_id = elt.get('file_id') or ROOT_ID
415
o.add(InventoryEntry.from_element(e))
506
ie = InventoryEntry.from_element(e)
507
if ie.parent_id == ROOT_ID:
508
ie.parent_id = root_id
418
512
from_element = classmethod(from_element)
421
def __cmp__(self, other):
515
def __eq__(self, other):
422
516
"""Compare two sets by comparing their contents.
424
518
>>> i1 = Inventory()
425
519
>>> i2 = Inventory()
428
>>> i1.add(InventoryEntry('123', 'foo'))
522
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
431
>>> i2.add(InventoryEntry('123', 'foo'))
525
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
438
529
if not isinstance(other, Inventory):
439
530
return NotImplemented
441
if self.id_set() ^ other.id_set():
444
for file_id in self._byid:
445
c = cmp(self[file_id], other[file_id])
451
def id2path(self, file_id):
452
"""Return as a list the path to file_id."""
532
if len(self._byid) != len(other._byid):
533
# shortcut: obviously not the same
536
return self._byid == other._byid
539
def __ne__(self, other):
540
return not (self == other)
544
raise ValueError('not hashable')
548
def get_idpath(self, file_id):
549
"""Return a list of file_ids for the path to an entry.
551
The list contains one element for each directory followed by
552
the id of the file itself. So the length of the returned list
553
is equal to the depth of the file in the tree, counting the
554
root directory as depth 1.
454
557
while file_id != None:
559
ie = self._byid[file_id]
561
raise BzrError("file_id {%s} not found in inventory" % file_id)
562
p.insert(0, ie.file_id)
457
563
file_id = ie.parent_id
567
def id2path(self, file_id):
568
"""Return as a list the path to file_id."""
570
# get all names, skipping root
571
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
572
return os.sep.join(p)
468
582
This returns the entry of the last component in the path,
469
583
which may be either a file or a directory.
585
Returns None iff the path is not found.
471
assert isinstance(name, types.StringTypes)
474
for f in splitpath(name):
587
if isinstance(name, types.StringTypes):
588
name = splitpath(name)
590
mutter("lookup path %r" % name)
476
cie = self._tree[parent_id][f]
595
cie = parent.children[f]
477
596
assert cie.name == f
478
parent_id = cie.file_id
597
assert cie.parent_id == parent.file_id
480
600
# or raise an error?
486
def get_child(self, parent_id, child_name):
487
return self._tree[parent_id].get(child_name)
603
return parent.file_id
490
606
def has_filename(self, names):
494
610
def has_id(self, file_id):
495
assert isinstance(file_id, str)
496
611
return self._byid.has_key(file_id)
500
if __name__ == '__main__':
501
import doctest, inventory
502
doctest.testmod(inventory)
614
def rename(self, file_id, new_parent_id, new_name):
615
"""Move a file within the inventory.
617
This can change either the name, or the parent, or both.
619
This does not move the working file."""
620
if not is_valid_name(new_name):
621
raise BzrError("not an acceptable filename: %r" % new_name)
623
new_parent = self._byid[new_parent_id]
624
if new_name in new_parent.children:
625
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
627
new_parent_idpath = self.get_idpath(new_parent_id)
628
if file_id in new_parent_idpath:
629
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
630
% (self.id2path(file_id), self.id2path(new_parent_id)))
632
file_ie = self._byid[file_id]
633
old_parent = self._byid[file_ie.parent_id]
635
# TODO: Don't leave things messed up if this fails
637
del old_parent.children[file_ie.name]
638
new_parent.children[new_name] = file_ie
640
file_ie.name = new_name
641
file_ie.parent_id = new_parent_id
646
_NAME_RE = re.compile(r'^[^/\\]+$')
648
def is_valid_name(name):
649
return bool(_NAME_RE.match(name))