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 get_tar_item(self, root, dp, now, tree):
150
"""Get a tarfile item and a file stream for its content."""
151
item = tarfile.TarInfo(os.path.join(root, dp))
152
# TODO: would be cool to actually set it to the timestamp of the
153
# revision it was last changed
155
fileobj = self._put_in_tar(item, tree)
159
"""Return true if the object this entry represents has textual data.
161
Note that textual data includes binary content.
163
Also note that all entries get weave files created for them.
164
This attribute is primarily used when upgrading from old trees that
165
did not have the weave index for all inventory entries.
169
def __init__(self, file_id, name, parent_id, text_id=None):
170
"""Create an InventoryEntry
172
The filename must be a single component, relative to the
173
parent directory; it cannot be a whole path or relative name.
175
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
180
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
181
Traceback (most recent call last):
182
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
184
assert isinstance(name, basestring), name
185
if '/' in name or '\\' in name:
186
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
188
self.executable = False
190
self.text_sha1 = None
191
self.text_size = None
192
self.file_id = file_id
194
self.text_id = text_id
195
self.parent_id = parent_id
196
self.symlink_target = None
198
def kind_character(self):
199
"""Return a short kind indicator useful for appending to names."""
200
raise BzrError('unknown kind %r' % self.kind)
202
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
204
def _put_in_tar(self, item, tree):
205
"""populate item for stashing in a tar, and return the content stream.
207
If no content is available, return None.
209
raise BzrError("don't know how to export {%s} of kind %r" %
210
(self.file_id, self.kind))
212
def put_on_disk(self, dest, dp, tree):
213
"""Create a representation of self on disk in the prefix dest.
215
This is a template method - implement _put_on_disk in subclasses.
217
fullpath = appendpath(dest, dp)
218
self._put_on_disk(fullpath, tree)
219
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
221
def _put_on_disk(self, fullpath, tree):
222
"""Put this entry onto disk at fullpath, from tree tree."""
223
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
225
def sorted_children(self):
226
l = self.children.items()
231
def versionable_kind(kind):
232
return kind in ('file', 'directory', 'symlink')
234
def check(self, checker, rev_id, inv, tree):
235
"""Check this inventory entry is intact.
237
This is a template method, override _check for kind specific
240
if self.parent_id != None:
241
if not inv.has_id(self.parent_id):
242
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
243
% (self.parent_id, rev_id))
244
self._check(checker, rev_id, tree)
246
def _check(self, checker, rev_id, tree):
247
"""Check this inventory entry for kind specific errors."""
248
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
253
"""Clone this inventory entry."""
254
raise NotImplementedError
256
def _get_snapshot_change(self, previous_entries):
257
if len(previous_entries) > 1:
259
elif len(previous_entries) == 0:
262
return 'modified/renamed/reparented'
265
return ("%s(%r, %r, parent_id=%r)"
266
% (self.__class__.__name__,
271
def snapshot(self, revision, path, previous_entries, work_tree,
273
"""Make a snapshot of this entry which may or may not have changed.
275
This means that all its fields are populated, that it has its
276
text stored in the text store or weave.
278
mutter('new parents of %s are %r', path, previous_entries)
279
self._read_tree_state(path, work_tree)
280
if len(previous_entries) == 1:
281
# cannot be unchanged unless there is only one parent file rev.
282
parent_ie = previous_entries.values()[0]
283
if self._unchanged(parent_ie):
284
mutter("found unchanged entry")
285
self.revision = parent_ie.revision
287
return self.snapshot_revision(revision, previous_entries,
288
work_tree, weave_store)
290
def snapshot_revision(self, revision, previous_entries, work_tree,
292
"""Record this revision unconditionally."""
293
mutter('new revision for {%s}', self.file_id)
294
self.revision = revision
295
change = self._get_snapshot_change(previous_entries)
296
self._snapshot_text(previous_entries, work_tree, weave_store)
299
def _snapshot_text(self, file_parents, work_tree, weave_store):
300
"""Record the 'text' of this entry, whatever form that takes.
302
This default implementation simply adds an empty text.
304
mutter('storing file {%s} in revision {%s}',
305
self.file_id, self.revision)
306
self._add_text_to_weave([], file_parents, weave_store)
308
def __eq__(self, other):
309
if not isinstance(other, InventoryEntry):
310
return NotImplemented
312
return ((self.file_id == other.file_id)
313
and (self.name == other.name)
314
and (other.symlink_target == self.symlink_target)
315
and (self.text_sha1 == other.text_sha1)
316
and (self.text_size == other.text_size)
317
and (self.text_id == other.text_id)
318
and (self.parent_id == other.parent_id)
319
and (self.kind == other.kind)
320
and (self.revision == other.revision)
321
and (self.executable == other.executable)
324
def __ne__(self, other):
325
return not (self == other)
328
raise ValueError('not hashable')
330
def _unchanged(self, previous_ie):
331
"""Has this entry changed relative to previous_ie.
333
This method should be overriden in child classes.
336
# different inv parent
337
if previous_ie.parent_id != self.parent_id:
340
elif previous_ie.name != self.name:
344
def _read_tree_state(self, path, work_tree):
345
"""Populate fields in the inventory entry from the given tree.
347
Note that this should be modified to be a noop on virtual trees
348
as all entries created there are prepopulated.
352
class RootEntry(InventoryEntry):
354
def _check(self, checker, rev_id, tree):
355
"""See InventoryEntry._check"""
357
def __init__(self, file_id):
358
self.file_id = file_id
360
self.kind = 'root_directory'
361
self.parent_id = None
364
def __eq__(self, other):
365
if not isinstance(other, RootEntry):
366
return NotImplemented
368
return (self.file_id == other.file_id) \
369
and (self.children == other.children)
372
class InventoryDirectory(InventoryEntry):
373
"""A directory in an inventory."""
375
def _check(self, checker, rev_id, tree):
376
"""See InventoryEntry._check"""
377
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
378
raise BzrCheckError('directory {%s} has text in revision {%s}'
379
% (self.file_id, rev_id))
382
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
383
other.revision = self.revision
384
# note that children are *not* copied; they're pulled across when
388
def __init__(self, file_id, name, parent_id):
389
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
391
self.kind = 'directory'
393
def kind_character(self):
394
"""See InventoryEntry.kind_character."""
397
def _put_in_tar(self, item, tree):
398
"""See InventoryEntry._put_in_tar."""
399
item.type = tarfile.DIRTYPE
406
def _put_on_disk(self, fullpath, tree):
407
"""See InventoryEntry._put_on_disk."""
411
class InventoryFile(InventoryEntry):
412
"""A file in an inventory."""
414
def _check(self, checker, rev_id, tree):
415
"""See InventoryEntry._check"""
416
revision = self.revision
417
t = (self.file_id, revision)
418
if t in checker.checked_texts:
419
prev_sha = checker.checked_texts[t]
420
if prev_sha != self.text_sha1:
421
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
422
(self.file_id, rev_id))
424
checker.repeated_text_cnt += 1
426
mutter('check version {%s} of {%s}', rev_id, self.file_id)
427
file_lines = tree.get_file_lines(self.file_id)
428
checker.checked_text_cnt += 1
429
if self.text_size != sum(map(len, file_lines)):
430
raise BzrCheckError('text {%s} wrong size' % self.text_id)
431
if self.text_sha1 != sha_strings(file_lines):
432
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
433
checker.checked_texts[t] = self.text_sha1
436
other = InventoryFile(self.file_id, self.name, self.parent_id)
437
other.executable = self.executable
438
other.text_id = self.text_id
439
other.text_sha1 = self.text_sha1
440
other.text_size = self.text_size
441
other.revision = self.revision
444
def detect_changes(self, old_entry):
445
"""See InventoryEntry.detect_changes."""
446
assert self.text_sha1 != None
447
assert old_entry.text_sha1 != None
448
text_modified = (self.text_sha1 != old_entry.text_sha1)
449
meta_modified = (self.executable != old_entry.executable)
450
return text_modified, meta_modified
452
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
453
output_to, reverse=False):
454
"""See InventoryEntry._diff."""
455
from_text = tree.get_file(self.file_id).readlines()
457
to_text = to_tree.get_file(to_entry.file_id).readlines()
461
text_diff(from_label, from_text,
462
to_label, to_text, output_to)
464
text_diff(to_label, to_text,
465
from_label, from_text, output_to)
468
"""See InventoryEntry.has_text."""
471
def __init__(self, file_id, name, parent_id):
472
super(InventoryFile, self).__init__(file_id, name, parent_id)
475
def kind_character(self):
476
"""See InventoryEntry.kind_character."""
479
def _put_in_tar(self, item, tree):
480
"""See InventoryEntry._put_in_tar."""
481
item.type = tarfile.REGTYPE
482
fileobj = tree.get_file(self.file_id)
483
item.size = self.text_size
484
if tree.is_executable(self.file_id):
490
def _put_on_disk(self, fullpath, tree):
491
"""See InventoryEntry._put_on_disk."""
492
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
493
if tree.is_executable(self.file_id):
494
os.chmod(fullpath, 0755)
496
def _read_tree_state(self, path, work_tree):
497
"""See InventoryEntry._read_tree_state."""
498
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
499
self.executable = work_tree.is_executable(self.file_id)
501
def _snapshot_text(self, file_parents, work_tree, weave_store):
502
"""See InventoryEntry._snapshot_text."""
503
mutter('storing file {%s} in revision {%s}',
504
self.file_id, self.revision)
505
# special case to avoid diffing on renames or
507
if (len(file_parents) == 1
508
and self.text_sha1 == file_parents.values()[0].text_sha1
509
and self.text_size == file_parents.values()[0].text_size):
510
previous_ie = file_parents.values()[0]
511
weave_store.add_identical_text(
512
self.file_id, previous_ie.revision,
513
self.revision, file_parents)
515
new_lines = work_tree.get_file(self.file_id).readlines()
516
self._add_text_to_weave(new_lines, file_parents, weave_store)
517
self.text_sha1 = sha_strings(new_lines)
518
self.text_size = sum(map(len, new_lines))
521
def _unchanged(self, previous_ie):
522
"""See InventoryEntry._unchanged."""
523
compatible = super(InventoryFile, self)._unchanged(previous_ie)
524
if self.text_sha1 != previous_ie.text_sha1:
527
# FIXME: 20050930 probe for the text size when getting sha1
528
# in _read_tree_state
529
self.text_size = previous_ie.text_size
533
class InventoryLink(InventoryEntry):
534
"""A file in an inventory."""
536
__slots__ = ['symlink_target']
538
def _check(self, checker, rev_id, tree):
539
"""See InventoryEntry._check"""
540
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
541
raise BzrCheckError('symlink {%s} has text in revision {%s}'
542
% (self.file_id, rev_id))
543
if self.symlink_target == None:
544
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
545
% (self.file_id, rev_id))
548
other = InventoryLink(self.file_id, self.name, self.parent_id)
549
other.symlink_target = self.symlink_target
550
other.revision = self.revision
553
def detect_changes(self, old_entry):
554
"""See InventoryEntry.detect_changes."""
555
# FIXME: which _modified field should we use ? RBC 20051003
556
text_modified = (self.symlink_target != old_entry.symlink_target)
558
mutter(" symlink target changed")
559
meta_modified = False
560
return text_modified, meta_modified
562
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
563
output_to, reverse=False):
564
"""See InventoryEntry._diff."""
565
from_text = self.symlink_target
566
if to_entry is not None:
567
to_text = to_entry.symlink_target
572
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
575
print >>output_to, '=== target was %r' % self.symlink_target
577
print >>output_to, '=== target is %r' % self.symlink_target
579
def __init__(self, file_id, name, parent_id):
580
super(InventoryLink, self).__init__(file_id, name, parent_id)
581
self.kind = 'symlink'
583
def kind_character(self):
584
"""See InventoryEntry.kind_character."""
587
def _put_in_tar(self, item, tree):
588
"""See InventoryEntry._put_in_tar."""
589
iterm.type = tarfile.SYMTYPE
593
item.linkname = self.symlink_target
596
def _put_on_disk(self, fullpath, tree):
597
"""See InventoryEntry._put_on_disk."""
599
os.symlink(self.symlink_target, fullpath)
601
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
603
def _read_tree_state(self, path, work_tree):
604
"""See InventoryEntry._read_tree_state."""
605
self.symlink_target = work_tree.get_symlink_target(self.file_id)
607
def _unchanged(self, previous_ie):
608
"""See InventoryEntry._unchanged."""
609
compatible = super(InventoryLink, self)._unchanged(previous_ie)
610
if self.symlink_target != previous_ie.symlink_target:
615
class Inventory(object):
616
"""Inventory of versioned files in a tree.
618
This describes which file_id is present at each point in the tree,
619
and possibly the SHA-1 or other information about the file.
620
Entries can be looked up either by path or by file_id.
622
The inventory represents a typical unix file tree, with
623
directories containing files and subdirectories. We never store
624
the full path to a file, because renaming a directory implicitly
625
moves all of its contents. This class internally maintains a
626
lookup tree that allows the children under a directory to be
629
InventoryEntry objects must not be modified after they are
630
inserted, other than through the Inventory API.
632
>>> inv = Inventory()
633
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
634
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
635
>>> inv['123-123'].name
638
May be treated as an iterator or set to look up file ids:
640
>>> bool(inv.path2id('hello.c'))
645
May also look up by name:
647
>>> [x[0] for x in inv.iter_entries()]
649
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
650
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
651
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
653
def __init__(self, root_id=ROOT_ID):
654
"""Create or read an inventory.
656
If a working directory is specified, the inventory is read
657
from there. If the file is specified, read from that. If not,
658
the inventory is created empty.
660
The inventory is created with a default root directory, with
663
# We are letting Branch.initialize() create a unique inventory
664
# root id. Rather than generating a random one here.
666
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
667
self.root = RootEntry(root_id)
668
self._byid = {self.root.file_id: self.root}
672
other = Inventory(self.root.file_id)
673
# copy recursively so we know directories will be added before
674
# their children. There are more efficient ways than this...
675
for path, entry in self.iter_entries():
676
if entry == self.root:
678
other.add(entry.copy())
683
return iter(self._byid)
687
"""Returns number of entries."""
688
return len(self._byid)
691
def iter_entries(self, from_dir=None):
692
"""Return (path, entry) pairs, in order by name."""
696
elif isinstance(from_dir, basestring):
697
from_dir = self._byid[from_dir]
699
kids = from_dir.children.items()
701
for name, ie in kids:
703
if ie.kind == 'directory':
704
for cn, cie in self.iter_entries(from_dir=ie.file_id):
705
yield os.path.join(name, cn), cie
709
"""Return list of (path, ie) for all entries except the root.
711
This may be faster than iter_entries.
714
def descend(dir_ie, dir_path):
715
kids = dir_ie.children.items()
717
for name, ie in kids:
718
child_path = os.path.join(dir_path, name)
719
accum.append((child_path, ie))
720
if ie.kind == 'directory':
721
descend(ie, child_path)
723
descend(self.root, '')
727
def directories(self):
728
"""Return (path, entry) pairs for all directories, including the root.
731
def descend(parent_ie, parent_path):
732
accum.append((parent_path, parent_ie))
734
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
737
for name, child_ie in kids:
738
child_path = os.path.join(parent_path, name)
739
descend(child_ie, child_path)
740
descend(self.root, '')
745
def __contains__(self, file_id):
746
"""True if this entry contains a file with given id.
748
>>> inv = Inventory()
749
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
750
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
756
return file_id in self._byid
759
def __getitem__(self, file_id):
760
"""Return the entry for given file_id.
762
>>> inv = Inventory()
763
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
764
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
765
>>> inv['123123'].name
769
return self._byid[file_id]
772
raise BzrError("can't look up file_id None")
774
raise BzrError("file_id {%s} not in inventory" % file_id)
777
def get_file_kind(self, file_id):
778
return self._byid[file_id].kind
780
def get_child(self, parent_id, filename):
781
return self[parent_id].children.get(filename)
784
def add(self, entry):
785
"""Add entry to inventory.
787
To add a file to a branch ready to be committed, use Branch.add,
790
Returns the new entry object.
792
if entry.file_id in self._byid:
793
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
795
if entry.parent_id == ROOT_ID or entry.parent_id is None:
796
entry.parent_id = self.root.file_id
799
parent = self._byid[entry.parent_id]
801
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
803
if parent.children.has_key(entry.name):
804
raise BzrError("%s is already versioned" %
805
appendpath(self.id2path(parent.file_id), entry.name))
807
self._byid[entry.file_id] = entry
808
parent.children[entry.name] = entry
812
def add_path(self, relpath, kind, file_id=None):
813
"""Add entry from a path.
815
The immediate parent must already be versioned.
817
Returns the new entry object."""
818
from bzrlib.branch import gen_file_id
820
parts = bzrlib.osutils.splitpath(relpath)
822
raise BzrError("cannot re-add root of inventory")
825
file_id = gen_file_id(relpath)
827
parent_path = parts[:-1]
828
parent_id = self.path2id(parent_path)
829
if parent_id == None:
830
raise NotVersionedError(parent_path)
832
if kind == 'directory':
833
ie = InventoryDirectory(file_id, parts[-1], parent_id)
835
ie = InventoryFile(file_id, parts[-1], parent_id)
836
elif kind == 'symlink':
837
ie = InventoryLink(file_id, parts[-1], parent_id)
839
raise BzrError("unknown kind %r" % kind)
843
def __delitem__(self, file_id):
844
"""Remove entry by id.
846
>>> inv = Inventory()
847
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
848
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
857
assert self[ie.parent_id].children[ie.name] == ie
859
# TODO: Test deleting all children; maybe hoist to a separate
861
if ie.kind == 'directory':
862
for cie in ie.children.values():
863
del self[cie.file_id]
866
del self._byid[file_id]
867
del self[ie.parent_id].children[ie.name]
870
def __eq__(self, other):
871
"""Compare two sets by comparing their contents.
877
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
878
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
881
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
882
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
886
if not isinstance(other, Inventory):
887
return NotImplemented
889
if len(self._byid) != len(other._byid):
890
# shortcut: obviously not the same
893
return self._byid == other._byid
896
def __ne__(self, other):
897
return not self.__eq__(other)
901
raise ValueError('not hashable')
904
def get_idpath(self, file_id):
905
"""Return a list of file_ids for the path to an entry.
907
The list contains one element for each directory followed by
908
the id of the file itself. So the length of the returned list
909
is equal to the depth of the file in the tree, counting the
910
root directory as depth 1.
913
while file_id != None:
915
ie = self._byid[file_id]
917
raise BzrError("file_id {%s} not found in inventory" % file_id)
918
p.insert(0, ie.file_id)
919
file_id = ie.parent_id
923
def id2path(self, file_id):
924
"""Return as a list the path to file_id.
927
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
928
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
929
>>> print i.id2path('foo-id').replace(os.sep, '/')
932
# get all names, skipping root
933
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
934
return os.sep.join(p)
938
def path2id(self, name):
939
"""Walk down through directories to return entry of last component.
941
names may be either a list of path components, or a single
942
string, in which case it is automatically split.
944
This returns the entry of the last component in the path,
945
which may be either a file or a directory.
947
Returns None iff the path is not found.
949
if isinstance(name, types.StringTypes):
950
name = splitpath(name)
952
mutter("lookup path %r" % name)
957
cie = parent.children[f]
959
assert cie.parent_id == parent.file_id
965
return parent.file_id
968
def has_filename(self, names):
969
return bool(self.path2id(names))
972
def has_id(self, file_id):
973
return self._byid.has_key(file_id)
976
def rename(self, file_id, new_parent_id, new_name):
977
"""Move a file within the inventory.
979
This can change either the name, or the parent, or both.
981
This does not move the working file."""
982
if not is_valid_name(new_name):
983
raise BzrError("not an acceptable filename: %r" % new_name)
985
new_parent = self._byid[new_parent_id]
986
if new_name in new_parent.children:
987
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
989
new_parent_idpath = self.get_idpath(new_parent_id)
990
if file_id in new_parent_idpath:
991
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
992
% (self.id2path(file_id), self.id2path(new_parent_id)))
994
file_ie = self._byid[file_id]
995
old_parent = self._byid[file_ie.parent_id]
997
# TODO: Don't leave things messed up if this fails
999
del old_parent.children[file_ie.name]
1000
new_parent.children[new_name] = file_ie
1002
file_ie.name = new_name
1003
file_ie.parent_id = new_parent_id
1010
def is_valid_name(name):
1012
if _NAME_RE == None:
1013
_NAME_RE = re.compile(r'^[^/\\]+$')
1015
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
