14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
"""Inventories map files to their name in a revision."""
19
# TODO: Maybe store inventory_id in the file? Not really needed.
21
__author__ = "Martin Pool <mbp@canonical.com>"
18
24
# This should really be an id randomly assigned when the tree is
19
25
# created, but it's not for now.
23
29
import sys, os.path, types, re
26
33
from cElementTree import Element, ElementTree, SubElement
27
34
except ImportError:
28
35
from elementtree.ElementTree import Element, ElementTree, SubElement
30
from bzrlib.xml import XMLMixin
31
from bzrlib.errors import BzrError, BzrCheckError
37
from xml import XMLMixin
38
from errors import bailout, BzrError
34
41
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
68
75
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
69
76
Traceback (most recent call last):
71
BzrError: inventory already contains entry with id {2323}
78
BzrError: ('inventory already contains entry with id {2323}', [])
72
79
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
73
80
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
74
81
>>> i.path2id('src/wibble')
90
97
>>> i.id2path('2326')
91
98
'src/wibble/wibble.c'
93
TODO: Maybe also keep the full path of the entry, and the children?
100
:todo: Maybe also keep the full path of the entry, and the children?
94
101
But those depend on its position within a particular inventory, and
95
102
it would be nice not to need to hold the backpointer here.
98
105
# TODO: split InventoryEntry into subclasses for files,
99
106
# directories, etc etc.
104
108
def __init__(self, file_id, name, kind, parent_id, text_id=None):
105
109
"""Create an InventoryEntry
115
119
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
116
120
Traceback (most recent call last):
117
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
121
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
119
if '/' in name or '\\' in name:
120
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
124
if len(splitpath(name)) != 1:
125
bailout('InventoryEntry name is not a simple filename: %r'
122
128
self.file_id = file_id
130
assert kind in ['file', 'directory']
125
132
self.text_id = text_id
126
133
self.parent_id = parent_id
134
self.text_sha1 = None
135
self.text_size = None
127
136
if kind == 'directory':
128
137
self.children = {}
132
raise BzrError("unhandled entry kind %r" % kind)
139
assert kind == 'file'
136
142
def sorted_children(self):
144
150
self.parent_id, text_id=self.text_id)
145
151
other.text_sha1 = self.text_sha1
146
152
other.text_size = self.text_size
147
# note that children are *not* copied; they're pulled across when
211
215
from_element = classmethod(from_element)
213
def __eq__(self, other):
217
def __cmp__(self, other):
214
220
if not isinstance(other, InventoryEntry):
215
221
return NotImplemented
217
return (self.file_id == other.file_id) \
218
and (self.name == other.name) \
219
and (self.text_sha1 == other.text_sha1) \
220
and (self.text_size == other.text_size) \
221
and (self.text_id == other.text_id) \
222
and (self.parent_id == other.parent_id) \
223
and (self.kind == other.kind)
226
def __ne__(self, other):
227
return not (self == other)
230
raise ValueError('not hashable')
223
return cmp(self.file_id, other.file_id) \
224
or cmp(self.name, other.name) \
225
or cmp(self.text_sha1, other.text_sha1) \
226
or cmp(self.text_size, other.text_size) \
227
or cmp(self.text_id, other.text_id) \
228
or cmp(self.parent_id, other.parent_id) \
229
or cmp(self.kind, other.kind)
239
238
self.parent_id = None
242
def __eq__(self, other):
241
def __cmp__(self, other):
243
244
if not isinstance(other, RootEntry):
244
245
return NotImplemented
246
return (self.file_id == other.file_id) \
247
and (self.children == other.children)
246
return cmp(self.file_id, other.file_id) \
247
or cmp(self.children, other.children)
251
251
class Inventory(XMLMixin):
252
252
"""Inventory of versioned files in a tree.
254
This describes which file_id is present at each point in the tree,
255
and possibly the SHA-1 or other information about the file.
256
Entries can be looked up either by path or by file_id.
254
An Inventory acts like a set of InventoryEntry items. You can
255
also look files up by their file_id or name.
257
May be read from and written to a metadata file in a tree. To
258
manipulate the inventory (for example to add a file), it is read
259
in, modified, and then written back out.
258
261
The inventory represents a typical unix file tree, with
259
262
directories containing files and subdirectories. We never store
298
## TODO: Make sure only canonical filenames are stored.
300
## TODO: Do something sensible about the possible collisions on
301
## case-losing filesystems. Perhaps we should just always forbid
304
## TODO: No special cases for root, rather just give it a file id
305
## like everything else.
307
## TODO: Probably change XML serialization to use nesting
294
309
def __init__(self):
295
310
"""Create or read an inventory.
329
344
if ie.kind == 'directory':
330
345
for cn, cie in self.iter_entries(from_dir=ie.file_id):
331
yield os.path.join(name, cn), cie
335
"""Return list of (path, ie) for all entries except the root.
337
This may be faster than iter_entries.
346
yield '/'.join((name, cn)), cie
350
def directories(self):
351
"""Return (path, entry) pairs for all directories.
340
def descend(dir_ie, dir_path):
341
kids = dir_ie.children.items()
343
for name, ie in kids:
344
child_path = os.path.join(dir_path, name)
345
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():
346
360
if ie.kind == 'directory':
347
descend(ie, child_path)
349
descend(self.root, '')
353
def directories(self):
354
"""Return (path, entry) pairs for all directories, including the root.
357
def descend(parent_ie, parent_path):
358
accum.append((parent_path, parent_ie))
361
dn.append((ie.name, ie))
360
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
363
for name, child_ie in kids:
364
child_path = os.path.join(parent_path, name)
365
descend(child_ie, child_path)
366
descend(self.root, '')
368
for name, ie in descend(self.root):
389
391
>>> inv['123123'].name
395
raise BzrError("can't look up file_id None")
393
398
return self._byid[file_id]
396
raise BzrError("can't look up file_id None")
398
raise BzrError("file_id {%s} not in inventory" % file_id)
401
def get_file_kind(self, file_id):
402
return self._byid[file_id].kind
400
raise BzrError("file_id {%s} not in inventory" % file_id)
404
403
def get_child(self, parent_id, filename):
405
404
return self[parent_id].children.get(filename)
411
410
To add a file to a branch ready to be committed, use Branch.add,
412
411
which calls this."""
413
412
if entry.file_id in self._byid:
414
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
413
bailout("inventory already contains entry with id {%s}" % entry.file_id)
417
416
parent = self._byid[entry.parent_id]
419
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
418
bailout("parent_id {%s} not in inventory" % entry.parent_id)
421
420
if parent.children.has_key(entry.name):
422
raise BzrError("%s is already versioned" %
421
bailout("%s is already versioned" %
423
422
appendpath(self.id2path(parent.file_id), entry.name))
425
424
self._byid[entry.file_id] = entry
430
429
"""Add entry from a path.
432
431
The immediate parent must already be versioned"""
433
from bzrlib.errors import NotVersionedError
435
432
parts = bzrlib.osutils.splitpath(relpath)
436
433
if len(parts) == 0:
437
raise BzrError("cannot re-add root of inventory")
434
bailout("cannot re-add root of inventory")
439
436
if file_id == None:
440
437
file_id = bzrlib.branch.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)
439
parent_id = self.path2id(parts[:-1])
440
assert parent_id != None
447
441
ie = InventoryEntry(file_id, parts[-1],
448
442
kind=kind, parent_id=parent_id)
449
443
return self.add(ie)
520
521
if not isinstance(other, Inventory):
521
522
return NotImplemented
523
if len(self._byid) != len(other._byid):
524
# shortcut: obviously not the same
527
return self._byid == other._byid
530
def __ne__(self, other):
531
return not (self == other)
535
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])
539
534
def get_idpath(self, file_id):
610
605
This does not move the working file."""
611
606
if not is_valid_name(new_name):
612
raise BzrError("not an acceptable filename: %r" % new_name)
607
bailout("not an acceptable filename: %r" % new_name)
614
609
new_parent = self._byid[new_parent_id]
615
610
if new_name in new_parent.children:
616
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)))
618
613
new_parent_idpath = self.get_idpath(new_parent_id)
619
614
if file_id in new_parent_idpath:
620
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
615
bailout("cannot move directory %r into a subdirectory of itself, %r"
621
616
% (self.id2path(file_id), self.id2path(new_parent_id)))
623
618
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
