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
pathjoin, 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: pathjoin('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():
106
... assert i.path2id(path)
113
>>> i.id2path('2326')
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
versionedfile = weave_store.get_weave(self.file_id, transaction)
123
versionedfile.add_lines(self.revision, parents, new_lines)
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(weave.get_ancestry(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(pathjoin(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 = pathjoin(dest, dp)
270
self._put_on_disk(fullpath, tree)
271
mutter(" export {%s} kind %s to %s", self.file_id,
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.keys(), 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
409
def _forget_tree_state(self):
413
class RootEntry(InventoryEntry):
415
def _check(self, checker, rev_id, tree):
416
"""See InventoryEntry._check"""
418
def __init__(self, file_id):
419
self.file_id = file_id
421
self.kind = 'root_directory'
422
self.parent_id = None
425
def __eq__(self, other):
426
if not isinstance(other, RootEntry):
427
return NotImplemented
429
return (self.file_id == other.file_id) \
430
and (self.children == other.children)
433
class InventoryDirectory(InventoryEntry):
434
"""A directory in an inventory."""
436
def _check(self, checker, rev_id, tree):
437
"""See InventoryEntry._check"""
438
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
439
raise BzrCheckError('directory {%s} has text in revision {%s}'
440
% (self.file_id, rev_id))
443
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
444
other.revision = self.revision
445
# note that children are *not* copied; they're pulled across when
449
def __init__(self, file_id, name, parent_id):
450
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
452
self.kind = 'directory'
454
def kind_character(self):
455
"""See InventoryEntry.kind_character."""
458
def _put_in_tar(self, item, tree):
459
"""See InventoryEntry._put_in_tar."""
460
item.type = tarfile.DIRTYPE
467
def _put_on_disk(self, fullpath, tree):
468
"""See InventoryEntry._put_on_disk."""
472
class InventoryFile(InventoryEntry):
473
"""A file in an inventory."""
475
def _check(self, checker, rev_id, tree):
476
"""See InventoryEntry._check"""
477
revision = self.revision
478
t = (self.file_id, revision)
479
if t in checker.checked_texts:
480
prev_sha = checker.checked_texts[t]
481
if prev_sha != self.text_sha1:
482
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
483
(self.file_id, rev_id))
485
checker.repeated_text_cnt += 1
488
if self.file_id not in checker.checked_weaves:
489
mutter('check weave {%s}', self.file_id)
490
w = tree.get_weave(self.file_id)
491
# Not passing a progress bar, because it creates a new
492
# progress, which overwrites the current progress,
493
# and doesn't look nice
495
checker.checked_weaves[self.file_id] = True
497
w = tree.get_weave(self.file_id)
499
mutter('check version {%s} of {%s}', rev_id, self.file_id)
500
checker.checked_text_cnt += 1
501
# We can't check the length, because Weave doesn't store that
502
# information, and the whole point of looking at the weave's
503
# sha1sum is that we don't have to extract the text.
504
if self.text_sha1 != w.get_sha1(self.revision):
505
raise BzrCheckError('text {%s} version {%s} wrong sha1'
506
% (self.file_id, self.revision))
507
checker.checked_texts[t] = self.text_sha1
510
other = InventoryFile(self.file_id, self.name, self.parent_id)
511
other.executable = self.executable
512
other.text_id = self.text_id
513
other.text_sha1 = self.text_sha1
514
other.text_size = self.text_size
515
other.revision = self.revision
518
def detect_changes(self, old_entry):
519
"""See InventoryEntry.detect_changes."""
520
assert self.text_sha1 != None
521
assert old_entry.text_sha1 != None
522
text_modified = (self.text_sha1 != old_entry.text_sha1)
523
meta_modified = (self.executable != old_entry.executable)
524
return text_modified, meta_modified
526
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
527
output_to, reverse=False):
528
"""See InventoryEntry._diff."""
529
from_text = tree.get_file(self.file_id).readlines()
531
to_text = to_tree.get_file(to_entry.file_id).readlines()
535
text_diff(from_label, from_text,
536
to_label, to_text, output_to)
538
text_diff(to_label, to_text,
539
from_label, from_text, output_to)
542
"""See InventoryEntry.has_text."""
545
def __init__(self, file_id, name, parent_id):
546
super(InventoryFile, self).__init__(file_id, name, parent_id)
549
def kind_character(self):
550
"""See InventoryEntry.kind_character."""
553
def _put_in_tar(self, item, tree):
554
"""See InventoryEntry._put_in_tar."""
555
item.type = tarfile.REGTYPE
556
fileobj = tree.get_file(self.file_id)
557
item.size = self.text_size
558
if tree.is_executable(self.file_id):
564
def _put_on_disk(self, fullpath, tree):
565
"""See InventoryEntry._put_on_disk."""
566
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
567
if tree.is_executable(self.file_id):
568
os.chmod(fullpath, 0755)
570
def _read_tree_state(self, path, work_tree):
571
"""See InventoryEntry._read_tree_state."""
572
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
573
self.executable = work_tree.is_executable(self.file_id)
575
def _forget_tree_state(self):
576
self.text_sha1 = None
577
self.executable = None
579
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
580
"""See InventoryEntry._snapshot_text."""
581
mutter('storing file {%s} in revision {%s}',
582
self.file_id, self.revision)
583
# special case to avoid diffing on renames or
585
if (len(file_parents) == 1
586
and self.text_sha1 == file_parents.values()[0].text_sha1
587
and self.text_size == file_parents.values()[0].text_size):
588
previous_ie = file_parents.values()[0]
589
versionedfile = weave_store.get_weave(self.file_id, transaction)
590
versionedfile.clone_text(self.revision, previous_ie.revision, file_parents.keys())
592
new_lines = work_tree.get_file(self.file_id).readlines()
593
self._add_text_to_weave(new_lines, file_parents.keys(), weave_store,
595
self.text_sha1 = sha_strings(new_lines)
596
self.text_size = sum(map(len, new_lines))
599
def _unchanged(self, previous_ie):
600
"""See InventoryEntry._unchanged."""
601
compatible = super(InventoryFile, self)._unchanged(previous_ie)
602
if self.text_sha1 != previous_ie.text_sha1:
605
# FIXME: 20050930 probe for the text size when getting sha1
606
# in _read_tree_state
607
self.text_size = previous_ie.text_size
608
if self.executable != previous_ie.executable:
613
class InventoryLink(InventoryEntry):
614
"""A file in an inventory."""
616
__slots__ = ['symlink_target']
618
def _check(self, checker, rev_id, tree):
619
"""See InventoryEntry._check"""
620
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
621
raise BzrCheckError('symlink {%s} has text in revision {%s}'
622
% (self.file_id, rev_id))
623
if self.symlink_target == None:
624
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
625
% (self.file_id, rev_id))
628
other = InventoryLink(self.file_id, self.name, self.parent_id)
629
other.symlink_target = self.symlink_target
630
other.revision = self.revision
633
def detect_changes(self, old_entry):
634
"""See InventoryEntry.detect_changes."""
635
# FIXME: which _modified field should we use ? RBC 20051003
636
text_modified = (self.symlink_target != old_entry.symlink_target)
638
mutter(" symlink target changed")
639
meta_modified = False
640
return text_modified, meta_modified
642
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
643
output_to, reverse=False):
644
"""See InventoryEntry._diff."""
645
from_text = self.symlink_target
646
if to_entry is not None:
647
to_text = to_entry.symlink_target
652
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
655
print >>output_to, '=== target was %r' % self.symlink_target
657
print >>output_to, '=== target is %r' % self.symlink_target
659
def __init__(self, file_id, name, parent_id):
660
super(InventoryLink, self).__init__(file_id, name, parent_id)
661
self.kind = 'symlink'
663
def kind_character(self):
664
"""See InventoryEntry.kind_character."""
667
def _put_in_tar(self, item, tree):
668
"""See InventoryEntry._put_in_tar."""
669
item.type = tarfile.SYMTYPE
673
item.linkname = self.symlink_target
676
def _put_on_disk(self, fullpath, tree):
677
"""See InventoryEntry._put_on_disk."""
679
os.symlink(self.symlink_target, fullpath)
681
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
683
def _read_tree_state(self, path, work_tree):
684
"""See InventoryEntry._read_tree_state."""
685
self.symlink_target = work_tree.get_symlink_target(self.file_id)
687
def _forget_tree_state(self):
688
self.symlink_target = None
690
def _unchanged(self, previous_ie):
691
"""See InventoryEntry._unchanged."""
692
compatible = super(InventoryLink, self)._unchanged(previous_ie)
693
if self.symlink_target != previous_ie.symlink_target:
698
class Inventory(object):
699
"""Inventory of versioned files in a tree.
701
This describes which file_id is present at each point in the tree,
702
and possibly the SHA-1 or other information about the file.
703
Entries can be looked up either by path or by file_id.
705
The inventory represents a typical unix file tree, with
706
directories containing files and subdirectories. We never store
707
the full path to a file, because renaming a directory implicitly
708
moves all of its contents. This class internally maintains a
709
lookup tree that allows the children under a directory to be
712
InventoryEntry objects must not be modified after they are
713
inserted, other than through the Inventory API.
715
>>> inv = Inventory()
716
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
717
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
718
>>> inv['123-123'].name
721
May be treated as an iterator or set to look up file ids:
723
>>> bool(inv.path2id('hello.c'))
728
May also look up by name:
730
>>> [x[0] for x in inv.iter_entries()]
732
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
733
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
734
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
736
def __init__(self, root_id=ROOT_ID):
737
"""Create or read an inventory.
739
If a working directory is specified, the inventory is read
740
from there. If the file is specified, read from that. If not,
741
the inventory is created empty.
743
The inventory is created with a default root directory, with
746
# We are letting Branch.create() create a unique inventory
747
# root id. Rather than generating a random one here.
749
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
750
self.root = RootEntry(root_id)
751
self._byid = {self.root.file_id: self.root}
755
other = Inventory(self.root.file_id)
756
# copy recursively so we know directories will be added before
757
# their children. There are more efficient ways than this...
758
for path, entry in self.iter_entries():
759
if entry == self.root:
761
other.add(entry.copy())
766
return iter(self._byid)
770
"""Returns number of entries."""
771
return len(self._byid)
774
def iter_entries(self, from_dir=None):
775
"""Return (path, entry) pairs, in order by name."""
779
elif isinstance(from_dir, basestring):
780
from_dir = self._byid[from_dir]
782
kids = from_dir.children.items()
784
for name, ie in kids:
786
if ie.kind == 'directory':
787
for cn, cie in self.iter_entries(from_dir=ie.file_id):
788
yield pathjoin(name, cn), cie
792
"""Return list of (path, ie) for all entries except the root.
794
This may be faster than iter_entries.
797
def descend(dir_ie, dir_path):
798
kids = dir_ie.children.items()
800
for name, ie in kids:
801
child_path = pathjoin(dir_path, name)
802
accum.append((child_path, ie))
803
if ie.kind == 'directory':
804
descend(ie, child_path)
806
descend(self.root, u'')
810
def directories(self):
811
"""Return (path, entry) pairs for all directories, including the root.
814
def descend(parent_ie, parent_path):
815
accum.append((parent_path, parent_ie))
817
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
820
for name, child_ie in kids:
821
child_path = pathjoin(parent_path, name)
822
descend(child_ie, child_path)
823
descend(self.root, u'')
828
def __contains__(self, file_id):
829
"""True if this entry contains a file with given id.
831
>>> inv = Inventory()
832
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
833
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
839
return file_id in self._byid
842
def __getitem__(self, file_id):
843
"""Return the entry for given file_id.
845
>>> inv = Inventory()
846
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
847
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
848
>>> inv['123123'].name
852
return self._byid[file_id]
855
raise BzrError("can't look up file_id None")
857
raise BzrError("file_id {%s} not in inventory" % file_id)
860
def get_file_kind(self, file_id):
861
return self._byid[file_id].kind
863
def get_child(self, parent_id, filename):
864
return self[parent_id].children.get(filename)
867
def add(self, entry):
868
"""Add entry to inventory.
870
To add a file to a branch ready to be committed, use Branch.add,
873
Returns the new entry object.
875
if entry.file_id in self._byid:
876
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
878
if entry.parent_id == ROOT_ID or entry.parent_id is None:
879
entry.parent_id = self.root.file_id
882
parent = self._byid[entry.parent_id]
884
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
886
if parent.children.has_key(entry.name):
887
raise BzrError("%s is already versioned" %
888
pathjoin(self.id2path(parent.file_id), entry.name))
890
self._byid[entry.file_id] = entry
891
parent.children[entry.name] = entry
895
def add_path(self, relpath, kind, file_id=None):
896
"""Add entry from a path.
898
The immediate parent must already be versioned.
900
Returns the new entry object."""
901
from bzrlib.workingtree import gen_file_id
903
parts = bzrlib.osutils.splitpath(relpath)
906
file_id = gen_file_id(relpath)
909
self.root = RootEntry(file_id)
910
self._byid = {self.root.file_id: self.root}
913
parent_path = parts[:-1]
914
parent_id = self.path2id(parent_path)
915
if parent_id == None:
916
raise NotVersionedError(path=parent_path)
917
if kind == 'directory':
918
ie = InventoryDirectory(file_id, parts[-1], parent_id)
920
ie = InventoryFile(file_id, parts[-1], parent_id)
921
elif kind == 'symlink':
922
ie = InventoryLink(file_id, parts[-1], parent_id)
924
raise BzrError("unknown kind %r" % kind)
928
def __delitem__(self, file_id):
929
"""Remove entry by id.
931
>>> inv = Inventory()
932
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
933
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
942
assert ie.parent_id is None or \
943
self[ie.parent_id].children[ie.name] == ie
945
del self._byid[file_id]
946
if ie.parent_id is not None:
947
del self[ie.parent_id].children[ie.name]
950
def __eq__(self, other):
951
"""Compare two sets by comparing their contents.
957
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
958
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
961
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
962
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
966
if not isinstance(other, Inventory):
967
return NotImplemented
969
if len(self._byid) != len(other._byid):
970
# shortcut: obviously not the same
973
return self._byid == other._byid
976
def __ne__(self, other):
977
return not self.__eq__(other)
981
raise ValueError('not hashable')
984
def get_idpath(self, file_id):
985
"""Return a list of file_ids for the path to an entry.
987
The list contains one element for each directory followed by
988
the id of the file itself. So the length of the returned list
989
is equal to the depth of the file in the tree, counting the
990
root directory as depth 1.
993
while file_id != None:
995
ie = self._byid[file_id]
997
raise BzrError("file_id {%s} not found in inventory" % file_id)
998
p.insert(0, ie.file_id)
999
file_id = ie.parent_id
1003
def id2path(self, file_id):
1004
"""Return as a list the path to file_id.
1007
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1008
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1009
>>> print i.id2path('foo-id')
1012
# get all names, skipping root
1013
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
1021
def path2id(self, name):
1022
"""Walk down through directories to return entry of last component.
1024
names may be either a list of path components, or a single
1025
string, in which case it is automatically split.
1027
This returns the entry of the last component in the path,
1028
which may be either a file or a directory.
1030
Returns None iff the path is not found.
1032
if isinstance(name, types.StringTypes):
1033
name = splitpath(name)
1035
mutter("lookup path %r" % name)
1040
cie = parent.children[f]
1041
assert cie.name == f
1042
assert cie.parent_id == parent.file_id
1045
# or raise an error?
1048
return parent.file_id
1051
def has_filename(self, names):
1052
return bool(self.path2id(names))
1055
def has_id(self, file_id):
1056
return self._byid.has_key(file_id)
1059
def rename(self, file_id, new_parent_id, new_name):
1060
"""Move a file within the inventory.
1062
This can change either the name, or the parent, or both.
1064
This does not move the working file."""
1065
if not is_valid_name(new_name):
1066
raise BzrError("not an acceptable filename: %r" % new_name)
1068
new_parent = self._byid[new_parent_id]
1069
if new_name in new_parent.children:
1070
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1072
new_parent_idpath = self.get_idpath(new_parent_id)
1073
if file_id in new_parent_idpath:
1074
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1075
% (self.id2path(file_id), self.id2path(new_parent_id)))
1077
file_ie = self._byid[file_id]
1078
old_parent = self._byid[file_ie.parent_id]
1080
# TODO: Don't leave things messed up if this fails
1082
del old_parent.children[file_ie.name]
1083
new_parent.children[new_name] = file_ie
1085
file_ie.name = new_name
1086
file_ie.parent_id = new_parent_id
1093
def is_valid_name(name):
1095
if _NAME_RE == None:
1096
_NAME_RE = re.compile(r'^[^/\\]+$')
1098
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
