1
# Copyright (C) 2005, 2006 Canonical Ltd
1
# (C) 2005 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.
26
18
# This should really be an id randomly assigned when the tree is
27
19
# created, but it's not for now.
28
20
ROOT_ID = "TREE_ROOT"
23
import sys, os.path, types, re
39
from bzrlib import errors, osutils
40
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
41
pathjoin, sha_strings)
42
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
43
BzrError, BzrCheckError, BinaryFile)
26
from bzrlib.errors import BzrError, BzrCheckError
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
44
29
from bzrlib.trace import mutter
47
31
class InventoryEntry(object):
48
32
"""Description of a versioned file.
50
34
An InventoryEntry has the following fields, which are also
51
35
present in the XML inventory-entry element:
56
(within the parent directory)
59
file_id of the parent directory, or ROOT_ID
62
the revision_id in which this variation of this file was
66
Indicates that this file should be executable on systems
70
sha-1 of the text of the file
73
size in bytes of the text of the file
75
(reading a version 4 tree created a text_id field.)
38
* *name*: (only the basename within the directory, must not
40
* *kind*: "directory" or "file"
41
* *directory_id*: (if absent/null means the branch root directory)
42
* *text_sha1*: only for files
43
* *text_size*: in bytes, only for files
44
* *text_id*: identifier for the text version, only for files
46
InventoryEntries can also exist inside a WorkingTree
47
inventory, in which case they are not yet bound to a
48
particular revision of the file. In that case the text_sha1,
49
text_size and text_id are absent.
77
52
>>> i = Inventory()
80
>>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
81
InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
82
>>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
83
InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
84
>>> shouldbe = {0: '', 1: 'src', 2: pathjoin('src','hello.c')}
85
>>> for ix, j in enumerate(i.iter_entries()):
86
... print (j[0] == shouldbe[ix], j[1])
55
>>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
56
>>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
57
>>> for j in i.iter_entries():
88
(True, RootEntry('TREE_ROOT', u'', parent_id=None, revision=None))
89
(True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
90
(True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
91
>>> i.add(InventoryFile('2323', 'bye.c', '123'))
60
('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
61
('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
62
>>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
92
63
Traceback (most recent call last):
94
65
BzrError: inventory already contains entry with id {2323}
95
>>> i.add(InventoryFile('2324', 'bye.c', '123'))
96
InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
97
>>> i.add(InventoryDirectory('2325', 'wibble', '123'))
98
InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
66
>>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
67
>>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
99
68
>>> i.path2id('src/wibble')
103
>>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
104
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
72
>>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
106
InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
107
>>> for path, entry in i.iter_entries():
109
... assert i.path2id(path)
74
InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
75
>>> for j in i.iter_entries():
77
... assert i.path2id(j[0])
116
83
src/wibble/wibble.c
117
84
>>> i.id2path('2326')
118
85
'src/wibble/wibble.c'
87
TODO: Maybe also keep the full path of the entry, and the children?
88
But those depend on its position within a particular inventory, and
89
it would be nice not to need to hold the backpointer here.
121
# Constants returned by describe_change()
123
# TODO: These should probably move to some kind of FileChangeDescription
124
# class; that's like what's inside a TreeDelta but we want to be able to
125
# generate them just for one file at a time.
127
MODIFIED_AND_RENAMED = 'modified and renamed'
131
def detect_changes(self, old_entry):
132
"""Return a (text_modified, meta_modified) from this to old_entry.
134
_read_tree_state must have been called on self and old_entry prior to
135
calling detect_changes.
139
def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
140
output_to, reverse=False):
141
"""Perform a diff from this to to_entry.
143
text_diff will be used for textual difference calculation.
144
This is a template method, override _diff in child classes.
146
self._read_tree_state(tree.id2path(self.file_id), tree)
148
# cannot diff from one kind to another - you must do a removal
149
# and an addif they do not match.
150
assert self.kind == to_entry.kind
151
to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
153
self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
156
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
157
output_to, reverse=False):
158
"""Perform a diff between two entries of the same kind."""
160
def find_previous_heads(self, previous_inventories,
161
versioned_file_store,
164
"""Return the revisions and entries that directly precede this.
166
Returned as a map from revision to inventory entry.
168
This is a map containing the file revisions in all parents
169
for which the file exists, and its revision is not a parent of
170
any other. If the file is new, the set will be empty.
172
:param versioned_file_store: A store where ancestry data on this
173
file id can be queried.
174
:param transaction: The transaction that queries to the versioned
175
file store should be completed under.
176
:param entry_vf: The entry versioned file, if its already available.
178
def get_ancestors(weave, entry):
179
return set(weave.get_ancestry(entry.revision))
180
# revision:ie mapping for each ie found in previous_inventories.
182
# revision:ie mapping with one revision for each head.
184
# revision: ancestor list for each head
186
# identify candidate head revision ids.
187
for inv in previous_inventories:
188
if self.file_id in inv:
189
ie = inv[self.file_id]
190
assert ie.file_id == self.file_id
191
if ie.revision in candidates:
192
# same revision value in two different inventories:
193
# correct possible inconsistencies:
194
# * there was a bug in revision updates with 'x' bit
197
if candidates[ie.revision].executable != ie.executable:
198
candidates[ie.revision].executable = False
199
ie.executable = False
200
except AttributeError:
202
# must now be the same.
203
assert candidates[ie.revision] == ie
205
# add this revision as a candidate.
206
candidates[ie.revision] = ie
208
# common case optimisation
209
if len(candidates) == 1:
210
# if there is only one candidate revision found
211
# then we can opening the versioned file to access ancestry:
212
# there cannot be any ancestors to eliminate when there is
213
# only one revision available.
214
heads[ie.revision] = ie
217
# eliminate ancestors amongst the available candidates:
218
# heads are those that are not an ancestor of any other candidate
219
# - this provides convergence at a per-file level.
220
for ie in candidates.values():
221
# may be an ancestor of a known head:
222
already_present = 0 != len(
223
[head for head in heads
224
if ie.revision in head_ancestors[head]])
226
# an ancestor of an analyzed candidate.
228
# not an ancestor of a known head:
229
# load the versioned file for this file id if needed
231
entry_vf = versioned_file_store.get_weave_or_empty(
232
self.file_id, transaction)
233
ancestors = get_ancestors(entry_vf, ie)
234
# may knock something else out:
235
check_heads = list(heads.keys())
236
for head in check_heads:
237
if head in ancestors:
238
# this previously discovered 'head' is not
239
# really a head - its an ancestor of the newly
242
head_ancestors[ie.revision] = ancestors
243
heads[ie.revision] = ie
246
def get_tar_item(self, root, dp, now, tree):
247
"""Get a tarfile item and a file stream for its content."""
248
item = tarfile.TarInfo(pathjoin(root, dp))
249
# TODO: would be cool to actually set it to the timestamp of the
250
# revision it was last changed
252
fileobj = self._put_in_tar(item, tree)
256
"""Return true if the object this entry represents has textual data.
258
Note that textual data includes binary content.
260
Also note that all entries get weave files created for them.
261
This attribute is primarily used when upgrading from old trees that
262
did not have the weave index for all inventory entries.
266
def __init__(self, file_id, name, parent_id, text_id=None):
92
# TODO: split InventoryEntry into subclasses for files,
93
# directories, etc etc.
95
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
96
'text_id', 'parent_id', 'children', ]
98
def __init__(self, file_id, name, kind, parent_id, text_id=None):
267
99
"""Create an InventoryEntry
269
101
The filename must be a single component, relative to the
270
102
parent directory; it cannot be a whole path or relative name.
272
>>> e = InventoryFile('123', 'hello.c', ROOT_ID)
104
>>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
277
>>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
109
>>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
278
110
Traceback (most recent call last):
279
InvalidEntryName: Invalid entry name: src/hello.c
111
BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
281
assert isinstance(name, basestring), name
282
113
if '/' in name or '\\' in name:
283
raise InvalidEntryName(name=name)
284
self.executable = False
114
raise BzrCheckError('InventoryEntry name %r is invalid' % name)
286
116
self.text_sha1 = None
287
117
self.text_size = None
288
119
self.file_id = file_id
290
122
self.text_id = text_id
291
123
self.parent_id = parent_id
292
self.symlink_target = None
294
def kind_character(self):
295
"""Return a short kind indicator useful for appending to names."""
296
raise BzrError('unknown kind %r' % self.kind)
298
known_kinds = ('file', 'directory', 'symlink', 'root_directory')
300
def _put_in_tar(self, item, tree):
301
"""populate item for stashing in a tar, and return the content stream.
303
If no content is available, return None.
305
raise BzrError("don't know how to export {%s} of kind %r" %
306
(self.file_id, self.kind))
308
def put_on_disk(self, dest, dp, tree):
309
"""Create a representation of self on disk in the prefix dest.
311
This is a template method - implement _put_on_disk in subclasses.
313
fullpath = pathjoin(dest, dp)
314
self._put_on_disk(fullpath, tree)
315
# mutter(" export {%s} kind %s to %s", self.file_id,
316
# self.kind, fullpath)
318
def _put_on_disk(self, fullpath, tree):
319
"""Put this entry onto disk at fullpath, from tree tree."""
320
raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
124
if kind == 'directory':
129
raise BzrError("unhandled entry kind %r" % kind)
322
133
def sorted_children(self):
323
return sorted(self.children.items())
326
def versionable_kind(kind):
327
return kind in ('file', 'directory', 'symlink')
329
def check(self, checker, rev_id, inv, tree):
330
"""Check this inventory entry is intact.
332
This is a template method, override _check for kind specific
335
:param checker: Check object providing context for the checks;
336
can be used to find out what parts of the repository have already
338
:param rev_id: Revision id from which this InventoryEntry was loaded.
339
Not necessarily the last-changed revision for this file.
340
:param inv: Inventory from which the entry was loaded.
341
:param tree: RevisionTree for this entry.
343
if self.parent_id is not None:
344
if not inv.has_id(self.parent_id):
345
raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
346
% (self.parent_id, rev_id))
347
self._check(checker, rev_id, tree)
349
def _check(self, checker, rev_id, tree):
350
"""Check this inventory entry for kind specific errors."""
351
raise BzrCheckError('unknown entry kind %r in revision {%s}' %
134
l = self.children.items()
355
"""Clone this inventory entry."""
356
raise NotImplementedError
359
def describe_change(old_entry, new_entry):
360
"""Describe the change between old_entry and this.
362
This smells of being an InterInventoryEntry situation, but as its
363
the first one, we're making it a static method for now.
365
An entry with a different parent, or different name is considered
366
to be renamed. Reparenting is an internal detail.
367
Note that renaming the parent does not trigger a rename for the
370
# TODO: Perhaps return an object rather than just a string
371
if old_entry is new_entry:
372
# also the case of both being None
374
elif old_entry is None:
376
elif new_entry is None:
378
text_modified, meta_modified = new_entry.detect_changes(old_entry)
379
if text_modified or meta_modified:
383
# TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
384
if old_entry.parent_id != new_entry.parent_id:
386
elif old_entry.name != new_entry.name:
390
if renamed and not modified:
391
return InventoryEntry.RENAMED
392
if modified and not renamed:
394
if modified and renamed:
395
return InventoryEntry.MODIFIED_AND_RENAMED
140
other = InventoryEntry(self.file_id, self.name, self.kind,
141
self.parent_id, text_id=self.text_id)
142
other.text_sha1 = self.text_sha1
143
other.text_size = self.text_size
144
# note that children are *not* copied; they're pulled across when
398
149
def __repr__(self):
399
return ("%s(%r, %r, parent_id=%r, revision=%r)"
150
return ("%s(%r, %r, kind=%r, parent_id=%r)"
400
151
% (self.__class__.__name__,
406
def snapshot(self, revision, path, previous_entries,
407
work_tree, commit_builder):
408
"""Make a snapshot of this entry which may or may not have changed.
410
This means that all its fields are populated, that it has its
411
text stored in the text store or weave.
413
# mutter('new parents of %s are %r', path, previous_entries)
414
self._read_tree_state(path, work_tree)
415
# TODO: Where should we determine whether to reuse a
416
# previous revision id or create a new revision? 20060606
417
if len(previous_entries) == 1:
418
# cannot be unchanged unless there is only one parent file rev.
419
parent_ie = previous_entries.values()[0]
420
if self._unchanged(parent_ie):
421
# mutter("found unchanged entry")
422
self.revision = parent_ie.revision
424
return self._snapshot_into_revision(revision, previous_entries,
425
work_tree, commit_builder)
427
def _snapshot_into_revision(self, revision, previous_entries, work_tree,
429
"""Record this revision unconditionally into a store.
431
The entry's last-changed revision property (`revision`) is updated to
432
that of the new revision.
434
:param revision: id of the new revision that is being recorded.
436
:returns: String description of the commit (e.g. "merged", "modified"), etc.
438
# mutter('new revision {%s} for {%s}', revision, self.file_id)
439
self.revision = revision
440
self._snapshot_text(previous_entries, work_tree, commit_builder)
442
def _snapshot_text(self, file_parents, work_tree, commit_builder):
443
"""Record the 'text' of this entry, whatever form that takes.
445
This default implementation simply adds an empty text.
447
raise NotImplementedError(self._snapshot_text)
158
def to_element(self):
159
"""Convert to XML element"""
160
from bzrlib.xml import 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)
449
212
def __eq__(self, other):
450
213
if not isinstance(other, InventoryEntry):
451
214
return NotImplemented
453
return ((self.file_id == other.file_id)
454
and (self.name == other.name)
455
and (other.symlink_target == self.symlink_target)
456
and (self.text_sha1 == other.text_sha1)
457
and (self.text_size == other.text_size)
458
and (self.text_id == other.text_id)
459
and (self.parent_id == other.parent_id)
460
and (self.kind == other.kind)
461
and (self.revision == other.revision)
462
and (self.executable == other.executable)
216
return (self.file_id == other.file_id) \
217
and (self.name == other.name) \
218
and (self.text_sha1 == other.text_sha1) \
219
and (self.text_size == other.text_size) \
220
and (self.text_id == other.text_id) \
221
and (self.parent_id == other.parent_id) \
222
and (self.kind == other.kind)
465
225
def __ne__(self, other):
466
226
return not (self == other)
522
246
and (self.children == other.children)
525
class InventoryDirectory(InventoryEntry):
526
"""A directory in an inventory."""
528
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
529
'text_id', 'parent_id', 'children', 'executable',
530
'revision', 'symlink_target']
532
def _check(self, checker, rev_id, tree):
533
"""See InventoryEntry._check"""
534
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
535
raise BzrCheckError('directory {%s} has text in revision {%s}'
536
% (self.file_id, rev_id))
539
other = InventoryDirectory(self.file_id, self.name, self.parent_id)
540
other.revision = self.revision
541
# note that children are *not* copied; they're pulled across when
545
def __init__(self, file_id, name, parent_id):
546
super(InventoryDirectory, self).__init__(file_id, name, parent_id)
548
self.kind = 'directory'
550
def kind_character(self):
551
"""See InventoryEntry.kind_character."""
554
def _put_in_tar(self, item, tree):
555
"""See InventoryEntry._put_in_tar."""
556
item.type = tarfile.DIRTYPE
563
def _put_on_disk(self, fullpath, tree):
564
"""See InventoryEntry._put_on_disk."""
567
def _snapshot_text(self, file_parents, work_tree, commit_builder):
568
"""See InventoryEntry._snapshot_text."""
569
commit_builder.modified_directory(self.file_id, file_parents)
572
class InventoryFile(InventoryEntry):
573
"""A file in an inventory."""
575
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
576
'text_id', 'parent_id', 'children', 'executable',
577
'revision', 'symlink_target']
579
def _check(self, checker, tree_revision_id, tree):
580
"""See InventoryEntry._check"""
581
t = (self.file_id, self.revision)
582
if t in checker.checked_texts:
583
prev_sha = checker.checked_texts[t]
584
if prev_sha != self.text_sha1:
585
raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
586
(self.file_id, tree_revision_id))
588
checker.repeated_text_cnt += 1
591
if self.file_id not in checker.checked_weaves:
592
mutter('check weave {%s}', self.file_id)
593
w = tree.get_weave(self.file_id)
594
# Not passing a progress bar, because it creates a new
595
# progress, which overwrites the current progress,
596
# and doesn't look nice
598
checker.checked_weaves[self.file_id] = True
600
w = tree.get_weave(self.file_id)
602
mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
603
checker.checked_text_cnt += 1
604
# We can't check the length, because Weave doesn't store that
605
# information, and the whole point of looking at the weave's
606
# sha1sum is that we don't have to extract the text.
607
if self.text_sha1 != w.get_sha1(self.revision):
608
raise BzrCheckError('text {%s} version {%s} wrong sha1'
609
% (self.file_id, self.revision))
610
checker.checked_texts[t] = self.text_sha1
613
other = InventoryFile(self.file_id, self.name, self.parent_id)
614
other.executable = self.executable
615
other.text_id = self.text_id
616
other.text_sha1 = self.text_sha1
617
other.text_size = self.text_size
618
other.revision = self.revision
621
def detect_changes(self, old_entry):
622
"""See InventoryEntry.detect_changes."""
623
assert self.text_sha1 is not None
624
assert old_entry.text_sha1 is not None
625
text_modified = (self.text_sha1 != old_entry.text_sha1)
626
meta_modified = (self.executable != old_entry.executable)
627
return text_modified, meta_modified
629
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
630
output_to, reverse=False):
631
"""See InventoryEntry._diff."""
633
from_text = tree.get_file(self.file_id).readlines()
635
to_text = to_tree.get_file(to_entry.file_id).readlines()
639
text_diff(from_label, from_text,
640
to_label, to_text, output_to)
642
text_diff(to_label, to_text,
643
from_label, from_text, output_to)
646
label_pair = (to_label, from_label)
648
label_pair = (from_label, to_label)
649
print >> output_to, "Binary files %s and %s differ" % label_pair
652
"""See InventoryEntry.has_text."""
655
def __init__(self, file_id, name, parent_id):
656
super(InventoryFile, self).__init__(file_id, name, parent_id)
659
def kind_character(self):
660
"""See InventoryEntry.kind_character."""
663
def _put_in_tar(self, item, tree):
664
"""See InventoryEntry._put_in_tar."""
665
item.type = tarfile.REGTYPE
666
fileobj = tree.get_file(self.file_id)
667
item.size = self.text_size
668
if tree.is_executable(self.file_id):
674
def _put_on_disk(self, fullpath, tree):
675
"""See InventoryEntry._put_on_disk."""
676
pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
677
if tree.is_executable(self.file_id):
678
os.chmod(fullpath, 0755)
680
def _read_tree_state(self, path, work_tree):
681
"""See InventoryEntry._read_tree_state."""
682
self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
683
# FIXME: 20050930 probe for the text size when getting sha1
684
# in _read_tree_state
685
self.executable = work_tree.is_executable(self.file_id, path=path)
688
return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
689
% (self.__class__.__name__,
696
def _forget_tree_state(self):
697
self.text_sha1 = None
699
def _snapshot_text(self, file_parents, work_tree, commit_builder):
700
"""See InventoryEntry._snapshot_text."""
701
def get_content_byte_lines():
702
return work_tree.get_file(self.file_id).readlines()
703
self.text_sha1, self.text_size = commit_builder.modified_file_text(
704
self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
706
def _unchanged(self, previous_ie):
707
"""See InventoryEntry._unchanged."""
708
compatible = super(InventoryFile, self)._unchanged(previous_ie)
709
if self.text_sha1 != previous_ie.text_sha1:
712
# FIXME: 20050930 probe for the text size when getting sha1
713
# in _read_tree_state
714
self.text_size = previous_ie.text_size
715
if self.executable != previous_ie.executable:
720
class InventoryLink(InventoryEntry):
721
"""A file in an inventory."""
723
__slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
724
'text_id', 'parent_id', 'children', 'executable',
725
'revision', 'symlink_target']
727
def _check(self, checker, rev_id, tree):
728
"""See InventoryEntry._check"""
729
if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
730
raise BzrCheckError('symlink {%s} has text in revision {%s}'
731
% (self.file_id, rev_id))
732
if self.symlink_target is None:
733
raise BzrCheckError('symlink {%s} has no target in revision {%s}'
734
% (self.file_id, rev_id))
737
other = InventoryLink(self.file_id, self.name, self.parent_id)
738
other.symlink_target = self.symlink_target
739
other.revision = self.revision
742
def detect_changes(self, old_entry):
743
"""See InventoryEntry.detect_changes."""
744
# FIXME: which _modified field should we use ? RBC 20051003
745
text_modified = (self.symlink_target != old_entry.symlink_target)
747
mutter(" symlink target changed")
748
meta_modified = False
749
return text_modified, meta_modified
751
def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
752
output_to, reverse=False):
753
"""See InventoryEntry._diff."""
754
from_text = self.symlink_target
755
if to_entry is not None:
756
to_text = to_entry.symlink_target
761
print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
764
print >>output_to, '=== target was %r' % self.symlink_target
766
print >>output_to, '=== target is %r' % self.symlink_target
768
def __init__(self, file_id, name, parent_id):
769
super(InventoryLink, self).__init__(file_id, name, parent_id)
770
self.kind = 'symlink'
772
def kind_character(self):
773
"""See InventoryEntry.kind_character."""
776
def _put_in_tar(self, item, tree):
777
"""See InventoryEntry._put_in_tar."""
778
item.type = tarfile.SYMTYPE
782
item.linkname = self.symlink_target
785
def _put_on_disk(self, fullpath, tree):
786
"""See InventoryEntry._put_on_disk."""
788
os.symlink(self.symlink_target, fullpath)
790
raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
792
def _read_tree_state(self, path, work_tree):
793
"""See InventoryEntry._read_tree_state."""
794
self.symlink_target = work_tree.get_symlink_target(self.file_id)
796
def _forget_tree_state(self):
797
self.symlink_target = None
799
def _unchanged(self, previous_ie):
800
"""See InventoryEntry._unchanged."""
801
compatible = super(InventoryLink, self)._unchanged(previous_ie)
802
if self.symlink_target != previous_ie.symlink_target:
806
def _snapshot_text(self, file_parents, work_tree, commit_builder):
807
"""See InventoryEntry._snapshot_text."""
808
commit_builder.modified_link(
809
self.file_id, file_parents, self.symlink_target)
812
250
class Inventory(object):
813
251
"""Inventory of versioned files in a tree.
857
293
The inventory is created with a default root directory, with
860
# We are letting Branch.create() create a unique inventory
296
# We are letting Branch(init=True) create a unique inventory
861
297
# root id. Rather than generating a random one here.
862
298
#if root_id is None:
863
299
# root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
864
300
self.root = RootEntry(root_id)
865
# FIXME: this isn't ever used, changing it to self.revision may break
866
# things. TODO make everything use self.revision_id
867
self.revision_id = revision_id
868
301
self._byid = {self.root.file_id: self.root}
871
# TODO: jam 20051218 Should copy also copy the revision_id?
872
entries = self.iter_entries()
873
other = Inventory(entries.next()[1].file_id)
874
# copy recursively so we know directories will be added before
875
# their children. There are more efficient ways than this...
876
for path, entry in entries():
877
other.add(entry.copy())
880
304
def __iter__(self):
881
305
return iter(self._byid)
883
308
def __len__(self):
884
309
"""Returns number of entries."""
885
310
return len(self._byid)
887
313
def iter_entries(self, from_dir=None):
888
314
"""Return (path, entry) pairs, in order by name."""
893
elif isinstance(from_dir, basestring):
894
from_dir = self._byid[from_dir]
896
# unrolling the recursive called changed the time from
897
# 440ms/663ms (inline/total) to 116ms/116ms
898
children = from_dir.children.items()
900
children = collections.deque(children)
901
stack = [(u'', children)]
903
from_dir_relpath, children = stack[-1]
906
name, ie = children.popleft()
908
# we know that from_dir_relpath never ends in a slash
909
# and 'f' doesn't begin with one, we can do a string op, rather
910
# than the checks of pathjoin(), though this means that all paths
912
path = from_dir_relpath + '/' + name
916
if ie.kind != 'directory':
919
# But do this child first
920
new_children = ie.children.items()
922
new_children = collections.deque(new_children)
923
stack.append((path, new_children))
924
# Break out of inner loop, so that we start outer loop with child
927
# if we finished all children, pop it off the stack
930
def iter_entries_by_dir(self, from_dir=None):
931
"""Iterate over the entries in a directory first order.
933
This returns all entries for a directory before returning
934
the entries for children of a directory. This is not
935
lexicographically sorted order, and is a hybrid between
936
depth-first and breadth-first.
938
:return: This yields (path, entry) pairs
940
# TODO? Perhaps this should return the from_dir so that the root is
941
# yielded? or maybe an option?
946
elif isinstance(from_dir, basestring):
947
from_dir = self._byid[from_dir]
949
stack = [(u'', from_dir)]
951
cur_relpath, cur_dir = stack.pop()
954
for child_name, child_ie in sorted(cur_dir.children.iteritems()):
956
child_relpath = cur_relpath + child_name
958
yield child_relpath, child_ie
960
if child_ie.kind == 'directory':
961
child_dirs.append((child_relpath+'/', child_ie))
962
stack.extend(reversed(child_dirs))
318
elif isinstance(from_dir, basestring):
319
from_dir = self._byid[from_dir]
321
kids = from_dir.children.items()
323
for name, ie in kids:
325
if ie.kind == 'directory':
326
for cn, cie in self.iter_entries(from_dir=ie.file_id):
327
yield os.path.join(name, cn), cie
964
330
def entries(self):
965
331
"""Return list of (path, ie) for all entries except the root.
added
removed
bzrlib/inventory.py
