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.
29
from bzrlib.errors import BzrError, BzrCheckError
31
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath
32
from bzrlib.trace import mutter
33
from bzrlib.errors import NotVersionedError
36
class InventoryEntry(object):
37
"""Description of a versioned file.
39
An InventoryEntry has the following fields, which are also
40
present in the XML inventory-entry element:
43
* *name*: (only the basename within the directory, must not
45
* *kind*: "directory" or "file"
46
* *directory_id*: (if absent/null means the branch root directory)
47
* *text_sha1*: only for files
48
* *text_size*: in bytes, only for files
49
* *text_id*: identifier for the text version, only for files
51
InventoryEntries can also exist inside a WorkingTree
52
inventory, in which case they are not yet bound to a
53
particular revision of the file. In that case the text_sha1,
54
text_size and text_id are absent.
60
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
61
InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
62
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
63
InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
64
>>> for j in i.iter_entries():
67
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
68
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
69
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
70
Traceback (most recent call last):
72
BzrError: inventory already contains entry with id {2323}
73
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
74
InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
75
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
76
InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
77
>>> i.path2id('src/wibble')
81
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
82
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
84
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
85
>>> for path, entry in i.iter_entries():
86
... print path.replace('\\\\', '/') # for win32 os.sep
87
... assert i.path2id(path)
94
>>> i.id2path('2326').replace('\\\\', '/')
97
TODO: Maybe also keep the full path of the entry, and the children?
98
But those depend on its position within a particular inventory, and
99
it would be nice not to need to hold the backpointer here.
102
# TODO: split InventoryEntry into subclasses for files,
103
# directories, etc etc.
105
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
106
'text_id', 'parent_id', 'children',
107
'text_version', 'entry_version', 'symlink_target']
109
def __init__(self, file_id, name, kind, parent_id, text_id=None):
110
"""Create an InventoryEntry
112
The filename must be a single component, relative to the
113
parent directory; it cannot be a whole path or relative name.
115
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
120
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
121
Traceback (most recent call last):
122
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
124
assert isinstance(name, basestring), name
125
if '/' in name or '\\' in name:
126
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
128
self.text_version = None
129
self.entry_version = None
130
self.text_sha1 = None
131
self.text_size = None
132
self.file_id = file_id
135
self.text_id = text_id
136
self.parent_id = parent_id
137
self.symlink_target = None
138
if kind == 'directory':
142
elif kind == 'symlink':
145
raise BzrError("unhandled entry kind %r" % kind)
147
def read_symlink_target(self, path):
148
if self.kind == 'symlink':
150
self.symlink_target = os.readlink(path)
152
raise BzrError("os.readlink error, %s" % e)
154
def sorted_children(self):
155
l = self.children.items()
161
other = InventoryEntry(self.file_id, self.name, self.kind,
162
self.parent_id, text_id=self.text_id)
163
other.text_sha1 = self.text_sha1
164
other.text_size = self.text_size
165
other.symlink_target = self.symlink_target
166
# note that children are *not* copied; they're pulled across when
172
return ("%s(%r, %r, kind=%r, parent_id=%r)"
173
% (self.__class__.__name__,
179
def __eq__(self, other):
180
if not isinstance(other, InventoryEntry):
181
return NotImplemented
183
return (self.file_id == other.file_id) \
184
and (self.name == other.name) \
185
and (other.symlink_target == self.symlink_target) \
186
and (self.text_sha1 == other.text_sha1) \
187
and (self.text_size == other.text_size) \
188
and (self.text_id == other.text_id) \
189
and (self.parent_id == other.parent_id) \
190
and (self.kind == other.kind) \
191
and (self.text_version == other.text_version) \
192
and (self.entry_version == other.entry_version)
194
def __ne__(self, other):
195
return not (self == other)
198
raise ValueError('not hashable')
202
class RootEntry(InventoryEntry):
203
def __init__(self, file_id):
204
self.file_id = file_id
206
self.kind = 'root_directory'
207
self.parent_id = None
210
def __eq__(self, other):
211
if not isinstance(other, RootEntry):
212
return NotImplemented
214
return (self.file_id == other.file_id) \
215
and (self.children == other.children)
219
class Inventory(object):
220
"""Inventory of versioned files in a tree.
222
This describes which file_id is present at each point in the tree,
223
and possibly the SHA-1 or other information about the file.
224
Entries can be looked up either by path or by file_id.
226
The inventory represents a typical unix file tree, with
227
directories containing files and subdirectories. We never store
228
the full path to a file, because renaming a directory implicitly
229
moves all of its contents. This class internally maintains a
230
lookup tree that allows the children under a directory to be
233
InventoryEntry objects must not be modified after they are
234
inserted, other than through the Inventory API.
236
>>> inv = Inventory()
237
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
238
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
239
>>> inv['123-123'].name
242
May be treated as an iterator or set to look up file ids:
244
>>> bool(inv.path2id('hello.c'))
249
May also look up by name:
251
>>> [x[0] for x in inv.iter_entries()]
253
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
254
>>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
255
InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
257
def __init__(self, root_id=ROOT_ID):
258
"""Create or read an inventory.
260
If a working directory is specified, the inventory is read
261
from there. If the file is specified, read from that. If not,
262
the inventory is created empty.
264
The inventory is created with a default root directory, with
267
# We are letting Branch.initialize() create a unique inventory
268
# root id. Rather than generating a random one here.
270
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
271
self.root = RootEntry(root_id)
272
self._byid = {self.root.file_id: self.root}
276
return iter(self._byid)
280
"""Returns number of entries."""
281
return len(self._byid)
284
def iter_entries(self, from_dir=None):
285
"""Return (path, entry) pairs, in order by name."""
289
elif isinstance(from_dir, basestring):
290
from_dir = self._byid[from_dir]
292
kids = from_dir.children.items()
294
for name, ie in kids:
296
if ie.kind == 'directory':
297
for cn, cie in self.iter_entries(from_dir=ie.file_id):
298
yield os.path.join(name, cn), cie
302
"""Return list of (path, ie) for all entries except the root.
304
This may be faster than iter_entries.
307
def descend(dir_ie, dir_path):
308
kids = dir_ie.children.items()
310
for name, ie in kids:
311
child_path = os.path.join(dir_path, name)
312
accum.append((child_path, ie))
313
if ie.kind == 'directory':
314
descend(ie, child_path)
316
descend(self.root, '')
320
def directories(self):
321
"""Return (path, entry) pairs for all directories, including the root.
324
def descend(parent_ie, parent_path):
325
accum.append((parent_path, parent_ie))
327
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
330
for name, child_ie in kids:
331
child_path = os.path.join(parent_path, name)
332
descend(child_ie, child_path)
333
descend(self.root, '')
338
def __contains__(self, file_id):
339
"""True if this entry contains a file with given id.
341
>>> inv = Inventory()
342
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
343
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
349
return file_id in self._byid
352
def __getitem__(self, file_id):
353
"""Return the entry for given file_id.
355
>>> inv = Inventory()
356
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
357
InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
358
>>> inv['123123'].name
362
return self._byid[file_id]
365
raise BzrError("can't look up file_id None")
367
raise BzrError("file_id {%s} not in inventory" % file_id)
370
def get_file_kind(self, file_id):
371
return self._byid[file_id].kind
373
def get_child(self, parent_id, filename):
374
return self[parent_id].children.get(filename)
377
def add(self, entry):
378
"""Add entry to inventory.
380
To add a file to a branch ready to be committed, use Branch.add,
383
Returns the new entry object.
385
if entry.file_id in self._byid:
386
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
388
if entry.parent_id == ROOT_ID or entry.parent_id is None:
389
entry.parent_id = self.root.file_id
392
parent = self._byid[entry.parent_id]
394
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
396
if parent.children.has_key(entry.name):
397
raise BzrError("%s is already versioned" %
398
appendpath(self.id2path(parent.file_id), entry.name))
400
self._byid[entry.file_id] = entry
401
parent.children[entry.name] = entry
405
def add_path(self, relpath, kind, file_id=None):
406
"""Add entry from a path.
408
The immediate parent must already be versioned.
410
Returns the new entry object."""
411
from bzrlib.branch import gen_file_id
413
parts = bzrlib.osutils.splitpath(relpath)
415
raise BzrError("cannot re-add root of inventory")
418
file_id = gen_file_id(relpath)
420
parent_path = parts[:-1]
421
parent_id = self.path2id(parent_path)
422
if parent_id == None:
423
raise NotVersionedError(parent_path)
425
ie = InventoryEntry(file_id, parts[-1],
426
kind=kind, parent_id=parent_id)
430
def __delitem__(self, file_id):
431
"""Remove entry by id.
433
>>> inv = Inventory()
434
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
435
InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
444
assert self[ie.parent_id].children[ie.name] == ie
446
# TODO: Test deleting all children; maybe hoist to a separate
448
if ie.kind == 'directory':
449
for cie in ie.children.values():
450
del self[cie.file_id]
453
del self._byid[file_id]
454
del self[ie.parent_id].children[ie.name]
457
def __eq__(self, other):
458
"""Compare two sets by comparing their contents.
464
>>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
465
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
468
>>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
469
InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
473
if not isinstance(other, Inventory):
474
return NotImplemented
476
if len(self._byid) != len(other._byid):
477
# shortcut: obviously not the same
480
return self._byid == other._byid
483
def __ne__(self, other):
484
return not (self == other)
488
raise ValueError('not hashable')
491
def get_idpath(self, file_id):
492
"""Return a list of file_ids for the path to an entry.
494
The list contains one element for each directory followed by
495
the id of the file itself. So the length of the returned list
496
is equal to the depth of the file in the tree, counting the
497
root directory as depth 1.
500
while file_id != None:
502
ie = self._byid[file_id]
504
raise BzrError("file_id {%s} not found in inventory" % file_id)
505
p.insert(0, ie.file_id)
506
file_id = ie.parent_id
510
def id2path(self, file_id):
511
"""Return as a list the path to file_id."""
513
# get all names, skipping root
514
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
515
return os.sep.join(p)
519
def path2id(self, name):
520
"""Walk down through directories to return entry of last component.
522
names may be either a list of path components, or a single
523
string, in which case it is automatically split.
525
This returns the entry of the last component in the path,
526
which may be either a file or a directory.
528
Returns None iff the path is not found.
530
if isinstance(name, types.StringTypes):
531
name = splitpath(name)
533
mutter("lookup path %r" % name)
538
cie = parent.children[f]
540
assert cie.parent_id == parent.file_id
546
return parent.file_id
549
def has_filename(self, names):
550
return bool(self.path2id(names))
553
def has_id(self, file_id):
554
return self._byid.has_key(file_id)
557
def rename(self, file_id, new_parent_id, new_name):
558
"""Move a file within the inventory.
560
This can change either the name, or the parent, or both.
562
This does not move the working file."""
563
if not is_valid_name(new_name):
564
raise BzrError("not an acceptable filename: %r" % new_name)
566
new_parent = self._byid[new_parent_id]
567
if new_name in new_parent.children:
568
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
570
new_parent_idpath = self.get_idpath(new_parent_id)
571
if file_id in new_parent_idpath:
572
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
573
% (self.id2path(file_id), self.id2path(new_parent_id)))
575
file_ie = self._byid[file_id]
576
old_parent = self._byid[file_ie.parent_id]
578
# TODO: Don't leave things messed up if this fails
580
del old_parent.children[file_ie.name]
581
new_parent.children[new_name] = file_ie
583
file_ie.name = new_name
584
file_ie.parent_id = new_parent_id
591
def is_valid_name(name):
594
_NAME_RE = re.compile(r'^[^/\\]+$')
596
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
