~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

Factor out another win32 special case and add platform independent tests for it.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 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.
17
21
 
18
22
# TODO: Maybe also keep the full path of the entry, and the children?
19
23
# But those depend on its position within a particular inventory, and
20
24
# it would be nice not to need to hold the backpointer here.
21
25
 
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"
29
29
 
30
30
 
31
 
import sys, os.path, types, re
 
31
import collections
 
32
import os.path
 
33
import re
 
34
import sys
 
35
import tarfile
 
36
import types
32
37
 
33
38
import bzrlib
34
 
from bzrlib.errors import BzrError, BzrCheckError
35
 
 
36
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
39
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
40
                            pathjoin, sha_strings)
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError, BinaryFile)
37
43
from bzrlib.trace import mutter
38
 
from bzrlib.errors import NotVersionedError
39
 
        
 
44
 
40
45
 
41
46
class InventoryEntry(object):
42
47
    """Description of a versioned file.
49
54
    name
50
55
        (within the parent directory)
51
56
 
52
 
    kind
53
 
        'directory' or 'file'
54
 
 
55
57
    parent_id
56
58
        file_id of the parent directory, or ROOT_ID
57
59
 
58
 
    entry_version
59
 
        the revision_id in which the name or parent of this file was
60
 
        last changed
 
60
    revision
 
61
        the revision_id in which this variation of this file was 
 
62
        introduced.
 
63
 
 
64
    executable
 
65
        Indicates that this file should be executable on systems
 
66
        that support it.
61
67
 
62
68
    text_sha1
63
69
        sha-1 of the text of the file
65
71
    text_size
66
72
        size in bytes of the text of the file
67
73
        
68
 
    text_version
69
 
        the revision_id in which the text of this file was introduced
70
 
 
71
74
    (reading a version 4 tree created a text_id field.)
72
75
 
73
76
    >>> i = Inventory()
74
77
    >>> i.path2id('')
75
78
    'TREE_ROOT'
76
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
77
 
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
78
 
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
79
 
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
80
 
    >>> for j in i.iter_entries():
81
 
    ...   print j
 
79
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
 
80
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
 
81
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
 
82
    InventoryFile('2323', 'hello.c', parent_id='123')
 
83
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
 
84
    >>> for ix, j in enumerate(i.iter_entries()):
 
85
    ...   print (j[0] == shouldbe[ix], j[1])
82
86
    ... 
83
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
84
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
85
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
87
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
88
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
 
89
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
86
90
    Traceback (most recent call last):
87
91
    ...
88
92
    BzrError: inventory already contains entry with id {2323}
89
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
90
 
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
91
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
92
 
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
 
93
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
 
94
    InventoryFile('2324', 'bye.c', parent_id='123')
 
95
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
 
96
    InventoryDirectory('2325', 'wibble', parent_id='123')
93
97
    >>> i.path2id('src/wibble')
94
98
    '2325'
95
99
    >>> '2325' in i
96
100
    True
97
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
98
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
101
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
99
103
    >>> i['2326']
100
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
101
 
    >>> for j in i.iter_entries():
102
 
    ...     print j[0]
103
 
    ...     assert i.path2id(j[0])
 
104
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
105
    >>> for path, entry in i.iter_entries():
 
106
    ...     print path
 
107
    ...     assert i.path2id(path)
104
108
    ... 
105
109
    src
106
110
    src/bye.c
110
114
    >>> i.id2path('2326')
111
115
    'src/wibble/wibble.c'
112
116
    """
 
117
 
 
118
    # Constants returned by describe_change()
 
119
    #
 
120
    # TODO: These should probably move to some kind of FileChangeDescription 
 
121
    # class; that's like what's inside a TreeDelta but we want to be able to 
 
122
    # generate them just for one file at a time.
 
123
    RENAMED = 'renamed'
 
124
    MODIFIED_AND_RENAMED = 'modified and renamed'
113
125
    
114
126
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
115
 
                 'text_id', 'parent_id', 'children',
116
 
                 'text_version', 'entry_version', ]
117
 
 
118
 
 
119
 
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
 
127
                 'text_id', 'parent_id', 'children', 'executable', 
 
128
                 'revision']
 
129
 
 
130
    def detect_changes(self, old_entry):
 
131
        """Return a (text_modified, meta_modified) from this to old_entry.
 
132
        
 
133
        _read_tree_state must have been called on self and old_entry prior to 
 
134
        calling detect_changes.
 
135
        """
 
136
        return False, False
 
137
 
 
138
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
139
             output_to, reverse=False):
 
140
        """Perform a diff from this to to_entry.
 
141
 
 
142
        text_diff will be used for textual difference calculation.
 
143
        This is a template method, override _diff in child classes.
 
144
        """
 
145
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
146
        if to_entry:
 
147
            # cannot diff from one kind to another - you must do a removal
 
148
            # and an addif they do not match.
 
149
            assert self.kind == to_entry.kind
 
150
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
151
                                      to_tree)
 
152
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
153
                   output_to, reverse)
 
154
 
 
155
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
156
             output_to, reverse=False):
 
157
        """Perform a diff between two entries of the same kind."""
 
158
 
 
159
    def find_previous_heads(self, previous_inventories,
 
160
                            versioned_file_store,
 
161
                            transaction,
 
162
                            entry_vf=None):
 
163
        """Return the revisions and entries that directly preceed this.
 
164
 
 
165
        Returned as a map from revision to inventory entry.
 
166
 
 
167
        This is a map containing the file revisions in all parents
 
168
        for which the file exists, and its revision is not a parent of
 
169
        any other. If the file is new, the set will be empty.
 
170
 
 
171
        :param versioned_file_store: A store where ancestry data on this
 
172
                                     file id can be queried.
 
173
        :param transaction: The transaction that queries to the versioned 
 
174
                            file store should be completed under.
 
175
        :param entry_vf: The entry versioned file, if its already available.
 
176
        """
 
177
        def get_ancestors(weave, entry):
 
178
            return set(weave.get_ancestry(entry.revision))
 
179
        # revision:ie mapping for each ie found in previous_inventories.
 
180
        candidates = {}
 
181
        # revision:ie mapping with one revision for each head.
 
182
        heads = {}
 
183
        # revision: ancestor list for each head
 
184
        head_ancestors = {}
 
185
        # identify candidate head revision ids.
 
186
        for inv in previous_inventories:
 
187
            if self.file_id in inv:
 
188
                ie = inv[self.file_id]
 
189
                assert ie.file_id == self.file_id
 
190
                if ie.revision in candidates:
 
191
                    # same revision value in two different inventories:
 
192
                    # correct possible inconsistencies:
 
193
                    #     * there was a bug in revision updates with 'x' bit 
 
194
                    #       support.
 
195
                    try:
 
196
                        if candidates[ie.revision].executable != ie.executable:
 
197
                            candidates[ie.revision].executable = False
 
198
                            ie.executable = False
 
199
                    except AttributeError:
 
200
                        pass
 
201
                    # must now be the same.
 
202
                    assert candidates[ie.revision] == ie
 
203
                else:
 
204
                    # add this revision as a candidate.
 
205
                    candidates[ie.revision] = ie
 
206
 
 
207
        # common case optimisation
 
208
        if len(candidates) == 1:
 
209
            # if there is only one candidate revision found
 
210
            # then we can opening the versioned file to access ancestry:
 
211
            # there cannot be any ancestors to eliminate when there is 
 
212
            # only one revision available.
 
213
            heads[ie.revision] = ie
 
214
            return heads
 
215
 
 
216
        # eliminate ancestors amongst the available candidates:
 
217
        # heads are those that are not an ancestor of any other candidate
 
218
        # - this provides convergence at a per-file level.
 
219
        for ie in candidates.values():
 
220
            # may be an ancestor of a known head:
 
221
            already_present = 0 != len(
 
222
                [head for head in heads 
 
223
                 if ie.revision in head_ancestors[head]])
 
224
            if already_present:
 
225
                # an ancestor of an analyzed candidate.
 
226
                continue
 
227
            # not an ancestor of a known head:
 
228
            # load the versioned file for this file id if needed
 
229
            if entry_vf is None:
 
230
                entry_vf = versioned_file_store.get_weave_or_empty(
 
231
                    self.file_id, transaction)
 
232
            ancestors = get_ancestors(entry_vf, ie)
 
233
            # may knock something else out:
 
234
            check_heads = list(heads.keys())
 
235
            for head in check_heads:
 
236
                if head in ancestors:
 
237
                    # this previously discovered 'head' is not
 
238
                    # really a head - its an ancestor of the newly 
 
239
                    # found head,
 
240
                    heads.pop(head)
 
241
            head_ancestors[ie.revision] = ancestors
 
242
            heads[ie.revision] = ie
 
243
        return heads
 
244
 
 
245
    def get_tar_item(self, root, dp, now, tree):
 
246
        """Get a tarfile item and a file stream for its content."""
 
247
        item = tarfile.TarInfo(pathjoin(root, dp))
 
248
        # TODO: would be cool to actually set it to the timestamp of the
 
249
        # revision it was last changed
 
250
        item.mtime = now
 
251
        fileobj = self._put_in_tar(item, tree)
 
252
        return item, fileobj
 
253
 
 
254
    def has_text(self):
 
255
        """Return true if the object this entry represents has textual data.
 
256
 
 
257
        Note that textual data includes binary content.
 
258
 
 
259
        Also note that all entries get weave files created for them.
 
260
        This attribute is primarily used when upgrading from old trees that
 
261
        did not have the weave index for all inventory entries.
 
262
        """
 
263
        return False
 
264
 
 
265
    def __init__(self, file_id, name, parent_id, text_id=None):
120
266
        """Create an InventoryEntry
121
267
        
122
268
        The filename must be a single component, relative to the
123
269
        parent directory; it cannot be a whole path or relative name.
124
270
 
125
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
271
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
126
272
        >>> e.name
127
273
        'hello.c'
128
274
        >>> e.file_id
129
275
        '123'
130
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
276
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
131
277
        Traceback (most recent call last):
132
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
278
        InvalidEntryName: Invalid entry name: src/hello.c
133
279
        """
134
280
        assert isinstance(name, basestring), name
135
281
        if '/' in name or '\\' in name:
136
 
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
137
 
        
138
 
        self.text_version = None
139
 
        self.entry_version = None
 
282
            raise InvalidEntryName(name=name)
 
283
        self.executable = False
 
284
        self.revision = None
140
285
        self.text_sha1 = None
141
286
        self.text_size = None
142
287
        self.file_id = file_id
143
288
        self.name = name
144
 
        self.kind = kind
145
289
        self.text_id = text_id
146
290
        self.parent_id = parent_id
147
 
        if kind == 'directory':
148
 
            self.children = {}
149
 
        elif kind == 'file':
150
 
            pass
151
 
        else:
152
 
            raise BzrError("unhandled entry kind %r" % kind)
153
 
 
154
 
 
 
291
        self.symlink_target = None
 
292
 
 
293
    def kind_character(self):
 
294
        """Return a short kind indicator useful for appending to names."""
 
295
        raise BzrError('unknown kind %r' % self.kind)
 
296
 
 
297
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
298
 
 
299
    def _put_in_tar(self, item, tree):
 
300
        """populate item for stashing in a tar, and return the content stream.
 
301
 
 
302
        If no content is available, return None.
 
303
        """
 
304
        raise BzrError("don't know how to export {%s} of kind %r" %
 
305
                       (self.file_id, self.kind))
 
306
 
 
307
    def put_on_disk(self, dest, dp, tree):
 
308
        """Create a representation of self on disk in the prefix dest.
 
309
        
 
310
        This is a template method - implement _put_on_disk in subclasses.
 
311
        """
 
312
        fullpath = pathjoin(dest, dp)
 
313
        self._put_on_disk(fullpath, tree)
 
314
        mutter("  export {%s} kind %s to %s", self.file_id,
 
315
                self.kind, fullpath)
 
316
 
 
317
    def _put_on_disk(self, fullpath, tree):
 
318
        """Put this entry onto disk at fullpath, from tree tree."""
 
319
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
155
320
 
156
321
    def sorted_children(self):
157
322
        l = self.children.items()
158
323
        l.sort()
159
324
        return l
160
325
 
 
326
    @staticmethod
 
327
    def versionable_kind(kind):
 
328
        return kind in ('file', 'directory', 'symlink')
 
329
 
 
330
    def check(self, checker, rev_id, inv, tree):
 
331
        """Check this inventory entry is intact.
 
332
 
 
333
        This is a template method, override _check for kind specific
 
334
        tests.
 
335
 
 
336
        :param checker: Check object providing context for the checks; 
 
337
             can be used to find out what parts of the repository have already
 
338
             been checked.
 
339
        :param rev_id: Revision id from which this InventoryEntry was loaded.
 
340
             Not necessarily the last-changed revision for this file.
 
341
        :param inv: Inventory from which the entry was loaded.
 
342
        :param tree: RevisionTree for this entry.
 
343
        """
 
344
        if self.parent_id != None:
 
345
            if not inv.has_id(self.parent_id):
 
346
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
347
                        % (self.parent_id, rev_id))
 
348
        self._check(checker, rev_id, tree)
 
349
 
 
350
    def _check(self, checker, rev_id, tree):
 
351
        """Check this inventory entry for kind specific errors."""
 
352
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
353
                            (self.kind, rev_id))
161
354
 
162
355
    def copy(self):
163
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
164
 
                               self.parent_id)
165
 
        other.text_id = self.text_id
166
 
        other.text_sha1 = self.text_sha1
167
 
        other.text_size = self.text_size
168
 
        other.text_version = self.text_version
169
 
        # note that children are *not* copied; they're pulled across when
170
 
        # others are added
171
 
        return other
172
 
 
 
356
        """Clone this inventory entry."""
 
357
        raise NotImplementedError
 
358
 
 
359
    @staticmethod
 
360
    def describe_change(old_entry, new_entry):
 
361
        """Describe the change between old_entry and this.
 
362
        
 
363
        This smells of being an InterInventoryEntry situation, but as its
 
364
        the first one, we're making it a static method for now.
 
365
 
 
366
        An entry with a different parent, or different name is considered 
 
367
        to be renamed. Reparenting is an internal detail.
 
368
        Note that renaming the parent does not trigger a rename for the
 
369
        child entry itself.
 
370
        """
 
371
        # TODO: Perhaps return an object rather than just a string
 
372
        if old_entry is new_entry:
 
373
            # also the case of both being None
 
374
            return 'unchanged'
 
375
        elif old_entry is None:
 
376
            return 'added'
 
377
        elif new_entry is None:
 
378
            return 'removed'
 
379
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
380
        if text_modified or meta_modified:
 
381
            modified = True
 
382
        else:
 
383
            modified = False
 
384
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
 
385
        if old_entry.parent_id != new_entry.parent_id:
 
386
            renamed = True
 
387
        elif old_entry.name != new_entry.name:
 
388
            renamed = True
 
389
        else:
 
390
            renamed = False
 
391
        if renamed and not modified:
 
392
            return InventoryEntry.RENAMED
 
393
        if modified and not renamed:
 
394
            return 'modified'
 
395
        if modified and renamed:
 
396
            return InventoryEntry.MODIFIED_AND_RENAMED
 
397
        return 'unchanged'
173
398
 
174
399
    def __repr__(self):
175
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
400
        return ("%s(%r, %r, parent_id=%r)"
176
401
                % (self.__class__.__name__,
177
402
                   self.file_id,
178
403
                   self.name,
179
 
                   self.kind,
180
404
                   self.parent_id))
181
405
 
182
 
    
 
406
    def snapshot(self, revision, path, previous_entries,
 
407
                 work_tree, commit_builder):
 
408
        """Make a snapshot of this entry which may or may not have changed.
 
409
        
 
410
        This means that all its fields are populated, that it has its
 
411
        text stored in the text store or weave.
 
412
        """
 
413
        mutter('new parents of %s are %r', path, previous_entries)
 
414
        self._read_tree_state(path, work_tree)
 
415
        # TODO: Where should we determine whether to reuse a
 
416
        # previous revision id or create a new revision? 20060606
 
417
        if len(previous_entries) == 1:
 
418
            # cannot be unchanged unless there is only one parent file rev.
 
419
            parent_ie = previous_entries.values()[0]
 
420
            if self._unchanged(parent_ie):
 
421
                mutter("found unchanged entry")
 
422
                self.revision = parent_ie.revision
 
423
                return "unchanged"
 
424
        return self._snapshot_into_revision(revision, previous_entries, 
 
425
                                            work_tree, commit_builder)
 
426
 
 
427
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
 
428
                                commit_builder):
 
429
        """Record this revision unconditionally into a store.
 
430
 
 
431
        The entry's last-changed revision property (`revision`) is updated to 
 
432
        that of the new revision.
 
433
        
 
434
        :param revision: id of the new revision that is being recorded.
 
435
 
 
436
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
 
437
        """
 
438
        mutter('new revision {%s} for {%s}', revision, self.file_id)
 
439
        self.revision = revision
 
440
        self._snapshot_text(previous_entries, work_tree, commit_builder)
 
441
 
 
442
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
 
443
        """Record the 'text' of this entry, whatever form that takes.
 
444
        
 
445
        This default implementation simply adds an empty text.
 
446
        """
 
447
        raise NotImplementedError(self._snapshot_text)
 
448
 
183
449
    def __eq__(self, other):
184
450
        if not isinstance(other, InventoryEntry):
185
451
            return NotImplemented
186
452
 
187
 
        return (self.file_id == other.file_id) \
188
 
               and (self.name == other.name) \
189
 
               and (self.text_sha1 == other.text_sha1) \
190
 
               and (self.text_size == other.text_size) \
191
 
               and (self.text_id == other.text_id) \
192
 
               and (self.parent_id == other.parent_id) \
193
 
               and (self.kind == other.kind) \
194
 
               and (self.text_version == other.text_version) \
195
 
               and (self.entry_version == other.entry_version)
196
 
 
 
453
        return ((self.file_id == other.file_id)
 
454
                and (self.name == other.name)
 
455
                and (other.symlink_target == self.symlink_target)
 
456
                and (self.text_sha1 == other.text_sha1)
 
457
                and (self.text_size == other.text_size)
 
458
                and (self.text_id == other.text_id)
 
459
                and (self.parent_id == other.parent_id)
 
460
                and (self.kind == other.kind)
 
461
                and (self.revision == other.revision)
 
462
                and (self.executable == other.executable)
 
463
                )
197
464
 
198
465
    def __ne__(self, other):
199
466
        return not (self == other)
201
468
    def __hash__(self):
202
469
        raise ValueError('not hashable')
203
470
 
 
471
    def _unchanged(self, previous_ie):
 
472
        """Has this entry changed relative to previous_ie.
 
473
 
 
474
        This method should be overriden in child classes.
 
475
        """
 
476
        compatible = True
 
477
        # different inv parent
 
478
        if previous_ie.parent_id != self.parent_id:
 
479
            compatible = False
 
480
        # renamed
 
481
        elif previous_ie.name != self.name:
 
482
            compatible = False
 
483
        return compatible
 
484
 
 
485
    def _read_tree_state(self, path, work_tree):
 
486
        """Populate fields in the inventory entry from the given tree.
 
487
        
 
488
        Note that this should be modified to be a noop on virtual trees
 
489
        as all entries created there are prepopulated.
 
490
        """
 
491
        # TODO: Rather than running this manually, we should check the 
 
492
        # working sha1 and other expensive properties when they're
 
493
        # first requested, or preload them if they're already known
 
494
        pass            # nothing to do by default
 
495
 
 
496
    def _forget_tree_state(self):
 
497
        pass
204
498
 
205
499
 
206
500
class RootEntry(InventoryEntry):
 
501
 
 
502
    def _check(self, checker, rev_id, tree):
 
503
        """See InventoryEntry._check"""
 
504
 
207
505
    def __init__(self, file_id):
208
506
        self.file_id = file_id
209
507
        self.children = {}
210
508
        self.kind = 'root_directory'
211
509
        self.parent_id = None
212
 
        self.name = ''
 
510
        self.name = u''
213
511
 
214
512
    def __eq__(self, other):
215
513
        if not isinstance(other, RootEntry):
219
517
               and (self.children == other.children)
220
518
 
221
519
 
 
520
class InventoryDirectory(InventoryEntry):
 
521
    """A directory in an inventory."""
 
522
 
 
523
    def _check(self, checker, rev_id, tree):
 
524
        """See InventoryEntry._check"""
 
525
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
526
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
527
                                % (self.file_id, rev_id))
 
528
 
 
529
    def copy(self):
 
530
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
531
        other.revision = self.revision
 
532
        # note that children are *not* copied; they're pulled across when
 
533
        # others are added
 
534
        return other
 
535
 
 
536
    def __init__(self, file_id, name, parent_id):
 
537
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
538
        self.children = {}
 
539
        self.kind = 'directory'
 
540
 
 
541
    def kind_character(self):
 
542
        """See InventoryEntry.kind_character."""
 
543
        return '/'
 
544
 
 
545
    def _put_in_tar(self, item, tree):
 
546
        """See InventoryEntry._put_in_tar."""
 
547
        item.type = tarfile.DIRTYPE
 
548
        fileobj = None
 
549
        item.name += '/'
 
550
        item.size = 0
 
551
        item.mode = 0755
 
552
        return fileobj
 
553
 
 
554
    def _put_on_disk(self, fullpath, tree):
 
555
        """See InventoryEntry._put_on_disk."""
 
556
        os.mkdir(fullpath)
 
557
 
 
558
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
559
        """See InventoryEntry._snapshot_text."""
 
560
        commit_builder.modified_directory(self.file_id, file_parents)
 
561
 
 
562
 
 
563
class InventoryFile(InventoryEntry):
 
564
    """A file in an inventory."""
 
565
 
 
566
    def _check(self, checker, tree_revision_id, tree):
 
567
        """See InventoryEntry._check"""
 
568
        t = (self.file_id, self.revision)
 
569
        if t in checker.checked_texts:
 
570
            prev_sha = checker.checked_texts[t]
 
571
            if prev_sha != self.text_sha1:
 
572
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
573
                                    (self.file_id, tree_revision_id))
 
574
            else:
 
575
                checker.repeated_text_cnt += 1
 
576
                return
 
577
 
 
578
        if self.file_id not in checker.checked_weaves:
 
579
            mutter('check weave {%s}', self.file_id)
 
580
            w = tree.get_weave(self.file_id)
 
581
            # Not passing a progress bar, because it creates a new
 
582
            # progress, which overwrites the current progress,
 
583
            # and doesn't look nice
 
584
            w.check()
 
585
            checker.checked_weaves[self.file_id] = True
 
586
        else:
 
587
            w = tree.get_weave(self.file_id)
 
588
 
 
589
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
 
590
        checker.checked_text_cnt += 1
 
591
        # We can't check the length, because Weave doesn't store that
 
592
        # information, and the whole point of looking at the weave's
 
593
        # sha1sum is that we don't have to extract the text.
 
594
        if self.text_sha1 != w.get_sha1(self.revision):
 
595
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
596
                                % (self.file_id, self.revision))
 
597
        checker.checked_texts[t] = self.text_sha1
 
598
 
 
599
    def copy(self):
 
600
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
601
        other.executable = self.executable
 
602
        other.text_id = self.text_id
 
603
        other.text_sha1 = self.text_sha1
 
604
        other.text_size = self.text_size
 
605
        other.revision = self.revision
 
606
        return other
 
607
 
 
608
    def detect_changes(self, old_entry):
 
609
        """See InventoryEntry.detect_changes."""
 
610
        assert self.text_sha1 != None
 
611
        assert old_entry.text_sha1 != None
 
612
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
613
        meta_modified = (self.executable != old_entry.executable)
 
614
        return text_modified, meta_modified
 
615
 
 
616
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
617
             output_to, reverse=False):
 
618
        """See InventoryEntry._diff."""
 
619
        try:
 
620
            from_text = tree.get_file(self.file_id).readlines()
 
621
            if to_entry:
 
622
                to_text = to_tree.get_file(to_entry.file_id).readlines()
 
623
            else:
 
624
                to_text = []
 
625
            if not reverse:
 
626
                text_diff(from_label, from_text,
 
627
                          to_label, to_text, output_to)
 
628
            else:
 
629
                text_diff(to_label, to_text,
 
630
                          from_label, from_text, output_to)
 
631
        except BinaryFile:
 
632
            if reverse:
 
633
                label_pair = (to_label, from_label)
 
634
            else:
 
635
                label_pair = (from_label, to_label)
 
636
            print >> output_to, "Binary files %s and %s differ" % label_pair
 
637
 
 
638
    def has_text(self):
 
639
        """See InventoryEntry.has_text."""
 
640
        return True
 
641
 
 
642
    def __init__(self, file_id, name, parent_id):
 
643
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
644
        self.kind = 'file'
 
645
 
 
646
    def kind_character(self):
 
647
        """See InventoryEntry.kind_character."""
 
648
        return ''
 
649
 
 
650
    def _put_in_tar(self, item, tree):
 
651
        """See InventoryEntry._put_in_tar."""
 
652
        item.type = tarfile.REGTYPE
 
653
        fileobj = tree.get_file(self.file_id)
 
654
        item.size = self.text_size
 
655
        if tree.is_executable(self.file_id):
 
656
            item.mode = 0755
 
657
        else:
 
658
            item.mode = 0644
 
659
        return fileobj
 
660
 
 
661
    def _put_on_disk(self, fullpath, tree):
 
662
        """See InventoryEntry._put_on_disk."""
 
663
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
664
        if tree.is_executable(self.file_id):
 
665
            os.chmod(fullpath, 0755)
 
666
 
 
667
    def _read_tree_state(self, path, work_tree):
 
668
        """See InventoryEntry._read_tree_state."""
 
669
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
 
670
        # FIXME: 20050930 probe for the text size when getting sha1
 
671
        # in _read_tree_state
 
672
        self.executable = work_tree.is_executable(self.file_id, path=path)
 
673
 
 
674
    def _forget_tree_state(self):
 
675
        self.text_sha1 = None
 
676
        self.executable = None
 
677
 
 
678
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
679
        """See InventoryEntry._snapshot_text."""
 
680
        def get_content_byte_lines():
 
681
            return work_tree.get_file(self.file_id).readlines()
 
682
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
 
683
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
 
684
 
 
685
    def _unchanged(self, previous_ie):
 
686
        """See InventoryEntry._unchanged."""
 
687
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
688
        if self.text_sha1 != previous_ie.text_sha1:
 
689
            compatible = False
 
690
        else:
 
691
            # FIXME: 20050930 probe for the text size when getting sha1
 
692
            # in _read_tree_state
 
693
            self.text_size = previous_ie.text_size
 
694
        if self.executable != previous_ie.executable:
 
695
            compatible = False
 
696
        return compatible
 
697
 
 
698
 
 
699
class InventoryLink(InventoryEntry):
 
700
    """A file in an inventory."""
 
701
 
 
702
    __slots__ = ['symlink_target']
 
703
 
 
704
    def _check(self, checker, rev_id, tree):
 
705
        """See InventoryEntry._check"""
 
706
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
707
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
708
                    % (self.file_id, rev_id))
 
709
        if self.symlink_target is None:
 
710
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
711
                    % (self.file_id, rev_id))
 
712
 
 
713
    def copy(self):
 
714
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
715
        other.symlink_target = self.symlink_target
 
716
        other.revision = self.revision
 
717
        return other
 
718
 
 
719
    def detect_changes(self, old_entry):
 
720
        """See InventoryEntry.detect_changes."""
 
721
        # FIXME: which _modified field should we use ? RBC 20051003
 
722
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
723
        if text_modified:
 
724
            mutter("    symlink target changed")
 
725
        meta_modified = False
 
726
        return text_modified, meta_modified
 
727
 
 
728
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
729
             output_to, reverse=False):
 
730
        """See InventoryEntry._diff."""
 
731
        from_text = self.symlink_target
 
732
        if to_entry is not None:
 
733
            to_text = to_entry.symlink_target
 
734
            if reverse:
 
735
                temp = from_text
 
736
                from_text = to_text
 
737
                to_text = temp
 
738
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
739
        else:
 
740
            if not reverse:
 
741
                print >>output_to, '=== target was %r' % self.symlink_target
 
742
            else:
 
743
                print >>output_to, '=== target is %r' % self.symlink_target
 
744
 
 
745
    def __init__(self, file_id, name, parent_id):
 
746
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
747
        self.kind = 'symlink'
 
748
 
 
749
    def kind_character(self):
 
750
        """See InventoryEntry.kind_character."""
 
751
        return ''
 
752
 
 
753
    def _put_in_tar(self, item, tree):
 
754
        """See InventoryEntry._put_in_tar."""
 
755
        item.type = tarfile.SYMTYPE
 
756
        fileobj = None
 
757
        item.size = 0
 
758
        item.mode = 0755
 
759
        item.linkname = self.symlink_target
 
760
        return fileobj
 
761
 
 
762
    def _put_on_disk(self, fullpath, tree):
 
763
        """See InventoryEntry._put_on_disk."""
 
764
        try:
 
765
            os.symlink(self.symlink_target, fullpath)
 
766
        except OSError,e:
 
767
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
768
 
 
769
    def _read_tree_state(self, path, work_tree):
 
770
        """See InventoryEntry._read_tree_state."""
 
771
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
772
 
 
773
    def _forget_tree_state(self):
 
774
        self.symlink_target = None
 
775
 
 
776
    def _unchanged(self, previous_ie):
 
777
        """See InventoryEntry._unchanged."""
 
778
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
779
        if self.symlink_target != previous_ie.symlink_target:
 
780
            compatible = False
 
781
        return compatible
 
782
 
 
783
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
784
        """See InventoryEntry._snapshot_text."""
 
785
        commit_builder.modified_link(
 
786
            self.file_id, file_parents, self.symlink_target)
 
787
 
222
788
 
223
789
class Inventory(object):
224
790
    """Inventory of versioned files in a tree.
238
804
    inserted, other than through the Inventory API.
239
805
 
240
806
    >>> inv = Inventory()
241
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
242
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
807
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
808
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
243
809
    >>> inv['123-123'].name
244
810
    'hello.c'
245
811
 
253
819
    May also look up by name:
254
820
 
255
821
    >>> [x[0] for x in inv.iter_entries()]
256
 
    ['hello.c']
 
822
    [u'hello.c']
257
823
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
258
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
259
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
 
824
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
825
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
260
826
    """
261
 
    def __init__(self, root_id=ROOT_ID):
 
827
    def __init__(self, root_id=ROOT_ID, revision_id=None):
262
828
        """Create or read an inventory.
263
829
 
264
830
        If a working directory is specified, the inventory is read
268
834
        The inventory is created with a default root directory, with
269
835
        an id of None.
270
836
        """
271
 
        # We are letting Branch(init=True) create a unique inventory
 
837
        # We are letting Branch.create() create a unique inventory
272
838
        # root id. Rather than generating a random one here.
273
839
        #if root_id is None:
274
840
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
275
841
        self.root = RootEntry(root_id)
 
842
        self.revision_id = revision_id
276
843
        self._byid = {self.root.file_id: self.root}
277
844
 
278
 
 
279
845
    def copy(self):
 
846
        # TODO: jam 20051218 Should copy also copy the revision_id?
280
847
        other = Inventory(self.root.file_id)
281
848
        # copy recursively so we know directories will be added before
282
849
        # their children.  There are more efficient ways than this...
286
853
            other.add(entry.copy())
287
854
        return other
288
855
 
289
 
 
290
856
    def __iter__(self):
291
857
        return iter(self._byid)
292
858
 
293
 
 
294
859
    def __len__(self):
295
860
        """Returns number of entries."""
296
861
        return len(self._byid)
297
862
 
298
 
 
299
863
    def iter_entries(self, from_dir=None):
300
864
        """Return (path, entry) pairs, in order by name."""
301
 
        if from_dir == None:
302
 
            assert self.root
303
 
            from_dir = self.root
304
 
        elif isinstance(from_dir, basestring):
305
 
            from_dir = self._byid[from_dir]
306
 
            
307
 
        kids = from_dir.children.items()
308
 
        kids.sort()
309
 
        for name, ie in kids:
310
 
            yield name, ie
311
 
            if ie.kind == 'directory':
312
 
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
313
 
                    yield os.path.join(name, cn), cie
314
 
 
 
865
        if from_dir is None:
 
866
            assert self.root
 
867
            from_dir = self.root
 
868
        elif isinstance(from_dir, basestring):
 
869
            from_dir = self._byid[from_dir]
 
870
            
 
871
        # unrolling the recursive called changed the time from
 
872
        # 440ms/663ms (inline/total) to 116ms/116ms
 
873
        children = from_dir.children.items()
 
874
        children.sort()
 
875
        children = collections.deque(children)
 
876
        stack = [(u'', children)]
 
877
        while stack:
 
878
            from_dir_relpath, children = stack[-1]
 
879
 
 
880
            while children:
 
881
                name, ie = children.popleft()
 
882
 
 
883
                # we know that from_dir_relpath never ends in a slash
 
884
                # and 'f' doesn't begin with one, we can do a string op, rather
 
885
                # than the checks of pathjoin(), though this means that all paths
 
886
                # start with a slash
 
887
                path = from_dir_relpath + '/' + name
 
888
 
 
889
                yield path[1:], ie
 
890
 
 
891
                if ie.kind != 'directory':
 
892
                    continue
 
893
 
 
894
                # But do this child first
 
895
                new_children = ie.children.items()
 
896
                new_children.sort()
 
897
                new_children = collections.deque(new_children)
 
898
                stack.append((path, new_children))
 
899
                # Break out of inner loop, so that we start outer loop with child
 
900
                break
 
901
            else:
 
902
                # if we finished all children, pop it off the stack
 
903
                stack.pop()
 
904
 
 
905
    def iter_entries_by_dir(self, from_dir=None):
 
906
        """Iterate over the entries in a directory first order.
 
907
 
 
908
        This returns all entries for a directory before returning
 
909
        the entries for children of a directory. This is not
 
910
        lexicographically sorted order, and is a hybrid between
 
911
        depth-first and breadth-first.
 
912
 
 
913
        :return: This yields (path, entry) pairs
 
914
        """
 
915
        # TODO? Perhaps this should return the from_dir so that the root is
 
916
        # yielded? or maybe an option?
 
917
        if from_dir is None:
 
918
            assert self.root
 
919
            from_dir = self.root
 
920
        elif isinstance(from_dir, basestring):
 
921
            from_dir = self._byid[from_dir]
 
922
            
 
923
        stack = [(u'', from_dir)]
 
924
        while stack:
 
925
            cur_relpath, cur_dir = stack.pop()
 
926
 
 
927
            child_dirs = []
 
928
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
 
929
 
 
930
                child_relpath = cur_relpath + child_name
 
931
 
 
932
                yield child_relpath, child_ie
 
933
 
 
934
                if child_ie.kind == 'directory':
 
935
                    child_dirs.append((child_relpath+'/', child_ie))
 
936
            stack.extend(reversed(child_dirs))
315
937
 
316
938
    def entries(self):
317
939
        """Return list of (path, ie) for all entries except the root.
323
945
            kids = dir_ie.children.items()
324
946
            kids.sort()
325
947
            for name, ie in kids:
326
 
                child_path = os.path.join(dir_path, name)
 
948
                child_path = pathjoin(dir_path, name)
327
949
                accum.append((child_path, ie))
328
950
                if ie.kind == 'directory':
329
951
                    descend(ie, child_path)
330
952
 
331
 
        descend(self.root, '')
 
953
        descend(self.root, u'')
332
954
        return accum
333
955
 
334
 
 
335
956
    def directories(self):
336
957
        """Return (path, entry) pairs for all directories, including the root.
337
958
        """
343
964
            kids.sort()
344
965
 
345
966
            for name, child_ie in kids:
346
 
                child_path = os.path.join(parent_path, name)
 
967
                child_path = pathjoin(parent_path, name)
347
968
                descend(child_ie, child_path)
348
 
        descend(self.root, '')
 
969
        descend(self.root, u'')
349
970
        return accum
350
971
        
351
 
 
352
 
 
353
972
    def __contains__(self, file_id):
354
973
        """True if this entry contains a file with given id.
355
974
 
356
975
        >>> inv = Inventory()
357
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
358
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
976
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
977
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
359
978
        >>> '123' in inv
360
979
        True
361
980
        >>> '456' in inv
363
982
        """
364
983
        return file_id in self._byid
365
984
 
366
 
 
367
985
    def __getitem__(self, file_id):
368
986
        """Return the entry for given file_id.
369
987
 
370
988
        >>> inv = Inventory()
371
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
372
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
989
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
990
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
373
991
        >>> inv['123123'].name
374
992
        'hello.c'
375
993
        """
376
994
        try:
377
995
            return self._byid[file_id]
378
996
        except KeyError:
379
 
            if file_id == None:
 
997
            if file_id is None:
380
998
                raise BzrError("can't look up file_id None")
381
999
            else:
382
1000
                raise BzrError("file_id {%s} not in inventory" % file_id)
383
1001
 
384
 
 
385
1002
    def get_file_kind(self, file_id):
386
1003
        return self._byid[file_id].kind
387
1004
 
388
1005
    def get_child(self, parent_id, filename):
389
1006
        return self[parent_id].children.get(filename)
390
1007
 
391
 
 
392
1008
    def add(self, entry):
393
1009
        """Add entry to inventory.
394
1010
 
410
1026
 
411
1027
        if parent.children.has_key(entry.name):
412
1028
            raise BzrError("%s is already versioned" %
413
 
                    appendpath(self.id2path(parent.file_id), entry.name))
 
1029
                    pathjoin(self.id2path(parent.file_id), entry.name))
414
1030
 
415
1031
        self._byid[entry.file_id] = entry
416
1032
        parent.children[entry.name] = entry
417
1033
        return entry
418
1034
 
419
 
 
420
 
    def add_path(self, relpath, kind, file_id=None):
 
1035
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
421
1036
        """Add entry from a path.
422
1037
 
423
1038
        The immediate parent must already be versioned.
424
1039
 
425
1040
        Returns the new entry object."""
426
 
        from bzrlib.branch import gen_file_id
427
1041
        
428
1042
        parts = bzrlib.osutils.splitpath(relpath)
 
1043
 
429
1044
        if len(parts) == 0:
430
 
            raise BzrError("cannot re-add root of inventory")
431
 
 
432
 
        if file_id == None:
433
 
            file_id = gen_file_id(relpath)
434
 
 
435
 
        parent_path = parts[:-1]
436
 
        parent_id = self.path2id(parent_path)
437
 
        if parent_id == None:
438
 
            raise NotVersionedError(parent_path)
439
 
 
440
 
        ie = InventoryEntry(file_id, parts[-1],
441
 
                            kind=kind, parent_id=parent_id)
 
1045
            if file_id is None:
 
1046
                file_id = bzrlib.workingtree.gen_root_id()
 
1047
            self.root = RootEntry(file_id)
 
1048
            self._byid = {self.root.file_id: self.root}
 
1049
            return
 
1050
        else:
 
1051
            parent_path = parts[:-1]
 
1052
            parent_id = self.path2id(parent_path)
 
1053
            if parent_id is None:
 
1054
                raise NotVersionedError(path=parent_path)
 
1055
        ie = make_entry(kind, parts[-1], parent_id, file_id)
442
1056
        return self.add(ie)
443
1057
 
444
 
 
445
1058
    def __delitem__(self, file_id):
446
1059
        """Remove entry by id.
447
1060
 
448
1061
        >>> inv = Inventory()
449
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
450
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
1062
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1063
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
451
1064
        >>> '123' in inv
452
1065
        True
453
1066
        >>> del inv['123']
456
1069
        """
457
1070
        ie = self[file_id]
458
1071
 
459
 
        assert self[ie.parent_id].children[ie.name] == ie
 
1072
        assert ie.parent_id is None or \
 
1073
            self[ie.parent_id].children[ie.name] == ie
460
1074
        
461
 
        # TODO: Test deleting all children; maybe hoist to a separate
462
 
        # deltree method?
463
 
        if ie.kind == 'directory':
464
 
            for cie in ie.children.values():
465
 
                del self[cie.file_id]
466
 
            del ie.children
467
 
 
468
1075
        del self._byid[file_id]
469
 
        del self[ie.parent_id].children[ie.name]
470
 
 
 
1076
        if ie.parent_id is not None:
 
1077
            del self[ie.parent_id].children[ie.name]
471
1078
 
472
1079
    def __eq__(self, other):
473
1080
        """Compare two sets by comparing their contents.
476
1083
        >>> i2 = Inventory()
477
1084
        >>> i1 == i2
478
1085
        True
479
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
480
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
1086
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
1087
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
481
1088
        >>> i1 == i2
482
1089
        False
483
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
484
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
1090
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
1091
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
485
1092
        >>> i1 == i2
486
1093
        True
487
1094
        """
494
1101
 
495
1102
        return self._byid == other._byid
496
1103
 
497
 
 
498
1104
    def __ne__(self, other):
499
 
        return not (self == other)
500
 
 
 
1105
        return not self.__eq__(other)
501
1106
 
502
1107
    def __hash__(self):
503
1108
        raise ValueError('not hashable')
504
1109
 
 
1110
    def _iter_file_id_parents(self, file_id):
 
1111
        """Yield the parents of file_id up to the root."""
 
1112
        while file_id != None:
 
1113
            try:
 
1114
                ie = self._byid[file_id]
 
1115
            except KeyError:
 
1116
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1117
            yield ie
 
1118
            file_id = ie.parent_id
505
1119
 
506
1120
    def get_idpath(self, file_id):
507
1121
        """Return a list of file_ids for the path to an entry.
512
1126
        root directory as depth 1.
513
1127
        """
514
1128
        p = []
515
 
        while file_id != None:
516
 
            try:
517
 
                ie = self._byid[file_id]
518
 
            except KeyError:
519
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
520
 
            p.insert(0, ie.file_id)
521
 
            file_id = ie.parent_id
 
1129
        for parent in self._iter_file_id_parents(file_id):
 
1130
            p.insert(0, parent.file_id)
522
1131
        return p
523
1132
 
524
 
 
525
1133
    def id2path(self, file_id):
526
 
        """Return as a list the path to file_id."""
527
 
 
 
1134
        """Return as a string the path to file_id.
 
1135
        
 
1136
        >>> i = Inventory()
 
1137
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1138
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1139
        >>> print i.id2path('foo-id')
 
1140
        src/foo.c
 
1141
        """
528
1142
        # get all names, skipping root
529
 
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
530
 
        return os.sep.join(p)
 
1143
        return '/'.join(reversed(
 
1144
            [parent.name for parent in 
 
1145
             self._iter_file_id_parents(file_id)][:-1]))
531
1146
            
532
 
 
533
 
 
534
1147
    def path2id(self, name):
535
1148
        """Walk down through directories to return entry of last component.
536
1149
 
540
1153
        This returns the entry of the last component in the path,
541
1154
        which may be either a file or a directory.
542
1155
 
543
 
        Returns None iff the path is not found.
 
1156
        Returns None IFF the path is not found.
544
1157
        """
545
1158
        if isinstance(name, types.StringTypes):
546
1159
            name = splitpath(name)
547
1160
 
548
 
        mutter("lookup path %r" % name)
 
1161
        # mutter("lookup path %r" % name)
549
1162
 
550
1163
        parent = self.root
551
1164
        for f in name:
560
1173
 
561
1174
        return parent.file_id
562
1175
 
563
 
 
564
1176
    def has_filename(self, names):
565
1177
        return bool(self.path2id(names))
566
1178
 
567
 
 
568
1179
    def has_id(self, file_id):
569
1180
        return self._byid.has_key(file_id)
570
1181
 
571
 
 
572
1182
    def rename(self, file_id, new_parent_id, new_name):
573
1183
        """Move a file within the inventory.
574
1184
 
599
1209
        file_ie.parent_id = new_parent_id
600
1210
 
601
1211
 
 
1212
def make_entry(kind, name, parent_id, file_id=None):
 
1213
    """Create an inventory entry.
 
1214
 
 
1215
    :param kind: the type of inventory entry to create.
 
1216
    :param name: the basename of the entry.
 
1217
    :param parent_id: the parent_id of the entry.
 
1218
    :param file_id: the file_id to use. if None, one will be created.
 
1219
    """
 
1220
    if file_id is None:
 
1221
        file_id = bzrlib.workingtree.gen_file_id(name)
 
1222
    if kind == 'directory':
 
1223
        return InventoryDirectory(file_id, name, parent_id)
 
1224
    elif kind == 'file':
 
1225
        return InventoryFile(file_id, name, parent_id)
 
1226
    elif kind == 'symlink':
 
1227
        return InventoryLink(file_id, name, parent_id)
 
1228
    else:
 
1229
        raise BzrError("unknown kind %r" % kind)
 
1230
 
602
1231
 
603
1232
 
604
1233
_NAME_RE = None
605
1234
 
606
1235
def is_valid_name(name):
607
1236
    global _NAME_RE
608
 
    if _NAME_RE == None:
 
1237
    if _NAME_RE is None:
609
1238
        _NAME_RE = re.compile(r'^[^/\\]+$')
610
1239
        
611
1240
    return bool(_NAME_RE.match(name))