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
# TODO: Maybe also keep the full path of the entry, and the children?
19
# But those depend on its position within a particular inventory, and
20
# it would be nice not to need to hold the backpointer here.
22
# This should really be an id randomly assigned when the tree is
23
# created, but it's not for now.
34
from bzrlib.errors import BzrError, BzrCheckError
36
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
37
appendpath, sha_strings)
38
from bzrlib.trace import mutter
39
from bzrlib.errors import NotVersionedError
42
class InventoryEntry(object):
43
"""Description of a versioned file.
45
An InventoryEntry has the following fields, which are also
46
present in the XML inventory-entry element:
51
(within the parent directory)
54
file_id of the parent directory, or ROOT_ID
57
the revision_id in which this variation of this file was
61
Indicates that this file should be executable on systems
65
sha-1 of the text of the file
68
size in bytes of the text of the file
70
(reading a version 4 tree created a text_id field.)
75
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
76
InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
77
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
78
InventoryFile('2323', 'hello.c', parent_id='123')
79
>>> for j in i.iter_entries():
82
('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
83
('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
84
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
85
Traceback (most recent call last):
87
BzrError: inventory already contains entry with id {2323}
88
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
89
InventoryFile('2324', 'bye.c', parent_id='123')
90
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
91
InventoryDirectory('2325', 'wibble', parent_id='123')
92
>>> i.path2id('src/wibble')
96
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
97
InventoryFile('2326', 'wibble.c', parent_id='2325')
99
InventoryFile('2326', 'wibble.c', parent_id='2325')
100
>>> for path, entry in i.iter_entries():
101
... print path.replace('\\\\', '/') # for win32 os.sep
102
... assert i.path2id(path)
109
>>> i.id2path('2326').replace('\\\\', '/')
110
'src/wibble/wibble.c'
113
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
114
'text_id', 'parent_id', 'children', 'executable',
117
def _add_text_to_weave(self, new_lines, parents, weave_store):
118
weave_store.add_text(self.file_id, self.revision, new_lines, parents)
120
def detect_changes(self, old_entry):
121
"""Return a (text_modified, meta_modified) from this to old_entry.
123
_read_tree_state must have been called on self and old_entry prior to
124
calling detect_changes.
128
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
129
output_to, reverse=False):
130
"""Perform a diff from this to to_entry.
132
text_diff will be used for textual difference calculation.
133
This is a template method, override _diff in child classes.
135
self._read_tree_state(tree.id2path(self.file_id), tree)
137
# cannot diff from one kind to another - you must do a removal
138
# and an addif they do not match.
139
assert self.kind == to_entry.kind
140
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
142
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
145
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
146
output_to, reverse=False):
147
"""Perform a diff between two entries of the same kind."""
149
def find_previous_heads(self, previous_inventories, entry_weave):
150
"""Return the revisions and entries that directly preceed this.
152
Returned as a map from revision to inventory entry.
154
This is a map containing the file revisions in all parents
155
for which the file exists, and its revision is not a parent of
156
any other. If the file is new, the set will be empty.
158
def get_ancestors(weave, entry):
159
return set(map(weave.idx_to_name,
160
weave.inclusions([weave.lookup(entry.revision)])))
163
for inv in previous_inventories:
164
if self.file_id in inv:
165
ie = inv[self.file_id]
166
assert ie.file_id == self.file_id
167
if ie.revision in heads:
168
assert heads[ie.revision] == ie
170
# may want to add it.
171
# may already be covered:
172
already_present = 0 != len(
173
[head for head in heads
174
if ie.revision in head_ancestors[head]])
176
# an ancestor of a known head.
179
ancestors = get_ancestors(entry_weave, ie)
180
# may knock something else out:
181
check_heads = list(heads.keys())
182
for head in check_heads:
183
if head in ancestors:
184
# this head is not really a head
186
head_ancestors[ie.revision] = ancestors
187
heads[ie.revision] = ie
190
def get_tar_item(self, root, dp, now, tree):
191
"""Get a tarfile item and a file stream for its content."""
192
item = tarfile.TarInfo(os.path.join(root, dp))
193
# TODO: would be cool to actually set it to the timestamp of the
194
# revision it was last changed
196
fileobj = self._put_in_tar(item, tree)
200
"""Return true if the object this entry represents has textual data.
202
Note that textual data includes binary content.
204
Also note that all entries get weave files created for them.
205
This attribute is primarily used when upgrading from old trees that
206
did not have the weave index for all inventory entries.
210
def __init__(self, file_id, name, parent_id, text_id=None):
211
"""Create an InventoryEntry
213
The filename must be a single component, relative to the
214
parent directory; it cannot be a whole path or relative name.
216
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
221
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
222
Traceback (most recent call last):
223
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
225
assert isinstance(name, basestring), name
226
if '/' in name or '\\' in name:
227
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
229
self.executable = False
231
self.text_sha1 = None
232
self.text_size = None
233
self.file_id = file_id
235
self.text_id = text_id
236
self.parent_id = parent_id
237
self.symlink_target = None
239
def kind_character(self):
240
"""Return a short kind indicator useful for appending to names."""
241
raise BzrError('unknown kind %r' % self.kind)
243
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
245
def _put_in_tar(self, item, tree):
246
"""populate item for stashing in a tar, and return the content stream.
248
If no content is available, return None.
250
raise BzrError("don't know how to export {%s} of kind %r" %
251
(self.file_id, self.kind))
253
def put_on_disk(self, dest, dp, tree):
254
"""Create a representation of self on disk in the prefix dest.
256
This is a template method - implement _put_on_disk in subclasses.
258
fullpath = appendpath(dest, dp)
259
self._put_on_disk(fullpath, tree)
260
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
262
def _put_on_disk(self, fullpath, tree):
263
"""Put this entry onto disk at fullpath, from tree tree."""
264
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
266
def sorted_children(self):
267
l = self.children.items()
272
def versionable_kind(kind):
273
return kind in ('file', 'directory', 'symlink')
275
def check(self, checker, rev_id, inv, tree):
276
"""Check this inventory entry is intact.
278
This is a template method, override _check for kind specific
281
if self.parent_id != None:
282
if not inv.has_id(self.parent_id):
283
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
284
% (self.parent_id, rev_id))
285
self._check(checker, rev_id, tree)
287
def _check(self, checker, rev_id, tree):
288
"""Check this inventory entry for kind specific errors."""
289
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
294
"""Clone this inventory entry."""
295
raise NotImplementedError
297
def _get_snapshot_change(self, previous_entries):
298
if len(previous_entries) > 1:
300
elif len(previous_entries) == 0:
303
return 'modified/renamed/reparented'
306
return ("%s(%r, %r, parent_id=%r)"
307
% (self.__class__.__name__,
312
def snapshot(self, revision, path, previous_entries,
313
work_tree, weave_store):
314
"""Make a snapshot of this entry which may or may not have changed.
316
This means that all its fields are populated, that it has its
317
text stored in the text store or weave.
319
mutter('new parents of %s are %r', path, previous_entries)
320
self._read_tree_state(path, work_tree)
321
if len(previous_entries) == 1:
322
# cannot be unchanged unless there is only one parent file rev.
323
parent_ie = previous_entries.values()[0]
324
if self._unchanged(parent_ie):
325
mutter("found unchanged entry")
326
self.revision = parent_ie.revision
328
return self.snapshot_revision(revision, previous_entries,
329
work_tree, weave_store)
331
def snapshot_revision(self, revision, previous_entries, work_tree,
333
"""Record this revision unconditionally."""
334
mutter('new revision for {%s}', self.file_id)
335
self.revision = revision
336
change = self._get_snapshot_change(previous_entries)
337
self._snapshot_text(previous_entries, work_tree, weave_store)
340
def _snapshot_text(self, file_parents, work_tree, weave_store):
341
"""Record the 'text' of this entry, whatever form that takes.
343
This default implementation simply adds an empty text.
345
mutter('storing file {%s} in revision {%s}',
346
self.file_id, self.revision)
347
self._add_text_to_weave([], file_parents, weave_store)
349
def __eq__(self, other):
350
if not isinstance(other, InventoryEntry):
351
return NotImplemented
353
return ((self.file_id == other.file_id)
354
and (self.name == other.name)
355
and (other.symlink_target == self.symlink_target)
356
and (self.text_sha1 == other.text_sha1)
357
and (self.text_size == other.text_size)
358
and (self.text_id == other.text_id)
359
and (self.parent_id == other.parent_id)
360
and (self.kind == other.kind)
361
and (self.revision == other.revision)
362
and (self.executable == other.executable)
365
def __ne__(self, other):
366
return not (self == other)
369
raise ValueError('not hashable')
371
def _unchanged(self, previous_ie):
372
"""Has this entry changed relative to previous_ie.
374
This method should be overriden in child classes.
377
# different inv parent
378
if previous_ie.parent_id != self.parent_id:
381
elif previous_ie.name != self.name:
385
def _read_tree_state(self, path, work_tree):
386
"""Populate fields in the inventory entry from the given tree.
388
Note that this should be modified to be a noop on virtual trees
389
as all entries created there are prepopulated.
393
class RootEntry(InventoryEntry):
395
def _check(self, checker, rev_id, tree):
396
"""See InventoryEntry._check"""
398
def __init__(self, file_id):
399
self.file_id = file_id
401
self.kind = 'root_directory'
402
self.parent_id = None
405
def __eq__(self, other):
406
if not isinstance(other, RootEntry):
407
return NotImplemented
409
return (self.file_id == other.file_id) \
410
and (self.children == other.children)
413
class InventoryDirectory(InventoryEntry):
414
"""A directory in an inventory."""
416
def _check(self, checker, rev_id, tree):
417
"""See InventoryEntry._check"""
418
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
419
raise BzrCheckError('directory {%s} has text in revision {%s}'
420
% (self.file_id, rev_id))
423
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
424
other.revision = self.revision
425
# note that children are *not* copied; they're pulled across when
429
def __init__(self, file_id, name, parent_id):
430
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
432
self.kind = 'directory'
434
def kind_character(self):
435
"""See InventoryEntry.kind_character."""
438
def _put_in_tar(self, item, tree):
439
"""See InventoryEntry._put_in_tar."""
440
item.type = tarfile.DIRTYPE
447
def _put_on_disk(self, fullpath, tree):
448
"""See InventoryEntry._put_on_disk."""
452
class InventoryFile(InventoryEntry):
453
"""A file in an inventory."""
455
def _check(self, checker, rev_id, tree):
456
"""See InventoryEntry._check"""
457
revision = self.revision
458
t = (self.file_id, revision)
459
if t in checker.checked_texts:
460
prev_sha = checker.checked_texts[t]
461
if prev_sha != self.text_sha1:
462
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
463
(self.file_id, rev_id))
465
checker.repeated_text_cnt += 1
467
mutter('check version {%s} of {%s}', rev_id, self.file_id)
468
file_lines = tree.get_file_lines(self.file_id)
469
checker.checked_text_cnt += 1
470
if self.text_size != sum(map(len, file_lines)):
471
raise BzrCheckError('text {%s} wrong size' % self.text_id)
472
if self.text_sha1 != sha_strings(file_lines):
473
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
474
checker.checked_texts[t] = self.text_sha1
477
other = InventoryFile(self.file_id, self.name, self.parent_id)
478
other.executable = self.executable
479
other.text_id = self.text_id
480
other.text_sha1 = self.text_sha1
481
other.text_size = self.text_size
482
other.revision = self.revision
485
def detect_changes(self, old_entry):
486
"""See InventoryEntry.detect_changes."""
487
assert self.text_sha1 != None
488
assert old_entry.text_sha1 != None
489
text_modified = (self.text_sha1 != old_entry.text_sha1)
490
meta_modified = (self.executable != old_entry.executable)
491
return text_modified, meta_modified
493
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
494
output_to, reverse=False):
495
"""See InventoryEntry._diff."""
496
from_text = tree.get_file(self.file_id).readlines()
498
to_text = to_tree.get_file(to_entry.file_id).readlines()
502
text_diff(from_label, from_text,
503
to_label, to_text, output_to)
505
text_diff(to_label, to_text,
506
from_label, from_text, output_to)
509
"""See InventoryEntry.has_text."""
512
def __init__(self, file_id, name, parent_id):
513
super(InventoryFile, self).__init__(file_id, name, parent_id)
516
def kind_character(self):
517
"""See InventoryEntry.kind_character."""
520
def _put_in_tar(self, item, tree):
521
"""See InventoryEntry._put_in_tar."""
522
item.type = tarfile.REGTYPE
523
fileobj = tree.get_file(self.file_id)
524
item.size = self.text_size
525
if tree.is_executable(self.file_id):
531
def _put_on_disk(self, fullpath, tree):
532
"""See InventoryEntry._put_on_disk."""
533
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
534
if tree.is_executable(self.file_id):
535
os.chmod(fullpath, 0755)
537
def _read_tree_state(self, path, work_tree):
538
"""See InventoryEntry._read_tree_state."""
539
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
540
self.executable = work_tree.is_executable(self.file_id)
542
def _snapshot_text(self, file_parents, work_tree, weave_store):
543
"""See InventoryEntry._snapshot_text."""
544
mutter('storing file {%s} in revision {%s}',
545
self.file_id, self.revision)
546
# special case to avoid diffing on renames or
548
if (len(file_parents) == 1
549
and self.text_sha1 == file_parents.values()[0].text_sha1
550
and self.text_size == file_parents.values()[0].text_size):
551
previous_ie = file_parents.values()[0]
552
weave_store.add_identical_text(
553
self.file_id, previous_ie.revision,
554
self.revision, file_parents)
556
new_lines = work_tree.get_file(self.file_id).readlines()
557
self._add_text_to_weave(new_lines, file_parents, weave_store)
558
self.text_sha1 = sha_strings(new_lines)
559
self.text_size = sum(map(len, new_lines))
562
def _unchanged(self, previous_ie):
563
"""See InventoryEntry._unchanged."""
564
compatible = super(InventoryFile, self)._unchanged(previous_ie)
565
if self.text_sha1 != previous_ie.text_sha1:
568
# FIXME: 20050930 probe for the text size when getting sha1
569
# in _read_tree_state
570
self.text_size = previous_ie.text_size
574
class InventoryLink(InventoryEntry):
575
"""A file in an inventory."""
577
__slots__ = ['symlink_target']
579
def _check(self, checker, rev_id, tree):
580
"""See InventoryEntry._check"""
581
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
582
raise BzrCheckError('symlink {%s} has text in revision {%s}'
583
% (self.file_id, rev_id))
584
if self.symlink_target == None:
585
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
586
% (self.file_id, rev_id))
589
other = InventoryLink(self.file_id, self.name, self.parent_id)
590
other.symlink_target = self.symlink_target
591
other.revision = self.revision
594
def detect_changes(self, old_entry):
595
"""See InventoryEntry.detect_changes."""
596
# FIXME: which _modified field should we use ? RBC 20051003
597
text_modified = (self.symlink_target != old_entry.symlink_target)
599
mutter(" symlink target changed")
600
meta_modified = False
601
return text_modified, meta_modified
603
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
604
output_to, reverse=False):
605
"""See InventoryEntry._diff."""
606
from_text = self.symlink_target
607
if to_entry is not None:
608
to_text = to_entry.symlink_target
613
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
616
print >>output_to, '=== target was %r' % self.symlink_target
618
print >>output_to, '=== target is %r' % self.symlink_target
620
def __init__(self, file_id, name, parent_id):
621
super(InventoryLink, self).__init__(file_id, name, parent_id)
622
self.kind = 'symlink'
624
def kind_character(self):
625
"""See InventoryEntry.kind_character."""
628
def _put_in_tar(self, item, tree):
629
"""See InventoryEntry._put_in_tar."""
630
iterm.type = tarfile.SYMTYPE
634
item.linkname = self.symlink_target
637
def _put_on_disk(self, fullpath, tree):
638
"""See InventoryEntry._put_on_disk."""
640
os.symlink(self.symlink_target, fullpath)
642
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
644
def _read_tree_state(self, path, work_tree):
645
"""See InventoryEntry._read_tree_state."""
646
self.symlink_target = work_tree.get_symlink_target(self.file_id)
648
def _unchanged(self, previous_ie):
649
"""See InventoryEntry._unchanged."""
650
compatible = super(InventoryLink, self)._unchanged(previous_ie)
651
if self.symlink_target != previous_ie.symlink_target:
656
class Inventory(object):
657
"""Inventory of versioned files in a tree.
659
This describes which file_id is present at each point in the tree,
660
and possibly the SHA-1 or other information about the file.
661
Entries can be looked up either by path or by file_id.
663
The inventory represents a typical unix file tree, with
664
directories containing files and subdirectories. We never store
665
the full path to a file, because renaming a directory implicitly
666
moves all of its contents. This class internally maintains a
667
lookup tree that allows the children under a directory to be
670
InventoryEntry objects must not be modified after they are
671
inserted, other than through the Inventory API.
673
>>> inv = Inventory()
674
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
675
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
676
>>> inv['123-123'].name
679
May be treated as an iterator or set to look up file ids:
681
>>> bool(inv.path2id('hello.c'))
686
May also look up by name:
688
>>> [x[0] for x in inv.iter_entries()]
690
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
691
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
692
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
694
def __init__(self, root_id=ROOT_ID):
695
"""Create or read an inventory.
697
If a working directory is specified, the inventory is read
698
from there. If the file is specified, read from that. If not,
699
the inventory is created empty.
701
The inventory is created with a default root directory, with
704
# We are letting Branch.initialize() create a unique inventory
705
# root id. Rather than generating a random one here.
707
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
708
self.root = RootEntry(root_id)
709
self._byid = {self.root.file_id: self.root}
713
other = Inventory(self.root.file_id)
714
# copy recursively so we know directories will be added before
715
# their children. There are more efficient ways than this...
716
for path, entry in self.iter_entries():
717
if entry == self.root:
719
other.add(entry.copy())
724
return iter(self._byid)
728
"""Returns number of entries."""
729
return len(self._byid)
732
def iter_entries(self, from_dir=None):
733
"""Return (path, entry) pairs, in order by name."""
737
elif isinstance(from_dir, basestring):
738
from_dir = self._byid[from_dir]
740
kids = from_dir.children.items()
742
for name, ie in kids:
744
if ie.kind == 'directory':
745
for cn, cie in self.iter_entries(from_dir=ie.file_id):
746
yield os.path.join(name, cn), cie
750
"""Return list of (path, ie) for all entries except the root.
752
This may be faster than iter_entries.
755
def descend(dir_ie, dir_path):
756
kids = dir_ie.children.items()
758
for name, ie in kids:
759
child_path = os.path.join(dir_path, name)
760
accum.append((child_path, ie))
761
if ie.kind == 'directory':
762
descend(ie, child_path)
764
descend(self.root, '')
768
def directories(self):
769
"""Return (path, entry) pairs for all directories, including the root.
772
def descend(parent_ie, parent_path):
773
accum.append((parent_path, parent_ie))
775
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
778
for name, child_ie in kids:
779
child_path = os.path.join(parent_path, name)
780
descend(child_ie, child_path)
781
descend(self.root, '')
786
def __contains__(self, file_id):
787
"""True if this entry contains a file with given id.
789
>>> inv = Inventory()
790
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
791
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
797
return file_id in self._byid
800
def __getitem__(self, file_id):
801
"""Return the entry for given file_id.
803
>>> inv = Inventory()
804
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
805
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
806
>>> inv['123123'].name
810
return self._byid[file_id]
813
raise BzrError("can't look up file_id None")
815
raise BzrError("file_id {%s} not in inventory" % file_id)
818
def get_file_kind(self, file_id):
819
return self._byid[file_id].kind
821
def get_child(self, parent_id, filename):
822
return self[parent_id].children.get(filename)
825
def add(self, entry):
826
"""Add entry to inventory.
828
To add a file to a branch ready to be committed, use Branch.add,
831
Returns the new entry object.
833
if entry.file_id in self._byid:
834
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
836
if entry.parent_id == ROOT_ID or entry.parent_id is None:
837
entry.parent_id = self.root.file_id
840
parent = self._byid[entry.parent_id]
842
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
844
if parent.children.has_key(entry.name):
845
raise BzrError("%s is already versioned" %
846
appendpath(self.id2path(parent.file_id), entry.name))
848
self._byid[entry.file_id] = entry
849
parent.children[entry.name] = entry
853
def add_path(self, relpath, kind, file_id=None):
854
"""Add entry from a path.
856
The immediate parent must already be versioned.
858
Returns the new entry object."""
859
from bzrlib.branch import gen_file_id
861
parts = bzrlib.osutils.splitpath(relpath)
863
raise BzrError("cannot re-add root of inventory")
866
file_id = gen_file_id(relpath)
868
parent_path = parts[:-1]
869
parent_id = self.path2id(parent_path)
870
if parent_id == None:
871
raise NotVersionedError(parent_path)
873
if kind == 'directory':
874
ie = InventoryDirectory(file_id, parts[-1], parent_id)
876
ie = InventoryFile(file_id, parts[-1], parent_id)
877
elif kind == 'symlink':
878
ie = InventoryLink(file_id, parts[-1], parent_id)
880
raise BzrError("unknown kind %r" % kind)
884
def __delitem__(self, file_id):
885
"""Remove entry by id.
887
>>> inv = Inventory()
888
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
889
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
898
assert self[ie.parent_id].children[ie.name] == ie
900
# TODO: Test deleting all children; maybe hoist to a separate
902
if ie.kind == 'directory':
903
for cie in ie.children.values():
904
del self[cie.file_id]
907
del self._byid[file_id]
908
del self[ie.parent_id].children[ie.name]
911
def __eq__(self, other):
912
"""Compare two sets by comparing their contents.
918
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
919
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
922
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
923
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
927
if not isinstance(other, Inventory):
928
return NotImplemented
930
if len(self._byid) != len(other._byid):
931
# shortcut: obviously not the same
934
return self._byid == other._byid
937
def __ne__(self, other):
938
return not self.__eq__(other)
942
raise ValueError('not hashable')
945
def get_idpath(self, file_id):
946
"""Return a list of file_ids for the path to an entry.
948
The list contains one element for each directory followed by
949
the id of the file itself. So the length of the returned list
950
is equal to the depth of the file in the tree, counting the
951
root directory as depth 1.
954
while file_id != None:
956
ie = self._byid[file_id]
958
raise BzrError("file_id {%s} not found in inventory" % file_id)
959
p.insert(0, ie.file_id)
960
file_id = ie.parent_id
964
def id2path(self, file_id):
965
"""Return as a list the path to file_id.
968
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
969
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
970
>>> print i.id2path('foo-id').replace(os.sep, '/')
973
# get all names, skipping root
974
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
975
return os.sep.join(p)
979
def path2id(self, name):
980
"""Walk down through directories to return entry of last component.
982
names may be either a list of path components, or a single
983
string, in which case it is automatically split.
985
This returns the entry of the last component in the path,
986
which may be either a file or a directory.
988
Returns None iff the path is not found.
990
if isinstance(name, types.StringTypes):
991
name = splitpath(name)
993
mutter("lookup path %r" % name)
998
cie = parent.children[f]
1000
assert cie.parent_id == parent.file_id
1003
# or raise an error?
1006
return parent.file_id
1009
def has_filename(self, names):
1010
return bool(self.path2id(names))
1013
def has_id(self, file_id):
1014
return self._byid.has_key(file_id)
1017
def rename(self, file_id, new_parent_id, new_name):
1018
"""Move a file within the inventory.
1020
This can change either the name, or the parent, or both.
1022
This does not move the working file."""
1023
if not is_valid_name(new_name):
1024
raise BzrError("not an acceptable filename: %r" % new_name)
1026
new_parent = self._byid[new_parent_id]
1027
if new_name in new_parent.children:
1028
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1030
new_parent_idpath = self.get_idpath(new_parent_id)
1031
if file_id in new_parent_idpath:
1032
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1033
% (self.id2path(file_id), self.id2path(new_parent_id)))
1035
file_ie = self._byid[file_id]
1036
old_parent = self._byid[file_ie.parent_id]
1038
# TODO: Don't leave things messed up if this fails
1040
del old_parent.children[file_ie.name]
1041
new_parent.children[new_name] = file_ie
1043
file_ie.name = new_name
1044
file_ie.parent_id = new_parent_id
1051
def is_valid_name(name):
1053
if _NAME_RE == None:
1054
_NAME_RE = re.compile(r'^[^/\\]+$')
1056
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
