~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-10-11 08:31:29 UTC
  • Revision ID: robertc@lifelesslap.robertcollins.net-20051011083129-fa720bc6cd6c039f
inline and simplify branch.find_branch_root, it should just try to create a branch at each step, which is simpler than probing for a specific dir and has less round trips.

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