~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-06 17:54:19 UTC
  • mto: This revision was merged to the branch mainline in revision 1705.
  • Revision ID: john@arbash-meinel.com-20060506175419-fe86b1f2a9e88a53
Updated web page url to http://bazaar-vcs.org

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
import os
 
30
 
 
31
import os.path
31
32
import re
32
33
import sys
33
 
 
34
 
from bzrlib.lazy_import import lazy_import
35
 
lazy_import(globals(), """
36
 
import collections
37
34
import tarfile
 
35
import types
38
36
 
39
37
import bzrlib
40
 
from bzrlib import (
41
 
    errors,
42
 
    generate_ids,
43
 
    osutils,
44
 
    symbol_versioning,
45
 
    workingtree,
46
 
    )
47
 
""")
48
 
 
49
 
from bzrlib.errors import (
50
 
    BzrCheckError,
51
 
    BzrError,
52
 
    )
53
 
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
 
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
39
                            pathjoin, sha_strings)
 
40
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
41
                           BzrError, BzrCheckError, BinaryFile)
54
42
from bzrlib.trace import mutter
55
43
 
56
44
 
88
76
    >>> i.path2id('')
89
77
    'TREE_ROOT'
90
78
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
91
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
 
79
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
92
80
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
93
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
94
 
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
 
81
    InventoryFile('2323', 'hello.c', parent_id='123')
 
82
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
95
83
    >>> for ix, j in enumerate(i.iter_entries()):
96
84
    ...   print (j[0] == shouldbe[ix], j[1])
97
85
    ... 
98
 
    (True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
99
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
100
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
 
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
    Traceback (most recent call last):
 
90
    ...
 
91
    BzrError: inventory already contains entry with id {2323}
101
92
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
102
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
 
93
    InventoryFile('2324', 'bye.c', parent_id='123')
103
94
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
104
 
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
 
95
    InventoryDirectory('2325', 'wibble', parent_id='123')
105
96
    >>> i.path2id('src/wibble')
106
97
    '2325'
107
98
    >>> '2325' in i
108
99
    True
109
100
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
110
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
101
    InventoryFile('2326', 'wibble.c', parent_id='2325')
111
102
    >>> i['2326']
112
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
103
    InventoryFile('2326', 'wibble.c', parent_id='2325')
113
104
    >>> for path, entry in i.iter_entries():
114
105
    ...     print path
 
106
    ...     assert i.path2id(path)
115
107
    ... 
116
 
    <BLANKLINE>
117
108
    src
118
109
    src/bye.c
119
110
    src/hello.c
122
113
    >>> i.id2path('2326')
123
114
    'src/wibble/wibble.c'
124
115
    """
125
 
 
126
 
    # Constants returned by describe_change()
127
 
    #
128
 
    # TODO: These should probably move to some kind of FileChangeDescription 
129
 
    # class; that's like what's inside a TreeDelta but we want to be able to 
130
 
    # generate them just for one file at a time.
131
 
    RENAMED = 'renamed'
132
 
    MODIFIED_AND_RENAMED = 'modified and renamed'
133
116
    
134
 
    __slots__ = []
 
117
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
118
                 'text_id', 'parent_id', 'children', 'executable', 
 
119
                 'revision']
 
120
 
 
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()
135
126
 
136
127
    def detect_changes(self, old_entry):
137
128
        """Return a (text_modified, meta_modified) from this to old_entry.
141
132
        """
142
133
        return False, False
143
134
 
 
135
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
136
             output_to, reverse=False):
 
137
        """Perform a diff from this to to_entry.
 
138
 
 
139
        text_diff will be used for textual difference calculation.
 
140
        This is a template method, override _diff in child classes.
 
141
        """
 
142
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
143
        if to_entry:
 
144
            # cannot diff from one kind to another - you must do a removal
 
145
            # and an addif they do not match.
 
146
            assert self.kind == to_entry.kind
 
147
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
148
                                      to_tree)
 
149
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
150
                   output_to, reverse)
 
151
 
144
152
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
153
             output_to, reverse=False):
146
154
        """Perform a diff between two entries of the same kind."""
147
 
    
148
 
    def parent_candidates(self, previous_inventories):
149
 
        """Find possible per-file graph parents.
150
 
 
151
 
        This is currently defined by:
152
 
         - Select the last changed revision in the parent inventory.
153
 
         - Do deal with a short lived bug in bzr 0.8's development two entries
154
 
           that have the same last changed but different 'x' bit settings are
155
 
           changed in-place.
 
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.
156
173
        """
 
174
        def get_ancestors(weave, entry):
 
175
            return set(weave.get_ancestry(entry.revision))
157
176
        # revision:ie mapping for each ie found in previous_inventories.
158
177
        candidates = {}
 
178
        # revision:ie mapping with one revision for each head.
 
179
        heads = {}
 
180
        # revision: ancestor list for each head
 
181
        head_ancestors = {}
159
182
        # identify candidate head revision ids.
160
183
        for inv in previous_inventories:
161
184
            if self.file_id in inv:
162
185
                ie = inv[self.file_id]
 
186
                assert ie.file_id == self.file_id
163
187
                if ie.revision in candidates:
164
188
                    # same revision value in two different inventories:
165
189
                    # correct possible inconsistencies:
171
195
                            ie.executable = False
172
196
                    except AttributeError:
173
197
                        pass
 
198
                    # must now be the same.
 
199
                    assert candidates[ie.revision] == ie
174
200
                else:
175
201
                    # add this revision as a candidate.
176
202
                    candidates[ie.revision] = ie
177
 
        return candidates
178
 
 
179
 
    @deprecated_method(deprecated_in((1, 6, 0)))
 
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
 
241
 
180
242
    def get_tar_item(self, root, dp, now, tree):
181
243
        """Get a tarfile item and a file stream for its content."""
182
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
 
244
        item = tarfile.TarInfo(pathjoin(root, dp))
183
245
        # TODO: would be cool to actually set it to the timestamp of the
184
246
        # revision it was last changed
185
247
        item.mtime = now
212
274
        Traceback (most recent call last):
213
275
        InvalidEntryName: Invalid entry name: src/hello.c
214
276
        """
 
277
        assert isinstance(name, basestring), name
215
278
        if '/' in name or '\\' in name:
216
 
            raise errors.InvalidEntryName(name=name)
 
279
            raise InvalidEntryName(name=name)
217
280
        self.executable = False
218
281
        self.revision = None
219
282
        self.text_sha1 = None
223
286
        self.text_id = text_id
224
287
        self.parent_id = parent_id
225
288
        self.symlink_target = None
226
 
        self.reference_revision = None
227
289
 
228
290
    def kind_character(self):
229
291
        """Return a short kind indicator useful for appending to names."""
230
292
        raise BzrError('unknown kind %r' % self.kind)
231
293
 
232
 
    known_kinds = ('file', 'directory', 'symlink')
 
294
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
233
295
 
234
296
    def _put_in_tar(self, item, tree):
235
297
        """populate item for stashing in a tar, and return the content stream.
239
301
        raise BzrError("don't know how to export {%s} of kind %r" %
240
302
                       (self.file_id, self.kind))
241
303
 
242
 
    @deprecated_method(deprecated_in((1, 6, 0)))
243
304
    def put_on_disk(self, dest, dp, tree):
244
305
        """Create a representation of self on disk in the prefix dest.
245
306
        
246
307
        This is a template method - implement _put_on_disk in subclasses.
247
308
        """
248
 
        fullpath = osutils.pathjoin(dest, dp)
 
309
        fullpath = pathjoin(dest, dp)
249
310
        self._put_on_disk(fullpath, tree)
250
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
251
 
        #         self.kind, fullpath)
 
311
        mutter("  export {%s} kind %s to %s", self.file_id,
 
312
                self.kind, fullpath)
252
313
 
253
314
    def _put_on_disk(self, fullpath, tree):
254
315
        """Put this entry onto disk at fullpath, from tree tree."""
255
316
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
256
317
 
257
318
    def sorted_children(self):
258
 
        return sorted(self.children.items())
 
319
        l = self.children.items()
 
320
        l.sort()
 
321
        return l
259
322
 
260
323
    @staticmethod
261
324
    def versionable_kind(kind):
262
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
325
        return kind in ('file', 'directory', 'symlink')
263
326
 
264
327
    def check(self, checker, rev_id, inv, tree):
265
328
        """Check this inventory entry is intact.
275
338
        :param inv: Inventory from which the entry was loaded.
276
339
        :param tree: RevisionTree for this entry.
277
340
        """
278
 
        if self.parent_id is not None:
 
341
        if self.parent_id != None:
279
342
            if not inv.has_id(self.parent_id):
280
343
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
281
344
                        % (self.parent_id, rev_id))
290
353
        """Clone this inventory entry."""
291
354
        raise NotImplementedError
292
355
 
293
 
    @staticmethod
294
 
    def describe_change(old_entry, new_entry):
295
 
        """Describe the change between old_entry and this.
296
 
        
297
 
        This smells of being an InterInventoryEntry situation, but as its
298
 
        the first one, we're making it a static method for now.
299
 
 
300
 
        An entry with a different parent, or different name is considered 
301
 
        to be renamed. Reparenting is an internal detail.
302
 
        Note that renaming the parent does not trigger a rename for the
303
 
        child entry itself.
 
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".
304
362
        """
305
 
        # TODO: Perhaps return an object rather than just a string
306
 
        if old_entry is new_entry:
307
 
            # also the case of both being None
308
 
            return 'unchanged'
309
 
        elif old_entry is None:
 
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
        #
 
371
        if len(previous_entries) > 1:
 
372
            return 'merged'
 
373
        elif len(previous_entries) == 0:
310
374
            return 'added'
311
 
        elif new_entry is None:
312
 
            return 'removed'
313
 
        if old_entry.kind != new_entry.kind:
314
 
            return 'modified'
315
 
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
316
 
        if text_modified or meta_modified:
317
 
            modified = True
318
 
        else:
319
 
            modified = False
320
 
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
321
 
        if old_entry.parent_id != new_entry.parent_id:
322
 
            renamed = True
323
 
        elif old_entry.name != new_entry.name:
324
 
            renamed = True
325
 
        else:
326
 
            renamed = False
327
 
        if renamed and not modified:
328
 
            return InventoryEntry.RENAMED
329
 
        if modified and not renamed:
330
 
            return 'modified'
331
 
        if modified and renamed:
332
 
            return InventoryEntry.MODIFIED_AND_RENAMED
333
 
        return 'unchanged'
 
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'
334
382
 
335
383
    def __repr__(self):
336
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
384
        return ("%s(%r, %r, parent_id=%r)"
337
385
                % (self.__class__.__name__,
338
386
                   self.file_id,
339
387
                   self.name,
340
 
                   self.parent_id,
341
 
                   self.revision))
 
388
                   self.parent_id))
 
389
 
 
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.
 
393
        
 
394
        This means that all its fields are populated, that it has its
 
395
        text stored in the text store or weave.
 
396
        """
 
397
        mutter('new parents of %s are %r', path, previous_entries)
 
398
        self._read_tree_state(path, work_tree)
 
399
        if len(previous_entries) == 1:
 
400
            # cannot be unchanged unless there is only one parent file rev.
 
401
            parent_ie = previous_entries.values()[0]
 
402
            if self._unchanged(parent_ie):
 
403
                mutter("found unchanged entry")
 
404
                self.revision = parent_ie.revision
 
405
                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)
 
421
        self.revision = revision
 
422
        change = self._describe_snapshot_change(previous_entries)
 
423
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
424
                            transaction)
 
425
        return change
 
426
 
 
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
        """
 
432
        mutter('storing file {%s} in revision {%s}',
 
433
               self.file_id, self.revision)
 
434
        self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
342
435
 
343
436
    def __eq__(self, other):
344
437
        if not isinstance(other, InventoryEntry):
354
447
                and (self.kind == other.kind)
355
448
                and (self.revision == other.revision)
356
449
                and (self.executable == other.executable)
357
 
                and (self.reference_revision == other.reference_revision)
358
450
                )
359
451
 
360
452
    def __ne__(self, other):
366
458
    def _unchanged(self, previous_ie):
367
459
        """Has this entry changed relative to previous_ie.
368
460
 
369
 
        This method should be overridden in child classes.
 
461
        This method should be overriden in child classes.
370
462
        """
371
463
        compatible = True
372
464
        # different inv parent
375
467
        # renamed
376
468
        elif previous_ie.name != self.name:
377
469
            compatible = False
378
 
        elif previous_ie.kind != self.kind:
379
 
            compatible = False
380
470
        return compatible
381
471
 
382
472
    def _read_tree_state(self, path, work_tree):
396
486
 
397
487
class RootEntry(InventoryEntry):
398
488
 
399
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
400
 
                 'text_id', 'parent_id', 'children', 'executable',
401
 
                 'revision', 'symlink_target', 'reference_revision']
402
 
 
403
489
    def _check(self, checker, rev_id, tree):
404
490
        """See InventoryEntry._check"""
405
491
 
406
492
    def __init__(self, file_id):
407
493
        self.file_id = file_id
408
494
        self.children = {}
409
 
        self.kind = 'directory'
 
495
        self.kind = 'root_directory'
410
496
        self.parent_id = None
411
497
        self.name = u''
412
 
        self.revision = None
413
 
        symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
414
 
                               '  Please use InventoryDirectory instead.',
415
 
                               DeprecationWarning, stacklevel=2)
416
498
 
417
499
    def __eq__(self, other):
418
500
        if not isinstance(other, RootEntry):
425
507
class InventoryDirectory(InventoryEntry):
426
508
    """A directory in an inventory."""
427
509
 
428
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
429
 
                 'text_id', 'parent_id', 'children', 'executable',
430
 
                 'revision', 'symlink_target', 'reference_revision']
431
 
 
432
510
    def _check(self, checker, rev_id, tree):
433
511
        """See InventoryEntry._check"""
434
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
512
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
513
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
514
                                % (self.file_id, rev_id))
437
515
 
468
546
class InventoryFile(InventoryEntry):
469
547
    """A file in an inventory."""
470
548
 
471
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
472
 
                 'text_id', 'parent_id', 'children', 'executable',
473
 
                 'revision', 'symlink_target', 'reference_revision']
474
 
 
475
549
    def _check(self, checker, tree_revision_id, tree):
476
550
        """See InventoryEntry._check"""
477
 
        key = (self.file_id, self.revision)
478
 
        if key in checker.checked_texts:
479
 
            prev_sha = checker.checked_texts[key]
 
551
        t = (self.file_id, self.revision)
 
552
        if t in checker.checked_texts:
 
553
            prev_sha = checker.checked_texts[t]
480
554
            if prev_sha != self.text_sha1:
481
 
                raise BzrCheckError(
482
 
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
483
 
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
484
 
                     t))
 
555
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
556
                                    (self.file_id, tree_revision_id))
485
557
            else:
486
558
                checker.repeated_text_cnt += 1
487
559
                return
488
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
 
489
572
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
490
573
        checker.checked_text_cnt += 1
491
574
        # We can't check the length, because Weave doesn't store that
492
575
        # information, and the whole point of looking at the weave's
493
576
        # sha1sum is that we don't have to extract the text.
494
 
        if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
495
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
496
 
        checker.checked_texts[key] = self.text_sha1
 
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
497
581
 
498
582
    def copy(self):
499
583
        other = InventoryFile(self.file_id, self.name, self.parent_id)
506
590
 
507
591
    def detect_changes(self, old_entry):
508
592
        """See InventoryEntry.detect_changes."""
 
593
        assert self.text_sha1 != None
 
594
        assert old_entry.text_sha1 != None
509
595
        text_modified = (self.text_sha1 != old_entry.text_sha1)
510
596
        meta_modified = (self.executable != old_entry.executable)
511
597
        return text_modified, meta_modified
513
599
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
514
600
             output_to, reverse=False):
515
601
        """See InventoryEntry._diff."""
516
 
        from bzrlib.diff import DiffText
517
 
        from_file_id = self.file_id
518
 
        if to_entry:
519
 
            to_file_id = to_entry.file_id
520
 
        else:
521
 
            to_file_id = None
522
 
        if reverse:
523
 
            to_file_id, from_file_id = from_file_id, to_file_id
524
 
            tree, to_tree = to_tree, tree
525
 
            from_label, to_label = to_label, from_label
526
 
        differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
527
 
                          text_diff)
528
 
        return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
 
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
529
620
 
530
621
    def has_text(self):
531
622
        """See InventoryEntry.has_text."""
552
643
 
553
644
    def _put_on_disk(self, fullpath, tree):
554
645
        """See InventoryEntry._put_on_disk."""
555
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
646
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
556
647
        if tree.is_executable(self.file_id):
557
648
            os.chmod(fullpath, 0755)
558
649
 
559
650
    def _read_tree_state(self, path, work_tree):
560
651
        """See InventoryEntry._read_tree_state."""
561
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
562
 
        # FIXME: 20050930 probe for the text size when getting sha1
563
 
        # in _read_tree_state
564
 
        self.executable = work_tree.is_executable(self.file_id, path=path)
565
 
 
566
 
    def __repr__(self):
567
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
568
 
                % (self.__class__.__name__,
569
 
                   self.file_id,
570
 
                   self.name,
571
 
                   self.parent_id,
572
 
                   self.text_sha1,
573
 
                   self.text_size))
 
652
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
653
        self.executable = work_tree.is_executable(self.file_id)
574
654
 
575
655
    def _forget_tree_state(self):
576
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
 
577
678
 
578
679
    def _unchanged(self, previous_ie):
579
680
        """See InventoryEntry._unchanged."""
592
693
class InventoryLink(InventoryEntry):
593
694
    """A file in an inventory."""
594
695
 
595
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
596
 
                 'text_id', 'parent_id', 'children', 'executable',
597
 
                 'revision', 'symlink_target', 'reference_revision']
 
696
    __slots__ = ['symlink_target']
598
697
 
599
698
    def _check(self, checker, rev_id, tree):
600
699
        """See InventoryEntry._check"""
601
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
700
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
602
701
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
702
                    % (self.file_id, rev_id))
604
 
        if self.symlink_target is None:
 
703
        if self.symlink_target == None:
605
704
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
705
                    % (self.file_id, rev_id))
607
706
 
623
722
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
624
723
             output_to, reverse=False):
625
724
        """See InventoryEntry._diff."""
626
 
        from bzrlib.diff import DiffSymlink
627
 
        old_target = self.symlink_target
 
725
        from_text = self.symlink_target
628
726
        if to_entry is not None:
629
 
            new_target = to_entry.symlink_target
630
 
        else:
631
 
            new_target = None
632
 
        if not reverse:
633
 
            old_tree = tree
634
 
            new_tree = to_tree
635
 
        else:
636
 
            old_tree = to_tree
637
 
            new_tree = tree
638
 
            new_target, old_target = old_target, new_target
639
 
        differ = DiffSymlink(old_tree, new_tree, output_to)
640
 
        return differ.diff_symlink(old_target, new_target)
 
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
641
738
 
642
739
    def __init__(self, file_id, name, parent_id):
643
740
        super(InventoryLink, self).__init__(file_id, name, parent_id)
678
775
        return compatible
679
776
 
680
777
 
681
 
class TreeReference(InventoryEntry):
682
 
    
683
 
    kind = 'tree-reference'
684
 
    
685
 
    def __init__(self, file_id, name, parent_id, revision=None,
686
 
                 reference_revision=None):
687
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
688
 
        self.revision = revision
689
 
        self.reference_revision = reference_revision
690
 
 
691
 
    def copy(self):
692
 
        return TreeReference(self.file_id, self.name, self.parent_id,
693
 
                             self.revision, self.reference_revision)
694
 
 
695
 
    def _read_tree_state(self, path, work_tree):
696
 
        """Populate fields in the inventory entry from the given tree.
697
 
        """
698
 
        self.reference_revision = work_tree.get_reference_revision(
699
 
            self.file_id, path)
700
 
 
701
 
    def _forget_tree_state(self):
702
 
        self.reference_revision = None 
703
 
 
704
 
    def _unchanged(self, previous_ie):
705
 
        """See InventoryEntry._unchanged."""
706
 
        compatible = super(TreeReference, self)._unchanged(previous_ie)
707
 
        if self.reference_revision != previous_ie.reference_revision:
708
 
            compatible = False
709
 
        return compatible
710
 
 
711
 
 
712
778
class Inventory(object):
713
779
    """Inventory of versioned files in a tree.
714
780
 
728
794
 
729
795
    >>> inv = Inventory()
730
796
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
731
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
797
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
732
798
    >>> inv['123-123'].name
733
799
    'hello.c'
734
800
 
742
808
    May also look up by name:
743
809
 
744
810
    >>> [x[0] for x in inv.iter_entries()]
745
 
    ['', u'hello.c']
 
811
    ['hello.c']
746
812
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
747
813
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
748
 
    Traceback (most recent call last):
749
 
    BzrError: parent_id {TREE_ROOT} not in inventory
750
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
751
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
 
814
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
752
815
    """
753
816
    def __init__(self, root_id=ROOT_ID, revision_id=None):
754
817
        """Create or read an inventory.
760
823
        The inventory is created with a default root directory, with
761
824
        an id of None.
762
825
        """
763
 
        if root_id is not None:
764
 
            self._set_root(InventoryDirectory(root_id, u'', None))
765
 
        else:
766
 
            self.root = None
767
 
            self._byid = {}
 
826
        # We are letting Branch.create() create a unique inventory
 
827
        # root id. Rather than generating a random one here.
 
828
        #if root_id is None:
 
829
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
830
        self.root = RootEntry(root_id)
768
831
        self.revision_id = revision_id
769
 
 
770
 
    def __repr__(self):
771
 
        return "<Inventory object at %x, contents=%r>" % (id(self), self._byid)
772
 
 
773
 
    def apply_delta(self, delta):
774
 
        """Apply a delta to this inventory.
775
 
 
776
 
        :param delta: A list of changes to apply. After all the changes are
777
 
            applied the final inventory must be internally consistent, but it
778
 
            is ok to supply changes which, if only half-applied would have an
779
 
            invalid result - such as supplying two changes which rename two
780
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
781
 
            ('B', 'A', 'B-id', b_entry)].
782
 
 
783
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
784
 
            new_entry).
785
 
            
786
 
            When new_path is None, the change indicates the removal of an entry
787
 
            from the inventory and new_entry will be ignored (using None is
788
 
            appropriate). If new_path is not None, then new_entry must be an
789
 
            InventoryEntry instance, which will be incorporated into the
790
 
            inventory (and replace any existing entry with the same file id).
791
 
            
792
 
            When old_path is None, the change indicates the addition of
793
 
            a new entry to the inventory.
794
 
            
795
 
            When neither new_path nor old_path are None, the change is a
796
 
            modification to an entry, such as a rename, reparent, kind change
797
 
            etc. 
798
 
 
799
 
            The children attribute of new_entry is ignored. This is because
800
 
            this method preserves children automatically across alterations to
801
 
            the parent of the children, and cases where the parent id of a
802
 
            child is changing require the child to be passed in as a separate
803
 
            change regardless. E.g. in the recursive deletion of a directory -
804
 
            the directory's children must be included in the delta, or the
805
 
            final inventory will be invalid.
806
 
        """
807
 
        children = {}
808
 
        # Remove all affected items which were in the original inventory,
809
 
        # starting with the longest paths, thus ensuring parents are examined
810
 
        # after their children, which means that everything we examine has no
811
 
        # modified children remaining by the time we examine it.
812
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
813
 
                                        if op is not None), reverse=True):
814
 
            if file_id not in self:
815
 
                # adds come later
816
 
                continue
817
 
            # Preserve unaltered children of file_id for later reinsertion.
818
 
            file_id_children = getattr(self[file_id], 'children', {})
819
 
            if len(file_id_children):
820
 
                children[file_id] = file_id_children
821
 
            # Remove file_id and the unaltered children. If file_id is not
822
 
            # being deleted it will be reinserted back later.
823
 
            self.remove_recursive_id(file_id)
824
 
        # Insert all affected which should be in the new inventory, reattaching
825
 
        # their children if they had any. This is done from shortest path to
826
 
        # longest, ensuring that items which were modified and whose parents in
827
 
        # the resulting inventory were also modified, are inserted after their
828
 
        # parents.
829
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
830
 
                                          delta if np is not None):
831
 
            if new_entry.kind == 'directory':
832
 
                # Pop the child which to allow detection of children whose
833
 
                # parents were deleted and which were not reattached to a new
834
 
                # parent.
835
 
                new_entry.children = children.pop(new_entry.file_id, {})
836
 
            self.add(new_entry)
837
 
        if len(children):
838
 
            # Get the parent id that was deleted
839
 
            parent_id, children = children.popitem()
840
 
            raise errors.InconsistentDelta("<deleted>", parent_id,
841
 
                "The file id was deleted but its children were not deleted.")
842
 
 
843
 
    def _set_root(self, ie):
844
 
        self.root = ie
845
832
        self._byid = {self.root.file_id: self.root}
846
833
 
 
834
 
847
835
    def copy(self):
848
836
        # TODO: jam 20051218 Should copy also copy the revision_id?
849
 
        entries = self.iter_entries()
850
 
        if self.root is None:
851
 
            return Inventory(root_id=None)
852
 
        other = Inventory(entries.next()[1].file_id)
853
 
        other.root.revision = self.root.revision
 
837
        other = Inventory(self.root.file_id)
854
838
        # copy recursively so we know directories will be added before
855
839
        # their children.  There are more efficient ways than this...
856
 
        for path, entry in entries:
 
840
        for path, entry in self.iter_entries():
 
841
            if entry == self.root:
 
842
                continue
857
843
            other.add(entry.copy())
858
844
        return other
859
845
 
 
846
 
860
847
    def __iter__(self):
861
848
        return iter(self._byid)
862
849
 
 
850
 
863
851
    def __len__(self):
864
852
        """Returns number of entries."""
865
853
        return len(self._byid)
866
854
 
 
855
 
867
856
    def iter_entries(self, from_dir=None):
868
857
        """Return (path, entry) pairs, in order by name."""
869
 
        if from_dir is None:
870
 
            if self.root is None:
871
 
                return
872
 
            from_dir = self.root
873
 
            yield '', self.root
874
 
        elif isinstance(from_dir, basestring):
875
 
            from_dir = self._byid[from_dir]
876
 
            
877
 
        # unrolling the recursive called changed the time from
878
 
        # 440ms/663ms (inline/total) to 116ms/116ms
879
 
        children = from_dir.children.items()
880
 
        children.sort()
881
 
        children = collections.deque(children)
882
 
        stack = [(u'', children)]
883
 
        while stack:
884
 
            from_dir_relpath, children = stack[-1]
885
 
 
886
 
            while children:
887
 
                name, ie = children.popleft()
888
 
 
889
 
                # we know that from_dir_relpath never ends in a slash
890
 
                # and 'f' doesn't begin with one, we can do a string op, rather
891
 
                # than the checks of pathjoin(), though this means that all paths
892
 
                # start with a slash
893
 
                path = from_dir_relpath + '/' + name
894
 
 
895
 
                yield path[1:], ie
896
 
 
897
 
                if ie.kind != 'directory':
898
 
                    continue
899
 
 
900
 
                # But do this child first
901
 
                new_children = ie.children.items()
902
 
                new_children.sort()
903
 
                new_children = collections.deque(new_children)
904
 
                stack.append((path, new_children))
905
 
                # Break out of inner loop, so that we start outer loop with child
906
 
                break
907
 
            else:
908
 
                # if we finished all children, pop it off the stack
909
 
                stack.pop()
910
 
 
911
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
912
 
        yield_parents=False):
913
 
        """Iterate over the entries in a directory first order.
914
 
 
915
 
        This returns all entries for a directory before returning
916
 
        the entries for children of a directory. This is not
917
 
        lexicographically sorted order, and is a hybrid between
918
 
        depth-first and breadth-first.
919
 
 
920
 
        :param yield_parents: If True, yield the parents from the root leading
921
 
            down to specific_file_ids that have been requested. This has no
922
 
            impact if specific_file_ids is None.
923
 
        :return: This yields (path, entry) pairs
924
 
        """
925
 
        if specific_file_ids and not isinstance(specific_file_ids, set):
926
 
            specific_file_ids = set(specific_file_ids)
927
 
        # TODO? Perhaps this should return the from_dir so that the root is
928
 
        # yielded? or maybe an option?
929
 
        if from_dir is None:
930
 
            if self.root is None:
931
 
                return
932
 
            # Optimize a common case
933
 
            if (not yield_parents and specific_file_ids is not None and
934
 
                len(specific_file_ids) == 1):
935
 
                file_id = list(specific_file_ids)[0]
936
 
                if file_id in self:
937
 
                    yield self.id2path(file_id), self[file_id]
938
 
                return 
939
 
            from_dir = self.root
940
 
            if (specific_file_ids is None or yield_parents or
941
 
                self.root.file_id in specific_file_ids):
942
 
                yield u'', self.root
943
 
        elif isinstance(from_dir, basestring):
944
 
            from_dir = self._byid[from_dir]
945
 
 
946
 
        if specific_file_ids is not None:
947
 
            # TODO: jam 20070302 This could really be done as a loop rather
948
 
            #       than a bunch of recursive calls.
949
 
            parents = set()
950
 
            byid = self._byid
951
 
            def add_ancestors(file_id):
952
 
                if file_id not in byid:
953
 
                    return
954
 
                parent_id = byid[file_id].parent_id
955
 
                if parent_id is None:
956
 
                    return
957
 
                if parent_id not in parents:
958
 
                    parents.add(parent_id)
959
 
                    add_ancestors(parent_id)
960
 
            for file_id in specific_file_ids:
961
 
                add_ancestors(file_id)
962
 
        else:
963
 
            parents = None
964
 
            
965
 
        stack = [(u'', from_dir)]
966
 
        while stack:
967
 
            cur_relpath, cur_dir = stack.pop()
968
 
 
969
 
            child_dirs = []
970
 
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
971
 
 
972
 
                child_relpath = cur_relpath + child_name
973
 
 
974
 
                if (specific_file_ids is None or 
975
 
                    child_ie.file_id in specific_file_ids or
976
 
                    (yield_parents and child_ie.file_id in parents)):
977
 
                    yield child_relpath, child_ie
978
 
 
979
 
                if child_ie.kind == 'directory':
980
 
                    if parents is None or child_ie.file_id in parents:
981
 
                        child_dirs.append((child_relpath+'/', child_ie))
982
 
            stack.extend(reversed(child_dirs))
983
 
 
984
 
    def make_entry(self, kind, name, parent_id, file_id=None):
985
 
        """Simple thunk to bzrlib.inventory.make_entry."""
986
 
        return make_entry(kind, name, parent_id, file_id)
 
858
        if from_dir == None:
 
859
            assert self.root
 
860
            from_dir = self.root
 
861
        elif isinstance(from_dir, basestring):
 
862
            from_dir = self._byid[from_dir]
 
863
            
 
864
        kids = from_dir.children.items()
 
865
        kids.sort()
 
866
        for name, ie in kids:
 
867
            yield name, ie
 
868
            if ie.kind == 'directory':
 
869
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
870
                    yield pathjoin(name, cn), cie
 
871
 
987
872
 
988
873
    def entries(self):
989
874
        """Return list of (path, ie) for all entries except the root.
995
880
            kids = dir_ie.children.items()
996
881
            kids.sort()
997
882
            for name, ie in kids:
998
 
                child_path = osutils.pathjoin(dir_path, name)
 
883
                child_path = pathjoin(dir_path, name)
999
884
                accum.append((child_path, ie))
1000
885
                if ie.kind == 'directory':
1001
886
                    descend(ie, child_path)
1003
888
        descend(self.root, u'')
1004
889
        return accum
1005
890
 
 
891
 
1006
892
    def directories(self):
1007
893
        """Return (path, entry) pairs for all directories, including the root.
1008
894
        """
1014
900
            kids.sort()
1015
901
 
1016
902
            for name, child_ie in kids:
1017
 
                child_path = osutils.pathjoin(parent_path, name)
 
903
                child_path = pathjoin(parent_path, name)
1018
904
                descend(child_ie, child_path)
1019
905
        descend(self.root, u'')
1020
906
        return accum
1021
907
        
 
908
 
 
909
 
1022
910
    def __contains__(self, file_id):
1023
911
        """True if this entry contains a file with given id.
1024
912
 
1025
913
        >>> inv = Inventory()
1026
914
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1027
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
915
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1028
916
        >>> '123' in inv
1029
917
        True
1030
918
        >>> '456' in inv
1031
919
        False
1032
920
        """
1033
 
        return (file_id in self._byid)
 
921
        return file_id in self._byid
 
922
 
1034
923
 
1035
924
    def __getitem__(self, file_id):
1036
925
        """Return the entry for given file_id.
1037
926
 
1038
927
        >>> inv = Inventory()
1039
928
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1040
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
929
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1041
930
        >>> inv['123123'].name
1042
931
        'hello.c'
1043
932
        """
1044
933
        try:
1045
934
            return self._byid[file_id]
1046
935
        except KeyError:
1047
 
            # really we're passing an inventory, not a tree...
1048
 
            raise errors.NoSuchId(self, file_id)
 
936
            if file_id == None:
 
937
                raise BzrError("can't look up file_id None")
 
938
            else:
 
939
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
940
 
1049
941
 
1050
942
    def get_file_kind(self, file_id):
1051
943
        return self._byid[file_id].kind
1053
945
    def get_child(self, parent_id, filename):
1054
946
        return self[parent_id].children.get(filename)
1055
947
 
1056
 
    def _add_child(self, entry):
1057
 
        """Add an entry to the inventory, without adding it to its parent"""
1058
 
        if entry.file_id in self._byid:
1059
 
            raise BzrError("inventory already contains entry with id {%s}" %
1060
 
                           entry.file_id)
1061
 
        self._byid[entry.file_id] = entry
1062
 
        for child in getattr(entry, 'children', {}).itervalues():
1063
 
            self._add_child(child)
1064
 
        return entry
1065
948
 
1066
949
    def add(self, entry):
1067
950
        """Add entry to inventory.
1072
955
        Returns the new entry object.
1073
956
        """
1074
957
        if entry.file_id in self._byid:
1075
 
            raise errors.DuplicateFileId(entry.file_id,
1076
 
                                         self._byid[entry.file_id])
1077
 
 
1078
 
        if entry.parent_id is None:
1079
 
            self.root = entry
1080
 
        else:
1081
 
            try:
1082
 
                parent = self._byid[entry.parent_id]
1083
 
            except KeyError:
1084
 
                raise BzrError("parent_id {%s} not in inventory" %
1085
 
                               entry.parent_id)
1086
 
 
1087
 
            if entry.name in parent.children:
1088
 
                raise BzrError("%s is already versioned" %
1089
 
                        osutils.pathjoin(self.id2path(parent.file_id),
1090
 
                        entry.name).encode('utf-8'))
1091
 
            parent.children[entry.name] = entry
1092
 
        return self._add_child(entry)
1093
 
 
1094
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
958
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
959
 
 
960
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
961
            entry.parent_id = self.root.file_id
 
962
 
 
963
        try:
 
964
            parent = self._byid[entry.parent_id]
 
965
        except KeyError:
 
966
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
967
 
 
968
        if parent.children.has_key(entry.name):
 
969
            raise BzrError("%s is already versioned" %
 
970
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
971
 
 
972
        self._byid[entry.file_id] = entry
 
973
        parent.children[entry.name] = entry
 
974
        return entry
 
975
 
 
976
 
 
977
    def add_path(self, relpath, kind, file_id=None):
1095
978
        """Add entry from a path.
1096
979
 
1097
980
        The immediate parent must already be versioned.
1098
981
 
1099
982
        Returns the new entry object."""
 
983
        from bzrlib.workingtree import gen_file_id
1100
984
        
1101
 
        parts = osutils.splitpath(relpath)
 
985
        parts = bzrlib.osutils.splitpath(relpath)
 
986
 
 
987
        if file_id == None:
 
988
            file_id = gen_file_id(relpath)
1102
989
 
1103
990
        if len(parts) == 0:
1104
 
            if file_id is None:
1105
 
                file_id = generate_ids.gen_root_id()
1106
 
            self.root = InventoryDirectory(file_id, '', None)
 
991
            self.root = RootEntry(file_id)
1107
992
            self._byid = {self.root.file_id: self.root}
1108
 
            return self.root
 
993
            return
1109
994
        else:
1110
995
            parent_path = parts[:-1]
1111
996
            parent_id = self.path2id(parent_path)
1112
 
            if parent_id is None:
1113
 
                raise errors.NotVersionedError(path=parent_path)
1114
 
        ie = make_entry(kind, parts[-1], parent_id, file_id)
 
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)
1115
1007
        return self.add(ie)
1116
1008
 
 
1009
 
1117
1010
    def __delitem__(self, file_id):
1118
1011
        """Remove entry by id.
1119
1012
 
1120
1013
        >>> inv = Inventory()
1121
1014
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1122
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
1015
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1123
1016
        >>> '123' in inv
1124
1017
        True
1125
1018
        >>> del inv['123']
1127
1020
        False
1128
1021
        """
1129
1022
        ie = self[file_id]
 
1023
 
 
1024
        assert ie.parent_id is None or \
 
1025
            self[ie.parent_id].children[ie.name] == ie
 
1026
        
1130
1027
        del self._byid[file_id]
1131
1028
        if ie.parent_id is not None:
1132
1029
            del self[ie.parent_id].children[ie.name]
1133
1030
 
 
1031
 
1134
1032
    def __eq__(self, other):
1135
1033
        """Compare two sets by comparing their contents.
1136
1034
 
1139
1037
        >>> i1 == i2
1140
1038
        True
1141
1039
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1142
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1040
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1143
1041
        >>> i1 == i2
1144
1042
        False
1145
1043
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1146
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1044
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1147
1045
        >>> i1 == i2
1148
1046
        True
1149
1047
        """
1150
1048
        if not isinstance(other, Inventory):
1151
1049
            return NotImplemented
1152
1050
 
 
1051
        if len(self._byid) != len(other._byid):
 
1052
            # shortcut: obviously not the same
 
1053
            return False
 
1054
 
1153
1055
        return self._byid == other._byid
1154
1056
 
 
1057
 
1155
1058
    def __ne__(self, other):
1156
1059
        return not self.__eq__(other)
1157
1060
 
 
1061
 
1158
1062
    def __hash__(self):
1159
1063
        raise ValueError('not hashable')
1160
1064
 
1161
1065
    def _iter_file_id_parents(self, file_id):
1162
1066
        """Yield the parents of file_id up to the root."""
1163
 
        while file_id is not None:
 
1067
        while file_id != None:
1164
1068
            try:
1165
1069
                ie = self._byid[file_id]
1166
1070
            except KeyError:
1167
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
 
1071
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1168
1072
            yield ie
1169
1073
            file_id = ie.parent_id
1170
1074
 
1204
1108
        This returns the entry of the last component in the path,
1205
1109
        which may be either a file or a directory.
1206
1110
 
1207
 
        Returns None IFF the path is not found.
 
1111
        Returns None iff the path is not found.
1208
1112
        """
1209
 
        if isinstance(name, basestring):
1210
 
            name = osutils.splitpath(name)
 
1113
        if isinstance(name, types.StringTypes):
 
1114
            name = splitpath(name)
1211
1115
 
1212
 
        # mutter("lookup path %r" % name)
 
1116
        mutter("lookup path %r" % name)
1213
1117
 
1214
1118
        parent = self.root
1215
 
        if parent is None:
1216
 
            return None
1217
1119
        for f in name:
1218
1120
            try:
1219
 
                children = getattr(parent, 'children', None)
1220
 
                if children is None:
1221
 
                    return None
1222
 
                cie = children[f]
 
1121
                cie = parent.children[f]
 
1122
                assert cie.name == f
 
1123
                assert cie.parent_id == parent.file_id
1223
1124
                parent = cie
1224
1125
            except KeyError:
1225
1126
                # or raise an error?
1227
1128
 
1228
1129
        return parent.file_id
1229
1130
 
 
1131
 
1230
1132
    def has_filename(self, names):
1231
1133
        return bool(self.path2id(names))
1232
1134
 
 
1135
 
1233
1136
    def has_id(self, file_id):
1234
 
        return (file_id in self._byid)
 
1137
        return self._byid.has_key(file_id)
1235
1138
 
1236
 
    def remove_recursive_id(self, file_id):
1237
 
        """Remove file_id, and children, from the inventory.
1238
 
        
1239
 
        :param file_id: A file_id to remove.
1240
 
        """
1241
 
        to_find_delete = [self._byid[file_id]]
1242
 
        to_delete = []
1243
 
        while to_find_delete:
1244
 
            ie = to_find_delete.pop()
1245
 
            to_delete.append(ie.file_id)
1246
 
            if ie.kind == 'directory':
1247
 
                to_find_delete.extend(ie.children.values())
1248
 
        for file_id in reversed(to_delete):
1249
 
            ie = self[file_id]
1250
 
            del self._byid[file_id]
1251
 
        if ie.parent_id is not None:
1252
 
            del self[ie.parent_id].children[ie.name]
1253
 
        else:
1254
 
            self.root = None
1255
1139
 
1256
1140
    def rename(self, file_id, new_parent_id, new_name):
1257
1141
        """Move a file within the inventory.
1258
1142
 
1259
1143
        This can change either the name, or the parent, or both.
1260
1144
 
1261
 
        This does not move the working file.
1262
 
        """
1263
 
        new_name = ensure_normalized_name(new_name)
 
1145
        This does not move the working file."""
1264
1146
        if not is_valid_name(new_name):
1265
1147
            raise BzrError("not an acceptable filename: %r" % new_name)
1266
1148
 
1284
1166
        file_ie.name = new_name
1285
1167
        file_ie.parent_id = new_parent_id
1286
1168
 
1287
 
    def is_root(self, file_id):
1288
 
        return self.root is not None and file_id == self.root.file_id
1289
 
 
1290
 
 
1291
 
entry_factory = {
1292
 
    'directory': InventoryDirectory,
1293
 
    'file': InventoryFile,
1294
 
    'symlink': InventoryLink,
1295
 
    'tree-reference': TreeReference
1296
 
}
1297
 
 
1298
 
def make_entry(kind, name, parent_id, file_id=None):
1299
 
    """Create an inventory entry.
1300
 
 
1301
 
    :param kind: the type of inventory entry to create.
1302
 
    :param name: the basename of the entry.
1303
 
    :param parent_id: the parent_id of the entry.
1304
 
    :param file_id: the file_id to use. if None, one will be created.
1305
 
    """
1306
 
    if file_id is None:
1307
 
        file_id = generate_ids.gen_file_id(name)
1308
 
    name = ensure_normalized_name(name)
1309
 
    try:
1310
 
        factory = entry_factory[kind]
1311
 
    except KeyError:
1312
 
        raise BzrError("unknown kind %r" % kind)
1313
 
    return factory(file_id, name, parent_id)
1314
 
 
1315
 
 
1316
 
def ensure_normalized_name(name):
1317
 
    """Normalize name.
1318
 
 
1319
 
    :raises InvalidNormalization: When name is not normalized, and cannot be
1320
 
        accessed on this platform by the normalized path.
1321
 
    :return: The NFC normalised version of name.
1322
 
    """
1323
 
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
1324
 
    # keep them synchronised.
1325
 
    # we dont import normalized_filename directly because we want to be
1326
 
    # able to change the implementation at runtime for tests.
1327
 
    norm_name, can_access = osutils.normalized_filename(name)
1328
 
    if norm_name != name:
1329
 
        if can_access:
1330
 
            return norm_name
1331
 
        else:
1332
 
            # TODO: jam 20060701 This would probably be more useful
1333
 
            #       if the error was raised with the full path
1334
 
            raise errors.InvalidNormalization(name)
1335
 
    return name
 
1169
 
1336
1170
 
1337
1171
 
1338
1172
_NAME_RE = None
1339
1173
 
1340
1174
def is_valid_name(name):
1341
1175
    global _NAME_RE
1342
 
    if _NAME_RE is None:
 
1176
    if _NAME_RE == None:
1343
1177
        _NAME_RE = re.compile(r'^[^/\\]+$')
1344
1178
        
1345
1179
    return bool(_NAME_RE.match(name))