~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-05-29 15:57:16 UTC
  • mfrom: (3427.5.9 dep_warnings)
  • Revision ID: pqm@pqm.ubuntu.com-20080529155716-0w3kic8lioa63231
(jam) Enable Deprecation Warnings when running -Werror and when
        running selftest

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005, 2006, 2007 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
 
 
31
 
import os.path
 
30
import os
32
31
import re
33
32
import sys
 
33
 
 
34
from bzrlib.lazy_import import lazy_import
 
35
lazy_import(globals(), """
 
36
import collections
34
37
import tarfile
35
 
import types
36
38
 
37
39
import bzrlib
38
 
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
39
 
                            pathjoin, sha_strings)
 
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_method
40
54
from bzrlib.trace import mutter
41
 
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
42
 
                           BzrError, BzrCheckError)
43
55
 
44
56
 
45
57
class InventoryEntry(object):
76
88
    >>> i.path2id('')
77
89
    'TREE_ROOT'
78
90
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
79
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
 
91
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
80
92
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
81
 
    InventoryFile('2323', 'hello.c', parent_id='123')
82
 
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
 
93
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
 
94
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
83
95
    >>> for ix, j in enumerate(i.iter_entries()):
84
96
    ...   print (j[0] == shouldbe[ix], j[1])
85
97
    ... 
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}
 
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))
92
101
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
93
 
    InventoryFile('2324', 'bye.c', parent_id='123')
 
102
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
94
103
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
95
 
    InventoryDirectory('2325', 'wibble', parent_id='123')
 
104
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
96
105
    >>> i.path2id('src/wibble')
97
106
    '2325'
98
107
    >>> '2325' in i
99
108
    True
100
109
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
101
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
110
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
102
111
    >>> i['2326']
103
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
112
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
104
113
    >>> for path, entry in i.iter_entries():
105
114
    ...     print path
106
 
    ...     assert i.path2id(path)
107
115
    ... 
 
116
    <BLANKLINE>
108
117
    src
109
118
    src/bye.c
110
119
    src/hello.c
113
122
    >>> i.id2path('2326')
114
123
    'src/wibble/wibble.c'
115
124
    """
 
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'
116
133
    
117
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
 
                 'text_id', 'parent_id', 'children', 'executable', 
119
 
                 'revision']
120
 
 
121
 
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
122
 
        versionedfile = weave_store.get_weave_or_empty(self.file_id,
123
 
                                                       transaction)
124
 
        versionedfile.add_lines(self.revision, parents, new_lines)
 
134
    __slots__ = []
125
135
 
126
136
    def detect_changes(self, old_entry):
127
137
        """Return a (text_modified, meta_modified) from this to old_entry.
131
141
        """
132
142
        return False, False
133
143
 
134
 
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
135
 
             output_to, reverse=False):
136
 
        """Perform a diff from this to to_entry.
137
 
 
138
 
        text_diff will be used for textual difference calculation.
139
 
        This is a template method, override _diff in child classes.
140
 
        """
141
 
        self._read_tree_state(tree.id2path(self.file_id), tree)
142
 
        if to_entry:
143
 
            # cannot diff from one kind to another - you must do a removal
144
 
            # and an addif they do not match.
145
 
            assert self.kind == to_entry.kind
146
 
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
147
 
                                      to_tree)
148
 
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
149
 
                   output_to, reverse)
150
 
 
151
144
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
152
145
             output_to, reverse=False):
153
146
        """Perform a diff between two entries of the same kind."""
154
 
 
155
 
    def find_previous_heads(self, previous_inventories,
156
 
                            versioned_file_store,
157
 
                            transaction,
158
 
                            entry_vf=None):
159
 
        """Return the revisions and entries that directly preceed this.
160
 
 
161
 
        Returned as a map from revision to inventory entry.
162
 
 
163
 
        This is a map containing the file revisions in all parents
164
 
        for which the file exists, and its revision is not a parent of
165
 
        any other. If the file is new, the set will be empty.
166
 
 
167
 
        :param versioned_file_store: A store where ancestry data on this
168
 
                                     file id can be queried.
169
 
        :param transaction: The transaction that queries to the versioned 
170
 
                            file store should be completed under.
171
 
        :param entry_vf: The entry versioned file, if its already available.
 
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.
172
156
        """
173
 
        def get_ancestors(weave, entry):
174
 
            return set(weave.get_ancestry(entry.revision))
175
157
        # revision:ie mapping for each ie found in previous_inventories.
176
158
        candidates = {}
177
 
        # revision:ie mapping with one revision for each head.
178
 
        heads = {}
179
 
        # revision: ancestor list for each head
180
 
        head_ancestors = {}
181
159
        # identify candidate head revision ids.
182
160
        for inv in previous_inventories:
183
161
            if self.file_id in inv:
184
162
                ie = inv[self.file_id]
185
 
                assert ie.file_id == self.file_id
186
163
                if ie.revision in candidates:
187
164
                    # same revision value in two different inventories:
188
165
                    # correct possible inconsistencies:
194
171
                            ie.executable = False
195
172
                    except AttributeError:
196
173
                        pass
197
 
                    # must now be the same.
198
 
                    assert candidates[ie.revision] == ie
199
174
                else:
200
175
                    # add this revision as a candidate.
201
176
                    candidates[ie.revision] = ie
202
 
 
203
 
        # common case optimisation
204
 
        if len(candidates) == 1:
205
 
            # if there is only one candidate revision found
206
 
            # then we can opening the versioned file to access ancestry:
207
 
            # there cannot be any ancestors to eliminate when there is 
208
 
            # only one revision available.
209
 
            heads[ie.revision] = ie
210
 
            return heads
211
 
 
212
 
        # eliminate ancestors amongst the available candidates:
213
 
        # heads are those that are not an ancestor of any other candidate
214
 
        # - this provides convergence at a per-file level.
215
 
        for ie in candidates.values():
216
 
            # may be an ancestor of a known head:
217
 
            already_present = 0 != len(
218
 
                [head for head in heads 
219
 
                 if ie.revision in head_ancestors[head]])
220
 
            if already_present:
221
 
                # an ancestor of an analyzed candidate.
222
 
                continue
223
 
            # not an ancestor of a known head:
224
 
            # load the versioned file for this file id if needed
225
 
            if entry_vf is None:
226
 
                entry_vf = versioned_file_store.get_weave_or_empty(
227
 
                    self.file_id, transaction)
228
 
            ancestors = get_ancestors(entry_vf, ie)
229
 
            # may knock something else out:
230
 
            check_heads = list(heads.keys())
231
 
            for head in check_heads:
232
 
                if head in ancestors:
233
 
                    # this previously discovered 'head' is not
234
 
                    # really a head - its an ancestor of the newly 
235
 
                    # found head,
236
 
                    heads.pop(head)
237
 
            head_ancestors[ie.revision] = ancestors
238
 
            heads[ie.revision] = ie
239
 
        return heads
 
177
        return candidates
240
178
 
241
179
    def get_tar_item(self, root, dp, now, tree):
242
180
        """Get a tarfile item and a file stream for its content."""
243
 
        item = tarfile.TarInfo(pathjoin(root, dp))
 
181
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
244
182
        # TODO: would be cool to actually set it to the timestamp of the
245
183
        # revision it was last changed
246
184
        item.mtime = now
273
211
        Traceback (most recent call last):
274
212
        InvalidEntryName: Invalid entry name: src/hello.c
275
213
        """
276
 
        assert isinstance(name, basestring), name
277
214
        if '/' in name or '\\' in name:
278
 
            raise InvalidEntryName(name=name)
 
215
            raise errors.InvalidEntryName(name=name)
279
216
        self.executable = False
280
217
        self.revision = None
281
218
        self.text_sha1 = None
285
222
        self.text_id = text_id
286
223
        self.parent_id = parent_id
287
224
        self.symlink_target = None
 
225
        self.reference_revision = None
288
226
 
289
227
    def kind_character(self):
290
228
        """Return a short kind indicator useful for appending to names."""
291
229
        raise BzrError('unknown kind %r' % self.kind)
292
230
 
293
 
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
231
    known_kinds = ('file', 'directory', 'symlink')
294
232
 
295
233
    def _put_in_tar(self, item, tree):
296
234
        """populate item for stashing in a tar, and return the content stream.
305
243
        
306
244
        This is a template method - implement _put_on_disk in subclasses.
307
245
        """
308
 
        fullpath = pathjoin(dest, dp)
 
246
        fullpath = osutils.pathjoin(dest, dp)
309
247
        self._put_on_disk(fullpath, tree)
310
 
        mutter("  export {%s} kind %s to %s", self.file_id,
311
 
                self.kind, fullpath)
 
248
        # mutter("  export {%s} kind %s to %s", self.file_id,
 
249
        #         self.kind, fullpath)
312
250
 
313
251
    def _put_on_disk(self, fullpath, tree):
314
252
        """Put this entry onto disk at fullpath, from tree tree."""
315
253
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
316
254
 
317
255
    def sorted_children(self):
318
 
        l = self.children.items()
319
 
        l.sort()
320
 
        return l
 
256
        return sorted(self.children.items())
321
257
 
322
258
    @staticmethod
323
259
    def versionable_kind(kind):
324
 
        return kind in ('file', 'directory', 'symlink')
 
260
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
325
261
 
326
262
    def check(self, checker, rev_id, inv, tree):
327
263
        """Check this inventory entry is intact.
337
273
        :param inv: Inventory from which the entry was loaded.
338
274
        :param tree: RevisionTree for this entry.
339
275
        """
340
 
        if self.parent_id != None:
 
276
        if self.parent_id is not None:
341
277
            if not inv.has_id(self.parent_id):
342
278
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
343
279
                        % (self.parent_id, rev_id))
352
288
        """Clone this inventory entry."""
353
289
        raise NotImplementedError
354
290
 
355
 
    def _describe_snapshot_change(self, previous_entries):
356
 
        """Describe how this entry will have changed in a new commit.
357
 
 
358
 
        :param previous_entries: Dictionary from revision_id to inventory entry.
359
 
 
360
 
        :returns: One-word description: "merged", "added", "renamed", "modified".
 
291
    @staticmethod
 
292
    def describe_change(old_entry, new_entry):
 
293
        """Describe the change between old_entry and this.
 
294
        
 
295
        This smells of being an InterInventoryEntry situation, but as its
 
296
        the first one, we're making it a static method for now.
 
297
 
 
298
        An entry with a different parent, or different name is considered 
 
299
        to be renamed. Reparenting is an internal detail.
 
300
        Note that renaming the parent does not trigger a rename for the
 
301
        child entry itself.
361
302
        """
362
 
        # XXX: This assumes that the file *has* changed -- it should probably
363
 
        # be fused with whatever does that detection.  Why not just a single
364
 
        # thing to compare the entries?
365
 
        #
366
 
        # TODO: Return some kind of object describing all the possible
367
 
        # dimensions that can change, not just a string.  That can then give
368
 
        # both old and new names for renames, etc.
369
 
        #
370
 
        if len(previous_entries) > 1:
371
 
            return 'merged'
372
 
        elif len(previous_entries) == 0:
 
303
        # TODO: Perhaps return an object rather than just a string
 
304
        if old_entry is new_entry:
 
305
            # also the case of both being None
 
306
            return 'unchanged'
 
307
        elif old_entry is None:
373
308
            return 'added'
374
 
        the_parent, = previous_entries.values()
375
 
        if self.parent_id != the_parent.parent_id:
376
 
            # actually, moved to another directory
377
 
            return 'renamed'
378
 
        elif self.name != the_parent.name:
379
 
            return 'renamed'
380
 
        return 'modified'
 
309
        elif new_entry is None:
 
310
            return 'removed'
 
311
        if old_entry.kind != new_entry.kind:
 
312
            return 'modified'
 
313
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
314
        if text_modified or meta_modified:
 
315
            modified = True
 
316
        else:
 
317
            modified = False
 
318
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
 
319
        if old_entry.parent_id != new_entry.parent_id:
 
320
            renamed = True
 
321
        elif old_entry.name != new_entry.name:
 
322
            renamed = True
 
323
        else:
 
324
            renamed = False
 
325
        if renamed and not modified:
 
326
            return InventoryEntry.RENAMED
 
327
        if modified and not renamed:
 
328
            return 'modified'
 
329
        if modified and renamed:
 
330
            return InventoryEntry.MODIFIED_AND_RENAMED
 
331
        return 'unchanged'
381
332
 
382
333
    def __repr__(self):
383
 
        return ("%s(%r, %r, parent_id=%r)"
 
334
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
384
335
                % (self.__class__.__name__,
385
336
                   self.file_id,
386
337
                   self.name,
387
 
                   self.parent_id))
388
 
 
389
 
    def snapshot(self, revision, path, previous_entries,
390
 
                 work_tree, weave_store, transaction):
391
 
        """Make a snapshot of this entry which may or may not have changed.
392
 
        
393
 
        This means that all its fields are populated, that it has its
394
 
        text stored in the text store or weave.
395
 
        """
396
 
        mutter('new parents of %s are %r', path, previous_entries)
397
 
        self._read_tree_state(path, work_tree)
398
 
        if len(previous_entries) == 1:
399
 
            # cannot be unchanged unless there is only one parent file rev.
400
 
            parent_ie = previous_entries.values()[0]
401
 
            if self._unchanged(parent_ie):
402
 
                mutter("found unchanged entry")
403
 
                self.revision = parent_ie.revision
404
 
                return "unchanged"
405
 
        return self._snapshot_into_revision(revision, previous_entries, 
406
 
                                            work_tree, weave_store, transaction)
407
 
 
408
 
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
409
 
                                weave_store, transaction):
410
 
        """Record this revision unconditionally into a store.
411
 
 
412
 
        The entry's last-changed revision property (`revision`) is updated to 
413
 
        that of the new revision.
414
 
        
415
 
        :param revision: id of the new revision that is being recorded.
416
 
 
417
 
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
418
 
        """
419
 
        mutter('new revision {%s} for {%s}', revision, self.file_id)
420
 
        self.revision = revision
421
 
        change = self._describe_snapshot_change(previous_entries)
422
 
        self._snapshot_text(previous_entries, work_tree, weave_store,
423
 
                            transaction)
424
 
        return change
425
 
 
426
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
427
 
        """Record the 'text' of this entry, whatever form that takes.
428
 
        
429
 
        This default implementation simply adds an empty text.
430
 
        """
431
 
        mutter('storing file {%s} in revision {%s}',
432
 
               self.file_id, self.revision)
433
 
        self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
 
338
                   self.parent_id,
 
339
                   self.revision))
434
340
 
435
341
    def __eq__(self, other):
436
342
        if not isinstance(other, InventoryEntry):
446
352
                and (self.kind == other.kind)
447
353
                and (self.revision == other.revision)
448
354
                and (self.executable == other.executable)
 
355
                and (self.reference_revision == other.reference_revision)
449
356
                )
450
357
 
451
358
    def __ne__(self, other):
457
364
    def _unchanged(self, previous_ie):
458
365
        """Has this entry changed relative to previous_ie.
459
366
 
460
 
        This method should be overriden in child classes.
 
367
        This method should be overridden in child classes.
461
368
        """
462
369
        compatible = True
463
370
        # different inv parent
466
373
        # renamed
467
374
        elif previous_ie.name != self.name:
468
375
            compatible = False
 
376
        elif previous_ie.kind != self.kind:
 
377
            compatible = False
469
378
        return compatible
470
379
 
471
380
    def _read_tree_state(self, path, work_tree):
485
394
 
486
395
class RootEntry(InventoryEntry):
487
396
 
 
397
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
398
                 'text_id', 'parent_id', 'children', 'executable',
 
399
                 'revision', 'symlink_target', 'reference_revision']
 
400
 
488
401
    def _check(self, checker, rev_id, tree):
489
402
        """See InventoryEntry._check"""
490
403
 
491
404
    def __init__(self, file_id):
492
405
        self.file_id = file_id
493
406
        self.children = {}
494
 
        self.kind = 'root_directory'
 
407
        self.kind = 'directory'
495
408
        self.parent_id = None
496
409
        self.name = u''
 
410
        self.revision = None
 
411
        symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
 
412
                               '  Please use InventoryDirectory instead.',
 
413
                               DeprecationWarning, stacklevel=2)
497
414
 
498
415
    def __eq__(self, other):
499
416
        if not isinstance(other, RootEntry):
506
423
class InventoryDirectory(InventoryEntry):
507
424
    """A directory in an inventory."""
508
425
 
 
426
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
427
                 'text_id', 'parent_id', 'children', 'executable',
 
428
                 'revision', 'symlink_target', 'reference_revision']
 
429
 
509
430
    def _check(self, checker, rev_id, tree):
510
431
        """See InventoryEntry._check"""
511
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
432
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
512
433
            raise BzrCheckError('directory {%s} has text in revision {%s}'
513
434
                                % (self.file_id, rev_id))
514
435
 
545
466
class InventoryFile(InventoryEntry):
546
467
    """A file in an inventory."""
547
468
 
 
469
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
470
                 'text_id', 'parent_id', 'children', 'executable',
 
471
                 'revision', 'symlink_target', 'reference_revision']
 
472
 
548
473
    def _check(self, checker, tree_revision_id, tree):
549
474
        """See InventoryEntry._check"""
550
475
        t = (self.file_id, self.revision)
551
476
        if t in checker.checked_texts:
552
477
            prev_sha = checker.checked_texts[t]
553
478
            if prev_sha != self.text_sha1:
554
 
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
555
 
                                    (self.file_id, tree_revision_id))
 
479
                raise BzrCheckError(
 
480
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
 
481
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
 
482
                     t))
556
483
            else:
557
484
                checker.repeated_text_cnt += 1
558
485
                return
559
486
 
560
487
        if self.file_id not in checker.checked_weaves:
561
488
            mutter('check weave {%s}', self.file_id)
562
 
            w = tree.get_weave(self.file_id)
 
489
            w = tree._get_weave(self.file_id)
563
490
            # Not passing a progress bar, because it creates a new
564
491
            # progress, which overwrites the current progress,
565
492
            # and doesn't look nice
566
493
            w.check()
567
494
            checker.checked_weaves[self.file_id] = True
568
495
        else:
569
 
            w = tree.get_weave(self.file_id)
 
496
            w = tree._get_weave(self.file_id)
570
497
 
571
498
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
572
499
        checker.checked_text_cnt += 1
573
500
        # We can't check the length, because Weave doesn't store that
574
501
        # information, and the whole point of looking at the weave's
575
502
        # sha1sum is that we don't have to extract the text.
576
 
        if self.text_sha1 != w.get_sha1(self.revision):
 
503
        if self.text_sha1 != w.get_sha1s([self.revision])[0]:
577
504
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
578
505
                                % (self.file_id, self.revision))
579
506
        checker.checked_texts[t] = self.text_sha1
589
516
 
590
517
    def detect_changes(self, old_entry):
591
518
        """See InventoryEntry.detect_changes."""
592
 
        assert self.text_sha1 != None
593
 
        assert old_entry.text_sha1 != None
594
519
        text_modified = (self.text_sha1 != old_entry.text_sha1)
595
520
        meta_modified = (self.executable != old_entry.executable)
596
521
        return text_modified, meta_modified
598
523
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
599
524
             output_to, reverse=False):
600
525
        """See InventoryEntry._diff."""
601
 
        from_text = tree.get_file(self.file_id).readlines()
 
526
        from bzrlib.diff import DiffText
 
527
        from_file_id = self.file_id
602
528
        if to_entry:
603
 
            to_text = to_tree.get_file(to_entry.file_id).readlines()
604
 
        else:
605
 
            to_text = []
606
 
        if not reverse:
607
 
            text_diff(from_label, from_text,
608
 
                      to_label, to_text, output_to)
609
 
        else:
610
 
            text_diff(to_label, to_text,
611
 
                      from_label, from_text, output_to)
 
529
            to_file_id = to_entry.file_id
 
530
        else:
 
531
            to_file_id = None
 
532
        if reverse:
 
533
            to_file_id, from_file_id = from_file_id, to_file_id
 
534
            tree, to_tree = to_tree, tree
 
535
            from_label, to_label = to_label, from_label
 
536
        differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
 
537
                          text_diff)
 
538
        return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
612
539
 
613
540
    def has_text(self):
614
541
        """See InventoryEntry.has_text."""
635
562
 
636
563
    def _put_on_disk(self, fullpath, tree):
637
564
        """See InventoryEntry._put_on_disk."""
638
 
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
565
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
639
566
        if tree.is_executable(self.file_id):
640
567
            os.chmod(fullpath, 0755)
641
568
 
642
569
    def _read_tree_state(self, path, work_tree):
643
570
        """See InventoryEntry._read_tree_state."""
644
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
645
 
        self.executable = work_tree.is_executable(self.file_id)
 
571
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
 
572
        # FIXME: 20050930 probe for the text size when getting sha1
 
573
        # in _read_tree_state
 
574
        self.executable = work_tree.is_executable(self.file_id, path=path)
 
575
 
 
576
    def __repr__(self):
 
577
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
 
578
                % (self.__class__.__name__,
 
579
                   self.file_id,
 
580
                   self.name,
 
581
                   self.parent_id,
 
582
                   self.text_sha1,
 
583
                   self.text_size))
646
584
 
647
585
    def _forget_tree_state(self):
648
586
        self.text_sha1 = None
649
 
        self.executable = None
650
 
 
651
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
652
 
        """See InventoryEntry._snapshot_text."""
653
 
        mutter('storing file {%s} in revision {%s}',
654
 
               self.file_id, self.revision)
655
 
        # special case to avoid diffing on renames or 
656
 
        # reparenting
657
 
        if (len(file_parents) == 1
658
 
            and self.text_sha1 == file_parents.values()[0].text_sha1
659
 
            and self.text_size == file_parents.values()[0].text_size):
660
 
            previous_ie = file_parents.values()[0]
661
 
            versionedfile = weave_store.get_weave(self.file_id, transaction)
662
 
            versionedfile.clone_text(self.revision, previous_ie.revision, file_parents.keys())
663
 
        else:
664
 
            new_lines = work_tree.get_file(self.file_id).readlines()
665
 
            self._add_text_to_weave(new_lines, file_parents.keys(), weave_store,
666
 
                                    transaction)
667
 
            self.text_sha1 = sha_strings(new_lines)
668
 
            self.text_size = sum(map(len, new_lines))
669
 
 
670
587
 
671
588
    def _unchanged(self, previous_ie):
672
589
        """See InventoryEntry._unchanged."""
685
602
class InventoryLink(InventoryEntry):
686
603
    """A file in an inventory."""
687
604
 
688
 
    __slots__ = ['symlink_target']
 
605
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
606
                 'text_id', 'parent_id', 'children', 'executable',
 
607
                 'revision', 'symlink_target', 'reference_revision']
689
608
 
690
609
    def _check(self, checker, rev_id, tree):
691
610
        """See InventoryEntry._check"""
692
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
611
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
693
612
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
694
613
                    % (self.file_id, rev_id))
695
 
        if self.symlink_target == None:
 
614
        if self.symlink_target is None:
696
615
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
697
616
                    % (self.file_id, rev_id))
698
617
 
714
633
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
715
634
             output_to, reverse=False):
716
635
        """See InventoryEntry._diff."""
717
 
        from_text = self.symlink_target
 
636
        from bzrlib.diff import DiffSymlink
 
637
        old_target = self.symlink_target
718
638
        if to_entry is not None:
719
 
            to_text = to_entry.symlink_target
720
 
            if reverse:
721
 
                temp = from_text
722
 
                from_text = to_text
723
 
                to_text = temp
724
 
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
725
 
        else:
726
 
            if not reverse:
727
 
                print >>output_to, '=== target was %r' % self.symlink_target
728
 
            else:
729
 
                print >>output_to, '=== target is %r' % self.symlink_target
 
639
            new_target = to_entry.symlink_target
 
640
        else:
 
641
            new_target = None
 
642
        if not reverse:
 
643
            old_tree = tree
 
644
            new_tree = to_tree
 
645
        else:
 
646
            old_tree = to_tree
 
647
            new_tree = tree
 
648
            new_target, old_target = old_target, new_target
 
649
        differ = DiffSymlink(old_tree, new_tree, output_to)
 
650
        return differ.diff_symlink(old_target, new_target)
730
651
 
731
652
    def __init__(self, file_id, name, parent_id):
732
653
        super(InventoryLink, self).__init__(file_id, name, parent_id)
767
688
        return compatible
768
689
 
769
690
 
 
691
class TreeReference(InventoryEntry):
 
692
    
 
693
    kind = 'tree-reference'
 
694
    
 
695
    def __init__(self, file_id, name, parent_id, revision=None,
 
696
                 reference_revision=None):
 
697
        InventoryEntry.__init__(self, file_id, name, parent_id)
 
698
        self.revision = revision
 
699
        self.reference_revision = reference_revision
 
700
 
 
701
    def copy(self):
 
702
        return TreeReference(self.file_id, self.name, self.parent_id,
 
703
                             self.revision, self.reference_revision)
 
704
 
 
705
    def _read_tree_state(self, path, work_tree):
 
706
        """Populate fields in the inventory entry from the given tree.
 
707
        """
 
708
        self.reference_revision = work_tree.get_reference_revision(
 
709
            self.file_id, path)
 
710
 
 
711
    def _forget_tree_state(self):
 
712
        self.reference_revision = None 
 
713
 
 
714
    def _unchanged(self, previous_ie):
 
715
        """See InventoryEntry._unchanged."""
 
716
        compatible = super(TreeReference, self)._unchanged(previous_ie)
 
717
        if self.reference_revision != previous_ie.reference_revision:
 
718
            compatible = False
 
719
        return compatible
 
720
 
 
721
 
770
722
class Inventory(object):
771
723
    """Inventory of versioned files in a tree.
772
724
 
786
738
 
787
739
    >>> inv = Inventory()
788
740
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
789
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
 
741
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
790
742
    >>> inv['123-123'].name
791
743
    'hello.c'
792
744
 
800
752
    May also look up by name:
801
753
 
802
754
    >>> [x[0] for x in inv.iter_entries()]
803
 
    ['hello.c']
 
755
    ['', u'hello.c']
804
756
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
805
757
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
806
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
 
758
    Traceback (most recent call last):
 
759
    BzrError: parent_id {TREE_ROOT} not in inventory
 
760
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
 
761
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
807
762
    """
808
763
    def __init__(self, root_id=ROOT_ID, revision_id=None):
809
764
        """Create or read an inventory.
815
770
        The inventory is created with a default root directory, with
816
771
        an id of None.
817
772
        """
818
 
        # We are letting Branch.create() create a unique inventory
819
 
        # root id. Rather than generating a random one here.
820
 
        #if root_id is None:
821
 
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
822
 
        self.root = RootEntry(root_id)
 
773
        if root_id is not None:
 
774
            self._set_root(InventoryDirectory(root_id, u'', None))
 
775
        else:
 
776
            self.root = None
 
777
            self._byid = {}
823
778
        self.revision_id = revision_id
 
779
 
 
780
    def __repr__(self):
 
781
        return "<Inventory object at %x, contents=%r>" % (id(self), self._byid)
 
782
 
 
783
    def apply_delta(self, delta):
 
784
        """Apply a delta to this inventory.
 
785
 
 
786
        :param delta: A list of changes to apply. After all the changes are
 
787
            applied the final inventory must be internally consistent, but it
 
788
            is ok to supply changes which, if only half-applied would have an
 
789
            invalid result - such as supplying two changes which rename two
 
790
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
 
791
            ('B', 'A', 'B-id', b_entry)].
 
792
 
 
793
            Each change is a tuple, of the form (old_path, new_path, file_id,
 
794
            new_entry).
 
795
            
 
796
            When new_path is None, the change indicates the removal of an entry
 
797
            from the inventory and new_entry will be ignored (using None is
 
798
            appropriate). If new_path is not None, then new_entry must be an
 
799
            InventoryEntry instance, which will be incorporated into the
 
800
            inventory (and replace any existing entry with the same file id).
 
801
            
 
802
            When old_path is None, the change indicates the addition of
 
803
            a new entry to the inventory.
 
804
            
 
805
            When neither new_path nor old_path are None, the change is a
 
806
            modification to an entry, such as a rename, reparent, kind change
 
807
            etc. 
 
808
 
 
809
            The children attribute of new_entry is ignored. This is because
 
810
            this method preserves children automatically across alterations to
 
811
            the parent of the children, and cases where the parent id of a
 
812
            child is changing require the child to be passed in as a separate
 
813
            change regardless. E.g. in the recursive deletion of a directory -
 
814
            the directory's children must be included in the delta, or the
 
815
            final inventory will be invalid.
 
816
        """
 
817
        children = {}
 
818
        # Remove all affected items which were in the original inventory,
 
819
        # starting with the longest paths, thus ensuring parents are examined
 
820
        # after their children, which means that everything we examine has no
 
821
        # modified children remaining by the time we examine it.
 
822
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
 
823
                                        if op is not None), reverse=True):
 
824
            if file_id not in self:
 
825
                # adds come later
 
826
                continue
 
827
            # Preserve unaltered children of file_id for later reinsertion.
 
828
            children[file_id] = getattr(self[file_id], 'children', {})
 
829
            # Remove file_id and the unaltered children. If file_id is not
 
830
            # being deleted it will be reinserted back later.
 
831
            self.remove_recursive_id(file_id)
 
832
        # Insert all affected which should be in the new inventory, reattaching
 
833
        # their children if they had any. This is done from shortest path to
 
834
        # longest, ensuring that items which were modified and whose parents in
 
835
        # the resulting inventory were also modified, are inserted after their
 
836
        # parents.
 
837
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
 
838
                                          delta if np is not None):
 
839
            if new_entry.kind == 'directory':
 
840
                new_entry.children = children.get(new_entry.file_id, {})
 
841
            self.add(new_entry)
 
842
 
 
843
    def _set_root(self, ie):
 
844
        self.root = ie
824
845
        self._byid = {self.root.file_id: self.root}
825
846
 
826
 
 
827
847
    def copy(self):
828
848
        # TODO: jam 20051218 Should copy also copy the revision_id?
829
 
        other = Inventory(self.root.file_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)
830
853
        # copy recursively so we know directories will be added before
831
854
        # their children.  There are more efficient ways than this...
832
 
        for path, entry in self.iter_entries():
833
 
            if entry == self.root:
834
 
                continue
 
855
        for path, entry in entries:
835
856
            other.add(entry.copy())
836
857
        return other
837
858
 
838
 
 
839
859
    def __iter__(self):
840
860
        return iter(self._byid)
841
861
 
842
 
 
843
862
    def __len__(self):
844
863
        """Returns number of entries."""
845
864
        return len(self._byid)
846
865
 
847
 
 
848
866
    def iter_entries(self, from_dir=None):
849
867
        """Return (path, entry) pairs, in order by name."""
850
 
        if from_dir == None:
851
 
            assert self.root
852
 
            from_dir = self.root
853
 
        elif isinstance(from_dir, basestring):
854
 
            from_dir = self._byid[from_dir]
855
 
            
856
 
        kids = from_dir.children.items()
857
 
        kids.sort()
858
 
        for name, ie in kids:
859
 
            yield name, ie
860
 
            if ie.kind == 'directory':
861
 
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
862
 
                    yield pathjoin(name, cn), cie
863
 
 
 
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)
864
986
 
865
987
    def entries(self):
866
988
        """Return list of (path, ie) for all entries except the root.
872
994
            kids = dir_ie.children.items()
873
995
            kids.sort()
874
996
            for name, ie in kids:
875
 
                child_path = pathjoin(dir_path, name)
 
997
                child_path = osutils.pathjoin(dir_path, name)
876
998
                accum.append((child_path, ie))
877
999
                if ie.kind == 'directory':
878
1000
                    descend(ie, child_path)
880
1002
        descend(self.root, u'')
881
1003
        return accum
882
1004
 
883
 
 
884
1005
    def directories(self):
885
1006
        """Return (path, entry) pairs for all directories, including the root.
886
1007
        """
892
1013
            kids.sort()
893
1014
 
894
1015
            for name, child_ie in kids:
895
 
                child_path = pathjoin(parent_path, name)
 
1016
                child_path = osutils.pathjoin(parent_path, name)
896
1017
                descend(child_ie, child_path)
897
1018
        descend(self.root, u'')
898
1019
        return accum
899
1020
        
900
 
 
901
 
 
902
1021
    def __contains__(self, file_id):
903
1022
        """True if this entry contains a file with given id.
904
1023
 
905
1024
        >>> inv = Inventory()
906
1025
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
907
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
1026
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
908
1027
        >>> '123' in inv
909
1028
        True
910
1029
        >>> '456' in inv
911
1030
        False
912
1031
        """
913
 
        return file_id in self._byid
914
 
 
 
1032
        return (file_id in self._byid)
915
1033
 
916
1034
    def __getitem__(self, file_id):
917
1035
        """Return the entry for given file_id.
918
1036
 
919
1037
        >>> inv = Inventory()
920
1038
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
921
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
 
1039
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
922
1040
        >>> inv['123123'].name
923
1041
        'hello.c'
924
1042
        """
925
1043
        try:
926
1044
            return self._byid[file_id]
927
1045
        except KeyError:
928
 
            if file_id == None:
929
 
                raise BzrError("can't look up file_id None")
930
 
            else:
931
 
                raise BzrError("file_id {%s} not in inventory" % file_id)
932
 
 
 
1046
            # really we're passing an inventory, not a tree...
 
1047
            raise errors.NoSuchId(self, file_id)
933
1048
 
934
1049
    def get_file_kind(self, file_id):
935
1050
        return self._byid[file_id].kind
937
1052
    def get_child(self, parent_id, filename):
938
1053
        return self[parent_id].children.get(filename)
939
1054
 
 
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
940
1064
 
941
1065
    def add(self, entry):
942
1066
        """Add entry to inventory.
947
1071
        Returns the new entry object.
948
1072
        """
949
1073
        if entry.file_id in self._byid:
950
 
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
951
 
 
952
 
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
953
 
            entry.parent_id = self.root.file_id
954
 
 
955
 
        try:
956
 
            parent = self._byid[entry.parent_id]
957
 
        except KeyError:
958
 
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
959
 
 
960
 
        if parent.children.has_key(entry.name):
961
 
            raise BzrError("%s is already versioned" %
962
 
                    pathjoin(self.id2path(parent.file_id), entry.name))
963
 
 
964
 
        self._byid[entry.file_id] = entry
965
 
        parent.children[entry.name] = entry
966
 
        return entry
967
 
 
968
 
 
969
 
    def add_path(self, relpath, kind, file_id=None):
 
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):
970
1094
        """Add entry from a path.
971
1095
 
972
1096
        The immediate parent must already be versioned.
973
1097
 
974
1098
        Returns the new entry object."""
975
 
        from bzrlib.workingtree import gen_file_id
976
1099
        
977
 
        parts = bzrlib.osutils.splitpath(relpath)
978
 
 
979
 
        if file_id == None:
980
 
            file_id = gen_file_id(relpath)
 
1100
        parts = osutils.splitpath(relpath)
981
1101
 
982
1102
        if len(parts) == 0:
983
 
            self.root = RootEntry(file_id)
 
1103
            if file_id is None:
 
1104
                file_id = generate_ids.gen_root_id()
 
1105
            self.root = InventoryDirectory(file_id, '', None)
984
1106
            self._byid = {self.root.file_id: self.root}
985
 
            return
 
1107
            return self.root
986
1108
        else:
987
1109
            parent_path = parts[:-1]
988
1110
            parent_id = self.path2id(parent_path)
989
 
            if parent_id == None:
990
 
                raise NotVersionedError(path=parent_path)
991
 
        if kind == 'directory':
992
 
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
993
 
        elif kind == 'file':
994
 
            ie = InventoryFile(file_id, parts[-1], parent_id)
995
 
        elif kind == 'symlink':
996
 
            ie = InventoryLink(file_id, parts[-1], parent_id)
997
 
        else:
998
 
            raise BzrError("unknown kind %r" % kind)
 
1111
            if parent_id is None:
 
1112
                raise errors.NotVersionedError(path=parent_path)
 
1113
        ie = make_entry(kind, parts[-1], parent_id, file_id)
999
1114
        return self.add(ie)
1000
1115
 
1001
 
 
1002
1116
    def __delitem__(self, file_id):
1003
1117
        """Remove entry by id.
1004
1118
 
1005
1119
        >>> inv = Inventory()
1006
1120
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1007
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
1121
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1008
1122
        >>> '123' in inv
1009
1123
        True
1010
1124
        >>> del inv['123']
1012
1126
        False
1013
1127
        """
1014
1128
        ie = self[file_id]
1015
 
 
1016
 
        assert ie.parent_id is None or \
1017
 
            self[ie.parent_id].children[ie.name] == ie
1018
 
        
1019
1129
        del self._byid[file_id]
1020
1130
        if ie.parent_id is not None:
1021
1131
            del self[ie.parent_id].children[ie.name]
1022
1132
 
1023
 
 
1024
1133
    def __eq__(self, other):
1025
1134
        """Compare two sets by comparing their contents.
1026
1135
 
1029
1138
        >>> i1 == i2
1030
1139
        True
1031
1140
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1032
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
1141
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1033
1142
        >>> i1 == i2
1034
1143
        False
1035
1144
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1036
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
1145
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1037
1146
        >>> i1 == i2
1038
1147
        True
1039
1148
        """
1040
1149
        if not isinstance(other, Inventory):
1041
1150
            return NotImplemented
1042
1151
 
1043
 
        if len(self._byid) != len(other._byid):
1044
 
            # shortcut: obviously not the same
1045
 
            return False
1046
 
 
1047
1152
        return self._byid == other._byid
1048
1153
 
1049
 
 
1050
1154
    def __ne__(self, other):
1051
1155
        return not self.__eq__(other)
1052
1156
 
1053
 
 
1054
1157
    def __hash__(self):
1055
1158
        raise ValueError('not hashable')
1056
1159
 
1057
1160
    def _iter_file_id_parents(self, file_id):
1058
1161
        """Yield the parents of file_id up to the root."""
1059
 
        while file_id != None:
 
1162
        while file_id is not None:
1060
1163
            try:
1061
1164
                ie = self._byid[file_id]
1062
1165
            except KeyError:
1063
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1166
                raise errors.NoSuchId(tree=None, file_id=file_id)
1064
1167
            yield ie
1065
1168
            file_id = ie.parent_id
1066
1169
 
1100
1203
        This returns the entry of the last component in the path,
1101
1204
        which may be either a file or a directory.
1102
1205
 
1103
 
        Returns None iff the path is not found.
 
1206
        Returns None IFF the path is not found.
1104
1207
        """
1105
 
        if isinstance(name, types.StringTypes):
1106
 
            name = splitpath(name)
 
1208
        if isinstance(name, basestring):
 
1209
            name = osutils.splitpath(name)
1107
1210
 
1108
 
        mutter("lookup path %r" % name)
 
1211
        # mutter("lookup path %r" % name)
1109
1212
 
1110
1213
        parent = self.root
 
1214
        if parent is None:
 
1215
            return None
1111
1216
        for f in name:
1112
1217
            try:
1113
 
                cie = parent.children[f]
1114
 
                assert cie.name == f
1115
 
                assert cie.parent_id == parent.file_id
 
1218
                children = getattr(parent, 'children', None)
 
1219
                if children is None:
 
1220
                    return None
 
1221
                cie = children[f]
1116
1222
                parent = cie
1117
1223
            except KeyError:
1118
1224
                # or raise an error?
1120
1226
 
1121
1227
        return parent.file_id
1122
1228
 
1123
 
 
1124
1229
    def has_filename(self, names):
1125
1230
        return bool(self.path2id(names))
1126
1231
 
1127
 
 
1128
1232
    def has_id(self, file_id):
1129
 
        return self._byid.has_key(file_id)
 
1233
        return (file_id in self._byid)
1130
1234
 
 
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
1131
1254
 
1132
1255
    def rename(self, file_id, new_parent_id, new_name):
1133
1256
        """Move a file within the inventory.
1134
1257
 
1135
1258
        This can change either the name, or the parent, or both.
1136
1259
 
1137
 
        This does not move the working file."""
 
1260
        This does not move the working file.
 
1261
        """
 
1262
        new_name = ensure_normalized_name(new_name)
1138
1263
        if not is_valid_name(new_name):
1139
1264
            raise BzrError("not an acceptable filename: %r" % new_name)
1140
1265
 
1158
1283
        file_ie.name = new_name
1159
1284
        file_ie.parent_id = new_parent_id
1160
1285
 
1161
 
 
 
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
1162
1335
 
1163
1336
 
1164
1337
_NAME_RE = None
1165
1338
 
1166
1339
def is_valid_name(name):
1167
1340
    global _NAME_RE
1168
 
    if _NAME_RE == None:
 
1341
    if _NAME_RE is None:
1169
1342
        _NAME_RE = re.compile(r'^[^/\\]+$')
1170
1343
        
1171
1344
    return bool(_NAME_RE.match(name))