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, transaction):
118
weave_store.add_text(self.file_id, self.revision, new_lines, parents,
121
def detect_changes(self, old_entry):
122
"""Return a (text_modified, meta_modified) from this to old_entry.
124
_read_tree_state must have been called on self and old_entry prior to
125
calling detect_changes.
129
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
130
output_to, reverse=False):
131
"""Perform a diff from this to to_entry.
133
text_diff will be used for textual difference calculation.
134
This is a template method, override _diff in child classes.
136
self._read_tree_state(tree.id2path(self.file_id), tree)
138
# cannot diff from one kind to another - you must do a removal
139
# and an addif they do not match.
140
assert self.kind == to_entry.kind
141
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
143
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
146
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
147
output_to, reverse=False):
148
"""Perform a diff between two entries of the same kind."""
150
def find_previous_heads(self, previous_inventories, entry_weave):
151
"""Return the revisions and entries that directly preceed this.
153
Returned as a map from revision to inventory entry.
155
This is a map containing the file revisions in all parents
156
for which the file exists, and its revision is not a parent of
157
any other. If the file is new, the set will be empty.
159
def get_ancestors(weave, entry):
160
return set(map(weave.idx_to_name,
161
weave.inclusions([weave.lookup(entry.revision)])))
164
for inv in previous_inventories:
165
if self.file_id in inv:
166
ie = inv[self.file_id]
167
assert ie.file_id == self.file_id
168
if ie.revision in heads:
169
# fixup logic, there was a bug in revision updates.
170
# with x bit support.
172
if heads[ie.revision].executable != ie.executable:
173
heads[ie.revision].executable = False
174
ie.executable = False
175
except AttributeError:
177
assert heads[ie.revision] == ie
179
# may want to add it.
180
# may already be covered:
181
already_present = 0 != len(
182
[head for head in heads
183
if ie.revision in head_ancestors[head]])
185
# an ancestor of a known head.
188
ancestors = get_ancestors(entry_weave, ie)
189
# may knock something else out:
190
check_heads = list(heads.keys())
191
for head in check_heads:
192
if head in ancestors:
193
# this head is not really a head
195
head_ancestors[ie.revision] = ancestors
196
heads[ie.revision] = ie
199
def get_tar_item(self, root, dp, now, tree):
200
"""Get a tarfile item and a file stream for its content."""
201
item = tarfile.TarInfo(os.path.join(root, dp))
202
# TODO: would be cool to actually set it to the timestamp of the
203
# revision it was last changed
205
fileobj = self._put_in_tar(item, tree)
209
"""Return true if the object this entry represents has textual data.
211
Note that textual data includes binary content.
213
Also note that all entries get weave files created for them.
214
This attribute is primarily used when upgrading from old trees that
215
did not have the weave index for all inventory entries.
219
def __init__(self, file_id, name, parent_id, text_id=None):
220
"""Create an InventoryEntry
222
The filename must be a single component, relative to the
223
parent directory; it cannot be a whole path or relative name.
225
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
230
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
231
Traceback (most recent call last):
232
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
234
assert isinstance(name, basestring), name
235
if '/' in name or '\\' in name:
236
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
238
self.executable = False
240
self.text_sha1 = None
241
self.text_size = None
242
self.file_id = file_id
244
self.text_id = text_id
245
self.parent_id = parent_id
246
self.symlink_target = None
248
def kind_character(self):
249
"""Return a short kind indicator useful for appending to names."""
250
raise BzrError('unknown kind %r' % self.kind)
252
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
254
def _put_in_tar(self, item, tree):
255
"""populate item for stashing in a tar, and return the content stream.
257
If no content is available, return None.
259
raise BzrError("don't know how to export {%s} of kind %r" %
260
(self.file_id, self.kind))
262
def put_on_disk(self, dest, dp, tree):
263
"""Create a representation of self on disk in the prefix dest.
265
This is a template method - implement _put_on_disk in subclasses.
267
fullpath = appendpath(dest, dp)
268
self._put_on_disk(fullpath, tree)
269
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
271
def _put_on_disk(self, fullpath, tree):
272
"""Put this entry onto disk at fullpath, from tree tree."""
273
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
275
def sorted_children(self):
276
l = self.children.items()
281
def versionable_kind(kind):
282
return kind in ('file', 'directory', 'symlink')
284
def check(self, checker, rev_id, inv, tree):
285
"""Check this inventory entry is intact.
287
This is a template method, override _check for kind specific
290
if self.parent_id != None:
291
if not inv.has_id(self.parent_id):
292
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
293
% (self.parent_id, rev_id))
294
self._check(checker, rev_id, tree)
296
def _check(self, checker, rev_id, tree):
297
"""Check this inventory entry for kind specific errors."""
298
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
303
"""Clone this inventory entry."""
304
raise NotImplementedError
306
def _get_snapshot_change(self, previous_entries):
307
if len(previous_entries) > 1:
309
elif len(previous_entries) == 0:
312
return 'modified/renamed/reparented'
315
return ("%s(%r, %r, parent_id=%r)"
316
% (self.__class__.__name__,
321
def snapshot(self, revision, path, previous_entries,
322
work_tree, weave_store, transaction):
323
"""Make a snapshot of this entry which may or may not have changed.
325
This means that all its fields are populated, that it has its
326
text stored in the text store or weave.
328
mutter('new parents of %s are %r', path, previous_entries)
329
self._read_tree_state(path, work_tree)
330
if len(previous_entries) == 1:
331
# cannot be unchanged unless there is only one parent file rev.
332
parent_ie = previous_entries.values()[0]
333
if self._unchanged(parent_ie):
334
mutter("found unchanged entry")
335
self.revision = parent_ie.revision
337
return self.snapshot_revision(revision, previous_entries,
338
work_tree, weave_store, transaction)
340
def snapshot_revision(self, revision, previous_entries, work_tree,
341
weave_store, transaction):
342
"""Record this revision unconditionally."""
343
mutter('new revision for {%s}', self.file_id)
344
self.revision = revision
345
change = self._get_snapshot_change(previous_entries)
346
self._snapshot_text(previous_entries, work_tree, weave_store,
350
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
351
"""Record the 'text' of this entry, whatever form that takes.
353
This default implementation simply adds an empty text.
355
mutter('storing file {%s} in revision {%s}',
356
self.file_id, self.revision)
357
self._add_text_to_weave([], file_parents, weave_store, transaction)
359
def __eq__(self, other):
360
if not isinstance(other, InventoryEntry):
361
return NotImplemented
363
return ((self.file_id == other.file_id)
364
and (self.name == other.name)
365
and (other.symlink_target == self.symlink_target)
366
and (self.text_sha1 == other.text_sha1)
367
and (self.text_size == other.text_size)
368
and (self.text_id == other.text_id)
369
and (self.parent_id == other.parent_id)
370
and (self.kind == other.kind)
371
and (self.revision == other.revision)
372
and (self.executable == other.executable)
375
def __ne__(self, other):
376
return not (self == other)
379
raise ValueError('not hashable')
381
def _unchanged(self, previous_ie):
382
"""Has this entry changed relative to previous_ie.
384
This method should be overriden in child classes.
387
# different inv parent
388
if previous_ie.parent_id != self.parent_id:
391
elif previous_ie.name != self.name:
395
def _read_tree_state(self, path, work_tree):
396
"""Populate fields in the inventory entry from the given tree.
398
Note that this should be modified to be a noop on virtual trees
399
as all entries created there are prepopulated.
403
class RootEntry(InventoryEntry):
405
def _check(self, checker, rev_id, tree):
406
"""See InventoryEntry._check"""
408
def __init__(self, file_id):
409
self.file_id = file_id
411
self.kind = 'root_directory'
412
self.parent_id = None
415
def __eq__(self, other):
416
if not isinstance(other, RootEntry):
417
return NotImplemented
419
return (self.file_id == other.file_id) \
420
and (self.children == other.children)
423
class InventoryDirectory(InventoryEntry):
424
"""A directory in an inventory."""
426
def _check(self, checker, rev_id, tree):
427
"""See InventoryEntry._check"""
428
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
429
raise BzrCheckError('directory {%s} has text in revision {%s}'
430
% (self.file_id, rev_id))
433
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
434
other.revision = self.revision
435
# note that children are *not* copied; they're pulled across when
439
def __init__(self, file_id, name, parent_id):
440
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
442
self.kind = 'directory'
444
def kind_character(self):
445
"""See InventoryEntry.kind_character."""
448
def _put_in_tar(self, item, tree):
449
"""See InventoryEntry._put_in_tar."""
450
item.type = tarfile.DIRTYPE
457
def _put_on_disk(self, fullpath, tree):
458
"""See InventoryEntry._put_on_disk."""
462
class InventoryFile(InventoryEntry):
463
"""A file in an inventory."""
465
def _check(self, checker, rev_id, tree):
466
"""See InventoryEntry._check"""
467
revision = self.revision
468
t = (self.file_id, revision)
469
if t in checker.checked_texts:
470
prev_sha = checker.checked_texts[t]
471
if prev_sha != self.text_sha1:
472
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
473
(self.file_id, rev_id))
475
checker.repeated_text_cnt += 1
477
mutter('check version {%s} of {%s}', rev_id, self.file_id)
478
file_lines = tree.get_file_lines(self.file_id)
479
checker.checked_text_cnt += 1
480
if self.text_size != sum(map(len, file_lines)):
481
raise BzrCheckError('text {%s} wrong size' % self.text_id)
482
if self.text_sha1 != sha_strings(file_lines):
483
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
484
checker.checked_texts[t] = self.text_sha1
487
other = InventoryFile(self.file_id, self.name, self.parent_id)
488
other.executable = self.executable
489
other.text_id = self.text_id
490
other.text_sha1 = self.text_sha1
491
other.text_size = self.text_size
492
other.revision = self.revision
495
def detect_changes(self, old_entry):
496
"""See InventoryEntry.detect_changes."""
497
assert self.text_sha1 != None
498
assert old_entry.text_sha1 != None
499
text_modified = (self.text_sha1 != old_entry.text_sha1)
500
meta_modified = (self.executable != old_entry.executable)
501
return text_modified, meta_modified
503
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
504
output_to, reverse=False):
505
"""See InventoryEntry._diff."""
506
from_text = tree.get_file(self.file_id).readlines()
508
to_text = to_tree.get_file(to_entry.file_id).readlines()
512
text_diff(from_label, from_text,
513
to_label, to_text, output_to)
515
text_diff(to_label, to_text,
516
from_label, from_text, output_to)
519
"""See InventoryEntry.has_text."""
522
def __init__(self, file_id, name, parent_id):
523
super(InventoryFile, self).__init__(file_id, name, parent_id)
526
def kind_character(self):
527
"""See InventoryEntry.kind_character."""
530
def _put_in_tar(self, item, tree):
531
"""See InventoryEntry._put_in_tar."""
532
item.type = tarfile.REGTYPE
533
fileobj = tree.get_file(self.file_id)
534
item.size = self.text_size
535
if tree.is_executable(self.file_id):
541
def _put_on_disk(self, fullpath, tree):
542
"""See InventoryEntry._put_on_disk."""
543
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
544
if tree.is_executable(self.file_id):
545
os.chmod(fullpath, 0755)
547
def _read_tree_state(self, path, work_tree):
548
"""See InventoryEntry._read_tree_state."""
549
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
550
self.executable = work_tree.is_executable(self.file_id)
552
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
553
"""See InventoryEntry._snapshot_text."""
554
mutter('storing file {%s} in revision {%s}',
555
self.file_id, self.revision)
556
# special case to avoid diffing on renames or
558
if (len(file_parents) == 1
559
and self.text_sha1 == file_parents.values()[0].text_sha1
560
and self.text_size == file_parents.values()[0].text_size):
561
previous_ie = file_parents.values()[0]
562
weave_store.add_identical_text(
563
self.file_id, previous_ie.revision,
564
self.revision, file_parents, transaction)
566
new_lines = work_tree.get_file(self.file_id).readlines()
567
self._add_text_to_weave(new_lines, file_parents, weave_store,
569
self.text_sha1 = sha_strings(new_lines)
570
self.text_size = sum(map(len, new_lines))
573
def _unchanged(self, previous_ie):
574
"""See InventoryEntry._unchanged."""
575
compatible = super(InventoryFile, self)._unchanged(previous_ie)
576
if self.text_sha1 != previous_ie.text_sha1:
579
# FIXME: 20050930 probe for the text size when getting sha1
580
# in _read_tree_state
581
self.text_size = previous_ie.text_size
585
class InventoryLink(InventoryEntry):
586
"""A file in an inventory."""
588
__slots__ = ['symlink_target']
590
def _check(self, checker, rev_id, tree):
591
"""See InventoryEntry._check"""
592
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
593
raise BzrCheckError('symlink {%s} has text in revision {%s}'
594
% (self.file_id, rev_id))
595
if self.symlink_target == None:
596
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
597
% (self.file_id, rev_id))
600
other = InventoryLink(self.file_id, self.name, self.parent_id)
601
other.symlink_target = self.symlink_target
602
other.revision = self.revision
605
def detect_changes(self, old_entry):
606
"""See InventoryEntry.detect_changes."""
607
# FIXME: which _modified field should we use ? RBC 20051003
608
text_modified = (self.symlink_target != old_entry.symlink_target)
610
mutter(" symlink target changed")
611
meta_modified = False
612
return text_modified, meta_modified
614
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
615
output_to, reverse=False):
616
"""See InventoryEntry._diff."""
617
from_text = self.symlink_target
618
if to_entry is not None:
619
to_text = to_entry.symlink_target
624
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
627
print >>output_to, '=== target was %r' % self.symlink_target
629
print >>output_to, '=== target is %r' % self.symlink_target
631
def __init__(self, file_id, name, parent_id):
632
super(InventoryLink, self).__init__(file_id, name, parent_id)
633
self.kind = 'symlink'
635
def kind_character(self):
636
"""See InventoryEntry.kind_character."""
639
def _put_in_tar(self, item, tree):
640
"""See InventoryEntry._put_in_tar."""
641
iterm.type = tarfile.SYMTYPE
645
item.linkname = self.symlink_target
648
def _put_on_disk(self, fullpath, tree):
649
"""See InventoryEntry._put_on_disk."""
651
os.symlink(self.symlink_target, fullpath)
653
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
655
def _read_tree_state(self, path, work_tree):
656
"""See InventoryEntry._read_tree_state."""
657
self.symlink_target = work_tree.get_symlink_target(self.file_id)
659
def _unchanged(self, previous_ie):
660
"""See InventoryEntry._unchanged."""
661
compatible = super(InventoryLink, self)._unchanged(previous_ie)
662
if self.symlink_target != previous_ie.symlink_target:
667
class Inventory(object):
668
"""Inventory of versioned files in a tree.
670
This describes which file_id is present at each point in the tree,
671
and possibly the SHA-1 or other information about the file.
672
Entries can be looked up either by path or by file_id.
674
The inventory represents a typical unix file tree, with
675
directories containing files and subdirectories. We never store
676
the full path to a file, because renaming a directory implicitly
677
moves all of its contents. This class internally maintains a
678
lookup tree that allows the children under a directory to be
681
InventoryEntry objects must not be modified after they are
682
inserted, other than through the Inventory API.
684
>>> inv = Inventory()
685
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
686
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
687
>>> inv['123-123'].name
690
May be treated as an iterator or set to look up file ids:
692
>>> bool(inv.path2id('hello.c'))
697
May also look up by name:
699
>>> [x[0] for x in inv.iter_entries()]
701
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
702
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
703
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
705
def __init__(self, root_id=ROOT_ID):
706
"""Create or read an inventory.
708
If a working directory is specified, the inventory is read
709
from there. If the file is specified, read from that. If not,
710
the inventory is created empty.
712
The inventory is created with a default root directory, with
715
# We are letting Branch.initialize() create a unique inventory
716
# root id. Rather than generating a random one here.
718
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
719
self.root = RootEntry(root_id)
720
self._byid = {self.root.file_id: self.root}
724
other = Inventory(self.root.file_id)
725
# copy recursively so we know directories will be added before
726
# their children. There are more efficient ways than this...
727
for path, entry in self.iter_entries():
728
if entry == self.root:
730
other.add(entry.copy())
735
return iter(self._byid)
739
"""Returns number of entries."""
740
return len(self._byid)
743
def iter_entries(self, from_dir=None):
744
"""Return (path, entry) pairs, in order by name."""
748
elif isinstance(from_dir, basestring):
749
from_dir = self._byid[from_dir]
751
kids = from_dir.children.items()
753
for name, ie in kids:
755
if ie.kind == 'directory':
756
for cn, cie in self.iter_entries(from_dir=ie.file_id):
757
yield os.path.join(name, cn), cie
761
"""Return list of (path, ie) for all entries except the root.
763
This may be faster than iter_entries.
766
def descend(dir_ie, dir_path):
767
kids = dir_ie.children.items()
769
for name, ie in kids:
770
child_path = os.path.join(dir_path, name)
771
accum.append((child_path, ie))
772
if ie.kind == 'directory':
773
descend(ie, child_path)
775
descend(self.root, '')
779
def directories(self):
780
"""Return (path, entry) pairs for all directories, including the root.
783
def descend(parent_ie, parent_path):
784
accum.append((parent_path, parent_ie))
786
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
789
for name, child_ie in kids:
790
child_path = os.path.join(parent_path, name)
791
descend(child_ie, child_path)
792
descend(self.root, '')
797
def __contains__(self, file_id):
798
"""True if this entry contains a file with given id.
800
>>> inv = Inventory()
801
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
802
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
808
return file_id in self._byid
811
def __getitem__(self, file_id):
812
"""Return the entry for given file_id.
814
>>> inv = Inventory()
815
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
816
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
817
>>> inv['123123'].name
821
return self._byid[file_id]
824
raise BzrError("can't look up file_id None")
826
raise BzrError("file_id {%s} not in inventory" % file_id)
829
def get_file_kind(self, file_id):
830
return self._byid[file_id].kind
832
def get_child(self, parent_id, filename):
833
return self[parent_id].children.get(filename)
836
def add(self, entry):
837
"""Add entry to inventory.
839
To add a file to a branch ready to be committed, use Branch.add,
842
Returns the new entry object.
844
if entry.file_id in self._byid:
845
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
847
if entry.parent_id == ROOT_ID or entry.parent_id is None:
848
entry.parent_id = self.root.file_id
851
parent = self._byid[entry.parent_id]
853
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
855
if parent.children.has_key(entry.name):
856
raise BzrError("%s is already versioned" %
857
appendpath(self.id2path(parent.file_id), entry.name))
859
self._byid[entry.file_id] = entry
860
parent.children[entry.name] = entry
864
def add_path(self, relpath, kind, file_id=None):
865
"""Add entry from a path.
867
The immediate parent must already be versioned.
869
Returns the new entry object."""
870
from bzrlib.branch import gen_file_id
872
parts = bzrlib.osutils.splitpath(relpath)
874
raise BzrError("cannot re-add root of inventory")
877
file_id = gen_file_id(relpath)
879
parent_path = parts[:-1]
880
parent_id = self.path2id(parent_path)
881
if parent_id == None:
882
raise NotVersionedError(parent_path)
884
if kind == 'directory':
885
ie = InventoryDirectory(file_id, parts[-1], parent_id)
887
ie = InventoryFile(file_id, parts[-1], parent_id)
888
elif kind == 'symlink':
889
ie = InventoryLink(file_id, parts[-1], parent_id)
891
raise BzrError("unknown kind %r" % kind)
895
def __delitem__(self, file_id):
896
"""Remove entry by id.
898
>>> inv = Inventory()
899
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
900
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
909
assert self[ie.parent_id].children[ie.name] == ie
911
# TODO: Test deleting all children; maybe hoist to a separate
913
if ie.kind == 'directory':
914
for cie in ie.children.values():
915
del self[cie.file_id]
918
del self._byid[file_id]
919
del self[ie.parent_id].children[ie.name]
922
def __eq__(self, other):
923
"""Compare two sets by comparing their contents.
929
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
930
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
933
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
934
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
938
if not isinstance(other, Inventory):
939
return NotImplemented
941
if len(self._byid) != len(other._byid):
942
# shortcut: obviously not the same
945
return self._byid == other._byid
948
def __ne__(self, other):
949
return not self.__eq__(other)
953
raise ValueError('not hashable')
956
def get_idpath(self, file_id):
957
"""Return a list of file_ids for the path to an entry.
959
The list contains one element for each directory followed by
960
the id of the file itself. So the length of the returned list
961
is equal to the depth of the file in the tree, counting the
962
root directory as depth 1.
965
while file_id != None:
967
ie = self._byid[file_id]
969
raise BzrError("file_id {%s} not found in inventory" % file_id)
970
p.insert(0, ie.file_id)
971
file_id = ie.parent_id
975
def id2path(self, file_id):
976
"""Return as a list the path to file_id.
979
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
980
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
981
>>> print i.id2path('foo-id').replace(os.sep, '/')
984
# get all names, skipping root
985
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
986
return os.sep.join(p)
990
def path2id(self, name):
991
"""Walk down through directories to return entry of last component.
993
names may be either a list of path components, or a single
994
string, in which case it is automatically split.
996
This returns the entry of the last component in the path,
997
which may be either a file or a directory.
999
Returns None iff the path is not found.
1001
if isinstance(name, types.StringTypes):
1002
name = splitpath(name)
1004
mutter("lookup path %r" % name)
1009
cie = parent.children[f]
1010
assert cie.name == f
1011
assert cie.parent_id == parent.file_id
1014
# or raise an error?
1017
return parent.file_id
1020
def has_filename(self, names):
1021
return bool(self.path2id(names))
1024
def has_id(self, file_id):
1025
return self._byid.has_key(file_id)
1028
def rename(self, file_id, new_parent_id, new_name):
1029
"""Move a file within the inventory.
1031
This can change either the name, or the parent, or both.
1033
This does not move the working file."""
1034
if not is_valid_name(new_name):
1035
raise BzrError("not an acceptable filename: %r" % new_name)
1037
new_parent = self._byid[new_parent_id]
1038
if new_name in new_parent.children:
1039
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1041
new_parent_idpath = self.get_idpath(new_parent_id)
1042
if file_id in new_parent_idpath:
1043
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1044
% (self.id2path(file_id), self.id2path(new_parent_id)))
1046
file_ie = self._byid[file_id]
1047
old_parent = self._byid[file_ie.parent_id]
1049
# TODO: Don't leave things messed up if this fails
1051
del old_parent.children[file_ie.name]
1052
new_parent.children[new_name] = file_ie
1054
file_ie.name = new_name
1055
file_ie.parent_id = new_parent_id
1062
def is_valid_name(name):
1064
if _NAME_RE == None:
1065
_NAME_RE = re.compile(r'^[^/\\]+$')
1067
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
