1
# (C) 2005 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
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.errors import NotVersionedError
33
class InventoryEntry(object):
34
"""Description of a versioned file.
36
An InventoryEntry has the following fields, which are also
37
present in the XML inventory-entry element:
40
* *name*: (only the basename within the directory, must not
42
* *kind*: "directory" or "file"
43
* *directory_id*: (if absent/null means the branch root directory)
44
* *text_sha1*: only for files
45
* *text_size*: in bytes, only for files
46
* *text_id*: identifier for the text version, only for files
48
InventoryEntries can also exist inside a WorkingTree
49
inventory, in which case they are not yet bound to a
50
particular revision of the file. In that case the text_sha1,
51
text_size and text_id are absent.
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')
61
>>> for j in i.iter_entries():
64
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
65
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
66
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
67
Traceback (most recent call last):
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')
74
>>> i.path2id('src/wibble')
78
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
81
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
>>> for j in i.iter_entries():
84
... assert i.path2id(j[0])
94
TODO: Maybe also keep the full path of the entry, and the children?
95
But those depend on its position within a particular inventory, and
96
it would be nice not to need to hold the backpointer here.
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', 'symlink_target']
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
106
"""Create an InventoryEntry
108
The filename must be a single component, relative to the
109
parent directory; it cannot be a whole path or relative name.
111
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
116
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
117
Traceback (most recent call last):
118
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
120
if '/' in name or '\\' in name:
121
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
123
self.text_sha1 = None
124
self.text_size = None
126
self.file_id = file_id
129
self.text_id = text_id
130
self.parent_id = parent_id
131
self.symlink_target = None
132
if kind == 'directory':
136
elif kind == 'symlink':
139
raise BzrError("unhandled entry kind %r" % kind)
141
def read_symlink_target(self, path):
142
if self.kind == 'symlink':
144
self.symlink_target = os.readlink(path)
146
raise BzrError("os.readlink error, %s" % e)
148
def sorted_children(self):
149
l = self.children.items()
155
other = InventoryEntry(self.file_id, self.name, self.kind,
156
self.parent_id, text_id=self.text_id)
157
other.text_sha1 = self.text_sha1
158
other.text_size = self.text_size
159
other.symlink_target = self.symlink_target
160
# note that children are *not* copied; they're pulled across when
166
return ("%s(%r, %r, kind=%r, parent_id=%r)"
167
% (self.__class__.__name__,
174
def to_element(self):
175
"""Convert to XML element"""
176
from bzrlib.xml import Element
180
e.set('name', self.name)
181
e.set('file_id', self.file_id)
182
e.set('kind', self.kind)
184
if self.text_size != None:
185
e.set('text_size', '%d' % self.text_size)
187
for f in ['text_id', 'text_sha1', 'symlink_target']:
192
# to be conservative, we don't externalize the root pointers
193
# for now, leaving them as null in the xml form. in a future
194
# version it will be implied by nested elements.
195
if self.parent_id != ROOT_ID:
196
assert isinstance(self.parent_id, basestring)
197
e.set('parent_id', self.parent_id)
204
def from_element(cls, elt):
205
assert elt.tag == 'entry'
207
## original format inventories don't have a parent_id for
208
## nodes in the root directory, but it's cleaner to use one
210
parent_id = elt.get('parent_id')
211
if parent_id == None:
214
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
215
self.text_id = elt.get('text_id')
216
self.text_sha1 = elt.get('text_sha1')
217
self.symlink_target = elt.get('symlink_target')
219
## mutter("read inventoryentry: %r" % (elt.attrib))
221
v = elt.get('text_size')
222
self.text_size = v and int(v)
227
from_element = classmethod(from_element)
229
def __eq__(self, other):
230
if not isinstance(other, InventoryEntry):
231
return NotImplemented
233
return (self.file_id == other.file_id) \
234
and (self.name == other.name) \
235
and (other.symlink_target == self.symlink_target) \
236
and (self.text_sha1 == other.text_sha1) \
237
and (self.text_size == other.text_size) \
238
and (self.text_id == other.text_id) \
239
and (self.parent_id == other.parent_id) \
240
and (self.kind == other.kind)
243
def __ne__(self, other):
244
return not (self == other)
247
raise ValueError('not hashable')
251
class RootEntry(InventoryEntry):
252
def __init__(self, file_id):
253
self.file_id = file_id
255
self.kind = 'root_directory'
256
self.parent_id = None
259
def __eq__(self, other):
260
if not isinstance(other, RootEntry):
261
return NotImplemented
263
return (self.file_id == other.file_id) \
264
and (self.children == other.children)
268
class Inventory(object):
269
"""Inventory of versioned files in a tree.
271
This describes which file_id is present at each point in the tree,
272
and possibly the SHA-1 or other information about the file.
273
Entries can be looked up either by path or by file_id.
275
The inventory represents a typical unix file tree, with
276
directories containing files and subdirectories. We never store
277
the full path to a file, because renaming a directory implicitly
278
moves all of its contents. This class internally maintains a
279
lookup tree that allows the children under a directory to be
282
InventoryEntry objects must not be modified after they are
283
inserted, other than through the Inventory API.
285
>>> inv = Inventory()
286
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
287
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
288
>>> inv['123-123'].name
291
May be treated as an iterator or set to look up file ids:
293
>>> bool(inv.path2id('hello.c'))
298
May also look up by name:
300
>>> [x[0] for x in inv.iter_entries()]
302
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
303
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
304
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
306
def __init__(self, root_id=ROOT_ID):
307
"""Create or read an inventory.
309
If a working directory is specified, the inventory is read
310
from there. If the file is specified, read from that. If not,
311
the inventory is created empty.
313
The inventory is created with a default root directory, with
316
# We are letting Branch(init=True) create a unique inventory
317
# root id. Rather than generating a random one here.
319
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
320
self.root = RootEntry(root_id)
321
self._byid = {self.root.file_id: self.root}
325
return iter(self._byid)
329
"""Returns number of entries."""
330
return len(self._byid)
333
def iter_entries(self, from_dir=None):
334
"""Return (path, entry) pairs, in order by name."""
338
elif isinstance(from_dir, basestring):
339
from_dir = self._byid[from_dir]
341
kids = from_dir.children.items()
343
for name, ie in kids:
345
if ie.kind == 'directory':
346
for cn, cie in self.iter_entries(from_dir=ie.file_id):
347
yield os.path.join(name, cn), cie
351
"""Return list of (path, ie) for all entries except the root.
353
This may be faster than iter_entries.
356
def descend(dir_ie, dir_path):
357
kids = dir_ie.children.items()
359
for name, ie in kids:
360
child_path = os.path.join(dir_path, name)
361
accum.append((child_path, ie))
362
if ie.kind == 'directory':
363
descend(ie, child_path)
365
descend(self.root, '')
369
def directories(self):
370
"""Return (path, entry) pairs for all directories, including the root.
373
def descend(parent_ie, parent_path):
374
accum.append((parent_path, parent_ie))
376
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
379
for name, child_ie in kids:
380
child_path = os.path.join(parent_path, name)
381
descend(child_ie, child_path)
382
descend(self.root, '')
387
def __contains__(self, file_id):
388
"""True if this entry contains a file with given id.
390
>>> inv = Inventory()
391
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
392
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
398
return file_id in self._byid
401
def __getitem__(self, file_id):
402
"""Return the entry for given file_id.
404
>>> inv = Inventory()
405
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
406
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
407
>>> inv['123123'].name
411
return self._byid[file_id]
414
raise BzrError("can't look up file_id None")
416
raise BzrError("file_id {%s} not in inventory" % file_id)
419
def get_file_kind(self, file_id):
420
return self._byid[file_id].kind
422
def get_child(self, parent_id, filename):
423
return self[parent_id].children.get(filename)
426
def add(self, entry):
427
"""Add entry to inventory.
429
To add a file to a branch ready to be committed, use Branch.add,
431
if entry.file_id in self._byid:
432
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
434
if entry.parent_id == ROOT_ID or entry.parent_id is None:
435
entry.parent_id = self.root.file_id
438
parent = self._byid[entry.parent_id]
440
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
442
if parent.children.has_key(entry.name):
443
raise BzrError("%s is already versioned" %
444
appendpath(self.id2path(parent.file_id), entry.name))
446
self._byid[entry.file_id] = entry
447
parent.children[entry.name] = entry
451
def add_path(self, relpath, kind, file_id=None):
452
"""Add entry from a path.
454
The immediate parent must already be versioned"""
455
from bzrlib.branch import gen_file_id
457
parts = bzrlib.osutils.splitpath(relpath)
459
raise BzrError("cannot re-add root of inventory")
462
file_id = gen_file_id(relpath)
464
parent_path = parts[:-1]
465
parent_id = self.path2id(parent_path)
466
if parent_id == None:
467
raise NotVersionedError(parent_path)
469
ie = InventoryEntry(file_id, parts[-1],
470
kind=kind, parent_id=parent_id)
474
def __delitem__(self, file_id):
475
"""Remove entry by id.
477
>>> inv = Inventory()
478
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
479
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
488
assert self[ie.parent_id].children[ie.name] == ie
490
# TODO: Test deleting all children; maybe hoist to a separate
492
if ie.kind == 'directory':
493
for cie in ie.children.values():
494
del self[cie.file_id]
497
del self._byid[file_id]
498
del self[ie.parent_id].children[ie.name]
501
def to_element(self):
502
"""Convert to XML Element"""
503
from bzrlib.xml import Element
505
e = Element('inventory')
507
if self.root.file_id not in (None, ROOT_ID):
508
e.set('file_id', self.root.file_id)
509
for path, ie in self.iter_entries():
510
e.append(ie.to_element())
514
def from_element(cls, elt):
515
"""Construct from XML Element
517
>>> inv = Inventory()
518
>>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
519
InventoryEntry('foo.c-123981239', 'foo.c', kind='file', parent_id='TREE_ROOT')
520
>>> elt = inv.to_element()
521
>>> inv2 = Inventory.from_element(elt)
525
# XXXX: doctest doesn't run this properly under python2.3
526
assert elt.tag == 'inventory'
527
root_id = elt.get('file_id') or ROOT_ID
530
ie = InventoryEntry.from_element(e)
531
if ie.parent_id == ROOT_ID:
532
ie.parent_id = root_id
536
from_element = classmethod(from_element)
539
def __eq__(self, other):
540
"""Compare two sets by comparing their contents.
546
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
547
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
550
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
551
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
555
if not isinstance(other, Inventory):
556
return NotImplemented
558
if len(self._byid) != len(other._byid):
559
# shortcut: obviously not the same
562
return self._byid == other._byid
565
def __ne__(self, other):
566
return not (self == other)
570
raise ValueError('not hashable')
574
def get_idpath(self, file_id):
575
"""Return a list of file_ids for the path to an entry.
577
The list contains one element for each directory followed by
578
the id of the file itself. So the length of the returned list
579
is equal to the depth of the file in the tree, counting the
580
root directory as depth 1.
583
while file_id != None:
585
ie = self._byid[file_id]
587
raise BzrError("file_id {%s} not found in inventory" % file_id)
588
p.insert(0, ie.file_id)
589
file_id = ie.parent_id
593
def id2path(self, file_id):
594
"""Return as a list the path to file_id."""
596
# get all names, skipping root
597
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
598
return os.sep.join(p)
602
def path2id(self, name):
603
"""Walk down through directories to return entry of last component.
605
names may be either a list of path components, or a single
606
string, in which case it is automatically split.
608
This returns the entry of the last component in the path,
609
which may be either a file or a directory.
611
Returns None iff the path is not found.
613
if isinstance(name, types.StringTypes):
614
name = splitpath(name)
616
mutter("lookup path %r" % name)
621
cie = parent.children[f]
623
assert cie.parent_id == parent.file_id
629
return parent.file_id
632
def has_filename(self, names):
633
return bool(self.path2id(names))
636
def has_id(self, file_id):
637
return self._byid.has_key(file_id)
640
def rename(self, file_id, new_parent_id, new_name):
641
"""Move a file within the inventory.
643
This can change either the name, or the parent, or both.
645
This does not move the working file."""
646
if not is_valid_name(new_name):
647
raise BzrError("not an acceptable filename: %r" % new_name)
649
new_parent = self._byid[new_parent_id]
650
if new_name in new_parent.children:
651
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
653
new_parent_idpath = self.get_idpath(new_parent_id)
654
if file_id in new_parent_idpath:
655
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
656
% (self.id2path(file_id), self.id2path(new_parent_id)))
658
file_ie = self._byid[file_id]
659
old_parent = self._byid[file_ie.parent_id]
661
# TODO: Don't leave things messed up if this fails
663
del old_parent.children[file_ie.name]
664
new_parent.children[new_name] = file_ie
666
file_ie.name = new_name
667
file_ie.parent_id = new_parent_id
674
def is_valid_name(name):
677
_NAME_RE = re.compile(r'^[^/\\]+$')
679
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
