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):
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.
159
for inv in previous_inventories:
160
if self.file_id in inv:
161
ie = inv[self.file_id]
162
assert ie.file_id == self.file_id
163
if ie.revision in heads:
164
assert heads[ie.revision] == ie
166
heads[ie.revision] = ie
169
def get_tar_item(self, root, dp, now, tree):
170
"""Get a tarfile item and a file stream for its content."""
171
item = tarfile.TarInfo(os.path.join(root, dp))
172
# TODO: would be cool to actually set it to the timestamp of the
173
# revision it was last changed
175
fileobj = self._put_in_tar(item, tree)
179
"""Return true if the object this entry represents has textual data.
181
Note that textual data includes binary content.
183
Also note that all entries get weave files created for them.
184
This attribute is primarily used when upgrading from old trees that
185
did not have the weave index for all inventory entries.
189
def __init__(self, file_id, name, parent_id, text_id=None):
190
"""Create an InventoryEntry
192
The filename must be a single component, relative to the
193
parent directory; it cannot be a whole path or relative name.
195
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
200
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
201
Traceback (most recent call last):
202
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
204
assert isinstance(name, basestring), name
205
if '/' in name or '\\' in name:
206
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
208
self.executable = False
210
self.text_sha1 = None
211
self.text_size = None
212
self.file_id = file_id
214
self.text_id = text_id
215
self.parent_id = parent_id
216
self.symlink_target = None
218
def kind_character(self):
219
"""Return a short kind indicator useful for appending to names."""
220
raise BzrError('unknown kind %r' % self.kind)
222
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
224
def _put_in_tar(self, item, tree):
225
"""populate item for stashing in a tar, and return the content stream.
227
If no content is available, return None.
229
raise BzrError("don't know how to export {%s} of kind %r" %
230
(self.file_id, self.kind))
232
def put_on_disk(self, dest, dp, tree):
233
"""Create a representation of self on disk in the prefix dest.
235
This is a template method - implement _put_on_disk in subclasses.
237
fullpath = appendpath(dest, dp)
238
self._put_on_disk(fullpath, tree)
239
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
241
def _put_on_disk(self, fullpath, tree):
242
"""Put this entry onto disk at fullpath, from tree tree."""
243
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
245
def sorted_children(self):
246
l = self.children.items()
251
def versionable_kind(kind):
252
return kind in ('file', 'directory', 'symlink')
254
def check(self, checker, rev_id, inv, tree):
255
"""Check this inventory entry is intact.
257
This is a template method, override _check for kind specific
260
if self.parent_id != None:
261
if not inv.has_id(self.parent_id):
262
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
263
% (self.parent_id, rev_id))
264
self._check(checker, rev_id, tree)
266
def _check(self, checker, rev_id, tree):
267
"""Check this inventory entry for kind specific errors."""
268
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
273
"""Clone this inventory entry."""
274
raise NotImplementedError
276
def _get_snapshot_change(self, previous_entries):
277
if len(previous_entries) > 1:
279
elif len(previous_entries) == 0:
282
return 'modified/renamed/reparented'
285
return ("%s(%r, %r, parent_id=%r)"
286
% (self.__class__.__name__,
291
def snapshot(self, revision, path, previous_entries, work_tree,
293
"""Make a snapshot of this entry which may or may not have changed.
295
This means that all its fields are populated, that it has its
296
text stored in the text store or weave.
298
mutter('new parents of %s are %r', path, previous_entries)
299
self._read_tree_state(path, work_tree)
300
if len(previous_entries) == 1:
301
# cannot be unchanged unless there is only one parent file rev.
302
parent_ie = previous_entries.values()[0]
303
if self._unchanged(parent_ie):
304
mutter("found unchanged entry")
305
self.revision = parent_ie.revision
307
return self.snapshot_revision(revision, previous_entries,
308
work_tree, weave_store)
310
def snapshot_revision(self, revision, previous_entries, work_tree,
312
"""Record this revision unconditionally."""
313
mutter('new revision for {%s}', self.file_id)
314
self.revision = revision
315
change = self._get_snapshot_change(previous_entries)
316
self._snapshot_text(previous_entries, work_tree, weave_store)
319
def _snapshot_text(self, file_parents, work_tree, weave_store):
320
"""Record the 'text' of this entry, whatever form that takes.
322
This default implementation simply adds an empty text.
324
mutter('storing file {%s} in revision {%s}',
325
self.file_id, self.revision)
326
self._add_text_to_weave([], file_parents, weave_store)
328
def __eq__(self, other):
329
if not isinstance(other, InventoryEntry):
330
return NotImplemented
332
return ((self.file_id == other.file_id)
333
and (self.name == other.name)
334
and (other.symlink_target == self.symlink_target)
335
and (self.text_sha1 == other.text_sha1)
336
and (self.text_size == other.text_size)
337
and (self.text_id == other.text_id)
338
and (self.parent_id == other.parent_id)
339
and (self.kind == other.kind)
340
and (self.revision == other.revision)
341
and (self.executable == other.executable)
344
def __ne__(self, other):
345
return not (self == other)
348
raise ValueError('not hashable')
350
def _unchanged(self, previous_ie):
351
"""Has this entry changed relative to previous_ie.
353
This method should be overriden in child classes.
356
# different inv parent
357
if previous_ie.parent_id != self.parent_id:
360
elif previous_ie.name != self.name:
364
def _read_tree_state(self, path, work_tree):
365
"""Populate fields in the inventory entry from the given tree.
367
Note that this should be modified to be a noop on virtual trees
368
as all entries created there are prepopulated.
372
class RootEntry(InventoryEntry):
374
def _check(self, checker, rev_id, tree):
375
"""See InventoryEntry._check"""
377
def __init__(self, file_id):
378
self.file_id = file_id
380
self.kind = 'root_directory'
381
self.parent_id = None
384
def __eq__(self, other):
385
if not isinstance(other, RootEntry):
386
return NotImplemented
388
return (self.file_id == other.file_id) \
389
and (self.children == other.children)
392
class InventoryDirectory(InventoryEntry):
393
"""A directory in an inventory."""
395
def _check(self, checker, rev_id, tree):
396
"""See InventoryEntry._check"""
397
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
398
raise BzrCheckError('directory {%s} has text in revision {%s}'
399
% (self.file_id, rev_id))
402
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
403
other.revision = self.revision
404
# note that children are *not* copied; they're pulled across when
408
def __init__(self, file_id, name, parent_id):
409
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
411
self.kind = 'directory'
413
def kind_character(self):
414
"""See InventoryEntry.kind_character."""
417
def _put_in_tar(self, item, tree):
418
"""See InventoryEntry._put_in_tar."""
419
item.type = tarfile.DIRTYPE
426
def _put_on_disk(self, fullpath, tree):
427
"""See InventoryEntry._put_on_disk."""
431
class InventoryFile(InventoryEntry):
432
"""A file in an inventory."""
434
def _check(self, checker, rev_id, tree):
435
"""See InventoryEntry._check"""
436
revision = self.revision
437
t = (self.file_id, revision)
438
if t in checker.checked_texts:
439
prev_sha = checker.checked_texts[t]
440
if prev_sha != self.text_sha1:
441
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
442
(self.file_id, rev_id))
444
checker.repeated_text_cnt += 1
446
mutter('check version {%s} of {%s}', rev_id, self.file_id)
447
file_lines = tree.get_file_lines(self.file_id)
448
checker.checked_text_cnt += 1
449
if self.text_size != sum(map(len, file_lines)):
450
raise BzrCheckError('text {%s} wrong size' % self.text_id)
451
if self.text_sha1 != sha_strings(file_lines):
452
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
453
checker.checked_texts[t] = self.text_sha1
456
other = InventoryFile(self.file_id, self.name, self.parent_id)
457
other.executable = self.executable
458
other.text_id = self.text_id
459
other.text_sha1 = self.text_sha1
460
other.text_size = self.text_size
461
other.revision = self.revision
464
def detect_changes(self, old_entry):
465
"""See InventoryEntry.detect_changes."""
466
assert self.text_sha1 != None
467
assert old_entry.text_sha1 != None
468
text_modified = (self.text_sha1 != old_entry.text_sha1)
469
meta_modified = (self.executable != old_entry.executable)
470
return text_modified, meta_modified
472
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
473
output_to, reverse=False):
474
"""See InventoryEntry._diff."""
475
from_text = tree.get_file(self.file_id).readlines()
477
to_text = to_tree.get_file(to_entry.file_id).readlines()
481
text_diff(from_label, from_text,
482
to_label, to_text, output_to)
484
text_diff(to_label, to_text,
485
from_label, from_text, output_to)
488
"""See InventoryEntry.has_text."""
491
def __init__(self, file_id, name, parent_id):
492
super(InventoryFile, self).__init__(file_id, name, parent_id)
495
def kind_character(self):
496
"""See InventoryEntry.kind_character."""
499
def _put_in_tar(self, item, tree):
500
"""See InventoryEntry._put_in_tar."""
501
item.type = tarfile.REGTYPE
502
fileobj = tree.get_file(self.file_id)
503
item.size = self.text_size
504
if tree.is_executable(self.file_id):
510
def _put_on_disk(self, fullpath, tree):
511
"""See InventoryEntry._put_on_disk."""
512
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
513
if tree.is_executable(self.file_id):
514
os.chmod(fullpath, 0755)
516
def _read_tree_state(self, path, work_tree):
517
"""See InventoryEntry._read_tree_state."""
518
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
519
self.executable = work_tree.is_executable(self.file_id)
521
def _snapshot_text(self, file_parents, work_tree, weave_store):
522
"""See InventoryEntry._snapshot_text."""
523
mutter('storing file {%s} in revision {%s}',
524
self.file_id, self.revision)
525
# special case to avoid diffing on renames or
527
if (len(file_parents) == 1
528
and self.text_sha1 == file_parents.values()[0].text_sha1
529
and self.text_size == file_parents.values()[0].text_size):
530
previous_ie = file_parents.values()[0]
531
weave_store.add_identical_text(
532
self.file_id, previous_ie.revision,
533
self.revision, file_parents)
535
new_lines = work_tree.get_file(self.file_id).readlines()
536
self._add_text_to_weave(new_lines, file_parents, weave_store)
537
self.text_sha1 = sha_strings(new_lines)
538
self.text_size = sum(map(len, new_lines))
541
def _unchanged(self, previous_ie):
542
"""See InventoryEntry._unchanged."""
543
compatible = super(InventoryFile, self)._unchanged(previous_ie)
544
if self.text_sha1 != previous_ie.text_sha1:
547
# FIXME: 20050930 probe for the text size when getting sha1
548
# in _read_tree_state
549
self.text_size = previous_ie.text_size
553
class InventoryLink(InventoryEntry):
554
"""A file in an inventory."""
556
__slots__ = ['symlink_target']
558
def _check(self, checker, rev_id, tree):
559
"""See InventoryEntry._check"""
560
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
561
raise BzrCheckError('symlink {%s} has text in revision {%s}'
562
% (self.file_id, rev_id))
563
if self.symlink_target == None:
564
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
565
% (self.file_id, rev_id))
568
other = InventoryLink(self.file_id, self.name, self.parent_id)
569
other.symlink_target = self.symlink_target
570
other.revision = self.revision
573
def detect_changes(self, old_entry):
574
"""See InventoryEntry.detect_changes."""
575
# FIXME: which _modified field should we use ? RBC 20051003
576
text_modified = (self.symlink_target != old_entry.symlink_target)
578
mutter(" symlink target changed")
579
meta_modified = False
580
return text_modified, meta_modified
582
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
583
output_to, reverse=False):
584
"""See InventoryEntry._diff."""
585
from_text = self.symlink_target
586
if to_entry is not None:
587
to_text = to_entry.symlink_target
592
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
595
print >>output_to, '=== target was %r' % self.symlink_target
597
print >>output_to, '=== target is %r' % self.symlink_target
599
def __init__(self, file_id, name, parent_id):
600
super(InventoryLink, self).__init__(file_id, name, parent_id)
601
self.kind = 'symlink'
603
def kind_character(self):
604
"""See InventoryEntry.kind_character."""
607
def _put_in_tar(self, item, tree):
608
"""See InventoryEntry._put_in_tar."""
609
iterm.type = tarfile.SYMTYPE
613
item.linkname = self.symlink_target
616
def _put_on_disk(self, fullpath, tree):
617
"""See InventoryEntry._put_on_disk."""
619
os.symlink(self.symlink_target, fullpath)
621
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
623
def _read_tree_state(self, path, work_tree):
624
"""See InventoryEntry._read_tree_state."""
625
self.symlink_target = work_tree.get_symlink_target(self.file_id)
627
def _unchanged(self, previous_ie):
628
"""See InventoryEntry._unchanged."""
629
compatible = super(InventoryLink, self)._unchanged(previous_ie)
630
if self.symlink_target != previous_ie.symlink_target:
635
class Inventory(object):
636
"""Inventory of versioned files in a tree.
638
This describes which file_id is present at each point in the tree,
639
and possibly the SHA-1 or other information about the file.
640
Entries can be looked up either by path or by file_id.
642
The inventory represents a typical unix file tree, with
643
directories containing files and subdirectories. We never store
644
the full path to a file, because renaming a directory implicitly
645
moves all of its contents. This class internally maintains a
646
lookup tree that allows the children under a directory to be
649
InventoryEntry objects must not be modified after they are
650
inserted, other than through the Inventory API.
652
>>> inv = Inventory()
653
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
654
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
655
>>> inv['123-123'].name
658
May be treated as an iterator or set to look up file ids:
660
>>> bool(inv.path2id('hello.c'))
665
May also look up by name:
667
>>> [x[0] for x in inv.iter_entries()]
669
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
670
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
671
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
673
def __init__(self, root_id=ROOT_ID):
674
"""Create or read an inventory.
676
If a working directory is specified, the inventory is read
677
from there. If the file is specified, read from that. If not,
678
the inventory is created empty.
680
The inventory is created with a default root directory, with
683
# We are letting Branch.initialize() create a unique inventory
684
# root id. Rather than generating a random one here.
686
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
687
self.root = RootEntry(root_id)
688
self._byid = {self.root.file_id: self.root}
692
other = Inventory(self.root.file_id)
693
# copy recursively so we know directories will be added before
694
# their children. There are more efficient ways than this...
695
for path, entry in self.iter_entries():
696
if entry == self.root:
698
other.add(entry.copy())
703
return iter(self._byid)
707
"""Returns number of entries."""
708
return len(self._byid)
711
def iter_entries(self, from_dir=None):
712
"""Return (path, entry) pairs, in order by name."""
716
elif isinstance(from_dir, basestring):
717
from_dir = self._byid[from_dir]
719
kids = from_dir.children.items()
721
for name, ie in kids:
723
if ie.kind == 'directory':
724
for cn, cie in self.iter_entries(from_dir=ie.file_id):
725
yield os.path.join(name, cn), cie
729
"""Return list of (path, ie) for all entries except the root.
731
This may be faster than iter_entries.
734
def descend(dir_ie, dir_path):
735
kids = dir_ie.children.items()
737
for name, ie in kids:
738
child_path = os.path.join(dir_path, name)
739
accum.append((child_path, ie))
740
if ie.kind == 'directory':
741
descend(ie, child_path)
743
descend(self.root, '')
747
def directories(self):
748
"""Return (path, entry) pairs for all directories, including the root.
751
def descend(parent_ie, parent_path):
752
accum.append((parent_path, parent_ie))
754
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
757
for name, child_ie in kids:
758
child_path = os.path.join(parent_path, name)
759
descend(child_ie, child_path)
760
descend(self.root, '')
765
def __contains__(self, file_id):
766
"""True if this entry contains a file with given id.
768
>>> inv = Inventory()
769
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
770
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
776
return file_id in self._byid
779
def __getitem__(self, file_id):
780
"""Return the entry for given file_id.
782
>>> inv = Inventory()
783
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
784
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
785
>>> inv['123123'].name
789
return self._byid[file_id]
792
raise BzrError("can't look up file_id None")
794
raise BzrError("file_id {%s} not in inventory" % file_id)
797
def get_file_kind(self, file_id):
798
return self._byid[file_id].kind
800
def get_child(self, parent_id, filename):
801
return self[parent_id].children.get(filename)
804
def add(self, entry):
805
"""Add entry to inventory.
807
To add a file to a branch ready to be committed, use Branch.add,
810
Returns the new entry object.
812
if entry.file_id in self._byid:
813
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
815
if entry.parent_id == ROOT_ID or entry.parent_id is None:
816
entry.parent_id = self.root.file_id
819
parent = self._byid[entry.parent_id]
821
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
823
if parent.children.has_key(entry.name):
824
raise BzrError("%s is already versioned" %
825
appendpath(self.id2path(parent.file_id), entry.name))
827
self._byid[entry.file_id] = entry
828
parent.children[entry.name] = entry
832
def add_path(self, relpath, kind, file_id=None):
833
"""Add entry from a path.
835
The immediate parent must already be versioned.
837
Returns the new entry object."""
838
from bzrlib.branch import gen_file_id
840
parts = bzrlib.osutils.splitpath(relpath)
842
raise BzrError("cannot re-add root of inventory")
845
file_id = gen_file_id(relpath)
847
parent_path = parts[:-1]
848
parent_id = self.path2id(parent_path)
849
if parent_id == None:
850
raise NotVersionedError(parent_path)
852
if kind == 'directory':
853
ie = InventoryDirectory(file_id, parts[-1], parent_id)
855
ie = InventoryFile(file_id, parts[-1], parent_id)
856
elif kind == 'symlink':
857
ie = InventoryLink(file_id, parts[-1], parent_id)
859
raise BzrError("unknown kind %r" % kind)
863
def __delitem__(self, file_id):
864
"""Remove entry by id.
866
>>> inv = Inventory()
867
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
868
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
877
assert self[ie.parent_id].children[ie.name] == ie
879
# TODO: Test deleting all children; maybe hoist to a separate
881
if ie.kind == 'directory':
882
for cie in ie.children.values():
883
del self[cie.file_id]
886
del self._byid[file_id]
887
del self[ie.parent_id].children[ie.name]
890
def __eq__(self, other):
891
"""Compare two sets by comparing their contents.
897
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
898
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
901
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
902
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
906
if not isinstance(other, Inventory):
907
return NotImplemented
909
if len(self._byid) != len(other._byid):
910
# shortcut: obviously not the same
913
return self._byid == other._byid
916
def __ne__(self, other):
917
return not self.__eq__(other)
921
raise ValueError('not hashable')
924
def get_idpath(self, file_id):
925
"""Return a list of file_ids for the path to an entry.
927
The list contains one element for each directory followed by
928
the id of the file itself. So the length of the returned list
929
is equal to the depth of the file in the tree, counting the
930
root directory as depth 1.
933
while file_id != None:
935
ie = self._byid[file_id]
937
raise BzrError("file_id {%s} not found in inventory" % file_id)
938
p.insert(0, ie.file_id)
939
file_id = ie.parent_id
943
def id2path(self, file_id):
944
"""Return as a list the path to file_id.
947
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
948
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
949
>>> print i.id2path('foo-id').replace(os.sep, '/')
952
# get all names, skipping root
953
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
954
return os.sep.join(p)
958
def path2id(self, name):
959
"""Walk down through directories to return entry of last component.
961
names may be either a list of path components, or a single
962
string, in which case it is automatically split.
964
This returns the entry of the last component in the path,
965
which may be either a file or a directory.
967
Returns None iff the path is not found.
969
if isinstance(name, types.StringTypes):
970
name = splitpath(name)
972
mutter("lookup path %r" % name)
977
cie = parent.children[f]
979
assert cie.parent_id == parent.file_id
985
return parent.file_id
988
def has_filename(self, names):
989
return bool(self.path2id(names))
992
def has_id(self, file_id):
993
return self._byid.has_key(file_id)
996
def rename(self, file_id, new_parent_id, new_name):
997
"""Move a file within the inventory.
999
This can change either the name, or the parent, or both.
1001
This does not move the working file."""
1002
if not is_valid_name(new_name):
1003
raise BzrError("not an acceptable filename: %r" % new_name)
1005
new_parent = self._byid[new_parent_id]
1006
if new_name in new_parent.children:
1007
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1009
new_parent_idpath = self.get_idpath(new_parent_id)
1010
if file_id in new_parent_idpath:
1011
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1012
% (self.id2path(file_id), self.id2path(new_parent_id)))
1014
file_ie = self._byid[file_id]
1015
old_parent = self._byid[file_ie.parent_id]
1017
# TODO: Don't leave things messed up if this fails
1019
del old_parent.children[file_ie.name]
1020
new_parent.children[new_name] = file_ie
1022
file_ie.name = new_name
1023
file_ie.parent_id = new_parent_id
1030
def is_valid_name(name):
1032
if _NAME_RE == None:
1033
_NAME_RE = re.compile(r'^[^/\\]+$')
1035
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
