~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2006-02-26 07:54:02 UTC
  • mto: (1587.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1588.
  • Revision ID: robertc@robertcollins.net-20060226075402-92fca9fdb7b0070d
Check for incorrect revision parentage in the weave during revision access.

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
                            pathjoin, 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: 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
        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(pathjoin(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 = pathjoin(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):
396
413
 
397
414
class RootEntry(InventoryEntry):
398
415
 
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
416
    def _check(self, checker, rev_id, tree):
404
417
        """See InventoryEntry._check"""
405
418
 
406
419
    def __init__(self, file_id):
407
420
        self.file_id = file_id
408
421
        self.children = {}
409
 
        self.kind = 'directory'
 
422
        self.kind = 'root_directory'
410
423
        self.parent_id = None
411
424
        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
425
 
417
426
    def __eq__(self, other):
418
427
        if not isinstance(other, RootEntry):
425
434
class InventoryDirectory(InventoryEntry):
426
435
    """A directory in an inventory."""
427
436
 
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
437
    def _check(self, checker, rev_id, tree):
433
438
        """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:
 
439
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
440
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
441
                                % (self.file_id, rev_id))
437
442
 
468
473
class InventoryFile(InventoryEntry):
469
474
    """A file in an inventory."""
470
475
 
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):
 
476
    def _check(self, checker, rev_id, tree):
476
477
        """See InventoryEntry._check"""
477
 
        key = (self.file_id, self.revision)
478
 
        if key in checker.checked_texts:
479
 
            prev_sha = checker.checked_texts[key]
 
478
        revision = self.revision
 
479
        t = (self.file_id, revision)
 
480
        if t in checker.checked_texts:
 
481
            prev_sha = checker.checked_texts[t] 
480
482
            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))
 
483
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
484
                                    (self.file_id, rev_id))
485
485
            else:
486
486
                checker.repeated_text_cnt += 1
487
487
                return
488
488
 
489
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
490
 
        checker.checked_text_cnt += 1
 
489
        if self.file_id not in checker.checked_weaves:
 
490
            mutter('check weave {%s}', self.file_id)
 
491
            w = tree.get_weave(self.file_id)
 
492
            # Not passing a progress bar, because it creates a new
 
493
            # progress, which overwrites the current progress,
 
494
            # and doesn't look nice
 
495
            w.check()
 
496
            checker.checked_weaves[self.file_id] = True
 
497
        else:
 
498
            w = tree.get_weave_prelude(self.file_id)
 
499
 
 
500
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
501
        checker.checked_text_cnt += 1 
491
502
        # We can't check the length, because Weave doesn't store that
492
503
        # information, and the whole point of looking at the weave's
493
504
        # 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
 
505
        if self.text_sha1 != w.get_sha1(self.revision):
 
506
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
507
                                % (self.file_id, self.revision))
 
508
        checker.checked_texts[t] = self.text_sha1
497
509
 
498
510
    def copy(self):
499
511
        other = InventoryFile(self.file_id, self.name, self.parent_id)
506
518
 
507
519
    def detect_changes(self, old_entry):
508
520
        """See InventoryEntry.detect_changes."""
 
521
        assert self.text_sha1 != None
 
522
        assert old_entry.text_sha1 != None
509
523
        text_modified = (self.text_sha1 != old_entry.text_sha1)
510
524
        meta_modified = (self.executable != old_entry.executable)
511
525
        return text_modified, meta_modified
513
527
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
514
528
             output_to, reverse=False):
515
529
        """See InventoryEntry._diff."""
516
 
        from bzrlib.diff import DiffText
517
 
        from_file_id = self.file_id
 
530
        from_text = tree.get_file(self.file_id).readlines()
518
531
        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)
 
532
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
533
        else:
 
534
            to_text = []
 
535
        if not reverse:
 
536
            text_diff(from_label, from_text,
 
537
                      to_label, to_text, output_to)
 
538
        else:
 
539
            text_diff(to_label, to_text,
 
540
                      from_label, from_text, output_to)
529
541
 
530
542
    def has_text(self):
531
543
        """See InventoryEntry.has_text."""
552
564
 
553
565
    def _put_on_disk(self, fullpath, tree):
554
566
        """See InventoryEntry._put_on_disk."""
555
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
567
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
556
568
        if tree.is_executable(self.file_id):
557
569
            os.chmod(fullpath, 0755)
558
570
 
559
571
    def _read_tree_state(self, path, work_tree):
560
572
        """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))
 
573
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
574
        self.executable = work_tree.is_executable(self.file_id)
574
575
 
575
576
    def _forget_tree_state(self):
576
577
        self.text_sha1 = None
 
578
        self.executable = None
 
579
 
 
580
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
581
        """See InventoryEntry._snapshot_text."""
 
582
        mutter('storing file {%s} in revision {%s}',
 
583
               self.file_id, self.revision)
 
584
        # special case to avoid diffing on renames or 
 
585
        # reparenting
 
586
        if (len(file_parents) == 1
 
587
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
588
            and self.text_size == file_parents.values()[0].text_size):
 
589
            previous_ie = file_parents.values()[0]
 
590
            weave_store.add_identical_text(
 
591
                self.file_id, previous_ie.revision, 
 
592
                self.revision, file_parents, transaction)
 
593
        else:
 
594
            new_lines = work_tree.get_file(self.file_id).readlines()
 
595
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
596
                                    transaction)
 
597
            self.text_sha1 = sha_strings(new_lines)
 
598
            self.text_size = sum(map(len, new_lines))
 
599
 
577
600
 
578
601
    def _unchanged(self, previous_ie):
579
602
        """See InventoryEntry._unchanged."""
592
615
class InventoryLink(InventoryEntry):
593
616
    """A file in an inventory."""
594
617
 
595
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
596
 
                 'text_id', 'parent_id', 'children', 'executable',
597
 
                 'revision', 'symlink_target', 'reference_revision']
 
618
    __slots__ = ['symlink_target']
598
619
 
599
620
    def _check(self, checker, rev_id, tree):
600
621
        """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:
 
622
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
602
623
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
624
                    % (self.file_id, rev_id))
604
 
        if self.symlink_target is None:
 
625
        if self.symlink_target == None:
605
626
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
627
                    % (self.file_id, rev_id))
607
628
 
623
644
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
624
645
             output_to, reverse=False):
625
646
        """See InventoryEntry._diff."""
626
 
        from bzrlib.diff import DiffSymlink
627
 
        old_target = self.symlink_target
 
647
        from_text = self.symlink_target
628
648
        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)
 
649
            to_text = to_entry.symlink_target
 
650
            if reverse:
 
651
                temp = from_text
 
652
                from_text = to_text
 
653
                to_text = temp
 
654
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
655
        else:
 
656
            if not reverse:
 
657
                print >>output_to, '=== target was %r' % self.symlink_target
 
658
            else:
 
659
                print >>output_to, '=== target is %r' % self.symlink_target
641
660
 
642
661
    def __init__(self, file_id, name, parent_id):
643
662
        super(InventoryLink, self).__init__(file_id, name, parent_id)
678
697
        return compatible
679
698
 
680
699
 
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
700
class Inventory(object):
713
701
    """Inventory of versioned files in a tree.
714
702
 
728
716
 
729
717
    >>> inv = Inventory()
730
718
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
731
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
719
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
732
720
    >>> inv['123-123'].name
733
721
    'hello.c'
734
722
 
742
730
    May also look up by name:
743
731
 
744
732
    >>> [x[0] for x in inv.iter_entries()]
745
 
    ['', u'hello.c']
 
733
    ['hello.c']
746
734
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
747
735
    >>> 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)
 
736
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
752
737
    """
753
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
738
    def __init__(self, root_id=ROOT_ID):
754
739
        """Create or read an inventory.
755
740
 
756
741
        If a working directory is specified, the inventory is read
760
745
        The inventory is created with a default root directory, with
761
746
        an id of None.
762
747
        """
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
 
748
        # We are letting Branch.create() create a unique inventory
 
749
        # root id. Rather than generating a random one here.
 
750
        #if root_id is None:
 
751
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
752
        self.root = RootEntry(root_id)
845
753
        self._byid = {self.root.file_id: self.root}
846
754
 
 
755
 
847
756
    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)
853
 
        other.root.revision = self.root.revision
 
757
        other = Inventory(self.root.file_id)
854
758
        # copy recursively so we know directories will be added before
855
759
        # their children.  There are more efficient ways than this...
856
 
        for path, entry in entries:
 
760
        for path, entry in self.iter_entries():
 
761
            if entry == self.root:
 
762
                continue
857
763
            other.add(entry.copy())
858
764
        return other
859
765
 
 
766
 
860
767
    def __iter__(self):
861
768
        return iter(self._byid)
862
769
 
 
770
 
863
771
    def __len__(self):
864
772
        """Returns number of entries."""
865
773
        return len(self._byid)
866
774
 
 
775
 
867
776
    def iter_entries(self, from_dir=None):
868
777
        """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)
 
778
        if from_dir == None:
 
779
            assert self.root
 
780
            from_dir = self.root
 
781
        elif isinstance(from_dir, basestring):
 
782
            from_dir = self._byid[from_dir]
 
783
            
 
784
        kids = from_dir.children.items()
 
785
        kids.sort()
 
786
        for name, ie in kids:
 
787
            yield name, ie
 
788
            if ie.kind == 'directory':
 
789
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
790
                    yield pathjoin(name, cn), cie
 
791
 
987
792
 
988
793
    def entries(self):
989
794
        """Return list of (path, ie) for all entries except the root.
995
800
            kids = dir_ie.children.items()
996
801
            kids.sort()
997
802
            for name, ie in kids:
998
 
                child_path = osutils.pathjoin(dir_path, name)
 
803
                child_path = pathjoin(dir_path, name)
999
804
                accum.append((child_path, ie))
1000
805
                if ie.kind == 'directory':
1001
806
                    descend(ie, child_path)
1003
808
        descend(self.root, u'')
1004
809
        return accum
1005
810
 
 
811
 
1006
812
    def directories(self):
1007
813
        """Return (path, entry) pairs for all directories, including the root.
1008
814
        """
1014
820
            kids.sort()
1015
821
 
1016
822
            for name, child_ie in kids:
1017
 
                child_path = osutils.pathjoin(parent_path, name)
 
823
                child_path = pathjoin(parent_path, name)
1018
824
                descend(child_ie, child_path)
1019
825
        descend(self.root, u'')
1020
826
        return accum
1021
827
        
 
828
 
 
829
 
1022
830
    def __contains__(self, file_id):
1023
831
        """True if this entry contains a file with given id.
1024
832
 
1025
833
        >>> inv = Inventory()
1026
834
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1027
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
835
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1028
836
        >>> '123' in inv
1029
837
        True
1030
838
        >>> '456' in inv
1031
839
        False
1032
840
        """
1033
 
        return (file_id in self._byid)
 
841
        return file_id in self._byid
 
842
 
1034
843
 
1035
844
    def __getitem__(self, file_id):
1036
845
        """Return the entry for given file_id.
1037
846
 
1038
847
        >>> inv = Inventory()
1039
848
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1040
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
849
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1041
850
        >>> inv['123123'].name
1042
851
        'hello.c'
1043
852
        """
1044
853
        try:
1045
854
            return self._byid[file_id]
1046
855
        except KeyError:
1047
 
            # really we're passing an inventory, not a tree...
1048
 
            raise errors.NoSuchId(self, file_id)
 
856
            if file_id == None:
 
857
                raise BzrError("can't look up file_id None")
 
858
            else:
 
859
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
860
 
1049
861
 
1050
862
    def get_file_kind(self, file_id):
1051
863
        return self._byid[file_id].kind
1053
865
    def get_child(self, parent_id, filename):
1054
866
        return self[parent_id].children.get(filename)
1055
867
 
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
868
 
1066
869
    def add(self, entry):
1067
870
        """Add entry to inventory.
1072
875
        Returns the new entry object.
1073
876
        """
1074
877
        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):
 
878
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
879
 
 
880
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
881
            entry.parent_id = self.root.file_id
 
882
 
 
883
        try:
 
884
            parent = self._byid[entry.parent_id]
 
885
        except KeyError:
 
886
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
887
 
 
888
        if parent.children.has_key(entry.name):
 
889
            raise BzrError("%s is already versioned" %
 
890
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
891
 
 
892
        self._byid[entry.file_id] = entry
 
893
        parent.children[entry.name] = entry
 
894
        return entry
 
895
 
 
896
 
 
897
    def add_path(self, relpath, kind, file_id=None):
1095
898
        """Add entry from a path.
1096
899
 
1097
900
        The immediate parent must already be versioned.
1098
901
 
1099
902
        Returns the new entry object."""
 
903
        from bzrlib.workingtree import gen_file_id
1100
904
        
1101
 
        parts = osutils.splitpath(relpath)
 
905
        parts = bzrlib.osutils.splitpath(relpath)
 
906
 
 
907
        if file_id == None:
 
908
            file_id = gen_file_id(relpath)
1102
909
 
1103
910
        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)
 
911
            self.root = RootEntry(file_id)
1107
912
            self._byid = {self.root.file_id: self.root}
1108
 
            return self.root
 
913
            return
1109
914
        else:
1110
915
            parent_path = parts[:-1]
1111
916
            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)
 
917
            if parent_id == None:
 
918
                raise NotVersionedError(path=parent_path)
 
919
        if kind == 'directory':
 
920
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
921
        elif kind == 'file':
 
922
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
923
        elif kind == 'symlink':
 
924
            ie = InventoryLink(file_id, parts[-1], parent_id)
 
925
        else:
 
926
            raise BzrError("unknown kind %r" % kind)
1115
927
        return self.add(ie)
1116
928
 
 
929
 
1117
930
    def __delitem__(self, file_id):
1118
931
        """Remove entry by id.
1119
932
 
1120
933
        >>> inv = Inventory()
1121
934
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1122
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
935
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1123
936
        >>> '123' in inv
1124
937
        True
1125
938
        >>> del inv['123']
1127
940
        False
1128
941
        """
1129
942
        ie = self[file_id]
 
943
 
 
944
        assert ie.parent_id is None or \
 
945
            self[ie.parent_id].children[ie.name] == ie
 
946
        
1130
947
        del self._byid[file_id]
1131
948
        if ie.parent_id is not None:
1132
949
            del self[ie.parent_id].children[ie.name]
1133
950
 
 
951
 
1134
952
    def __eq__(self, other):
1135
953
        """Compare two sets by comparing their contents.
1136
954
 
1139
957
        >>> i1 == i2
1140
958
        True
1141
959
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1142
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
960
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1143
961
        >>> i1 == i2
1144
962
        False
1145
963
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1146
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
964
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1147
965
        >>> i1 == i2
1148
966
        True
1149
967
        """
1150
968
        if not isinstance(other, Inventory):
1151
969
            return NotImplemented
1152
970
 
 
971
        if len(self._byid) != len(other._byid):
 
972
            # shortcut: obviously not the same
 
973
            return False
 
974
 
1153
975
        return self._byid == other._byid
1154
976
 
 
977
 
1155
978
    def __ne__(self, other):
1156
979
        return not self.__eq__(other)
1157
980
 
 
981
 
1158
982
    def __hash__(self):
1159
983
        raise ValueError('not hashable')
1160
984
 
1161
 
    def _iter_file_id_parents(self, file_id):
1162
 
        """Yield the parents of file_id up to the root."""
1163
 
        while file_id is not None:
1164
 
            try:
1165
 
                ie = self._byid[file_id]
1166
 
            except KeyError:
1167
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
1168
 
            yield ie
1169
 
            file_id = ie.parent_id
1170
985
 
1171
986
    def get_idpath(self, file_id):
1172
987
        """Return a list of file_ids for the path to an entry.
1177
992
        root directory as depth 1.
1178
993
        """
1179
994
        p = []
1180
 
        for parent in self._iter_file_id_parents(file_id):
1181
 
            p.insert(0, parent.file_id)
 
995
        while file_id != None:
 
996
            try:
 
997
                ie = self._byid[file_id]
 
998
            except KeyError:
 
999
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1000
            p.insert(0, ie.file_id)
 
1001
            file_id = ie.parent_id
1182
1002
        return p
1183
1003
 
 
1004
 
1184
1005
    def id2path(self, file_id):
1185
 
        """Return as a string the path to file_id.
 
1006
        """Return as a list the path to file_id.
1186
1007
        
1187
1008
        >>> i = Inventory()
1188
1009
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1191
1012
        src/foo.c
1192
1013
        """
1193
1014
        # get all names, skipping root
1194
 
        return '/'.join(reversed(
1195
 
            [parent.name for parent in 
1196
 
             self._iter_file_id_parents(file_id)][:-1]))
 
1015
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
1016
        if p:
 
1017
            return pathjoin(*p)
 
1018
        else:
 
1019
            return ''
1197
1020
            
 
1021
 
 
1022
 
1198
1023
    def path2id(self, name):
1199
1024
        """Walk down through directories to return entry of last component.
1200
1025
 
1204
1029
        This returns the entry of the last component in the path,
1205
1030
        which may be either a file or a directory.
1206
1031
 
1207
 
        Returns None IFF the path is not found.
 
1032
        Returns None iff the path is not found.
1208
1033
        """
1209
 
        if isinstance(name, basestring):
1210
 
            name = osutils.splitpath(name)
 
1034
        if isinstance(name, types.StringTypes):
 
1035
            name = splitpath(name)
1211
1036
 
1212
 
        # mutter("lookup path %r" % name)
 
1037
        mutter("lookup path %r" % name)
1213
1038
 
1214
1039
        parent = self.root
1215
 
        if parent is None:
1216
 
            return None
1217
1040
        for f in name:
1218
1041
            try:
1219
 
                children = getattr(parent, 'children', None)
1220
 
                if children is None:
1221
 
                    return None
1222
 
                cie = children[f]
 
1042
                cie = parent.children[f]
 
1043
                assert cie.name == f
 
1044
                assert cie.parent_id == parent.file_id
1223
1045
                parent = cie
1224
1046
            except KeyError:
1225
1047
                # or raise an error?
1227
1049
 
1228
1050
        return parent.file_id
1229
1051
 
 
1052
 
1230
1053
    def has_filename(self, names):
1231
1054
        return bool(self.path2id(names))
1232
1055
 
 
1056
 
1233
1057
    def has_id(self, file_id):
1234
 
        return (file_id in self._byid)
 
1058
        return self._byid.has_key(file_id)
1235
1059
 
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
1060
 
1256
1061
    def rename(self, file_id, new_parent_id, new_name):
1257
1062
        """Move a file within the inventory.
1258
1063
 
1259
1064
        This can change either the name, or the parent, or both.
1260
1065
 
1261
 
        This does not move the working file.
1262
 
        """
1263
 
        new_name = ensure_normalized_name(new_name)
 
1066
        This does not move the working file."""
1264
1067
        if not is_valid_name(new_name):
1265
1068
            raise BzrError("not an acceptable filename: %r" % new_name)
1266
1069
 
1284
1087
        file_ie.name = new_name
1285
1088
        file_ie.parent_id = new_parent_id
1286
1089
 
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
 
1090
 
1336
1091
 
1337
1092
 
1338
1093
_NAME_RE = None
1339
1094
 
1340
1095
def is_valid_name(name):
1341
1096
    global _NAME_RE
1342
 
    if _NAME_RE is None:
 
1097
    if _NAME_RE == None:
1343
1098
        _NAME_RE = re.compile(r'^[^/\\]+$')
1344
1099
        
1345
1100
    return bool(_NAME_RE.match(name))