~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-10-03 05:54:35 UTC
  • mto: (1393.1.30)
  • mto: This revision was merged to the branch mainline in revision 1400.
  • Revision ID: robertc@robertcollins.net-20051003055434-c8ebd30d1de10247
move exporting functionality into inventory.py - uncovers bug in symlink support

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical Ltd
 
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
17
 
22
18
# TODO: Maybe also keep the full path of the entry, and the children?
23
19
# But those depend on its position within a particular inventory, and
24
20
# it would be nice not to need to hold the backpointer here.
25
21
 
 
22
# TODO: Perhaps split InventoryEntry into subclasses for files,
 
23
# directories, etc etc.
 
24
 
 
25
 
26
26
# This should really be an id randomly assigned when the tree is
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
35
35
import types
36
36
 
37
37
import bzrlib
 
38
from bzrlib.errors import BzrError, BzrCheckError
 
39
 
38
40
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
39
 
                            pathjoin, sha_strings)
40
 
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
41
 
                           BzrError, BzrCheckError, BinaryFile)
 
41
                            appendpath, sha_strings)
42
42
from bzrlib.trace import mutter
 
43
from bzrlib.errors import NotVersionedError
43
44
 
44
45
 
45
46
class InventoryEntry(object):
53
54
    name
54
55
        (within the parent directory)
55
56
 
 
57
    kind
 
58
        'directory' or 'file' or 'symlink'
 
59
 
56
60
    parent_id
57
61
        file_id of the parent directory, or ROOT_ID
58
62
 
75
79
    >>> i = Inventory()
76
80
    >>> i.path2id('')
77
81
    'TREE_ROOT'
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')
82
 
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
83
 
    >>> for ix, j in enumerate(i.iter_entries()):
84
 
    ...   print (j[0] == shouldbe[ix], j[1])
 
82
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
83
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
 
84
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
85
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
 
86
    >>> for j in i.iter_entries():
 
87
    ...   print j
85
88
    ... 
86
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
87
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
88
 
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
89
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
90
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
 
91
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
89
92
    Traceback (most recent call last):
90
93
    ...
91
94
    BzrError: inventory already contains entry with id {2323}
92
 
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
93
 
    InventoryFile('2324', 'bye.c', parent_id='123')
94
 
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
95
 
    InventoryDirectory('2325', 'wibble', parent_id='123')
 
95
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
96
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
 
97
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
98
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
96
99
    >>> i.path2id('src/wibble')
97
100
    '2325'
98
101
    >>> '2325' in i
99
102
    True
100
 
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
101
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
103
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
104
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
102
105
    >>> i['2326']
103
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
106
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
104
107
    >>> for path, entry in i.iter_entries():
105
 
    ...     print path
 
108
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
106
109
    ...     assert i.path2id(path)
107
110
    ... 
108
111
    src
110
113
    src/hello.c
111
114
    src/wibble
112
115
    src/wibble/wibble.c
113
 
    >>> i.id2path('2326')
 
116
    >>> i.id2path('2326').replace('\\\\', '/')
114
117
    'src/wibble/wibble.c'
115
118
    """
116
119
    
117
120
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
121
                 'text_id', 'parent_id', 'children', 'executable', 
119
 
                 'revision']
 
122
                 'revision', 'symlink_target']
120
123
 
121
 
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
122
 
        versionedfile = weave_store.get_weave_or_empty(self.file_id,
123
 
                                                       transaction)
124
 
        versionedfile.add_lines(self.revision, parents, new_lines)
125
 
        versionedfile.clear_cache()
 
124
    def _add_text_to_weave(self, new_lines, parents, weave_store):
 
125
        weave_store.add_text(self.file_id, self.revision, new_lines, parents)
126
126
 
127
127
    def detect_changes(self, old_entry):
128
128
        """Return a (text_modified, meta_modified) from this to old_entry.
130
130
        _read_tree_state must have been called on self and old_entry prior to 
131
131
        calling detect_changes.
132
132
        """
133
 
        return False, False
 
133
        if self.kind == 'file':
 
134
            assert self.text_sha1 != None
 
135
            assert old_entry.text_sha1 != None
 
136
            text_modified = (self.text_sha1 != old_entry.text_sha1)
 
137
            meta_modified = (self.executable != old_entry.executable)
 
138
        elif self.kind == 'symlink':
 
139
            # FIXME: which _modified field should we use ? RBC 20051003
 
140
            text_modified = (self.symlink_target != old_entry.symlink_target)
 
141
            if text_modified:
 
142
                mutter("    symlink target changed")
 
143
            meta_modified = False
 
144
        else:
 
145
            text_modified = False
 
146
            meta_modified = False
 
147
        return text_modified, meta_modified
134
148
 
135
149
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
136
150
             output_to, reverse=False):
137
151
        """Perform a diff from this to to_entry.
138
152
 
139
153
        text_diff will be used for textual difference calculation.
140
 
        This is a template method, override _diff in child classes.
141
154
        """
142
155
        self._read_tree_state(tree.id2path(self.file_id), tree)
143
156
        if to_entry:
146
159
            assert self.kind == to_entry.kind
147
160
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
148
161
                                      to_tree)
149
 
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
150
 
                   output_to, reverse)
151
 
 
152
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
153
 
             output_to, reverse=False):
154
 
        """Perform a diff between two entries of the same kind."""
155
 
 
156
 
    def find_previous_heads(self, previous_inventories,
157
 
                            versioned_file_store,
158
 
                            transaction,
159
 
                            entry_vf=None):
160
 
        """Return the revisions and entries that directly preceed this.
161
 
 
162
 
        Returned as a map from revision to inventory entry.
163
 
 
164
 
        This is a map containing the file revisions in all parents
165
 
        for which the file exists, and its revision is not a parent of
166
 
        any other. If the file is new, the set will be empty.
167
 
 
168
 
        :param versioned_file_store: A store where ancestry data on this
169
 
                                     file id can be queried.
170
 
        :param transaction: The transaction that queries to the versioned 
171
 
                            file store should be completed under.
172
 
        :param entry_vf: The entry versioned file, if its already available.
173
 
        """
174
 
        def get_ancestors(weave, entry):
175
 
            return set(weave.get_ancestry(entry.revision))
176
 
        # revision:ie mapping for each ie found in previous_inventories.
177
 
        candidates = {}
178
 
        # revision:ie mapping with one revision for each head.
179
 
        heads = {}
180
 
        # revision: ancestor list for each head
181
 
        head_ancestors = {}
182
 
        # identify candidate head revision ids.
183
 
        for inv in previous_inventories:
184
 
            if self.file_id in inv:
185
 
                ie = inv[self.file_id]
186
 
                assert ie.file_id == self.file_id
187
 
                if ie.revision in candidates:
188
 
                    # same revision value in two different inventories:
189
 
                    # correct possible inconsistencies:
190
 
                    #     * there was a bug in revision updates with 'x' bit 
191
 
                    #       support.
192
 
                    try:
193
 
                        if candidates[ie.revision].executable != ie.executable:
194
 
                            candidates[ie.revision].executable = False
195
 
                            ie.executable = False
196
 
                    except AttributeError:
197
 
                        pass
198
 
                    # must now be the same.
199
 
                    assert candidates[ie.revision] == ie
 
162
        if self.kind == 'file':
 
163
            from_text = tree.get_file(self.file_id).readlines()
 
164
            if to_entry:
 
165
                to_text = to_tree.get_file(to_entry.file_id).readlines()
 
166
            else:
 
167
                to_text = []
 
168
            if not reverse:
 
169
                text_diff(from_label, from_text,
 
170
                          to_label, to_text, output_to)
 
171
            else:
 
172
                text_diff(to_label, to_text,
 
173
                          from_label, from_text, output_to)
 
174
        elif self.kind == 'symlink':
 
175
            from_text = self.symlink_target
 
176
            if to_entry is not None:
 
177
                to_text = to_entry.symlink_target
 
178
                if reverse:
 
179
                    temp = from_text
 
180
                    from_text = to_text
 
181
                    to_text = temp
 
182
                print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
183
            else:
 
184
                if not reverse:
 
185
                    print >>output_to, '=== target was %r' % self.symlink_target
200
186
                else:
201
 
                    # add this revision as a candidate.
202
 
                    candidates[ie.revision] = ie
203
 
 
204
 
        # common case optimisation
205
 
        if len(candidates) == 1:
206
 
            # if there is only one candidate revision found
207
 
            # then we can opening the versioned file to access ancestry:
208
 
            # there cannot be any ancestors to eliminate when there is 
209
 
            # only one revision available.
210
 
            heads[ie.revision] = ie
211
 
            return heads
212
 
 
213
 
        # eliminate ancestors amongst the available candidates:
214
 
        # heads are those that are not an ancestor of any other candidate
215
 
        # - this provides convergence at a per-file level.
216
 
        for ie in candidates.values():
217
 
            # may be an ancestor of a known head:
218
 
            already_present = 0 != len(
219
 
                [head for head in heads 
220
 
                 if ie.revision in head_ancestors[head]])
221
 
            if already_present:
222
 
                # an ancestor of an analyzed candidate.
223
 
                continue
224
 
            # not an ancestor of a known head:
225
 
            # load the versioned file for this file id if needed
226
 
            if entry_vf is None:
227
 
                entry_vf = versioned_file_store.get_weave_or_empty(
228
 
                    self.file_id, transaction)
229
 
            ancestors = get_ancestors(entry_vf, ie)
230
 
            # may knock something else out:
231
 
            check_heads = list(heads.keys())
232
 
            for head in check_heads:
233
 
                if head in ancestors:
234
 
                    # this previously discovered 'head' is not
235
 
                    # really a head - its an ancestor of the newly 
236
 
                    # found head,
237
 
                    heads.pop(head)
238
 
            head_ancestors[ie.revision] = ancestors
239
 
            heads[ie.revision] = ie
240
 
        return heads
 
187
                    print >>output_to, '=== target is %r' % self.symlink_target
241
188
 
242
189
    def get_tar_item(self, root, dp, now, tree):
243
 
        """Get a tarfile item and a file stream for its content."""
244
 
        item = tarfile.TarInfo(pathjoin(root, dp))
 
190
        item = tarfile.TarInfo(os.path.join(root, dp))
245
191
        # TODO: would be cool to actually set it to the timestamp of the
246
192
        # revision it was last changed
247
193
        item.mtime = now
248
 
        fileobj = self._put_in_tar(item, tree)
 
194
        if self.kind == 'directory':
 
195
            item.type = tarfile.DIRTYPE
 
196
            fileobj = None
 
197
            item.name += '/'
 
198
            item.size = 0
 
199
            item.mode = 0755
 
200
        elif self.kind == 'file':
 
201
            item.type = tarfile.REGTYPE
 
202
            fileobj = tree.get_file(self.file_id)
 
203
            item.size = self.text_size
 
204
            if tree.is_executable(self.file_id):
 
205
                item.mode = 0755
 
206
            else:
 
207
                item.mode = 0644
 
208
        else:
 
209
            raise BzrError("don't know how to export {%s} of kind %r" %
 
210
                    (self.file_id, self.kind))
249
211
        return item, fileobj
250
212
 
251
213
    def has_text(self):
252
214
        """Return true if the object this entry represents has textual data.
253
215
 
254
216
        Note that textual data includes binary content.
255
 
 
256
 
        Also note that all entries get weave files created for them.
257
 
        This attribute is primarily used when upgrading from old trees that
258
 
        did not have the weave index for all inventory entries.
259
217
        """
260
 
        return False
 
218
        if self.kind =='file':
 
219
            return True
 
220
        else:
 
221
            return False
261
222
 
262
 
    def __init__(self, file_id, name, parent_id, text_id=None):
 
223
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
263
224
        """Create an InventoryEntry
264
225
        
265
226
        The filename must be a single component, relative to the
266
227
        parent directory; it cannot be a whole path or relative name.
267
228
 
268
 
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
 
229
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
269
230
        >>> e.name
270
231
        'hello.c'
271
232
        >>> e.file_id
272
233
        '123'
273
 
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
 
234
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
274
235
        Traceback (most recent call last):
275
 
        InvalidEntryName: Invalid entry name: src/hello.c
 
236
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
276
237
        """
277
238
        assert isinstance(name, basestring), name
278
239
        if '/' in name or '\\' in name:
279
 
            raise InvalidEntryName(name=name)
 
240
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
241
        
280
242
        self.executable = False
281
243
        self.revision = None
282
244
        self.text_sha1 = None
283
245
        self.text_size = None
284
246
        self.file_id = file_id
285
247
        self.name = name
 
248
        self.kind = kind
286
249
        self.text_id = text_id
287
250
        self.parent_id = parent_id
288
251
        self.symlink_target = None
 
252
        if kind == 'directory':
 
253
            self.children = {}
 
254
        elif kind == 'file':
 
255
            pass
 
256
        elif kind == 'symlink':
 
257
            pass
 
258
        else:
 
259
            raise BzrError("unhandled entry kind %r" % kind)
289
260
 
290
261
    def kind_character(self):
291
262
        """Return a short kind indicator useful for appending to names."""
292
 
        raise BzrError('unknown kind %r' % self.kind)
 
263
        if self.kind == 'directory':
 
264
            return '/'
 
265
        if self.kind == 'file':
 
266
            return ''
 
267
        if self.kind == 'symlink':
 
268
            return ''
 
269
        raise RuntimeError('unreachable code')
293
270
 
294
271
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
295
272
 
296
 
    def _put_in_tar(self, item, tree):
297
 
        """populate item for stashing in a tar, and return the content stream.
298
 
 
299
 
        If no content is available, return None.
300
 
        """
301
 
        raise BzrError("don't know how to export {%s} of kind %r" %
302
 
                       (self.file_id, self.kind))
303
 
 
304
273
    def put_on_disk(self, dest, dp, tree):
305
 
        """Create a representation of self on disk in the prefix dest.
306
 
        
307
 
        This is a template method - implement _put_on_disk in subclasses.
308
 
        """
309
 
        fullpath = pathjoin(dest, dp)
310
 
        self._put_on_disk(fullpath, tree)
311
 
        mutter("  export {%s} kind %s to %s", self.file_id,
312
 
                self.kind, fullpath)
313
 
 
314
 
    def _put_on_disk(self, fullpath, tree):
315
 
        """Put this entry onto disk at fullpath, from tree tree."""
316
 
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
 
274
        """Create a representation of self on disk in the prefix dest."""
 
275
        fullpath = appendpath(dest, dp)
 
276
        if self.kind == 'directory':
 
277
            os.mkdir(fullpath)
 
278
        elif self.kind == 'file':
 
279
            pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
280
            if tree.is_executable(self.file_id):
 
281
                os.chmod(fullpath, 0755)
 
282
        elif self.kind == 'symlink':
 
283
            try:
 
284
                os.symlink(self.symlink_target, fullpath)
 
285
            except OSError,e:
 
286
                raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
287
        else:
 
288
            raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
 
289
        mutter("  export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
317
290
 
318
291
    def sorted_children(self):
319
292
        l = self.children.items()
325
298
        return kind in ('file', 'directory', 'symlink')
326
299
 
327
300
    def check(self, checker, rev_id, inv, tree):
328
 
        """Check this inventory entry is intact.
329
 
 
330
 
        This is a template method, override _check for kind specific
331
 
        tests.
332
 
 
333
 
        :param checker: Check object providing context for the checks; 
334
 
             can be used to find out what parts of the repository have already
335
 
             been checked.
336
 
        :param rev_id: Revision id from which this InventoryEntry was loaded.
337
 
             Not necessarily the last-changed revision for this file.
338
 
        :param inv: Inventory from which the entry was loaded.
339
 
        :param tree: RevisionTree for this entry.
340
 
        """
341
301
        if self.parent_id != None:
342
302
            if not inv.has_id(self.parent_id):
343
303
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
344
304
                        % (self.parent_id, rev_id))
345
 
        self._check(checker, rev_id, tree)
 
305
        if self.kind == 'file':
 
306
            revision = self.revision
 
307
            t = (self.file_id, revision)
 
308
            if t in checker.checked_texts:
 
309
                prev_sha = checker.checked_texts[t] 
 
310
                if prev_sha != self.text_sha1:
 
311
                    raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
312
                                        (self.file_id, rev_id))
 
313
                else:
 
314
                    checker.repeated_text_cnt += 1
 
315
                    return
 
316
            mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
317
            file_lines = tree.get_file_lines(self.file_id)
 
318
            checker.checked_text_cnt += 1 
 
319
            if self.text_size != sum(map(len, file_lines)):
 
320
                raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
321
            if self.text_sha1 != sha_strings(file_lines):
 
322
                raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
323
            checker.checked_texts[t] = self.text_sha1
 
324
        elif self.kind == 'directory':
 
325
            if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
326
                raise BzrCheckError('directory {%s} has text in revision {%s}'
 
327
                        % (self.file_id, rev_id))
 
328
        elif self.kind == 'root_directory':
 
329
            pass
 
330
        elif self.kind == 'symlink':
 
331
            if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
332
                raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
333
                        % (self.file_id, rev_id))
 
334
            if self.symlink_target == None:
 
335
                raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
336
                        % (self.file_id, rev_id))
 
337
        else:
 
338
            raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
339
                                (self.kind, rev_id))
346
340
 
347
 
    def _check(self, checker, rev_id, tree):
348
 
        """Check this inventory entry for kind specific errors."""
349
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
350
 
                            (self.kind, rev_id))
351
341
 
352
342
    def copy(self):
353
 
        """Clone this inventory entry."""
354
 
        raise NotImplementedError
355
 
 
356
 
    def _describe_snapshot_change(self, previous_entries):
357
 
        """Describe how this entry will have changed in a new commit.
358
 
 
359
 
        :param previous_entries: Dictionary from revision_id to inventory entry.
360
 
 
361
 
        :returns: One-word description: "merged", "added", "renamed", "modified".
362
 
        """
363
 
        # XXX: This assumes that the file *has* changed -- it should probably
364
 
        # be fused with whatever does that detection.  Why not just a single
365
 
        # thing to compare the entries?
366
 
        #
367
 
        # TODO: Return some kind of object describing all the possible
368
 
        # dimensions that can change, not just a string.  That can then give
369
 
        # both old and new names for renames, etc.
370
 
        #
 
343
        other = InventoryEntry(self.file_id, self.name, self.kind,
 
344
                               self.parent_id)
 
345
        other.executable = self.executable
 
346
        other.text_id = self.text_id
 
347
        other.text_sha1 = self.text_sha1
 
348
        other.text_size = self.text_size
 
349
        other.symlink_target = self.symlink_target
 
350
        other.revision = self.revision
 
351
        # note that children are *not* copied; they're pulled across when
 
352
        # others are added
 
353
        return other
 
354
 
 
355
    def _get_snapshot_change(self, previous_entries):
371
356
        if len(previous_entries) > 1:
372
357
            return 'merged'
373
358
        elif len(previous_entries) == 0:
374
359
            return 'added'
375
 
        the_parent, = previous_entries.values()
376
 
        if self.parent_id != the_parent.parent_id:
377
 
            # actually, moved to another directory
378
 
            return 'renamed'
379
 
        elif self.name != the_parent.name:
380
 
            return 'renamed'
381
 
        return 'modified'
 
360
        else:
 
361
            return 'modified/renamed/reparented'
382
362
 
383
363
    def __repr__(self):
384
 
        return ("%s(%r, %r, parent_id=%r)"
 
364
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
385
365
                % (self.__class__.__name__,
386
366
                   self.file_id,
387
367
                   self.name,
 
368
                   self.kind,
388
369
                   self.parent_id))
389
370
 
390
 
    def snapshot(self, revision, path, previous_entries,
391
 
                 work_tree, weave_store, transaction):
392
 
        """Make a snapshot of this entry which may or may not have changed.
 
371
    def snapshot(self, revision, path, previous_entries, work_tree, 
 
372
                 weave_store):
 
373
        """Make a snapshot of this entry.
393
374
        
394
375
        This means that all its fields are populated, that it has its
395
376
        text stored in the text store or weave.
399
380
        if len(previous_entries) == 1:
400
381
            # cannot be unchanged unless there is only one parent file rev.
401
382
            parent_ie = previous_entries.values()[0]
402
 
            if self._unchanged(parent_ie):
 
383
            if self._unchanged(path, parent_ie, work_tree):
403
384
                mutter("found unchanged entry")
404
385
                self.revision = parent_ie.revision
405
386
                return "unchanged"
406
 
        return self._snapshot_into_revision(revision, previous_entries, 
407
 
                                            work_tree, weave_store, transaction)
408
 
 
409
 
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
410
 
                                weave_store, transaction):
411
 
        """Record this revision unconditionally into a store.
412
 
 
413
 
        The entry's last-changed revision property (`revision`) is updated to 
414
 
        that of the new revision.
415
 
        
416
 
        :param revision: id of the new revision that is being recorded.
417
 
 
418
 
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
419
 
        """
420
 
        mutter('new revision {%s} for {%s}', revision, self.file_id)
 
387
        mutter('new revision for {%s}', self.file_id)
421
388
        self.revision = revision
422
 
        change = self._describe_snapshot_change(previous_entries)
423
 
        self._snapshot_text(previous_entries, work_tree, weave_store,
424
 
                            transaction)
 
389
        change = self._get_snapshot_change(previous_entries)
 
390
        if self.kind != 'file':
 
391
            return change
 
392
        self._snapshot_text(previous_entries, work_tree, weave_store)
425
393
        return change
426
394
 
427
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
428
 
        """Record the 'text' of this entry, whatever form that takes.
429
 
        
430
 
        This default implementation simply adds an empty text.
431
 
        """
 
395
    def _snapshot_text(self, file_parents, work_tree, weave_store): 
432
396
        mutter('storing file {%s} in revision {%s}',
433
397
               self.file_id, self.revision)
434
 
        self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
 
398
        # special case to avoid diffing on renames or 
 
399
        # reparenting
 
400
        if (len(file_parents) == 1
 
401
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
402
            and self.text_size == file_parents.values()[0].text_size):
 
403
            previous_ie = file_parents.values()[0]
 
404
            weave_store.add_identical_text(
 
405
                self.file_id, previous_ie.revision, 
 
406
                self.revision, file_parents)
 
407
        else:
 
408
            new_lines = work_tree.get_file(self.file_id).readlines()
 
409
            self._add_text_to_weave(new_lines, file_parents, weave_store)
 
410
            self.text_sha1 = sha_strings(new_lines)
 
411
            self.text_size = sum(map(len, new_lines))
435
412
 
436
413
    def __eq__(self, other):
437
414
        if not isinstance(other, InventoryEntry):
455
432
    def __hash__(self):
456
433
        raise ValueError('not hashable')
457
434
 
458
 
    def _unchanged(self, previous_ie):
459
 
        """Has this entry changed relative to previous_ie.
460
 
 
461
 
        This method should be overriden in child classes.
462
 
        """
 
435
    def _unchanged(self, path, previous_ie, work_tree):
463
436
        compatible = True
464
437
        # different inv parent
465
438
        if previous_ie.parent_id != self.parent_id:
467
440
        # renamed
468
441
        elif previous_ie.name != self.name:
469
442
            compatible = False
 
443
        if self.kind == 'symlink':
 
444
            if self.symlink_target != previous_ie.symlink_target:
 
445
                compatible = False
 
446
        if self.kind == 'file':
 
447
            if self.text_sha1 != previous_ie.text_sha1:
 
448
                compatible = False
 
449
            else:
 
450
                # FIXME: 20050930 probe for the text size when getting sha1
 
451
                # in _read_tree_state
 
452
                self.text_size = previous_ie.text_size
470
453
        return compatible
471
454
 
472
455
    def _read_tree_state(self, path, work_tree):
473
 
        """Populate fields in the inventory entry from the given tree.
474
 
        
475
 
        Note that this should be modified to be a noop on virtual trees
476
 
        as all entries created there are prepopulated.
477
 
        """
478
 
        # TODO: Rather than running this manually, we should check the 
479
 
        # working sha1 and other expensive properties when they're
480
 
        # first requested, or preload them if they're already known
481
 
        pass            # nothing to do by default
482
 
 
483
 
    def _forget_tree_state(self):
484
 
        pass
 
456
        if self.kind == 'symlink':
 
457
            self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
458
        if self.kind == 'file':
 
459
            self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
460
            self.executable = work_tree.is_executable(self.file_id)
485
461
 
486
462
 
487
463
class RootEntry(InventoryEntry):
488
 
 
489
 
    def _check(self, checker, rev_id, tree):
490
 
        """See InventoryEntry._check"""
491
 
 
492
464
    def __init__(self, file_id):
493
465
        self.file_id = file_id
494
466
        self.children = {}
495
467
        self.kind = 'root_directory'
496
468
        self.parent_id = None
497
 
        self.name = u''
 
469
        self.name = ''
498
470
 
499
471
    def __eq__(self, other):
500
472
        if not isinstance(other, RootEntry):
504
476
               and (self.children == other.children)
505
477
 
506
478
 
507
 
class InventoryDirectory(InventoryEntry):
508
 
    """A directory in an inventory."""
509
 
 
510
 
    def _check(self, checker, rev_id, tree):
511
 
        """See InventoryEntry._check"""
512
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
513
 
            raise BzrCheckError('directory {%s} has text in revision {%s}'
514
 
                                % (self.file_id, rev_id))
515
 
 
516
 
    def copy(self):
517
 
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
518
 
        other.revision = self.revision
519
 
        # note that children are *not* copied; they're pulled across when
520
 
        # others are added
521
 
        return other
522
 
 
523
 
    def __init__(self, file_id, name, parent_id):
524
 
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
525
 
        self.children = {}
526
 
        self.kind = 'directory'
527
 
 
528
 
    def kind_character(self):
529
 
        """See InventoryEntry.kind_character."""
530
 
        return '/'
531
 
 
532
 
    def _put_in_tar(self, item, tree):
533
 
        """See InventoryEntry._put_in_tar."""
534
 
        item.type = tarfile.DIRTYPE
535
 
        fileobj = None
536
 
        item.name += '/'
537
 
        item.size = 0
538
 
        item.mode = 0755
539
 
        return fileobj
540
 
 
541
 
    def _put_on_disk(self, fullpath, tree):
542
 
        """See InventoryEntry._put_on_disk."""
543
 
        os.mkdir(fullpath)
544
 
 
545
 
 
546
 
class InventoryFile(InventoryEntry):
547
 
    """A file in an inventory."""
548
 
 
549
 
    def _check(self, checker, tree_revision_id, tree):
550
 
        """See InventoryEntry._check"""
551
 
        t = (self.file_id, self.revision)
552
 
        if t in checker.checked_texts:
553
 
            prev_sha = checker.checked_texts[t]
554
 
            if prev_sha != self.text_sha1:
555
 
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
556
 
                                    (self.file_id, tree_revision_id))
557
 
            else:
558
 
                checker.repeated_text_cnt += 1
559
 
                return
560
 
 
561
 
        if self.file_id not in checker.checked_weaves:
562
 
            mutter('check weave {%s}', self.file_id)
563
 
            w = tree.get_weave(self.file_id)
564
 
            # Not passing a progress bar, because it creates a new
565
 
            # progress, which overwrites the current progress,
566
 
            # and doesn't look nice
567
 
            w.check()
568
 
            checker.checked_weaves[self.file_id] = True
569
 
        else:
570
 
            w = tree.get_weave(self.file_id)
571
 
 
572
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
573
 
        checker.checked_text_cnt += 1
574
 
        # We can't check the length, because Weave doesn't store that
575
 
        # information, and the whole point of looking at the weave's
576
 
        # sha1sum is that we don't have to extract the text.
577
 
        if self.text_sha1 != w.get_sha1(self.revision):
578
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
579
 
                                % (self.file_id, self.revision))
580
 
        checker.checked_texts[t] = self.text_sha1
581
 
 
582
 
    def copy(self):
583
 
        other = InventoryFile(self.file_id, self.name, self.parent_id)
584
 
        other.executable = self.executable
585
 
        other.text_id = self.text_id
586
 
        other.text_sha1 = self.text_sha1
587
 
        other.text_size = self.text_size
588
 
        other.revision = self.revision
589
 
        return other
590
 
 
591
 
    def detect_changes(self, old_entry):
592
 
        """See InventoryEntry.detect_changes."""
593
 
        assert self.text_sha1 != None
594
 
        assert old_entry.text_sha1 != None
595
 
        text_modified = (self.text_sha1 != old_entry.text_sha1)
596
 
        meta_modified = (self.executable != old_entry.executable)
597
 
        return text_modified, meta_modified
598
 
 
599
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
600
 
             output_to, reverse=False):
601
 
        """See InventoryEntry._diff."""
602
 
        try:
603
 
            from_text = tree.get_file(self.file_id).readlines()
604
 
            if to_entry:
605
 
                to_text = to_tree.get_file(to_entry.file_id).readlines()
606
 
            else:
607
 
                to_text = []
608
 
            if not reverse:
609
 
                text_diff(from_label, from_text,
610
 
                          to_label, to_text, output_to)
611
 
            else:
612
 
                text_diff(to_label, to_text,
613
 
                          from_label, from_text, output_to)
614
 
        except BinaryFile:
615
 
            if reverse:
616
 
                label_pair = (to_label, from_label)
617
 
            else:
618
 
                label_pair = (from_label, to_label)
619
 
            print >> output_to, "Binary files %s and %s differ" % label_pair
620
 
 
621
 
    def has_text(self):
622
 
        """See InventoryEntry.has_text."""
623
 
        return True
624
 
 
625
 
    def __init__(self, file_id, name, parent_id):
626
 
        super(InventoryFile, self).__init__(file_id, name, parent_id)
627
 
        self.kind = 'file'
628
 
 
629
 
    def kind_character(self):
630
 
        """See InventoryEntry.kind_character."""
631
 
        return ''
632
 
 
633
 
    def _put_in_tar(self, item, tree):
634
 
        """See InventoryEntry._put_in_tar."""
635
 
        item.type = tarfile.REGTYPE
636
 
        fileobj = tree.get_file(self.file_id)
637
 
        item.size = self.text_size
638
 
        if tree.is_executable(self.file_id):
639
 
            item.mode = 0755
640
 
        else:
641
 
            item.mode = 0644
642
 
        return fileobj
643
 
 
644
 
    def _put_on_disk(self, fullpath, tree):
645
 
        """See InventoryEntry._put_on_disk."""
646
 
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
647
 
        if tree.is_executable(self.file_id):
648
 
            os.chmod(fullpath, 0755)
649
 
 
650
 
    def _read_tree_state(self, path, work_tree):
651
 
        """See InventoryEntry._read_tree_state."""
652
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
653
 
        self.executable = work_tree.is_executable(self.file_id)
654
 
 
655
 
    def _forget_tree_state(self):
656
 
        self.text_sha1 = None
657
 
        self.executable = None
658
 
 
659
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
660
 
        """See InventoryEntry._snapshot_text."""
661
 
        mutter('storing file {%s} in revision {%s}',
662
 
               self.file_id, self.revision)
663
 
        # special case to avoid diffing on renames or 
664
 
        # reparenting
665
 
        if (len(file_parents) == 1
666
 
            and self.text_sha1 == file_parents.values()[0].text_sha1
667
 
            and self.text_size == file_parents.values()[0].text_size):
668
 
            previous_ie = file_parents.values()[0]
669
 
            versionedfile = weave_store.get_weave(self.file_id, transaction)
670
 
            versionedfile.clone_text(self.revision, previous_ie.revision, file_parents.keys())
671
 
        else:
672
 
            new_lines = work_tree.get_file(self.file_id).readlines()
673
 
            self._add_text_to_weave(new_lines, file_parents.keys(), weave_store,
674
 
                                    transaction)
675
 
            self.text_sha1 = sha_strings(new_lines)
676
 
            self.text_size = sum(map(len, new_lines))
677
 
 
678
 
 
679
 
    def _unchanged(self, previous_ie):
680
 
        """See InventoryEntry._unchanged."""
681
 
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
682
 
        if self.text_sha1 != previous_ie.text_sha1:
683
 
            compatible = False
684
 
        else:
685
 
            # FIXME: 20050930 probe for the text size when getting sha1
686
 
            # in _read_tree_state
687
 
            self.text_size = previous_ie.text_size
688
 
        if self.executable != previous_ie.executable:
689
 
            compatible = False
690
 
        return compatible
691
 
 
692
 
 
693
 
class InventoryLink(InventoryEntry):
694
 
    """A file in an inventory."""
695
 
 
696
 
    __slots__ = ['symlink_target']
697
 
 
698
 
    def _check(self, checker, rev_id, tree):
699
 
        """See InventoryEntry._check"""
700
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
701
 
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
702
 
                    % (self.file_id, rev_id))
703
 
        if self.symlink_target == None:
704
 
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
705
 
                    % (self.file_id, rev_id))
706
 
 
707
 
    def copy(self):
708
 
        other = InventoryLink(self.file_id, self.name, self.parent_id)
709
 
        other.symlink_target = self.symlink_target
710
 
        other.revision = self.revision
711
 
        return other
712
 
 
713
 
    def detect_changes(self, old_entry):
714
 
        """See InventoryEntry.detect_changes."""
715
 
        # FIXME: which _modified field should we use ? RBC 20051003
716
 
        text_modified = (self.symlink_target != old_entry.symlink_target)
717
 
        if text_modified:
718
 
            mutter("    symlink target changed")
719
 
        meta_modified = False
720
 
        return text_modified, meta_modified
721
 
 
722
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
723
 
             output_to, reverse=False):
724
 
        """See InventoryEntry._diff."""
725
 
        from_text = self.symlink_target
726
 
        if to_entry is not None:
727
 
            to_text = to_entry.symlink_target
728
 
            if reverse:
729
 
                temp = from_text
730
 
                from_text = to_text
731
 
                to_text = temp
732
 
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
733
 
        else:
734
 
            if not reverse:
735
 
                print >>output_to, '=== target was %r' % self.symlink_target
736
 
            else:
737
 
                print >>output_to, '=== target is %r' % self.symlink_target
738
 
 
739
 
    def __init__(self, file_id, name, parent_id):
740
 
        super(InventoryLink, self).__init__(file_id, name, parent_id)
741
 
        self.kind = 'symlink'
742
 
 
743
 
    def kind_character(self):
744
 
        """See InventoryEntry.kind_character."""
745
 
        return ''
746
 
 
747
 
    def _put_in_tar(self, item, tree):
748
 
        """See InventoryEntry._put_in_tar."""
749
 
        item.type = tarfile.SYMTYPE
750
 
        fileobj = None
751
 
        item.size = 0
752
 
        item.mode = 0755
753
 
        item.linkname = self.symlink_target
754
 
        return fileobj
755
 
 
756
 
    def _put_on_disk(self, fullpath, tree):
757
 
        """See InventoryEntry._put_on_disk."""
758
 
        try:
759
 
            os.symlink(self.symlink_target, fullpath)
760
 
        except OSError,e:
761
 
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
762
 
 
763
 
    def _read_tree_state(self, path, work_tree):
764
 
        """See InventoryEntry._read_tree_state."""
765
 
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
766
 
 
767
 
    def _forget_tree_state(self):
768
 
        self.symlink_target = None
769
 
 
770
 
    def _unchanged(self, previous_ie):
771
 
        """See InventoryEntry._unchanged."""
772
 
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
773
 
        if self.symlink_target != previous_ie.symlink_target:
774
 
            compatible = False
775
 
        return compatible
776
 
 
777
479
 
778
480
class Inventory(object):
779
481
    """Inventory of versioned files in a tree.
793
495
    inserted, other than through the Inventory API.
794
496
 
795
497
    >>> inv = Inventory()
796
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
797
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
 
498
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
499
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
798
500
    >>> inv['123-123'].name
799
501
    'hello.c'
800
502
 
810
512
    >>> [x[0] for x in inv.iter_entries()]
811
513
    ['hello.c']
812
514
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
813
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
814
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
 
515
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
516
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
815
517
    """
816
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
518
    def __init__(self, root_id=ROOT_ID):
817
519
        """Create or read an inventory.
818
520
 
819
521
        If a working directory is specified, the inventory is read
823
525
        The inventory is created with a default root directory, with
824
526
        an id of None.
825
527
        """
826
 
        # We are letting Branch.create() create a unique inventory
 
528
        # We are letting Branch.initialize() create a unique inventory
827
529
        # root id. Rather than generating a random one here.
828
530
        #if root_id is None:
829
531
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
830
532
        self.root = RootEntry(root_id)
831
 
        self.revision_id = revision_id
832
533
        self._byid = {self.root.file_id: self.root}
833
534
 
834
535
 
835
536
    def copy(self):
836
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
837
537
        other = Inventory(self.root.file_id)
838
538
        # copy recursively so we know directories will be added before
839
539
        # their children.  There are more efficient ways than this...
867
567
            yield name, ie
868
568
            if ie.kind == 'directory':
869
569
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
870
 
                    yield pathjoin(name, cn), cie
 
570
                    yield os.path.join(name, cn), cie
871
571
 
872
572
 
873
573
    def entries(self):
880
580
            kids = dir_ie.children.items()
881
581
            kids.sort()
882
582
            for name, ie in kids:
883
 
                child_path = pathjoin(dir_path, name)
 
583
                child_path = os.path.join(dir_path, name)
884
584
                accum.append((child_path, ie))
885
585
                if ie.kind == 'directory':
886
586
                    descend(ie, child_path)
887
587
 
888
 
        descend(self.root, u'')
 
588
        descend(self.root, '')
889
589
        return accum
890
590
 
891
591
 
900
600
            kids.sort()
901
601
 
902
602
            for name, child_ie in kids:
903
 
                child_path = pathjoin(parent_path, name)
 
603
                child_path = os.path.join(parent_path, name)
904
604
                descend(child_ie, child_path)
905
 
        descend(self.root, u'')
 
605
        descend(self.root, '')
906
606
        return accum
907
607
        
908
608
 
911
611
        """True if this entry contains a file with given id.
912
612
 
913
613
        >>> inv = Inventory()
914
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
915
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
614
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
615
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
916
616
        >>> '123' in inv
917
617
        True
918
618
        >>> '456' in inv
925
625
        """Return the entry for given file_id.
926
626
 
927
627
        >>> inv = Inventory()
928
 
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
929
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
 
628
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
629
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
930
630
        >>> inv['123123'].name
931
631
        'hello.c'
932
632
        """
967
667
 
968
668
        if parent.children.has_key(entry.name):
969
669
            raise BzrError("%s is already versioned" %
970
 
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
670
                    appendpath(self.id2path(parent.file_id), entry.name))
971
671
 
972
672
        self._byid[entry.file_id] = entry
973
673
        parent.children[entry.name] = entry
980
680
        The immediate parent must already be versioned.
981
681
 
982
682
        Returns the new entry object."""
983
 
        from bzrlib.workingtree import gen_file_id
 
683
        from bzrlib.branch import gen_file_id
984
684
        
985
685
        parts = bzrlib.osutils.splitpath(relpath)
 
686
        if len(parts) == 0:
 
687
            raise BzrError("cannot re-add root of inventory")
986
688
 
987
689
        if file_id == None:
988
690
            file_id = gen_file_id(relpath)
989
691
 
990
 
        if len(parts) == 0:
991
 
            self.root = RootEntry(file_id)
992
 
            self._byid = {self.root.file_id: self.root}
993
 
            return
994
 
        else:
995
 
            parent_path = parts[:-1]
996
 
            parent_id = self.path2id(parent_path)
997
 
            if parent_id == None:
998
 
                raise NotVersionedError(path=parent_path)
999
 
        if kind == 'directory':
1000
 
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
1001
 
        elif kind == 'file':
1002
 
            ie = InventoryFile(file_id, parts[-1], parent_id)
1003
 
        elif kind == 'symlink':
1004
 
            ie = InventoryLink(file_id, parts[-1], parent_id)
1005
 
        else:
1006
 
            raise BzrError("unknown kind %r" % kind)
 
692
        parent_path = parts[:-1]
 
693
        parent_id = self.path2id(parent_path)
 
694
        if parent_id == None:
 
695
            raise NotVersionedError(parent_path)
 
696
 
 
697
        ie = InventoryEntry(file_id, parts[-1],
 
698
                            kind=kind, parent_id=parent_id)
1007
699
        return self.add(ie)
1008
700
 
1009
701
 
1011
703
        """Remove entry by id.
1012
704
 
1013
705
        >>> inv = Inventory()
1014
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1015
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
706
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
707
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
1016
708
        >>> '123' in inv
1017
709
        True
1018
710
        >>> del inv['123']
1021
713
        """
1022
714
        ie = self[file_id]
1023
715
 
1024
 
        assert ie.parent_id is None or \
1025
 
            self[ie.parent_id].children[ie.name] == ie
 
716
        assert self[ie.parent_id].children[ie.name] == ie
1026
717
        
 
718
        # TODO: Test deleting all children; maybe hoist to a separate
 
719
        # deltree method?
 
720
        if ie.kind == 'directory':
 
721
            for cie in ie.children.values():
 
722
                del self[cie.file_id]
 
723
            del ie.children
 
724
 
1027
725
        del self._byid[file_id]
1028
 
        if ie.parent_id is not None:
1029
 
            del self[ie.parent_id].children[ie.name]
 
726
        del self[ie.parent_id].children[ie.name]
1030
727
 
1031
728
 
1032
729
    def __eq__(self, other):
1036
733
        >>> i2 = Inventory()
1037
734
        >>> i1 == i2
1038
735
        True
1039
 
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1040
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
736
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
737
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
1041
738
        >>> i1 == i2
1042
739
        False
1043
 
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1044
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
740
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
741
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
1045
742
        >>> i1 == i2
1046
743
        True
1047
744
        """
1062
759
    def __hash__(self):
1063
760
        raise ValueError('not hashable')
1064
761
 
1065
 
    def _iter_file_id_parents(self, file_id):
1066
 
        """Yield the parents of file_id up to the root."""
1067
 
        while file_id != None:
1068
 
            try:
1069
 
                ie = self._byid[file_id]
1070
 
            except KeyError:
1071
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1072
 
            yield ie
1073
 
            file_id = ie.parent_id
1074
762
 
1075
763
    def get_idpath(self, file_id):
1076
764
        """Return a list of file_ids for the path to an entry.
1081
769
        root directory as depth 1.
1082
770
        """
1083
771
        p = []
1084
 
        for parent in self._iter_file_id_parents(file_id):
1085
 
            p.insert(0, parent.file_id)
 
772
        while file_id != None:
 
773
            try:
 
774
                ie = self._byid[file_id]
 
775
            except KeyError:
 
776
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
777
            p.insert(0, ie.file_id)
 
778
            file_id = ie.parent_id
1086
779
        return p
1087
780
 
 
781
 
1088
782
    def id2path(self, file_id):
1089
 
        """Return as a string the path to file_id.
1090
 
        
1091
 
        >>> i = Inventory()
1092
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1093
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1094
 
        >>> print i.id2path('foo-id')
1095
 
        src/foo.c
1096
 
        """
 
783
        """Return as a list the path to file_id."""
 
784
 
1097
785
        # get all names, skipping root
1098
 
        return '/'.join(reversed(
1099
 
            [parent.name for parent in 
1100
 
             self._iter_file_id_parents(file_id)][:-1]))
 
786
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
787
        return os.sep.join(p)
1101
788
            
 
789
 
 
790
 
1102
791
    def path2id(self, name):
1103
792
        """Walk down through directories to return entry of last component.
1104
793