~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2005-11-08 18:36:26 UTC
  • mto: This revision was merged to the branch mainline in revision 1727.
  • Revision ID: john@arbash-meinel.com-20051108183626-71f8414338043265
Updating unified_diff to take a factory, using the new diff algorithm in the code.

Show diffs side-by-side

added added

removed removed

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