1
# Copyright (C) 2005, 2006 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep
18
# the WorkingTree's copy of the inventory in sync with the branch. The
19
# branch modifies its working inventory when it does a commit to make
20
# missing files permanently removed.
22
# TODO: Maybe also keep the full path of the entry, and the children?
23
# But those depend on its position within a particular inventory, and
24
# it would be nice not to need to hold the backpointer here.
26
# This should really be an id randomly assigned when the tree is
27
# created, but it's not for now.
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
49
from bzrlib.errors import (
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)
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))
100
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
101
Traceback (most recent call last):
103
BzrError: inventory already contains entry with id {2323}
104
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
105
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
106
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
107
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
108
>>> i.path2id('src/wibble')
112
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
113
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
115
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
116
>>> for path, entry in i.iter_entries():
118
... assert i.path2id(path)
126
>>> i.id2path('2326')
127
'src/wibble/wibble.c'
130
# Constants returned by describe_change()
132
# TODO: These should probably move to some kind of FileChangeDescription
133
# class; that's like what's inside a TreeDelta but we want to be able to
134
# generate them just for one file at a time.
136
MODIFIED_AND_RENAMED = 'modified and renamed'
140
def detect_changes(self, old_entry):
141
"""Return a (text_modified, meta_modified) from this to old_entry.
143
_read_tree_state must have been called on self and old_entry prior to
144
calling detect_changes.
148
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
149
output_to, reverse=False):
150
"""Perform a diff from this to to_entry.
152
text_diff will be used for textual difference calculation.
153
This is a template method, override _diff in child classes.
155
self._read_tree_state(tree.id2path(self.file_id), tree)
157
# cannot diff from one kind to another - you must do a removal
158
# and an addif they do not match.
159
assert self.kind == to_entry.kind
160
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
162
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
165
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
166
output_to, reverse=False):
167
"""Perform a diff between two entries of the same kind."""
169
def find_previous_heads(self, previous_inventories,
170
versioned_file_store,
173
"""Return the revisions and entries that directly precede this.
175
Returned as a map from revision to inventory entry.
177
This is a map containing the file revisions in all parents
178
for which the file exists, and its revision is not a parent of
179
any other. If the file is new, the set will be empty.
181
:param versioned_file_store: A store where ancestry data on this
182
file id can be queried.
183
:param transaction: The transaction that queries to the versioned
184
file store should be completed under.
185
:param entry_vf: The entry versioned file, if its already available.
187
def get_ancestors(weave, entry):
188
return set(weave.get_ancestry(entry.revision))
189
# revision:ie mapping for each ie found in previous_inventories.
191
# revision:ie mapping with one revision for each head.
193
# revision: ancestor list for each head
195
# identify candidate head revision ids.
196
for inv in previous_inventories:
197
if self.file_id in inv:
198
ie = inv[self.file_id]
199
assert ie.file_id == self.file_id
200
if ie.revision in candidates:
201
# same revision value in two different inventories:
202
# correct possible inconsistencies:
203
# * there was a bug in revision updates with 'x' bit
206
if candidates[ie.revision].executable != ie.executable:
207
candidates[ie.revision].executable = False
208
ie.executable = False
209
except AttributeError:
211
# must now be the same.
212
assert candidates[ie.revision] == ie
214
# add this revision as a candidate.
215
candidates[ie.revision] = ie
217
# common case optimisation
218
if len(candidates) == 1:
219
# if there is only one candidate revision found
220
# then we can opening the versioned file to access ancestry:
221
# there cannot be any ancestors to eliminate when there is
222
# only one revision available.
223
heads[ie.revision] = ie
226
# eliminate ancestors amongst the available candidates:
227
# heads are those that are not an ancestor of any other candidate
228
# - this provides convergence at a per-file level.
229
for ie in candidates.values():
230
# may be an ancestor of a known head:
231
already_present = 0 != len(
232
[head for head in heads
233
if ie.revision in head_ancestors[head]])
235
# an ancestor of an analyzed candidate.
237
# not an ancestor of a known head:
238
# load the versioned file for this file id if needed
240
entry_vf = versioned_file_store.get_weave_or_empty(
241
self.file_id, transaction)
242
ancestors = get_ancestors(entry_vf, ie)
243
# may knock something else out:
244
check_heads = list(heads.keys())
245
for head in check_heads:
246
if head in ancestors:
247
# this previously discovered 'head' is not
248
# really a head - its an ancestor of the newly
251
head_ancestors[ie.revision] = ancestors
252
heads[ie.revision] = ie
255
def get_tar_item(self, root, dp, now, tree):
256
"""Get a tarfile item and a file stream for its content."""
257
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
258
# TODO: would be cool to actually set it to the timestamp of the
259
# revision it was last changed
261
fileobj = self._put_in_tar(item, tree)
265
"""Return true if the object this entry represents has textual data.
267
Note that textual data includes binary content.
269
Also note that all entries get weave files created for them.
270
This attribute is primarily used when upgrading from old trees that
271
did not have the weave index for all inventory entries.
275
def __init__(self, file_id, name, parent_id, text_id=None):
276
"""Create an InventoryEntry
278
The filename must be a single component, relative to the
279
parent directory; it cannot be a whole path or relative name.
281
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
286
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
287
Traceback (most recent call last):
288
InvalidEntryName: Invalid entry name: src/hello.c
290
assert isinstance(name, basestring), name
291
if '/' in name or '\\' in name:
292
raise errors.InvalidEntryName(name=name)
293
self.executable = False
295
self.text_sha1 = None
296
self.text_size = None
297
self.file_id = file_id
298
assert isinstance(file_id, (str, None.__class__)), \
299
'bad type %r for %r' % (type(file_id), file_id)
301
self.text_id = text_id
302
self.parent_id = parent_id
303
self.symlink_target = None
305
def kind_character(self):
306
"""Return a short kind indicator useful for appending to names."""
307
raise BzrError('unknown kind %r' % self.kind)
309
known_kinds = ('file', 'directory', 'symlink')
311
def _put_in_tar(self, item, tree):
312
"""populate item for stashing in a tar, and return the content stream.
314
If no content is available, return None.
316
raise BzrError("don't know how to export {%s} of kind %r" %
317
(self.file_id, self.kind))
319
def put_on_disk(self, dest, dp, tree):
320
"""Create a representation of self on disk in the prefix dest.
322
This is a template method - implement _put_on_disk in subclasses.
324
fullpath = osutils.pathjoin(dest, dp)
325
self._put_on_disk(fullpath, tree)
326
# mutter(" export {%s} kind %s to %s", self.file_id,
327
# self.kind, fullpath)
329
def _put_on_disk(self, fullpath, tree):
330
"""Put this entry onto disk at fullpath, from tree tree."""
331
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
333
def sorted_children(self):
334
return sorted(self.children.items())
337
def versionable_kind(kind):
338
return (kind in ('file', 'directory', 'symlink'))
340
def check(self, checker, rev_id, inv, tree):
341
"""Check this inventory entry is intact.
343
This is a template method, override _check for kind specific
346
:param checker: Check object providing context for the checks;
347
can be used to find out what parts of the repository have already
349
:param rev_id: Revision id from which this InventoryEntry was loaded.
350
Not necessarily the last-changed revision for this file.
351
:param inv: Inventory from which the entry was loaded.
352
:param tree: RevisionTree for this entry.
354
if self.parent_id is not None:
355
if not inv.has_id(self.parent_id):
356
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
357
% (self.parent_id, rev_id))
358
self._check(checker, rev_id, tree)
360
def _check(self, checker, rev_id, tree):
361
"""Check this inventory entry for kind specific errors."""
362
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
366
"""Clone this inventory entry."""
367
raise NotImplementedError
370
def describe_change(old_entry, new_entry):
371
"""Describe the change between old_entry and this.
373
This smells of being an InterInventoryEntry situation, but as its
374
the first one, we're making it a static method for now.
376
An entry with a different parent, or different name is considered
377
to be renamed. Reparenting is an internal detail.
378
Note that renaming the parent does not trigger a rename for the
381
# TODO: Perhaps return an object rather than just a string
382
if old_entry is new_entry:
383
# also the case of both being None
385
elif old_entry is None:
387
elif new_entry is None:
389
if old_entry.kind != new_entry.kind:
391
text_modified, meta_modified = new_entry.detect_changes(old_entry)
392
if text_modified or meta_modified:
396
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
397
if old_entry.parent_id != new_entry.parent_id:
399
elif old_entry.name != new_entry.name:
403
if renamed and not modified:
404
return InventoryEntry.RENAMED
405
if modified and not renamed:
407
if modified and renamed:
408
return InventoryEntry.MODIFIED_AND_RENAMED
412
return ("%s(%r, %r, parent_id=%r, revision=%r)"
413
% (self.__class__.__name__,
419
def snapshot(self, revision, path, previous_entries,
420
work_tree, commit_builder):
421
"""Make a snapshot of this entry which may or may not have changed.
423
This means that all its fields are populated, that it has its
424
text stored in the text store or weave.
426
# mutter('new parents of %s are %r', path, previous_entries)
427
self._read_tree_state(path, work_tree)
428
# TODO: Where should we determine whether to reuse a
429
# previous revision id or create a new revision? 20060606
430
if len(previous_entries) == 1:
431
# cannot be unchanged unless there is only one parent file rev.
432
parent_ie = previous_entries.values()[0]
433
if self._unchanged(parent_ie):
434
# mutter("found unchanged entry")
435
self.revision = parent_ie.revision
437
return self._snapshot_into_revision(revision, previous_entries,
438
work_tree, commit_builder)
440
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
442
"""Record this revision unconditionally into a store.
444
The entry's last-changed revision property (`revision`) is updated to
445
that of the new revision.
447
:param revision: id of the new revision that is being recorded.
449
:returns: String description of the commit (e.g. "merged", "modified"), etc.
451
# mutter('new revision {%s} for {%s}', revision, self.file_id)
452
self.revision = revision
453
self._snapshot_text(previous_entries, work_tree, commit_builder)
455
def _snapshot_text(self, file_parents, work_tree, commit_builder):
456
"""Record the 'text' of this entry, whatever form that takes.
458
This default implementation simply adds an empty text.
460
raise NotImplementedError(self._snapshot_text)
462
def __eq__(self, other):
463
if not isinstance(other, InventoryEntry):
464
return NotImplemented
466
return ((self.file_id == other.file_id)
467
and (self.name == other.name)
468
and (other.symlink_target == self.symlink_target)
469
and (self.text_sha1 == other.text_sha1)
470
and (self.text_size == other.text_size)
471
and (self.text_id == other.text_id)
472
and (self.parent_id == other.parent_id)
473
and (self.kind == other.kind)
474
and (self.revision == other.revision)
475
and (self.executable == other.executable)
478
def __ne__(self, other):
479
return not (self == other)
482
raise ValueError('not hashable')
484
def _unchanged(self, previous_ie):
485
"""Has this entry changed relative to previous_ie.
487
This method should be overridden in child classes.
490
# different inv parent
491
if previous_ie.parent_id != self.parent_id:
494
elif previous_ie.name != self.name:
498
def _read_tree_state(self, path, work_tree):
499
"""Populate fields in the inventory entry from the given tree.
501
Note that this should be modified to be a noop on virtual trees
502
as all entries created there are prepopulated.
504
# TODO: Rather than running this manually, we should check the
505
# working sha1 and other expensive properties when they're
506
# first requested, or preload them if they're already known
507
pass # nothing to do by default
509
def _forget_tree_state(self):
513
class RootEntry(InventoryEntry):
515
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
516
'text_id', 'parent_id', 'children', 'executable',
517
'revision', 'symlink_target']
519
def _check(self, checker, rev_id, tree):
520
"""See InventoryEntry._check"""
522
def __init__(self, file_id):
523
self.file_id = file_id
525
self.kind = 'directory'
526
self.parent_id = None
529
symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
530
' Please use InventoryDirectory instead.',
531
DeprecationWarning, stacklevel=2)
533
def __eq__(self, other):
534
if not isinstance(other, RootEntry):
535
return NotImplemented
537
return (self.file_id == other.file_id) \
538
and (self.children == other.children)
541
class InventoryDirectory(InventoryEntry):
542
"""A directory in an inventory."""
544
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
545
'text_id', 'parent_id', 'children', 'executable',
546
'revision', 'symlink_target']
548
def _check(self, checker, rev_id, tree):
549
"""See InventoryEntry._check"""
550
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
551
raise BzrCheckError('directory {%s} has text in revision {%s}'
552
% (self.file_id, rev_id))
555
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
556
other.revision = self.revision
557
# note that children are *not* copied; they're pulled across when
561
def __init__(self, file_id, name, parent_id):
562
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
564
self.kind = 'directory'
566
def kind_character(self):
567
"""See InventoryEntry.kind_character."""
570
def _put_in_tar(self, item, tree):
571
"""See InventoryEntry._put_in_tar."""
572
item.type = tarfile.DIRTYPE
579
def _put_on_disk(self, fullpath, tree):
580
"""See InventoryEntry._put_on_disk."""
583
def _snapshot_text(self, file_parents, work_tree, commit_builder):
584
"""See InventoryEntry._snapshot_text."""
585
commit_builder.modified_directory(self.file_id, file_parents)
588
class InventoryFile(InventoryEntry):
589
"""A file in an inventory."""
591
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
592
'text_id', 'parent_id', 'children', 'executable',
593
'revision', 'symlink_target']
595
def _check(self, checker, tree_revision_id, tree):
596
"""See InventoryEntry._check"""
597
t = (self.file_id, self.revision)
598
if t in checker.checked_texts:
599
prev_sha = checker.checked_texts[t]
600
if prev_sha != self.text_sha1:
601
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
602
(self.file_id, tree_revision_id))
604
checker.repeated_text_cnt += 1
607
if self.file_id not in checker.checked_weaves:
608
mutter('check weave {%s}', self.file_id)
609
w = tree.get_weave(self.file_id)
610
# Not passing a progress bar, because it creates a new
611
# progress, which overwrites the current progress,
612
# and doesn't look nice
614
checker.checked_weaves[self.file_id] = True
616
w = tree.get_weave(self.file_id)
618
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
619
checker.checked_text_cnt += 1
620
# We can't check the length, because Weave doesn't store that
621
# information, and the whole point of looking at the weave's
622
# sha1sum is that we don't have to extract the text.
623
if self.text_sha1 != w.get_sha1(self.revision):
624
raise BzrCheckError('text {%s} version {%s} wrong sha1'
625
% (self.file_id, self.revision))
626
checker.checked_texts[t] = self.text_sha1
629
other = InventoryFile(self.file_id, self.name, self.parent_id)
630
other.executable = self.executable
631
other.text_id = self.text_id
632
other.text_sha1 = self.text_sha1
633
other.text_size = self.text_size
634
other.revision = self.revision
637
def detect_changes(self, old_entry):
638
"""See InventoryEntry.detect_changes."""
639
assert self.text_sha1 is not None
640
assert old_entry.text_sha1 is not None
641
text_modified = (self.text_sha1 != old_entry.text_sha1)
642
meta_modified = (self.executable != old_entry.executable)
643
return text_modified, meta_modified
645
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
646
output_to, reverse=False):
647
"""See InventoryEntry._diff."""
649
from_text = tree.get_file(self.file_id).readlines()
651
to_text = to_tree.get_file(to_entry.file_id).readlines()
655
text_diff(from_label, from_text,
656
to_label, to_text, output_to)
658
text_diff(to_label, to_text,
659
from_label, from_text, output_to)
660
except errors.BinaryFile:
662
label_pair = (to_label, from_label)
664
label_pair = (from_label, to_label)
665
print >> output_to, "Binary files %s and %s differ" % label_pair
668
"""See InventoryEntry.has_text."""
671
def __init__(self, file_id, name, parent_id):
672
super(InventoryFile, self).__init__(file_id, name, parent_id)
675
def kind_character(self):
676
"""See InventoryEntry.kind_character."""
679
def _put_in_tar(self, item, tree):
680
"""See InventoryEntry._put_in_tar."""
681
item.type = tarfile.REGTYPE
682
fileobj = tree.get_file(self.file_id)
683
item.size = self.text_size
684
if tree.is_executable(self.file_id):
690
def _put_on_disk(self, fullpath, tree):
691
"""See InventoryEntry._put_on_disk."""
692
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
693
if tree.is_executable(self.file_id):
694
os.chmod(fullpath, 0755)
696
def _read_tree_state(self, path, work_tree):
697
"""See InventoryEntry._read_tree_state."""
698
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
699
# FIXME: 20050930 probe for the text size when getting sha1
700
# in _read_tree_state
701
self.executable = work_tree.is_executable(self.file_id, path=path)
704
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
705
% (self.__class__.__name__,
712
def _forget_tree_state(self):
713
self.text_sha1 = None
715
def _snapshot_text(self, file_parents, work_tree, commit_builder):
716
"""See InventoryEntry._snapshot_text."""
717
def get_content_byte_lines():
718
return work_tree.get_file(self.file_id).readlines()
719
self.text_sha1, self.text_size = commit_builder.modified_file_text(
720
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
722
def _unchanged(self, previous_ie):
723
"""See InventoryEntry._unchanged."""
724
compatible = super(InventoryFile, self)._unchanged(previous_ie)
725
if self.text_sha1 != previous_ie.text_sha1:
728
# FIXME: 20050930 probe for the text size when getting sha1
729
# in _read_tree_state
730
self.text_size = previous_ie.text_size
731
if self.executable != previous_ie.executable:
736
class InventoryLink(InventoryEntry):
737
"""A file in an inventory."""
739
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
740
'text_id', 'parent_id', 'children', 'executable',
741
'revision', 'symlink_target']
743
def _check(self, checker, rev_id, tree):
744
"""See InventoryEntry._check"""
745
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
746
raise BzrCheckError('symlink {%s} has text in revision {%s}'
747
% (self.file_id, rev_id))
748
if self.symlink_target is None:
749
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
750
% (self.file_id, rev_id))
753
other = InventoryLink(self.file_id, self.name, self.parent_id)
754
other.symlink_target = self.symlink_target
755
other.revision = self.revision
758
def detect_changes(self, old_entry):
759
"""See InventoryEntry.detect_changes."""
760
# FIXME: which _modified field should we use ? RBC 20051003
761
text_modified = (self.symlink_target != old_entry.symlink_target)
763
mutter(" symlink target changed")
764
meta_modified = False
765
return text_modified, meta_modified
767
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
768
output_to, reverse=False):
769
"""See InventoryEntry._diff."""
770
from_text = self.symlink_target
771
if to_entry is not None:
772
to_text = to_entry.symlink_target
777
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
780
print >>output_to, '=== target was %r' % self.symlink_target
782
print >>output_to, '=== target is %r' % self.symlink_target
784
def __init__(self, file_id, name, parent_id):
785
super(InventoryLink, self).__init__(file_id, name, parent_id)
786
self.kind = 'symlink'
788
def kind_character(self):
789
"""See InventoryEntry.kind_character."""
792
def _put_in_tar(self, item, tree):
793
"""See InventoryEntry._put_in_tar."""
794
item.type = tarfile.SYMTYPE
798
item.linkname = self.symlink_target
801
def _put_on_disk(self, fullpath, tree):
802
"""See InventoryEntry._put_on_disk."""
804
os.symlink(self.symlink_target, fullpath)
806
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
808
def _read_tree_state(self, path, work_tree):
809
"""See InventoryEntry._read_tree_state."""
810
self.symlink_target = work_tree.get_symlink_target(self.file_id)
812
def _forget_tree_state(self):
813
self.symlink_target = None
815
def _unchanged(self, previous_ie):
816
"""See InventoryEntry._unchanged."""
817
compatible = super(InventoryLink, self)._unchanged(previous_ie)
818
if self.symlink_target != previous_ie.symlink_target:
822
def _snapshot_text(self, file_parents, work_tree, commit_builder):
823
"""See InventoryEntry._snapshot_text."""
824
commit_builder.modified_link(
825
self.file_id, file_parents, self.symlink_target)
828
class Inventory(object):
829
"""Inventory of versioned files in a tree.
831
This describes which file_id is present at each point in the tree,
832
and possibly the SHA-1 or other information about the file.
833
Entries can be looked up either by path or by file_id.
835
The inventory represents a typical unix file tree, with
836
directories containing files and subdirectories. We never store
837
the full path to a file, because renaming a directory implicitly
838
moves all of its contents. This class internally maintains a
839
lookup tree that allows the children under a directory to be
842
InventoryEntry objects must not be modified after they are
843
inserted, other than through the Inventory API.
845
>>> inv = Inventory()
846
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
847
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
848
>>> inv['123-123'].name
851
May be treated as an iterator or set to look up file ids:
853
>>> bool(inv.path2id('hello.c'))
858
May also look up by name:
860
>>> [x[0] for x in inv.iter_entries()]
862
>>> inv = Inventory('TREE_ROOT-12345678-12345678')
863
>>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
864
Traceback (most recent call last):
865
BzrError: parent_id {TREE_ROOT} not in inventory
866
>>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
867
InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
869
def __init__(self, root_id=ROOT_ID, revision_id=None):
870
"""Create or read an inventory.
872
If a working directory is specified, the inventory is read
873
from there. If the file is specified, read from that. If not,
874
the inventory is created empty.
876
The inventory is created with a default root directory, with
879
if root_id is not None:
880
assert root_id.__class__ == str
881
self._set_root(InventoryDirectory(root_id, u'', None))
885
self.revision_id = revision_id
887
def _set_root(self, ie):
889
self._byid = {self.root.file_id: self.root}
892
# TODO: jam 20051218 Should copy also copy the revision_id?
893
entries = self.iter_entries()
894
other = Inventory(entries.next()[1].file_id)
895
# copy recursively so we know directories will be added before
896
# their children. There are more efficient ways than this...
897
for path, entry in entries():
898
other.add(entry.copy())
902
return iter(self._byid)
905
"""Returns number of entries."""
906
return len(self._byid)
908
def iter_entries(self, from_dir=None):
909
"""Return (path, entry) pairs, in order by name."""
911
if self.root is None:
915
elif isinstance(from_dir, basestring):
916
from_dir = self._byid[from_dir]
918
# unrolling the recursive called changed the time from
919
# 440ms/663ms (inline/total) to 116ms/116ms
920
children = from_dir.children.items()
922
children = collections.deque(children)
923
stack = [(u'', children)]
925
from_dir_relpath, children = stack[-1]
928
name, ie = children.popleft()
930
# we know that from_dir_relpath never ends in a slash
931
# and 'f' doesn't begin with one, we can do a string op, rather
932
# than the checks of pathjoin(), though this means that all paths
934
path = from_dir_relpath + '/' + name
938
if ie.kind != 'directory':
941
# But do this child first
942
new_children = ie.children.items()
944
new_children = collections.deque(new_children)
945
stack.append((path, new_children))
946
# Break out of inner loop, so that we start outer loop with child
949
# if we finished all children, pop it off the stack
952
def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
953
"""Iterate over the entries in a directory first order.
955
This returns all entries for a directory before returning
956
the entries for children of a directory. This is not
957
lexicographically sorted order, and is a hybrid between
958
depth-first and breadth-first.
960
:return: This yields (path, entry) pairs
962
if specific_file_ids:
963
safe = osutils.safe_file_id
964
specific_file_ids = set(safe(fid) for fid in specific_file_ids)
965
# TODO? Perhaps this should return the from_dir so that the root is
966
# yielded? or maybe an option?
968
if self.root is None:
970
# Optimize a common case
971
if specific_file_ids is not None and len(specific_file_ids) == 1:
972
file_id = list(specific_file_ids)[0]
974
yield self.id2path(file_id), self[file_id]
977
if (specific_file_ids is None or
978
self.root.file_id in specific_file_ids):
980
elif isinstance(from_dir, basestring):
981
from_dir = self._byid[from_dir]
983
if specific_file_ids is not None:
984
# TODO: jam 20070302 This could really be done as a loop rather
985
# than a bunch of recursive calls.
988
def add_ancestors(file_id):
989
if file_id not in byid:
991
parent_id = byid[file_id].parent_id
992
if parent_id is None:
994
if parent_id not in parents:
995
parents.add(parent_id)
996
add_ancestors(parent_id)
997
for file_id in specific_file_ids:
998
add_ancestors(file_id)
1002
stack = [(u'', from_dir)]
1004
cur_relpath, cur_dir = stack.pop()
1007
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
1009
child_relpath = cur_relpath + child_name
1011
if (specific_file_ids is None or
1012
child_ie.file_id in specific_file_ids):
1013
yield child_relpath, child_ie
1015
if child_ie.kind == 'directory':
1016
if parents is None or child_ie.file_id in parents:
1017
child_dirs.append((child_relpath+'/', child_ie))
1018
stack.extend(reversed(child_dirs))
1021
"""Return list of (path, ie) for all entries except the root.
1023
This may be faster than iter_entries.
1026
def descend(dir_ie, dir_path):
1027
kids = dir_ie.children.items()
1029
for name, ie in kids:
1030
child_path = osutils.pathjoin(dir_path, name)
1031
accum.append((child_path, ie))
1032
if ie.kind == 'directory':
1033
descend(ie, child_path)
1035
descend(self.root, u'')
1038
def directories(self):
1039
"""Return (path, entry) pairs for all directories, including the root.
1042
def descend(parent_ie, parent_path):
1043
accum.append((parent_path, parent_ie))
1045
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
1048
for name, child_ie in kids:
1049
child_path = osutils.pathjoin(parent_path, name)
1050
descend(child_ie, child_path)
1051
descend(self.root, u'')
1054
def __contains__(self, file_id):
1055
"""True if this entry contains a file with given id.
1057
>>> inv = Inventory()
1058
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1059
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1065
file_id = osutils.safe_file_id(file_id)
1066
return (file_id in self._byid)
1068
def __getitem__(self, file_id):
1069
"""Return the entry for given file_id.
1071
>>> inv = Inventory()
1072
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1073
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
1074
>>> inv['123123'].name
1077
file_id = osutils.safe_file_id(file_id)
1079
return self._byid[file_id]
1081
# really we're passing an inventory, not a tree...
1082
raise errors.NoSuchId(self, file_id)
1084
def get_file_kind(self, file_id):
1085
file_id = osutils.safe_file_id(file_id)
1086
return self._byid[file_id].kind
1088
def get_child(self, parent_id, filename):
1089
parent_id = osutils.safe_file_id(parent_id)
1090
return self[parent_id].children.get(filename)
1092
def add(self, entry):
1093
"""Add entry to inventory.
1095
To add a file to a branch ready to be committed, use Branch.add,
1098
Returns the new entry object.
1100
if entry.file_id in self._byid:
1101
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
1103
if entry.parent_id is None:
1104
assert self.root is None and len(self._byid) == 0
1105
self._set_root(entry)
1108
parent = self._byid[entry.parent_id]
1110
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
1112
if entry.name in parent.children:
1113
raise BzrError("%s is already versioned" %
1114
osutils.pathjoin(self.id2path(parent.file_id), entry.name))
1116
self._byid[entry.file_id] = entry
1117
parent.children[entry.name] = entry
1120
def add_path(self, relpath, kind, file_id=None, parent_id=None):
1121
"""Add entry from a path.
1123
The immediate parent must already be versioned.
1125
Returns the new entry object."""
1127
parts = osutils.splitpath(relpath)
1131
file_id = generate_ids.gen_root_id()
1133
file_id = osutils.safe_file_id(file_id)
1134
self.root = InventoryDirectory(file_id, '', None)
1135
self._byid = {self.root.file_id: self.root}
1138
parent_path = parts[:-1]
1139
parent_id = self.path2id(parent_path)
1140
if parent_id is None:
1141
raise errors.NotVersionedError(path=parent_path)
1142
ie = make_entry(kind, parts[-1], parent_id, file_id)
1145
def __delitem__(self, file_id):
1146
"""Remove entry by id.
1148
>>> inv = Inventory()
1149
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1150
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1157
file_id = osutils.safe_file_id(file_id)
1160
assert ie.parent_id is None or \
1161
self[ie.parent_id].children[ie.name] == ie
1163
del self._byid[file_id]
1164
if ie.parent_id is not None:
1165
del self[ie.parent_id].children[ie.name]
1167
def __eq__(self, other):
1168
"""Compare two sets by comparing their contents.
1170
>>> i1 = Inventory()
1171
>>> i2 = Inventory()
1174
>>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1175
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1178
>>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1179
InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1183
if not isinstance(other, Inventory):
1184
return NotImplemented
1186
return self._byid == other._byid
1188
def __ne__(self, other):
1189
return not self.__eq__(other)
1192
raise ValueError('not hashable')
1194
def _iter_file_id_parents(self, file_id):
1195
"""Yield the parents of file_id up to the root."""
1196
file_id = osutils.safe_file_id(file_id)
1197
while file_id is not None:
1199
ie = self._byid[file_id]
1201
raise BzrError("file_id {%s} not found in inventory" % file_id)
1203
file_id = ie.parent_id
1205
def get_idpath(self, file_id):
1206
"""Return a list of file_ids for the path to an entry.
1208
The list contains one element for each directory followed by
1209
the id of the file itself. So the length of the returned list
1210
is equal to the depth of the file in the tree, counting the
1211
root directory as depth 1.
1213
file_id = osutils.safe_file_id(file_id)
1215
for parent in self._iter_file_id_parents(file_id):
1216
p.insert(0, parent.file_id)
1219
def id2path(self, file_id):
1220
"""Return as a string the path to file_id.
1223
>>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1224
>>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1225
>>> print i.id2path('foo-id')
1228
file_id = osutils.safe_file_id(file_id)
1229
# get all names, skipping root
1230
return '/'.join(reversed(
1231
[parent.name for parent in
1232
self._iter_file_id_parents(file_id)][:-1]))
1234
def path2id(self, name):
1235
"""Walk down through directories to return entry of last component.
1237
names may be either a list of path components, or a single
1238
string, in which case it is automatically split.
1240
This returns the entry of the last component in the path,
1241
which may be either a file or a directory.
1243
Returns None IFF the path is not found.
1245
if isinstance(name, basestring):
1246
name = osutils.splitpath(name)
1248
# mutter("lookup path %r" % name)
1255
children = getattr(parent, 'children', None)
1256
if children is None:
1259
assert cie.name == f
1260
assert cie.parent_id == parent.file_id
1263
# or raise an error?
1266
return parent.file_id
1268
def has_filename(self, names):
1269
return bool(self.path2id(names))
1271
def has_id(self, file_id):
1272
file_id = osutils.safe_file_id(file_id)
1273
return (file_id in self._byid)
1275
def remove_recursive_id(self, file_id):
1276
"""Remove file_id, and children, from the inventory.
1278
:param file_id: A file_id to remove.
1280
file_id = osutils.safe_file_id(file_id)
1281
to_find_delete = [self._byid[file_id]]
1283
while to_find_delete:
1284
ie = to_find_delete.pop()
1285
to_delete.append(ie.file_id)
1286
if ie.kind == 'directory':
1287
to_find_delete.extend(ie.children.values())
1288
for file_id in reversed(to_delete):
1290
del self._byid[file_id]
1291
if ie.parent_id is not None:
1292
del self[ie.parent_id].children[ie.name]
1294
def rename(self, file_id, new_parent_id, new_name):
1295
"""Move a file within the inventory.
1297
This can change either the name, or the parent, or both.
1299
This does not move the working file.
1301
file_id = osutils.safe_file_id(file_id)
1302
if not is_valid_name(new_name):
1303
raise BzrError("not an acceptable filename: %r" % new_name)
1305
new_parent = self._byid[new_parent_id]
1306
if new_name in new_parent.children:
1307
raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1309
new_parent_idpath = self.get_idpath(new_parent_id)
1310
if file_id in new_parent_idpath:
1311
raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
1312
% (self.id2path(file_id), self.id2path(new_parent_id)))
1314
file_ie = self._byid[file_id]
1315
old_parent = self._byid[file_ie.parent_id]
1317
# TODO: Don't leave things messed up if this fails
1319
del old_parent.children[file_ie.name]
1320
new_parent.children[new_name] = file_ie
1322
file_ie.name = new_name
1323
file_ie.parent_id = new_parent_id
1325
def is_root(self, file_id):
1326
file_id = osutils.safe_file_id(file_id)
1327
return self.root is not None and file_id == self.root.file_id
1330
def make_entry(kind, name, parent_id, file_id=None):
1331
"""Create an inventory entry.
1333
:param kind: the type of inventory entry to create.
1334
:param name: the basename of the entry.
1335
:param parent_id: the parent_id of the entry.
1336
:param file_id: the file_id to use. if None, one will be created.
1339
file_id = generate_ids.gen_file_id(name)
1341
file_id = osutils.safe_file_id(file_id)
1343
norm_name, can_access = osutils.normalized_filename(name)
1344
if norm_name != name:
1348
# TODO: jam 20060701 This would probably be more useful
1349
# if the error was raised with the full path
1350
raise errors.InvalidNormalization(name)
1352
if kind == 'directory':
1353
return InventoryDirectory(file_id, name, parent_id)
1354
elif kind == 'file':
1355
return InventoryFile(file_id, name, parent_id)
1356
elif kind == 'symlink':
1357
return InventoryLink(file_id, name, parent_id)
1359
raise BzrError("unknown kind %r" % kind)
1364
def is_valid_name(name):
1366
if _NAME_RE is None:
1367
_NAME_RE = re.compile(r'^[^/\\]+$')
1369
return bool(_NAME_RE.match(name))
added
removed
bzrlib/inventory.py
