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(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(pathjoin(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 = pathjoin(dest, dp)
271
self._put_on_disk(fullpath, tree)
272
mutter(" export {%s} kind %s to %s", self.file_id,
275
def _put_on_disk(self, fullpath, tree):
276
"""Put this entry onto disk at fullpath, from tree tree."""
277
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
279
def sorted_children(self):
280
l = self.children.items()
285
def versionable_kind(kind):
286
return kind in ('file', 'directory', 'symlink')
288
def check(self, checker, rev_id, inv, tree):
289
"""Check this inventory entry is intact.
291
This is a template method, override _check for kind specific
294
if self.parent_id != None:
295
if not inv.has_id(self.parent_id):
296
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
297
% (self.parent_id, rev_id))
298
self._check(checker, rev_id, tree)
300
def _check(self, checker, rev_id, tree):
301
"""Check this inventory entry for kind specific errors."""
302
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
307
"""Clone this inventory entry."""
308
raise NotImplementedError
310
def _get_snapshot_change(self, previous_entries):
311
if len(previous_entries) > 1:
313
elif len(previous_entries) == 0:
316
return 'modified/renamed/reparented'
319
return ("%s(%r, %r, parent_id=%r)"
320
% (self.__class__.__name__,
325
def snapshot(self, revision, path, previous_entries,
326
work_tree, weave_store, transaction):
327
"""Make a snapshot of this entry which may or may not have changed.
329
This means that all its fields are populated, that it has its
330
text stored in the text store or weave.
332
mutter('new parents of %s are %r', path, previous_entries)
333
self._read_tree_state(path, work_tree)
334
if len(previous_entries) == 1:
335
# cannot be unchanged unless there is only one parent file rev.
336
parent_ie = previous_entries.values()[0]
337
if self._unchanged(parent_ie):
338
mutter("found unchanged entry")
339
self.revision = parent_ie.revision
341
return self.snapshot_revision(revision, previous_entries,
342
work_tree, weave_store, transaction)
344
def snapshot_revision(self, revision, previous_entries, work_tree,
345
weave_store, transaction):
346
"""Record this revision unconditionally."""
347
mutter('new revision for {%s}', self.file_id)
348
self.revision = revision
349
change = self._get_snapshot_change(previous_entries)
350
self._snapshot_text(previous_entries, work_tree, weave_store,
354
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
355
"""Record the 'text' of this entry, whatever form that takes.
357
This default implementation simply adds an empty text.
359
mutter('storing file {%s} in revision {%s}',
360
self.file_id, self.revision)
361
self._add_text_to_weave([], file_parents, weave_store, transaction)
363
def __eq__(self, other):
364
if not isinstance(other, InventoryEntry):
365
return NotImplemented
367
return ((self.file_id == other.file_id)
368
and (self.name == other.name)
369
and (other.symlink_target == self.symlink_target)
370
and (self.text_sha1 == other.text_sha1)
371
and (self.text_size == other.text_size)
372
and (self.text_id == other.text_id)
373
and (self.parent_id == other.parent_id)
374
and (self.kind == other.kind)
375
and (self.revision == other.revision)
376
and (self.executable == other.executable)
379
def __ne__(self, other):
380
return not (self == other)
383
raise ValueError('not hashable')
385
def _unchanged(self, previous_ie):
386
"""Has this entry changed relative to previous_ie.
388
This method should be overriden in child classes.
391
# different inv parent
392
if previous_ie.parent_id != self.parent_id:
395
elif previous_ie.name != self.name:
399
def _read_tree_state(self, path, work_tree):
400
"""Populate fields in the inventory entry from the given tree.
402
Note that this should be modified to be a noop on virtual trees
403
as all entries created there are prepopulated.
405
# TODO: Rather than running this manually, we should check the
406
# working sha1 and other expensive properties when they're
407
# first requested, or preload them if they're already known
408
pass # nothing to do by default
410
def _forget_tree_state(self):
414
class RootEntry(InventoryEntry):
416
def _check(self, checker, rev_id, tree):
417
"""See InventoryEntry._check"""
419
def __init__(self, file_id):
420
self.file_id = file_id
422
self.kind = 'root_directory'
423
self.parent_id = None
426
def __eq__(self, other):
427
if not isinstance(other, RootEntry):
428
return NotImplemented
430
return (self.file_id == other.file_id) \
431
and (self.children == other.children)
434
class InventoryDirectory(InventoryEntry):
435
"""A directory in an inventory."""
437
def _check(self, checker, rev_id, tree):
438
"""See InventoryEntry._check"""
439
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
440
raise BzrCheckError('directory {%s} has text in revision {%s}'
441
% (self.file_id, rev_id))
444
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
445
other.revision = self.revision
446
# note that children are *not* copied; they're pulled across when
450
def __init__(self, file_id, name, parent_id):
451
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
453
self.kind = 'directory'
455
def kind_character(self):
456
"""See InventoryEntry.kind_character."""
459
def _put_in_tar(self, item, tree):
460
"""See InventoryEntry._put_in_tar."""
461
item.type = tarfile.DIRTYPE
468
def _put_on_disk(self, fullpath, tree):
469
"""See InventoryEntry._put_on_disk."""
473
class InventoryFile(InventoryEntry):
474
"""A file in an inventory."""
476
def _check(self, checker, rev_id, tree):
477
"""See InventoryEntry._check"""
478
revision = self.revision
479
t = (self.file_id, revision)
480
if t in checker.checked_texts:
481
prev_sha = checker.checked_texts[t]
482
if prev_sha != self.text_sha1:
483
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
484
(self.file_id, rev_id))
486
checker.repeated_text_cnt += 1
489
if self.file_id not in checker.checked_weaves:
490
mutter('check weave {%s}', self.file_id)
491
w = tree.get_weave(self.file_id)
492
# Not passing a progress bar, because it creates a new
493
# progress, which overwrites the current progress,
494
# and doesn't look nice
496
checker.checked_weaves[self.file_id] = True
498
w = tree.get_weave(self.file_id)
500
mutter('check version {%s} of {%s}', rev_id, self.file_id)
501
checker.checked_text_cnt += 1
502
# We can't check the length, because Weave doesn't store that
503
# information, and the whole point of looking at the weave's
504
# sha1sum is that we don't have to extract the text.
505
if self.text_sha1 != w.get_sha1(self.revision):
506
raise BzrCheckError('text {%s} version {%s} wrong sha1'
507
% (self.file_id, self.revision))
508
checker.checked_texts[t] = self.text_sha1
511
other = InventoryFile(self.file_id, self.name, self.parent_id)
512
other.executable = self.executable
513
other.text_id = self.text_id
514
other.text_sha1 = self.text_sha1
515
other.text_size = self.text_size
516
other.revision = self.revision
519
def detect_changes(self, old_entry):
520
"""See InventoryEntry.detect_changes."""
521
assert self.text_sha1 != None
522
assert old_entry.text_sha1 != None
523
text_modified = (self.text_sha1 != old_entry.text_sha1)
524
meta_modified = (self.executable != old_entry.executable)
525
return text_modified, meta_modified
527
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
528
output_to, reverse=False):
529
"""See InventoryEntry._diff."""
530
from_text = tree.get_file(self.file_id).readlines()
532
to_text = to_tree.get_file(to_entry.file_id).readlines()
536
text_diff(from_label, from_text,
537
to_label, to_text, output_to)
539
text_diff(to_label, to_text,
540
from_label, from_text, output_to)
543
"""See InventoryEntry.has_text."""
546
def __init__(self, file_id, name, parent_id):
547
super(InventoryFile, self).__init__(file_id, name, parent_id)
550
def kind_character(self):
551
"""See InventoryEntry.kind_character."""
554
def _put_in_tar(self, item, tree):
555
"""See InventoryEntry._put_in_tar."""
556
item.type = tarfile.REGTYPE
557
fileobj = tree.get_file(self.file_id)
558
item.size = self.text_size
559
if tree.is_executable(self.file_id):
565
def _put_on_disk(self, fullpath, tree):
566
"""See InventoryEntry._put_on_disk."""
567
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
568
if tree.is_executable(self.file_id):
569
os.chmod(fullpath, 0755)
571
def _read_tree_state(self, path, work_tree):
572
"""See InventoryEntry._read_tree_state."""
573
self.text_sha1 = work_tree.get_file_sha1(self.file_id)
574
self.executable = work_tree.is_executable(self.file_id)
576
def _forget_tree_state(self):
577
self.text_sha1 = None
578
self.executable = None
580
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
581
"""See InventoryEntry._snapshot_text."""
582
mutter('storing file {%s} in revision {%s}',
583
self.file_id, self.revision)
584
# special case to avoid diffing on renames or
586
if (len(file_parents) == 1
587
and self.text_sha1 == file_parents.values()[0].text_sha1
588
and self.text_size == file_parents.values()[0].text_size):
589
previous_ie = file_parents.values()[0]
590
versionedfile = weave_store.get_weave(self.file_id, transaction)
591
versionedfile.clone_text(self.revision, previous_ie.revision, file_parents)
593
new_lines = work_tree.get_file(self.file_id).readlines()
594
self._add_text_to_weave(new_lines, file_parents, weave_store,
596
self.text_sha1 = sha_strings(new_lines)
597
self.text_size = sum(map(len, new_lines))
600
def _unchanged(self, previous_ie):
601
"""See InventoryEntry._unchanged."""
602
compatible = super(InventoryFile, self)._unchanged(previous_ie)
603
if self.text_sha1 != previous_ie.text_sha1:
606
# FIXME: 20050930 probe for the text size when getting sha1
607
# in _read_tree_state
608
self.text_size = previous_ie.text_size
609
if self.executable != previous_ie.executable:
614
class InventoryLink(InventoryEntry):
615
"""A file in an inventory."""
617
__slots__ = ['symlink_target']
619
def _check(self, checker, rev_id, tree):
620
"""See InventoryEntry._check"""
621
if self.text_sha1 != None or self.text_size != None or self.text_id != None:
622
raise BzrCheckError('symlink {%s} has text in revision {%s}'
623
% (self.file_id, rev_id))
624
if self.symlink_target == None:
625
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
626
% (self.file_id, rev_id))
629
other = InventoryLink(self.file_id, self.name, self.parent_id)
630
other.symlink_target = self.symlink_target
631
other.revision = self.revision
634
def detect_changes(self, old_entry):
635
"""See InventoryEntry.detect_changes."""
636
# FIXME: which _modified field should we use ? RBC 20051003
637
text_modified = (self.symlink_target != old_entry.symlink_target)
639
mutter(" symlink target changed")
640
meta_modified = False
641
return text_modified, meta_modified
643
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
644
output_to, reverse=False):
645
"""See InventoryEntry._diff."""
646
from_text = self.symlink_target
647
if to_entry is not None:
648
to_text = to_entry.symlink_target
653
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
656
print >>output_to, '=== target was %r' % self.symlink_target
658
print >>output_to, '=== target is %r' % self.symlink_target
660
def __init__(self, file_id, name, parent_id):
661
super(InventoryLink, self).__init__(file_id, name, parent_id)
662
self.kind = 'symlink'
664
def kind_character(self):
665
"""See InventoryEntry.kind_character."""
668
def _put_in_tar(self, item, tree):
669
"""See InventoryEntry._put_in_tar."""
670
item.type = tarfile.SYMTYPE
674
item.linkname = self.symlink_target
677
def _put_on_disk(self, fullpath, tree):
678
"""See InventoryEntry._put_on_disk."""
680
os.symlink(self.symlink_target, fullpath)
682
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
684
def _read_tree_state(self, path, work_tree):
685
"""See InventoryEntry._read_tree_state."""
686
self.symlink_target = work_tree.get_symlink_target(self.file_id)
688
def _forget_tree_state(self):
689
self.symlink_target = None
691
def _unchanged(self, previous_ie):
692
"""See InventoryEntry._unchanged."""
693
compatible = super(InventoryLink, self)._unchanged(previous_ie)
694
if self.symlink_target != previous_ie.symlink_target:
699
class Inventory(object):
700
"""Inventory of versioned files in a tree.
702
This describes which file_id is present at each point in the tree,
703
and possibly the SHA-1 or other information about the file.
704
Entries can be looked up either by path or by file_id.
706
The inventory represents a typical unix file tree, with
707
directories containing files and subdirectories. We never store
708
the full path to a file, because renaming a directory implicitly
709
moves all of its contents. This class internally maintains a
710
lookup tree that allows the children under a directory to be
713
InventoryEntry objects must not be modified after they are
714
inserted, other than through the Inventory API.
716
>>> inv = Inventory()
717
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
718
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
719
>>> inv['123-123'].name
722
May be treated as an iterator or set to look up file ids:
724
>>> bool(inv.path2id('hello.c'))
729
May also look up by name:
731
>>> [x[0] for x in inv.iter_entries()]
733
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
734
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
735
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
737
def __init__(self, root_id=ROOT_ID):
738
"""Create or read an inventory.
740
If a working directory is specified, the inventory is read
741
from there. If the file is specified, read from that. If not,
742
the inventory is created empty.
744
The inventory is created with a default root directory, with
747
# We are letting Branch.create() create a unique inventory
748
# root id. Rather than generating a random one here.
750
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
751
self.root = RootEntry(root_id)
752
self._byid = {self.root.file_id: self.root}
756
other = Inventory(self.root.file_id)
757
# copy recursively so we know directories will be added before
758
# their children. There are more efficient ways than this...
759
for path, entry in self.iter_entries():
760
if entry == self.root:
762
other.add(entry.copy())
767
return iter(self._byid)
771
"""Returns number of entries."""
772
return len(self._byid)
775
def iter_entries(self, from_dir=None):
776
"""Return (path, entry) pairs, in order by name."""
780
elif isinstance(from_dir, basestring):
781
from_dir = self._byid[from_dir]
783
kids = from_dir.children.items()
785
for name, ie in kids:
787
if ie.kind == 'directory':
788
for cn, cie in self.iter_entries(from_dir=ie.file_id):
789
yield pathjoin(name, cn), cie
793
"""Return list of (path, ie) for all entries except the root.
795
This may be faster than iter_entries.
798
def descend(dir_ie, dir_path):
799
kids = dir_ie.children.items()
801
for name, ie in kids:
802
child_path = pathjoin(dir_path, name)
803
accum.append((child_path, ie))
804
if ie.kind == 'directory':
805
descend(ie, child_path)
807
descend(self.root, u'')
811
def directories(self):
812
"""Return (path, entry) pairs for all directories, including the root.
815
def descend(parent_ie, parent_path):
816
accum.append((parent_path, parent_ie))
818
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
821
for name, child_ie in kids:
822
child_path = pathjoin(parent_path, name)
823
descend(child_ie, child_path)
824
descend(self.root, u'')
829
def __contains__(self, file_id):
830
"""True if this entry contains a file with given id.
832
>>> inv = Inventory()
833
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
834
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
840
return file_id in self._byid
843
def __getitem__(self, file_id):
844
"""Return the entry for given file_id.
846
>>> inv = Inventory()
847
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
848
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
849
>>> inv['123123'].name
853
return self._byid[file_id]
856
raise BzrError("can't look up file_id None")
858
raise BzrError("file_id {%s} not in inventory" % file_id)
861
def get_file_kind(self, file_id):
862
return self._byid[file_id].kind
864
def get_child(self, parent_id, filename):
865
return self[parent_id].children.get(filename)
868
def add(self, entry):
869
"""Add entry to inventory.
871
To add a file to a branch ready to be committed, use Branch.add,
874
Returns the new entry object.
876
if entry.file_id in self._byid:
877
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
879
if entry.parent_id == ROOT_ID or entry.parent_id is None:
880
entry.parent_id = self.root.file_id
883
parent = self._byid[entry.parent_id]
885
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
887
if parent.children.has_key(entry.name):
888
raise BzrError("%s is already versioned" %
889
pathjoin(self.id2path(parent.file_id), entry.name))
891
self._byid[entry.file_id] = entry
892
parent.children[entry.name] = entry
896
def add_path(self, relpath, kind, file_id=None):
897
"""Add entry from a path.
899
The immediate parent must already be versioned.
901
Returns the new entry object."""
902
from bzrlib.workingtree import gen_file_id
904
parts = bzrlib.osutils.splitpath(relpath)
907
file_id = gen_file_id(relpath)
910
self.root = RootEntry(file_id)
911
self._byid = {self.root.file_id: self.root}
914
parent_path = parts[:-1]
915
parent_id = self.path2id(parent_path)
916
if parent_id == None:
917
raise NotVersionedError(path=parent_path)
918
if kind == 'directory':
919
ie = InventoryDirectory(file_id, parts[-1], parent_id)
921
ie = InventoryFile(file_id, parts[-1], parent_id)
922
elif kind == 'symlink':
923
ie = InventoryLink(file_id, parts[-1], parent_id)
925
raise BzrError("unknown kind %r" % kind)
929
def __delitem__(self, file_id):
930
"""Remove entry by id.
932
>>> inv = Inventory()
933
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
934
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
943
assert ie.parent_id is None or \
944
self[ie.parent_id].children[ie.name] == ie
946
del self._byid[file_id]
947
if ie.parent_id is not None:
948
del self[ie.parent_id].children[ie.name]
951
def __eq__(self, other):
952
"""Compare two sets by comparing their contents.
958
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
959
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
962
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
963
InventoryFile('123', 'foo', parent_id='TREE_ROOT')
967
if not isinstance(other, Inventory):
968
return NotImplemented
970
if len(self._byid) != len(other._byid):
971
# shortcut: obviously not the same
974
return self._byid == other._byid
977
def __ne__(self, other):
978
return not self.__eq__(other)
982
raise ValueError('not hashable')
985
def get_idpath(self, file_id):
986
"""Return a list of file_ids for the path to an entry.
988
The list contains one element for each directory followed by
989
the id of the file itself. So the length of the returned list
990
is equal to the depth of the file in the tree, counting the
991
root directory as depth 1.
994
while file_id != None:
996
ie = self._byid[file_id]
998
raise BzrError("file_id {%s} not found in inventory" % file_id)
999
p.insert(0, ie.file_id)
1000
file_id = ie.parent_id
1004
def id2path(self, file_id):
1005
"""Return as a list the path to file_id.
1008
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1009
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1010
>>> print i.id2path('foo-id')
1013
# get all names, skipping root
1014
p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
1022
def path2id(self, name):
1023
"""Walk down through directories to return entry of last component.
1025
names may be either a list of path components, or a single
1026
string, in which case it is automatically split.
1028
This returns the entry of the last component in the path,
1029
which may be either a file or a directory.
1031
Returns None iff the path is not found.
1033
if isinstance(name, types.StringTypes):
1034
name = splitpath(name)
1036
mutter("lookup path %r" % name)
1041
cie = parent.children[f]
1042
assert cie.name == f
1043
assert cie.parent_id == parent.file_id
1046
# or raise an error?
1049
return parent.file_id
1052
def has_filename(self, names):
1053
return bool(self.path2id(names))
1056
def has_id(self, file_id):
1057
return self._byid.has_key(file_id)
1060
def rename(self, file_id, new_parent_id, new_name):
1061
"""Move a file within the inventory.
1063
This can change either the name, or the parent, or both.
1065
This does not move the working file."""
1066
if not is_valid_name(new_name):
1067
raise BzrError("not an acceptable filename: %r" % new_name)
1069
new_parent = self._byid[new_parent_id]
1070
if new_name in new_parent.children:
1071
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1073
new_parent_idpath = self.get_idpath(new_parent_id)
1074
if file_id in new_parent_idpath:
1075
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1076
% (self.id2path(file_id), self.id2path(new_parent_id)))
1078
file_ie = self._byid[file_id]
1079
old_parent = self._byid[file_ie.parent_id]
1081
# TODO: Don't leave things messed up if this fails
1083
del old_parent.children[file_ie.name]
1084
new_parent.children[new_name] = file_ie
1086
file_ie.name = new_name
1087
file_ie.parent_id = new_parent_id
1094
def is_valid_name(name):
1096
if _NAME_RE == None:
1097
_NAME_RE = re.compile(r'^[^/\\]+$')
1099
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
