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
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep
18
# the WorkingTree's copy of the inventory in sync with the branch. The
19
# branch modifies its working inventory when it does a commit to make
20
# missing files permanently removed.
22
# TODO: Maybe also keep the full path of the entry, and the children?
23
# But those depend on its position within a particular inventory, and
24
# it would be nice not to need to hold the backpointer here.
26
# This should really be an id randomly assigned when the tree is
27
# created, but it's not for now.
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
39
appendpath, sha_strings)
40
from bzrlib.trace import mutter
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
42
BzrError, BzrCheckError)
45
class InventoryEntry(object):
46
"""Description of a versioned file.
48
An InventoryEntry has the following fields, which are also
49
present in the XML inventory-entry element:
54
(within the parent directory)
57
file_id of the parent directory, or ROOT_ID
60
the revision_id in which this variation of this file was
64
Indicates that this file should be executable on systems
68
sha-1 of the text of the file
71
size in bytes of the text of the file
73
(reading a version 4 tree created a text_id field.)
78
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
79
InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
80
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
81
InventoryFile('2323', 'hello.c', parent_id='123')
82
>>> shouldbe = {0: 'src', 1: os.path.join('src','hello.c')}
83
>>> for ix, j in enumerate(i.iter_entries()):
84
... print (j[0] == shouldbe[ix], j[1])
86
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
87
(True, InventoryFile('2323', 'hello.c', parent_id='123'))
88
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
89
Traceback (most recent call last):
91
BzrError: inventory already contains entry with id {2323}
92
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
93
InventoryFile('2324', 'bye.c', parent_id='123')
94
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
95
InventoryDirectory('2325', 'wibble', parent_id='123')
96
>>> i.path2id('src/wibble')
100
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
101
InventoryFile('2326', 'wibble.c', parent_id='2325')
103
InventoryFile('2326', 'wibble.c', parent_id='2325')
104
>>> for path, entry in i.iter_entries():
105
... print path.replace('\\\\', '/') # for win32 os.sep
106
... assert i.path2id(path)
113
>>> i.id2path('2326').replace('\\\\', '/')
114
'src/wibble/wibble.c'
117
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
'text_id', 'parent_id', 'children', 'executable',
121
def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
122
weave_store.add_text(self.file_id, self.revision, new_lines, parents,
125
def detect_changes(self, old_entry):
126
"""Return a (text_modified, meta_modified) from this to old_entry.
128
_read_tree_state must have been called on self and old_entry prior to
129
calling detect_changes.
133
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
134
output_to, reverse=False):
135
"""Perform a diff from this to to_entry.
137
text_diff will be used for textual difference calculation.
138
This is a template method, override _diff in child classes.
140
self._read_tree_state(tree.id2path(self.file_id), tree)
142
# cannot diff from one kind to another - you must do a removal
143
# and an addif they do not match.
144
assert self.kind == to_entry.kind
145
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
147
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
150
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
151
output_to, reverse=False):
152
"""Perform a diff between two entries of the same kind."""
154
def find_previous_heads(self, previous_inventories, entry_weave):
155
"""Return the revisions and entries that directly preceed this.
157
Returned as a map from revision to inventory entry.
159
This is a map containing the file revisions in all parents
160
for which the file exists, and its revision is not a parent of
161
any other. If the file is new, the set will be empty.
163
def get_ancestors(weave, entry):
164
return set(map(weave.idx_to_name,
165
weave.inclusions([weave.lookup(entry.revision)])))
168
for inv in previous_inventories:
169
if self.file_id in inv:
170
ie = inv[self.file_id]
171
assert ie.file_id == self.file_id
172
if ie.revision in heads:
173
# fixup logic, there was a bug in revision updates.
174
# with x bit support.
176
if heads[ie.revision].executable != ie.executable:
177
heads[ie.revision].executable = False
178
ie.executable = False
179
except AttributeError:
181
assert heads[ie.revision] == ie
183
# may want to add it.
184
# may already be covered:
185
already_present = 0 != len(
186
[head for head in heads
187
if ie.revision in head_ancestors[head]])
189
# an ancestor of a known head.
192
ancestors = get_ancestors(entry_weave, ie)
193
# may knock something else out:
194
check_heads = list(heads.keys())
195
for head in check_heads:
196
if head in ancestors:
197
# this head is not really a head
199
head_ancestors[ie.revision] = ancestors
200
heads[ie.revision] = ie
203
def get_tar_item(self, root, dp, now, tree):
204
"""Get a tarfile item and a file stream for its content."""
205
item = tarfile.TarInfo(os.path.join(root, dp))
206
# TODO: would be cool to actually set it to the timestamp of the
207
# revision it was last changed
209
fileobj = self._put_in_tar(item, tree)
213
"""Return true if the object this entry represents has textual data.
215
Note that textual data includes binary content.
217
Also note that all entries get weave files created for them.
218
This attribute is primarily used when upgrading from old trees that
219
did not have the weave index for all inventory entries.
223
def __init__(self, file_id, name, parent_id, text_id=None):
224
"""Create an InventoryEntry
226
The filename must be a single component, relative to the
227
parent directory; it cannot be a whole path or relative name.
229
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
234
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
235
Traceback (most recent call last):
236
InvalidEntryName: Invalid entry name: src/hello.c
238
assert isinstance(name, basestring), name
239
if '/' in name or '\\' in name:
240
raise InvalidEntryName(name=name)
241
self.executable = False
243
self.text_sha1 = None
244
self.text_size = None
245
self.file_id = file_id
247
self.text_id = text_id
248
self.parent_id = parent_id
249
self.symlink_target = None
251
def kind_character(self):
252
"""Return a short kind indicator useful for appending to names."""
253
raise BzrError('unknown kind %r' % self.kind)
255
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
257
def _put_in_tar(self, item, tree):
258
"""populate item for stashing in a tar, and return the content stream.
260
If no content is available, return None.
262
raise BzrError("don't know how to export {%s} of kind %r" %
263
(self.file_id, self.kind))
265
def put_on_disk(self, dest, dp, tree):
266
"""Create a representation of self on disk in the prefix dest.
268
This is a template method - implement _put_on_disk in subclasses.
270
fullpath = appendpath(dest, dp)
271
self._put_on_disk(fullpath, tree)
272
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
274
def _put_on_disk(self, fullpath, tree):
275
"""Put this entry onto disk at fullpath, from tree tree."""
276
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
278
def sorted_children(self):
279
l = self.children.items()
284
def versionable_kind(kind):
285
return kind in ('file', 'directory', 'symlink')
287
def check(self, checker, rev_id, inv, tree):
288
"""Check this inventory entry is intact.
290
This is a template method, override _check for kind specific
293
if self.parent_id != None:
294
if not inv.has_id(self.parent_id):
295
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
296
% (self.parent_id, rev_id))
297
self._check(checker, rev_id, tree)
299
def _check(self, checker, rev_id, tree):
300
"""Check this inventory entry for kind specific errors."""
301
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
306
"""Clone this inventory entry."""
307
raise NotImplementedError
309
def _get_snapshot_change(self, previous_entries):
310
if len(previous_entries) > 1:
312
elif len(previous_entries) == 0:
315
return 'modified/renamed/reparented'
318
return ("%s(%r, %r, parent_id=%r)"
319
% (self.__class__.__name__,
324
def snapshot(self, revision, path, previous_entries,
325
work_tree, weave_store, transaction):
326
"""Make a snapshot of this entry which may or may not have changed.
328
This means that all its fields are populated, that it has its
329
text stored in the text store or weave.
331
mutter('new parents of %s are %r', path, previous_entries)
332
self._read_tree_state(path, work_tree)
333
if len(previous_entries) == 1:
334
# cannot be unchanged unless there is only one parent file rev.
335
parent_ie = previous_entries.values()[0]
336
if self._unchanged(parent_ie):
337
mutter("found unchanged entry")
338
self.revision = parent_ie.revision
340
return self.snapshot_revision(revision, previous_entries,
341
work_tree, weave_store, transaction)
343
def snapshot_revision(self, revision, previous_entries, work_tree,
344
weave_store, transaction):
345
"""Record this revision unconditionally."""
346
mutter('new revision for {%s}', self.file_id)
347
self.revision = revision
348
change = self._get_snapshot_change(previous_entries)
349
self._snapshot_text(previous_entries, work_tree, weave_store,
353
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
354
"""Record the 'text' of this entry, whatever form that takes.
356
This default implementation simply adds an empty text.
358
mutter('storing file {%s} in revision {%s}',
359
self.file_id, self.revision)
360
self._add_text_to_weave([], file_parents, weave_store, transaction)
362
def __eq__(self, other):
363
if not isinstance(other, InventoryEntry):
364
return NotImplemented
366
return ((self.file_id == other.file_id)
367
and (self.name == other.name)
368
and (other.symlink_target == self.symlink_target)
369
and (self.text_sha1 == other.text_sha1)
370
and (self.text_size == other.text_size)
371
and (self.text_id == other.text_id)
372
and (self.parent_id == other.parent_id)
373
and (self.kind == other.kind)
374
and (self.revision == other.revision)
375
and (self.executable == other.executable)
378
def __ne__(self, other):
379
return not (self == other)
382
raise ValueError('not hashable')
384
def _unchanged(self, previous_ie):
385
"""Has this entry changed relative to previous_ie.
387
This method should be overriden in child classes.
390
# different inv parent
391
if previous_ie.parent_id != self.parent_id:
394
elif previous_ie.name != self.name:
398
def _read_tree_state(self, path, work_tree):
399
"""Populate fields in the inventory entry from the given tree.
401
Note that this should be modified to be a noop on virtual trees
402
as all entries created there are prepopulated.
404
# TODO: Rather than running this manually, we should check the
405
# working sha1 and other expensive properties when they're
406
# first requested, or preload them if they're already known
407
pass # nothing to do by default
410
class RootEntry(InventoryEntry):
412
def _check(self, checker, rev_id, tree):
413
"""See InventoryEntry._check"""
415
def __init__(self, file_id):
416
self.file_id = file_id
418
self.kind = 'root_directory'
419
self.parent_id = None
422
def __eq__(self, other):
423
if not isinstance(other, RootEntry):
424
return NotImplemented
426
return (self.file_id == other.file_id) \
427
and (self.children == other.children)
430
class InventoryDirectory(InventoryEntry):
431
"""A directory in an inventory."""
433
def _check(self, checker, rev_id, tree):
434
"""See InventoryEntry._check"""
435
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
436
raise BzrCheckError('directory {%s} has text in revision {%s}'
437
% (self.file_id, rev_id))
440
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
441
other.revision = self.revision
442
# note that children are *not* copied; they're pulled across when
446
def __init__(self, file_id, name, parent_id):
447
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
449
self.kind = 'directory'
451
def kind_character(self):
452
"""See InventoryEntry.kind_character."""
455
def _put_in_tar(self, item, tree):
456
"""See InventoryEntry._put_in_tar."""
457
item.type = tarfile.DIRTYPE
464
def _put_on_disk(self, fullpath, tree):
465
"""See InventoryEntry._put_on_disk."""
469
class InventoryFile(InventoryEntry):
470
"""A file in an inventory."""
472
def _check(self, checker, rev_id, tree):
473
"""See InventoryEntry._check"""
474
revision = self.revision
475
t = (self.file_id, revision)
476
if t in checker.checked_texts:
477
prev_sha = checker.checked_texts[t]
478
if prev_sha != self.text_sha1:
479
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
480
(self.file_id, rev_id))
482
checker.repeated_text_cnt += 1
484
mutter('check version {%s} of {%s}', rev_id, self.file_id)
485
file_lines = tree.get_file_lines(self.file_id)
486
checker.checked_text_cnt += 1
487
if self.text_size != sum(map(len, file_lines)):
488
raise BzrCheckError('text {%s} wrong size' % self.text_id)
489
if self.text_sha1 != sha_strings(file_lines):
490
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
491
checker.checked_texts[t] = self.text_sha1
494
other = InventoryFile(self.file_id, self.name, self.parent_id)
495
other.executable = self.executable
496
other.text_id = self.text_id
497
other.text_sha1 = self.text_sha1
498
other.text_size = self.text_size
499
other.revision = self.revision
502
def detect_changes(self, old_entry):
503
"""See InventoryEntry.detect_changes."""
504
assert self.text_sha1 != None
505
assert old_entry.text_sha1 != None
506
text_modified = (self.text_sha1 != old_entry.text_sha1)
507
meta_modified = (self.executable != old_entry.executable)
508
return text_modified, meta_modified
510
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
511
output_to, reverse=False):
512
"""See InventoryEntry._diff."""
513
from_text = tree.get_file(self.file_id).readlines()
515
to_text = to_tree.get_file(to_entry.file_id).readlines()
519
text_diff(from_label, from_text,
520
to_label, to_text, output_to)
522
text_diff(to_label, to_text,
523
from_label, from_text, output_to)
526
"""See InventoryEntry.has_text."""
529
def __init__(self, file_id, name, parent_id):
530
super(InventoryFile, self).__init__(file_id, name, parent_id)
533
def kind_character(self):
534
"""See InventoryEntry.kind_character."""
537
def _put_in_tar(self, item, tree):
538
"""See InventoryEntry._put_in_tar."""
539
item.type = tarfile.REGTYPE
540
fileobj = tree.get_file(self.file_id)
541
item.size = self.text_size
542
if tree.is_executable(self.file_id):
548
def _put_on_disk(self, fullpath, tree):
549
"""See InventoryEntry._put_on_disk."""
550
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
551
if tree.is_executable(self.file_id):
552
os.chmod(fullpath, 0755)
554
def _read_tree_state(self, path, work_tree):
555
"""See InventoryEntry._read_tree_state."""
556
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
557
self.executable = work_tree.is_executable(self.file_id)
559
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
560
"""See InventoryEntry._snapshot_text."""
561
mutter('storing file {%s} in revision {%s}',
562
self.file_id, self.revision)
563
# special case to avoid diffing on renames or
565
if (len(file_parents) == 1
566
and self.text_sha1 == file_parents.values()[0].text_sha1
567
and self.text_size == file_parents.values()[0].text_size):
568
previous_ie = file_parents.values()[0]
569
weave_store.add_identical_text(
570
self.file_id, previous_ie.revision,
571
self.revision, file_parents, transaction)
573
new_lines = work_tree.get_file(self.file_id).readlines()
574
self._add_text_to_weave(new_lines, file_parents, weave_store,
576
self.text_sha1 = sha_strings(new_lines)
577
self.text_size = sum(map(len, new_lines))
580
def _unchanged(self, previous_ie):
581
"""See InventoryEntry._unchanged."""
582
compatible = super(InventoryFile, self)._unchanged(previous_ie)
583
if self.text_sha1 != previous_ie.text_sha1:
586
# FIXME: 20050930 probe for the text size when getting sha1
587
# in _read_tree_state
588
self.text_size = previous_ie.text_size
589
if self.executable != previous_ie.executable:
594
class InventoryLink(InventoryEntry):
595
"""A file in an inventory."""
597
__slots__ = ['symlink_target']
599
def _check(self, checker, rev_id, tree):
600
"""See InventoryEntry._check"""
601
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
602
raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
% (self.file_id, rev_id))
604
if self.symlink_target == None:
605
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
% (self.file_id, rev_id))
609
other = InventoryLink(self.file_id, self.name, self.parent_id)
610
other.symlink_target = self.symlink_target
611
other.revision = self.revision
614
def detect_changes(self, old_entry):
615
"""See InventoryEntry.detect_changes."""
616
# FIXME: which _modified field should we use ? RBC 20051003
617
text_modified = (self.symlink_target != old_entry.symlink_target)
619
mutter(" symlink target changed")
620
meta_modified = False
621
return text_modified, meta_modified
623
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
624
output_to, reverse=False):
625
"""See InventoryEntry._diff."""
626
from_text = self.symlink_target
627
if to_entry is not None:
628
to_text = to_entry.symlink_target
633
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
636
print >>output_to, '=== target was %r' % self.symlink_target
638
print >>output_to, '=== target is %r' % self.symlink_target
640
def __init__(self, file_id, name, parent_id):
641
super(InventoryLink, self).__init__(file_id, name, parent_id)
642
self.kind = 'symlink'
644
def kind_character(self):
645
"""See InventoryEntry.kind_character."""
648
def _put_in_tar(self, item, tree):
649
"""See InventoryEntry._put_in_tar."""
650
iterm.type = tarfile.SYMTYPE
654
item.linkname = self.symlink_target
657
def _put_on_disk(self, fullpath, tree):
658
"""See InventoryEntry._put_on_disk."""
660
os.symlink(self.symlink_target, fullpath)
662
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
664
def _read_tree_state(self, path, work_tree):
665
"""See InventoryEntry._read_tree_state."""
666
self.symlink_target = work_tree.get_symlink_target(self.file_id)
668
def _unchanged(self, previous_ie):
669
"""See InventoryEntry._unchanged."""
670
compatible = super(InventoryLink, self)._unchanged(previous_ie)
671
if self.symlink_target != previous_ie.symlink_target:
676
class Inventory(object):
677
"""Inventory of versioned files in a tree.
679
This describes which file_id is present at each point in the tree,
680
and possibly the SHA-1 or other information about the file.
681
Entries can be looked up either by path or by file_id.
683
The inventory represents a typical unix file tree, with
684
directories containing files and subdirectories. We never store
685
the full path to a file, because renaming a directory implicitly
686
moves all of its contents. This class internally maintains a
687
lookup tree that allows the children under a directory to be
690
InventoryEntry objects must not be modified after they are
691
inserted, other than through the Inventory API.
693
>>> inv = Inventory()
694
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
695
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
696
>>> inv['123-123'].name
699
May be treated as an iterator or set to look up file ids:
701
>>> bool(inv.path2id('hello.c'))
706
May also look up by name:
708
>>> [x[0] for x in inv.iter_entries()]
710
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
711
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
712
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
714
def __init__(self, root_id=ROOT_ID):
715
"""Create or read an inventory.
717
If a working directory is specified, the inventory is read
718
from there. If the file is specified, read from that. If not,
719
the inventory is created empty.
721
The inventory is created with a default root directory, with
724
# We are letting Branch.initialize() create a unique inventory
725
# root id. Rather than generating a random one here.
727
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
728
self.root = RootEntry(root_id)
729
self._byid = {self.root.file_id: self.root}
733
other = Inventory(self.root.file_id)
734
# copy recursively so we know directories will be added before
735
# their children. There are more efficient ways than this...
736
for path, entry in self.iter_entries():
737
if entry == self.root:
739
other.add(entry.copy())
744
return iter(self._byid)
748
"""Returns number of entries."""
749
return len(self._byid)
752
def iter_entries(self, from_dir=None):
753
"""Return (path, entry) pairs, in order by name."""
757
elif isinstance(from_dir, basestring):
758
from_dir = self._byid[from_dir]
760
kids = from_dir.children.items()
762
for name, ie in kids:
764
if ie.kind == 'directory':
765
for cn, cie in self.iter_entries(from_dir=ie.file_id):
766
yield os.path.join(name, cn), cie
770
"""Return list of (path, ie) for all entries except the root.
772
This may be faster than iter_entries.
775
def descend(dir_ie, dir_path):
776
kids = dir_ie.children.items()
778
for name, ie in kids:
779
child_path = os.path.join(dir_path, name)
780
accum.append((child_path, ie))
781
if ie.kind == 'directory':
782
descend(ie, child_path)
784
descend(self.root, '')
788
def directories(self):
789
"""Return (path, entry) pairs for all directories, including the root.
792
def descend(parent_ie, parent_path):
793
accum.append((parent_path, parent_ie))
795
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
798
for name, child_ie in kids:
799
child_path = os.path.join(parent_path, name)
800
descend(child_ie, child_path)
801
descend(self.root, '')
806
def __contains__(self, file_id):
807
"""True if this entry contains a file with given id.
809
>>> inv = Inventory()
810
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
811
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
817
return file_id in self._byid
820
def __getitem__(self, file_id):
821
"""Return the entry for given file_id.
823
>>> inv = Inventory()
824
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
825
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
826
>>> inv['123123'].name
830
return self._byid[file_id]
833
raise BzrError("can't look up file_id None")
835
raise BzrError("file_id {%s} not in inventory" % file_id)
838
def get_file_kind(self, file_id):
839
return self._byid[file_id].kind
841
def get_child(self, parent_id, filename):
842
return self[parent_id].children.get(filename)
845
def add(self, entry):
846
"""Add entry to inventory.
848
To add a file to a branch ready to be committed, use Branch.add,
851
Returns the new entry object.
853
if entry.file_id in self._byid:
854
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
856
if entry.parent_id == ROOT_ID or entry.parent_id is None:
857
entry.parent_id = self.root.file_id
860
parent = self._byid[entry.parent_id]
862
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
864
if parent.children.has_key(entry.name):
865
raise BzrError("%s is already versioned" %
866
appendpath(self.id2path(parent.file_id), entry.name))
868
self._byid[entry.file_id] = entry
869
parent.children[entry.name] = entry
873
def add_path(self, relpath, kind, file_id=None):
874
"""Add entry from a path.
876
The immediate parent must already be versioned.
878
Returns the new entry object."""
879
from bzrlib.branch import gen_file_id
881
parts = bzrlib.osutils.splitpath(relpath)
883
raise BzrError("cannot re-add root of inventory")
886
file_id = gen_file_id(relpath)
888
parent_path = parts[:-1]
889
parent_id = self.path2id(parent_path)
890
if parent_id == None:
891
raise NotVersionedError(path=parent_path)
892
if kind == 'directory':
893
ie = InventoryDirectory(file_id, parts[-1], parent_id)
895
ie = InventoryFile(file_id, parts[-1], parent_id)
896
elif kind == 'symlink':
897
ie = InventoryLink(file_id, parts[-1], parent_id)
899
raise BzrError("unknown kind %r" % kind)
903
def __delitem__(self, file_id):
904
"""Remove entry by id.
906
>>> inv = Inventory()
907
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
908
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
917
assert self[ie.parent_id].children[ie.name] == ie
919
# TODO: Test deleting all children; maybe hoist to a separate
921
if ie.kind == 'directory':
922
for cie in ie.children.values():
923
del self[cie.file_id]
926
del self._byid[file_id]
927
del self[ie.parent_id].children[ie.name]
930
def __eq__(self, other):
931
"""Compare two sets by comparing their contents.
937
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
938
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
941
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
942
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
946
if not isinstance(other, Inventory):
947
return NotImplemented
949
if len(self._byid) != len(other._byid):
950
# shortcut: obviously not the same
953
return self._byid == other._byid
956
def __ne__(self, other):
957
return not self.__eq__(other)
961
raise ValueError('not hashable')
964
def get_idpath(self, file_id):
965
"""Return a list of file_ids for the path to an entry.
967
The list contains one element for each directory followed by
968
the id of the file itself. So the length of the returned list
969
is equal to the depth of the file in the tree, counting the
970
root directory as depth 1.
973
while file_id != None:
975
ie = self._byid[file_id]
977
raise BzrError("file_id {%s} not found in inventory" % file_id)
978
p.insert(0, ie.file_id)
979
file_id = ie.parent_id
983
def id2path(self, file_id):
984
"""Return as a list the path to file_id.
987
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
988
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
989
>>> print i.id2path('foo-id').replace(os.sep, '/')
992
# get all names, skipping root
993
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
994
return os.sep.join(p)
998
def path2id(self, name):
999
"""Walk down through directories to return entry of last component.
1001
names may be either a list of path components, or a single
1002
string, in which case it is automatically split.
1004
This returns the entry of the last component in the path,
1005
which may be either a file or a directory.
1007
Returns None iff the path is not found.
1009
if isinstance(name, types.StringTypes):
1010
name = splitpath(name)
1012
mutter("lookup path %r" % name)
1017
cie = parent.children[f]
1018
assert cie.name == f
1019
assert cie.parent_id == parent.file_id
1022
# or raise an error?
1025
return parent.file_id
1028
def has_filename(self, names):
1029
return bool(self.path2id(names))
1032
def has_id(self, file_id):
1033
return self._byid.has_key(file_id)
1036
def rename(self, file_id, new_parent_id, new_name):
1037
"""Move a file within the inventory.
1039
This can change either the name, or the parent, or both.
1041
This does not move the working file."""
1042
if not is_valid_name(new_name):
1043
raise BzrError("not an acceptable filename: %r" % new_name)
1045
new_parent = self._byid[new_parent_id]
1046
if new_name in new_parent.children:
1047
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1049
new_parent_idpath = self.get_idpath(new_parent_id)
1050
if file_id in new_parent_idpath:
1051
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1052
% (self.id2path(file_id), self.id2path(new_parent_id)))
1054
file_ie = self._byid[file_id]
1055
old_parent = self._byid[file_ie.parent_id]
1057
# TODO: Don't leave things messed up if this fails
1059
del old_parent.children[file_ie.name]
1060
new_parent.children[new_name] = file_ie
1062
file_ie.name = new_name
1063
file_ie.parent_id = new_parent_id
1070
def is_valid_name(name):
1072
if _NAME_RE == None:
1073
_NAME_RE = re.compile(r'^[^/\\]+$')
1075
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
