~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-10-08 08:45:42 UTC
  • Revision ID: robertc@robertcollins.net-20051008084542-48ea5a99756f970e
add rm alias to remove

Show diffs side-by-side

added added

removed removed

Lines of Context:
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
 
 
18
# TODO: Maybe also keep the full path of the entry, and the children?
 
19
# But those depend on its position within a particular inventory, and
 
20
# it would be nice not to need to hold the backpointer here.
 
21
 
18
22
# This should really be an id randomly assigned when the tree is
19
23
# created, but it's not for now.
20
24
ROOT_ID = "TREE_ROOT"
21
25
 
22
26
 
23
 
import sys, os.path, types, re
 
27
import os.path
 
28
import re
 
29
import sys
 
30
import tarfile
 
31
import types
24
32
 
25
33
import bzrlib
26
34
from bzrlib.errors import BzrError, BzrCheckError
27
35
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
36
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
37
                            appendpath, sha_strings)
29
38
from bzrlib.trace import mutter
 
39
from bzrlib.errors import NotVersionedError
 
40
 
30
41
 
31
42
class InventoryEntry(object):
32
43
    """Description of a versioned file.
34
45
    An InventoryEntry has the following fields, which are also
35
46
    present in the XML inventory-entry element:
36
47
 
37
 
    * *file_id*
38
 
    * *name*: (only the basename within the directory, must not
39
 
      contain slashes)
40
 
    * *kind*: "directory" or "file"
41
 
    * *directory_id*: (if absent/null means the branch root directory)
42
 
    * *text_sha1*: only for files
43
 
    * *text_size*: in bytes, only for files 
44
 
    * *text_id*: identifier for the text version, only for files
45
 
 
46
 
    InventoryEntries can also exist inside a WorkingTree
47
 
    inventory, in which case they are not yet bound to a
48
 
    particular revision of the file.  In that case the text_sha1,
49
 
    text_size and text_id are absent.
50
 
 
 
48
    file_id
 
49
 
 
50
    name
 
51
        (within the parent directory)
 
52
 
 
53
    parent_id
 
54
        file_id of the parent directory, or ROOT_ID
 
55
 
 
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.
 
63
 
 
64
    text_sha1
 
65
        sha-1 of the text of the file
 
66
        
 
67
    text_size
 
68
        size in bytes of the text of the file
 
69
        
 
70
    (reading a version 4 tree created a text_id field.)
51
71
 
52
72
    >>> i = Inventory()
53
73
    >>> i.path2id('')
54
74
    'TREE_ROOT'
55
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
56
 
    >>> i.add(InventoryEntry('2323', 'hello.c', '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')
57
79
    >>> for j in i.iter_entries():
58
80
    ...   print j
59
81
    ... 
60
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
61
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
62
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
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'))
63
85
    Traceback (most recent call last):
64
86
    ...
65
87
    BzrError: inventory already contains entry with id {2323}
66
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
67
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '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')
68
92
    >>> i.path2id('src/wibble')
69
93
    '2325'
70
94
    >>> '2325' in i
71
95
    True
72
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
96
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
97
    InventoryFile('2326', 'wibble.c', parent_id='2325')
73
98
    >>> i['2326']
74
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
75
 
    >>> for j in i.iter_entries():
76
 
    ...     print j[0]
77
 
    ...     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)
78
103
    ... 
79
104
    src
80
105
    src/bye.c
81
106
    src/hello.c
82
107
    src/wibble
83
108
    src/wibble/wibble.c
84
 
    >>> i.id2path('2326')
 
109
    >>> i.id2path('2326').replace('\\\\', '/')
85
110
    'src/wibble/wibble.c'
86
 
 
87
 
    TODO: Maybe also keep the full path of the entry, and the children?
88
 
           But those depend on its position within a particular inventory, and
89
 
           it would be nice not to need to hold the backpointer here.
90
111
    """
91
 
 
92
 
    # TODO: split InventoryEntry into subclasses for files,
93
 
    # directories, etc etc.
94
 
 
 
112
    
95
113
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
96
 
                 'text_id', 'parent_id', 'children', ]
97
 
 
98
 
    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):
99
220
        """Create an InventoryEntry
100
221
        
101
222
        The filename must be a single component, relative to the
102
223
        parent directory; it cannot be a whole path or relative name.
103
224
 
104
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
225
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
105
226
        >>> e.name
106
227
        'hello.c'
107
228
        >>> e.file_id
108
229
        '123'
109
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
230
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
110
231
        Traceback (most recent call last):
111
232
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
112
233
        """
 
234
        assert isinstance(name, basestring), name
113
235
        if '/' in name or '\\' in name:
114
236
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
115
237
        
 
238
        self.executable = False
 
239
        self.revision = None
116
240
        self.text_sha1 = None
117
241
        self.text_size = None
118
 
    
119
242
        self.file_id = file_id
120
243
        self.name = name
121
 
        self.kind = kind
122
244
        self.text_id = text_id
123
245
        self.parent_id = parent_id
124
 
        if kind == 'directory':
125
 
            self.children = {}
126
 
        elif kind == 'file':
127
 
            pass
128
 
        else:
129
 
            raise BzrError("unhandled entry kind %r" % kind)
130
 
 
131
 
 
 
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))
132
274
 
133
275
    def sorted_children(self):
134
276
        l = self.children.items()
135
277
        l.sort()
136
278
        return l
137
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
 
138
301
 
139
302
    def copy(self):
140
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
141
 
                               self.parent_id, text_id=self.text_id)
142
 
        other.text_sha1 = self.text_sha1
143
 
        other.text_size = self.text_size
144
 
        # note that children are *not* copied; they're pulled across when
145
 
        # others are added
146
 
        return other
 
303
        """Clone this inventory entry."""
 
304
        raise NotImplementedError
147
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'
148
313
 
149
314
    def __repr__(self):
150
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
315
        return ("%s(%r, %r, parent_id=%r)"
151
316
                % (self.__class__.__name__,
152
317
                   self.file_id,
153
318
                   self.name,
154
 
                   self.kind,
155
319
                   self.parent_id))
156
320
 
157
 
    
158
 
    def to_element(self):
159
 
        """Convert to XML element"""
160
 
        from bzrlib.xml import Element
161
 
        
162
 
        e = Element('entry')
163
 
 
164
 
        e.set('name', self.name)
165
 
        e.set('file_id', self.file_id)
166
 
        e.set('kind', self.kind)
167
 
 
168
 
        if self.text_size != None:
169
 
            e.set('text_size', '%d' % self.text_size)
170
 
            
171
 
        for f in ['text_id', 'text_sha1']:
172
 
            v = getattr(self, f)
173
 
            if v != None:
174
 
                e.set(f, v)
175
 
 
176
 
        # to be conservative, we don't externalize the root pointers
177
 
        # for now, leaving them as null in the xml form.  in a future
178
 
        # version it will be implied by nested elements.
179
 
        if self.parent_id != ROOT_ID:
180
 
            assert isinstance(self.parent_id, basestring)
181
 
            e.set('parent_id', self.parent_id)
182
 
 
183
 
        e.tail = '\n'
184
 
            
185
 
        return e
186
 
 
187
 
 
188
 
    def from_element(cls, elt):
189
 
        assert elt.tag == 'entry'
190
 
 
191
 
        ## original format inventories don't have a parent_id for
192
 
        ## nodes in the root directory, but it's cleaner to use one
193
 
        ## internally.
194
 
        parent_id = elt.get('parent_id')
195
 
        if parent_id == None:
196
 
            parent_id = ROOT_ID
197
 
 
198
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
199
 
        self.text_id = elt.get('text_id')
200
 
        self.text_sha1 = elt.get('text_sha1')
201
 
        
202
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
203
 
 
204
 
        v = elt.get('text_size')
205
 
        self.text_size = v and int(v)
206
 
 
207
 
        return self
208
 
            
209
 
 
210
 
    from_element = classmethod(from_element)
 
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)
211
358
 
212
359
    def __eq__(self, other):
213
360
        if not isinstance(other, InventoryEntry):
214
361
            return NotImplemented
215
362
 
216
 
        return (self.file_id == other.file_id) \
217
 
               and (self.name == other.name) \
218
 
               and (self.text_sha1 == other.text_sha1) \
219
 
               and (self.text_size == other.text_size) \
220
 
               and (self.text_id == other.text_id) \
221
 
               and (self.parent_id == other.parent_id) \
222
 
               and (self.kind == other.kind)
223
 
 
 
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
                )
224
374
 
225
375
    def __ne__(self, other):
226
376
        return not (self == other)
228
378
    def __hash__(self):
229
379
        raise ValueError('not hashable')
230
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
        """
231
401
 
232
402
 
233
403
class RootEntry(InventoryEntry):
 
404
 
 
405
    def _check(self, checker, rev_id, tree):
 
406
        """See InventoryEntry._check"""
 
407
 
234
408
    def __init__(self, file_id):
235
409
        self.file_id = file_id
236
410
        self.children = {}
246
420
               and (self.children == other.children)
247
421
 
248
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
 
249
668
 
250
669
class Inventory(object):
251
670
    """Inventory of versioned files in a tree.
265
684
    inserted, other than through the Inventory API.
266
685
 
267
686
    >>> inv = Inventory()
268
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
687
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
688
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
269
689
    >>> inv['123-123'].name
270
690
    'hello.c'
271
691
 
281
701
    >>> [x[0] for x in inv.iter_entries()]
282
702
    ['hello.c']
283
703
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
284
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
704
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
705
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
285
706
    """
286
707
    def __init__(self, root_id=ROOT_ID):
287
708
        """Create or read an inventory.
293
714
        The inventory is created with a default root directory, with
294
715
        an id of None.
295
716
        """
296
 
        # We are letting Branch(init=True) create a unique inventory
 
717
        # We are letting Branch.initialize() create a unique inventory
297
718
        # root id. Rather than generating a random one here.
298
719
        #if root_id is None:
299
720
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
301
722
        self._byid = {self.root.file_id: self.root}
302
723
 
303
724
 
 
725
    def copy(self):
 
726
        other = Inventory(self.root.file_id)
 
727
        # copy recursively so we know directories will be added before
 
728
        # their children.  There are more efficient ways than this...
 
729
        for path, entry in self.iter_entries():
 
730
            if entry == self.root:
 
731
                continue
 
732
            other.add(entry.copy())
 
733
        return other
 
734
 
 
735
 
304
736
    def __iter__(self):
305
737
        return iter(self._byid)
306
738
 
368
800
        """True if this entry contains a file with given id.
369
801
 
370
802
        >>> inv = Inventory()
371
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
803
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
804
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
372
805
        >>> '123' in inv
373
806
        True
374
807
        >>> '456' in inv
381
814
        """Return the entry for given file_id.
382
815
 
383
816
        >>> inv = Inventory()
384
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
817
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
818
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
385
819
        >>> inv['123123'].name
386
820
        'hello.c'
387
821
        """
405
839
        """Add entry to inventory.
406
840
 
407
841
        To add  a file to a branch ready to be committed, use Branch.add,
408
 
        which calls this."""
 
842
        which calls this.
 
843
 
 
844
        Returns the new entry object.
 
845
        """
409
846
        if entry.file_id in self._byid:
410
847
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
411
848
 
423
860
 
424
861
        self._byid[entry.file_id] = entry
425
862
        parent.children[entry.name] = entry
 
863
        return entry
426
864
 
427
865
 
428
866
    def add_path(self, relpath, kind, file_id=None):
429
867
        """Add entry from a path.
430
868
 
431
 
        The immediate parent must already be versioned"""
432
 
        from bzrlib.errors import NotVersionedError
 
869
        The immediate parent must already be versioned.
 
870
 
 
871
        Returns the new entry object."""
 
872
        from bzrlib.branch import gen_file_id
433
873
        
434
874
        parts = bzrlib.osutils.splitpath(relpath)
435
875
        if len(parts) == 0:
436
876
            raise BzrError("cannot re-add root of inventory")
437
877
 
438
878
        if file_id == None:
439
 
            from bzrlib.branch import gen_file_id
440
879
            file_id = gen_file_id(relpath)
441
880
 
442
881
        parent_path = parts[:-1]
444
883
        if parent_id == None:
445
884
            raise NotVersionedError(parent_path)
446
885
 
447
 
        ie = InventoryEntry(file_id, parts[-1],
448
 
                            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)
449
894
        return self.add(ie)
450
895
 
451
896
 
453
898
        """Remove entry by id.
454
899
 
455
900
        >>> inv = Inventory()
456
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
901
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
902
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
457
903
        >>> '123' in inv
458
904
        True
459
905
        >>> del inv['123']
475
921
        del self[ie.parent_id].children[ie.name]
476
922
 
477
923
 
478
 
    def to_element(self):
479
 
        """Convert to XML Element"""
480
 
        from bzrlib.xml import Element
481
 
        
482
 
        e = Element('inventory')
483
 
        e.text = '\n'
484
 
        if self.root.file_id not in (None, ROOT_ID):
485
 
            e.set('file_id', self.root.file_id)
486
 
        for path, ie in self.iter_entries():
487
 
            e.append(ie.to_element())
488
 
        return e
489
 
    
490
 
 
491
 
    def from_element(cls, elt):
492
 
        """Construct from XML Element
493
 
        
494
 
        >>> inv = Inventory()
495
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
496
 
        >>> elt = inv.to_element()
497
 
        >>> inv2 = Inventory.from_element(elt)
498
 
        >>> inv2 == inv
499
 
        True
500
 
        """
501
 
        # XXXX: doctest doesn't run this properly under python2.3
502
 
        assert elt.tag == 'inventory'
503
 
        root_id = elt.get('file_id') or ROOT_ID
504
 
        o = cls(root_id)
505
 
        for e in elt:
506
 
            ie = InventoryEntry.from_element(e)
507
 
            if ie.parent_id == ROOT_ID:
508
 
                ie.parent_id = root_id
509
 
            o.add(ie)
510
 
        return o
511
 
        
512
 
    from_element = classmethod(from_element)
513
 
 
514
 
 
515
924
    def __eq__(self, other):
516
925
        """Compare two sets by comparing their contents.
517
926
 
519
928
        >>> i2 = Inventory()
520
929
        >>> i1 == i2
521
930
        True
522
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
931
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
932
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
523
933
        >>> i1 == i2
524
934
        False
525
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
935
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
936
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
526
937
        >>> i1 == i2
527
938
        True
528
939
        """
537
948
 
538
949
 
539
950
    def __ne__(self, other):
540
 
        return not (self == other)
 
951
        return not self.__eq__(other)
541
952
 
542
953
 
543
954
    def __hash__(self):
544
955
        raise ValueError('not hashable')
545
956
 
546
957
 
547
 
 
548
958
    def get_idpath(self, file_id):
549
959
        """Return a list of file_ids for the path to an entry.
550
960
 
565
975
 
566
976
 
567
977
    def id2path(self, file_id):
568
 
        """Return as a list the path to file_id."""
569
 
 
 
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
        """
570
986
        # get all names, skipping root
571
987
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
572
988
        return os.sep.join(p)
643
1059
 
644
1060
 
645
1061
 
646
 
_NAME_RE = re.compile(r'^[^/\\]+$')
 
1062
_NAME_RE = None
647
1063
 
648
1064
def is_valid_name(name):
 
1065
    global _NAME_RE
 
1066
    if _NAME_RE == None:
 
1067
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1068
        
649
1069
    return bool(_NAME_RE.match(name))