85
68
sha-1 of the text of the file
88
71
size in bytes of the text of the file
90
73
(reading a version 4 tree created a text_id field.)
92
75
>>> i = Inventory()
95
>>> i.add(InventoryDirectory(b'123', 'src', ROOT_ID))
96
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
97
>>> i.add(InventoryFile(b'2323', 'hello.c', parent_id='123'))
98
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
99
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
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')}
100
83
>>> for ix, j in enumerate(i.iter_entries()):
101
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):
103
(True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
104
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
105
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
91
BzrError: inventory already contains entry with id {2323}
106
92
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
107
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
93
InventoryFile('2324', 'bye.c', parent_id='123')
108
94
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
109
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
95
InventoryDirectory('2325', 'wibble', parent_id='123')
110
96
>>> i.path2id('src/wibble')
112
100
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
113
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
114
>>> i.get_entry('2326')
115
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
101
InventoryFile('2326', 'wibble.c', parent_id='2325')
103
InventoryFile('2326', 'wibble.c', parent_id='2325')
116
104
>>> for path, entry in i.iter_entries():
106
... assert i.path2id(path)
124
112
src/wibble/wibble.c
125
>>> i.id2path(b'2326')
113
>>> i.id2path('2326')
126
114
'src/wibble/wibble.c'
129
# Constants returned by describe_change()
131
# TODO: These should probably move to some kind of FileChangeDescription
132
# class; that's like what's inside a TreeDelta but we want to be able to
133
# generate them just for one file at a time.
135
MODIFIED_AND_RENAMED = 'modified and renamed'
137
__slots__ = ['file_id', 'revision', 'parent_id', 'name']
139
# Attributes that all InventoryEntry instances are expected to have, but
140
# that don't vary for all kinds of entry. (e.g. symlink_target is only
141
# relevant to InventoryLink, so there's no reason to make every
142
# InventoryFile instance allocate space to hold a value for it.)
143
# Attributes that only vary for files: executable, text_sha1, text_size,
149
# Attributes that only vary for symlinks: symlink_target
150
symlink_target = None
151
# Attributes that only vary for tree-references: reference_revision
152
reference_revision = None
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_or_empty(self.file_id,
124
versionedfile.add_lines(self.revision, parents, new_lines)
125
versionedfile.clear_cache()
154
127
def detect_changes(self, old_entry):
155
128
"""Return a (text_modified, meta_modified) from this to old_entry.
157
_read_tree_state must have been called on self and old_entry prior to
130
_read_tree_state must have been called on self and old_entry prior to
158
131
calling detect_changes.
160
133
return False, False
135
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
136
output_to, reverse=False):
137
"""Perform a diff from this to to_entry.
139
text_diff will be used for textual difference calculation.
140
This is a template method, override _diff in child classes.
142
self._read_tree_state(tree.id2path(self.file_id), tree)
144
# cannot diff from one kind to another - you must do a removal
145
# and an addif they do not match.
146
assert self.kind == to_entry.kind
147
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
149
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
162
152
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
163
output_to, reverse=False):
153
output_to, reverse=False):
164
154
"""Perform a diff between two entries of the same kind."""
166
def parent_candidates(self, previous_inventories):
167
"""Find possible per-file graph parents.
169
This is currently defined by:
170
- Select the last changed revision in the parent inventory.
171
- Do deal with a short lived bug in bzr 0.8's development two entries
172
that have the same last changed but different 'x' bit settings are
156
def find_previous_heads(self, previous_inventories,
157
versioned_file_store,
160
"""Return the revisions and entries that directly preceed this.
162
Returned as a map from revision to inventory entry.
164
This is a map containing the file revisions in all parents
165
for which the file exists, and its revision is not a parent of
166
any other. If the file is new, the set will be empty.
168
:param versioned_file_store: A store where ancestry data on this
169
file id can be queried.
170
:param transaction: The transaction that queries to the versioned
171
file store should be completed under.
172
:param entry_vf: The entry versioned file, if its already available.
174
def get_ancestors(weave, entry):
175
return set(weave.get_ancestry(entry.revision))
175
176
# revision:ie mapping for each ie found in previous_inventories.
178
# revision:ie mapping with one revision for each head.
180
# revision: ancestor list for each head
177
182
# identify candidate head revision ids.
178
183
for inv in previous_inventories:
180
ie = inv.get_entry(self.file_id)
181
except errors.NoSuchId:
184
if self.file_id in inv:
185
ie = inv[self.file_id]
186
assert ie.file_id == self.file_id
184
187
if ie.revision in candidates:
185
188
# same revision value in two different inventories:
186
189
# correct possible inconsistencies:
187
# * there was a bug in revision updates with 'x' bit
190
# * there was a bug in revision updates with 'x' bit
190
193
if candidates[ie.revision].executable != ie.executable:
211
def __init__(self, file_id, name, parent_id):
262
def __init__(self, file_id, name, parent_id, text_id=None):
212
263
"""Create an InventoryEntry
214
265
The filename must be a single component, relative to the
215
266
parent directory; it cannot be a whole path or relative name.
217
>>> e = InventoryFile(b'123', 'hello.c', ROOT_ID)
268
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
222
>>> e = InventoryFile(b'123', 'src/hello.c', ROOT_ID)
273
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
223
274
Traceback (most recent call last):
224
275
InvalidEntryName: Invalid entry name: src/hello.c
227
raise errors.InvalidEntryName(name=name)
228
if not isinstance(file_id, bytes):
229
raise TypeError(file_id)
230
self.file_id = file_id
277
assert isinstance(name, basestring), name
278
if '/' in name or '\\' in name:
279
raise InvalidEntryName(name=name)
280
self.executable = False
231
281
self.revision = None
282
self.text_sha1 = None
283
self.text_size = None
284
self.file_id = file_id
286
self.text_id = text_id
233
287
self.parent_id = parent_id
288
self.symlink_target = None
235
290
def kind_character(self):
236
291
"""Return a short kind indicator useful for appending to names."""
237
raise errors.BzrError('unknown kind %r' % self.kind)
239
known_kinds = ('file', 'directory', 'symlink')
292
raise BzrError('unknown kind %r' % self.kind)
294
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
296
def _put_in_tar(self, item, tree):
297
"""populate item for stashing in a tar, and return the content stream.
299
If no content is available, return None.
301
raise BzrError("don't know how to export {%s} of kind %r" %
302
(self.file_id, self.kind))
304
def put_on_disk(self, dest, dp, tree):
305
"""Create a representation of self on disk in the prefix dest.
307
This is a template method - implement _put_on_disk in subclasses.
309
fullpath = pathjoin(dest, dp)
310
self._put_on_disk(fullpath, tree)
311
mutter(" export {%s} kind %s to %s", self.file_id,
314
def _put_on_disk(self, fullpath, tree):
315
"""Put this entry onto disk at fullpath, from tree tree."""
316
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
318
def sorted_children(self):
319
l = self.children.items()
242
324
def versionable_kind(kind):
243
return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
325
return kind in ('file', 'directory', 'symlink')
245
def check(self, checker, rev_id, inv):
327
def check(self, checker, rev_id, inv, tree):
246
328
"""Check this inventory entry is intact.
248
330
This is a template method, override _check for kind specific
251
:param checker: Check object providing context for the checks;
333
:param checker: Check object providing context for the checks;
252
334
can be used to find out what parts of the repository have already
254
336
:param rev_id: Revision id from which this InventoryEntry was loaded.
255
337
Not necessarily the last-changed revision for this file.
256
338
:param inv: Inventory from which the entry was loaded.
339
:param tree: RevisionTree for this entry.
258
if self.parent_id is not None:
341
if self.parent_id != None:
259
342
if not inv.has_id(self.parent_id):
260
raise errors.BzrCheckError(
261
'missing parent {%s} in inventory for revision {%s}' % (
262
self.parent_id, rev_id))
263
checker._add_entry_to_text_key_references(inv, self)
264
self._check(checker, rev_id)
343
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
344
% (self.parent_id, rev_id))
345
self._check(checker, rev_id, tree)
266
def _check(self, checker, rev_id):
347
def _check(self, checker, rev_id, tree):
267
348
"""Check this inventory entry for kind specific errors."""
268
checker._report_items.append(
269
'unknown entry kind %r in revision {%s}' % (self.kind, rev_id))
349
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
272
353
"""Clone this inventory entry."""
273
354
raise NotImplementedError
276
def describe_change(old_entry, new_entry):
277
"""Describe the change between old_entry and this.
279
This smells of being an InterInventoryEntry situation, but as its
280
the first one, we're making it a static method for now.
282
An entry with a different parent, or different name is considered
283
to be renamed. Reparenting is an internal detail.
284
Note that renaming the parent does not trigger a rename for the
356
def _describe_snapshot_change(self, previous_entries):
357
"""Describe how this entry will have changed in a new commit.
359
:param previous_entries: Dictionary from revision_id to inventory entry.
361
:returns: One-word description: "merged", "added", "renamed", "modified".
287
# TODO: Perhaps return an object rather than just a string
288
if old_entry is new_entry:
289
# also the case of both being None
291
elif old_entry is None:
363
# XXX: This assumes that the file *has* changed -- it should probably
364
# be fused with whatever does that detection. Why not just a single
365
# thing to compare the entries?
367
# TODO: Return some kind of object describing all the possible
368
# dimensions that can change, not just a string. That can then give
369
# both old and new names for renames, etc.
371
if len(previous_entries) > 1:
373
elif len(previous_entries) == 0:
293
elif new_entry is None:
295
if old_entry.kind != new_entry.kind:
297
text_modified, meta_modified = new_entry.detect_changes(old_entry)
298
if text_modified or meta_modified:
302
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
303
if old_entry.parent_id != new_entry.parent_id:
305
elif old_entry.name != new_entry.name:
309
if renamed and not modified:
310
return InventoryEntry.RENAMED
311
if modified and not renamed:
313
if modified and renamed:
314
return InventoryEntry.MODIFIED_AND_RENAMED
375
the_parent, = previous_entries.values()
376
if self.parent_id != the_parent.parent_id:
377
# actually, moved to another directory
379
elif self.name != the_parent.name:
317
383
def __repr__(self):
318
return ("%s(%r, %r, parent_id=%r, revision=%r)"
384
return ("%s(%r, %r, parent_id=%r)"
319
385
% (self.__class__.__name__,
325
def is_unmodified(self, other):
326
other_revision = getattr(other, 'revision', None)
327
if other_revision is None:
329
return self.revision == other.revision
390
def snapshot(self, revision, path, previous_entries,
391
work_tree, weave_store, transaction):
392
"""Make a snapshot of this entry which may or may not have changed.
394
This means that all its fields are populated, that it has its
395
text stored in the text store or weave.
397
mutter('new parents of %s are %r', path, previous_entries)
398
self._read_tree_state(path, work_tree)
399
if len(previous_entries) == 1:
400
# cannot be unchanged unless there is only one parent file rev.
401
parent_ie = previous_entries.values()[0]
402
if self._unchanged(parent_ie):
403
mutter("found unchanged entry")
404
self.revision = parent_ie.revision
406
return self._snapshot_into_revision(revision, previous_entries,
407
work_tree, weave_store, transaction)
409
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
410
weave_store, transaction):
411
"""Record this revision unconditionally into a store.
413
The entry's last-changed revision property (`revision`) is updated to
414
that of the new revision.
416
:param revision: id of the new revision that is being recorded.
418
:returns: String description of the commit (e.g. "merged", "modified"), etc.
420
mutter('new revision {%s} for {%s}', revision, self.file_id)
421
self.revision = revision
422
change = self._describe_snapshot_change(previous_entries)
423
self._snapshot_text(previous_entries, work_tree, weave_store,
427
def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
428
"""Record the 'text' of this entry, whatever form that takes.
430
This default implementation simply adds an empty text.
432
mutter('storing file {%s} in revision {%s}',
433
self.file_id, self.revision)
434
self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
331
436
def __eq__(self, other):
333
# For the case when objects are cached
335
437
if not isinstance(other, InventoryEntry):
336
438
return NotImplemented
338
return ((self.file_id == other.file_id) and
339
(self.name == other.name) and
340
(other.symlink_target == self.symlink_target) and
341
(self.text_sha1 == other.text_sha1) and
342
(self.text_size == other.text_size) and
343
(self.text_id == other.text_id) and
344
(self.parent_id == other.parent_id) and
345
(self.kind == other.kind) and
346
(self.revision == other.revision) and
347
(self.executable == other.executable) and
348
(self.reference_revision == other.reference_revision)
440
return ((self.file_id == other.file_id)
441
and (self.name == other.name)
442
and (other.symlink_target == self.symlink_target)
443
and (self.text_sha1 == other.text_sha1)
444
and (self.text_size == other.text_size)
445
and (self.text_id == other.text_id)
446
and (self.parent_id == other.parent_id)
447
and (self.kind == other.kind)
448
and (self.revision == other.revision)
449
and (self.executable == other.executable)
351
452
def __ne__(self, other):
606
775
return compatible
609
class TreeReference(InventoryEntry):
611
__slots__ = ['reference_revision']
613
kind = 'tree-reference'
615
def __init__(self, file_id, name, parent_id, revision=None,
616
reference_revision=None):
617
InventoryEntry.__init__(self, file_id, name, parent_id)
618
self.revision = revision
619
self.reference_revision = reference_revision
622
return TreeReference(self.file_id, self.name, self.parent_id,
623
self.revision, self.reference_revision)
625
def _read_tree_state(self, path, work_tree):
626
"""Populate fields in the inventory entry from the given tree.
628
self.reference_revision = work_tree.get_reference_revision(
631
def _forget_tree_state(self):
632
self.reference_revision = None
634
def _unchanged(self, previous_ie):
635
"""See InventoryEntry._unchanged."""
636
compatible = super(TreeReference, self)._unchanged(previous_ie)
637
if self.reference_revision != previous_ie.reference_revision:
641
def kind_character(self):
642
"""See InventoryEntry.kind_character."""
646
class CommonInventory(object):
647
"""Basic inventory logic, defined in terms of primitives like has_id.
649
An inventory is the metadata about the contents of a tree.
651
This is broadly a map from file_id to entries such as directories, files,
652
symlinks and tree references. Each entry maintains its own metadata like
653
SHA1 and length for files, or children for a directory.
778
class Inventory(object):
779
"""Inventory of versioned files in a tree.
781
This describes which file_id is present at each point in the tree,
782
and possibly the SHA-1 or other information about the file.
655
783
Entries can be looked up either by path or by file_id.
785
The inventory represents a typical unix file tree, with
786
directories containing files and subdirectories. We never store
787
the full path to a file, because renaming a directory implicitly
788
moves all of its contents. This class internally maintains a
789
lookup tree that allows the children under a directory to be
657
792
InventoryEntry objects must not be modified after they are
658
793
inserted, other than through the Inventory API.
661
def has_filename(self, filename):
662
return bool(self.path2id(filename))
664
def id2path(self, file_id):
665
"""Return as a string the path to file_id.
668
>>> e = i.add(InventoryDirectory(b'src-id', 'src', ROOT_ID))
669
>>> e = i.add(InventoryFile(b'foo-id', 'foo.c', parent_id='src-id'))
670
>>> print i.id2path(b'foo-id')
673
:raises NoSuchId: If file_id is not present in the inventory.
675
# get all names, skipping root
676
return '/'.join(reversed(
677
[parent.name for parent in
678
self._iter_file_id_parents(file_id)][:-1]))
680
def iter_entries(self, from_dir=None, recursive=True):
681
"""Return (path, entry) pairs, in order by name.
683
:param from_dir: if None, start from the root,
684
otherwise start from this directory (either file-id or entry)
685
:param recursive: recurse into directories or not
688
if self.root is None:
692
elif isinstance(from_dir, bytes):
693
from_dir = self.get_entry(from_dir)
695
# unrolling the recursive called changed the time from
696
# 440ms/663ms (inline/total) to 116ms/116ms
697
children = sorted(viewitems(from_dir.children))
699
for name, ie in children:
702
children = deque(children)
703
stack = [(u'', children)]
705
from_dir_relpath, children = stack[-1]
708
name, ie = children.popleft()
710
# we know that from_dir_relpath never ends in a slash
711
# and 'f' doesn't begin with one, we can do a string op, rather
712
# than the checks of pathjoin(), though this means that all paths
714
path = from_dir_relpath + '/' + name
718
if ie.kind != 'directory':
721
# But do this child first
722
new_children = sorted(viewitems(ie.children))
723
new_children = deque(new_children)
724
stack.append((path, new_children))
725
# Break out of inner loop, so that we start outer loop with child
728
# if we finished all children, pop it off the stack
731
def _preload_cache(self):
732
"""Populate any caches, we are about to access all items.
734
The default implementation does nothing, because CommonInventory doesn't
739
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
740
"""Iterate over the entries in a directory first order.
742
This returns all entries for a directory before returning
743
the entries for children of a directory. This is not
744
lexicographically sorted order, and is a hybrid between
745
depth-first and breadth-first.
747
:return: This yields (path, entry) pairs
749
if specific_file_ids and not isinstance(specific_file_ids, set):
750
specific_file_ids = set(specific_file_ids)
751
# TODO? Perhaps this should return the from_dir so that the root is
752
# yielded? or maybe an option?
753
if from_dir is None and specific_file_ids is None:
754
# They are iterating from the root, and have not specified any
755
# specific entries to look at. All current callers fully consume the
756
# iterator, so we can safely assume we are accessing all entries
757
self._preload_cache()
759
if self.root is None:
761
# Optimize a common case
762
if (specific_file_ids is not None
763
and len(specific_file_ids) == 1):
764
file_id = list(specific_file_ids)[0]
765
if file_id is not None:
767
path = self.id2path(file_id)
768
except errors.NoSuchId:
771
yield path, self.get_entry(file_id)
774
if (specific_file_ids is None
775
or self.root.file_id in specific_file_ids):
777
elif isinstance(from_dir, bytes):
778
from_dir = self.get_entry(from_dir)
780
raise TypeError(from_dir)
782
if specific_file_ids is not None:
783
# TODO: jam 20070302 This could really be done as a loop rather
784
# than a bunch of recursive calls.
788
def add_ancestors(file_id):
789
if not byid.has_id(file_id):
791
parent_id = byid.get_entry(file_id).parent_id
792
if parent_id is None:
794
if parent_id not in parents:
795
parents.add(parent_id)
796
add_ancestors(parent_id)
797
for file_id in specific_file_ids:
798
add_ancestors(file_id)
802
stack = [(u'', from_dir)]
804
cur_relpath, cur_dir = stack.pop()
807
for child_name, child_ie in sorted(viewitems(cur_dir.children)):
809
child_relpath = cur_relpath + child_name
811
if (specific_file_ids is None
812
or child_ie.file_id in specific_file_ids):
813
yield child_relpath, child_ie
815
if child_ie.kind == 'directory':
816
if parents is None or child_ie.file_id in parents:
817
child_dirs.append((child_relpath + '/', child_ie))
818
stack.extend(reversed(child_dirs))
820
def _make_delta(self, old):
821
"""Make an inventory delta from two inventories."""
822
old_ids = set(old.iter_all_ids())
823
new_ids = set(self.iter_all_ids())
824
adds = new_ids - old_ids
825
deletes = old_ids - new_ids
826
common = old_ids.intersection(new_ids)
828
for file_id in deletes:
829
delta.append((old.id2path(file_id), None, file_id, None))
831
delta.append((None, self.id2path(file_id),
832
file_id, self.get_entry(file_id)))
833
for file_id in common:
834
if old.get_entry(file_id) != self.get_entry(file_id):
835
delta.append((old.id2path(file_id), self.id2path(file_id),
836
file_id, self.get_entry(file_id)))
839
def make_entry(self, kind, name, parent_id, file_id=None):
840
"""Simple thunk to breezy.bzr.inventory.make_entry."""
841
return make_entry(kind, name, parent_id, file_id)
844
"""Return list of (path, ie) for all entries except the root.
846
This may be faster than iter_entries.
850
def descend(dir_ie, dir_path):
851
kids = sorted(viewitems(dir_ie.children))
852
for name, ie in kids:
853
child_path = osutils.pathjoin(dir_path, name)
854
accum.append((child_path, ie))
855
if ie.kind == 'directory':
856
descend(ie, child_path)
858
if self.root is not None:
859
descend(self.root, u'')
862
def get_entry_by_path_partial(self, relpath):
863
"""Like get_entry_by_path, but return TreeReference objects.
865
:param relpath: Path to resolve, either as string with / as separators,
866
or as list of elements.
867
:return: tuple with ie, resolved elements and elements left to resolve
869
if isinstance(relpath, (str, text_type)):
870
names = osutils.splitpath(relpath)
876
except errors.NoSuchId:
877
# root doesn't exist yet so nothing else can
878
return None, None, None
880
return None, None, None
881
for i, f in enumerate(names):
883
children = getattr(parent, 'children', None)
885
return None, None, None
887
if cie.kind == 'tree-reference':
888
return cie, names[:i + 1], names[i + 1:]
892
return None, None, None
893
return parent, names, []
895
def get_entry_by_path(self, relpath):
896
"""Return an inventory entry by path.
898
:param relpath: may be either a list of path components, or a single
899
string, in which case it is automatically split.
901
This returns the entry of the last component in the path,
902
which may be either a file or a directory.
904
Returns None IFF the path is not found.
906
if isinstance(relpath, (str, text_type)):
907
names = osutils.splitpath(relpath)
913
except errors.NoSuchId:
914
# root doesn't exist yet so nothing else can
920
children = getattr(parent, 'children', None)
930
def path2id(self, relpath):
931
"""Walk down through directories to return entry of last component.
933
:param relpath: may be either a list of path components, or a single
934
string, in which case it is automatically split.
936
This returns the entry of the last component in the path,
937
which may be either a file or a directory.
939
Returns None IFF the path is not found.
941
ie = self.get_entry_by_path(relpath)
946
def filter(self, specific_fileids):
947
"""Get an inventory view filtered against a set of file-ids.
949
Children of directories and parents are included.
951
The result may or may not reference the underlying inventory
952
so it should be treated as immutable.
954
interesting_parents = set()
955
for fileid in specific_fileids:
957
interesting_parents.update(self.get_idpath(fileid))
958
except errors.NoSuchId:
959
# This fileid is not in the inventory - that's ok
961
entries = self.iter_entries()
962
if self.root is None:
963
return Inventory(root_id=None)
964
other = Inventory(next(entries)[1].file_id)
965
other.root.revision = self.root.revision
966
other.revision_id = self.revision_id
967
directories_to_expand = set()
968
for path, entry in entries:
969
file_id = entry.file_id
970
if (file_id in specific_fileids or
971
entry.parent_id in directories_to_expand):
972
if entry.kind == 'directory':
973
directories_to_expand.add(file_id)
974
elif file_id not in interesting_parents:
976
other.add(entry.copy())
979
def get_idpath(self, file_id):
980
"""Return a list of file_ids for the path to an entry.
982
The list contains one element for each directory followed by
983
the id of the file itself. So the length of the returned list
984
is equal to the depth of the file in the tree, counting the
985
root directory as depth 1.
988
for parent in self._iter_file_id_parents(file_id):
989
p.insert(0, parent.file_id)
993
class Inventory(CommonInventory):
994
"""Mutable dict based in-memory inventory.
996
We never store the full path to a file, because renaming a directory
997
implicitly moves all of its contents. This class internally maintains a
998
lookup tree that allows the children under a directory to be
1001
795
>>> inv = Inventory()
1002
>>> inv.add(InventoryFile(b'123-123', 'hello.c', ROOT_ID))
1003
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1004
>>> inv.get_entry(b'123-123').name
796
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
797
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
798
>>> inv['123-123'].name
1007
Id's may be looked up from paths:
1009
>>> inv.path2id('hello.c')
1011
>>> inv.has_id(b'123-123')
1014
There are iterators over the contents:
1016
>>> [entry[0] for entry in inv.iter_entries()]
801
May be treated as an iterator or set to look up file ids:
803
>>> bool(inv.path2id('hello.c'))
808
May also look up by name:
810
>>> [x[0] for x in inv.iter_entries()]
812
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
813
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
814
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
1020
816
def __init__(self, root_id=ROOT_ID, revision_id=None):
1021
817
"""Create or read an inventory.
1027
823
The inventory is created with a default root directory, with
1030
if root_id is not None:
1031
self._set_root(InventoryDirectory(root_id, u'', None))
826
# We are letting Branch.create() create a unique inventory
827
# root id. Rather than generating a random one here.
829
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
830
self.root = RootEntry(root_id)
1035
831
self.revision_id = revision_id
1038
# More than one page of ouput is not useful anymore to debug
1041
contents = repr(self._byid)
1042
if len(contents) > max_len:
1043
contents = contents[:(max_len - len(closing))] + closing
1044
return "<Inventory object at %x, contents=%r>" % (id(self), contents)
1046
def apply_delta(self, delta):
1047
"""Apply a delta to this inventory.
1049
See the inventory developers documentation for the theory behind
1052
If delta application fails the inventory is left in an indeterminate
1053
state and must not be used.
1055
:param delta: A list of changes to apply. After all the changes are
1056
applied the final inventory must be internally consistent, but it
1057
is ok to supply changes which, if only half-applied would have an
1058
invalid result - such as supplying two changes which rename two
1059
files, 'A' and 'B' with each other : [('A', 'B', b'A-id', a_entry),
1060
('B', 'A', b'B-id', b_entry)].
1062
Each change is a tuple, of the form (old_path, new_path, file_id,
1065
When new_path is None, the change indicates the removal of an entry
1066
from the inventory and new_entry will be ignored (using None is
1067
appropriate). If new_path is not None, then new_entry must be an
1068
InventoryEntry instance, which will be incorporated into the
1069
inventory (and replace any existing entry with the same file id).
1071
When old_path is None, the change indicates the addition of
1072
a new entry to the inventory.
1074
When neither new_path nor old_path are None, the change is a
1075
modification to an entry, such as a rename, reparent, kind change
1078
The children attribute of new_entry is ignored. This is because
1079
this method preserves children automatically across alterations to
1080
the parent of the children, and cases where the parent id of a
1081
child is changing require the child to be passed in as a separate
1082
change regardless. E.g. in the recursive deletion of a directory -
1083
the directory's children must be included in the delta, or the
1084
final inventory will be invalid.
1086
Note that a file_id must only appear once within a given delta.
1087
An AssertionError is raised otherwise.
1089
# Check that the delta is legal. It would be nice if this could be
1090
# done within the loops below but it's safer to validate the delta
1091
# before starting to mutate the inventory, as there isn't a rollback
1093
list(_check_delta_unique_ids(_check_delta_unique_new_paths(
1094
_check_delta_unique_old_paths(_check_delta_ids_match_entry(
1095
_check_delta_ids_are_valid(
1096
_check_delta_new_path_entry_both_or_None(
1100
# Remove all affected items which were in the original inventory,
1101
# starting with the longest paths, thus ensuring parents are examined
1102
# after their children, which means that everything we examine has no
1103
# modified children remaining by the time we examine it.
1104
for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1105
if op is not None), reverse=True):
1106
# Preserve unaltered children of file_id for later reinsertion.
1107
file_id_children = getattr(self.get_entry(file_id), 'children', {})
1108
if len(file_id_children):
1109
children[file_id] = file_id_children
1110
if self.id2path(file_id) != old_path:
1111
raise errors.InconsistentDelta(old_path, file_id,
1112
"Entry was at wrong other path %r." % self.id2path(file_id))
1113
# Remove file_id and the unaltered children. If file_id is not
1114
# being deleted it will be reinserted back later.
1115
self.remove_recursive_id(file_id)
1116
# Insert all affected which should be in the new inventory, reattaching
1117
# their children if they had any. This is done from shortest path to
1118
# longest, ensuring that items which were modified and whose parents in
1119
# the resulting inventory were also modified, are inserted after their
1121
for new_path, f, new_entry in sorted((np, f, e) for op, np, f, e in
1122
delta if np is not None):
1123
if new_entry.kind == 'directory':
1124
# Pop the child which to allow detection of children whose
1125
# parents were deleted and which were not reattached to a new
1127
replacement = InventoryDirectory(new_entry.file_id,
1128
new_entry.name, new_entry.parent_id)
1129
replacement.revision = new_entry.revision
1130
replacement.children = children.pop(replacement.file_id, {})
1131
new_entry = replacement
1134
except errors.DuplicateFileId:
1135
raise errors.InconsistentDelta(new_path, new_entry.file_id,
1136
"New id is already present in target.")
1137
except AttributeError:
1138
raise errors.InconsistentDelta(new_path, new_entry.file_id,
1139
"Parent is not a directory.")
1140
if self.id2path(new_entry.file_id) != new_path:
1141
raise errors.InconsistentDelta(new_path, new_entry.file_id,
1142
"New path is not consistent with parent path.")
1144
# Get the parent id that was deleted
1145
parent_id, children = children.popitem()
1146
raise errors.InconsistentDelta("<deleted>", parent_id,
1147
"The file id was deleted but its children were not deleted.")
1149
def create_by_apply_delta(self, inventory_delta, new_revision_id,
1150
propagate_caches=False):
1151
"""See CHKInventory.create_by_apply_delta()"""
1152
new_inv = self.copy()
1153
new_inv.apply_delta(inventory_delta)
1154
new_inv.revision_id = new_revision_id
1157
def _set_root(self, ie):
1159
832
self._byid = {self.root.file_id: self.root}
1162
836
# TODO: jam 20051218 Should copy also copy the revision_id?
1163
entries = self.iter_entries()
1164
if self.root is None:
1165
return Inventory(root_id=None)
1166
other = Inventory(next(entries)[1].file_id)
1167
other.root.revision = self.root.revision
837
other = Inventory(self.root.file_id)
1168
838
# copy recursively so we know directories will be added before
1169
839
# their children. There are more efficient ways than this...
1170
for path, entry in entries:
840
for path, entry in self.iter_entries():
841
if entry == self.root:
1171
843
other.add(entry.copy())
1174
def iter_all_ids(self):
1175
"""Iterate over all file-ids."""
1176
848
return iter(self._byid)
1178
def iter_just_entries(self):
1179
"""Iterate over all entries.
1181
Unlike iter_entries(), just the entries are returned (not (path, ie))
1182
and the order of entries is undefined.
1184
XXX: We may not want to merge this into bzr.dev.
1186
if self.root is None:
1188
return iter(viewvalues(self._byid))
1190
851
def __len__(self):
1191
852
"""Returns number of entries."""
1192
853
return len(self._byid)
1194
def get_entry(self, file_id):
856
def iter_entries(self, from_dir=None):
857
"""Return (path, entry) pairs, in order by name."""
861
elif isinstance(from_dir, basestring):
862
from_dir = self._byid[from_dir]
864
kids = from_dir.children.items()
866
for name, ie in kids:
868
if ie.kind == 'directory':
869
for cn, cie in self.iter_entries(from_dir=ie.file_id):
870
yield pathjoin(name, cn), cie
874
"""Return list of (path, ie) for all entries except the root.
876
This may be faster than iter_entries.
879
def descend(dir_ie, dir_path):
880
kids = dir_ie.children.items()
882
for name, ie in kids:
883
child_path = pathjoin(dir_path, name)
884
accum.append((child_path, ie))
885
if ie.kind == 'directory':
886
descend(ie, child_path)
888
descend(self.root, u'')
892
def directories(self):
893
"""Return (path, entry) pairs for all directories, including the root.
896
def descend(parent_ie, parent_path):
897
accum.append((parent_path, parent_ie))
899
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
902
for name, child_ie in kids:
903
child_path = pathjoin(parent_path, name)
904
descend(child_ie, child_path)
905
descend(self.root, u'')
910
def __contains__(self, file_id):
911
"""True if this entry contains a file with given id.
913
>>> inv = Inventory()
914
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
915
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
921
return file_id in self._byid
924
def __getitem__(self, file_id):
1195
925
"""Return the entry for given file_id.
1197
927
>>> inv = Inventory()
1198
>>> inv.add(InventoryFile(b'123123', 'hello.c', ROOT_ID))
1199
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1200
>>> inv.get_entry(b'123123').name
928
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
929
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
930
>>> inv['123123'].name
1203
if not isinstance(file_id, bytes):
1204
raise TypeError(file_id)
1206
934
return self._byid[file_id]
1207
935
except KeyError:
1208
# really we're passing an inventory, not a tree...
1209
raise errors.NoSuchId(self, file_id)
937
raise BzrError("can't look up file_id None")
939
raise BzrError("file_id {%s} not in inventory" % file_id)
1211
942
def get_file_kind(self, file_id):
1212
943
return self._byid[file_id].kind
1214
945
def get_child(self, parent_id, filename):
1215
return self.get_entry(parent_id).children.get(filename)
1217
def _add_child(self, entry):
1218
"""Add an entry to the inventory, without adding it to its parent"""
946
return self[parent_id].children.get(filename)
949
def add(self, entry):
950
"""Add entry to inventory.
952
To add a file to a branch ready to be committed, use Branch.add,
955
Returns the new entry object.
1219
957
if entry.file_id in self._byid:
1220
raise errors.BzrError(
1221
"inventory already contains entry with id {%s}" %
958
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
960
if entry.parent_id == ROOT_ID or entry.parent_id is None:
961
entry.parent_id = self.root.file_id
964
parent = self._byid[entry.parent_id]
966
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
968
if parent.children.has_key(entry.name):
969
raise BzrError("%s is already versioned" %
970
pathjoin(self.id2path(parent.file_id), entry.name))
1223
972
self._byid[entry.file_id] = entry
1224
children = getattr(entry, 'children', {})
1225
if children is not None:
1226
for child in viewvalues(children):
1227
self._add_child(child)
973
parent.children[entry.name] = entry
1230
def add(self, entry):
1231
"""Add entry to inventory.
1235
if entry.file_id in self._byid:
1236
raise errors.DuplicateFileId(entry.file_id,
1237
self._byid[entry.file_id])
1238
if entry.parent_id is None:
1242
parent = self._byid[entry.parent_id]
1244
raise errors.InconsistentDelta("<unknown>", entry.parent_id,
1245
"Parent not in inventory.")
1246
if entry.name in parent.children:
1247
raise errors.InconsistentDelta(
1248
self.id2path(parent.children[entry.name].file_id),
1250
"Path already versioned")
1251
parent.children[entry.name] = entry
1252
return self._add_child(entry)
1254
def add_path(self, relpath, kind, file_id=None, parent_id=None):
977
def add_path(self, relpath, kind, file_id=None):
1255
978
"""Add entry from a path.
1257
980
The immediate parent must already be versioned.
1259
982
Returns the new entry object."""
983
from bzrlib.workingtree import gen_file_id
985
parts = bzrlib.osutils.splitpath(relpath)
1261
parts = osutils.splitpath(relpath)
988
file_id = gen_file_id(relpath)
1263
990
if len(parts) == 0:
1265
file_id = generate_ids.gen_root_id()
1266
self.root = InventoryDirectory(file_id, '', None)
991
self.root = RootEntry(file_id)
1267
992
self._byid = {self.root.file_id: self.root}
1270
995
parent_path = parts[:-1]
1271
996
parent_id = self.path2id(parent_path)
1272
if parent_id is None:
1273
raise errors.NotVersionedError(path=parent_path)
1274
ie = make_entry(kind, parts[-1], parent_id, file_id)
997
if parent_id == None:
998
raise NotVersionedError(path=parent_path)
999
if kind == 'directory':
1000
ie = InventoryDirectory(file_id, parts[-1], parent_id)
1001
elif kind == 'file':
1002
ie = InventoryFile(file_id, parts[-1], parent_id)
1003
elif kind == 'symlink':
1004
ie = InventoryLink(file_id, parts[-1], parent_id)
1006
raise BzrError("unknown kind %r" % kind)
1275
1007
return self.add(ie)
1277
def delete(self, file_id):
1010
def __delitem__(self, file_id):
1278
1011
"""Remove entry by id.
1280
1013
>>> inv = Inventory()
1281
>>> inv.add(InventoryFile(b'123', 'foo.c', ROOT_ID))
1282
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1283
>>> inv.has_id(b'123')
1014
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1015
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1285
>>> inv.delete(b'123')
1286
>>> inv.has_id(b'123')
1289
ie = self.get_entry(file_id)
1024
assert ie.parent_id is None or \
1025
self[ie.parent_id].children[ie.name] == ie
1290
1027
del self._byid[file_id]
1291
1028
if ie.parent_id is not None:
1292
del self.get_entry(ie.parent_id).children[ie.name]
1029
del self[ie.parent_id].children[ie.name]
1294
1032
def __eq__(self, other):
1295
1033
"""Compare two sets by comparing their contents.
1413
1163
del old_parent.children[file_ie.name]
1414
1164
new_parent.children[new_name] = file_ie
1416
1166
file_ie.name = new_name
1417
1167
file_ie.parent_id = new_parent_id
1419
def is_root(self, file_id):
1420
return self.root is not None and file_id == self.root.file_id
1423
class CHKInventory(CommonInventory):
1424
"""An inventory persisted in a CHK store.
1426
By design, a CHKInventory is immutable so many of the methods
1427
supported by Inventory - add, rename, apply_delta, etc - are *not*
1428
supported. To create a new CHKInventory, use create_by_apply_delta()
1429
or from_inventory(), say.
1431
Internally, a CHKInventory has one or two CHKMaps:
1433
* id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1434
* parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1437
The second map is optional and not present in early CHkRepository's.
1439
No caching is performed: every method call or item access will perform
1440
requests to the storage layer. As such, keep references to objects you
1444
def __init__(self, search_key_name):
1445
CommonInventory.__init__(self)
1446
self._fileid_to_entry_cache = {}
1447
self._fully_cached = False
1448
self._path_to_fileid_cache = {}
1449
self._search_key_name = search_key_name
1452
def __eq__(self, other):
1453
"""Compare two sets by comparing their contents."""
1454
if not isinstance(other, CHKInventory):
1455
return NotImplemented
1457
this_key = self.id_to_entry.key()
1458
other_key = other.id_to_entry.key()
1459
this_pid_key = self.parent_id_basename_to_file_id.key()
1460
other_pid_key = other.parent_id_basename_to_file_id.key()
1461
if None in (this_key, this_pid_key, other_key, other_pid_key):
1463
return this_key == other_key and this_pid_key == other_pid_key
1465
def _entry_to_bytes(self, entry):
1466
"""Serialise entry as a single bytestring.
1468
:param Entry: An inventory entry.
1469
:return: A bytestring for the entry.
1472
ENTRY ::= FILE | DIR | SYMLINK | TREE
1473
FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
1474
DIR ::= "dir: " COMMON
1475
SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
1476
TREE ::= "tree: " COMMON REFERENCE_REVISION
1477
COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
1480
if entry.parent_id is not None:
1481
parent_str = entry.parent_id
1484
name_str = entry.name.encode("utf8")
1485
if entry.kind == 'file':
1486
if entry.executable:
1490
return b"file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
1491
entry.file_id, parent_str, name_str, entry.revision,
1492
entry.text_sha1, entry.text_size, exec_str)
1493
elif entry.kind == 'directory':
1494
return b"dir: %s\n%s\n%s\n%s" % (
1495
entry.file_id, parent_str, name_str, entry.revision)
1496
elif entry.kind == 'symlink':
1497
return b"symlink: %s\n%s\n%s\n%s\n%s" % (
1498
entry.file_id, parent_str, name_str, entry.revision,
1499
entry.symlink_target.encode("utf8"))
1500
elif entry.kind == 'tree-reference':
1501
return b"tree: %s\n%s\n%s\n%s\n%s" % (
1502
entry.file_id, parent_str, name_str, entry.revision,
1503
entry.reference_revision)
1505
raise ValueError("unknown kind %r" % entry.kind)
1507
def _expand_fileids_to_parents_and_children(self, file_ids):
1508
"""Give a more wholistic view starting with the given file_ids.
1510
For any file_id which maps to a directory, we will include all children
1511
of that directory. We will also include all directories which are
1512
parents of the given file_ids, but we will not include their children.
1519
fringle # fringle-id
1523
if given [foo-id] we will include
1524
TREE_ROOT as interesting parents
1526
foo-id, baz-id, frob-id, fringle-id
1530
# TODO: Pre-pass over the list of fileids to see if anything is already
1531
# deserialized in self._fileid_to_entry_cache
1533
directories_to_expand = set()
1534
children_of_parent_id = {}
1535
# It is okay if some of the fileids are missing
1536
for entry in self._getitems(file_ids):
1537
if entry.kind == 'directory':
1538
directories_to_expand.add(entry.file_id)
1539
interesting.add(entry.parent_id)
1540
children_of_parent_id.setdefault(entry.parent_id, set()
1541
).add(entry.file_id)
1543
# Now, interesting has all of the direct parents, but not the
1544
# parents of those parents. It also may have some duplicates with
1546
remaining_parents = interesting.difference(file_ids)
1547
# When we hit the TREE_ROOT, we'll get an interesting parent of None,
1548
# but we don't actually want to recurse into that
1549
interesting.add(None) # this will auto-filter it in the loop
1550
remaining_parents.discard(None)
1551
while remaining_parents:
1552
next_parents = set()
1553
for entry in self._getitems(remaining_parents):
1554
next_parents.add(entry.parent_id)
1555
children_of_parent_id.setdefault(entry.parent_id, set()
1556
).add(entry.file_id)
1557
# Remove any search tips we've already processed
1558
remaining_parents = next_parents.difference(interesting)
1559
interesting.update(remaining_parents)
1560
# We should probably also .difference(directories_to_expand)
1561
interesting.update(file_ids)
1562
interesting.discard(None)
1563
while directories_to_expand:
1564
# Expand directories by looking in the
1565
# parent_id_basename_to_file_id map
1566
keys = [StaticTuple(f,).intern() for f in directories_to_expand]
1567
directories_to_expand = set()
1568
items = self.parent_id_basename_to_file_id.iteritems(keys)
1569
next_file_ids = {item[1] for item in items}
1570
next_file_ids = next_file_ids.difference(interesting)
1571
interesting.update(next_file_ids)
1572
for entry in self._getitems(next_file_ids):
1573
if entry.kind == 'directory':
1574
directories_to_expand.add(entry.file_id)
1575
children_of_parent_id.setdefault(entry.parent_id, set()
1576
).add(entry.file_id)
1577
return interesting, children_of_parent_id
1579
def filter(self, specific_fileids):
1580
"""Get an inventory view filtered against a set of file-ids.
1582
Children of directories and parents are included.
1584
The result may or may not reference the underlying inventory
1585
so it should be treated as immutable.
1588
parent_to_children) = self._expand_fileids_to_parents_and_children(
1590
# There is some overlap here, but we assume that all interesting items
1591
# are in the _fileid_to_entry_cache because we had to read them to
1592
# determine if they were a dir we wanted to recurse, or just a file
1593
# This should give us all the entries we'll want to add, so start
1595
other = Inventory(self.root_id)
1596
other.root.revision = self.root.revision
1597
other.revision_id = self.revision_id
1598
if not interesting or not parent_to_children:
1599
# empty filter, or filtering entrys that don't exist
1600
# (if even 1 existed, then we would have populated
1601
# parent_to_children with at least the tree root.)
1603
cache = self._fileid_to_entry_cache
1604
remaining_children = deque(
1605
parent_to_children[self.root_id])
1606
while remaining_children:
1607
file_id = remaining_children.popleft()
1609
if ie.kind == 'directory':
1610
ie = ie.copy() # We create a copy to depopulate the .children attribute
1611
# TODO: depending on the uses of 'other' we should probably alwyas
1612
# '.copy()' to prevent someone from mutating other and
1613
# invaliding our internal cache
1615
if file_id in parent_to_children:
1616
remaining_children.extend(parent_to_children[file_id])
1620
def _bytes_to_utf8name_key(data):
1621
"""Get the file_id, revision_id key out of data."""
1622
# We don't normally care about name, except for times when we want
1623
# to filter out empty names because of non rich-root...
1624
sections = data.split(b'\n')
1625
kind, file_id = sections[0].split(b': ')
1626
return (sections[2], bytesintern(file_id), bytesintern(sections[3]))
1628
def _bytes_to_entry(self, bytes):
1629
"""Deserialise a serialised entry."""
1630
sections = bytes.split(b'\n')
1631
if sections[0].startswith(b"file: "):
1632
result = InventoryFile(sections[0][6:],
1633
sections[2].decode('utf8'),
1635
result.text_sha1 = sections[4]
1636
result.text_size = int(sections[5])
1637
result.executable = sections[6] == b"Y"
1638
elif sections[0].startswith(b"dir: "):
1639
result = CHKInventoryDirectory(sections[0][5:],
1640
sections[2].decode('utf8'),
1642
elif sections[0].startswith(b"symlink: "):
1643
result = InventoryLink(sections[0][9:],
1644
sections[2].decode('utf8'),
1646
result.symlink_target = sections[4].decode('utf8')
1647
elif sections[0].startswith(b"tree: "):
1648
result = TreeReference(sections[0][6:],
1649
sections[2].decode('utf8'),
1651
result.reference_revision = sections[4]
1653
raise ValueError("Not a serialised entry %r" % bytes)
1654
result.file_id = bytesintern(result.file_id)
1655
result.revision = bytesintern(sections[3])
1656
if result.parent_id == b'':
1657
result.parent_id = None
1658
self._fileid_to_entry_cache[result.file_id] = result
1661
def create_by_apply_delta(self, inventory_delta, new_revision_id,
1662
propagate_caches=False):
1663
"""Create a new CHKInventory by applying inventory_delta to this one.
1665
See the inventory developers documentation for the theory behind
1668
:param inventory_delta: The inventory delta to apply. See
1669
Inventory.apply_delta for details.
1670
:param new_revision_id: The revision id of the resulting CHKInventory.
1671
:param propagate_caches: If True, the caches for this inventory are
1672
copied to and updated for the result.
1673
:return: The new CHKInventory.
1675
split = osutils.split
1676
result = CHKInventory(self._search_key_name)
1677
if propagate_caches:
1678
# Just propagate the path-to-fileid cache for now
1679
result._path_to_fileid_cache = self._path_to_fileid_cache.copy()
1680
search_key_func = chk_map.search_key_registry.get(
1681
self._search_key_name)
1682
self.id_to_entry._ensure_root()
1683
maximum_size = self.id_to_entry._root_node.maximum_size
1684
result.revision_id = new_revision_id
1685
result.id_to_entry = chk_map.CHKMap(
1686
self.id_to_entry._store,
1687
self.id_to_entry.key(),
1688
search_key_func=search_key_func)
1689
result.id_to_entry._ensure_root()
1690
result.id_to_entry._root_node.set_maximum_size(maximum_size)
1691
# Change to apply to the parent_id_basename delta. The dict maps
1692
# (parent_id, basename) -> (old_key, new_value). We use a dict because
1693
# when a path has its id replaced (e.g. the root is changed, or someone
1694
# does bzr mv a b, bzr mv c a, we should output a single change to this
1695
# map rather than two.
1696
parent_id_basename_delta = {}
1697
if self.parent_id_basename_to_file_id is not None:
1698
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1699
self.parent_id_basename_to_file_id._store,
1700
self.parent_id_basename_to_file_id.key(),
1701
search_key_func=search_key_func)
1702
result.parent_id_basename_to_file_id._ensure_root()
1703
self.parent_id_basename_to_file_id._ensure_root()
1704
result_p_id_root = result.parent_id_basename_to_file_id._root_node
1705
p_id_root = self.parent_id_basename_to_file_id._root_node
1706
result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1707
result_p_id_root._key_width = p_id_root._key_width
1709
result.parent_id_basename_to_file_id = None
1710
result.root_id = self.root_id
1711
id_to_entry_delta = []
1712
# inventory_delta is only traversed once, so we just update the
1714
# Check for repeated file ids
1715
inventory_delta = _check_delta_unique_ids(inventory_delta)
1716
# Repeated old paths
1717
inventory_delta = _check_delta_unique_old_paths(inventory_delta)
1718
# Check for repeated new paths
1719
inventory_delta = _check_delta_unique_new_paths(inventory_delta)
1720
# Check for entries that don't match the fileid
1721
inventory_delta = _check_delta_ids_match_entry(inventory_delta)
1722
# Check for nonsense fileids
1723
inventory_delta = _check_delta_ids_are_valid(inventory_delta)
1724
# Check for new_path <-> entry consistency
1725
inventory_delta = _check_delta_new_path_entry_both_or_None(
1727
# All changed entries need to have their parents be directories and be
1728
# at the right path. This set contains (path, id) tuples.
1730
# When we delete an item, all the children of it must be either deleted
1731
# or altered in their own right. As we batch process the change via
1732
# CHKMap.apply_delta, we build a set of things to use to validate the
1736
for old_path, new_path, file_id, entry in inventory_delta:
1739
result.root_id = file_id
1740
if new_path is None:
1745
if propagate_caches:
1747
del result._path_to_fileid_cache[old_path]
1750
deletes.add(file_id)
1752
new_key = StaticTuple(file_id,)
1753
new_value = result._entry_to_bytes(entry)
1754
# Update caches. It's worth doing this whether
1755
# we're propagating the old caches or not.
1756
result._path_to_fileid_cache[new_path] = file_id
1757
parents.add((split(new_path)[0], entry.parent_id))
1758
if old_path is None:
1761
old_key = StaticTuple(file_id,)
1762
if self.id2path(file_id) != old_path:
1763
raise errors.InconsistentDelta(old_path, file_id,
1764
"Entry was at wrong other path %r." %
1765
self.id2path(file_id))
1766
altered.add(file_id)
1767
id_to_entry_delta.append(StaticTuple(old_key, new_key, new_value))
1768
if result.parent_id_basename_to_file_id is not None:
1769
# parent_id, basename changes
1770
if old_path is None:
1773
old_entry = self.get_entry(file_id)
1774
old_key = self._parent_id_basename_key(old_entry)
1775
if new_path is None:
1779
new_key = self._parent_id_basename_key(entry)
1781
# If the two keys are the same, the value will be unchanged
1782
# as its always the file id for this entry.
1783
if old_key != new_key:
1784
# Transform a change into explicit delete/add preserving
1785
# a possible match on the key from a different file id.
1786
if old_key is not None:
1787
parent_id_basename_delta.setdefault(
1788
old_key, [None, None])[0] = old_key
1789
if new_key is not None:
1790
parent_id_basename_delta.setdefault(
1791
new_key, [None, None])[1] = new_value
1792
# validate that deletes are complete.
1793
for file_id in deletes:
1794
entry = self.get_entry(file_id)
1795
if entry.kind != 'directory':
1797
# This loop could potentially be better by using the id_basename
1798
# map to just get the child file ids.
1799
for child in viewvalues(entry.children):
1800
if child.file_id not in altered:
1801
raise errors.InconsistentDelta(self.id2path(child.file_id),
1802
child.file_id, "Child not deleted or reparented when "
1804
result.id_to_entry.apply_delta(id_to_entry_delta)
1805
if parent_id_basename_delta:
1806
# Transform the parent_id_basename delta data into a linear delta
1807
# with only one record for a given key. Optimally this would allow
1808
# re-keying, but its simpler to just output that as a delete+add
1809
# to spend less time calculating the delta.
1811
for key, (old_key, value) in viewitems(parent_id_basename_delta):
1812
if value is not None:
1813
delta_list.append((old_key, key, value))
1815
delta_list.append((old_key, None, None))
1816
result.parent_id_basename_to_file_id.apply_delta(delta_list)
1817
parents.discard(('', None))
1818
for parent_path, parent in parents:
1820
if result.get_entry(parent).kind != 'directory':
1821
raise errors.InconsistentDelta(result.id2path(parent), parent,
1822
'Not a directory, but given children')
1823
except errors.NoSuchId:
1824
raise errors.InconsistentDelta("<unknown>", parent,
1825
"Parent is not present in resulting inventory.")
1826
if result.path2id(parent_path) != parent:
1827
raise errors.InconsistentDelta(parent_path, parent,
1828
"Parent has wrong path %r." % result.path2id(parent_path))
1832
def deserialise(klass, chk_store, lines, expected_revision_id):
1833
"""Deserialise a CHKInventory.
1835
:param chk_store: A CHK capable VersionedFiles instance.
1836
:param bytes: The serialised bytes.
1837
:param expected_revision_id: The revision ID we think this inventory is
1839
:return: A CHKInventory
1841
if not lines[-1].endswith(b'\n'):
1842
raise ValueError("last line should have trailing eol\n")
1843
if lines[0] != b'chkinventory:\n':
1844
raise ValueError("not a serialised CHKInventory: %r" % bytes)
1846
allowed_keys = frozenset((b'root_id', b'revision_id',
1847
b'parent_id_basename_to_file_id',
1848
b'search_key_name', b'id_to_entry'))
1849
for line in lines[1:]:
1850
key, value = line.rstrip(b'\n').split(b': ', 1)
1851
if key not in allowed_keys:
1852
raise errors.BzrError('Unknown key in inventory: %r\n%r'
1855
raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1858
revision_id = bytesintern(info[b'revision_id'])
1859
root_id = bytesintern(info[b'root_id'])
1860
search_key_name = bytesintern(info.get(b'search_key_name', b'plain'))
1861
parent_id_basename_to_file_id = bytesintern(info.get(
1862
b'parent_id_basename_to_file_id', None))
1863
if not parent_id_basename_to_file_id.startswith(b'sha1:'):
1864
raise ValueError('parent_id_basename_to_file_id should be a sha1'
1865
' key not %r' % (parent_id_basename_to_file_id,))
1866
id_to_entry = info[b'id_to_entry']
1867
if not id_to_entry.startswith(b'sha1:'):
1868
raise ValueError('id_to_entry should be a sha1'
1869
' key not %r' % (id_to_entry,))
1871
result = CHKInventory(search_key_name)
1872
result.revision_id = revision_id
1873
result.root_id = root_id
1874
search_key_func = chk_map.search_key_registry.get(
1875
result._search_key_name)
1876
if parent_id_basename_to_file_id is not None:
1877
result.parent_id_basename_to_file_id = chk_map.CHKMap(
1878
chk_store, StaticTuple(parent_id_basename_to_file_id,),
1879
search_key_func=search_key_func)
1881
result.parent_id_basename_to_file_id = None
1883
result.id_to_entry = chk_map.CHKMap(chk_store,
1884
StaticTuple(id_to_entry,),
1885
search_key_func=search_key_func)
1886
if (result.revision_id,) != expected_revision_id:
1887
raise ValueError("Mismatched revision id and expected: %r, %r" %
1888
(result.revision_id, expected_revision_id))
1892
def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name=b'plain'):
1893
"""Create a CHKInventory from an existing inventory.
1895
The content of inventory is copied into the chk_store, and a
1896
CHKInventory referencing that is returned.
1898
:param chk_store: A CHK capable VersionedFiles instance.
1899
:param inventory: The inventory to copy.
1900
:param maximum_size: The CHKMap node size limit.
1901
:param search_key_name: The identifier for the search key function
1903
result = klass(search_key_name)
1904
result.revision_id = inventory.revision_id
1905
result.root_id = inventory.root.file_id
1907
entry_to_bytes = result._entry_to_bytes
1908
parent_id_basename_key = result._parent_id_basename_key
1909
id_to_entry_dict = {}
1910
parent_id_basename_dict = {}
1911
for path, entry in inventory.iter_entries():
1912
key = StaticTuple(entry.file_id,).intern()
1913
id_to_entry_dict[key] = entry_to_bytes(entry)
1914
p_id_key = parent_id_basename_key(entry)
1915
parent_id_basename_dict[p_id_key] = entry.file_id
1917
result._populate_from_dicts(chk_store, id_to_entry_dict,
1918
parent_id_basename_dict, maximum_size=maximum_size)
1921
def _populate_from_dicts(self, chk_store, id_to_entry_dict,
1922
parent_id_basename_dict, maximum_size):
1923
search_key_func = chk_map.search_key_registry.get(
1924
self._search_key_name)
1925
root_key = chk_map.CHKMap.from_dict(chk_store, id_to_entry_dict,
1926
maximum_size=maximum_size, key_width=1,
1927
search_key_func=search_key_func)
1928
self.id_to_entry = chk_map.CHKMap(chk_store, root_key,
1930
root_key = chk_map.CHKMap.from_dict(chk_store,
1931
parent_id_basename_dict,
1932
maximum_size=maximum_size, key_width=2,
1933
search_key_func=search_key_func)
1934
self.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1935
root_key, search_key_func)
1937
def _parent_id_basename_key(self, entry):
1938
"""Create a key for a entry in a parent_id_basename_to_file_id index."""
1939
if entry.parent_id is not None:
1940
parent_id = entry.parent_id
1943
return StaticTuple(parent_id, entry.name.encode('utf8')).intern()
1945
def get_entry(self, file_id):
1946
"""map a single file_id -> InventoryEntry."""
1948
raise errors.NoSuchId(self, file_id)
1949
result = self._fileid_to_entry_cache.get(file_id, None)
1950
if result is not None:
1953
return self._bytes_to_entry(
1954
next(self.id_to_entry.iteritems([StaticTuple(file_id,)]))[1])
1955
except StopIteration:
1956
# really we're passing an inventory, not a tree...
1957
raise errors.NoSuchId(self, file_id)
1959
def _getitems(self, file_ids):
1960
"""Similar to get_entry, but lets you query for multiple.
1962
The returned order is undefined. And currently if an item doesn't
1963
exist, it isn't included in the output.
1967
for file_id in file_ids:
1968
entry = self._fileid_to_entry_cache.get(file_id, None)
1970
remaining.append(file_id)
1972
result.append(entry)
1973
file_keys = [StaticTuple(f,).intern() for f in remaining]
1974
for file_key, value in self.id_to_entry.iteritems(file_keys):
1975
entry = self._bytes_to_entry(value)
1976
result.append(entry)
1977
self._fileid_to_entry_cache[entry.file_id] = entry
1980
def has_id(self, file_id):
1981
# Perhaps have an explicit 'contains' method on CHKMap ?
1982
if self._fileid_to_entry_cache.get(file_id, None) is not None:
1985
self.id_to_entry.iteritems([StaticTuple(file_id,)]))) == 1
1987
def is_root(self, file_id):
1988
return file_id == self.root_id
1990
def _iter_file_id_parents(self, file_id):
1991
"""Yield the parents of file_id up to the root."""
1992
while file_id is not None:
1994
ie = self.get_entry(file_id)
1996
raise errors.NoSuchId(tree=self, file_id=file_id)
1998
file_id = ie.parent_id
2000
def iter_all_ids(self):
2001
"""Iterate over all file-ids."""
2002
for key, _ in self.id_to_entry.iteritems():
2005
def iter_just_entries(self):
2006
"""Iterate over all entries.
2008
Unlike iter_entries(), just the entries are returned (not (path, ie))
2009
and the order of entries is undefined.
2011
XXX: We may not want to merge this into bzr.dev.
2013
for key, entry in self.id_to_entry.iteritems():
2015
ie = self._fileid_to_entry_cache.get(file_id, None)
2017
ie = self._bytes_to_entry(entry)
2018
self._fileid_to_entry_cache[file_id] = ie
2021
def _preload_cache(self):
2022
"""Make sure all file-ids are in _fileid_to_entry_cache"""
2023
if self._fully_cached:
2024
return # No need to do it again
2025
# The optimal sort order is to use iteritems() directly
2026
cache = self._fileid_to_entry_cache
2027
for key, entry in self.id_to_entry.iteritems():
2029
if file_id not in cache:
2030
ie = self._bytes_to_entry(entry)
2034
last_parent_id = last_parent_ie = None
2035
pid_items = self.parent_id_basename_to_file_id.iteritems()
2036
for key, child_file_id in pid_items:
2037
if key == (b'', b''): # This is the root
2038
if child_file_id != self.root_id:
2039
raise ValueError('Data inconsistency detected.'
2040
' We expected data with key ("","") to match'
2041
' the root id, but %s != %s'
2042
% (child_file_id, self.root_id))
2044
parent_id, basename = key
2045
ie = cache[child_file_id]
2046
if parent_id == last_parent_id:
2047
parent_ie = last_parent_ie
2049
parent_ie = cache[parent_id]
2050
if parent_ie.kind != 'directory':
2051
raise ValueError('Data inconsistency detected.'
2052
' An entry in the parent_id_basename_to_file_id map'
2053
' has parent_id {%s} but the kind of that object'
2054
' is %r not "directory"' % (parent_id, parent_ie.kind))
2055
if parent_ie._children is None:
2056
parent_ie._children = {}
2057
basename = basename.decode('utf-8')
2058
if basename in parent_ie._children:
2059
existing_ie = parent_ie._children[basename]
2060
if existing_ie != ie:
2061
raise ValueError('Data inconsistency detected.'
2062
' Two entries with basename %r were found'
2063
' in the parent entry {%s}'
2064
% (basename, parent_id))
2065
if basename != ie.name:
2066
raise ValueError('Data inconsistency detected.'
2067
' In the parent_id_basename_to_file_id map, file_id'
2068
' {%s} is listed as having basename %r, but in the'
2069
' id_to_entry map it is %r'
2070
% (child_file_id, basename, ie.name))
2071
parent_ie._children[basename] = ie
2072
self._fully_cached = True
2074
def iter_changes(self, basis):
2075
"""Generate a Tree.iter_changes change list between this and basis.
2077
:param basis: Another CHKInventory.
2078
:return: An iterator over the changes between self and basis, as per
2079
tree.iter_changes().
2081
# We want: (file_id, (path_in_source, path_in_target),
2082
# changed_content, versioned, parent, name, kind,
2084
for key, basis_value, self_value in \
2085
self.id_to_entry.iter_changes(basis.id_to_entry):
2087
if basis_value is not None:
2088
basis_entry = basis._bytes_to_entry(basis_value)
2089
path_in_source = basis.id2path(file_id)
2090
basis_parent = basis_entry.parent_id
2091
basis_name = basis_entry.name
2092
basis_executable = basis_entry.executable
2094
path_in_source = None
2097
basis_executable = None
2098
if self_value is not None:
2099
self_entry = self._bytes_to_entry(self_value)
2100
path_in_target = self.id2path(file_id)
2101
self_parent = self_entry.parent_id
2102
self_name = self_entry.name
2103
self_executable = self_entry.executable
2105
path_in_target = None
2108
self_executable = None
2109
if basis_value is None:
2111
kind = (None, self_entry.kind)
2112
versioned = (False, True)
2113
elif self_value is None:
2115
kind = (basis_entry.kind, None)
2116
versioned = (True, False)
2118
kind = (basis_entry.kind, self_entry.kind)
2119
versioned = (True, True)
2120
changed_content = False
2121
if kind[0] != kind[1]:
2122
changed_content = True
2123
elif kind[0] == 'file':
2124
if (self_entry.text_size != basis_entry.text_size
2125
or self_entry.text_sha1 != basis_entry.text_sha1):
2126
changed_content = True
2127
elif kind[0] == 'symlink':
2128
if self_entry.symlink_target != basis_entry.symlink_target:
2129
changed_content = True
2130
elif kind[0] == 'tree-reference':
2131
if (self_entry.reference_revision
2132
!= basis_entry.reference_revision):
2133
changed_content = True
2134
parent = (basis_parent, self_parent)
2135
name = (basis_name, self_name)
2136
executable = (basis_executable, self_executable)
2137
if (not changed_content and
2138
parent[0] == parent[1] and
2139
name[0] == name[1] and
2140
executable[0] == executable[1]):
2141
# Could happen when only the revision changed for a directory
2145
file_id, (path_in_source, path_in_target), changed_content,
2146
versioned, parent, name, kind, executable)
2149
"""Return the number of entries in the inventory."""
2150
return len(self.id_to_entry)
2152
def _make_delta(self, old):
2153
"""Make an inventory delta from two inventories."""
2154
if not isinstance(old, CHKInventory):
2155
return CommonInventory._make_delta(self, old)
2157
for key, old_value, self_value in \
2158
self.id_to_entry.iter_changes(old.id_to_entry):
2160
if old_value is not None:
2161
old_path = old.id2path(file_id)
2164
if self_value is not None:
2165
entry = self._bytes_to_entry(self_value)
2166
self._fileid_to_entry_cache[file_id] = entry
2167
new_path = self.id2path(file_id)
2171
delta.append((old_path, new_path, file_id, entry))
2174
def path2id(self, relpath):
2175
"""See CommonInventory.path2id()."""
2176
# TODO: perhaps support negative hits?
2177
if isinstance(relpath, (str, text_type)):
2178
names = osutils.splitpath(relpath)
2183
relpath = osutils.pathjoin(*relpath)
2184
result = self._path_to_fileid_cache.get(relpath, None)
2185
if result is not None:
2187
current_id = self.root_id
2188
if current_id is None:
2190
parent_id_index = self.parent_id_basename_to_file_id
2192
for basename in names:
2193
if cur_path is None:
2196
cur_path = cur_path + '/' + basename
2197
basename_utf8 = basename.encode('utf8')
2198
file_id = self._path_to_fileid_cache.get(cur_path, None)
2200
key_filter = [StaticTuple(current_id, basename_utf8)]
2201
items = parent_id_index.iteritems(key_filter)
2202
for (parent_id, name_utf8), file_id in items:
2203
if parent_id != current_id or name_utf8 != basename_utf8:
2204
raise errors.BzrError("corrupt inventory lookup! "
2205
"%r %r %r %r" % (parent_id, current_id, name_utf8,
2210
self._path_to_fileid_cache[cur_path] = file_id
2211
current_id = file_id
2215
"""Serialise the inventory to lines."""
2216
lines = [b"chkinventory:\n"]
2217
if self._search_key_name != b'plain':
2218
# custom ordering grouping things that don't change together
2219
lines.append(b'search_key_name: %s\n' % (
2220
self._search_key_name))
2221
lines.append(b"root_id: %s\n" % self.root_id)
2222
lines.append(b'parent_id_basename_to_file_id: %s\n' %
2223
(self.parent_id_basename_to_file_id.key()[0],))
2224
lines.append(b"revision_id: %s\n" % self.revision_id)
2225
lines.append(b"id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
2227
lines.append(b"revision_id: %s\n" % self.revision_id)
2228
lines.append(b"root_id: %s\n" % self.root_id)
2229
if self.parent_id_basename_to_file_id is not None:
2230
lines.append(b'parent_id_basename_to_file_id: %s\n' %
2231
(self.parent_id_basename_to_file_id.key()[0],))
2232
lines.append(b"id_to_entry: %s\n" % (self.id_to_entry.key()[0],))
2237
"""Get the root entry."""
2238
return self.get_entry(self.root_id)
2241
class CHKInventoryDirectory(InventoryDirectory):
2242
"""A directory in an inventory."""
2244
__slots__ = ['_children', '_chk_inventory']
2246
def __init__(self, file_id, name, parent_id, chk_inventory):
2247
# Don't call InventoryDirectory.__init__ - it isn't right for this
2249
InventoryEntry.__init__(self, file_id, name, parent_id)
2250
self._children = None
2251
self._chk_inventory = chk_inventory
2255
"""Access the list of children of this directory.
2257
With a parent_id_basename_to_file_id index, loads all the children,
2258
without loads the entire index. Without is bad. A more sophisticated
2259
proxy object might be nice, to allow partial loading of children as
2260
well when specific names are accessed. (So path traversal can be
2261
written in the obvious way but not examine siblings.).
2263
if self._children is not None:
2264
return self._children
2265
# No longer supported
2266
if self._chk_inventory.parent_id_basename_to_file_id is None:
2267
raise AssertionError("Inventories without"
2268
" parent_id_basename_to_file_id are no longer supported")
2270
# XXX: Todo - use proxy objects for the children rather than loading
2271
# all when the attribute is referenced.
2272
parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
2274
for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
2275
key_filter=[StaticTuple(self.file_id,)]):
2276
child_keys.add(StaticTuple(file_id,))
2278
for file_id_key in child_keys:
2279
entry = self._chk_inventory._fileid_to_entry_cache.get(
2280
file_id_key[0], None)
2281
if entry is not None:
2282
result[entry.name] = entry
2283
cached.add(file_id_key)
2284
child_keys.difference_update(cached)
2285
# populate; todo: do by name
2286
id_to_entry = self._chk_inventory.id_to_entry
2287
for file_id_key, bytes in id_to_entry.iteritems(child_keys):
2288
entry = self._chk_inventory._bytes_to_entry(bytes)
2289
result[entry.name] = entry
2290
self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
2291
self._children = result
2296
'directory': InventoryDirectory,
2297
'file': InventoryFile,
2298
'symlink': InventoryLink,
2299
'tree-reference': TreeReference
2303
def make_entry(kind, name, parent_id, file_id=None):
2304
"""Create an inventory entry.
2306
:param kind: the type of inventory entry to create.
2307
:param name: the basename of the entry.
2308
:param parent_id: the parent_id of the entry.
2309
:param file_id: the file_id to use. if None, one will be created.
2312
file_id = generate_ids.gen_file_id(name)
2313
name = ensure_normalized_name(name)
2315
factory = entry_factory[kind]
2317
raise errors.BadFileKindError(name, kind)
2318
return factory(file_id, name, parent_id)
2321
def ensure_normalized_name(name):
2324
:raises InvalidNormalization: When name is not normalized, and cannot be
2325
accessed on this platform by the normalized path.
2326
:return: The NFC normalised version of name.
2328
# ------- This has been copied to breezy.dirstate.DirState.add, please
2329
# keep them synchronised.
2330
# we dont import normalized_filename directly because we want to be
2331
# able to change the implementation at runtime for tests.
2332
norm_name, can_access = osutils.normalized_filename(name)
2333
if norm_name != name:
2337
# TODO: jam 20060701 This would probably be more useful
2338
# if the error was raised with the full path
2339
raise errors.InvalidNormalization(name)
2343
_NAME_RE = lazy_regex.lazy_compile(r'^[^/\\]+$')
2346
1174
def is_valid_name(name):
1176
if _NAME_RE == None:
1177
_NAME_RE = re.compile(r'^[^/\\]+$')
2347
1179
return bool(_NAME_RE.match(name))
2350
def _check_delta_unique_ids(delta):
2351
"""Decorate a delta and check that the file ids in it are unique.
2353
:return: A generator over delta.
2357
length = len(ids) + 1
2359
if len(ids) != length:
2360
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2365
def _check_delta_unique_new_paths(delta):
2366
"""Decorate a delta and check that the new paths in it are unique.
2368
:return: A generator over delta.
2372
length = len(paths) + 1
2374
if path is not None:
2376
if len(paths) != length:
2377
raise errors.InconsistentDelta(path, item[2], "repeated path")
2381
def _check_delta_unique_old_paths(delta):
2382
"""Decorate a delta and check that the old paths in it are unique.
2384
:return: A generator over delta.
2388
length = len(paths) + 1
2390
if path is not None:
2392
if len(paths) != length:
2393
raise errors.InconsistentDelta(path, item[2], "repeated path")
2397
def _check_delta_ids_are_valid(delta):
2398
"""Decorate a delta and check that the ids in it are valid.
2400
:return: A generator over delta.
2405
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2406
"entry with file_id None %r" % entry)
2407
if not isinstance(item[2], bytes):
2408
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2409
"entry with non bytes file_id %r" % entry)
2413
def _check_delta_ids_match_entry(delta):
2414
"""Decorate a delta and check that the ids in it match the entry.file_id.
2416
:return: A generator over delta.
2420
if entry is not None:
2421
if entry.file_id != item[2]:
2422
raise errors.InconsistentDelta(item[0] or item[1], item[2],
2423
"mismatched id with %r" % entry)
2427
def _check_delta_new_path_entry_both_or_None(delta):
2428
"""Decorate a delta and check that the new_path and entry are paired.
2430
:return: A generator over delta.
2435
if new_path is None and entry is not None:
2436
raise errors.InconsistentDelta(item[0], item[1],
2437
"Entry with no new_path")
2438
if new_path is not None and entry is None:
2439
raise errors.InconsistentDelta(new_path, item[1],
2440
"new_path with no entry")
2444
def mutable_inventory_from_tree(tree):
2445
"""Create a new inventory that has the same contents as a specified tree.
2447
:param tree: Revision tree to create inventory from
2449
entries = tree.iter_entries_by_dir()
2450
inv = Inventory(None, tree.get_revision_id())
2451
for path, inv_entry in entries:
2452
inv.add(inv_entry.copy())
added
removed
bzrlib/inventory.py
