1
# Copyright (C) 2005, 2006, 2007 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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.
30
from bzrlib.lazy_import import lazy_import
31
lazy_import(globals(), """
48
from bzrlib.errors import (
52
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
53
from bzrlib.trace import mutter
56
class InventoryEntry(object):
57
"""Description of a versioned file.
59
An InventoryEntry has the following fields, which are also
60
present in the XML inventory-entry element:
65
(within the parent directory)
68
file_id of the parent directory, or ROOT_ID
71
the revision_id in which this variation of this file was
75
Indicates that this file should be executable on systems
79
sha-1 of the text of the file
82
size in bytes of the text of the file
84
(reading a version 4 tree created a text_id field.)
89
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
90
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
91
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
92
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
93
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
94
>>> for ix, j in enumerate(i.iter_entries()):
95
... print (j[0] == shouldbe[ix], j[1])
97
(True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
98
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
99
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
100
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
101
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
102
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
103
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
104
>>> i.path2id('src/wibble')
108
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
109
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
111
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
112
>>> for path, entry in i.iter_entries():
121
>>> i.id2path('2326')
122
'src/wibble/wibble.c'
125
# Constants returned by describe_change()
127
# TODO: These should probably move to some kind of FileChangeDescription
128
# class; that's like what's inside a TreeDelta but we want to be able to
129
# generate them just for one file at a time.
131
MODIFIED_AND_RENAMED = 'modified and renamed'
135
def detect_changes(self, old_entry):
136
"""Return a (text_modified, meta_modified) from this to old_entry.
138
_read_tree_state must have been called on self and old_entry prior to
139
calling detect_changes.
143
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
144
output_to, reverse=False):
145
"""Perform a diff between two entries of the same kind."""
147
def parent_candidates(self, previous_inventories):
148
"""Find possible per-file graph parents.
150
This is currently defined by:
151
- Select the last changed revision in the parent inventory.
152
- Do deal with a short lived bug in bzr 0.8's development two entries
153
that have the same last changed but different 'x' bit settings are
156
# revision:ie mapping for each ie found in previous_inventories.
158
# identify candidate head revision ids.
159
for inv in previous_inventories:
160
if self.file_id in inv:
161
ie = inv[self.file_id]
162
if ie.revision in candidates:
163
# same revision value in two different inventories:
164
# correct possible inconsistencies:
165
# * there was a bug in revision updates with 'x' bit
168
if candidates[ie.revision].executable != ie.executable:
169
candidates[ie.revision].executable = False
170
ie.executable = False
171
except AttributeError:
174
# add this revision as a candidate.
175
candidates[ie.revision] = ie
178
@deprecated_method(deprecated_in((1, 6, 0)))
179
def get_tar_item(self, root, dp, now, tree):
180
"""Get a tarfile item and a file stream for its content."""
181
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
182
# TODO: would be cool to actually set it to the timestamp of the
183
# revision it was last changed
185
fileobj = self._put_in_tar(item, tree)
189
"""Return true if the object this entry represents has textual data.
191
Note that textual data includes binary content.
193
Also note that all entries get weave files created for them.
194
This attribute is primarily used when upgrading from old trees that
195
did not have the weave index for all inventory entries.
199
def __init__(self, file_id, name, parent_id, text_id=None):
200
"""Create an InventoryEntry
202
The filename must be a single component, relative to the
203
parent directory; it cannot be a whole path or relative name.
205
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
210
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
211
Traceback (most recent call last):
212
InvalidEntryName: Invalid entry name: src/hello.c
214
if '/' in name or '\\' in name:
215
raise errors.InvalidEntryName(name=name)
216
self.executable = False
218
self.text_sha1 = None
219
self.text_size = None
220
self.file_id = file_id
222
self.text_id = text_id
223
self.parent_id = parent_id
224
self.symlink_target = None
225
self.reference_revision = None
227
def kind_character(self):
228
"""Return a short kind indicator useful for appending to names."""
229
raise BzrError('unknown kind %r' % self.kind)
231
known_kinds = ('file', 'directory', 'symlink')
233
def _put_in_tar(self, item, tree):
234
"""populate item for stashing in a tar, and return the content stream.
236
If no content is available, return None.
238
raise BzrError("don't know how to export {%s} of kind %r" %
239
(self.file_id, self.kind))
241
@deprecated_method(deprecated_in((1, 6, 0)))
242
def put_on_disk(self, dest, dp, tree):
243
"""Create a representation of self on disk in the prefix dest.
245
This is a template method - implement _put_on_disk in subclasses.
247
fullpath = osutils.pathjoin(dest, dp)
248
self._put_on_disk(fullpath, tree)
249
# mutter(" export {%s} kind %s to %s", self.file_id,
250
# self.kind, fullpath)
252
def _put_on_disk(self, fullpath, tree):
253
"""Put this entry onto disk at fullpath, from tree tree."""
254
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
256
def sorted_children(self):
257
return sorted(self.children.items())
260
def versionable_kind(kind):
261
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
263
def check(self, checker, rev_id, inv, tree):
264
"""Check this inventory entry is intact.
266
This is a template method, override _check for kind specific
269
:param checker: Check object providing context for the checks;
270
can be used to find out what parts of the repository have already
272
:param rev_id: Revision id from which this InventoryEntry was loaded.
273
Not necessarily the last-changed revision for this file.
274
:param inv: Inventory from which the entry was loaded.
275
:param tree: RevisionTree for this entry.
277
if self.parent_id is not None:
278
if not inv.has_id(self.parent_id):
279
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
280
% (self.parent_id, rev_id))
281
self._check(checker, rev_id, tree)
283
def _check(self, checker, rev_id, tree):
284
"""Check this inventory entry for kind specific errors."""
285
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
289
"""Clone this inventory entry."""
290
raise NotImplementedError
293
def describe_change(old_entry, new_entry):
294
"""Describe the change between old_entry and this.
296
This smells of being an InterInventoryEntry situation, but as its
297
the first one, we're making it a static method for now.
299
An entry with a different parent, or different name is considered
300
to be renamed. Reparenting is an internal detail.
301
Note that renaming the parent does not trigger a rename for the
304
# TODO: Perhaps return an object rather than just a string
305
if old_entry is new_entry:
306
# also the case of both being None
308
elif old_entry is None:
310
elif new_entry is None:
312
if old_entry.kind != new_entry.kind:
314
text_modified, meta_modified = new_entry.detect_changes(old_entry)
315
if text_modified or meta_modified:
319
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
320
if old_entry.parent_id != new_entry.parent_id:
322
elif old_entry.name != new_entry.name:
326
if renamed and not modified:
327
return InventoryEntry.RENAMED
328
if modified and not renamed:
330
if modified and renamed:
331
return InventoryEntry.MODIFIED_AND_RENAMED
335
return ("%s(%r, %r, parent_id=%r, revision=%r)"
336
% (self.__class__.__name__,
342
def __eq__(self, other):
344
# For the case when objects are cached
346
if not isinstance(other, InventoryEntry):
347
return NotImplemented
349
return ((self.file_id == other.file_id)
350
and (self.name == other.name)
351
and (other.symlink_target == self.symlink_target)
352
and (self.text_sha1 == other.text_sha1)
353
and (self.text_size == other.text_size)
354
and (self.text_id == other.text_id)
355
and (self.parent_id == other.parent_id)
356
and (self.kind == other.kind)
357
and (self.revision == other.revision)
358
and (self.executable == other.executable)
359
and (self.reference_revision == other.reference_revision)
362
def __ne__(self, other):
363
return not (self == other)
366
raise ValueError('not hashable')
368
def _unchanged(self, previous_ie):
369
"""Has this entry changed relative to previous_ie.
371
This method should be overridden in child classes.
374
# different inv parent
375
if previous_ie.parent_id != self.parent_id:
378
elif previous_ie.name != self.name:
380
elif previous_ie.kind != self.kind:
384
def _read_tree_state(self, path, work_tree):
385
"""Populate fields in the inventory entry from the given tree.
387
Note that this should be modified to be a noop on virtual trees
388
as all entries created there are prepopulated.
390
# TODO: Rather than running this manually, we should check the
391
# working sha1 and other expensive properties when they're
392
# first requested, or preload them if they're already known
393
pass # nothing to do by default
395
def _forget_tree_state(self):
399
class RootEntry(InventoryEntry):
401
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
402
'text_id', 'parent_id', 'children', 'executable',
403
'revision', 'symlink_target', 'reference_revision']
405
def _check(self, checker, rev_id, tree):
406
"""See InventoryEntry._check"""
408
def __init__(self, file_id):
409
self.file_id = file_id
411
self.kind = 'directory'
412
self.parent_id = None
415
symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
416
' Please use InventoryDirectory instead.',
417
DeprecationWarning, stacklevel=2)
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
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
431
'text_id', 'parent_id', 'children', 'executable',
432
'revision', 'symlink_target', 'reference_revision']
434
def _check(self, checker, rev_id, tree):
435
"""See InventoryEntry._check"""
436
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
437
raise BzrCheckError('directory {%s} has text in revision {%s}'
438
% (self.file_id, rev_id))
441
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
442
other.revision = self.revision
443
# note that children are *not* copied; they're pulled across when
447
def __init__(self, file_id, name, parent_id):
448
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
450
self.kind = 'directory'
452
def kind_character(self):
453
"""See InventoryEntry.kind_character."""
456
def _put_in_tar(self, item, tree):
457
"""See InventoryEntry._put_in_tar."""
458
item.type = tarfile.DIRTYPE
465
def _put_on_disk(self, fullpath, tree):
466
"""See InventoryEntry._put_on_disk."""
470
class InventoryFile(InventoryEntry):
471
"""A file in an inventory."""
473
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
474
'text_id', 'parent_id', 'children', 'executable',
475
'revision', 'symlink_target', 'reference_revision']
477
def _check(self, checker, tree_revision_id, tree):
478
"""See InventoryEntry._check"""
479
key = (self.file_id, self.revision)
480
if key in checker.checked_texts:
481
prev_sha = checker.checked_texts[key]
482
if prev_sha != self.text_sha1:
484
'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
485
(self.file_id, tree_revision_id, prev_sha, self.text_sha1,
488
checker.repeated_text_cnt += 1
491
checker.checked_text_cnt += 1
492
# We can't check the length, because Weave doesn't store that
493
# information, and the whole point of looking at the weave's
494
# sha1sum is that we don't have to extract the text.
495
if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
496
raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
497
checker.checked_texts[key] = self.text_sha1
500
other = InventoryFile(self.file_id, self.name, self.parent_id)
501
other.executable = self.executable
502
other.text_id = self.text_id
503
other.text_sha1 = self.text_sha1
504
other.text_size = self.text_size
505
other.revision = self.revision
508
def detect_changes(self, old_entry):
509
"""See InventoryEntry.detect_changes."""
510
text_modified = (self.text_sha1 != old_entry.text_sha1)
511
meta_modified = (self.executable != old_entry.executable)
512
return text_modified, meta_modified
514
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
515
output_to, reverse=False):
516
"""See InventoryEntry._diff."""
517
from bzrlib.diff import DiffText
518
from_file_id = self.file_id
520
to_file_id = to_entry.file_id
524
to_file_id, from_file_id = from_file_id, to_file_id
525
tree, to_tree = to_tree, tree
526
from_label, to_label = to_label, from_label
527
differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
529
return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
532
"""See InventoryEntry.has_text."""
535
def __init__(self, file_id, name, parent_id):
536
super(InventoryFile, self).__init__(file_id, name, parent_id)
539
def kind_character(self):
540
"""See InventoryEntry.kind_character."""
543
def _put_in_tar(self, item, tree):
544
"""See InventoryEntry._put_in_tar."""
545
item.type = tarfile.REGTYPE
546
fileobj = tree.get_file(self.file_id)
547
item.size = self.text_size
548
if tree.is_executable(self.file_id):
554
def _put_on_disk(self, fullpath, tree):
555
"""See InventoryEntry._put_on_disk."""
556
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
557
if tree.is_executable(self.file_id):
558
os.chmod(fullpath, 0755)
560
def _read_tree_state(self, path, work_tree):
561
"""See InventoryEntry._read_tree_state."""
562
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
563
# FIXME: 20050930 probe for the text size when getting sha1
564
# in _read_tree_state
565
self.executable = work_tree.is_executable(self.file_id, path=path)
568
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s, revision=%s)"
569
% (self.__class__.__name__,
577
def _forget_tree_state(self):
578
self.text_sha1 = None
580
def _unchanged(self, previous_ie):
581
"""See InventoryEntry._unchanged."""
582
compatible = super(InventoryFile, self)._unchanged(previous_ie)
583
if self.text_sha1 != previous_ie.text_sha1:
586
# FIXME: 20050930 probe for the text size when getting sha1
587
# in _read_tree_state
588
self.text_size = previous_ie.text_size
589
if self.executable != previous_ie.executable:
594
class InventoryLink(InventoryEntry):
595
"""A file in an inventory."""
597
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
598
'text_id', 'parent_id', 'children', 'executable',
599
'revision', 'symlink_target', 'reference_revision']
601
def _check(self, checker, rev_id, tree):
602
"""See InventoryEntry._check"""
603
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
604
raise BzrCheckError('symlink {%s} has text in revision {%s}'
605
% (self.file_id, rev_id))
606
if self.symlink_target is None:
607
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
608
% (self.file_id, rev_id))
611
other = InventoryLink(self.file_id, self.name, self.parent_id)
612
other.symlink_target = self.symlink_target
613
other.revision = self.revision
616
def detect_changes(self, old_entry):
617
"""See InventoryEntry.detect_changes."""
618
# FIXME: which _modified field should we use ? RBC 20051003
619
text_modified = (self.symlink_target != old_entry.symlink_target)
621
mutter(" symlink target changed")
622
meta_modified = False
623
return text_modified, meta_modified
625
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
626
output_to, reverse=False):
627
"""See InventoryEntry._diff."""
628
from bzrlib.diff import DiffSymlink
629
old_target = self.symlink_target
630
if to_entry is not None:
631
new_target = to_entry.symlink_target
640
new_target, old_target = old_target, new_target
641
differ = DiffSymlink(old_tree, new_tree, output_to)
642
return differ.diff_symlink(old_target, new_target)
644
def __init__(self, file_id, name, parent_id):
645
super(InventoryLink, self).__init__(file_id, name, parent_id)
646
self.kind = 'symlink'
648
def kind_character(self):
649
"""See InventoryEntry.kind_character."""
652
def _put_in_tar(self, item, tree):
653
"""See InventoryEntry._put_in_tar."""
654
item.type = tarfile.SYMTYPE
658
item.linkname = self.symlink_target
661
def _put_on_disk(self, fullpath, tree):
662
"""See InventoryEntry._put_on_disk."""
664
os.symlink(self.symlink_target, fullpath)
666
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
668
def _read_tree_state(self, path, work_tree):
669
"""See InventoryEntry._read_tree_state."""
670
self.symlink_target = work_tree.get_symlink_target(self.file_id)
672
def _forget_tree_state(self):
673
self.symlink_target = None
675
def _unchanged(self, previous_ie):
676
"""See InventoryEntry._unchanged."""
677
compatible = super(InventoryLink, self)._unchanged(previous_ie)
678
if self.symlink_target != previous_ie.symlink_target:
683
class TreeReference(InventoryEntry):
685
kind = 'tree-reference'
687
def __init__(self, file_id, name, parent_id, revision=None,
688
reference_revision=None):
689
InventoryEntry.__init__(self, file_id, name, parent_id)
690
self.revision = revision
691
self.reference_revision = reference_revision
694
return TreeReference(self.file_id, self.name, self.parent_id,
695
self.revision, self.reference_revision)
697
def _read_tree_state(self, path, work_tree):
698
"""Populate fields in the inventory entry from the given tree.
700
self.reference_revision = work_tree.get_reference_revision(
703
def _forget_tree_state(self):
704
self.reference_revision = None
706
def _unchanged(self, previous_ie):
707
"""See InventoryEntry._unchanged."""
708
compatible = super(TreeReference, self)._unchanged(previous_ie)
709
if self.reference_revision != previous_ie.reference_revision:
714
class CommonInventory(object):
715
"""Basic inventory logic, defined in terms of primitives like has_id.
717
An inventory is the metadata about the contents of a tree.
719
This is broadly a map from file_id to entries such as directories, files,
720
symlinks and tree references. Each entry maintains its own metadata like
721
SHA1 and length for files, or children for a directory.
723
Entries can be looked up either by path or by file_id.
725
InventoryEntry objects must not be modified after they are
726
inserted, other than through the Inventory API.
729
def __contains__(self, file_id):
730
"""True if this entry contains a file with given id.
732
>>> inv = Inventory()
733
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
734
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
740
Note that this method along with __iter__ are not encouraged for use as
741
they are less clear than specific query methods - they may be rmeoved
744
return self.has_id(file_id)
746
def id2path(self, file_id):
747
"""Return as a string the path to file_id.
750
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
751
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
752
>>> print i.id2path('foo-id')
755
# get all names, skipping root
756
return '/'.join(reversed(
757
[parent.name for parent in
758
self._iter_file_id_parents(file_id)][:-1]))
760
def iter_entries(self, from_dir=None, recursive=True):
761
"""Return (path, entry) pairs, in order by name.
763
:param from_dir: if None, start from the root,
764
otherwise start from this directory (either file-id or entry)
765
:param recursive: recurse into directories or not
768
if self.root is None:
772
elif isinstance(from_dir, basestring):
773
from_dir = self[from_dir]
775
# unrolling the recursive called changed the time from
776
# 440ms/663ms (inline/total) to 116ms/116ms
777
children = from_dir.children.items()
780
for name, ie in children:
783
children = collections.deque(children)
784
stack = [(u'', children)]
786
from_dir_relpath, children = stack[-1]
789
name, ie = children.popleft()
791
# we know that from_dir_relpath never ends in a slash
792
# and 'f' doesn't begin with one, we can do a string op, rather
793
# than the checks of pathjoin(), though this means that all paths
795
path = from_dir_relpath + '/' + name
799
if ie.kind != 'directory':
802
# But do this child first
803
new_children = ie.children.items()
805
new_children = collections.deque(new_children)
806
stack.append((path, new_children))
807
# Break out of inner loop, so that we start outer loop with child
810
# if we finished all children, pop it off the stack
813
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
814
yield_parents=False):
815
"""Iterate over the entries in a directory first order.
817
This returns all entries for a directory before returning
818
the entries for children of a directory. This is not
819
lexicographically sorted order, and is a hybrid between
820
depth-first and breadth-first.
822
:param yield_parents: If True, yield the parents from the root leading
823
down to specific_file_ids that have been requested. This has no
824
impact if specific_file_ids is None.
825
:return: This yields (path, entry) pairs
827
if specific_file_ids and not isinstance(specific_file_ids, set):
828
specific_file_ids = set(specific_file_ids)
829
# TODO? Perhaps this should return the from_dir so that the root is
830
# yielded? or maybe an option?
832
if self.root is None:
834
# Optimize a common case
835
if (not yield_parents and specific_file_ids is not None and
836
len(specific_file_ids) == 1):
837
file_id = list(specific_file_ids)[0]
839
yield self.id2path(file_id), self[file_id]
842
if (specific_file_ids is None or yield_parents or
843
self.root.file_id in specific_file_ids):
845
elif isinstance(from_dir, basestring):
846
from_dir = self[from_dir]
848
if specific_file_ids is not None:
849
# TODO: jam 20070302 This could really be done as a loop rather
850
# than a bunch of recursive calls.
853
def add_ancestors(file_id):
854
if file_id not in byid:
856
parent_id = byid[file_id].parent_id
857
if parent_id is None:
859
if parent_id not in parents:
860
parents.add(parent_id)
861
add_ancestors(parent_id)
862
for file_id in specific_file_ids:
863
add_ancestors(file_id)
867
stack = [(u'', from_dir)]
869
cur_relpath, cur_dir = stack.pop()
872
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
874
child_relpath = cur_relpath + child_name
876
if (specific_file_ids is None or
877
child_ie.file_id in specific_file_ids or
878
(yield_parents and child_ie.file_id in parents)):
879
yield child_relpath, child_ie
881
if child_ie.kind == 'directory':
882
if parents is None or child_ie.file_id in parents:
883
child_dirs.append((child_relpath+'/', child_ie))
884
stack.extend(reversed(child_dirs))
886
def _make_delta(self, old):
887
"""Make an inventory delta from two inventories."""
890
adds = new_ids - old_ids
891
deletes = old_ids - new_ids
892
common = old_ids.intersection(new_ids)
894
for file_id in deletes:
895
delta.append((old.id2path(file_id), None, file_id, None))
897
delta.append((None, self.id2path(file_id), file_id, self[file_id]))
898
for file_id in common:
899
if old[file_id] != self[file_id]:
900
delta.append((old.id2path(file_id), self.id2path(file_id),
901
file_id, self[file_id]))
904
def _get_mutable_inventory(self):
905
"""Returns a mutable copy of the object.
907
Some inventories are immutable, yet working trees, for example, needs
908
to mutate exisiting inventories instead of creating a new one.
910
raise NotImplementedError(self._get_mutable_inventory)
912
def make_entry(self, kind, name, parent_id, file_id=None):
913
"""Simple thunk to bzrlib.inventory.make_entry."""
914
return make_entry(kind, name, parent_id, file_id)
917
"""Return list of (path, ie) for all entries except the root.
919
This may be faster than iter_entries.
922
def descend(dir_ie, dir_path):
923
kids = dir_ie.children.items()
925
for name, ie in kids:
926
child_path = osutils.pathjoin(dir_path, name)
927
accum.append((child_path, ie))
928
if ie.kind == 'directory':
929
descend(ie, child_path)
931
descend(self.root, u'')
934
def directories(self):
935
"""Return (path, entry) pairs for all directories, including the root.
938
def descend(parent_ie, parent_path):
939
accum.append((parent_path, parent_ie))
941
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
944
for name, child_ie in kids:
945
child_path = osutils.pathjoin(parent_path, name)
946
descend(child_ie, child_path)
947
descend(self.root, u'')
950
def path2id(self, name):
951
"""Walk down through directories to return entry of last component.
953
names may be either a list of path components, or a single
954
string, in which case it is automatically split.
956
This returns the entry of the last component in the path,
957
which may be either a file or a directory.
959
Returns None IFF the path is not found.
961
if isinstance(name, basestring):
962
name = osutils.splitpath(name)
964
# mutter("lookup path %r" % name)
968
except errors.NoSuchId:
969
# root doesn't exist yet so nothing else can
975
children = getattr(parent, 'children', None)
984
return parent.file_id
986
def filter(self, specific_fileids):
987
"""Get an inventory view filtered against a set of file-ids.
989
Children of directories and parents are included.
991
The result may or may not reference the underlying inventory
992
so it should be treated as immutable.
994
interesting_parents = set()
995
for fileid in specific_fileids:
997
interesting_parents.update(self.get_idpath(fileid))
998
except errors.NoSuchId:
999
# This fileid is not in the inventory - that's ok
1001
entries = self.iter_entries()
1002
if self.root is None:
1003
return Inventory(root_id=None)
1004
other = Inventory(entries.next()[1].file_id)
1005
other.root.revision = self.root.revision
1006
other.revision_id = self.revision_id
1007
directories_to_expand = set()
1008
for path, entry in entries:
1009
file_id = entry.file_id
1010
if (file_id in specific_fileids
1011
or entry.parent_id in directories_to_expand):
1012
if entry.kind == 'directory':
1013
directories_to_expand.add(file_id)
1014
elif file_id not in interesting_parents:
1016
other.add(entry.copy())
1019
def get_idpath(self, file_id):
1020
"""Return a list of file_ids for the path to an entry.
1022
The list contains one element for each directory followed by
1023
the id of the file itself. So the length of the returned list
1024
is equal to the depth of the file in the tree, counting the
1025
root directory as depth 1.
1028
for parent in self._iter_file_id_parents(file_id):
1029
p.insert(0, parent.file_id)
1033
class Inventory(CommonInventory):
1034
"""Mutable dict based in-memory inventory.
1036
We never store the full path to a file, because renaming a directory
1037
implicitly moves all of its contents. This class internally maintains a
1038
lookup tree that allows the children under a directory to be
1041
>>> inv = Inventory()
1042
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1043
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1044
>>> inv['123-123'].name
1047
Id's may be looked up from paths:
1049
>>> inv.path2id('hello.c')
1051
>>> '123-123' in inv
1054
There are iterators over the contents:
1056
>>> [entry[0] for entry in inv.iter_entries()]
1060
def __init__(self, root_id=ROOT_ID, revision_id=None):
1061
"""Create or read an inventory.
1063
If a working directory is specified, the inventory is read
1064
from there. If the file is specified, read from that. If not,
1065
the inventory is created empty.
1067
The inventory is created with a default root directory, with
1070
if root_id is not None:
1071
self._set_root(InventoryDirectory(root_id, u'', None))
1075
self.revision_id = revision_id
1078
# More than one page of ouput is not useful anymore to debug
1081
contents = repr(self._byid)
1082
if len(contents) > max_len:
1083
contents = contents[:(max_len-len(closing))] + closing
1084
return "<Inventory object at %x, contents=%r>" % (id(self), contents)
1086
def apply_delta(self, delta):
1087
"""Apply a delta to this inventory.
1089
See the inventory developers documentation for the theory behind
1092
:param delta: A list of changes to apply. After all the changes are
1093
applied the final inventory must be internally consistent, but it
1094
is ok to supply changes which, if only half-applied would have an
1095
invalid result - such as supplying two changes which rename two
1096
files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
1097
('B', 'A', 'B-id', b_entry)].
1099
Each change is a tuple, of the form (old_path, new_path, file_id,
1102
When new_path is None, the change indicates the removal of an entry
1103
from the inventory and new_entry will be ignored (using None is
1104
appropriate). If new_path is not None, then new_entry must be an
1105
InventoryEntry instance, which will be incorporated into the
1106
inventory (and replace any existing entry with the same file id).
1108
When old_path is None, the change indicates the addition of
1109
a new entry to the inventory.
1111
When neither new_path nor old_path are None, the change is a
1112
modification to an entry, such as a rename, reparent, kind change
1115
The children attribute of new_entry is ignored. This is because
1116
this method preserves children automatically across alterations to
1117
the parent of the children, and cases where the parent id of a
1118
child is changing require the child to be passed in as a separate
1119
change regardless. E.g. in the recursive deletion of a directory -
1120
the directory's children must be included in the delta, or the
1121
final inventory will be invalid.
1123
Note that a file_id must only appear once within a given delta.
1124
An AssertionError is raised otherwise.
1126
# Check that the delta is legal. It would be nice if this could be
1127
# done within the loops below but it's safer to validate the delta
1128
# before starting to mutate the inventory, as there isn't a rollback
1130
list(_check_delta_unique_ids(_check_delta_unique_new_paths(
1131
_check_delta_unique_old_paths(_check_delta_ids_match_entry(
1135
# Remove all affected items which were in the original inventory,
1136
# starting with the longest paths, thus ensuring parents are examined
1137
# after their children, which means that everything we examine has no
1138
# modified children remaining by the time we examine it.
1139
for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1140
if op is not None), reverse=True):
1141
if file_id not in self:
1144
# Preserve unaltered children of file_id for later reinsertion.
1145
file_id_children = getattr(self[file_id], 'children', {})
1146
if len(file_id_children):
1147
children[file_id] = file_id_children
1148
# Remove file_id and the unaltered children. If file_id is not
1149
# being deleted it will be reinserted back later.
1150
self.remove_recursive_id(file_id)
1151
# Insert all affected which should be in the new inventory, reattaching
1152
# their children if they had any. This is done from shortest path to
1153
# longest, ensuring that items which were modified and whose parents in
1154
# the resulting inventory were also modified, are inserted after their
1156
for new_path, new_entry in sorted((np, e) for op, np, f, e in
1157
delta if np is not None):
1158
if new_entry.kind == 'directory':
1159
# Pop the child which to allow detection of children whose
1160
# parents were deleted and which were not reattached to a new
1162
replacement = InventoryDirectory(new_entry.file_id,
1163
new_entry.name, new_entry.parent_id)
1164
replacement.revision = new_entry.revision
1165
replacement.children = children.pop(replacement.file_id, {})
1166
new_entry = replacement
1169
except AttributeError:
1170
raise errors.InconsistentDelta(new_path, new_entry.file_id,
1171
"Parent is not a directory.")
1173
# Get the parent id that was deleted
1174
parent_id, children = children.popitem()
1175
raise errors.InconsistentDelta("<deleted>", parent_id,
1176
"The file id was deleted but its children were not deleted.")
1178
def _set_root(self, ie):
1180
self._byid = {self.root.file_id: self.root}
1183
# TODO: jam 20051218 Should copy also copy the revision_id?
1184
entries = self.iter_entries()
1185
if self.root is None:
1186
return Inventory(root_id=None)
1187
other = Inventory(entries.next()[1].file_id)
1188
other.root.revision = self.root.revision
1189
# copy recursively so we know directories will be added before
1190
# their children. There are more efficient ways than this...
1191
for path, entry in entries:
1192
other.add(entry.copy())
1195
def _get_mutable_inventory(self):
1196
"""See CommonInventory._get_mutable_inventory."""
1197
return copy.deepcopy(self)
1200
"""Iterate over all file-ids."""
1201
return iter(self._byid)
1203
def iter_just_entries(self):
1204
"""Iterate over all entries.
1206
Unlike iter_entries(), just the entries are returned (not (path, ie))
1207
and the order of entries is undefined.
1209
XXX: We may not want to merge this into bzr.dev.
1211
if self.root is None:
1213
for _, ie in self._byid.iteritems():
1217
"""Returns number of entries."""
1218
return len(self._byid)
1220
def __getitem__(self, file_id):
1221
"""Return the entry for given file_id.
1223
>>> inv = Inventory()
1224
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1225
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1226
>>> inv['123123'].name
1230
return self._byid[file_id]
1232
# really we're passing an inventory, not a tree...
1233
raise errors.NoSuchId(self, file_id)
1235
def get_file_kind(self, file_id):
1236
return self._byid[file_id].kind
1238
def get_child(self, parent_id, filename):
1239
return self[parent_id].children.get(filename)
1241
def _add_child(self, entry):
1242
"""Add an entry to the inventory, without adding it to its parent"""
1243
if entry.file_id in self._byid:
1244
raise BzrError("inventory already contains entry with id {%s}" %
1246
self._byid[entry.file_id] = entry
1247
for child in getattr(entry, 'children', {}).itervalues():
1248
self._add_child(child)
1251
def add(self, entry):
1252
"""Add entry to inventory.
1254
To add a file to a branch ready to be committed, use Branch.add,
1257
Returns the new entry object.
1259
if entry.file_id in self._byid:
1260
raise errors.DuplicateFileId(entry.file_id,
1261
self._byid[entry.file_id])
1263
if entry.parent_id is None:
1267
parent = self._byid[entry.parent_id]
1269
raise errors.InconsistentDelta("<unknown>", entry.parent_id,
1270
"Parent not in inventory.")
1271
if entry.name in parent.children:
1272
raise errors.InconsistentDelta(
1273
self.id2path(parent.children[entry.name].file_id),
1275
"Path already versioned")
1276
parent.children[entry.name] = entry
1277
return self._add_child(entry)
1279
def add_path(self, relpath, kind, file_id=None, parent_id=None):
1280
"""Add entry from a path.
1282
The immediate parent must already be versioned.
1284
Returns the new entry object."""
1286
parts = osutils.splitpath(relpath)
1290
file_id = generate_ids.gen_root_id()
1291
self.root = InventoryDirectory(file_id, '', None)
1292
self._byid = {self.root.file_id: self.root}
1295
parent_path = parts[:-1]
1296
parent_id = self.path2id(parent_path)
1297
if parent_id is None:
1298
raise errors.NotVersionedError(path=parent_path)
1299
ie = make_entry(kind, parts[-1], parent_id, file_id)
1302
def __delitem__(self, file_id):
1303
"""Remove entry by id.
1305
>>> inv = Inventory()
1306
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1307
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1315
del self._byid[file_id]
1316
if ie.parent_id is not None:
1317
del self[ie.parent_id].children[ie.name]
1319
def __eq__(self, other):
1320
"""Compare two sets by comparing their contents.
1322
>>> i1 = Inventory()
1323
>>> i2 = Inventory()
1326
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1327
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1330
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1331
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1335
if not isinstance(other, Inventory):
1336
return NotImplemented
1338
return self._byid == other._byid
1340
def __ne__(self, other):
1341
return not self.__eq__(other)
1344
raise ValueError('not hashable')
1346
def _iter_file_id_parents(self, file_id):
1347
"""Yield the parents of file_id up to the root."""
1348
while file_id is not None:
1350
ie = self._byid[file_id]
1352
raise errors.NoSuchId(tree=None, file_id=file_id)
1354
file_id = ie.parent_id
1356
def has_filename(self, filename):
1357
return bool(self.path2id(filename))
1359
def has_id(self, file_id):
1360
return (file_id in self._byid)
1362
def _make_delta(self, old):
1363
"""Make an inventory delta from two inventories."""
1364
old_getter = getattr(old, '_byid', old)
1365
new_getter = self._byid
1366
old_ids = set(old_getter)
1367
new_ids = set(new_getter)
1368
adds = new_ids - old_ids
1369
deletes = old_ids - new_ids
1370
if not adds and not deletes:
1373
common = old_ids.intersection(new_ids)
1375
for file_id in deletes:
1376
delta.append((old.id2path(file_id), None, file_id, None))
1377
for file_id in adds:
1378
delta.append((None, self.id2path(file_id), file_id, self[file_id]))
1379
for file_id in common:
1380
new_ie = new_getter[file_id]
1381
old_ie = old_getter[file_id]
1382
# If xml_serializer returns the cached InventoryEntries (rather
1383
# than always doing .copy()), inlining the 'is' check saves 2.7M
1384
# calls to __eq__. Under lsprof this saves 20s => 6s.
1385
# It is a minor improvement without lsprof.
1386
if old_ie is new_ie or old_ie == new_ie:
1389
delta.append((old.id2path(file_id), self.id2path(file_id),
1393
def remove_recursive_id(self, file_id):
1394
"""Remove file_id, and children, from the inventory.
1396
:param file_id: A file_id to remove.
1398
to_find_delete = [self._byid[file_id]]
1400
while to_find_delete:
1401
ie = to_find_delete.pop()
1402
to_delete.append(ie.file_id)
1403
if ie.kind == 'directory':
1404
to_find_delete.extend(ie.children.values())
1405
for file_id in reversed(to_delete):
1407
del self._byid[file_id]
1408
if ie.parent_id is not None:
1409
del self[ie.parent_id].children[ie.name]
1413
def rename(self, file_id, new_parent_id, new_name):
1414
"""Move a file within the inventory.
1416
This can change either the name, or the parent, or both.
1418
This does not move the working file.
1420
new_name = ensure_normalized_name(new_name)
1421
if not is_valid_name(new_name):
1422
raise BzrError("not an acceptable filename: %r" % new_name)
1424
new_parent = self._byid[new_parent_id]
1425
if new_name in new_parent.children:
1426
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1428
new_parent_idpath = self.get_idpath(new_parent_id)
1429
if file_id in new_parent_idpath:
1430
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1431
% (self.id2path(file_id), self.id2path(new_parent_id)))
1433
file_ie = self._byid[file_id]
1434
old_parent = self._byid[file_ie.parent_id]
1436
# TODO: Don't leave things messed up if this fails
1438
del old_parent.children[file_ie.name]
1439
new_parent.children[new_name] = file_ie
1441
file_ie.name = new_name
1442
file_ie.parent_id = new_parent_id
1444
def is_root(self, file_id):
1445
return self.root is not None and file_id == self.root.file_id
1448
class CHKInventory(CommonInventory):
1449
"""An inventory persisted in a CHK store.
1451
By design, a CHKInventory is immutable so many of the methods
1452
supported by Inventory - add, rename, apply_delta, etc - are *not*
1453
supported. To create a new CHKInventory, use create_by_apply_delta()
1454
or from_inventory(), say.
1456
Internally, a CHKInventory has one or two CHKMaps:
1458
* id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1459
* parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1462
The second map is optional and not present in early CHkRepository's.
1464
No caching is performed: every method call or item access will perform
1465
requests to the storage layer. As such, keep references to objects you
1469
def __init__(self, search_key_name):
1470
CommonInventory.__init__(self)
1471
self._fileid_to_entry_cache = {}
1472
self._path_to_fileid_cache = {}
1473
self._search_key_name = search_key_name
1475
def __eq__(self, other):
1476
"""Compare two sets by comparing their contents."""
1477
if not isinstance(other, CHKInventory):
1478
return NotImplemented
1480
this_key = self.id_to_entry.key()
1481
other_key = other.id_to_entry.key()
1482
this_pid_key = self.parent_id_basename_to_file_id.key()
1483
other_pid_key = other.parent_id_basename_to_file_id.key()
1484
if None in (this_key, this_pid_key, other_key, other_pid_key):
1486
return this_key == other_key and this_pid_key == other_pid_key
1488
def _entry_to_bytes(self, entry):
1489
"""Serialise entry as a single bytestring.
1491
:param Entry: An inventory entry.
1492
:return: A bytestring for the entry.
1495
ENTRY ::= FILE | DIR | SYMLINK | TREE
1496
FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
1497
DIR ::= "dir: " COMMON
1498
SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
1499
TREE ::= "tree: " COMMON REFERENCE_REVISION
1500
COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
1503
if entry.parent_id is not None:
1504
parent_str = entry.parent_id
1507
name_str = entry.name.encode("utf8")
1508
if entry.kind == 'file':
1509
if entry.executable:
1513
return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
1514
entry.file_id, parent_str, name_str, entry.revision,
1515
entry.text_sha1, entry.text_size, exec_str)
1516
elif entry.kind == 'directory':
1517
return "dir: %s\n%s\n%s\n%s" % (
1518
entry.file_id, parent_str, name_str, entry.revision)
1519
elif entry.kind == 'symlink':
1520
return "symlink: %s\n%s\n%s\n%s\n%s" % (
1521
entry.file_id, parent_str, name_str, entry.revision,
1522
entry.symlink_target.encode("utf8"))
1523
elif entry.kind == 'tree-reference':
1524
return "tree: %s\n%s\n%s\n%s\n%s" % (
1525
entry.file_id, parent_str, name_str, entry.revision,
1526
entry.reference_revision)
1528
raise ValueError("unknown kind %r" % entry.kind)
1531
def _bytes_to_utf8name_key(bytes):
1532
"""Get the file_id, revision_id key out of bytes."""
1533
# We don't normally care about name, except for times when we want
1534
# to filter out empty names because of non rich-root...
1535
sections = bytes.split('\n')
1536
kind, file_id = sections[0].split(': ')
1537
return (sections[2], file_id, sections[3])
1539
def _bytes_to_entry(self, bytes):
1540
"""Deserialise a serialised entry."""
1541
sections = bytes.split('\n')
1542
if sections[0].startswith("file: "):
1543
result = InventoryFile(sections[0][6:],
1544
sections[2].decode('utf8'),
1546
result.text_sha1 = sections[4]
1547
result.text_size = int(sections[5])
1548
result.executable = sections[6] == "Y"
1549
elif sections[0].startswith("dir: "):
1550
result = CHKInventoryDirectory(sections[0][5:],
1551
sections[2].decode('utf8'),
1553
elif sections[0].startswith("symlink: "):
1554
result = InventoryLink(sections[0][9:],
1555
sections[2].decode('utf8'),
1557
result.symlink_target = sections[4].decode('utf8')
1558
elif sections[0].startswith("tree: "):
1559
result = TreeReference(sections[0][6:],
1560
sections[2].decode('utf8'),
1562
result.reference_revision = sections[4]
1564
raise ValueError("Not a serialised entry %r" % bytes)
1565
result.revision = sections[3]
1566
if result.parent_id == '':
1567
result.parent_id = None
1568
self._fileid_to_entry_cache[result.file_id] = result
1571
def _get_mutable_inventory(self):
1572
"""See CommonInventory._get_mutable_inventory."""
1573
entries = self.iter_entries()
1574
inv = Inventory(None, self.revision_id)
1575
for path, inv_entry in entries:
1576
inv.add(inv_entry.copy())
1579
def create_by_apply_delta(self, inventory_delta, new_revision_id,
1580
propagate_caches=False):
1581
"""Create a new CHKInventory by applying inventory_delta to this one.
1583
See the inventory developers documentation for the theory behind
1586
:param inventory_delta: The inventory delta to apply. See
1587
Inventory.apply_delta for details.
1588
:param new_revision_id: The revision id of the resulting CHKInventory.
1589
:param propagate_caches: If True, the caches for this inventory are
1590
copied to and updated for the result.
1591
:return: The new CHKInventory.
1593
result = CHKInventory(self._search_key_name)
1594
if propagate_caches:
1595
# Just propagate the path-to-fileid cache for now
1596
result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
1597
search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1598
self.id_to_entry._ensure_root()
1599
maximum_size = self.id_to_entry._root_node.maximum_size
1600
result.revision_id = new_revision_id
1601
result.id_to_entry = chk_map.CHKMap(
1602
self.id_to_entry._store,
1603
self.id_to_entry.key(),
1604
search_key_func=search_key_func)
1605
result.id_to_entry._ensure_root()
1606
result.id_to_entry._root_node.set_maximum_size(maximum_size)
1607
parent_id_basename_delta = []
1608
if self.parent_id_basename_to_file_id is not None:
1609
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1610
self.parent_id_basename_to_file_id._store,
1611
self.parent_id_basename_to_file_id.key(),
1612
search_key_func=search_key_func)
1613
result.parent_id_basename_to_file_id._ensure_root()
1614
self.parent_id_basename_to_file_id._ensure_root()
1615
result_p_id_root = result.parent_id_basename_to_file_id._root_node
1616
p_id_root = self.parent_id_basename_to_file_id._root_node
1617
result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1618
result_p_id_root._key_width = p_id_root._key_width
1620
result.parent_id_basename_to_file_id = None
1621
result.root_id = self.root_id
1622
id_to_entry_delta = []
1623
# inventory_delta is only traversed once, so we just update the
1625
# Check for repeated file ids
1626
inventory_delta = _check_delta_unique_ids(inventory_delta)
1627
# Repeated old paths
1628
inventory_delta = _check_delta_unique_old_paths(inventory_delta)
1629
# Check for repeated new paths
1630
inventory_delta = _check_delta_unique_new_paths(inventory_delta)
1631
# Check for entries that don't match the fileid
1632
inventory_delta = _check_delta_ids_match_entry(inventory_delta)
1633
# All changed entries need to have their parents be directories.
1635
for old_path, new_path, file_id, entry in inventory_delta:
1638
result.root_id = file_id
1639
if new_path is None:
1644
if propagate_caches:
1646
del result._path_to_fileid_cache[old_path]
1650
new_key = (file_id,)
1651
new_value = result._entry_to_bytes(entry)
1652
# Update caches. It's worth doing this whether
1653
# we're propagating the old caches or not.
1654
result._path_to_fileid_cache[new_path] = file_id
1655
parents.add(entry.parent_id)
1656
if old_path is None:
1659
old_key = (file_id,)
1660
id_to_entry_delta.append((old_key, new_key, new_value))
1661
if result.parent_id_basename_to_file_id is not None:
1662
# parent_id, basename changes
1663
if old_path is None:
1666
old_entry = self[file_id]
1667
old_key = self._parent_id_basename_key(old_entry)
1668
if new_path is None:
1672
new_key = self._parent_id_basename_key(entry)
1674
if old_key != new_key:
1675
# If the two keys are the same, the value will be unchanged
1676
# as its always the file id.
1677
parent_id_basename_delta.append((old_key, new_key, new_value))
1678
result.id_to_entry.apply_delta(id_to_entry_delta)
1679
if parent_id_basename_delta:
1680
result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
1681
parents.discard(None)
1682
for parent in parents:
1684
if result[parent].kind != 'directory':
1685
raise errors.InconsistentDelta(result.id2path(parent), parent,
1686
'Not a directory, but given children')
1687
except errors.NoSuchId:
1688
raise errors.InconsistentDelta("<unknown>", parent,
1689
"Parent is not present in resulting inventory.")
1693
def deserialise(klass, chk_store, bytes, expected_revision_id):
1694
"""Deserialise a CHKInventory.
1696
:param chk_store: A CHK capable VersionedFiles instance.
1697
:param bytes: The serialised bytes.
1698
:param expected_revision_id: The revision ID we think this inventory is
1700
:return: A CHKInventory
1702
lines = bytes.split('\n')
1704
raise AssertionError('bytes to deserialize must end with an eol')
1706
if lines[0] != 'chkinventory:':
1707
raise ValueError("not a serialised CHKInventory: %r" % bytes)
1709
allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
1710
'parent_id_basename_to_file_id',
1712
for line in lines[1:]:
1713
key, value = line.split(': ', 1)
1714
if key not in allowed_keys:
1715
raise errors.BzrError('Unknown key in inventory: %r\n%r'
1718
raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1721
revision_id = info['revision_id']
1722
root_id = info['root_id']
1723
search_key_name = info.get('search_key_name', 'plain')
1724
parent_id_basename_to_file_id = info.get(
1725
'parent_id_basename_to_file_id', None)
1726
id_to_entry = info['id_to_entry']
1728
result = CHKInventory(search_key_name)
1729
result.revision_id = revision_id
1730
result.root_id = root_id
1731
search_key_func = chk_map.search_key_registry.get(
1732
result._search_key_name)
1733
if parent_id_basename_to_file_id is not None:
1734
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1735
chk_store, (parent_id_basename_to_file_id,),
1736
search_key_func=search_key_func)
1738
result.parent_id_basename_to_file_id = None
1740
result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
1741
search_key_func=search_key_func)
1742
if (result.revision_id,) != expected_revision_id:
1743
raise ValueError("Mismatched revision id and expected: %r, %r" %
1744
(result.revision_id, expected_revision_id))
1748
def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
1749
"""Create a CHKInventory from an existing inventory.
1751
The content of inventory is copied into the chk_store, and a
1752
CHKInventory referencing that is returned.
1754
:param chk_store: A CHK capable VersionedFiles instance.
1755
:param inventory: The inventory to copy.
1756
:param maximum_size: The CHKMap node size limit.
1757
:param search_key_name: The identifier for the search key function
1759
result = klass(search_key_name)
1760
result.revision_id = inventory.revision_id
1761
result.root_id = inventory.root.file_id
1763
entry_to_bytes = result._entry_to_bytes
1764
parent_id_basename_key = result._parent_id_basename_key
1765
id_to_entry_dict = {}
1766
parent_id_basename_dict = {}
1767
for path, entry in inventory.iter_entries():
1768
id_to_entry_dict[(entry.file_id,)] = entry_to_bytes(entry)
1769
p_id_key = parent_id_basename_key(entry)
1770
parent_id_basename_dict[p_id_key] = entry.file_id
1772
result._populate_from_dicts(chk_store, id_to_entry_dict,
1773
parent_id_basename_dict, maximum_size=maximum_size)
1776
def _populate_from_dicts(self, chk_store, id_to_entry_dict,
1777
parent_id_basename_dict, maximum_size):
1778
search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1779
root_key = chk_map.CHKMap.from_dict(chk_store, id_to_entry_dict,
1780
maximum_size=maximum_size, key_width=1,
1781
search_key_func=search_key_func)
1782
self.id_to_entry = chk_map.CHKMap(chk_store, root_key,
1784
root_key = chk_map.CHKMap.from_dict(chk_store,
1785
parent_id_basename_dict,
1786
maximum_size=maximum_size, key_width=2,
1787
search_key_func=search_key_func)
1788
self.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1789
root_key, search_key_func)
1791
def _parent_id_basename_key(self, entry):
1792
"""Create a key for a entry in a parent_id_basename_to_file_id index."""
1793
if entry.parent_id is not None:
1794
parent_id = entry.parent_id
1797
return parent_id, entry.name.encode('utf8')
1799
def __getitem__(self, file_id):
1800
"""map a single file_id -> InventoryEntry."""
1802
raise errors.NoSuchId(self, file_id)
1803
result = self._fileid_to_entry_cache.get(file_id, None)
1804
if result is not None:
1807
return self._bytes_to_entry(
1808
self.id_to_entry.iteritems([(file_id,)]).next()[1])
1809
except StopIteration:
1810
# really we're passing an inventory, not a tree...
1811
raise errors.NoSuchId(self, file_id)
1813
def has_id(self, file_id):
1814
# Perhaps have an explicit 'contains' method on CHKMap ?
1815
if self._fileid_to_entry_cache.get(file_id, None) is not None:
1817
return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
1819
def is_root(self, file_id):
1820
return file_id == self.root_id
1822
def _iter_file_id_parents(self, file_id):
1823
"""Yield the parents of file_id up to the root."""
1824
while file_id is not None:
1828
raise errors.NoSuchId(tree=self, file_id=file_id)
1830
file_id = ie.parent_id
1833
"""Iterate over all file-ids."""
1834
for key, _ in self.id_to_entry.iteritems():
1837
def iter_just_entries(self):
1838
"""Iterate over all entries.
1840
Unlike iter_entries(), just the entries are returned (not (path, ie))
1841
and the order of entries is undefined.
1843
XXX: We may not want to merge this into bzr.dev.
1845
for key, entry in self.id_to_entry.iteritems():
1847
ie = self._fileid_to_entry_cache.get(file_id, None)
1849
ie = self._bytes_to_entry(entry)
1850
self._fileid_to_entry_cache[file_id] = ie
1853
def iter_changes(self, basis):
1854
"""Generate a Tree.iter_changes change list between this and basis.
1856
:param basis: Another CHKInventory.
1857
:return: An iterator over the changes between self and basis, as per
1858
tree.iter_changes().
1860
# We want: (file_id, (path_in_source, path_in_target),
1861
# changed_content, versioned, parent, name, kind,
1863
for key, basis_value, self_value in \
1864
self.id_to_entry.iter_changes(basis.id_to_entry):
1866
if basis_value is not None:
1867
basis_entry = basis._bytes_to_entry(basis_value)
1868
path_in_source = basis.id2path(file_id)
1869
basis_parent = basis_entry.parent_id
1870
basis_name = basis_entry.name
1871
basis_executable = basis_entry.executable
1873
path_in_source = None
1876
basis_executable = None
1877
if self_value is not None:
1878
self_entry = self._bytes_to_entry(self_value)
1879
path_in_target = self.id2path(file_id)
1880
self_parent = self_entry.parent_id
1881
self_name = self_entry.name
1882
self_executable = self_entry.executable
1884
path_in_target = None
1887
self_executable = None
1888
if basis_value is None:
1890
kind = (None, self_entry.kind)
1891
versioned = (False, True)
1892
elif self_value is None:
1894
kind = (basis_entry.kind, None)
1895
versioned = (True, False)
1897
kind = (basis_entry.kind, self_entry.kind)
1898
versioned = (True, True)
1899
changed_content = False
1900
if kind[0] != kind[1]:
1901
changed_content = True
1902
elif kind[0] == 'file':
1903
if (self_entry.text_size != basis_entry.text_size or
1904
self_entry.text_sha1 != basis_entry.text_sha1):
1905
changed_content = True
1906
elif kind[0] == 'symlink':
1907
if self_entry.symlink_target != basis_entry.symlink_target:
1908
changed_content = True
1909
elif kind[0] == 'tree-reference':
1910
if (self_entry.reference_revision !=
1911
basis_entry.reference_revision):
1912
changed_content = True
1913
parent = (basis_parent, self_parent)
1914
name = (basis_name, self_name)
1915
executable = (basis_executable, self_executable)
1916
if (not changed_content
1917
and parent[0] == parent[1]
1918
and name[0] == name[1]
1919
and executable[0] == executable[1]):
1920
# Could happen when only the revision changed for a directory
1923
yield (file_id, (path_in_source, path_in_target), changed_content,
1924
versioned, parent, name, kind, executable)
1927
"""Return the number of entries in the inventory."""
1928
return len(self.id_to_entry)
1930
def _make_delta(self, old):
1931
"""Make an inventory delta from two inventories."""
1932
if type(old) != CHKInventory:
1933
return CommonInventory._make_delta(self, old)
1935
for key, old_value, self_value in \
1936
self.id_to_entry.iter_changes(old.id_to_entry):
1938
if old_value is not None:
1939
old_path = old.id2path(file_id)
1942
if self_value is not None:
1943
entry = self._bytes_to_entry(self_value)
1944
self._fileid_to_entry_cache[file_id] = entry
1945
new_path = self.id2path(file_id)
1949
delta.append((old_path, new_path, file_id, entry))
1952
def path2id(self, name):
1953
"""See CommonInventory.path2id()."""
1954
result = self._path_to_fileid_cache.get(name, None)
1956
result = CommonInventory.path2id(self, name)
1957
self._path_to_fileid_cache[name] = result
1961
"""Serialise the inventory to lines."""
1962
lines = ["chkinventory:\n"]
1963
if self._search_key_name != 'plain':
1964
# custom ordering grouping things that don't change together
1965
lines.append('search_key_name: %s\n' % (self._search_key_name,))
1966
lines.append("root_id: %s\n" % self.root_id)
1967
lines.append('parent_id_basename_to_file_id: %s\n' %
1968
self.parent_id_basename_to_file_id.key())
1969
lines.append("revision_id: %s\n" % self.revision_id)
1970
lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1972
lines.append("revision_id: %s\n" % self.revision_id)
1973
lines.append("root_id: %s\n" % self.root_id)
1974
if self.parent_id_basename_to_file_id is not None:
1975
lines.append('parent_id_basename_to_file_id: %s\n' %
1976
self.parent_id_basename_to_file_id.key())
1977
lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1982
"""Get the root entry."""
1983
return self[self.root_id]
1986
class CHKInventoryDirectory(InventoryDirectory):
1987
"""A directory in an inventory."""
1989
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1990
'text_id', 'parent_id', '_children', 'executable',
1991
'revision', 'symlink_target', 'reference_revision',
1994
def __init__(self, file_id, name, parent_id, chk_inventory):
1995
# Don't call InventoryDirectory.__init__ - it isn't right for this
1997
InventoryEntry.__init__(self, file_id, name, parent_id)
1998
self._children = None
1999
self.kind = 'directory'
2000
self._chk_inventory = chk_inventory
2004
"""Access the list of children of this directory.
2006
With a parent_id_basename_to_file_id index, loads all the children,
2007
without loads the entire index. Without is bad. A more sophisticated
2008
proxy object might be nice, to allow partial loading of children as
2009
well when specific names are accessed. (So path traversal can be
2010
written in the obvious way but not examine siblings.).
2012
if self._children is not None:
2013
return self._children
2014
# No longer supported
2015
if self._chk_inventory.parent_id_basename_to_file_id is None:
2016
raise AssertionError("Inventories without"
2017
" parent_id_basename_to_file_id are no longer supported")
2019
# XXX: Todo - use proxy objects for the children rather than loading
2020
# all when the attribute is referenced.
2021
parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
2023
for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
2024
key_filter=[(self.file_id,)]):
2025
child_keys.add((file_id,))
2027
for file_id_key in child_keys:
2028
entry = self._chk_inventory._fileid_to_entry_cache.get(
2029
file_id_key[0], None)
2030
if entry is not None:
2031
result[entry.name] = entry
2032
cached.add(file_id_key)
2033
child_keys.difference_update(cached)
2034
# populate; todo: do by name
2035
id_to_entry = self._chk_inventory.id_to_entry
2036
for file_id_key, bytes in id_to_entry.iteritems(child_keys):
2037
entry = self._chk_inventory._bytes_to_entry(bytes)
2038
result[entry.name] = entry
2039
self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
2040
self._children = result
2044
'directory': InventoryDirectory,
2045
'file': InventoryFile,
2046
'symlink': InventoryLink,
2047
'tree-reference': TreeReference
2050
def make_entry(kind, name, parent_id, file_id=None):
2051
"""Create an inventory entry.
2053
:param kind: the type of inventory entry to create.
2054
:param name: the basename of the entry.
2055
:param parent_id: the parent_id of the entry.
2056
:param file_id: the file_id to use. if None, one will be created.
2059
file_id = generate_ids.gen_file_id(name)
2060
name = ensure_normalized_name(name)
2062
factory = entry_factory[kind]
2064
raise BzrError("unknown kind %r" % kind)
2065
return factory(file_id, name, parent_id)
2068
def ensure_normalized_name(name):
2071
:raises InvalidNormalization: When name is not normalized, and cannot be
2072
accessed on this platform by the normalized path.
2073
:return: The NFC normalised version of name.
2075
#------- This has been copied to bzrlib.dirstate.DirState.add, please
2076
# keep them synchronised.
2077
# we dont import normalized_filename directly because we want to be
2078
# able to change the implementation at runtime for tests.
2079
norm_name, can_access = osutils.normalized_filename(name)
2080
if norm_name != name:
2084
# TODO: jam 20060701 This would probably be more useful
2085
# if the error was raised with the full path
2086
raise errors.InvalidNormalization(name)
2092
def is_valid_name(name):
2094
if _NAME_RE is None:
2095
_NAME_RE = re.compile(r'^[^/\\]+$')
2097
return bool(_NAME_RE.match(name))
2100
def _check_delta_unique_ids(delta):
2101
"""Decorate a delta and check that the file ids in it are unique.
2103
:return: A generator over delta.
2107
length = len(ids) + 1
2109
if len(ids) != length:
2110
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2115
def _check_delta_unique_new_paths(delta):
2116
"""Decorate a delta and check that the new paths in it are unique.
2118
:return: A generator over delta.
2122
length = len(paths) + 1
2124
if path is not None:
2126
if len(paths) != length:
2127
raise errors.InconsistentDelta(path, item[2], "repeated path")
2131
def _check_delta_unique_old_paths(delta):
2132
"""Decorate a delta and check that the old paths in it are unique.
2134
:return: A generator over delta.
2138
length = len(paths) + 1
2140
if path is not None:
2142
if len(paths) != length:
2143
raise errors.InconsistentDelta(path, item[2], "repeated path")
2147
def _check_delta_ids_match_entry(delta):
2148
"""Decorate a delta and check that the ids in it match the entry.file_id.
2150
:return: A generator over delta.
2154
if entry is not None:
2155
if entry.file_id != item[2]:
2156
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2157
"mismatched id with %r" % entry)
added
removed
bzrlib/inventory.py
