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.
401
# TODO: Rather than running this manually, we should check the
402
# working sha1 and other expensive properties when they're
403
# first requested, or preload them if they're already known
404
pass # nothing to do by default
407
class RootEntry(InventoryEntry):
409
def _check(self, checker, rev_id, tree):
410
"""See InventoryEntry._check"""
412
def __init__(self, file_id):
413
self.file_id = file_id
415
self.kind = 'root_directory'
416
self.parent_id = None
419
def __eq__(self, other):
420
if not isinstance(other, RootEntry):
421
return NotImplemented
423
return (self.file_id == other.file_id) \
424
and (self.children == other.children)
427
class InventoryDirectory(InventoryEntry):
428
"""A directory in an inventory."""
430
def _check(self, checker, rev_id, tree):
431
"""See InventoryEntry._check"""
432
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
433
raise BzrCheckError('directory {%s} has text in revision {%s}'
434
% (self.file_id, rev_id))
437
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
438
other.revision = self.revision
439
# note that children are *not* copied; they're pulled across when
443
def __init__(self, file_id, name, parent_id):
444
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
446
self.kind = 'directory'
448
def kind_character(self):
449
"""See InventoryEntry.kind_character."""
452
def _put_in_tar(self, item, tree):
453
"""See InventoryEntry._put_in_tar."""
454
item.type = tarfile.DIRTYPE
461
def _put_on_disk(self, fullpath, tree):
462
"""See InventoryEntry._put_on_disk."""
466
class InventoryFile(InventoryEntry):
467
"""A file in an inventory."""
469
def _check(self, checker, rev_id, tree):
470
"""See InventoryEntry._check"""
471
revision = self.revision
472
t = (self.file_id, revision)
473
if t in checker.checked_texts:
474
prev_sha = checker.checked_texts[t]
475
if prev_sha != self.text_sha1:
476
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
477
(self.file_id, rev_id))
479
checker.repeated_text_cnt += 1
481
mutter('check version {%s} of {%s}', rev_id, self.file_id)
482
file_lines = tree.get_file_lines(self.file_id)
483
checker.checked_text_cnt += 1
484
if self.text_size != sum(map(len, file_lines)):
485
raise BzrCheckError('text {%s} wrong size' % self.text_id)
486
if self.text_sha1 != sha_strings(file_lines):
487
raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
488
checker.checked_texts[t] = self.text_sha1
491
other = InventoryFile(self.file_id, self.name, self.parent_id)
492
other.executable = self.executable
493
other.text_id = self.text_id
494
other.text_sha1 = self.text_sha1
495
other.text_size = self.text_size
496
other.revision = self.revision
499
def detect_changes(self, old_entry):
500
"""See InventoryEntry.detect_changes."""
501
assert self.text_sha1 != None
502
assert old_entry.text_sha1 != None
503
text_modified = (self.text_sha1 != old_entry.text_sha1)
504
meta_modified = (self.executable != old_entry.executable)
505
return text_modified, meta_modified
507
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
508
output_to, reverse=False):
509
"""See InventoryEntry._diff."""
510
from_text = tree.get_file(self.file_id).readlines()
512
to_text = to_tree.get_file(to_entry.file_id).readlines()
516
text_diff(from_label, from_text,
517
to_label, to_text, output_to)
519
text_diff(to_label, to_text,
520
from_label, from_text, output_to)
523
"""See InventoryEntry.has_text."""
526
def __init__(self, file_id, name, parent_id):
527
super(InventoryFile, self).__init__(file_id, name, parent_id)
530
def kind_character(self):
531
"""See InventoryEntry.kind_character."""
534
def _put_in_tar(self, item, tree):
535
"""See InventoryEntry._put_in_tar."""
536
item.type = tarfile.REGTYPE
537
fileobj = tree.get_file(self.file_id)
538
item.size = self.text_size
539
if tree.is_executable(self.file_id):
545
def _put_on_disk(self, fullpath, tree):
546
"""See InventoryEntry._put_on_disk."""
547
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
548
if tree.is_executable(self.file_id):
549
os.chmod(fullpath, 0755)
551
def _read_tree_state(self, path, work_tree):
552
"""See InventoryEntry._read_tree_state."""
553
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
554
self.executable = work_tree.is_executable(self.file_id)
556
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
557
"""See InventoryEntry._snapshot_text."""
558
mutter('storing file {%s} in revision {%s}',
559
self.file_id, self.revision)
560
# special case to avoid diffing on renames or
562
if (len(file_parents) == 1
563
and self.text_sha1 == file_parents.values()[0].text_sha1
564
and self.text_size == file_parents.values()[0].text_size):
565
previous_ie = file_parents.values()[0]
566
weave_store.add_identical_text(
567
self.file_id, previous_ie.revision,
568
self.revision, file_parents, transaction)
570
new_lines = work_tree.get_file(self.file_id).readlines()
571
self._add_text_to_weave(new_lines, file_parents, weave_store,
573
self.text_sha1 = sha_strings(new_lines)
574
self.text_size = sum(map(len, new_lines))
577
def _unchanged(self, previous_ie):
578
"""See InventoryEntry._unchanged."""
579
compatible = super(InventoryFile, self)._unchanged(previous_ie)
580
if self.text_sha1 != previous_ie.text_sha1:
583
# FIXME: 20050930 probe for the text size when getting sha1
584
# in _read_tree_state
585
self.text_size = previous_ie.text_size
586
if self.executable != previous_ie.executable:
591
class InventoryLink(InventoryEntry):
592
"""A file in an inventory."""
594
__slots__ = ['symlink_target']
596
def _check(self, checker, rev_id, tree):
597
"""See InventoryEntry._check"""
598
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
599
raise BzrCheckError('symlink {%s} has text in revision {%s}'
600
% (self.file_id, rev_id))
601
if self.symlink_target == None:
602
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
603
% (self.file_id, rev_id))
606
other = InventoryLink(self.file_id, self.name, self.parent_id)
607
other.symlink_target = self.symlink_target
608
other.revision = self.revision
611
def detect_changes(self, old_entry):
612
"""See InventoryEntry.detect_changes."""
613
# FIXME: which _modified field should we use ? RBC 20051003
614
text_modified = (self.symlink_target != old_entry.symlink_target)
616
mutter(" symlink target changed")
617
meta_modified = False
618
return text_modified, meta_modified
620
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
621
output_to, reverse=False):
622
"""See InventoryEntry._diff."""
623
from_text = self.symlink_target
624
if to_entry is not None:
625
to_text = to_entry.symlink_target
630
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
633
print >>output_to, '=== target was %r' % self.symlink_target
635
print >>output_to, '=== target is %r' % self.symlink_target
637
def __init__(self, file_id, name, parent_id):
638
super(InventoryLink, self).__init__(file_id, name, parent_id)
639
self.kind = 'symlink'
641
def kind_character(self):
642
"""See InventoryEntry.kind_character."""
645
def _put_in_tar(self, item, tree):
646
"""See InventoryEntry._put_in_tar."""
647
iterm.type = tarfile.SYMTYPE
651
item.linkname = self.symlink_target
654
def _put_on_disk(self, fullpath, tree):
655
"""See InventoryEntry._put_on_disk."""
657
os.symlink(self.symlink_target, fullpath)
659
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
661
def _read_tree_state(self, path, work_tree):
662
"""See InventoryEntry._read_tree_state."""
663
self.symlink_target = work_tree.get_symlink_target(self.file_id)
665
def _unchanged(self, previous_ie):
666
"""See InventoryEntry._unchanged."""
667
compatible = super(InventoryLink, self)._unchanged(previous_ie)
668
if self.symlink_target != previous_ie.symlink_target:
673
class Inventory(object):
674
"""Inventory of versioned files in a tree.
676
This describes which file_id is present at each point in the tree,
677
and possibly the SHA-1 or other information about the file.
678
Entries can be looked up either by path or by file_id.
680
The inventory represents a typical unix file tree, with
681
directories containing files and subdirectories. We never store
682
the full path to a file, because renaming a directory implicitly
683
moves all of its contents. This class internally maintains a
684
lookup tree that allows the children under a directory to be
687
InventoryEntry objects must not be modified after they are
688
inserted, other than through the Inventory API.
690
>>> inv = Inventory()
691
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
692
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
693
>>> inv['123-123'].name
696
May be treated as an iterator or set to look up file ids:
698
>>> bool(inv.path2id('hello.c'))
703
May also look up by name:
705
>>> [x[0] for x in inv.iter_entries()]
707
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
708
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
709
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
711
def __init__(self, root_id=ROOT_ID):
712
"""Create or read an inventory.
714
If a working directory is specified, the inventory is read
715
from there. If the file is specified, read from that. If not,
716
the inventory is created empty.
718
The inventory is created with a default root directory, with
721
# We are letting Branch.initialize() create a unique inventory
722
# root id. Rather than generating a random one here.
724
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
725
self.root = RootEntry(root_id)
726
self._byid = {self.root.file_id: self.root}
730
other = Inventory(self.root.file_id)
731
# copy recursively so we know directories will be added before
732
# their children. There are more efficient ways than this...
733
for path, entry in self.iter_entries():
734
if entry == self.root:
736
other.add(entry.copy())
741
return iter(self._byid)
745
"""Returns number of entries."""
746
return len(self._byid)
749
def iter_entries(self, from_dir=None):
750
"""Return (path, entry) pairs, in order by name."""
754
elif isinstance(from_dir, basestring):
755
from_dir = self._byid[from_dir]
757
kids = from_dir.children.items()
759
for name, ie in kids:
761
if ie.kind == 'directory':
762
for cn, cie in self.iter_entries(from_dir=ie.file_id):
763
yield os.path.join(name, cn), cie
767
"""Return list of (path, ie) for all entries except the root.
769
This may be faster than iter_entries.
772
def descend(dir_ie, dir_path):
773
kids = dir_ie.children.items()
775
for name, ie in kids:
776
child_path = os.path.join(dir_path, name)
777
accum.append((child_path, ie))
778
if ie.kind == 'directory':
779
descend(ie, child_path)
781
descend(self.root, '')
785
def directories(self):
786
"""Return (path, entry) pairs for all directories, including the root.
789
def descend(parent_ie, parent_path):
790
accum.append((parent_path, parent_ie))
792
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
795
for name, child_ie in kids:
796
child_path = os.path.join(parent_path, name)
797
descend(child_ie, child_path)
798
descend(self.root, '')
803
def __contains__(self, file_id):
804
"""True if this entry contains a file with given id.
806
>>> inv = Inventory()
807
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
808
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
814
return file_id in self._byid
817
def __getitem__(self, file_id):
818
"""Return the entry for given file_id.
820
>>> inv = Inventory()
821
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
822
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
823
>>> inv['123123'].name
827
return self._byid[file_id]
830
raise BzrError("can't look up file_id None")
832
raise BzrError("file_id {%s} not in inventory" % file_id)
835
def get_file_kind(self, file_id):
836
return self._byid[file_id].kind
838
def get_child(self, parent_id, filename):
839
return self[parent_id].children.get(filename)
842
def add(self, entry):
843
"""Add entry to inventory.
845
To add a file to a branch ready to be committed, use Branch.add,
848
Returns the new entry object.
850
if entry.file_id in self._byid:
851
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
853
if entry.parent_id == ROOT_ID or entry.parent_id is None:
854
entry.parent_id = self.root.file_id
857
parent = self._byid[entry.parent_id]
859
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
861
if parent.children.has_key(entry.name):
862
raise BzrError("%s is already versioned" %
863
appendpath(self.id2path(parent.file_id), entry.name))
865
self._byid[entry.file_id] = entry
866
parent.children[entry.name] = entry
870
def add_path(self, relpath, kind, file_id=None):
871
"""Add entry from a path.
873
The immediate parent must already be versioned.
875
Returns the new entry object."""
876
from bzrlib.branch import gen_file_id
878
parts = bzrlib.osutils.splitpath(relpath)
880
raise BzrError("cannot re-add root of inventory")
883
file_id = gen_file_id(relpath)
885
parent_path = parts[:-1]
886
parent_id = self.path2id(parent_path)
887
if parent_id == None:
888
raise NotVersionedError(parent_path)
890
if kind == 'directory':
891
ie = InventoryDirectory(file_id, parts[-1], parent_id)
893
ie = InventoryFile(file_id, parts[-1], parent_id)
894
elif kind == 'symlink':
895
ie = InventoryLink(file_id, parts[-1], parent_id)
897
raise BzrError("unknown kind %r" % kind)
901
def __delitem__(self, file_id):
902
"""Remove entry by id.
904
>>> inv = Inventory()
905
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
906
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
915
assert self[ie.parent_id].children[ie.name] == ie
917
# TODO: Test deleting all children; maybe hoist to a separate
919
if ie.kind == 'directory':
920
for cie in ie.children.values():
921
del self[cie.file_id]
924
del self._byid[file_id]
925
del self[ie.parent_id].children[ie.name]
928
def __eq__(self, other):
929
"""Compare two sets by comparing their contents.
935
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
936
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
939
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
940
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
944
if not isinstance(other, Inventory):
945
return NotImplemented
947
if len(self._byid) != len(other._byid):
948
# shortcut: obviously not the same
951
return self._byid == other._byid
954
def __ne__(self, other):
955
return not self.__eq__(other)
959
raise ValueError('not hashable')
962
def get_idpath(self, file_id):
963
"""Return a list of file_ids for the path to an entry.
965
The list contains one element for each directory followed by
966
the id of the file itself. So the length of the returned list
967
is equal to the depth of the file in the tree, counting the
968
root directory as depth 1.
971
while file_id != None:
973
ie = self._byid[file_id]
975
raise BzrError("file_id {%s} not found in inventory" % file_id)
976
p.insert(0, ie.file_id)
977
file_id = ie.parent_id
981
def id2path(self, file_id):
982
"""Return as a list the path to file_id.
985
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
986
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
987
>>> print i.id2path('foo-id').replace(os.sep, '/')
990
# get all names, skipping root
991
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
992
return os.sep.join(p)
996
def path2id(self, name):
997
"""Walk down through directories to return entry of last component.
999
names may be either a list of path components, or a single
1000
string, in which case it is automatically split.
1002
This returns the entry of the last component in the path,
1003
which may be either a file or a directory.
1005
Returns None iff the path is not found.
1007
if isinstance(name, types.StringTypes):
1008
name = splitpath(name)
1010
mutter("lookup path %r" % name)
1015
cie = parent.children[f]
1016
assert cie.name == f
1017
assert cie.parent_id == parent.file_id
1020
# or raise an error?
1023
return parent.file_id
1026
def has_filename(self, names):
1027
return bool(self.path2id(names))
1030
def has_id(self, file_id):
1031
return self._byid.has_key(file_id)
1034
def rename(self, file_id, new_parent_id, new_name):
1035
"""Move a file within the inventory.
1037
This can change either the name, or the parent, or both.
1039
This does not move the working file."""
1040
if not is_valid_name(new_name):
1041
raise BzrError("not an acceptable filename: %r" % new_name)
1043
new_parent = self._byid[new_parent_id]
1044
if new_name in new_parent.children:
1045
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1047
new_parent_idpath = self.get_idpath(new_parent_id)
1048
if file_id in new_parent_idpath:
1049
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1050
% (self.id2path(file_id), self.id2path(new_parent_id)))
1052
file_ie = self._byid[file_id]
1053
old_parent = self._byid[file_ie.parent_id]
1055
# TODO: Don't leave things messed up if this fails
1057
del old_parent.children[file_ie.name]
1058
new_parent.children[new_name] = file_ie
1060
file_ie.name = new_name
1061
file_ie.parent_id = new_parent_id
1068
def is_valid_name(name):
1070
if _NAME_RE == None:
1071
_NAME_RE = re.compile(r'^[^/\\]+$')
1073
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
