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>"
24
18
# This should really be an id randomly assigned when the tree is
25
19
# created, but it's not for now.
29
23
import sys, os.path, types, re
33
26
from cElementTree import Element, ElementTree, SubElement
34
27
except ImportError:
35
28
from elementtree.ElementTree import Element, ElementTree, SubElement
37
from xml import XMLMixin
38
from errors import bailout, BzrError
30
from bzrlib.xml import XMLMixin
31
from bzrlib.errors import BzrError, BzrCheckError
41
34
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
75
68
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
76
69
Traceback (most recent call last):
78
BzrError: ('inventory already contains entry with id {2323}', [])
71
BzrError: inventory already contains entry with id {2323}
79
72
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
80
73
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
81
74
>>> i.path2id('src/wibble')
97
90
>>> i.id2path('2326')
98
91
'src/wibble/wibble.c'
100
:todo: Maybe also keep the full path of the entry, and the children?
93
TODO: Maybe also keep the full path of the entry, and the children?
101
94
But those depend on its position within a particular inventory, and
102
95
it would be nice not to need to hold the backpointer here.
105
98
# TODO: split InventoryEntry into subclasses for files,
106
99
# directories, etc etc.
108
104
def __init__(self, file_id, name, kind, parent_id, text_id=None):
109
105
"""Create an InventoryEntry
119
115
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
120
116
Traceback (most recent call last):
121
BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
117
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
124
if len(splitpath(name)) != 1:
125
bailout('InventoryEntry name is not a simple filename: %r'
119
if '/' in name or '\\' in name:
120
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
128
122
self.file_id = file_id
130
assert kind in ['file', 'directory']
132
125
self.text_id = text_id
133
126
self.parent_id = parent_id
134
self.text_sha1 = None
135
self.text_size = None
136
127
if kind == 'directory':
137
128
self.children = {}
139
assert kind == 'file'
132
raise BzrError("unhandled entry kind %r" % kind)
142
136
def sorted_children(self):
150
144
self.parent_id, text_id=self.text_id)
151
145
other.text_sha1 = self.text_sha1
152
146
other.text_size = self.text_size
147
# note that children are *not* copied; they're pulled across when
215
211
from_element = classmethod(from_element)
217
def __cmp__(self, other):
213
def __eq__(self, other):
220
214
if not isinstance(other, InventoryEntry):
221
215
return NotImplemented
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)
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')
238
239
self.parent_id = None
241
def __cmp__(self, other):
242
def __eq__(self, other):
244
243
if not isinstance(other, RootEntry):
245
244
return NotImplemented
246
return cmp(self.file_id, other.file_id) \
247
or cmp(self.children, other.children)
246
return (self.file_id == other.file_id) \
247
and (self.children == other.children)
251
251
class Inventory(XMLMixin):
252
252
"""Inventory of versioned files in a tree.
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.
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.
261
258
The inventory represents a typical unix file tree, with
262
259
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
309
294
def __init__(self):
310
295
"""Create or read an inventory.
344
329
if ie.kind == 'directory':
345
330
for cn, cie in self.iter_entries(from_dir=ie.file_id):
346
yield '/'.join((name, cn)), cie
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.
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))
346
if ie.kind == 'directory':
347
descend(ie, child_path)
349
descend(self.root, '')
350
353
def directories(self):
351
"""Return (path, entry) pairs for all directories.
354
"""Return (path, entry) pairs for all directories, including the root.
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():
360
if ie.kind == 'directory':
361
dn.append((ie.name, ie))
357
def descend(parent_ie, parent_path):
358
accum.append((parent_path, parent_ie))
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
360
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
368
for name, ie in descend(self.root):
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, '')
391
389
>>> inv['123123'].name
395
raise BzrError("can't look up file_id None")
398
393
return self._byid[file_id]
400
raise BzrError("file_id {%s} not in inventory" % 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
403
404
def get_child(self, parent_id, filename):
404
405
return self[parent_id].children.get(filename)
410
411
To add a file to a branch ready to be committed, use Branch.add,
411
412
which calls this."""
412
413
if entry.file_id in self._byid:
413
bailout("inventory already contains entry with id {%s}" % entry.file_id)
414
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
416
417
parent = self._byid[entry.parent_id]
418
bailout("parent_id {%s} not in inventory" % entry.parent_id)
419
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
420
421
if parent.children.has_key(entry.name):
421
bailout("%s is already versioned" %
422
raise BzrError("%s is already versioned" %
422
423
appendpath(self.id2path(parent.file_id), entry.name))
424
425
self._byid[entry.file_id] = entry
429
430
"""Add entry from a path.
431
432
The immediate parent must already be versioned"""
433
from bzrlib.errors import NotVersionedError
432
435
parts = bzrlib.osutils.splitpath(relpath)
433
436
if len(parts) == 0:
434
bailout("cannot re-add root of inventory")
437
raise BzrError("cannot re-add root of inventory")
436
439
if file_id == None:
437
440
file_id = bzrlib.branch.gen_file_id(relpath)
439
parent_id = self.path2id(parts[:-1])
440
assert parent_id != None
442
parent_path = parts[:-1]
443
parent_id = self.path2id(parent_path)
444
if parent_id == None:
445
raise NotVersionedError(parent_path)
441
447
ie = InventoryEntry(file_id, parts[-1],
442
448
kind=kind, parent_id=parent_id)
443
449
return self.add(ie)
521
520
if not isinstance(other, Inventory):
522
521
return NotImplemented
524
if self.id_set() ^ other.id_set():
527
for file_id in self._byid:
528
c = cmp(self[file_id], other[file_id])
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')
534
539
def get_idpath(self, file_id):
605
610
This does not move the working file."""
606
611
if not is_valid_name(new_name):
607
bailout("not an acceptable filename: %r" % new_name)
612
raise BzrError("not an acceptable filename: %r" % new_name)
609
614
new_parent = self._byid[new_parent_id]
610
615
if new_name in new_parent.children:
611
bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
616
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
613
618
new_parent_idpath = self.get_idpath(new_parent_id)
614
619
if file_id in new_parent_idpath:
615
bailout("cannot move directory %r into a subdirectory of itself, %r"
620
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
616
621
% (self.id2path(file_id), self.id2path(new_parent_id)))
618
623
file_ie = self._byid[file_id]
added
removed
bzrlib/inventory.py
