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
>>> for j in i.iter_entries():
85
('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
86
('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
87
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
88
Traceback (most recent call last):
90
BzrError: inventory already contains entry with id {2323}
91
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
92
InventoryFile('2324', 'bye.c', parent_id='123')
93
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
94
InventoryDirectory('2325', 'wibble', parent_id='123')
95
>>> i.path2id('src/wibble')
99
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
100
InventoryFile('2326', 'wibble.c', parent_id='2325')
102
InventoryFile('2326', 'wibble.c', parent_id='2325')
103
>>> for path, entry in i.iter_entries():
104
... print path.replace('\\\\', '/') # for win32 os.sep
105
... assert i.path2id(path)
112
>>> i.id2path('2326').replace('\\\\', '/')
113
'src/wibble/wibble.c'
116
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
117
'text_id', 'parent_id', 'children', 'executable',
120
def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
121
weave_store.add_text(self.file_id, self.revision, new_lines, parents,
124
def detect_changes(self, old_entry):
125
"""Return a (text_modified, meta_modified) from this to old_entry.
127
_read_tree_state must have been called on self and old_entry prior to
128
calling detect_changes.
132
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
133
output_to, reverse=False):
134
"""Perform a diff from this to to_entry.
136
text_diff will be used for textual difference calculation.
137
This is a template method, override _diff in child classes.
139
self._read_tree_state(tree.id2path(self.file_id), tree)
141
# cannot diff from one kind to another - you must do a removal
142
# and an addif they do not match.
143
assert self.kind == to_entry.kind
144
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
146
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
149
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
150
output_to, reverse=False):
151
"""Perform a diff between two entries of the same kind."""
153
def find_previous_heads(self, previous_inventories, entry_weave):
154
"""Return the revisions and entries that directly preceed this.
156
Returned as a map from revision to inventory entry.
158
This is a map containing the file revisions in all parents
159
for which the file exists, and its revision is not a parent of
160
any other. If the file is new, the set will be empty.
162
def get_ancestors(weave, entry):
163
return set(map(weave.idx_to_name,
164
weave.inclusions([weave.lookup(entry.revision)])))
167
for inv in previous_inventories:
168
if self.file_id in inv:
169
ie = inv[self.file_id]
170
assert ie.file_id == self.file_id
171
if ie.revision in heads:
172
# fixup logic, there was a bug in revision updates.
173
# with x bit support.
175
if heads[ie.revision].executable != ie.executable:
176
heads[ie.revision].executable = False
177
ie.executable = False
178
except AttributeError:
180
assert heads[ie.revision] == ie
182
# may want to add it.
183
# may already be covered:
184
already_present = 0 != len(
185
[head for head in heads
186
if ie.revision in head_ancestors[head]])
188
# an ancestor of a known head.
191
ancestors = get_ancestors(entry_weave, ie)
192
# may knock something else out:
193
check_heads = list(heads.keys())
194
for head in check_heads:
195
if head in ancestors:
196
# this head is not really a head
198
head_ancestors[ie.revision] = ancestors
199
heads[ie.revision] = ie
202
def get_tar_item(self, root, dp, now, tree):
203
"""Get a tarfile item and a file stream for its content."""
204
item = tarfile.TarInfo(os.path.join(root, dp))
205
# TODO: would be cool to actually set it to the timestamp of the
206
# revision it was last changed
208
fileobj = self._put_in_tar(item, tree)
212
"""Return true if the object this entry represents has textual data.
214
Note that textual data includes binary content.
216
Also note that all entries get weave files created for them.
217
This attribute is primarily used when upgrading from old trees that
218
did not have the weave index for all inventory entries.
222
def __init__(self, file_id, name, parent_id, text_id=None):
223
"""Create an InventoryEntry
225
The filename must be a single component, relative to the
226
parent directory; it cannot be a whole path or relative name.
228
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
233
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
234
Traceback (most recent call last):
235
InvalidEntryName: Invalid entry name: src/hello.c
237
assert isinstance(name, basestring), name
238
if '/' in name or '\\' in name:
239
raise InvalidEntryName(name=name)
240
self.executable = False
242
self.text_sha1 = None
243
self.text_size = None
244
self.file_id = file_id
246
self.text_id = text_id
247
self.parent_id = parent_id
248
self.symlink_target = None
250
def kind_character(self):
251
"""Return a short kind indicator useful for appending to names."""
252
raise BzrError('unknown kind %r' % self.kind)
254
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
256
def _put_in_tar(self, item, tree):
257
"""populate item for stashing in a tar, and return the content stream.
259
If no content is available, return None.
261
raise BzrError("don't know how to export {%s} of kind %r" %
262
(self.file_id, self.kind))
264
def put_on_disk(self, dest, dp, tree):
265
"""Create a representation of self on disk in the prefix dest.
267
This is a template method - implement _put_on_disk in subclasses.
269
fullpath = appendpath(dest, dp)
270
self._put_on_disk(fullpath, tree)
271
mutter(" export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
273
def _put_on_disk(self, fullpath, tree):
274
"""Put this entry onto disk at fullpath, from tree tree."""
275
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
277
def sorted_children(self):
278
l = self.children.items()
283
def versionable_kind(kind):
284
return kind in ('file', 'directory', 'symlink')
286
def check(self, checker, rev_id, inv, tree):
287
"""Check this inventory entry is intact.
289
This is a template method, override _check for kind specific
292
if self.parent_id != None:
293
if not inv.has_id(self.parent_id):
294
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
295
% (self.parent_id, rev_id))
296
self._check(checker, rev_id, tree)
298
def _check(self, checker, rev_id, tree):
299
"""Check this inventory entry for kind specific errors."""
300
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
305
"""Clone this inventory entry."""
306
raise NotImplementedError
308
def _get_snapshot_change(self, previous_entries):
309
if len(previous_entries) > 1:
311
elif len(previous_entries) == 0:
314
return 'modified/renamed/reparented'
317
return ("%s(%r, %r, parent_id=%r)"
318
% (self.__class__.__name__,
323
def snapshot(self, revision, path, previous_entries,
324
work_tree, weave_store, transaction):
325
"""Make a snapshot of this entry which may or may not have changed.
327
This means that all its fields are populated, that it has its
328
text stored in the text store or weave.
330
mutter('new parents of %s are %r', path, previous_entries)
331
self._read_tree_state(path, work_tree)
332
if len(previous_entries) == 1:
333
# cannot be unchanged unless there is only one parent file rev.
334
parent_ie = previous_entries.values()[0]
335
if self._unchanged(parent_ie):
336
mutter("found unchanged entry")
337
self.revision = parent_ie.revision
339
return self.snapshot_revision(revision, previous_entries,
340
work_tree, weave_store, transaction)
342
def snapshot_revision(self, revision, previous_entries, work_tree,
343
weave_store, transaction):
344
"""Record this revision unconditionally."""
345
mutter('new revision for {%s}', self.file_id)
346
self.revision = revision
347
change = self._get_snapshot_change(previous_entries)
348
self._snapshot_text(previous_entries, work_tree, weave_store,
352
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
353
"""Record the 'text' of this entry, whatever form that takes.
355
This default implementation simply adds an empty text.
357
mutter('storing file {%s} in revision {%s}',
358
self.file_id, self.revision)
359
self._add_text_to_weave([], file_parents, weave_store, transaction)
361
def __eq__(self, other):
362
if not isinstance(other, InventoryEntry):
363
return NotImplemented
365
return ((self.file_id == other.file_id)
366
and (self.name == other.name)
367
and (other.symlink_target == self.symlink_target)
368
and (self.text_sha1 == other.text_sha1)
369
and (self.text_size == other.text_size)
370
and (self.text_id == other.text_id)
371
and (self.parent_id == other.parent_id)
372
and (self.kind == other.kind)
373
and (self.revision == other.revision)
374
and (self.executable == other.executable)
377
def __ne__(self, other):
378
return not (self == other)
381
raise ValueError('not hashable')
383
def _unchanged(self, previous_ie):
384
"""Has this entry changed relative to previous_ie.
386
This method should be overriden in child classes.
389
# different inv parent
390
if previous_ie.parent_id != self.parent_id:
393
elif previous_ie.name != self.name:
397
def _read_tree_state(self, path, work_tree):
398
"""Populate fields in the inventory entry from the given tree.
400
Note that this should be modified to be a noop on virtual trees
401
as all entries created there are prepopulated.
403
# TODO: Rather than running this manually, we should check the
404
# working sha1 and other expensive properties when they're
405
# first requested, or preload them if they're already known
406
pass # nothing to do by default
409
class RootEntry(InventoryEntry):
411
def _check(self, checker, rev_id, tree):
412
"""See InventoryEntry._check"""
414
def __init__(self, file_id):
415
self.file_id = file_id
417
self.kind = 'root_directory'
418
self.parent_id = None
421
def __eq__(self, other):
422
if not isinstance(other, RootEntry):
423
return NotImplemented
425
return (self.file_id == other.file_id) \
426
and (self.children == other.children)
429
class InventoryDirectory(InventoryEntry):
430
"""A directory in an inventory."""
432
def _check(self, checker, rev_id, tree):
433
"""See InventoryEntry._check"""
434
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
raise BzrCheckError('directory {%s} has text in revision {%s}'
436
% (self.file_id, rev_id))
439
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
440
other.revision = self.revision
441
# note that children are *not* copied; they're pulled across when
445
def __init__(self, file_id, name, parent_id):
446
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
448
self.kind = 'directory'
450
def kind_character(self):
451
"""See InventoryEntry.kind_character."""
454
def _put_in_tar(self, item, tree):
455
"""See InventoryEntry._put_in_tar."""
456
item.type = tarfile.DIRTYPE
463
def _put_on_disk(self, fullpath, tree):
464
"""See InventoryEntry._put_on_disk."""
468
class InventoryFile(InventoryEntry):
469
"""A file in an inventory."""
471
def _check(self, checker, rev_id, tree):
472
"""See InventoryEntry._check"""
473
revision = self.revision
474
t = (self.file_id, revision)
475
if t in checker.checked_texts:
476
prev_sha = checker.checked_texts[t]
477
if prev_sha != self.text_sha1:
478
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
479
(self.file_id, rev_id))
481
checker.repeated_text_cnt += 1
483
mutter('check version {%s} of {%s}', rev_id, self.file_id)
484
file_lines = tree.get_file_lines(self.file_id)
485
checker.checked_text_cnt += 1
486
if self.text_size != sum(map(len, file_lines)):
487
raise BzrCheckError('text {%s} wrong size' % self.text_id)
488
if self.text_sha1 != sha_strings(file_lines):
489
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
490
checker.checked_texts[t] = self.text_sha1
493
other = InventoryFile(self.file_id, self.name, self.parent_id)
494
other.executable = self.executable
495
other.text_id = self.text_id
496
other.text_sha1 = self.text_sha1
497
other.text_size = self.text_size
498
other.revision = self.revision
501
def detect_changes(self, old_entry):
502
"""See InventoryEntry.detect_changes."""
503
assert self.text_sha1 != None
504
assert old_entry.text_sha1 != None
505
text_modified = (self.text_sha1 != old_entry.text_sha1)
506
meta_modified = (self.executable != old_entry.executable)
507
return text_modified, meta_modified
509
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
510
output_to, reverse=False):
511
"""See InventoryEntry._diff."""
512
from_text = tree.get_file(self.file_id).readlines()
514
to_text = to_tree.get_file(to_entry.file_id).readlines()
518
text_diff(from_label, from_text,
519
to_label, to_text, output_to)
521
text_diff(to_label, to_text,
522
from_label, from_text, output_to)
525
"""See InventoryEntry.has_text."""
528
def __init__(self, file_id, name, parent_id):
529
super(InventoryFile, self).__init__(file_id, name, parent_id)
532
def kind_character(self):
533
"""See InventoryEntry.kind_character."""
536
def _put_in_tar(self, item, tree):
537
"""See InventoryEntry._put_in_tar."""
538
item.type = tarfile.REGTYPE
539
fileobj = tree.get_file(self.file_id)
540
item.size = self.text_size
541
if tree.is_executable(self.file_id):
547
def _put_on_disk(self, fullpath, tree):
548
"""See InventoryEntry._put_on_disk."""
549
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
550
if tree.is_executable(self.file_id):
551
os.chmod(fullpath, 0755)
553
def _read_tree_state(self, path, work_tree):
554
"""See InventoryEntry._read_tree_state."""
555
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
556
self.executable = work_tree.is_executable(self.file_id)
558
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
559
"""See InventoryEntry._snapshot_text."""
560
mutter('storing file {%s} in revision {%s}',
561
self.file_id, self.revision)
562
# special case to avoid diffing on renames or
564
if (len(file_parents) == 1
565
and self.text_sha1 == file_parents.values()[0].text_sha1
566
and self.text_size == file_parents.values()[0].text_size):
567
previous_ie = file_parents.values()[0]
568
weave_store.add_identical_text(
569
self.file_id, previous_ie.revision,
570
self.revision, file_parents, transaction)
572
new_lines = work_tree.get_file(self.file_id).readlines()
573
self._add_text_to_weave(new_lines, file_parents, weave_store,
575
self.text_sha1 = sha_strings(new_lines)
576
self.text_size = sum(map(len, new_lines))
579
def _unchanged(self, previous_ie):
580
"""See InventoryEntry._unchanged."""
581
compatible = super(InventoryFile, self)._unchanged(previous_ie)
582
if self.text_sha1 != previous_ie.text_sha1:
585
# FIXME: 20050930 probe for the text size when getting sha1
586
# in _read_tree_state
587
self.text_size = previous_ie.text_size
588
if self.executable != previous_ie.executable:
593
class InventoryLink(InventoryEntry):
594
"""A file in an inventory."""
596
__slots__ = ['symlink_target']
598
def _check(self, checker, rev_id, tree):
599
"""See InventoryEntry._check"""
600
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
601
raise BzrCheckError('symlink {%s} has text in revision {%s}'
602
% (self.file_id, rev_id))
603
if self.symlink_target == None:
604
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
605
% (self.file_id, rev_id))
608
other = InventoryLink(self.file_id, self.name, self.parent_id)
609
other.symlink_target = self.symlink_target
610
other.revision = self.revision
613
def detect_changes(self, old_entry):
614
"""See InventoryEntry.detect_changes."""
615
# FIXME: which _modified field should we use ? RBC 20051003
616
text_modified = (self.symlink_target != old_entry.symlink_target)
618
mutter(" symlink target changed")
619
meta_modified = False
620
return text_modified, meta_modified
622
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
623
output_to, reverse=False):
624
"""See InventoryEntry._diff."""
625
from_text = self.symlink_target
626
if to_entry is not None:
627
to_text = to_entry.symlink_target
632
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
635
print >>output_to, '=== target was %r' % self.symlink_target
637
print >>output_to, '=== target is %r' % self.symlink_target
639
def __init__(self, file_id, name, parent_id):
640
super(InventoryLink, self).__init__(file_id, name, parent_id)
641
self.kind = 'symlink'
643
def kind_character(self):
644
"""See InventoryEntry.kind_character."""
647
def _put_in_tar(self, item, tree):
648
"""See InventoryEntry._put_in_tar."""
649
iterm.type = tarfile.SYMTYPE
653
item.linkname = self.symlink_target
656
def _put_on_disk(self, fullpath, tree):
657
"""See InventoryEntry._put_on_disk."""
659
os.symlink(self.symlink_target, fullpath)
661
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
663
def _read_tree_state(self, path, work_tree):
664
"""See InventoryEntry._read_tree_state."""
665
self.symlink_target = work_tree.get_symlink_target(self.file_id)
667
def _unchanged(self, previous_ie):
668
"""See InventoryEntry._unchanged."""
669
compatible = super(InventoryLink, self)._unchanged(previous_ie)
670
if self.symlink_target != previous_ie.symlink_target:
675
class Inventory(object):
676
"""Inventory of versioned files in a tree.
678
This describes which file_id is present at each point in the tree,
679
and possibly the SHA-1 or other information about the file.
680
Entries can be looked up either by path or by file_id.
682
The inventory represents a typical unix file tree, with
683
directories containing files and subdirectories. We never store
684
the full path to a file, because renaming a directory implicitly
685
moves all of its contents. This class internally maintains a
686
lookup tree that allows the children under a directory to be
689
InventoryEntry objects must not be modified after they are
690
inserted, other than through the Inventory API.
692
>>> inv = Inventory()
693
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
694
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
695
>>> inv['123-123'].name
698
May be treated as an iterator or set to look up file ids:
700
>>> bool(inv.path2id('hello.c'))
705
May also look up by name:
707
>>> [x[0] for x in inv.iter_entries()]
709
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
710
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
711
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
713
def __init__(self, root_id=ROOT_ID):
714
"""Create or read an inventory.
716
If a working directory is specified, the inventory is read
717
from there. If the file is specified, read from that. If not,
718
the inventory is created empty.
720
The inventory is created with a default root directory, with
723
# We are letting Branch.initialize() create a unique inventory
724
# root id. Rather than generating a random one here.
726
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
727
self.root = RootEntry(root_id)
728
self._byid = {self.root.file_id: self.root}
732
other = Inventory(self.root.file_id)
733
# copy recursively so we know directories will be added before
734
# their children. There are more efficient ways than this...
735
for path, entry in self.iter_entries():
736
if entry == self.root:
738
other.add(entry.copy())
743
return iter(self._byid)
747
"""Returns number of entries."""
748
return len(self._byid)
751
def iter_entries(self, from_dir=None):
752
"""Return (path, entry) pairs, in order by name."""
756
elif isinstance(from_dir, basestring):
757
from_dir = self._byid[from_dir]
759
kids = from_dir.children.items()
761
for name, ie in kids:
763
if ie.kind == 'directory':
764
for cn, cie in self.iter_entries(from_dir=ie.file_id):
765
yield os.path.join(name, cn), cie
769
"""Return list of (path, ie) for all entries except the root.
771
This may be faster than iter_entries.
774
def descend(dir_ie, dir_path):
775
kids = dir_ie.children.items()
777
for name, ie in kids:
778
child_path = os.path.join(dir_path, name)
779
accum.append((child_path, ie))
780
if ie.kind == 'directory':
781
descend(ie, child_path)
783
descend(self.root, '')
787
def directories(self):
788
"""Return (path, entry) pairs for all directories, including the root.
791
def descend(parent_ie, parent_path):
792
accum.append((parent_path, parent_ie))
794
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
797
for name, child_ie in kids:
798
child_path = os.path.join(parent_path, name)
799
descend(child_ie, child_path)
800
descend(self.root, '')
805
def __contains__(self, file_id):
806
"""True if this entry contains a file with given id.
808
>>> inv = Inventory()
809
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
810
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
816
return file_id in self._byid
819
def __getitem__(self, file_id):
820
"""Return the entry for given file_id.
822
>>> inv = Inventory()
823
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
824
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
825
>>> inv['123123'].name
829
return self._byid[file_id]
832
raise BzrError("can't look up file_id None")
834
raise BzrError("file_id {%s} not in inventory" % file_id)
837
def get_file_kind(self, file_id):
838
return self._byid[file_id].kind
840
def get_child(self, parent_id, filename):
841
return self[parent_id].children.get(filename)
844
def add(self, entry):
845
"""Add entry to inventory.
847
To add a file to a branch ready to be committed, use Branch.add,
850
Returns the new entry object.
852
if entry.file_id in self._byid:
853
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
855
if entry.parent_id == ROOT_ID or entry.parent_id is None:
856
entry.parent_id = self.root.file_id
859
parent = self._byid[entry.parent_id]
861
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
863
if parent.children.has_key(entry.name):
864
raise BzrError("%s is already versioned" %
865
appendpath(self.id2path(parent.file_id), entry.name))
867
self._byid[entry.file_id] = entry
868
parent.children[entry.name] = entry
872
def add_path(self, relpath, kind, file_id=None):
873
"""Add entry from a path.
875
The immediate parent must already be versioned.
877
Returns the new entry object."""
878
from bzrlib.branch import gen_file_id
880
parts = bzrlib.osutils.splitpath(relpath)
882
raise BzrError("cannot re-add root of inventory")
885
file_id = gen_file_id(relpath)
887
parent_path = parts[:-1]
888
parent_id = self.path2id(parent_path)
889
if parent_id == None:
890
raise NotVersionedError(path=parent_path)
891
if kind == 'directory':
892
ie = InventoryDirectory(file_id, parts[-1], parent_id)
894
ie = InventoryFile(file_id, parts[-1], parent_id)
895
elif kind == 'symlink':
896
ie = InventoryLink(file_id, parts[-1], parent_id)
898
raise BzrError("unknown kind %r" % kind)
902
def __delitem__(self, file_id):
903
"""Remove entry by id.
905
>>> inv = Inventory()
906
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
907
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
916
assert self[ie.parent_id].children[ie.name] == ie
918
# TODO: Test deleting all children; maybe hoist to a separate
920
if ie.kind == 'directory':
921
for cie in ie.children.values():
922
del self[cie.file_id]
925
del self._byid[file_id]
926
del self[ie.parent_id].children[ie.name]
929
def __eq__(self, other):
930
"""Compare two sets by comparing their contents.
936
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
937
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
940
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
941
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
945
if not isinstance(other, Inventory):
946
return NotImplemented
948
if len(self._byid) != len(other._byid):
949
# shortcut: obviously not the same
952
return self._byid == other._byid
955
def __ne__(self, other):
956
return not self.__eq__(other)
960
raise ValueError('not hashable')
963
def get_idpath(self, file_id):
964
"""Return a list of file_ids for the path to an entry.
966
The list contains one element for each directory followed by
967
the id of the file itself. So the length of the returned list
968
is equal to the depth of the file in the tree, counting the
969
root directory as depth 1.
972
while file_id != None:
974
ie = self._byid[file_id]
976
raise BzrError("file_id {%s} not found in inventory" % file_id)
977
p.insert(0, ie.file_id)
978
file_id = ie.parent_id
982
def id2path(self, file_id):
983
"""Return as a list the path to file_id.
986
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
987
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
988
>>> print i.id2path('foo-id').replace(os.sep, '/')
991
# get all names, skipping root
992
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
993
return os.sep.join(p)
997
def path2id(self, name):
998
"""Walk down through directories to return entry of last component.
1000
names may be either a list of path components, or a single
1001
string, in which case it is automatically split.
1003
This returns the entry of the last component in the path,
1004
which may be either a file or a directory.
1006
Returns None iff the path is not found.
1008
if isinstance(name, types.StringTypes):
1009
name = splitpath(name)
1011
mutter("lookup path %r" % name)
1016
cie = parent.children[f]
1017
assert cie.name == f
1018
assert cie.parent_id == parent.file_id
1021
# or raise an error?
1024
return parent.file_id
1027
def has_filename(self, names):
1028
return bool(self.path2id(names))
1031
def has_id(self, file_id):
1032
return self._byid.has_key(file_id)
1035
def rename(self, file_id, new_parent_id, new_name):
1036
"""Move a file within the inventory.
1038
This can change either the name, or the parent, or both.
1040
This does not move the working file."""
1041
if not is_valid_name(new_name):
1042
raise BzrError("not an acceptable filename: %r" % new_name)
1044
new_parent = self._byid[new_parent_id]
1045
if new_name in new_parent.children:
1046
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1048
new_parent_idpath = self.get_idpath(new_parent_id)
1049
if file_id in new_parent_idpath:
1050
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1051
% (self.id2path(file_id), self.id2path(new_parent_id)))
1053
file_ie = self._byid[file_id]
1054
old_parent = self._byid[file_ie.parent_id]
1056
# TODO: Don't leave things messed up if this fails
1058
del old_parent.children[file_ie.name]
1059
new_parent.children[new_name] = file_ie
1061
file_ie.name = new_name
1062
file_ie.parent_id = new_parent_id
1069
def is_valid_name(name):
1071
if _NAME_RE == None:
1072
_NAME_RE = re.compile(r'^[^/\\]+$')
1074
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
