~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-10-04 02:54:54 UTC
  • mfrom: (1399.1.12)
  • mto: (1185.13.3)
  • mto: This revision was merged to the branch mainline in revision 1400.
  • Revision ID: mbp@sourcefrog.net-20051004025454-a8da093aebf1fb24
[merge] refactoring from robert to use different Entry classes
for files, directories, etc.

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 get_tar_item(self, root, dp, now, tree):
 
150
        """Get a tarfile item and a file stream for its content."""
 
151
        item = tarfile.TarInfo(os.path.join(root, dp))
 
152
        # TODO: would be cool to actually set it to the timestamp of the
 
153
        # revision it was last changed
 
154
        item.mtime = now
 
155
        fileobj = self._put_in_tar(item, tree)
 
156
        return item, fileobj
 
157
 
 
158
    def has_text(self):
 
159
        """Return true if the object this entry represents has textual data.
 
160
 
 
161
        Note that textual data includes binary content.
 
162
        """
 
163
        return False
 
164
 
 
165
    def __init__(self, file_id, name, parent_id, text_id=None):
126
166
        """Create an InventoryEntry
127
167
        
128
168
        The filename must be a single component, relative to the
129
169
        parent directory; it cannot be a whole path or relative name.
130
170
 
131
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
171
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
132
172
        >>> e.name
133
173
        'hello.c'
134
174
        >>> e.file_id
135
175
        '123'
136
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
176
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
137
177
        Traceback (most recent call last):
138
178
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
139
179
        """
147
187
        self.text_size = None
148
188
        self.file_id = file_id
149
189
        self.name = name
150
 
        self.kind = kind
151
190
        self.text_id = text_id
152
191
        self.parent_id = parent_id
153
192
        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)
 
193
 
 
194
    def kind_character(self):
 
195
        """Return a short kind indicator useful for appending to names."""
 
196
        raise BzrError('unknown kind %r' % self.kind)
 
197
 
 
198
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
199
 
 
200
    def _put_in_tar(self, item, tree):
 
201
        """populate item for stashing in a tar, and return the content stream.
 
202
 
 
203
        If no content is available, return None.
 
204
        """
 
205
        raise BzrError("don't know how to export {%s} of kind %r" %
 
206
                       (self.file_id, self.kind))
 
207
 
 
208
    def put_on_disk(self, dest, dp, tree):
 
209
        """Create a representation of self on disk in the prefix dest.
 
210
        
 
211
        This is a template method - implement _put_on_disk in subclasses.
 
212
        """
 
213
        fullpath = appendpath(dest, dp)
 
214
        self._put_on_disk(fullpath, tree)
 
215
        mutter("  export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
 
216
 
 
217
    def _put_on_disk(self, fullpath, tree):
 
218
        """Put this entry onto disk at fullpath, from tree tree."""
 
219
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
169
220
 
170
221
    def sorted_children(self):
171
222
        l = self.children.items()
172
223
        l.sort()
173
224
        return l
174
225
 
 
226
    @staticmethod
 
227
    def versionable_kind(kind):
 
228
        return kind in ('file', 'directory', 'symlink')
 
229
 
175
230
    def check(self, checker, rev_id, inv, tree):
 
231
        """Check this inventory entry is intact.
 
232
 
 
233
        This is a template method, override _check for kind specific
 
234
        tests.
 
235
        """
176
236
        if self.parent_id != None:
177
237
            if not inv.has_id(self.parent_id):
178
238
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
179
239
                        % (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))
 
240
        self._check(checker, rev_id, tree)
 
241
 
 
242
    def _check(self, checker, rev_id, tree):
 
243
        """Check this inventory entry for kind specific errors."""
 
244
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
245
                            (self.kind, rev_id))
215
246
 
216
247
 
217
248
    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
 
249
        """Clone this inventory entry."""
 
250
        raise NotImplementedError
229
251
 
230
252
    def _get_snapshot_change(self, previous_entries):
231
253
        if len(previous_entries) > 1:
236
258
            return 'modified/renamed/reparented'
237
259
 
238
260
    def __repr__(self):
239
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
261
        return ("%s(%r, %r, parent_id=%r)"
240
262
                % (self.__class__.__name__,
241
263
                   self.file_id,
242
264
                   self.name,
243
 
                   self.kind,
244
265
                   self.parent_id))
245
266
 
246
267
    def snapshot(self, revision, path, previous_entries, work_tree, 
247
268
                 weave_store):
248
 
        """Make a snapshot of this entry.
 
269
        """Make a snapshot of this entry which may or may not have changed.
249
270
        
250
271
        This means that all its fields are populated, that it has its
251
272
        text stored in the text store or weave.
259
280
                mutter("found unchanged entry")
260
281
                self.revision = parent_ie.revision
261
282
                return "unchanged"
 
283
        return self.snapshot_revision(revision, previous_entries, 
 
284
                                      work_tree, weave_store)
 
285
 
 
286
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
287
                          weave_store):
 
288
        """Record this revision unconditionally."""
262
289
        mutter('new revision for {%s}', self.file_id)
263
290
        self.revision = revision
264
291
        change = self._get_snapshot_change(previous_entries)
265
 
        if self.kind != 'file':
266
 
            return change
267
 
        self._snapshot_text(previous_entries, work_tree, weave_store)
268
292
        return change
269
293
 
270
294
    def _snapshot_text(self, file_parents, work_tree, weave_store): 
308
332
        raise ValueError('not hashable')
309
333
 
310
334
    def _unchanged(self, path, previous_ie, work_tree):
 
335
        """Has this entry changed relative to previous_ie.
 
336
 
 
337
        This method should be overriden in child classes.
 
338
        """
311
339
        compatible = True
312
340
        # different inv parent
313
341
        if previous_ie.parent_id != self.parent_id:
315
343
        # renamed
316
344
        elif previous_ie.name != self.name:
317
345
            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
346
        return compatible
329
347
 
330
348
    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)
 
349
        """Populate fields in the inventory entry from the given tree.
 
350
        
 
351
        Note that this should be modified to be a noop on virtual trees
 
352
        as all entries created there are prepopulated.
 
353
        """
336
354
 
337
355
 
338
356
class RootEntry(InventoryEntry):
 
357
 
 
358
    def _check(self, checker, rev_id, tree):
 
359
        """See InventoryEntry._check"""
 
360
 
339
361
    def __init__(self, file_id):
340
362
        self.file_id = file_id
341
363
        self.children = {}
351
373
               and (self.children == other.children)
352
374
 
353
375
 
 
376
class InventoryDirectory(InventoryEntry):
 
377
    """A directory in an inventory."""
 
378
 
 
379
    def _check(self, checker, rev_id, tree):
 
380
        """See InventoryEntry._check"""
 
381
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
382
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
383
                                % (self.file_id, rev_id))
 
384
 
 
385
    def copy(self):
 
386
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
387
        other.revision = self.revision
 
388
        # note that children are *not* copied; they're pulled across when
 
389
        # others are added
 
390
        return other
 
391
 
 
392
    def __init__(self, file_id, name, parent_id):
 
393
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
394
        self.children = {}
 
395
        self.kind = 'directory'
 
396
 
 
397
    def kind_character(self):
 
398
        """See InventoryEntry.kind_character."""
 
399
        return '/'
 
400
 
 
401
    def _put_in_tar(self, item, tree):
 
402
        """See InventoryEntry._put_in_tar."""
 
403
        item.type = tarfile.DIRTYPE
 
404
        fileobj = None
 
405
        item.name += '/'
 
406
        item.size = 0
 
407
        item.mode = 0755
 
408
        return fileobj
 
409
 
 
410
    def _put_on_disk(self, fullpath, tree):
 
411
        """See InventoryEntry._put_on_disk."""
 
412
        os.mkdir(fullpath)
 
413
 
 
414
 
 
415
class InventoryFile(InventoryEntry):
 
416
    """A file in an inventory."""
 
417
 
 
418
    def _check(self, checker, rev_id, tree):
 
419
        """See InventoryEntry._check"""
 
420
        revision = self.revision
 
421
        t = (self.file_id, revision)
 
422
        if t in checker.checked_texts:
 
423
            prev_sha = checker.checked_texts[t] 
 
424
            if prev_sha != self.text_sha1:
 
425
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
426
                                    (self.file_id, rev_id))
 
427
            else:
 
428
                checker.repeated_text_cnt += 1
 
429
                return
 
430
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
431
        file_lines = tree.get_file_lines(self.file_id)
 
432
        checker.checked_text_cnt += 1 
 
433
        if self.text_size != sum(map(len, file_lines)):
 
434
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
435
        if self.text_sha1 != sha_strings(file_lines):
 
436
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
437
        checker.checked_texts[t] = self.text_sha1
 
438
 
 
439
    def copy(self):
 
440
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
441
        other.executable = self.executable
 
442
        other.text_id = self.text_id
 
443
        other.text_sha1 = self.text_sha1
 
444
        other.text_size = self.text_size
 
445
        other.revision = self.revision
 
446
        return other
 
447
 
 
448
    def detect_changes(self, old_entry):
 
449
        """See InventoryEntry.detect_changes."""
 
450
        assert self.text_sha1 != None
 
451
        assert old_entry.text_sha1 != None
 
452
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
453
        meta_modified = (self.executable != old_entry.executable)
 
454
        return text_modified, meta_modified
 
455
 
 
456
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
457
             output_to, reverse=False):
 
458
        """See InventoryEntry._diff."""
 
459
        from_text = tree.get_file(self.file_id).readlines()
 
460
        if to_entry:
 
461
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
462
        else:
 
463
            to_text = []
 
464
        if not reverse:
 
465
            text_diff(from_label, from_text,
 
466
                      to_label, to_text, output_to)
 
467
        else:
 
468
            text_diff(to_label, to_text,
 
469
                      from_label, from_text, output_to)
 
470
 
 
471
    def has_text(self):
 
472
        """See InventoryEntry.has_text."""
 
473
        return True
 
474
 
 
475
    def __init__(self, file_id, name, parent_id):
 
476
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
477
        self.kind = 'file'
 
478
 
 
479
    def kind_character(self):
 
480
        """See InventoryEntry.kind_character."""
 
481
        return ''
 
482
 
 
483
    def _put_in_tar(self, item, tree):
 
484
        """See InventoryEntry._put_in_tar."""
 
485
        item.type = tarfile.REGTYPE
 
486
        fileobj = tree.get_file(self.file_id)
 
487
        item.size = self.text_size
 
488
        if tree.is_executable(self.file_id):
 
489
            item.mode = 0755
 
490
        else:
 
491
            item.mode = 0644
 
492
        return fileobj
 
493
 
 
494
    def _put_on_disk(self, fullpath, tree):
 
495
        """See InventoryEntry._put_on_disk."""
 
496
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
497
        if tree.is_executable(self.file_id):
 
498
            os.chmod(fullpath, 0755)
 
499
 
 
500
    def _read_tree_state(self, path, work_tree):
 
501
        """See InventoryEntry._read_tree_state."""
 
502
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
503
        self.executable = work_tree.is_executable(self.file_id)
 
504
 
 
505
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
506
                          weave_store):
 
507
        """See InventoryEntry.snapshot_revision."""
 
508
        change = super(InventoryFile, self).snapshot_revision(revision, 
 
509
            previous_entries, work_tree, weave_store)
 
510
        self._snapshot_text(previous_entries, work_tree, weave_store)
 
511
        return change
 
512
 
 
513
    def _unchanged(self, path, previous_ie, work_tree):
 
514
        """See InventoryEntry._unchanged."""
 
515
        compatible = super(InventoryFile, self)._unchanged(path, previous_ie, 
 
516
            work_tree)
 
517
        if self.text_sha1 != previous_ie.text_sha1:
 
518
            compatible = False
 
519
        else:
 
520
            # FIXME: 20050930 probe for the text size when getting sha1
 
521
            # in _read_tree_state
 
522
            self.text_size = previous_ie.text_size
 
523
        return compatible
 
524
 
 
525
 
 
526
class InventoryLink(InventoryEntry):
 
527
    """A file in an inventory."""
 
528
 
 
529
    __slots__ = ['symlink_target']
 
530
 
 
531
    def _check(self, checker, rev_id, tree):
 
532
        """See InventoryEntry._check"""
 
533
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
534
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
535
                    % (self.file_id, rev_id))
 
536
        if self.symlink_target == None:
 
537
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
538
                    % (self.file_id, rev_id))
 
539
 
 
540
    def copy(self):
 
541
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
542
        other.symlink_target = self.symlink_target
 
543
        other.revision = self.revision
 
544
        return other
 
545
 
 
546
    def detect_changes(self, old_entry):
 
547
        """See InventoryEntry.detect_changes."""
 
548
        # FIXME: which _modified field should we use ? RBC 20051003
 
549
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
550
        if text_modified:
 
551
            mutter("    symlink target changed")
 
552
        meta_modified = False
 
553
        return text_modified, meta_modified
 
554
 
 
555
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
556
             output_to, reverse=False):
 
557
        """See InventoryEntry._diff."""
 
558
        from_text = self.symlink_target
 
559
        if to_entry is not None:
 
560
            to_text = to_entry.symlink_target
 
561
            if reverse:
 
562
                temp = from_text
 
563
                from_text = to_text
 
564
                to_text = temp
 
565
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
566
        else:
 
567
            if not reverse:
 
568
                print >>output_to, '=== target was %r' % self.symlink_target
 
569
            else:
 
570
                print >>output_to, '=== target is %r' % self.symlink_target
 
571
 
 
572
    def __init__(self, file_id, name, parent_id):
 
573
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
574
        self.kind = 'symlink'
 
575
 
 
576
    def kind_character(self):
 
577
        """See InventoryEntry.kind_character."""
 
578
        return ''
 
579
 
 
580
    def _put_in_tar(self, item, tree):
 
581
        """See InventoryEntry._put_in_tar."""
 
582
        iterm.type = tarfile.SYMTYPE
 
583
        fileobj = None
 
584
        item.size = 0
 
585
        item.mode = 0755
 
586
        item.linkname = self.symlink_target
 
587
        return fileobj
 
588
 
 
589
    def _put_on_disk(self, fullpath, tree):
 
590
        """See InventoryEntry._put_on_disk."""
 
591
        try:
 
592
            os.symlink(self.symlink_target, fullpath)
 
593
        except OSError,e:
 
594
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
595
 
 
596
    def _read_tree_state(self, path, work_tree):
 
597
        """See InventoryEntry._read_tree_state."""
 
598
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
599
 
 
600
    def _unchanged(self, path, previous_ie, work_tree):
 
601
        """See InventoryEntry._unchanged."""
 
602
        compatible = super(InventoryLink, self)._unchanged(path, previous_ie, 
 
603
            work_tree)
 
604
        if self.symlink_target != previous_ie.symlink_target:
 
605
            compatible = False
 
606
        return compatible
 
607
 
354
608
 
355
609
class Inventory(object):
356
610
    """Inventory of versioned files in a tree.
370
624
    inserted, other than through the Inventory API.
371
625
 
372
626
    >>> 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')
 
627
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
628
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
375
629
    >>> inv['123-123'].name
376
630
    'hello.c'
377
631
 
387
641
    >>> [x[0] for x in inv.iter_entries()]
388
642
    ['hello.c']
389
643
    >>> 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')
 
644
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
645
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
392
646
    """
393
647
    def __init__(self, root_id=ROOT_ID):
394
648
        """Create or read an inventory.
486
740
        """True if this entry contains a file with given id.
487
741
 
488
742
        >>> inv = Inventory()
489
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
490
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
743
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
744
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
491
745
        >>> '123' in inv
492
746
        True
493
747
        >>> '456' in inv
500
754
        """Return the entry for given file_id.
501
755
 
502
756
        >>> inv = Inventory()
503
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
504
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
757
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
758
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
505
759
        >>> inv['123123'].name
506
760
        'hello.c'
507
761
        """
569
823
        if parent_id == None:
570
824
            raise NotVersionedError(parent_path)
571
825
 
572
 
        ie = InventoryEntry(file_id, parts[-1],
573
 
                            kind=kind, parent_id=parent_id)
 
826
        if kind == 'directory':
 
827
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
828
        elif kind == 'file':
 
829
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
830
        elif kind == 'symlink':
 
831
            ie = InventoryLink(file_id, parts[-1], parent_id)
 
832
        else:
 
833
            raise BzrError("unknown kind %r" % kind)
574
834
        return self.add(ie)
575
835
 
576
836
 
578
838
        """Remove entry by id.
579
839
 
580
840
        >>> inv = Inventory()
581
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
582
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
841
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
842
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
583
843
        >>> '123' in inv
584
844
        True
585
845
        >>> del inv['123']
608
868
        >>> i2 = Inventory()
609
869
        >>> i1 == i2
610
870
        True
611
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
612
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
871
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
872
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
613
873
        >>> i1 == i2
614
874
        False
615
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
616
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
875
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
876
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
617
877
        >>> i1 == i2
618
878
        True
619
879
        """