~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2005-11-23 15:44:24 UTC
  • mto: (1185.50.19 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1512.
  • Revision ID: john@arbash-meinel.com-20051123154424-a02f8bf990a1fed5
Renamed all of the tests from selftest/foo.py to tests/test_foo.py

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
                            appendpath, sha_strings)
54
40
from bzrlib.trace import mutter
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError)
55
43
 
56
44
 
57
45
class InventoryEntry(object):
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: os.path.join('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
 
    ...     print path
 
105
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
 
106
    ...     assert i.path2id(path)
115
107
    ... 
116
 
    <BLANKLINE>
117
108
    src
118
109
    src/bye.c
119
110
    src/hello.c
120
111
    src/wibble
121
112
    src/wibble/wibble.c
122
 
    >>> i.id2path('2326')
 
113
    >>> i.id2path('2326').replace('\\\\', '/')
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
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
 
123
                             transaction)
135
124
 
136
125
    def detect_changes(self, old_entry):
137
126
        """Return a (text_modified, meta_modified) from this to old_entry.
141
130
        """
142
131
        return False, False
143
132
 
 
133
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
134
             output_to, reverse=False):
 
135
        """Perform a diff from this to to_entry.
 
136
 
 
137
        text_diff will be used for textual difference calculation.
 
138
        This is a template method, override _diff in child classes.
 
139
        """
 
140
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
141
        if to_entry:
 
142
            # cannot diff from one kind to another - you must do a removal
 
143
            # and an addif they do not match.
 
144
            assert self.kind == to_entry.kind
 
145
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
146
                                      to_tree)
 
147
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
148
                   output_to, reverse)
 
149
 
144
150
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
151
             output_to, reverse=False):
146
152
        """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.
 
153
 
 
154
    def find_previous_heads(self, previous_inventories, entry_weave):
 
155
        """Return the revisions and entries that directly preceed this.
 
156
 
 
157
        Returned as a map from revision to inventory entry.
 
158
 
 
159
        This is a map containing the file revisions in all parents
 
160
        for which the file exists, and its revision is not a parent of
 
161
        any other. If the file is new, the set will be empty.
156
162
        """
157
 
        # revision:ie mapping for each ie found in previous_inventories.
158
 
        candidates = {}
159
 
        # identify candidate head revision ids.
 
163
        def get_ancestors(weave, entry):
 
164
            return set(map(weave.idx_to_name,
 
165
                           weave.inclusions([weave.lookup(entry.revision)])))
 
166
        heads = {}
 
167
        head_ancestors = {}
160
168
        for inv in previous_inventories:
161
169
            if self.file_id in inv:
162
170
                ie = inv[self.file_id]
163
 
                if ie.revision in candidates:
164
 
                    # same revision value in two different inventories:
165
 
                    # correct possible inconsistencies:
166
 
                    #     * there was a bug in revision updates with 'x' bit 
167
 
                    #       support.
 
171
                assert ie.file_id == self.file_id
 
172
                if ie.revision in heads:
 
173
                    # fixup logic, there was a bug in revision updates.
 
174
                    # with x bit support.
168
175
                    try:
169
 
                        if candidates[ie.revision].executable != ie.executable:
170
 
                            candidates[ie.revision].executable = False
 
176
                        if heads[ie.revision].executable != ie.executable:
 
177
                            heads[ie.revision].executable = False
171
178
                            ie.executable = False
172
179
                    except AttributeError:
173
180
                        pass
 
181
                    assert heads[ie.revision] == ie
174
182
                else:
175
 
                    # add this revision as a candidate.
176
 
                    candidates[ie.revision] = ie
177
 
        return candidates
 
183
                    # may want to add it.
 
184
                    # may already be covered:
 
185
                    already_present = 0 != len(
 
186
                        [head for head in heads 
 
187
                         if ie.revision in head_ancestors[head]])
 
188
                    if already_present:
 
189
                        # an ancestor of a known head.
 
190
                        continue
 
191
                    # definately a head:
 
192
                    ancestors = get_ancestors(entry_weave, ie)
 
193
                    # may knock something else out:
 
194
                    check_heads = list(heads.keys())
 
195
                    for head in check_heads:
 
196
                        if head in ancestors:
 
197
                            # this head is not really a head
 
198
                            heads.pop(head)
 
199
                    head_ancestors[ie.revision] = ancestors
 
200
                    heads[ie.revision] = ie
 
201
        return heads
178
202
 
179
 
    @deprecated_method(deprecated_in((1, 6, 0)))
180
203
    def get_tar_item(self, root, dp, now, tree):
181
204
        """Get a tarfile item and a file stream for its content."""
182
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
 
205
        item = tarfile.TarInfo(os.path.join(root, dp))
183
206
        # TODO: would be cool to actually set it to the timestamp of the
184
207
        # revision it was last changed
185
208
        item.mtime = now
212
235
        Traceback (most recent call last):
213
236
        InvalidEntryName: Invalid entry name: src/hello.c
214
237
        """
 
238
        assert isinstance(name, basestring), name
215
239
        if '/' in name or '\\' in name:
216
 
            raise errors.InvalidEntryName(name=name)
 
240
            raise InvalidEntryName(name=name)
217
241
        self.executable = False
218
242
        self.revision = None
219
243
        self.text_sha1 = None
223
247
        self.text_id = text_id
224
248
        self.parent_id = parent_id
225
249
        self.symlink_target = None
226
 
        self.reference_revision = None
227
250
 
228
251
    def kind_character(self):
229
252
        """Return a short kind indicator useful for appending to names."""
230
253
        raise BzrError('unknown kind %r' % self.kind)
231
254
 
232
 
    known_kinds = ('file', 'directory', 'symlink')
 
255
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
233
256
 
234
257
    def _put_in_tar(self, item, tree):
235
258
        """populate item for stashing in a tar, and return the content stream.
239
262
        raise BzrError("don't know how to export {%s} of kind %r" %
240
263
                       (self.file_id, self.kind))
241
264
 
242
 
    @deprecated_method(deprecated_in((1, 6, 0)))
243
265
    def put_on_disk(self, dest, dp, tree):
244
266
        """Create a representation of self on disk in the prefix dest.
245
267
        
246
268
        This is a template method - implement _put_on_disk in subclasses.
247
269
        """
248
 
        fullpath = osutils.pathjoin(dest, dp)
 
270
        fullpath = appendpath(dest, dp)
249
271
        self._put_on_disk(fullpath, tree)
250
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
251
 
        #         self.kind, fullpath)
 
272
        mutter("  export {%s} kind %s to %s", self.file_id,
 
273
                self.kind, fullpath)
252
274
 
253
275
    def _put_on_disk(self, fullpath, tree):
254
276
        """Put this entry onto disk at fullpath, from tree tree."""
255
277
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
256
278
 
257
279
    def sorted_children(self):
258
 
        return sorted(self.children.items())
 
280
        l = self.children.items()
 
281
        l.sort()
 
282
        return l
259
283
 
260
284
    @staticmethod
261
285
    def versionable_kind(kind):
262
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
286
        return kind in ('file', 'directory', 'symlink')
263
287
 
264
288
    def check(self, checker, rev_id, inv, tree):
265
289
        """Check this inventory entry is intact.
266
290
 
267
291
        This is a template method, override _check for kind specific
268
292
        tests.
269
 
 
270
 
        :param checker: Check object providing context for the checks; 
271
 
             can be used to find out what parts of the repository have already
272
 
             been checked.
273
 
        :param rev_id: Revision id from which this InventoryEntry was loaded.
274
 
             Not necessarily the last-changed revision for this file.
275
 
        :param inv: Inventory from which the entry was loaded.
276
 
        :param tree: RevisionTree for this entry.
277
293
        """
278
 
        if self.parent_id is not None:
 
294
        if self.parent_id != None:
279
295
            if not inv.has_id(self.parent_id):
280
296
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
281
297
                        % (self.parent_id, rev_id))
286
302
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
287
303
                            (self.kind, rev_id))
288
304
 
 
305
 
289
306
    def copy(self):
290
307
        """Clone this inventory entry."""
291
308
        raise NotImplementedError
292
309
 
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.
304
 
        """
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:
 
310
    def _get_snapshot_change(self, previous_entries):
 
311
        if len(previous_entries) > 1:
 
312
            return 'merged'
 
313
        elif len(previous_entries) == 0:
310
314
            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'
 
315
        else:
 
316
            return 'modified/renamed/reparented'
334
317
 
335
318
    def __repr__(self):
336
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
319
        return ("%s(%r, %r, parent_id=%r)"
337
320
                % (self.__class__.__name__,
338
321
                   self.file_id,
339
322
                   self.name,
340
 
                   self.parent_id,
341
 
                   self.revision))
 
323
                   self.parent_id))
 
324
 
 
325
    def snapshot(self, revision, path, previous_entries,
 
326
                 work_tree, weave_store, transaction):
 
327
        """Make a snapshot of this entry which may or may not have changed.
 
328
        
 
329
        This means that all its fields are populated, that it has its
 
330
        text stored in the text store or weave.
 
331
        """
 
332
        mutter('new parents of %s are %r', path, previous_entries)
 
333
        self._read_tree_state(path, work_tree)
 
334
        if len(previous_entries) == 1:
 
335
            # cannot be unchanged unless there is only one parent file rev.
 
336
            parent_ie = previous_entries.values()[0]
 
337
            if self._unchanged(parent_ie):
 
338
                mutter("found unchanged entry")
 
339
                self.revision = parent_ie.revision
 
340
                return "unchanged"
 
341
        return self.snapshot_revision(revision, previous_entries, 
 
342
                                      work_tree, weave_store, transaction)
 
343
 
 
344
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
345
                          weave_store, transaction):
 
346
        """Record this revision unconditionally."""
 
347
        mutter('new revision for {%s}', self.file_id)
 
348
        self.revision = revision
 
349
        change = self._get_snapshot_change(previous_entries)
 
350
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
351
                            transaction)
 
352
        return change
 
353
 
 
354
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
355
        """Record the 'text' of this entry, whatever form that takes.
 
356
        
 
357
        This default implementation simply adds an empty text.
 
358
        """
 
359
        mutter('storing file {%s} in revision {%s}',
 
360
               self.file_id, self.revision)
 
361
        self._add_text_to_weave([], file_parents, weave_store, transaction)
342
362
 
343
363
    def __eq__(self, other):
344
364
        if not isinstance(other, InventoryEntry):
354
374
                and (self.kind == other.kind)
355
375
                and (self.revision == other.revision)
356
376
                and (self.executable == other.executable)
357
 
                and (self.reference_revision == other.reference_revision)
358
377
                )
359
378
 
360
379
    def __ne__(self, other):
366
385
    def _unchanged(self, previous_ie):
367
386
        """Has this entry changed relative to previous_ie.
368
387
 
369
 
        This method should be overridden in child classes.
 
388
        This method should be overriden in child classes.
370
389
        """
371
390
        compatible = True
372
391
        # different inv parent
375
394
        # renamed
376
395
        elif previous_ie.name != self.name:
377
396
            compatible = False
378
 
        elif previous_ie.kind != self.kind:
379
 
            compatible = False
380
397
        return compatible
381
398
 
382
399
    def _read_tree_state(self, path, work_tree):
390
407
        # first requested, or preload them if they're already known
391
408
        pass            # nothing to do by default
392
409
 
393
 
    def _forget_tree_state(self):
394
 
        pass
395
 
 
396
410
 
397
411
class RootEntry(InventoryEntry):
398
412
 
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
413
    def _check(self, checker, rev_id, tree):
404
414
        """See InventoryEntry._check"""
405
415
 
406
416
    def __init__(self, file_id):
407
417
        self.file_id = file_id
408
418
        self.children = {}
409
 
        self.kind = 'directory'
 
419
        self.kind = 'root_directory'
410
420
        self.parent_id = None
411
 
        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)
 
421
        self.name = ''
416
422
 
417
423
    def __eq__(self, other):
418
424
        if not isinstance(other, RootEntry):
425
431
class InventoryDirectory(InventoryEntry):
426
432
    """A directory in an inventory."""
427
433
 
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
434
    def _check(self, checker, rev_id, tree):
433
435
        """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:
 
436
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
437
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
438
                                % (self.file_id, rev_id))
437
439
 
468
470
class InventoryFile(InventoryEntry):
469
471
    """A file in an inventory."""
470
472
 
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
 
    def _check(self, checker, tree_revision_id, tree):
 
473
    def _check(self, checker, rev_id, tree):
476
474
        """See InventoryEntry._check"""
477
 
        key = (self.file_id, self.revision)
478
 
        if key in checker.checked_texts:
479
 
            prev_sha = checker.checked_texts[key]
 
475
        revision = self.revision
 
476
        t = (self.file_id, revision)
 
477
        if t in checker.checked_texts:
 
478
            prev_sha = checker.checked_texts[t] 
480
479
            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))
 
480
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
481
                                    (self.file_id, rev_id))
485
482
            else:
486
483
                checker.repeated_text_cnt += 1
487
484
                return
488
 
 
489
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
490
 
        checker.checked_text_cnt += 1
491
 
        # We can't check the length, because Weave doesn't store that
492
 
        # information, and the whole point of looking at the weave's
493
 
        # 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
 
485
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
486
        file_lines = tree.get_file_lines(self.file_id)
 
487
        checker.checked_text_cnt += 1 
 
488
        if self.text_size != sum(map(len, file_lines)):
 
489
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
490
        if self.text_sha1 != sha_strings(file_lines):
 
491
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
492
        checker.checked_texts[t] = self.text_sha1
497
493
 
498
494
    def copy(self):
499
495
        other = InventoryFile(self.file_id, self.name, self.parent_id)
506
502
 
507
503
    def detect_changes(self, old_entry):
508
504
        """See InventoryEntry.detect_changes."""
 
505
        assert self.text_sha1 != None
 
506
        assert old_entry.text_sha1 != None
509
507
        text_modified = (self.text_sha1 != old_entry.text_sha1)
510
508
        meta_modified = (self.executable != old_entry.executable)
511
509
        return text_modified, meta_modified
513
511
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
514
512
             output_to, reverse=False):
515
513
        """See InventoryEntry._diff."""
516
 
        from bzrlib.diff import DiffText
517
 
        from_file_id = self.file_id
 
514
        from_text = tree.get_file(self.file_id).readlines()
518
515
        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)
 
516
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
517
        else:
 
518
            to_text = []
 
519
        if not reverse:
 
520
            text_diff(from_label, from_text,
 
521
                      to_label, to_text, output_to)
 
522
        else:
 
523
            text_diff(to_label, to_text,
 
524
                      from_label, from_text, output_to)
529
525
 
530
526
    def has_text(self):
531
527
        """See InventoryEntry.has_text."""
552
548
 
553
549
    def _put_on_disk(self, fullpath, tree):
554
550
        """See InventoryEntry._put_on_disk."""
555
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
551
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
556
552
        if tree.is_executable(self.file_id):
557
553
            os.chmod(fullpath, 0755)
558
554
 
559
555
    def _read_tree_state(self, path, work_tree):
560
556
        """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))
574
 
 
575
 
    def _forget_tree_state(self):
576
 
        self.text_sha1 = None
 
557
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
558
        self.executable = work_tree.is_executable(self.file_id)
 
559
 
 
560
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
561
        """See InventoryEntry._snapshot_text."""
 
562
        mutter('storing file {%s} in revision {%s}',
 
563
               self.file_id, self.revision)
 
564
        # special case to avoid diffing on renames or 
 
565
        # reparenting
 
566
        if (len(file_parents) == 1
 
567
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
568
            and self.text_size == file_parents.values()[0].text_size):
 
569
            previous_ie = file_parents.values()[0]
 
570
            weave_store.add_identical_text(
 
571
                self.file_id, previous_ie.revision, 
 
572
                self.revision, file_parents, transaction)
 
573
        else:
 
574
            new_lines = work_tree.get_file(self.file_id).readlines()
 
575
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
576
                                    transaction)
 
577
            self.text_sha1 = sha_strings(new_lines)
 
578
            self.text_size = sum(map(len, new_lines))
 
579
 
577
580
 
578
581
    def _unchanged(self, previous_ie):
579
582
        """See InventoryEntry._unchanged."""
592
595
class InventoryLink(InventoryEntry):
593
596
    """A file in an inventory."""
594
597
 
595
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
596
 
                 'text_id', 'parent_id', 'children', 'executable',
597
 
                 'revision', 'symlink_target', 'reference_revision']
 
598
    __slots__ = ['symlink_target']
598
599
 
599
600
    def _check(self, checker, rev_id, tree):
600
601
        """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:
 
602
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
602
603
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
604
                    % (self.file_id, rev_id))
604
 
        if self.symlink_target is None:
 
605
        if self.symlink_target == None:
605
606
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
607
                    % (self.file_id, rev_id))
607
608
 
623
624
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
624
625
             output_to, reverse=False):
625
626
        """See InventoryEntry._diff."""
626
 
        from bzrlib.diff import DiffSymlink
627
 
        old_target = self.symlink_target
 
627
        from_text = self.symlink_target
628
628
        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)
 
629
            to_text = to_entry.symlink_target
 
630
            if reverse:
 
631
                temp = from_text
 
632
                from_text = to_text
 
633
                to_text = temp
 
634
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
635
        else:
 
636
            if not reverse:
 
637
                print >>output_to, '=== target was %r' % self.symlink_target
 
638
            else:
 
639
                print >>output_to, '=== target is %r' % self.symlink_target
641
640
 
642
641
    def __init__(self, file_id, name, parent_id):
643
642
        super(InventoryLink, self).__init__(file_id, name, parent_id)
667
666
        """See InventoryEntry._read_tree_state."""
668
667
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
669
668
 
670
 
    def _forget_tree_state(self):
671
 
        self.symlink_target = None
672
 
 
673
669
    def _unchanged(self, previous_ie):
674
670
        """See InventoryEntry._unchanged."""
675
671
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
678
674
        return compatible
679
675
 
680
676
 
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
677
class Inventory(object):
713
678
    """Inventory of versioned files in a tree.
714
679
 
728
693
 
729
694
    >>> inv = Inventory()
730
695
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
731
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
696
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
732
697
    >>> inv['123-123'].name
733
698
    'hello.c'
734
699
 
742
707
    May also look up by name:
743
708
 
744
709
    >>> [x[0] for x in inv.iter_entries()]
745
 
    ['', u'hello.c']
 
710
    ['hello.c']
746
711
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
747
712
    >>> 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)
 
713
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
752
714
    """
753
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
715
    def __init__(self, root_id=ROOT_ID):
754
716
        """Create or read an inventory.
755
717
 
756
718
        If a working directory is specified, the inventory is read
760
722
        The inventory is created with a default root directory, with
761
723
        an id of None.
762
724
        """
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 = {}
768
 
        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
 
725
        # We are letting Branch.initialize() create a unique inventory
 
726
        # root id. Rather than generating a random one here.
 
727
        #if root_id is None:
 
728
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
729
        self.root = RootEntry(root_id)
845
730
        self._byid = {self.root.file_id: self.root}
846
731
 
 
732
 
847
733
    def copy(self):
848
 
        # 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)
 
734
        other = Inventory(self.root.file_id)
853
735
        # copy recursively so we know directories will be added before
854
736
        # their children.  There are more efficient ways than this...
855
 
        for path, entry in entries:
 
737
        for path, entry in self.iter_entries():
 
738
            if entry == self.root:
 
739
                continue
856
740
            other.add(entry.copy())
857
741
        return other
858
742
 
 
743
 
859
744
    def __iter__(self):
860
745
        return iter(self._byid)
861
746
 
 
747
 
862
748
    def __len__(self):
863
749
        """Returns number of entries."""
864
750
        return len(self._byid)
865
751
 
 
752
 
866
753
    def iter_entries(self, from_dir=None):
867
754
        """Return (path, entry) pairs, in order by name."""
868
 
        if from_dir is None:
869
 
            if self.root is None:
870
 
                return
871
 
            from_dir = self.root
872
 
            yield '', self.root
873
 
        elif isinstance(from_dir, basestring):
874
 
            from_dir = self._byid[from_dir]
875
 
            
876
 
        # unrolling the recursive called changed the time from
877
 
        # 440ms/663ms (inline/total) to 116ms/116ms
878
 
        children = from_dir.children.items()
879
 
        children.sort()
880
 
        children = collections.deque(children)
881
 
        stack = [(u'', children)]
882
 
        while stack:
883
 
            from_dir_relpath, children = stack[-1]
884
 
 
885
 
            while children:
886
 
                name, ie = children.popleft()
887
 
 
888
 
                # we know that from_dir_relpath never ends in a slash
889
 
                # and 'f' doesn't begin with one, we can do a string op, rather
890
 
                # than the checks of pathjoin(), though this means that all paths
891
 
                # start with a slash
892
 
                path = from_dir_relpath + '/' + name
893
 
 
894
 
                yield path[1:], ie
895
 
 
896
 
                if ie.kind != 'directory':
897
 
                    continue
898
 
 
899
 
                # But do this child first
900
 
                new_children = ie.children.items()
901
 
                new_children.sort()
902
 
                new_children = collections.deque(new_children)
903
 
                stack.append((path, new_children))
904
 
                # Break out of inner loop, so that we start outer loop with child
905
 
                break
906
 
            else:
907
 
                # if we finished all children, pop it off the stack
908
 
                stack.pop()
909
 
 
910
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
911
 
        yield_parents=False):
912
 
        """Iterate over the entries in a directory first order.
913
 
 
914
 
        This returns all entries for a directory before returning
915
 
        the entries for children of a directory. This is not
916
 
        lexicographically sorted order, and is a hybrid between
917
 
        depth-first and breadth-first.
918
 
 
919
 
        :param yield_parents: If True, yield the parents from the root leading
920
 
            down to specific_file_ids that have been requested. This has no
921
 
            impact if specific_file_ids is None.
922
 
        :return: This yields (path, entry) pairs
923
 
        """
924
 
        if specific_file_ids and not isinstance(specific_file_ids, set):
925
 
            specific_file_ids = set(specific_file_ids)
926
 
        # TODO? Perhaps this should return the from_dir so that the root is
927
 
        # yielded? or maybe an option?
928
 
        if from_dir is None:
929
 
            if self.root is None:
930
 
                return
931
 
            # Optimize a common case
932
 
            if (not yield_parents and specific_file_ids is not None and
933
 
                len(specific_file_ids) == 1):
934
 
                file_id = list(specific_file_ids)[0]
935
 
                if file_id in self:
936
 
                    yield self.id2path(file_id), self[file_id]
937
 
                return 
938
 
            from_dir = self.root
939
 
            if (specific_file_ids is None or yield_parents or
940
 
                self.root.file_id in specific_file_ids):
941
 
                yield u'', self.root
942
 
        elif isinstance(from_dir, basestring):
943
 
            from_dir = self._byid[from_dir]
944
 
 
945
 
        if specific_file_ids is not None:
946
 
            # TODO: jam 20070302 This could really be done as a loop rather
947
 
            #       than a bunch of recursive calls.
948
 
            parents = set()
949
 
            byid = self._byid
950
 
            def add_ancestors(file_id):
951
 
                if file_id not in byid:
952
 
                    return
953
 
                parent_id = byid[file_id].parent_id
954
 
                if parent_id is None:
955
 
                    return
956
 
                if parent_id not in parents:
957
 
                    parents.add(parent_id)
958
 
                    add_ancestors(parent_id)
959
 
            for file_id in specific_file_ids:
960
 
                add_ancestors(file_id)
961
 
        else:
962
 
            parents = None
963
 
            
964
 
        stack = [(u'', from_dir)]
965
 
        while stack:
966
 
            cur_relpath, cur_dir = stack.pop()
967
 
 
968
 
            child_dirs = []
969
 
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
970
 
 
971
 
                child_relpath = cur_relpath + child_name
972
 
 
973
 
                if (specific_file_ids is None or 
974
 
                    child_ie.file_id in specific_file_ids or
975
 
                    (yield_parents and child_ie.file_id in parents)):
976
 
                    yield child_relpath, child_ie
977
 
 
978
 
                if child_ie.kind == 'directory':
979
 
                    if parents is None or child_ie.file_id in parents:
980
 
                        child_dirs.append((child_relpath+'/', child_ie))
981
 
            stack.extend(reversed(child_dirs))
982
 
 
983
 
    def make_entry(self, kind, name, parent_id, file_id=None):
984
 
        """Simple thunk to bzrlib.inventory.make_entry."""
985
 
        return make_entry(kind, name, parent_id, file_id)
 
755
        if from_dir == None:
 
756
            assert self.root
 
757
            from_dir = self.root
 
758
        elif isinstance(from_dir, basestring):
 
759
            from_dir = self._byid[from_dir]
 
760
            
 
761
        kids = from_dir.children.items()
 
762
        kids.sort()
 
763
        for name, ie in kids:
 
764
            yield name, ie
 
765
            if ie.kind == 'directory':
 
766
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
767
                    yield os.path.join(name, cn), cie
 
768
 
986
769
 
987
770
    def entries(self):
988
771
        """Return list of (path, ie) for all entries except the root.
994
777
            kids = dir_ie.children.items()
995
778
            kids.sort()
996
779
            for name, ie in kids:
997
 
                child_path = osutils.pathjoin(dir_path, name)
 
780
                child_path = os.path.join(dir_path, name)
998
781
                accum.append((child_path, ie))
999
782
                if ie.kind == 'directory':
1000
783
                    descend(ie, child_path)
1001
784
 
1002
 
        descend(self.root, u'')
 
785
        descend(self.root, '')
1003
786
        return accum
1004
787
 
 
788
 
1005
789
    def directories(self):
1006
790
        """Return (path, entry) pairs for all directories, including the root.
1007
791
        """
1013
797
            kids.sort()
1014
798
 
1015
799
            for name, child_ie in kids:
1016
 
                child_path = osutils.pathjoin(parent_path, name)
 
800
                child_path = os.path.join(parent_path, name)
1017
801
                descend(child_ie, child_path)
1018
 
        descend(self.root, u'')
 
802
        descend(self.root, '')
1019
803
        return accum
1020
804
        
 
805
 
 
806
 
1021
807
    def __contains__(self, file_id):
1022
808
        """True if this entry contains a file with given id.
1023
809
 
1024
810
        >>> inv = Inventory()
1025
811
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1026
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
812
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1027
813
        >>> '123' in inv
1028
814
        True
1029
815
        >>> '456' in inv
1030
816
        False
1031
817
        """
1032
 
        return (file_id in self._byid)
 
818
        return file_id in self._byid
 
819
 
1033
820
 
1034
821
    def __getitem__(self, file_id):
1035
822
        """Return the entry for given file_id.
1036
823
 
1037
824
        >>> inv = Inventory()
1038
825
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1039
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
826
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1040
827
        >>> inv['123123'].name
1041
828
        'hello.c'
1042
829
        """
1043
830
        try:
1044
831
            return self._byid[file_id]
1045
832
        except KeyError:
1046
 
            # really we're passing an inventory, not a tree...
1047
 
            raise errors.NoSuchId(self, file_id)
 
833
            if file_id == None:
 
834
                raise BzrError("can't look up file_id None")
 
835
            else:
 
836
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
837
 
1048
838
 
1049
839
    def get_file_kind(self, file_id):
1050
840
        return self._byid[file_id].kind
1052
842
    def get_child(self, parent_id, filename):
1053
843
        return self[parent_id].children.get(filename)
1054
844
 
1055
 
    def _add_child(self, entry):
1056
 
        """Add an entry to the inventory, without adding it to its parent"""
1057
 
        if entry.file_id in self._byid:
1058
 
            raise BzrError("inventory already contains entry with id {%s}" %
1059
 
                           entry.file_id)
1060
 
        self._byid[entry.file_id] = entry
1061
 
        for child in getattr(entry, 'children', {}).itervalues():
1062
 
            self._add_child(child)
1063
 
        return entry
1064
845
 
1065
846
    def add(self, entry):
1066
847
        """Add entry to inventory.
1071
852
        Returns the new entry object.
1072
853
        """
1073
854
        if entry.file_id in self._byid:
1074
 
            raise errors.DuplicateFileId(entry.file_id,
1075
 
                                         self._byid[entry.file_id])
1076
 
 
1077
 
        if entry.parent_id is None:
1078
 
            self.root = entry
1079
 
        else:
1080
 
            try:
1081
 
                parent = self._byid[entry.parent_id]
1082
 
            except KeyError:
1083
 
                raise BzrError("parent_id {%s} not in inventory" %
1084
 
                               entry.parent_id)
1085
 
 
1086
 
            if entry.name in parent.children:
1087
 
                raise BzrError("%s is already versioned" %
1088
 
                        osutils.pathjoin(self.id2path(parent.file_id),
1089
 
                        entry.name).encode('utf-8'))
1090
 
            parent.children[entry.name] = entry
1091
 
        return self._add_child(entry)
1092
 
 
1093
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
855
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
856
 
 
857
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
858
            entry.parent_id = self.root.file_id
 
859
 
 
860
        try:
 
861
            parent = self._byid[entry.parent_id]
 
862
        except KeyError:
 
863
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
864
 
 
865
        if parent.children.has_key(entry.name):
 
866
            raise BzrError("%s is already versioned" %
 
867
                    appendpath(self.id2path(parent.file_id), entry.name))
 
868
 
 
869
        self._byid[entry.file_id] = entry
 
870
        parent.children[entry.name] = entry
 
871
        return entry
 
872
 
 
873
 
 
874
    def add_path(self, relpath, kind, file_id=None):
1094
875
        """Add entry from a path.
1095
876
 
1096
877
        The immediate parent must already be versioned.
1097
878
 
1098
879
        Returns the new entry object."""
 
880
        from bzrlib.branch import gen_file_id
1099
881
        
1100
 
        parts = osutils.splitpath(relpath)
1101
 
 
 
882
        parts = bzrlib.osutils.splitpath(relpath)
1102
883
        if len(parts) == 0:
1103
 
            if file_id is None:
1104
 
                file_id = generate_ids.gen_root_id()
1105
 
            self.root = InventoryDirectory(file_id, '', None)
1106
 
            self._byid = {self.root.file_id: self.root}
1107
 
            return self.root
 
884
            raise BzrError("cannot re-add root of inventory")
 
885
 
 
886
        if file_id == None:
 
887
            file_id = gen_file_id(relpath)
 
888
 
 
889
        parent_path = parts[:-1]
 
890
        parent_id = self.path2id(parent_path)
 
891
        if parent_id == None:
 
892
            raise NotVersionedError(path=parent_path)
 
893
        if kind == 'directory':
 
894
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
895
        elif kind == 'file':
 
896
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
897
        elif kind == 'symlink':
 
898
            ie = InventoryLink(file_id, parts[-1], parent_id)
1108
899
        else:
1109
 
            parent_path = parts[:-1]
1110
 
            parent_id = self.path2id(parent_path)
1111
 
            if parent_id is None:
1112
 
                raise errors.NotVersionedError(path=parent_path)
1113
 
        ie = make_entry(kind, parts[-1], parent_id, file_id)
 
900
            raise BzrError("unknown kind %r" % kind)
1114
901
        return self.add(ie)
1115
902
 
 
903
 
1116
904
    def __delitem__(self, file_id):
1117
905
        """Remove entry by id.
1118
906
 
1119
907
        >>> inv = Inventory()
1120
908
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1121
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
909
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1122
910
        >>> '123' in inv
1123
911
        True
1124
912
        >>> del inv['123']
1126
914
        False
1127
915
        """
1128
916
        ie = self[file_id]
 
917
 
 
918
        assert self[ie.parent_id].children[ie.name] == ie
 
919
        
 
920
        # TODO: Test deleting all children; maybe hoist to a separate
 
921
        # deltree method?
 
922
        if ie.kind == 'directory':
 
923
            for cie in ie.children.values():
 
924
                del self[cie.file_id]
 
925
            del ie.children
 
926
 
1129
927
        del self._byid[file_id]
1130
 
        if ie.parent_id is not None:
1131
 
            del self[ie.parent_id].children[ie.name]
 
928
        del self[ie.parent_id].children[ie.name]
 
929
 
1132
930
 
1133
931
    def __eq__(self, other):
1134
932
        """Compare two sets by comparing their contents.
1138
936
        >>> i1 == i2
1139
937
        True
1140
938
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1141
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
939
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1142
940
        >>> i1 == i2
1143
941
        False
1144
942
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1145
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
943
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1146
944
        >>> i1 == i2
1147
945
        True
1148
946
        """
1149
947
        if not isinstance(other, Inventory):
1150
948
            return NotImplemented
1151
949
 
 
950
        if len(self._byid) != len(other._byid):
 
951
            # shortcut: obviously not the same
 
952
            return False
 
953
 
1152
954
        return self._byid == other._byid
1153
955
 
 
956
 
1154
957
    def __ne__(self, other):
1155
958
        return not self.__eq__(other)
1156
959
 
 
960
 
1157
961
    def __hash__(self):
1158
962
        raise ValueError('not hashable')
1159
963
 
1160
 
    def _iter_file_id_parents(self, file_id):
1161
 
        """Yield the parents of file_id up to the root."""
1162
 
        while file_id is not None:
1163
 
            try:
1164
 
                ie = self._byid[file_id]
1165
 
            except KeyError:
1166
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
1167
 
            yield ie
1168
 
            file_id = ie.parent_id
1169
964
 
1170
965
    def get_idpath(self, file_id):
1171
966
        """Return a list of file_ids for the path to an entry.
1176
971
        root directory as depth 1.
1177
972
        """
1178
973
        p = []
1179
 
        for parent in self._iter_file_id_parents(file_id):
1180
 
            p.insert(0, parent.file_id)
 
974
        while file_id != None:
 
975
            try:
 
976
                ie = self._byid[file_id]
 
977
            except KeyError:
 
978
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
979
            p.insert(0, ie.file_id)
 
980
            file_id = ie.parent_id
1181
981
        return p
1182
982
 
 
983
 
1183
984
    def id2path(self, file_id):
1184
 
        """Return as a string the path to file_id.
 
985
        """Return as a list the path to file_id.
1185
986
        
1186
987
        >>> i = Inventory()
1187
988
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1188
989
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1189
 
        >>> print i.id2path('foo-id')
 
990
        >>> print i.id2path('foo-id').replace(os.sep, '/')
1190
991
        src/foo.c
1191
992
        """
1192
993
        # get all names, skipping root
1193
 
        return '/'.join(reversed(
1194
 
            [parent.name for parent in 
1195
 
             self._iter_file_id_parents(file_id)][:-1]))
 
994
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
995
        return os.sep.join(p)
1196
996
            
 
997
 
 
998
 
1197
999
    def path2id(self, name):
1198
1000
        """Walk down through directories to return entry of last component.
1199
1001
 
1203
1005
        This returns the entry of the last component in the path,
1204
1006
        which may be either a file or a directory.
1205
1007
 
1206
 
        Returns None IFF the path is not found.
 
1008
        Returns None iff the path is not found.
1207
1009
        """
1208
 
        if isinstance(name, basestring):
1209
 
            name = osutils.splitpath(name)
 
1010
        if isinstance(name, types.StringTypes):
 
1011
            name = splitpath(name)
1210
1012
 
1211
 
        # mutter("lookup path %r" % name)
 
1013
        mutter("lookup path %r" % name)
1212
1014
 
1213
1015
        parent = self.root
1214
 
        if parent is None:
1215
 
            return None
1216
1016
        for f in name:
1217
1017
            try:
1218
 
                children = getattr(parent, 'children', None)
1219
 
                if children is None:
1220
 
                    return None
1221
 
                cie = children[f]
 
1018
                cie = parent.children[f]
 
1019
                assert cie.name == f
 
1020
                assert cie.parent_id == parent.file_id
1222
1021
                parent = cie
1223
1022
            except KeyError:
1224
1023
                # or raise an error?
1226
1025
 
1227
1026
        return parent.file_id
1228
1027
 
 
1028
 
1229
1029
    def has_filename(self, names):
1230
1030
        return bool(self.path2id(names))
1231
1031
 
 
1032
 
1232
1033
    def has_id(self, file_id):
1233
 
        return (file_id in self._byid)
 
1034
        return self._byid.has_key(file_id)
1234
1035
 
1235
 
    def remove_recursive_id(self, file_id):
1236
 
        """Remove file_id, and children, from the inventory.
1237
 
        
1238
 
        :param file_id: A file_id to remove.
1239
 
        """
1240
 
        to_find_delete = [self._byid[file_id]]
1241
 
        to_delete = []
1242
 
        while to_find_delete:
1243
 
            ie = to_find_delete.pop()
1244
 
            to_delete.append(ie.file_id)
1245
 
            if ie.kind == 'directory':
1246
 
                to_find_delete.extend(ie.children.values())
1247
 
        for file_id in reversed(to_delete):
1248
 
            ie = self[file_id]
1249
 
            del self._byid[file_id]
1250
 
        if ie.parent_id is not None:
1251
 
            del self[ie.parent_id].children[ie.name]
1252
 
        else:
1253
 
            self.root = None
1254
1036
 
1255
1037
    def rename(self, file_id, new_parent_id, new_name):
1256
1038
        """Move a file within the inventory.
1257
1039
 
1258
1040
        This can change either the name, or the parent, or both.
1259
1041
 
1260
 
        This does not move the working file.
1261
 
        """
1262
 
        new_name = ensure_normalized_name(new_name)
 
1042
        This does not move the working file."""
1263
1043
        if not is_valid_name(new_name):
1264
1044
            raise BzrError("not an acceptable filename: %r" % new_name)
1265
1045
 
1283
1063
        file_ie.name = new_name
1284
1064
        file_ie.parent_id = new_parent_id
1285
1065
 
1286
 
    def is_root(self, file_id):
1287
 
        return self.root is not None and file_id == self.root.file_id
1288
 
 
1289
 
 
1290
 
entry_factory = {
1291
 
    'directory': InventoryDirectory,
1292
 
    'file': InventoryFile,
1293
 
    'symlink': InventoryLink,
1294
 
    'tree-reference': TreeReference
1295
 
}
1296
 
 
1297
 
def make_entry(kind, name, parent_id, file_id=None):
1298
 
    """Create an inventory entry.
1299
 
 
1300
 
    :param kind: the type of inventory entry to create.
1301
 
    :param name: the basename of the entry.
1302
 
    :param parent_id: the parent_id of the entry.
1303
 
    :param file_id: the file_id to use. if None, one will be created.
1304
 
    """
1305
 
    if file_id is None:
1306
 
        file_id = generate_ids.gen_file_id(name)
1307
 
    name = ensure_normalized_name(name)
1308
 
    try:
1309
 
        factory = entry_factory[kind]
1310
 
    except KeyError:
1311
 
        raise BzrError("unknown kind %r" % kind)
1312
 
    return factory(file_id, name, parent_id)
1313
 
 
1314
 
 
1315
 
def ensure_normalized_name(name):
1316
 
    """Normalize name.
1317
 
 
1318
 
    :raises InvalidNormalization: When name is not normalized, and cannot be
1319
 
        accessed on this platform by the normalized path.
1320
 
    :return: The NFC normalised version of name.
1321
 
    """
1322
 
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
1323
 
    # keep them synchronised.
1324
 
    # we dont import normalized_filename directly because we want to be
1325
 
    # able to change the implementation at runtime for tests.
1326
 
    norm_name, can_access = osutils.normalized_filename(name)
1327
 
    if norm_name != name:
1328
 
        if can_access:
1329
 
            return norm_name
1330
 
        else:
1331
 
            # TODO: jam 20060701 This would probably be more useful
1332
 
            #       if the error was raised with the full path
1333
 
            raise errors.InvalidNormalization(name)
1334
 
    return name
 
1066
 
1335
1067
 
1336
1068
 
1337
1069
_NAME_RE = None
1338
1070
 
1339
1071
def is_valid_name(name):
1340
1072
    global _NAME_RE
1341
 
    if _NAME_RE is None:
 
1073
    if _NAME_RE == None:
1342
1074
        _NAME_RE = re.compile(r'^[^/\\]+$')
1343
1075
        
1344
1076
    return bool(_NAME_RE.match(name))