15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
# TODO: Maybe store inventory_id in the file? Not really needed.
18
21
# This should really be an id randomly assigned when the tree is
19
22
# created, but it's not for now.
20
23
ROOT_ID = "TREE_ROOT"
23
26
import sys, os.path, types, re
30
from cElementTree import Element, ElementTree, SubElement
32
from elementtree.ElementTree import Element, ElementTree, SubElement
34
from xml import XMLMixin
35
from errors import bailout, BzrError
26
from bzrlib.errors import BzrError, BzrCheckError
28
38
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
39
from bzrlib.trace import mutter
31
class InventoryEntry(object):
41
class InventoryEntry(XMLMixin):
32
42
"""Description of a versioned file.
34
44
An InventoryEntry has the following fields, which are also
62
72
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
63
73
Traceback (most recent call last):
65
BzrError: inventory already contains entry with id {2323}
75
BzrError: ('inventory already contains entry with id {2323}', [])
66
76
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
67
77
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
68
78
>>> i.path2id('src/wibble')
92
102
# TODO: split InventoryEntry into subclasses for files,
93
103
# directories, etc etc.
98
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
99
106
"""Create an InventoryEntry
109
116
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
110
117
Traceback (most recent call last):
111
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
118
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
113
if '/' in name or '\\' in name:
114
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
121
if len(splitpath(name)) != 1:
122
bailout('InventoryEntry name is not a simple filename: %r'
116
125
self.file_id = file_id
119
128
self.text_id = text_id
120
129
self.parent_id = parent_id
130
self.text_sha1 = None
131
self.text_size = None
121
132
if kind == 'directory':
122
133
self.children = {}
123
134
elif kind == 'file':
138
149
self.parent_id, text_id=self.text_id)
139
150
other.text_sha1 = self.text_sha1
140
151
other.text_size = self.text_size
141
# note that children are *not* copied; they're pulled across when
207
214
from_element = classmethod(from_element)
209
def __eq__(self, other):
216
def __cmp__(self, other):
210
219
if not isinstance(other, InventoryEntry):
211
220
return NotImplemented
213
return (self.file_id == other.file_id) \
214
and (self.name == other.name) \
215
and (self.text_sha1 == other.text_sha1) \
216
and (self.text_size == other.text_size) \
217
and (self.text_id == other.text_id) \
218
and (self.parent_id == other.parent_id) \
219
and (self.kind == other.kind)
222
def __ne__(self, other):
223
return not (self == other)
226
raise ValueError('not hashable')
222
return cmp(self.file_id, other.file_id) \
223
or cmp(self.name, other.name) \
224
or cmp(self.text_sha1, other.text_sha1) \
225
or cmp(self.text_size, other.text_size) \
226
or cmp(self.text_id, other.text_id) \
227
or cmp(self.parent_id, other.parent_id) \
228
or cmp(self.kind, other.kind)
235
237
self.parent_id = None
238
def __eq__(self, other):
240
def __cmp__(self, other):
239
243
if not isinstance(other, RootEntry):
240
244
return NotImplemented
242
return (self.file_id == other.file_id) \
243
and (self.children == other.children)
247
class Inventory(object):
245
return cmp(self.file_id, other.file_id) \
246
or cmp(self.children, other.children)
250
class Inventory(XMLMixin):
248
251
"""Inventory of versioned files in a tree.
250
253
This describes which file_id is present at each point in the tree,
262
265
inserted, other than through the Inventory API.
264
267
>>> inv = Inventory()
268
>>> inv.write_xml(sys.stdout)
265
271
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
266
272
>>> inv['123-123'].name
278
284
>>> [x[0] for x in inv.iter_entries()]
280
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
281
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
287
>>> inv.write_xml(sys.stdout)
289
<entry file_id="123-123" kind="file" name="hello.c" />
283
def __init__(self, root_id=ROOT_ID):
294
## TODO: Make sure only canonical filenames are stored.
296
## TODO: Do something sensible about the possible collisions on
297
## case-losing filesystems. Perhaps we should just always forbid
300
## TODO: No special cases for root, rather just give it a file id
301
## like everything else.
303
## TODO: Probably change XML serialization to use nesting rather
304
## than parent_id pointers.
306
## TODO: Perhaps hold the ElementTree in memory and work directly
307
## on that rather than converting into Python objects every time?
284
310
"""Create or read an inventory.
286
312
If a working directory is specified, the inventory is read
290
316
The inventory is created with a default root directory, with
293
# We are letting Branch(init=True) create a unique inventory
294
# root id. Rather than generating a random one here.
296
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
297
self.root = RootEntry(root_id)
319
self.root = RootEntry(ROOT_ID)
298
320
self._byid = {self.root.file_id: self.root}
322
344
if ie.kind == 'directory':
323
345
for cn, cie in self.iter_entries(from_dir=ie.file_id):
324
346
yield os.path.join(name, cn), cie
328
"""Return list of (path, ie) for all entries except the root.
330
This may be faster than iter_entries.
350
def directories(self):
351
"""Return (path, entry) pairs for all directories.
333
def descend(dir_ie, dir_path):
334
kids = dir_ie.children.items()
336
for name, ie in kids:
337
child_path = os.path.join(dir_path, name)
338
accum.append((child_path, ie))
353
def descend(parent_ie):
354
parent_name = parent_ie.name
355
yield parent_name, parent_ie
357
# directory children in sorted order
359
for ie in parent_ie.children.itervalues():
339
360
if ie.kind == 'directory':
340
descend(ie, child_path)
342
descend(self.root, '')
346
def directories(self):
347
"""Return (path, entry) pairs for all directories, including the root.
350
def descend(parent_ie, parent_path):
351
accum.append((parent_path, parent_ie))
361
dn.append((ie.name, ie))
353
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
364
for name, child_ie in dn:
365
for sub_name, sub_ie in descend(child_ie):
366
yield appendpath(parent_name, sub_name), sub_ie
356
for name, child_ie in kids:
357
child_path = os.path.join(parent_path, name)
358
descend(child_ie, child_path)
359
descend(self.root, '')
368
for name, ie in descend(self.root):
382
391
>>> inv['123123'].name
395
raise BzrError("can't look up file_id None")
386
398
return self._byid[file_id]
389
raise BzrError("can't look up file_id None")
391
raise BzrError("file_id {%s} not in inventory" % file_id)
394
def get_file_kind(self, file_id):
395
return self._byid[file_id].kind
400
raise BzrError("file_id {%s} not in inventory" % file_id)
397
403
def get_child(self, parent_id, filename):
398
404
return self[parent_id].children.get(filename)
404
410
To add a file to a branch ready to be committed, use Branch.add,
405
411
which calls this."""
406
412
if entry.file_id in self._byid:
407
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
409
if entry.parent_id == ROOT_ID or entry.parent_id is None:
410
entry.parent_id = self.root.file_id
413
bailout("inventory already contains entry with id {%s}" % entry.file_id)
413
416
parent = self._byid[entry.parent_id]
415
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
418
bailout("parent_id {%s} not in inventory" % entry.parent_id)
417
420
if parent.children.has_key(entry.name):
418
raise BzrError("%s is already versioned" %
421
bailout("%s is already versioned" %
419
422
appendpath(self.id2path(parent.file_id), entry.name))
421
424
self._byid[entry.file_id] = entry
426
429
"""Add entry from a path.
428
431
The immediate parent must already be versioned"""
429
from bzrlib.errors import NotVersionedError
431
432
parts = bzrlib.osutils.splitpath(relpath)
432
433
if len(parts) == 0:
433
raise BzrError("cannot re-add root of inventory")
434
bailout("cannot re-add root of inventory")
435
436
if file_id == None:
436
from bzrlib.branch import gen_file_id
437
file_id = gen_file_id(relpath)
439
parent_path = parts[:-1]
440
parent_id = self.path2id(parent_path)
441
if parent_id == None:
442
raise NotVersionedError(parent_path)
437
file_id = bzrlib.branch.gen_file_id(relpath)
439
parent_id = self.path2id(parts[:-1])
440
assert parent_id != None
444
441
ie = InventoryEntry(file_id, parts[-1],
445
442
kind=kind, parent_id=parent_id)
446
443
return self.add(ie)
472
469
del self[ie.parent_id].children[ie.name]
473
return Set(self._byid)
475
476
def to_element(self):
476
477
"""Convert to XML Element"""
477
from bzrlib.xml import Element
479
478
e = Element('inventory')
481
if self.root.file_id not in (None, ROOT_ID):
482
e.set('file_id', self.root.file_id)
483
480
for path, ie in self.iter_entries():
484
481
e.append(ie.to_element())
488
485
def from_element(cls, elt):
489
486
"""Construct from XML Element
491
488
>>> inv = Inventory()
492
489
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
493
490
>>> elt = inv.to_element()
498
# XXXX: doctest doesn't run this properly under python2.3
499
495
assert elt.tag == 'inventory'
500
root_id = elt.get('file_id') or ROOT_ID
503
ie = InventoryEntry.from_element(e)
504
if ie.parent_id == ROOT_ID:
505
ie.parent_id = root_id
498
o.add(InventoryEntry.from_element(e))
509
501
from_element = classmethod(from_element)
512
def __eq__(self, other):
504
def __cmp__(self, other):
513
505
"""Compare two sets by comparing their contents.
515
507
>>> i1 = Inventory()
526
521
if not isinstance(other, Inventory):
527
522
return NotImplemented
529
if len(self._byid) != len(other._byid):
530
# shortcut: obviously not the same
533
return self._byid == other._byid
536
def __ne__(self, other):
537
return not (self == other)
541
raise ValueError('not hashable')
524
if self.id_set() ^ other.id_set():
527
for file_id in self._byid:
528
c = cmp(self[file_id], other[file_id])
545
534
def get_idpath(self, file_id):
565
554
"""Return as a list the path to file_id."""
567
556
# get all names, skipping root
568
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
557
p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
569
558
return os.sep.join(p)
616
605
This does not move the working file."""
617
606
if not is_valid_name(new_name):
618
raise BzrError("not an acceptable filename: %r" % new_name)
607
bailout("not an acceptable filename: %r" % new_name)
620
609
new_parent = self._byid[new_parent_id]
621
610
if new_name in new_parent.children:
622
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
611
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
624
613
new_parent_idpath = self.get_idpath(new_parent_id)
625
614
if file_id in new_parent_idpath:
626
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
615
bailout("cannot move directory %r into a subdirectory of itself, %r"
627
616
% (self.id2path(file_id), self.id2path(new_parent_id)))
629
618
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
