1
# (C) 2005 Canonical Ltd
1
# Copyright (C) 2005, 2006 Canonical Ltd
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
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.
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
23
import sys, os.path, types, re
27
from cElementTree import Element, ElementTree, SubElement
29
from elementtree.ElementTree import Element, ElementTree, SubElement
31
from xml import XMLMixin
32
from errors import bailout, BzrError, BzrCheckError
34
from bzrlib.lazy_import import lazy_import
35
lazy_import(globals(), """
35
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
47
from bzrlib.errors import (
36
51
from bzrlib.trace import mutter
38
class InventoryEntry(XMLMixin):
54
class InventoryEntry(object):
39
55
"""Description of a versioned file.
41
57
An InventoryEntry has the following fields, which are also
42
58
present in the XML inventory-entry element:
45
* *name*: (only the basename within the directory, must not
47
* *kind*: "directory" or "file"
48
* *directory_id*: (if absent/null means the branch root directory)
49
* *text_sha1*: only for files
50
* *text_size*: in bytes, only for files
51
* *text_id*: identifier for the text version, only for files
53
InventoryEntries can also exist inside a WorkingTree
54
inventory, in which case they are not yet bound to a
55
particular revision of the file. In that case the text_sha1,
56
text_size and text_id are absent.
63
(within the parent directory)
66
file_id of the parent directory, or ROOT_ID
69
the revision_id in which this variation of this file was
73
Indicates that this file should be executable on systems
77
sha-1 of the text of the file
80
size in bytes of the text of the file
82
(reading a version 4 tree created a text_id field.)
59
84
>>> i = Inventory()
62
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
63
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
64
>>> for j in i.iter_entries():
87
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
88
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
89
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
90
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
91
>>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
92
>>> for ix, j in enumerate(i.iter_entries()):
93
... print (j[0] == shouldbe[ix], j[1])
67
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
68
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
69
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
95
(True, InventoryDirectory('TREE_ROOT', '', parent_id=None, revision=None))
96
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
97
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
98
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
70
99
Traceback (most recent call last):
72
BzrError: ('inventory already contains entry with id {2323}', [])
73
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
74
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
101
BzrError: inventory already contains entry with id {2323}
102
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
103
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
104
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
105
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
75
106
>>> i.path2id('src/wibble')
79
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
110
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
111
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
81
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
>>> for j in i.iter_entries():
84
... assert i.path2id(j[0])
113
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
114
>>> for path, entry in i.iter_entries():
116
... assert i.path2id(path)
90
123
src/wibble/wibble.c
91
124
>>> i.id2path('2326')
92
125
'src/wibble/wibble.c'
94
TODO: Maybe also keep the full path of the entry, and the children?
95
But those depend on its position within a particular inventory, and
96
it would be nice not to need to hold the backpointer here.
99
# TODO: split InventoryEntry into subclasses for files,
100
# directories, etc etc.
128
# Constants returned by describe_change()
130
# TODO: These should probably move to some kind of FileChangeDescription
131
# class; that's like what's inside a TreeDelta but we want to be able to
132
# generate them just for one file at a time.
134
MODIFIED_AND_RENAMED = 'modified and renamed'
105
def __init__(self, file_id, name, kind, parent_id, text_id=None):
138
def detect_changes(self, old_entry):
139
"""Return a (text_modified, meta_modified) from this to old_entry.
141
_read_tree_state must have been called on self and old_entry prior to
142
calling detect_changes.
146
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
147
output_to, reverse=False):
148
"""Perform a diff from this to to_entry.
150
text_diff will be used for textual difference calculation.
151
This is a template method, override _diff in child classes.
153
self._read_tree_state(tree.id2path(self.file_id), tree)
155
# cannot diff from one kind to another - you must do a removal
156
# and an addif they do not match.
157
assert self.kind == to_entry.kind
158
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
160
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
163
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
164
output_to, reverse=False):
165
"""Perform a diff between two entries of the same kind."""
167
def find_previous_heads(self, previous_inventories,
168
versioned_file_store,
171
"""Return the revisions and entries that directly precede this.
173
Returned as a map from revision to inventory entry.
175
This is a map containing the file revisions in all parents
176
for which the file exists, and its revision is not a parent of
177
any other. If the file is new, the set will be empty.
179
:param versioned_file_store: A store where ancestry data on this
180
file id can be queried.
181
:param transaction: The transaction that queries to the versioned
182
file store should be completed under.
183
:param entry_vf: The entry versioned file, if its already available.
185
def get_ancestors(weave, entry):
186
return set(weave.get_ancestry(entry.revision))
187
# revision:ie mapping for each ie found in previous_inventories.
189
# revision:ie mapping with one revision for each head.
191
# revision: ancestor list for each head
193
# identify candidate head revision ids.
194
for inv in previous_inventories:
195
if self.file_id in inv:
196
ie = inv[self.file_id]
197
assert ie.file_id == self.file_id
198
if ie.revision in candidates:
199
# same revision value in two different inventories:
200
# correct possible inconsistencies:
201
# * there was a bug in revision updates with 'x' bit
204
if candidates[ie.revision].executable != ie.executable:
205
candidates[ie.revision].executable = False
206
ie.executable = False
207
except AttributeError:
209
# must now be the same.
210
assert candidates[ie.revision] == ie
212
# add this revision as a candidate.
213
candidates[ie.revision] = ie
215
# common case optimisation
216
if len(candidates) == 1:
217
# if there is only one candidate revision found
218
# then we can opening the versioned file to access ancestry:
219
# there cannot be any ancestors to eliminate when there is
220
# only one revision available.
221
heads[ie.revision] = ie
224
# eliminate ancestors amongst the available candidates:
225
# heads are those that are not an ancestor of any other candidate
226
# - this provides convergence at a per-file level.
227
for ie in candidates.values():
228
# may be an ancestor of a known head:
229
already_present = 0 != len(
230
[head for head in heads
231
if ie.revision in head_ancestors[head]])
233
# an ancestor of an analyzed candidate.
235
# not an ancestor of a known head:
236
# load the versioned file for this file id if needed
238
entry_vf = versioned_file_store.get_weave_or_empty(
239
self.file_id, transaction)
240
ancestors = get_ancestors(entry_vf, ie)
241
# may knock something else out:
242
check_heads = list(heads.keys())
243
for head in check_heads:
244
if head in ancestors:
245
# this previously discovered 'head' is not
246
# really a head - its an ancestor of the newly
249
head_ancestors[ie.revision] = ancestors
250
heads[ie.revision] = ie
253
def get_tar_item(self, root, dp, now, tree):
254
"""Get a tarfile item and a file stream for its content."""
255
item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
256
# TODO: would be cool to actually set it to the timestamp of the
257
# revision it was last changed
259
fileobj = self._put_in_tar(item, tree)
263
"""Return true if the object this entry represents has textual data.
265
Note that textual data includes binary content.
267
Also note that all entries get weave files created for them.
268
This attribute is primarily used when upgrading from old trees that
269
did not have the weave index for all inventory entries.
273
def __init__(self, file_id, name, parent_id, text_id=None):
106
274
"""Create an InventoryEntry
108
276
The filename must be a single component, relative to the
109
277
parent directory; it cannot be a whole path or relative name.
111
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
279
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
116
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
284
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
117
285
Traceback (most recent call last):
118
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
286
InvalidEntryName: Invalid entry name: src/hello.c
288
assert isinstance(name, basestring), name
120
289
if '/' in name or '\\' in name:
121
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
290
raise errors.InvalidEntryName(name=name)
291
self.executable = False
293
self.text_sha1 = None
294
self.text_size = None
123
295
self.file_id = file_id
126
297
self.text_id = text_id
127
298
self.parent_id = parent_id
128
if kind == 'directory':
133
raise BzrError("unhandled entry kind %r" % kind)
299
self.symlink_target = None
301
def kind_character(self):
302
"""Return a short kind indicator useful for appending to names."""
303
raise BzrError('unknown kind %r' % self.kind)
305
known_kinds = ('file', 'directory', 'symlink')
307
def _put_in_tar(self, item, tree):
308
"""populate item for stashing in a tar, and return the content stream.
310
If no content is available, return None.
312
raise BzrError("don't know how to export {%s} of kind %r" %
313
(self.file_id, self.kind))
315
def put_on_disk(self, dest, dp, tree):
316
"""Create a representation of self on disk in the prefix dest.
318
This is a template method - implement _put_on_disk in subclasses.
320
fullpath = osutils.pathjoin(dest, dp)
321
self._put_on_disk(fullpath, tree)
322
# mutter(" export {%s} kind %s to %s", self.file_id,
323
# self.kind, fullpath)
325
def _put_on_disk(self, fullpath, tree):
326
"""Put this entry onto disk at fullpath, from tree tree."""
327
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
137
329
def sorted_children(self):
138
l = self.children.items()
330
return sorted(self.children.items())
333
def versionable_kind(kind):
334
return (kind in ('file', 'directory', 'symlink'))
336
def check(self, checker, rev_id, inv, tree):
337
"""Check this inventory entry is intact.
339
This is a template method, override _check for kind specific
342
:param checker: Check object providing context for the checks;
343
can be used to find out what parts of the repository have already
345
:param rev_id: Revision id from which this InventoryEntry was loaded.
346
Not necessarily the last-changed revision for this file.
347
:param inv: Inventory from which the entry was loaded.
348
:param tree: RevisionTree for this entry.
350
if self.parent_id is not None:
351
if not inv.has_id(self.parent_id):
352
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
353
% (self.parent_id, rev_id))
354
self._check(checker, rev_id, tree)
356
def _check(self, checker, rev_id, tree):
357
"""Check this inventory entry for kind specific errors."""
358
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
144
other = InventoryEntry(self.file_id, self.name, self.kind,
145
self.parent_id, text_id=self.text_id)
146
other.text_sha1 = self.text_sha1
147
other.text_size = self.text_size
362
"""Clone this inventory entry."""
363
raise NotImplementedError
366
def describe_change(old_entry, new_entry):
367
"""Describe the change between old_entry and this.
369
This smells of being an InterInventoryEntry situation, but as its
370
the first one, we're making it a static method for now.
372
An entry with a different parent, or different name is considered
373
to be renamed. Reparenting is an internal detail.
374
Note that renaming the parent does not trigger a rename for the
377
# TODO: Perhaps return an object rather than just a string
378
if old_entry is new_entry:
379
# also the case of both being None
381
elif old_entry is None:
383
elif new_entry is None:
385
text_modified, meta_modified = new_entry.detect_changes(old_entry)
386
if text_modified or meta_modified:
390
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
391
if old_entry.parent_id != new_entry.parent_id:
393
elif old_entry.name != new_entry.name:
397
if renamed and not modified:
398
return InventoryEntry.RENAMED
399
if modified and not renamed:
401
if modified and renamed:
402
return InventoryEntry.MODIFIED_AND_RENAMED
151
405
def __repr__(self):
152
return ("%s(%r, %r, kind=%r, parent_id=%r)"
406
return ("%s(%r, %r, parent_id=%r, revision=%r)"
153
407
% (self.__class__.__name__,
160
def to_element(self):
161
"""Convert to XML element"""
164
e.set('name', self.name)
165
e.set('file_id', self.file_id)
166
e.set('kind', self.kind)
168
if self.text_size != None:
169
e.set('text_size', '%d' % self.text_size)
171
for f in ['text_id', 'text_sha1']:
176
# to be conservative, we don't externalize the root pointers
177
# for now, leaving them as null in the xml form. in a future
178
# version it will be implied by nested elements.
179
if self.parent_id != ROOT_ID:
180
assert isinstance(self.parent_id, basestring)
181
e.set('parent_id', self.parent_id)
188
def from_element(cls, elt):
189
assert elt.tag == 'entry'
191
## original format inventories don't have a parent_id for
192
## nodes in the root directory, but it's cleaner to use one
194
parent_id = elt.get('parent_id')
195
if parent_id == None:
198
self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
199
self.text_id = elt.get('text_id')
200
self.text_sha1 = elt.get('text_sha1')
202
## mutter("read inventoryentry: %r" % (elt.attrib))
204
v = elt.get('text_size')
205
self.text_size = v and int(v)
210
from_element = classmethod(from_element)
212
def __cmp__(self, other):
413
def snapshot(self, revision, path, previous_entries,
414
work_tree, commit_builder):
415
"""Make a snapshot of this entry which may or may not have changed.
417
This means that all its fields are populated, that it has its
418
text stored in the text store or weave.
420
# mutter('new parents of %s are %r', path, previous_entries)
421
self._read_tree_state(path, work_tree)
422
# TODO: Where should we determine whether to reuse a
423
# previous revision id or create a new revision? 20060606
424
if len(previous_entries) == 1:
425
# cannot be unchanged unless there is only one parent file rev.
426
parent_ie = previous_entries.values()[0]
427
if self._unchanged(parent_ie):
428
# mutter("found unchanged entry")
429
self.revision = parent_ie.revision
431
return self._snapshot_into_revision(revision, previous_entries,
432
work_tree, commit_builder)
434
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
436
"""Record this revision unconditionally into a store.
438
The entry's last-changed revision property (`revision`) is updated to
439
that of the new revision.
441
:param revision: id of the new revision that is being recorded.
443
:returns: String description of the commit (e.g. "merged", "modified"), etc.
445
# mutter('new revision {%s} for {%s}', revision, self.file_id)
446
self.revision = revision
447
self._snapshot_text(previous_entries, work_tree, commit_builder)
449
def _snapshot_text(self, file_parents, work_tree, commit_builder):
450
"""Record the 'text' of this entry, whatever form that takes.
452
This default implementation simply adds an empty text.
454
raise NotImplementedError(self._snapshot_text)
456
def __eq__(self, other):
215
457
if not isinstance(other, InventoryEntry):
216
458
return NotImplemented
218
return cmp(self.file_id, other.file_id) \
219
or cmp(self.name, other.name) \
220
or cmp(self.text_sha1, other.text_sha1) \
221
or cmp(self.text_size, other.text_size) \
222
or cmp(self.text_id, other.text_id) \
223
or cmp(self.parent_id, other.parent_id) \
224
or cmp(self.kind, other.kind)
460
return ((self.file_id == other.file_id)
461
and (self.name == other.name)
462
and (other.symlink_target == self.symlink_target)
463
and (self.text_sha1 == other.text_sha1)
464
and (self.text_size == other.text_size)
465
and (self.text_id == other.text_id)
466
and (self.parent_id == other.parent_id)
467
and (self.kind == other.kind)
468
and (self.revision == other.revision)
469
and (self.executable == other.executable)
472
def __ne__(self, other):
473
return not (self == other)
476
raise ValueError('not hashable')
478
def _unchanged(self, previous_ie):
479
"""Has this entry changed relative to previous_ie.
481
This method should be overridden in child classes.
484
# different inv parent
485
if previous_ie.parent_id != self.parent_id:
488
elif previous_ie.name != self.name:
492
def _read_tree_state(self, path, work_tree):
493
"""Populate fields in the inventory entry from the given tree.
495
Note that this should be modified to be a noop on virtual trees
496
as all entries created there are prepopulated.
498
# TODO: Rather than running this manually, we should check the
499
# working sha1 and other expensive properties when they're
500
# first requested, or preload them if they're already known
501
pass # nothing to do by default
503
def _forget_tree_state(self):
228
507
class RootEntry(InventoryEntry):
509
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
510
'text_id', 'parent_id', 'children', 'executable',
511
'revision', 'symlink_target']
513
def _check(self, checker, rev_id, tree):
514
"""See InventoryEntry._check"""
229
516
def __init__(self, file_id):
230
517
self.file_id = file_id
231
518
self.children = {}
232
self.kind = 'root_directory'
519
self.kind = 'directory'
233
520
self.parent_id = None
523
symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
524
' Please use InventoryDirectory instead.',
525
DeprecationWarning, stacklevel=2)
236
def __cmp__(self, other):
527
def __eq__(self, other):
239
528
if not isinstance(other, RootEntry):
240
529
return NotImplemented
241
return cmp(self.file_id, other.file_id) \
242
or cmp(self.children, other.children)
246
class Inventory(XMLMixin):
531
return (self.file_id == other.file_id) \
532
and (self.children == other.children)
535
class InventoryDirectory(InventoryEntry):
536
"""A directory in an inventory."""
538
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
539
'text_id', 'parent_id', 'children', 'executable',
540
'revision', 'symlink_target']
542
def _check(self, checker, rev_id, tree):
543
"""See InventoryEntry._check"""
544
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
545
raise BzrCheckError('directory {%s} has text in revision {%s}'
546
% (self.file_id, rev_id))
549
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
550
other.revision = self.revision
551
# note that children are *not* copied; they're pulled across when
555
def __init__(self, file_id, name, parent_id):
556
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
558
self.kind = 'directory'
560
def kind_character(self):
561
"""See InventoryEntry.kind_character."""
564
def _put_in_tar(self, item, tree):
565
"""See InventoryEntry._put_in_tar."""
566
item.type = tarfile.DIRTYPE
573
def _put_on_disk(self, fullpath, tree):
574
"""See InventoryEntry._put_on_disk."""
577
def _snapshot_text(self, file_parents, work_tree, commit_builder):
578
"""See InventoryEntry._snapshot_text."""
579
commit_builder.modified_directory(self.file_id, file_parents)
582
class InventoryFile(InventoryEntry):
583
"""A file in an inventory."""
585
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
586
'text_id', 'parent_id', 'children', 'executable',
587
'revision', 'symlink_target']
589
def _check(self, checker, tree_revision_id, tree):
590
"""See InventoryEntry._check"""
591
t = (self.file_id, self.revision)
592
if t in checker.checked_texts:
593
prev_sha = checker.checked_texts[t]
594
if prev_sha != self.text_sha1:
595
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
596
(self.file_id, tree_revision_id))
598
checker.repeated_text_cnt += 1
601
if self.file_id not in checker.checked_weaves:
602
mutter('check weave {%s}', self.file_id)
603
w = tree.get_weave(self.file_id)
604
# Not passing a progress bar, because it creates a new
605
# progress, which overwrites the current progress,
606
# and doesn't look nice
608
checker.checked_weaves[self.file_id] = True
610
w = tree.get_weave(self.file_id)
612
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
613
checker.checked_text_cnt += 1
614
# We can't check the length, because Weave doesn't store that
615
# information, and the whole point of looking at the weave's
616
# sha1sum is that we don't have to extract the text.
617
if self.text_sha1 != w.get_sha1(self.revision):
618
raise BzrCheckError('text {%s} version {%s} wrong sha1'
619
% (self.file_id, self.revision))
620
checker.checked_texts[t] = self.text_sha1
623
other = InventoryFile(self.file_id, self.name, self.parent_id)
624
other.executable = self.executable
625
other.text_id = self.text_id
626
other.text_sha1 = self.text_sha1
627
other.text_size = self.text_size
628
other.revision = self.revision
631
def detect_changes(self, old_entry):
632
"""See InventoryEntry.detect_changes."""
633
assert self.text_sha1 is not None
634
assert old_entry.text_sha1 is not None
635
text_modified = (self.text_sha1 != old_entry.text_sha1)
636
meta_modified = (self.executable != old_entry.executable)
637
return text_modified, meta_modified
639
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
640
output_to, reverse=False):
641
"""See InventoryEntry._diff."""
643
from_text = tree.get_file(self.file_id).readlines()
645
to_text = to_tree.get_file(to_entry.file_id).readlines()
649
text_diff(from_label, from_text,
650
to_label, to_text, output_to)
652
text_diff(to_label, to_text,
653
from_label, from_text, output_to)
654
except errors.BinaryFile:
656
label_pair = (to_label, from_label)
658
label_pair = (from_label, to_label)
659
print >> output_to, "Binary files %s and %s differ" % label_pair
662
"""See InventoryEntry.has_text."""
665
def __init__(self, file_id, name, parent_id):
666
super(InventoryFile, self).__init__(file_id, name, parent_id)
669
def kind_character(self):
670
"""See InventoryEntry.kind_character."""
673
def _put_in_tar(self, item, tree):
674
"""See InventoryEntry._put_in_tar."""
675
item.type = tarfile.REGTYPE
676
fileobj = tree.get_file(self.file_id)
677
item.size = self.text_size
678
if tree.is_executable(self.file_id):
684
def _put_on_disk(self, fullpath, tree):
685
"""See InventoryEntry._put_on_disk."""
686
osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
687
if tree.is_executable(self.file_id):
688
os.chmod(fullpath, 0755)
690
def _read_tree_state(self, path, work_tree):
691
"""See InventoryEntry._read_tree_state."""
692
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
693
# FIXME: 20050930 probe for the text size when getting sha1
694
# in _read_tree_state
695
self.executable = work_tree.is_executable(self.file_id, path=path)
698
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
699
% (self.__class__.__name__,
706
def _forget_tree_state(self):
707
self.text_sha1 = None
709
def _snapshot_text(self, file_parents, work_tree, commit_builder):
710
"""See InventoryEntry._snapshot_text."""
711
def get_content_byte_lines():
712
return work_tree.get_file(self.file_id).readlines()
713
self.text_sha1, self.text_size = commit_builder.modified_file_text(
714
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
716
def _unchanged(self, previous_ie):
717
"""See InventoryEntry._unchanged."""
718
compatible = super(InventoryFile, self)._unchanged(previous_ie)
719
if self.text_sha1 != previous_ie.text_sha1:
722
# FIXME: 20050930 probe for the text size when getting sha1
723
# in _read_tree_state
724
self.text_size = previous_ie.text_size
725
if self.executable != previous_ie.executable:
730
class InventoryLink(InventoryEntry):
731
"""A file in an inventory."""
733
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
734
'text_id', 'parent_id', 'children', 'executable',
735
'revision', 'symlink_target']
737
def _check(self, checker, rev_id, tree):
738
"""See InventoryEntry._check"""
739
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
740
raise BzrCheckError('symlink {%s} has text in revision {%s}'
741
% (self.file_id, rev_id))
742
if self.symlink_target is None:
743
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
744
% (self.file_id, rev_id))
747
other = InventoryLink(self.file_id, self.name, self.parent_id)
748
other.symlink_target = self.symlink_target
749
other.revision = self.revision
752
def detect_changes(self, old_entry):
753
"""See InventoryEntry.detect_changes."""
754
# FIXME: which _modified field should we use ? RBC 20051003
755
text_modified = (self.symlink_target != old_entry.symlink_target)
757
mutter(" symlink target changed")
758
meta_modified = False
759
return text_modified, meta_modified
761
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
762
output_to, reverse=False):
763
"""See InventoryEntry._diff."""
764
from_text = self.symlink_target
765
if to_entry is not None:
766
to_text = to_entry.symlink_target
771
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
774
print >>output_to, '=== target was %r' % self.symlink_target
776
print >>output_to, '=== target is %r' % self.symlink_target
778
def __init__(self, file_id, name, parent_id):
779
super(InventoryLink, self).__init__(file_id, name, parent_id)
780
self.kind = 'symlink'
782
def kind_character(self):
783
"""See InventoryEntry.kind_character."""
786
def _put_in_tar(self, item, tree):
787
"""See InventoryEntry._put_in_tar."""
788
item.type = tarfile.SYMTYPE
792
item.linkname = self.symlink_target
795
def _put_on_disk(self, fullpath, tree):
796
"""See InventoryEntry._put_on_disk."""
798
os.symlink(self.symlink_target, fullpath)
800
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
802
def _read_tree_state(self, path, work_tree):
803
"""See InventoryEntry._read_tree_state."""
804
self.symlink_target = work_tree.get_symlink_target(self.file_id)
806
def _forget_tree_state(self):
807
self.symlink_target = None
809
def _unchanged(self, previous_ie):
810
"""See InventoryEntry._unchanged."""
811
compatible = super(InventoryLink, self)._unchanged(previous_ie)
812
if self.symlink_target != previous_ie.symlink_target:
816
def _snapshot_text(self, file_parents, work_tree, commit_builder):
817
"""See InventoryEntry._snapshot_text."""
818
commit_builder.modified_link(
819
self.file_id, file_parents, self.symlink_target)
822
class Inventory(object):
247
823
"""Inventory of versioned files in a tree.
249
825
This describes which file_id is present at each point in the tree,
296
870
The inventory is created with a default root directory, with
299
self.root = RootEntry(ROOT_ID)
873
if root_id is not None:
874
self._set_root(InventoryDirectory(root_id, '', None))
878
self.revision_id = revision_id
880
def _set_root(self, ie):
300
882
self._byid = {self.root.file_id: self.root}
885
# TODO: jam 20051218 Should copy also copy the revision_id?
886
entries = self.iter_entries()
887
other = Inventory(entries.next()[1].file_id)
888
# copy recursively so we know directories will be added before
889
# their children. There are more efficient ways than this...
890
for path, entry in entries():
891
other.add(entry.copy())
303
894
def __iter__(self):
304
895
return iter(self._byid)
307
897
def __len__(self):
308
898
"""Returns number of entries."""
309
899
return len(self._byid)
312
901
def iter_entries(self, from_dir=None):
313
902
"""Return (path, entry) pairs, in order by name."""
317
elif isinstance(from_dir, basestring):
318
from_dir = self._byid[from_dir]
320
kids = from_dir.children.items()
322
for name, ie in kids:
324
if ie.kind == 'directory':
325
for cn, cie in self.iter_entries(from_dir=ie.file_id):
326
yield os.path.join(name, cn), cie
904
if self.root is None:
908
elif isinstance(from_dir, basestring):
909
from_dir = self._byid[from_dir]
911
# unrolling the recursive called changed the time from
912
# 440ms/663ms (inline/total) to 116ms/116ms
913
children = from_dir.children.items()
915
children = collections.deque(children)
916
stack = [(u'', children)]
918
from_dir_relpath, children = stack[-1]
921
name, ie = children.popleft()
923
# we know that from_dir_relpath never ends in a slash
924
# and 'f' doesn't begin with one, we can do a string op, rather
925
# than the checks of pathjoin(), though this means that all paths
927
path = from_dir_relpath + '/' + name
931
if ie.kind != 'directory':
934
# But do this child first
935
new_children = ie.children.items()
937
new_children = collections.deque(new_children)
938
stack.append((path, new_children))
939
# Break out of inner loop, so that we start outer loop with child
942
# if we finished all children, pop it off the stack
945
def iter_entries_by_dir(self, from_dir=None):
946
"""Iterate over the entries in a directory first order.
948
This returns all entries for a directory before returning
949
the entries for children of a directory. This is not
950
lexicographically sorted order, and is a hybrid between
951
depth-first and breadth-first.
953
:return: This yields (path, entry) pairs
955
# TODO? Perhaps this should return the from_dir so that the root is
956
# yielded? or maybe an option?
958
if self.root is None:
962
elif isinstance(from_dir, basestring):
963
from_dir = self._byid[from_dir]
965
stack = [(u'', from_dir)]
967
cur_relpath, cur_dir = stack.pop()
970
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
972
child_relpath = cur_relpath + child_name
974
yield child_relpath, child_ie
976
if child_ie.kind == 'directory':
977
child_dirs.append((child_relpath+'/', child_ie))
978
stack.extend(reversed(child_dirs))
981
"""Return list of (path, ie) for all entries except the root.
983
This may be faster than iter_entries.
986
def descend(dir_ie, dir_path):
987
kids = dir_ie.children.items()
989
for name, ie in kids:
990
child_path = osutils.pathjoin(dir_path, name)
991
accum.append((child_path, ie))
992
if ie.kind == 'directory':
993
descend(ie, child_path)
995
descend(self.root, u'')
330
998
def directories(self):
331
"""Return (path, entry) pairs for all directories.
999
"""Return (path, entry) pairs for all directories, including the root.
333
def descend(parent_ie):
334
parent_name = parent_ie.name
335
yield parent_name, parent_ie
337
# directory children in sorted order
339
for ie in parent_ie.children.itervalues():
340
if ie.kind == 'directory':
341
dn.append((ie.name, ie))
1002
def descend(parent_ie, parent_path):
1003
accum.append((parent_path, parent_ie))
344
for name, child_ie in dn:
345
for sub_name, sub_ie in descend(child_ie):
346
yield appendpath(parent_name, sub_name), sub_ie
1005
kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
348
for name, ie in descend(self.root):
1008
for name, child_ie in kids:
1009
child_path = osutils.pathjoin(parent_path, name)
1010
descend(child_ie, child_path)
1011
descend(self.root, u'')
353
1014
def __contains__(self, file_id):
354
1015
"""True if this entry contains a file with given id.
356
1017
>>> inv = Inventory()
357
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
1018
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1019
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
358
1020
>>> '123' in inv
360
1022
>>> '456' in inv
363
return file_id in self._byid
1025
return (file_id in self._byid)
366
1027
def __getitem__(self, file_id):
367
1028
"""Return the entry for given file_id.
369
1030
>>> inv = Inventory()
370
>>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
1031
>>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1032
InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
371
1033
>>> inv['123123'].name
375
1037
return self._byid[file_id]
376
1038
except KeyError:
378
raise BzrError("can't look up file_id None")
380
raise BzrError("file_id {%s} not in inventory" % file_id)
1039
# really we're passing an inventory, not a tree...
1040
raise errors.NoSuchId(self, file_id)
1042
def get_file_kind(self, file_id):
1043
return self._byid[file_id].kind
383
1045
def get_child(self, parent_id, filename):
384
1046
return self[parent_id].children.get(filename)
387
1048
def add(self, entry):
388
1049
"""Add entry to inventory.
390
1051
To add a file to a branch ready to be committed, use Branch.add,
1054
Returns the new entry object.
392
1056
if entry.file_id in self._byid:
393
bailout("inventory already contains entry with id {%s}" % entry.file_id)
1057
raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
1059
if entry.parent_id is None:
1060
assert self.root is None and len(self._byid) == 0
1061
self._set_root(entry)
396
1064
parent = self._byid[entry.parent_id]
397
1065
except KeyError:
398
bailout("parent_id {%s} not in inventory" % entry.parent_id)
1066
raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
400
if parent.children.has_key(entry.name):
401
bailout("%s is already versioned" %
402
appendpath(self.id2path(parent.file_id), entry.name))
1068
if entry.name in parent.children:
1069
raise BzrError("%s is already versioned" %
1070
osutils.pathjoin(self.id2path(parent.file_id), entry.name))
404
1072
self._byid[entry.file_id] = entry
405
1073
parent.children[entry.name] = entry
408
def add_path(self, relpath, kind, file_id=None):
1076
def add_path(self, relpath, kind, file_id=None, parent_id=None):
409
1077
"""Add entry from a path.
411
The immediate parent must already be versioned"""
412
parts = bzrlib.osutils.splitpath(relpath)
1079
The immediate parent must already be versioned.
1081
Returns the new entry object."""
1083
parts = osutils.splitpath(relpath)
413
1085
if len(parts) == 0:
414
bailout("cannot re-add root of inventory")
417
file_id = bzrlib.branch.gen_file_id(relpath)
419
parent_id = self.path2id(parts[:-1])
420
assert parent_id != None
421
ie = InventoryEntry(file_id, parts[-1],
422
kind=kind, parent_id=parent_id)
1087
file_id = bzrlib.workingtree.gen_root_id()
1088
self.root = InventoryDirectory(file_id, '', None)
1089
self._byid = {self.root.file_id: self.root}
1092
parent_path = parts[:-1]
1093
parent_id = self.path2id(parent_path)
1094
if parent_id is None:
1095
raise errors.NotVersionedError(path=parent_path)
1096
ie = make_entry(kind, parts[-1], parent_id, file_id)
423
1097
return self.add(ie)
426
1099
def __delitem__(self, file_id):
427
1100
"""Remove entry by id.
429
1102
>>> inv = Inventory()
430
>>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
1103
>>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1104
InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
431
1105
>>> '123' in inv
433
1107
>>> del inv['123']
added
removed
bzrlib/inventory.py
