~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-10-07 01:01:07 UTC
  • mfrom: (1185.13.2)
  • Revision ID: robertc@robertcollins.net-20051007010107-fe48434051a15b92
mergeĀ fromĀ upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
19
19
# But those depend on its position within a particular inventory, and
20
20
# it would be nice not to need to hold the backpointer here.
21
21
 
22
 
# TODO: Perhaps split InventoryEntry into subclasses for files,
23
 
# directories, etc etc.
24
 
 
25
 
 
26
22
# This should really be an id randomly assigned when the tree is
27
23
# created, but it's not for now.
28
24
ROOT_ID = "TREE_ROOT"
31
27
import os.path
32
28
import re
33
29
import sys
 
30
import tarfile
34
31
import types
35
32
 
36
33
import bzrlib
37
34
from bzrlib.errors import BzrError, BzrCheckError
38
35
 
39
 
from bzrlib.osutils import quotefn, splitpath, joinpath, appendpath, sha_strings
 
36
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
37
                            appendpath, sha_strings)
40
38
from bzrlib.trace import mutter
41
39
from bzrlib.errors import NotVersionedError
42
40
 
52
50
    name
53
51
        (within the parent directory)
54
52
 
55
 
    kind
56
 
        'directory' or 'file' or 'symlink'
57
 
 
58
53
    parent_id
59
54
        file_id of the parent directory, or ROOT_ID
60
55
 
77
72
    >>> i = Inventory()
78
73
    >>> i.path2id('')
79
74
    'TREE_ROOT'
80
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
81
 
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
82
 
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
83
 
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
 
75
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
 
76
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
 
77
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
 
78
    InventoryFile('2323', 'hello.c', parent_id='123')
84
79
    >>> for j in i.iter_entries():
85
80
    ...   print j
86
81
    ... 
87
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
88
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
89
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
82
    ('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
83
    ('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
 
84
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
90
85
    Traceback (most recent call last):
91
86
    ...
92
87
    BzrError: inventory already contains entry with id {2323}
93
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
94
 
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
95
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
96
 
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
 
88
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
 
89
    InventoryFile('2324', 'bye.c', parent_id='123')
 
90
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
 
91
    InventoryDirectory('2325', 'wibble', parent_id='123')
97
92
    >>> i.path2id('src/wibble')
98
93
    '2325'
99
94
    >>> '2325' in i
100
95
    True
101
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
102
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
96
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
97
    InventoryFile('2326', 'wibble.c', parent_id='2325')
103
98
    >>> i['2326']
104
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
99
    InventoryFile('2326', 'wibble.c', parent_id='2325')
105
100
    >>> for path, entry in i.iter_entries():
106
101
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
107
102
    ...     assert i.path2id(path)
117
112
    
118
113
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
119
114
                 'text_id', 'parent_id', 'children', 'executable', 
120
 
                 'revision', 'symlink_target']
 
115
                 'revision']
121
116
 
122
117
    def _add_text_to_weave(self, new_lines, parents, weave_store):
123
118
        weave_store.add_text(self.file_id, self.revision, new_lines, parents)
124
119
 
125
 
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
 
120
    def detect_changes(self, old_entry):
 
121
        """Return a (text_modified, meta_modified) from this to old_entry.
 
122
        
 
123
        _read_tree_state must have been called on self and old_entry prior to 
 
124
        calling detect_changes.
 
125
        """
 
126
        return False, False
 
127
 
 
128
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
129
             output_to, reverse=False):
 
130
        """Perform a diff from this to to_entry.
 
131
 
 
132
        text_diff will be used for textual difference calculation.
 
133
        This is a template method, override _diff in child classes.
 
134
        """
 
135
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
136
        if to_entry:
 
137
            # cannot diff from one kind to another - you must do a removal
 
138
            # and an addif they do not match.
 
139
            assert self.kind == to_entry.kind
 
140
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
141
                                      to_tree)
 
142
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
143
                   output_to, reverse)
 
144
 
 
145
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
146
             output_to, reverse=False):
 
147
        """Perform a diff between two entries of the same kind."""
 
148
 
 
149
    def find_previous_heads(self, previous_inventories, entry_weave):
 
150
        """Return the revisions and entries that directly preceed this.
 
151
 
 
152
        Returned as a map from revision to inventory entry.
 
153
 
 
154
        This is a map containing the file revisions in all parents
 
155
        for which the file exists, and its revision is not a parent of
 
156
        any other. If the file is new, the set will be empty.
 
157
        """
 
158
        def get_ancestors(weave, entry):
 
159
            return set(map(weave.idx_to_name,
 
160
                           weave.inclusions([weave.lookup(entry.revision)])))
 
161
        heads = {}
 
162
        head_ancestors = {}
 
163
        for inv in previous_inventories:
 
164
            if self.file_id in inv:
 
165
                ie = inv[self.file_id]
 
166
                assert ie.file_id == self.file_id
 
167
                if ie.revision in heads:
 
168
                    assert heads[ie.revision] == ie
 
169
                else:
 
170
                    # may want to add it.
 
171
                    # may already be covered:
 
172
                    already_present = 0 != len(
 
173
                        [head for head in heads 
 
174
                         if ie.revision in head_ancestors[head]])
 
175
                    if already_present:
 
176
                        # an ancestor of a known head.
 
177
                        continue
 
178
                    # definately a head:
 
179
                    ancestors = get_ancestors(entry_weave, ie)
 
180
                    # may knock something else out:
 
181
                    check_heads = list(heads.keys())
 
182
                    for head in check_heads:
 
183
                        if head in ancestors:
 
184
                            # this head is not really a head
 
185
                            heads.pop(head)
 
186
                    head_ancestors[ie.revision] = ancestors
 
187
                    heads[ie.revision] = ie
 
188
        return heads
 
189
 
 
190
    def get_tar_item(self, root, dp, now, tree):
 
191
        """Get a tarfile item and a file stream for its content."""
 
192
        item = tarfile.TarInfo(os.path.join(root, dp))
 
193
        # TODO: would be cool to actually set it to the timestamp of the
 
194
        # revision it was last changed
 
195
        item.mtime = now
 
196
        fileobj = self._put_in_tar(item, tree)
 
197
        return item, fileobj
 
198
 
 
199
    def has_text(self):
 
200
        """Return true if the object this entry represents has textual data.
 
201
 
 
202
        Note that textual data includes binary content.
 
203
 
 
204
        Also note that all entries get weave files created for them.
 
205
        This attribute is primarily used when upgrading from old trees that
 
206
        did not have the weave index for all inventory entries.
 
207
        """
 
208
        return False
 
209
 
 
210
    def __init__(self, file_id, name, parent_id, text_id=None):
126
211
        """Create an InventoryEntry
127
212
        
128
213
        The filename must be a single component, relative to the
129
214
        parent directory; it cannot be a whole path or relative name.
130
215
 
131
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
216
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
132
217
        >>> e.name
133
218
        'hello.c'
134
219
        >>> e.file_id
135
220
        '123'
136
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
221
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
137
222
        Traceback (most recent call last):
138
223
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
139
224
        """
147
232
        self.text_size = None
148
233
        self.file_id = file_id
149
234
        self.name = name
150
 
        self.kind = kind
151
235
        self.text_id = text_id
152
236
        self.parent_id = parent_id
153
237
        self.symlink_target = None
154
 
        if kind == 'directory':
155
 
            self.children = {}
156
 
        elif kind == 'file':
157
 
            pass
158
 
        elif kind == 'symlink':
159
 
            pass
160
 
        else:
161
 
            raise BzrError("unhandled entry kind %r" % kind)
162
 
 
163
 
    def read_symlink_target(self, path):
164
 
        if self.kind == 'symlink':
165
 
            try:
166
 
                self.symlink_target = os.readlink(path)
167
 
            except OSError,e:
168
 
                raise BzrError("os.readlink error, %s" % e)
 
238
 
 
239
    def kind_character(self):
 
240
        """Return a short kind indicator useful for appending to names."""
 
241
        raise BzrError('unknown kind %r' % self.kind)
 
242
 
 
243
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
244
 
 
245
    def _put_in_tar(self, item, tree):
 
246
        """populate item for stashing in a tar, and return the content stream.
 
247
 
 
248
        If no content is available, return None.
 
249
        """
 
250
        raise BzrError("don't know how to export {%s} of kind %r" %
 
251
                       (self.file_id, self.kind))
 
252
 
 
253
    def put_on_disk(self, dest, dp, tree):
 
254
        """Create a representation of self on disk in the prefix dest.
 
255
        
 
256
        This is a template method - implement _put_on_disk in subclasses.
 
257
        """
 
258
        fullpath = appendpath(dest, dp)
 
259
        self._put_on_disk(fullpath, tree)
 
260
        mutter("  export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
 
261
 
 
262
    def _put_on_disk(self, fullpath, tree):
 
263
        """Put this entry onto disk at fullpath, from tree tree."""
 
264
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
169
265
 
170
266
    def sorted_children(self):
171
267
        l = self.children.items()
172
268
        l.sort()
173
269
        return l
174
270
 
 
271
    @staticmethod
 
272
    def versionable_kind(kind):
 
273
        return kind in ('file', 'directory', 'symlink')
 
274
 
175
275
    def check(self, checker, rev_id, inv, tree):
 
276
        """Check this inventory entry is intact.
 
277
 
 
278
        This is a template method, override _check for kind specific
 
279
        tests.
 
280
        """
176
281
        if self.parent_id != None:
177
282
            if not inv.has_id(self.parent_id):
178
283
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
179
284
                        % (self.parent_id, rev_id))
180
 
        if self.kind == 'file':
181
 
            revision = self.revision
182
 
            t = (self.file_id, revision)
183
 
            if t in checker.checked_texts:
184
 
                prev_sha = checker.checked_texts[t] 
185
 
                if prev_sha != self.text_sha1:
186
 
                    raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
187
 
                                        (self.file_id, rev_id))
188
 
                else:
189
 
                    checker.repeated_text_cnt += 1
190
 
                    return
191
 
            mutter('check version {%s} of {%s}', rev_id, self.file_id)
192
 
            file_lines = tree.get_file_lines(self.file_id)
193
 
            checker.checked_text_cnt += 1 
194
 
            if self.text_size != sum(map(len, file_lines)):
195
 
                raise BzrCheckError('text {%s} wrong size' % self.text_id)
196
 
            if self.text_sha1 != sha_strings(file_lines):
197
 
                raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
198
 
            checker.checked_texts[t] = self.text_sha1
199
 
        elif self.kind == 'directory':
200
 
            if self.text_sha1 != None or self.text_size != None or self.text_id != None:
201
 
                raise BzrCheckError('directory {%s} has text in revision {%s}'
202
 
                        % (self.file_id, rev_id))
203
 
        elif self.kind == 'root_directory':
204
 
            pass
205
 
        elif self.kind == 'symlink':
206
 
            if self.text_sha1 != None or self.text_size != None or self.text_id != None:
207
 
                raise BzrCheckError('symlink {%s} has text in revision {%s}'
208
 
                        % (self.file_id, rev_id))
209
 
            if self.symlink_target == None:
210
 
                raise BzrCheckError('symlink {%s} has no target in revision {%s}'
211
 
                        % (self.file_id, rev_id))
212
 
        else:
213
 
            raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
214
 
                                (self.kind, rev_id))
 
285
        self._check(checker, rev_id, tree)
 
286
 
 
287
    def _check(self, checker, rev_id, tree):
 
288
        """Check this inventory entry for kind specific errors."""
 
289
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
290
                            (self.kind, rev_id))
215
291
 
216
292
 
217
293
    def copy(self):
218
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
219
 
                               self.parent_id)
220
 
        other.executable = self.executable
221
 
        other.text_id = self.text_id
222
 
        other.text_sha1 = self.text_sha1
223
 
        other.text_size = self.text_size
224
 
        other.symlink_target = self.symlink_target
225
 
        other.revision = self.revision
226
 
        # note that children are *not* copied; they're pulled across when
227
 
        # others are added
228
 
        return other
 
294
        """Clone this inventory entry."""
 
295
        raise NotImplementedError
229
296
 
230
297
    def _get_snapshot_change(self, previous_entries):
231
298
        if len(previous_entries) > 1:
236
303
            return 'modified/renamed/reparented'
237
304
 
238
305
    def __repr__(self):
239
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
306
        return ("%s(%r, %r, parent_id=%r)"
240
307
                % (self.__class__.__name__,
241
308
                   self.file_id,
242
309
                   self.name,
243
 
                   self.kind,
244
310
                   self.parent_id))
245
311
 
246
 
    def snapshot(self, revision, path, previous_entries, work_tree, 
247
 
                 weave_store):
248
 
        """Make a snapshot of this entry.
 
312
    def snapshot(self, revision, path, previous_entries,
 
313
                 work_tree, weave_store):
 
314
        """Make a snapshot of this entry which may or may not have changed.
249
315
        
250
316
        This means that all its fields are populated, that it has its
251
317
        text stored in the text store or weave.
255
321
        if len(previous_entries) == 1:
256
322
            # cannot be unchanged unless there is only one parent file rev.
257
323
            parent_ie = previous_entries.values()[0]
258
 
            if self._unchanged(path, parent_ie, work_tree):
 
324
            if self._unchanged(parent_ie):
259
325
                mutter("found unchanged entry")
260
326
                self.revision = parent_ie.revision
261
327
                return "unchanged"
 
328
        return self.snapshot_revision(revision, previous_entries, 
 
329
                                      work_tree, weave_store)
 
330
 
 
331
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
332
                          weave_store):
 
333
        """Record this revision unconditionally."""
262
334
        mutter('new revision for {%s}', self.file_id)
263
335
        self.revision = revision
264
336
        change = self._get_snapshot_change(previous_entries)
265
 
        if self.kind != 'file':
266
 
            return change
267
337
        self._snapshot_text(previous_entries, work_tree, weave_store)
268
338
        return change
269
339
 
270
340
    def _snapshot_text(self, file_parents, work_tree, weave_store): 
 
341
        """Record the 'text' of this entry, whatever form that takes.
 
342
        
 
343
        This default implementation simply adds an empty text.
 
344
        """
271
345
        mutter('storing file {%s} in revision {%s}',
272
346
               self.file_id, self.revision)
273
 
        # special case to avoid diffing on renames or 
274
 
        # reparenting
275
 
        if (len(file_parents) == 1
276
 
            and self.text_sha1 == file_parents.values()[0].text_sha1
277
 
            and self.text_size == file_parents.values()[0].text_size):
278
 
            previous_ie = file_parents.values()[0]
279
 
            weave_store.add_identical_text(
280
 
                self.file_id, previous_ie.revision, 
281
 
                self.revision, file_parents)
282
 
        else:
283
 
            new_lines = work_tree.get_file(self.file_id).readlines()
284
 
            self._add_text_to_weave(new_lines, file_parents, weave_store)
285
 
            self.text_sha1 = sha_strings(new_lines)
286
 
            self.text_size = sum(map(len, new_lines))
 
347
        self._add_text_to_weave([], file_parents, weave_store)
287
348
 
288
349
    def __eq__(self, other):
289
350
        if not isinstance(other, InventoryEntry):
307
368
    def __hash__(self):
308
369
        raise ValueError('not hashable')
309
370
 
310
 
    def _unchanged(self, path, previous_ie, work_tree):
 
371
    def _unchanged(self, previous_ie):
 
372
        """Has this entry changed relative to previous_ie.
 
373
 
 
374
        This method should be overriden in child classes.
 
375
        """
311
376
        compatible = True
312
377
        # different inv parent
313
378
        if previous_ie.parent_id != self.parent_id:
315
380
        # renamed
316
381
        elif previous_ie.name != self.name:
317
382
            compatible = False
318
 
        if self.kind == 'symlink':
319
 
            if self.symlink_target != previous_ie.symlink_target:
320
 
                compatible = False
321
 
        if self.kind == 'file':
322
 
            if self.text_sha1 != previous_ie.text_sha1:
323
 
                compatible = False
324
 
            else:
325
 
                # FIXME: 20050930 probe for the text size when getting sha1
326
 
                # in _read_tree_state
327
 
                self.text_size = previous_ie.text_size
328
383
        return compatible
329
384
 
330
385
    def _read_tree_state(self, path, work_tree):
331
 
        if self.kind == 'symlink':
332
 
            self.read_symlink_target(work_tree.abspath(path))
333
 
        if self.kind == 'file':
334
 
            self.text_sha1 = work_tree.get_file_sha1(self.file_id)
335
 
            self.executable = work_tree.is_executable(self.file_id)
 
386
        """Populate fields in the inventory entry from the given tree.
 
387
        
 
388
        Note that this should be modified to be a noop on virtual trees
 
389
        as all entries created there are prepopulated.
 
390
        """
336
391
 
337
392
 
338
393
class RootEntry(InventoryEntry):
 
394
 
 
395
    def _check(self, checker, rev_id, tree):
 
396
        """See InventoryEntry._check"""
 
397
 
339
398
    def __init__(self, file_id):
340
399
        self.file_id = file_id
341
400
        self.children = {}
351
410
               and (self.children == other.children)
352
411
 
353
412
 
 
413
class InventoryDirectory(InventoryEntry):
 
414
    """A directory in an inventory."""
 
415
 
 
416
    def _check(self, checker, rev_id, tree):
 
417
        """See InventoryEntry._check"""
 
418
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
419
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
420
                                % (self.file_id, rev_id))
 
421
 
 
422
    def copy(self):
 
423
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
424
        other.revision = self.revision
 
425
        # note that children are *not* copied; they're pulled across when
 
426
        # others are added
 
427
        return other
 
428
 
 
429
    def __init__(self, file_id, name, parent_id):
 
430
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
431
        self.children = {}
 
432
        self.kind = 'directory'
 
433
 
 
434
    def kind_character(self):
 
435
        """See InventoryEntry.kind_character."""
 
436
        return '/'
 
437
 
 
438
    def _put_in_tar(self, item, tree):
 
439
        """See InventoryEntry._put_in_tar."""
 
440
        item.type = tarfile.DIRTYPE
 
441
        fileobj = None
 
442
        item.name += '/'
 
443
        item.size = 0
 
444
        item.mode = 0755
 
445
        return fileobj
 
446
 
 
447
    def _put_on_disk(self, fullpath, tree):
 
448
        """See InventoryEntry._put_on_disk."""
 
449
        os.mkdir(fullpath)
 
450
 
 
451
 
 
452
class InventoryFile(InventoryEntry):
 
453
    """A file in an inventory."""
 
454
 
 
455
    def _check(self, checker, rev_id, tree):
 
456
        """See InventoryEntry._check"""
 
457
        revision = self.revision
 
458
        t = (self.file_id, revision)
 
459
        if t in checker.checked_texts:
 
460
            prev_sha = checker.checked_texts[t] 
 
461
            if prev_sha != self.text_sha1:
 
462
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
463
                                    (self.file_id, rev_id))
 
464
            else:
 
465
                checker.repeated_text_cnt += 1
 
466
                return
 
467
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
468
        file_lines = tree.get_file_lines(self.file_id)
 
469
        checker.checked_text_cnt += 1 
 
470
        if self.text_size != sum(map(len, file_lines)):
 
471
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
472
        if self.text_sha1 != sha_strings(file_lines):
 
473
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
474
        checker.checked_texts[t] = self.text_sha1
 
475
 
 
476
    def copy(self):
 
477
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
478
        other.executable = self.executable
 
479
        other.text_id = self.text_id
 
480
        other.text_sha1 = self.text_sha1
 
481
        other.text_size = self.text_size
 
482
        other.revision = self.revision
 
483
        return other
 
484
 
 
485
    def detect_changes(self, old_entry):
 
486
        """See InventoryEntry.detect_changes."""
 
487
        assert self.text_sha1 != None
 
488
        assert old_entry.text_sha1 != None
 
489
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
490
        meta_modified = (self.executable != old_entry.executable)
 
491
        return text_modified, meta_modified
 
492
 
 
493
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
494
             output_to, reverse=False):
 
495
        """See InventoryEntry._diff."""
 
496
        from_text = tree.get_file(self.file_id).readlines()
 
497
        if to_entry:
 
498
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
499
        else:
 
500
            to_text = []
 
501
        if not reverse:
 
502
            text_diff(from_label, from_text,
 
503
                      to_label, to_text, output_to)
 
504
        else:
 
505
            text_diff(to_label, to_text,
 
506
                      from_label, from_text, output_to)
 
507
 
 
508
    def has_text(self):
 
509
        """See InventoryEntry.has_text."""
 
510
        return True
 
511
 
 
512
    def __init__(self, file_id, name, parent_id):
 
513
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
514
        self.kind = 'file'
 
515
 
 
516
    def kind_character(self):
 
517
        """See InventoryEntry.kind_character."""
 
518
        return ''
 
519
 
 
520
    def _put_in_tar(self, item, tree):
 
521
        """See InventoryEntry._put_in_tar."""
 
522
        item.type = tarfile.REGTYPE
 
523
        fileobj = tree.get_file(self.file_id)
 
524
        item.size = self.text_size
 
525
        if tree.is_executable(self.file_id):
 
526
            item.mode = 0755
 
527
        else:
 
528
            item.mode = 0644
 
529
        return fileobj
 
530
 
 
531
    def _put_on_disk(self, fullpath, tree):
 
532
        """See InventoryEntry._put_on_disk."""
 
533
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
534
        if tree.is_executable(self.file_id):
 
535
            os.chmod(fullpath, 0755)
 
536
 
 
537
    def _read_tree_state(self, path, work_tree):
 
538
        """See InventoryEntry._read_tree_state."""
 
539
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
540
        self.executable = work_tree.is_executable(self.file_id)
 
541
 
 
542
    def _snapshot_text(self, file_parents, work_tree, weave_store): 
 
543
        """See InventoryEntry._snapshot_text."""
 
544
        mutter('storing file {%s} in revision {%s}',
 
545
               self.file_id, self.revision)
 
546
        # special case to avoid diffing on renames or 
 
547
        # reparenting
 
548
        if (len(file_parents) == 1
 
549
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
550
            and self.text_size == file_parents.values()[0].text_size):
 
551
            previous_ie = file_parents.values()[0]
 
552
            weave_store.add_identical_text(
 
553
                self.file_id, previous_ie.revision, 
 
554
                self.revision, file_parents)
 
555
        else:
 
556
            new_lines = work_tree.get_file(self.file_id).readlines()
 
557
            self._add_text_to_weave(new_lines, file_parents, weave_store)
 
558
            self.text_sha1 = sha_strings(new_lines)
 
559
            self.text_size = sum(map(len, new_lines))
 
560
 
 
561
 
 
562
    def _unchanged(self, previous_ie):
 
563
        """See InventoryEntry._unchanged."""
 
564
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
565
        if self.text_sha1 != previous_ie.text_sha1:
 
566
            compatible = False
 
567
        else:
 
568
            # FIXME: 20050930 probe for the text size when getting sha1
 
569
            # in _read_tree_state
 
570
            self.text_size = previous_ie.text_size
 
571
        return compatible
 
572
 
 
573
 
 
574
class InventoryLink(InventoryEntry):
 
575
    """A file in an inventory."""
 
576
 
 
577
    __slots__ = ['symlink_target']
 
578
 
 
579
    def _check(self, checker, rev_id, tree):
 
580
        """See InventoryEntry._check"""
 
581
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
582
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
583
                    % (self.file_id, rev_id))
 
584
        if self.symlink_target == None:
 
585
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
586
                    % (self.file_id, rev_id))
 
587
 
 
588
    def copy(self):
 
589
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
590
        other.symlink_target = self.symlink_target
 
591
        other.revision = self.revision
 
592
        return other
 
593
 
 
594
    def detect_changes(self, old_entry):
 
595
        """See InventoryEntry.detect_changes."""
 
596
        # FIXME: which _modified field should we use ? RBC 20051003
 
597
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
598
        if text_modified:
 
599
            mutter("    symlink target changed")
 
600
        meta_modified = False
 
601
        return text_modified, meta_modified
 
602
 
 
603
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
604
             output_to, reverse=False):
 
605
        """See InventoryEntry._diff."""
 
606
        from_text = self.symlink_target
 
607
        if to_entry is not None:
 
608
            to_text = to_entry.symlink_target
 
609
            if reverse:
 
610
                temp = from_text
 
611
                from_text = to_text
 
612
                to_text = temp
 
613
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
614
        else:
 
615
            if not reverse:
 
616
                print >>output_to, '=== target was %r' % self.symlink_target
 
617
            else:
 
618
                print >>output_to, '=== target is %r' % self.symlink_target
 
619
 
 
620
    def __init__(self, file_id, name, parent_id):
 
621
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
622
        self.kind = 'symlink'
 
623
 
 
624
    def kind_character(self):
 
625
        """See InventoryEntry.kind_character."""
 
626
        return ''
 
627
 
 
628
    def _put_in_tar(self, item, tree):
 
629
        """See InventoryEntry._put_in_tar."""
 
630
        iterm.type = tarfile.SYMTYPE
 
631
        fileobj = None
 
632
        item.size = 0
 
633
        item.mode = 0755
 
634
        item.linkname = self.symlink_target
 
635
        return fileobj
 
636
 
 
637
    def _put_on_disk(self, fullpath, tree):
 
638
        """See InventoryEntry._put_on_disk."""
 
639
        try:
 
640
            os.symlink(self.symlink_target, fullpath)
 
641
        except OSError,e:
 
642
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
643
 
 
644
    def _read_tree_state(self, path, work_tree):
 
645
        """See InventoryEntry._read_tree_state."""
 
646
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
647
 
 
648
    def _unchanged(self, previous_ie):
 
649
        """See InventoryEntry._unchanged."""
 
650
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
651
        if self.symlink_target != previous_ie.symlink_target:
 
652
            compatible = False
 
653
        return compatible
 
654
 
354
655
 
355
656
class Inventory(object):
356
657
    """Inventory of versioned files in a tree.
370
671
    inserted, other than through the Inventory API.
371
672
 
372
673
    >>> inv = Inventory()
373
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
374
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
674
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
675
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
375
676
    >>> inv['123-123'].name
376
677
    'hello.c'
377
678
 
387
688
    >>> [x[0] for x in inv.iter_entries()]
388
689
    ['hello.c']
389
690
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
390
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
391
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
 
691
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
692
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
392
693
    """
393
694
    def __init__(self, root_id=ROOT_ID):
394
695
        """Create or read an inventory.
486
787
        """True if this entry contains a file with given id.
487
788
 
488
789
        >>> inv = Inventory()
489
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
490
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
790
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
791
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
491
792
        >>> '123' in inv
492
793
        True
493
794
        >>> '456' in inv
500
801
        """Return the entry for given file_id.
501
802
 
502
803
        >>> inv = Inventory()
503
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
504
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
804
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
805
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
505
806
        >>> inv['123123'].name
506
807
        'hello.c'
507
808
        """
569
870
        if parent_id == None:
570
871
            raise NotVersionedError(parent_path)
571
872
 
572
 
        ie = InventoryEntry(file_id, parts[-1],
573
 
                            kind=kind, parent_id=parent_id)
 
873
        if kind == 'directory':
 
874
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
875
        elif kind == 'file':
 
876
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
877
        elif kind == 'symlink':
 
878
            ie = InventoryLink(file_id, parts[-1], parent_id)
 
879
        else:
 
880
            raise BzrError("unknown kind %r" % kind)
574
881
        return self.add(ie)
575
882
 
576
883
 
578
885
        """Remove entry by id.
579
886
 
580
887
        >>> inv = Inventory()
581
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
582
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
888
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
889
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
583
890
        >>> '123' in inv
584
891
        True
585
892
        >>> del inv['123']
608
915
        >>> i2 = Inventory()
609
916
        >>> i1 == i2
610
917
        True
611
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
612
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
918
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
919
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
613
920
        >>> i1 == i2
614
921
        False
615
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
616
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
922
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
923
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
617
924
        >>> i1 == i2
618
925
        True
619
926
        """
655
962
 
656
963
 
657
964
    def id2path(self, file_id):
658
 
        """Return as a list the path to file_id."""
659
 
 
 
965
        """Return as a list the path to file_id.
 
966
        
 
967
        >>> i = Inventory()
 
968
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
969
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
970
        >>> print i.id2path('foo-id').replace(os.sep, '/')
 
971
        src/foo.c
 
972
        """
660
973
        # get all names, skipping root
661
974
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
662
975
        return os.sep.join(p)