~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2006-05-30 04:44:48 UTC
  • mto: (1711.2.26 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1734.
  • Revision ID: john@arbash-meinel.com-20060530044448-81612e2e57c3991f
Update documentation and TODO for compare_trees

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
import os
 
30
 
 
31
import collections
 
32
import os.path
31
33
import re
32
34
import sys
33
 
 
34
 
from bzrlib.lazy_import import lazy_import
35
 
lazy_import(globals(), """
36
 
import collections
37
35
import tarfile
 
36
import types
38
37
 
39
38
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
 
39
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
40
                            pathjoin, sha_strings)
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError, BinaryFile)
54
43
from bzrlib.trace import mutter
55
44
 
56
45
 
88
77
    >>> i.path2id('')
89
78
    'TREE_ROOT'
90
79
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
91
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
 
80
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
92
81
    >>> 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'}
 
82
    InventoryFile('2323', 'hello.c', parent_id='123')
 
83
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
95
84
    >>> for ix, j in enumerate(i.iter_entries()):
96
85
    ...   print (j[0] == shouldbe[ix], j[1])
97
86
    ... 
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))
 
87
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
88
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
 
89
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
90
    Traceback (most recent call last):
 
91
    ...
 
92
    BzrError: inventory already contains entry with id {2323}
101
93
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
102
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
 
94
    InventoryFile('2324', 'bye.c', parent_id='123')
103
95
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
104
 
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
 
96
    InventoryDirectory('2325', 'wibble', parent_id='123')
105
97
    >>> i.path2id('src/wibble')
106
98
    '2325'
107
99
    >>> '2325' in i
108
100
    True
109
101
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
110
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
111
103
    >>> i['2326']
112
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
104
    InventoryFile('2326', 'wibble.c', parent_id='2325')
113
105
    >>> for path, entry in i.iter_entries():
114
106
    ...     print path
 
107
    ...     assert i.path2id(path)
115
108
    ... 
116
 
    <BLANKLINE>
117
109
    src
118
110
    src/bye.c
119
111
    src/hello.c
131
123
    RENAMED = 'renamed'
132
124
    MODIFIED_AND_RENAMED = 'modified and renamed'
133
125
    
134
 
    __slots__ = []
 
126
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
127
                 'text_id', 'parent_id', 'children', 'executable', 
 
128
                 'revision']
 
129
 
 
130
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
 
131
        versionedfile = weave_store.get_weave_or_empty(self.file_id,
 
132
                                                       transaction)
 
133
        versionedfile.add_lines(self.revision, parents, new_lines)
 
134
        versionedfile.clear_cache()
135
135
 
136
136
    def detect_changes(self, old_entry):
137
137
        """Return a (text_modified, meta_modified) from this to old_entry.
141
141
        """
142
142
        return False, False
143
143
 
 
144
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
145
             output_to, reverse=False):
 
146
        """Perform a diff from this to to_entry.
 
147
 
 
148
        text_diff will be used for textual difference calculation.
 
149
        This is a template method, override _diff in child classes.
 
150
        """
 
151
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
152
        if to_entry:
 
153
            # cannot diff from one kind to another - you must do a removal
 
154
            # and an addif they do not match.
 
155
            assert self.kind == to_entry.kind
 
156
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
157
                                      to_tree)
 
158
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
159
                   output_to, reverse)
 
160
 
144
161
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
145
162
             output_to, reverse=False):
146
163
        """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.
 
164
 
 
165
    def find_previous_heads(self, previous_inventories,
 
166
                            versioned_file_store,
 
167
                            transaction,
 
168
                            entry_vf=None):
 
169
        """Return the revisions and entries that directly preceed this.
 
170
 
 
171
        Returned as a map from revision to inventory entry.
 
172
 
 
173
        This is a map containing the file revisions in all parents
 
174
        for which the file exists, and its revision is not a parent of
 
175
        any other. If the file is new, the set will be empty.
 
176
 
 
177
        :param versioned_file_store: A store where ancestry data on this
 
178
                                     file id can be queried.
 
179
        :param transaction: The transaction that queries to the versioned 
 
180
                            file store should be completed under.
 
181
        :param entry_vf: The entry versioned file, if its already available.
156
182
        """
 
183
        def get_ancestors(weave, entry):
 
184
            return set(weave.get_ancestry(entry.revision))
157
185
        # revision:ie mapping for each ie found in previous_inventories.
158
186
        candidates = {}
 
187
        # revision:ie mapping with one revision for each head.
 
188
        heads = {}
 
189
        # revision: ancestor list for each head
 
190
        head_ancestors = {}
159
191
        # identify candidate head revision ids.
160
192
        for inv in previous_inventories:
161
193
            if self.file_id in inv:
162
194
                ie = inv[self.file_id]
 
195
                assert ie.file_id == self.file_id
163
196
                if ie.revision in candidates:
164
197
                    # same revision value in two different inventories:
165
198
                    # correct possible inconsistencies:
171
204
                            ie.executable = False
172
205
                    except AttributeError:
173
206
                        pass
 
207
                    # must now be the same.
 
208
                    assert candidates[ie.revision] == ie
174
209
                else:
175
210
                    # add this revision as a candidate.
176
211
                    candidates[ie.revision] = ie
177
 
        return candidates
178
 
 
179
 
    @deprecated_method(deprecated_in((1, 6, 0)))
 
212
 
 
213
        # common case optimisation
 
214
        if len(candidates) == 1:
 
215
            # if there is only one candidate revision found
 
216
            # then we can opening the versioned file to access ancestry:
 
217
            # there cannot be any ancestors to eliminate when there is 
 
218
            # only one revision available.
 
219
            heads[ie.revision] = ie
 
220
            return heads
 
221
 
 
222
        # eliminate ancestors amongst the available candidates:
 
223
        # heads are those that are not an ancestor of any other candidate
 
224
        # - this provides convergence at a per-file level.
 
225
        for ie in candidates.values():
 
226
            # may be an ancestor of a known head:
 
227
            already_present = 0 != len(
 
228
                [head for head in heads 
 
229
                 if ie.revision in head_ancestors[head]])
 
230
            if already_present:
 
231
                # an ancestor of an analyzed candidate.
 
232
                continue
 
233
            # not an ancestor of a known head:
 
234
            # load the versioned file for this file id if needed
 
235
            if entry_vf is None:
 
236
                entry_vf = versioned_file_store.get_weave_or_empty(
 
237
                    self.file_id, transaction)
 
238
            ancestors = get_ancestors(entry_vf, ie)
 
239
            # may knock something else out:
 
240
            check_heads = list(heads.keys())
 
241
            for head in check_heads:
 
242
                if head in ancestors:
 
243
                    # this previously discovered 'head' is not
 
244
                    # really a head - its an ancestor of the newly 
 
245
                    # found head,
 
246
                    heads.pop(head)
 
247
            head_ancestors[ie.revision] = ancestors
 
248
            heads[ie.revision] = ie
 
249
        return heads
 
250
 
180
251
    def get_tar_item(self, root, dp, now, tree):
181
252
        """Get a tarfile item and a file stream for its content."""
182
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
 
253
        item = tarfile.TarInfo(pathjoin(root, dp))
183
254
        # TODO: would be cool to actually set it to the timestamp of the
184
255
        # revision it was last changed
185
256
        item.mtime = now
212
283
        Traceback (most recent call last):
213
284
        InvalidEntryName: Invalid entry name: src/hello.c
214
285
        """
 
286
        assert isinstance(name, basestring), name
215
287
        if '/' in name or '\\' in name:
216
 
            raise errors.InvalidEntryName(name=name)
 
288
            raise InvalidEntryName(name=name)
217
289
        self.executable = False
218
290
        self.revision = None
219
291
        self.text_sha1 = None
223
295
        self.text_id = text_id
224
296
        self.parent_id = parent_id
225
297
        self.symlink_target = None
226
 
        self.reference_revision = None
227
298
 
228
299
    def kind_character(self):
229
300
        """Return a short kind indicator useful for appending to names."""
230
301
        raise BzrError('unknown kind %r' % self.kind)
231
302
 
232
 
    known_kinds = ('file', 'directory', 'symlink')
 
303
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
233
304
 
234
305
    def _put_in_tar(self, item, tree):
235
306
        """populate item for stashing in a tar, and return the content stream.
239
310
        raise BzrError("don't know how to export {%s} of kind %r" %
240
311
                       (self.file_id, self.kind))
241
312
 
242
 
    @deprecated_method(deprecated_in((1, 6, 0)))
243
313
    def put_on_disk(self, dest, dp, tree):
244
314
        """Create a representation of self on disk in the prefix dest.
245
315
        
246
316
        This is a template method - implement _put_on_disk in subclasses.
247
317
        """
248
 
        fullpath = osutils.pathjoin(dest, dp)
 
318
        fullpath = pathjoin(dest, dp)
249
319
        self._put_on_disk(fullpath, tree)
250
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
251
 
        #         self.kind, fullpath)
 
320
        mutter("  export {%s} kind %s to %s", self.file_id,
 
321
                self.kind, fullpath)
252
322
 
253
323
    def _put_on_disk(self, fullpath, tree):
254
324
        """Put this entry onto disk at fullpath, from tree tree."""
255
325
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
256
326
 
257
327
    def sorted_children(self):
258
 
        return sorted(self.children.items())
 
328
        l = self.children.items()
 
329
        l.sort()
 
330
        return l
259
331
 
260
332
    @staticmethod
261
333
    def versionable_kind(kind):
262
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
334
        return kind in ('file', 'directory', 'symlink')
263
335
 
264
336
    def check(self, checker, rev_id, inv, tree):
265
337
        """Check this inventory entry is intact.
275
347
        :param inv: Inventory from which the entry was loaded.
276
348
        :param tree: RevisionTree for this entry.
277
349
        """
278
 
        if self.parent_id is not None:
 
350
        if self.parent_id != None:
279
351
            if not inv.has_id(self.parent_id):
280
352
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
281
353
                        % (self.parent_id, rev_id))
310
382
            return 'added'
311
383
        elif new_entry is None:
312
384
            return 'removed'
313
 
        if old_entry.kind != new_entry.kind:
314
 
            return 'modified'
315
385
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
316
386
        if text_modified or meta_modified:
317
387
            modified = True
333
403
        return 'unchanged'
334
404
 
335
405
    def __repr__(self):
336
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
406
        return ("%s(%r, %r, parent_id=%r)"
337
407
                % (self.__class__.__name__,
338
408
                   self.file_id,
339
409
                   self.name,
340
 
                   self.parent_id,
341
 
                   self.revision))
 
410
                   self.parent_id))
 
411
 
 
412
    def snapshot(self, revision, path, previous_entries,
 
413
                 work_tree, weave_store, transaction):
 
414
        """Make a snapshot of this entry which may or may not have changed.
 
415
        
 
416
        This means that all its fields are populated, that it has its
 
417
        text stored in the text store or weave.
 
418
        """
 
419
        mutter('new parents of %s are %r', path, previous_entries)
 
420
        self._read_tree_state(path, work_tree)
 
421
        if len(previous_entries) == 1:
 
422
            # cannot be unchanged unless there is only one parent file rev.
 
423
            parent_ie = previous_entries.values()[0]
 
424
            if self._unchanged(parent_ie):
 
425
                mutter("found unchanged entry")
 
426
                self.revision = parent_ie.revision
 
427
                return "unchanged"
 
428
        return self._snapshot_into_revision(revision, previous_entries, 
 
429
                                            work_tree, weave_store, transaction)
 
430
 
 
431
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
 
432
                                weave_store, transaction):
 
433
        """Record this revision unconditionally into a store.
 
434
 
 
435
        The entry's last-changed revision property (`revision`) is updated to 
 
436
        that of the new revision.
 
437
        
 
438
        :param revision: id of the new revision that is being recorded.
 
439
 
 
440
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
 
441
        """
 
442
        mutter('new revision {%s} for {%s}', revision, self.file_id)
 
443
        self.revision = revision
 
444
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
445
                            transaction)
 
446
 
 
447
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
448
        """Record the 'text' of this entry, whatever form that takes.
 
449
        
 
450
        This default implementation simply adds an empty text.
 
451
        """
 
452
        mutter('storing file {%s} in revision {%s}',
 
453
               self.file_id, self.revision)
 
454
        self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
342
455
 
343
456
    def __eq__(self, other):
344
457
        if not isinstance(other, InventoryEntry):
354
467
                and (self.kind == other.kind)
355
468
                and (self.revision == other.revision)
356
469
                and (self.executable == other.executable)
357
 
                and (self.reference_revision == other.reference_revision)
358
470
                )
359
471
 
360
472
    def __ne__(self, other):
366
478
    def _unchanged(self, previous_ie):
367
479
        """Has this entry changed relative to previous_ie.
368
480
 
369
 
        This method should be overridden in child classes.
 
481
        This method should be overriden in child classes.
370
482
        """
371
483
        compatible = True
372
484
        # different inv parent
375
487
        # renamed
376
488
        elif previous_ie.name != self.name:
377
489
            compatible = False
378
 
        elif previous_ie.kind != self.kind:
379
 
            compatible = False
380
490
        return compatible
381
491
 
382
492
    def _read_tree_state(self, path, work_tree):
396
506
 
397
507
class RootEntry(InventoryEntry):
398
508
 
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
509
    def _check(self, checker, rev_id, tree):
404
510
        """See InventoryEntry._check"""
405
511
 
406
512
    def __init__(self, file_id):
407
513
        self.file_id = file_id
408
514
        self.children = {}
409
 
        self.kind = 'directory'
 
515
        self.kind = 'root_directory'
410
516
        self.parent_id = None
411
517
        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
518
 
417
519
    def __eq__(self, other):
418
520
        if not isinstance(other, RootEntry):
425
527
class InventoryDirectory(InventoryEntry):
426
528
    """A directory in an inventory."""
427
529
 
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
530
    def _check(self, checker, rev_id, tree):
433
531
        """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:
 
532
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
533
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
534
                                % (self.file_id, rev_id))
437
535
 
468
566
class InventoryFile(InventoryEntry):
469
567
    """A file in an inventory."""
470
568
 
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
569
    def _check(self, checker, tree_revision_id, tree):
476
570
        """See InventoryEntry._check"""
477
 
        key = (self.file_id, self.revision)
478
 
        if key in checker.checked_texts:
479
 
            prev_sha = checker.checked_texts[key]
 
571
        t = (self.file_id, self.revision)
 
572
        if t in checker.checked_texts:
 
573
            prev_sha = checker.checked_texts[t]
480
574
            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))
 
575
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
576
                                    (self.file_id, tree_revision_id))
485
577
            else:
486
578
                checker.repeated_text_cnt += 1
487
579
                return
488
580
 
 
581
        if self.file_id not in checker.checked_weaves:
 
582
            mutter('check weave {%s}', self.file_id)
 
583
            w = tree.get_weave(self.file_id)
 
584
            # Not passing a progress bar, because it creates a new
 
585
            # progress, which overwrites the current progress,
 
586
            # and doesn't look nice
 
587
            w.check()
 
588
            checker.checked_weaves[self.file_id] = True
 
589
        else:
 
590
            w = tree.get_weave(self.file_id)
 
591
 
489
592
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
490
593
        checker.checked_text_cnt += 1
491
594
        # We can't check the length, because Weave doesn't store that
492
595
        # information, and the whole point of looking at the weave's
493
596
        # 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
 
597
        if self.text_sha1 != w.get_sha1(self.revision):
 
598
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
599
                                % (self.file_id, self.revision))
 
600
        checker.checked_texts[t] = self.text_sha1
497
601
 
498
602
    def copy(self):
499
603
        other = InventoryFile(self.file_id, self.name, self.parent_id)
506
610
 
507
611
    def detect_changes(self, old_entry):
508
612
        """See InventoryEntry.detect_changes."""
 
613
        assert self.text_sha1 != None
 
614
        assert old_entry.text_sha1 != None
509
615
        text_modified = (self.text_sha1 != old_entry.text_sha1)
510
616
        meta_modified = (self.executable != old_entry.executable)
511
617
        return text_modified, meta_modified
513
619
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
514
620
             output_to, reverse=False):
515
621
        """See InventoryEntry._diff."""
516
 
        from bzrlib.diff import DiffText
517
 
        from_file_id = self.file_id
518
 
        if to_entry:
519
 
            to_file_id = to_entry.file_id
520
 
        else:
521
 
            to_file_id = None
522
 
        if reverse:
523
 
            to_file_id, from_file_id = from_file_id, to_file_id
524
 
            tree, to_tree = to_tree, tree
525
 
            from_label, to_label = to_label, from_label
526
 
        differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
527
 
                          text_diff)
528
 
        return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
 
622
        try:
 
623
            from_text = tree.get_file(self.file_id).readlines()
 
624
            if to_entry:
 
625
                to_text = to_tree.get_file(to_entry.file_id).readlines()
 
626
            else:
 
627
                to_text = []
 
628
            if not reverse:
 
629
                text_diff(from_label, from_text,
 
630
                          to_label, to_text, output_to)
 
631
            else:
 
632
                text_diff(to_label, to_text,
 
633
                          from_label, from_text, output_to)
 
634
        except BinaryFile:
 
635
            if reverse:
 
636
                label_pair = (to_label, from_label)
 
637
            else:
 
638
                label_pair = (from_label, to_label)
 
639
            print >> output_to, "Binary files %s and %s differ" % label_pair
529
640
 
530
641
    def has_text(self):
531
642
        """See InventoryEntry.has_text."""
552
663
 
553
664
    def _put_on_disk(self, fullpath, tree):
554
665
        """See InventoryEntry._put_on_disk."""
555
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
666
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
556
667
        if tree.is_executable(self.file_id):
557
668
            os.chmod(fullpath, 0755)
558
669
 
559
670
    def _read_tree_state(self, path, work_tree):
560
671
        """See InventoryEntry._read_tree_state."""
561
672
        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
673
        self.executable = work_tree.is_executable(self.file_id, path=path)
565
674
 
566
 
    def __repr__(self):
567
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
568
 
                % (self.__class__.__name__,
569
 
                   self.file_id,
570
 
                   self.name,
571
 
                   self.parent_id,
572
 
                   self.text_sha1,
573
 
                   self.text_size))
574
 
 
575
675
    def _forget_tree_state(self):
576
676
        self.text_sha1 = None
 
677
        self.executable = None
 
678
 
 
679
    def _snapshot_text(self, file_parents, work_tree, versionedfile_store, transaction):
 
680
        """See InventoryEntry._snapshot_text."""
 
681
        mutter('storing text of file {%s} in revision {%s} into %r',
 
682
               self.file_id, self.revision, versionedfile_store)
 
683
        # special case to avoid diffing on renames or 
 
684
        # reparenting
 
685
        if (len(file_parents) == 1
 
686
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
687
            and self.text_size == file_parents.values()[0].text_size):
 
688
            previous_ie = file_parents.values()[0]
 
689
            versionedfile = versionedfile_store.get_weave(self.file_id, transaction)
 
690
            versionedfile.clone_text(self.revision, previous_ie.revision, file_parents.keys())
 
691
        else:
 
692
            new_lines = work_tree.get_file(self.file_id).readlines()
 
693
            self._add_text_to_weave(new_lines, file_parents.keys(), versionedfile_store,
 
694
                                    transaction)
 
695
            self.text_sha1 = sha_strings(new_lines)
 
696
            self.text_size = sum(map(len, new_lines))
 
697
 
577
698
 
578
699
    def _unchanged(self, previous_ie):
579
700
        """See InventoryEntry._unchanged."""
592
713
class InventoryLink(InventoryEntry):
593
714
    """A file in an inventory."""
594
715
 
595
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
596
 
                 'text_id', 'parent_id', 'children', 'executable',
597
 
                 'revision', 'symlink_target', 'reference_revision']
 
716
    __slots__ = ['symlink_target']
598
717
 
599
718
    def _check(self, checker, rev_id, tree):
600
719
        """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:
 
720
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
602
721
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
603
722
                    % (self.file_id, rev_id))
604
 
        if self.symlink_target is None:
 
723
        if self.symlink_target == None:
605
724
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
606
725
                    % (self.file_id, rev_id))
607
726
 
623
742
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
624
743
             output_to, reverse=False):
625
744
        """See InventoryEntry._diff."""
626
 
        from bzrlib.diff import DiffSymlink
627
 
        old_target = self.symlink_target
 
745
        from_text = self.symlink_target
628
746
        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)
 
747
            to_text = to_entry.symlink_target
 
748
            if reverse:
 
749
                temp = from_text
 
750
                from_text = to_text
 
751
                to_text = temp
 
752
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
753
        else:
 
754
            if not reverse:
 
755
                print >>output_to, '=== target was %r' % self.symlink_target
 
756
            else:
 
757
                print >>output_to, '=== target is %r' % self.symlink_target
641
758
 
642
759
    def __init__(self, file_id, name, parent_id):
643
760
        super(InventoryLink, self).__init__(file_id, name, parent_id)
678
795
        return compatible
679
796
 
680
797
 
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
798
class Inventory(object):
713
799
    """Inventory of versioned files in a tree.
714
800
 
728
814
 
729
815
    >>> inv = Inventory()
730
816
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
731
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
817
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
732
818
    >>> inv['123-123'].name
733
819
    'hello.c'
734
820
 
742
828
    May also look up by name:
743
829
 
744
830
    >>> [x[0] for x in inv.iter_entries()]
745
 
    ['', u'hello.c']
 
831
    [u'hello.c']
746
832
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
747
833
    >>> 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)
 
834
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
752
835
    """
753
836
    def __init__(self, root_id=ROOT_ID, revision_id=None):
754
837
        """Create or read an inventory.
760
843
        The inventory is created with a default root directory, with
761
844
        an id of None.
762
845
        """
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 = {}
 
846
        # We are letting Branch.create() create a unique inventory
 
847
        # root id. Rather than generating a random one here.
 
848
        #if root_id is None:
 
849
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
850
        self.root = RootEntry(root_id)
768
851
        self.revision_id = revision_id
769
 
 
770
 
    def __repr__(self):
771
 
        return "<Inventory object at %x, contents=%r>" % (id(self), self._byid)
772
 
 
773
 
    def apply_delta(self, delta):
774
 
        """Apply a delta to this inventory.
775
 
 
776
 
        :param delta: A list of changes to apply. After all the changes are
777
 
            applied the final inventory must be internally consistent, but it
778
 
            is ok to supply changes which, if only half-applied would have an
779
 
            invalid result - such as supplying two changes which rename two
780
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
781
 
            ('B', 'A', 'B-id', b_entry)].
782
 
 
783
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
784
 
            new_entry).
785
 
            
786
 
            When new_path is None, the change indicates the removal of an entry
787
 
            from the inventory and new_entry will be ignored (using None is
788
 
            appropriate). If new_path is not None, then new_entry must be an
789
 
            InventoryEntry instance, which will be incorporated into the
790
 
            inventory (and replace any existing entry with the same file id).
791
 
            
792
 
            When old_path is None, the change indicates the addition of
793
 
            a new entry to the inventory.
794
 
            
795
 
            When neither new_path nor old_path are None, the change is a
796
 
            modification to an entry, such as a rename, reparent, kind change
797
 
            etc. 
798
 
 
799
 
            The children attribute of new_entry is ignored. This is because
800
 
            this method preserves children automatically across alterations to
801
 
            the parent of the children, and cases where the parent id of a
802
 
            child is changing require the child to be passed in as a separate
803
 
            change regardless. E.g. in the recursive deletion of a directory -
804
 
            the directory's children must be included in the delta, or the
805
 
            final inventory will be invalid.
806
 
        """
807
 
        children = {}
808
 
        # Remove all affected items which were in the original inventory,
809
 
        # starting with the longest paths, thus ensuring parents are examined
810
 
        # after their children, which means that everything we examine has no
811
 
        # modified children remaining by the time we examine it.
812
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
813
 
                                        if op is not None), reverse=True):
814
 
            if file_id not in self:
815
 
                # adds come later
816
 
                continue
817
 
            # Preserve unaltered children of file_id for later reinsertion.
818
 
            file_id_children = getattr(self[file_id], 'children', {})
819
 
            if len(file_id_children):
820
 
                children[file_id] = file_id_children
821
 
            # Remove file_id and the unaltered children. If file_id is not
822
 
            # being deleted it will be reinserted back later.
823
 
            self.remove_recursive_id(file_id)
824
 
        # Insert all affected which should be in the new inventory, reattaching
825
 
        # their children if they had any. This is done from shortest path to
826
 
        # longest, ensuring that items which were modified and whose parents in
827
 
        # the resulting inventory were also modified, are inserted after their
828
 
        # parents.
829
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
830
 
                                          delta if np is not None):
831
 
            if new_entry.kind == 'directory':
832
 
                # Pop the child which to allow detection of children whose
833
 
                # parents were deleted and which were not reattached to a new
834
 
                # parent.
835
 
                new_entry.children = children.pop(new_entry.file_id, {})
836
 
            self.add(new_entry)
837
 
        if len(children):
838
 
            # Get the parent id that was deleted
839
 
            parent_id, children = children.popitem()
840
 
            raise errors.InconsistentDelta("<deleted>", parent_id,
841
 
                "The file id was deleted but its children were not deleted.")
842
 
 
843
 
    def _set_root(self, ie):
844
 
        self.root = ie
845
852
        self._byid = {self.root.file_id: self.root}
846
853
 
 
854
 
847
855
    def copy(self):
848
856
        # 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
 
857
        other = Inventory(self.root.file_id)
854
858
        # copy recursively so we know directories will be added before
855
859
        # their children.  There are more efficient ways than this...
856
 
        for path, entry in entries:
 
860
        for path, entry in self.iter_entries():
 
861
            if entry == self.root:
 
862
                continue
857
863
            other.add(entry.copy())
858
864
        return other
859
865
 
 
866
 
860
867
    def __iter__(self):
861
868
        return iter(self._byid)
862
869
 
 
870
 
863
871
    def __len__(self):
864
872
        """Returns number of entries."""
865
873
        return len(self._byid)
866
874
 
 
875
 
867
876
    def iter_entries(self, from_dir=None):
868
877
        """Return (path, entry) pairs, in order by name."""
869
 
        if from_dir is None:
870
 
            if self.root is None:
871
 
                return
 
878
        if from_dir == None:
 
879
            assert self.root
872
880
            from_dir = self.root
873
 
            yield '', self.root
874
881
        elif isinstance(from_dir, basestring):
875
882
            from_dir = self._byid[from_dir]
876
883
            
908
915
                # if we finished all children, pop it off the stack
909
916
                stack.pop()
910
917
 
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)
987
 
 
988
918
    def entries(self):
989
919
        """Return list of (path, ie) for all entries except the root.
990
920
 
995
925
            kids = dir_ie.children.items()
996
926
            kids.sort()
997
927
            for name, ie in kids:
998
 
                child_path = osutils.pathjoin(dir_path, name)
 
928
                child_path = pathjoin(dir_path, name)
999
929
                accum.append((child_path, ie))
1000
930
                if ie.kind == 'directory':
1001
931
                    descend(ie, child_path)
1003
933
        descend(self.root, u'')
1004
934
        return accum
1005
935
 
 
936
 
1006
937
    def directories(self):
1007
938
        """Return (path, entry) pairs for all directories, including the root.
1008
939
        """
1014
945
            kids.sort()
1015
946
 
1016
947
            for name, child_ie in kids:
1017
 
                child_path = osutils.pathjoin(parent_path, name)
 
948
                child_path = pathjoin(parent_path, name)
1018
949
                descend(child_ie, child_path)
1019
950
        descend(self.root, u'')
1020
951
        return accum
1021
952
        
 
953
 
 
954
 
1022
955
    def __contains__(self, file_id):
1023
956
        """True if this entry contains a file with given id.
1024
957
 
1025
958
        >>> inv = Inventory()
1026
959
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1027
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
960
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1028
961
        >>> '123' in inv
1029
962
        True
1030
963
        >>> '456' in inv
1031
964
        False
1032
965
        """
1033
 
        return (file_id in self._byid)
 
966
        return file_id in self._byid
 
967
 
1034
968
 
1035
969
    def __getitem__(self, file_id):
1036
970
        """Return the entry for given file_id.
1037
971
 
1038
972
        >>> inv = Inventory()
1039
973
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1040
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
974
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1041
975
        >>> inv['123123'].name
1042
976
        'hello.c'
1043
977
        """
1044
978
        try:
1045
979
            return self._byid[file_id]
1046
980
        except KeyError:
1047
 
            # really we're passing an inventory, not a tree...
1048
 
            raise errors.NoSuchId(self, file_id)
 
981
            if file_id == None:
 
982
                raise BzrError("can't look up file_id None")
 
983
            else:
 
984
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
985
 
1049
986
 
1050
987
    def get_file_kind(self, file_id):
1051
988
        return self._byid[file_id].kind
1053
990
    def get_child(self, parent_id, filename):
1054
991
        return self[parent_id].children.get(filename)
1055
992
 
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
993
 
1066
994
    def add(self, entry):
1067
995
        """Add entry to inventory.
1072
1000
        Returns the new entry object.
1073
1001
        """
1074
1002
        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)
 
1003
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
1004
 
 
1005
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
1006
            entry.parent_id = self.root.file_id
 
1007
 
 
1008
        try:
 
1009
            parent = self._byid[entry.parent_id]
 
1010
        except KeyError:
 
1011
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
1012
 
 
1013
        if parent.children.has_key(entry.name):
 
1014
            raise BzrError("%s is already versioned" %
 
1015
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
1016
 
 
1017
        self._byid[entry.file_id] = entry
 
1018
        parent.children[entry.name] = entry
 
1019
        return entry
 
1020
 
1093
1021
 
1094
1022
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
1095
1023
        """Add entry from a path.
1098
1026
 
1099
1027
        Returns the new entry object."""
1100
1028
        
1101
 
        parts = osutils.splitpath(relpath)
 
1029
        parts = bzrlib.osutils.splitpath(relpath)
1102
1030
 
1103
1031
        if len(parts) == 0:
1104
1032
            if file_id is None:
1105
 
                file_id = generate_ids.gen_root_id()
1106
 
            self.root = InventoryDirectory(file_id, '', None)
 
1033
                file_id = bzrlib.workingtree.gen_root_id()
 
1034
            self.root = RootEntry(file_id)
1107
1035
            self._byid = {self.root.file_id: self.root}
1108
 
            return self.root
 
1036
            return
1109
1037
        else:
1110
1038
            parent_path = parts[:-1]
1111
1039
            parent_id = self.path2id(parent_path)
1112
 
            if parent_id is None:
1113
 
                raise errors.NotVersionedError(path=parent_path)
 
1040
            if parent_id == None:
 
1041
                raise NotVersionedError(path=parent_path)
1114
1042
        ie = make_entry(kind, parts[-1], parent_id, file_id)
1115
1043
        return self.add(ie)
1116
1044
 
1119
1047
 
1120
1048
        >>> inv = Inventory()
1121
1049
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1122
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
1050
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1123
1051
        >>> '123' in inv
1124
1052
        True
1125
1053
        >>> del inv['123']
1127
1055
        False
1128
1056
        """
1129
1057
        ie = self[file_id]
 
1058
 
 
1059
        assert ie.parent_id is None or \
 
1060
            self[ie.parent_id].children[ie.name] == ie
 
1061
        
1130
1062
        del self._byid[file_id]
1131
1063
        if ie.parent_id is not None:
1132
1064
            del self[ie.parent_id].children[ie.name]
1133
1065
 
 
1066
 
1134
1067
    def __eq__(self, other):
1135
1068
        """Compare two sets by comparing their contents.
1136
1069
 
1139
1072
        >>> i1 == i2
1140
1073
        True
1141
1074
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1142
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1075
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1143
1076
        >>> i1 == i2
1144
1077
        False
1145
1078
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1146
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
1079
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1147
1080
        >>> i1 == i2
1148
1081
        True
1149
1082
        """
1150
1083
        if not isinstance(other, Inventory):
1151
1084
            return NotImplemented
1152
1085
 
 
1086
        if len(self._byid) != len(other._byid):
 
1087
            # shortcut: obviously not the same
 
1088
            return False
 
1089
 
1153
1090
        return self._byid == other._byid
1154
1091
 
 
1092
 
1155
1093
    def __ne__(self, other):
1156
1094
        return not self.__eq__(other)
1157
1095
 
 
1096
 
1158
1097
    def __hash__(self):
1159
1098
        raise ValueError('not hashable')
1160
1099
 
1161
1100
    def _iter_file_id_parents(self, file_id):
1162
1101
        """Yield the parents of file_id up to the root."""
1163
 
        while file_id is not None:
 
1102
        while file_id != None:
1164
1103
            try:
1165
1104
                ie = self._byid[file_id]
1166
1105
            except KeyError:
1167
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
 
1106
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1168
1107
            yield ie
1169
1108
            file_id = ie.parent_id
1170
1109
 
1206
1145
 
1207
1146
        Returns None IFF the path is not found.
1208
1147
        """
1209
 
        if isinstance(name, basestring):
1210
 
            name = osutils.splitpath(name)
 
1148
        if isinstance(name, types.StringTypes):
 
1149
            name = splitpath(name)
1211
1150
 
1212
1151
        # mutter("lookup path %r" % name)
1213
1152
 
1214
1153
        parent = self.root
1215
 
        if parent is None:
1216
 
            return None
1217
1154
        for f in name:
1218
1155
            try:
1219
 
                children = getattr(parent, 'children', None)
1220
 
                if children is None:
1221
 
                    return None
1222
 
                cie = children[f]
 
1156
                cie = parent.children[f]
 
1157
                assert cie.name == f
 
1158
                assert cie.parent_id == parent.file_id
1223
1159
                parent = cie
1224
1160
            except KeyError:
1225
1161
                # or raise an error?
1227
1163
 
1228
1164
        return parent.file_id
1229
1165
 
 
1166
 
1230
1167
    def has_filename(self, names):
1231
1168
        return bool(self.path2id(names))
1232
1169
 
 
1170
 
1233
1171
    def has_id(self, file_id):
1234
 
        return (file_id in self._byid)
 
1172
        return self._byid.has_key(file_id)
1235
1173
 
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
1174
 
1256
1175
    def rename(self, file_id, new_parent_id, new_name):
1257
1176
        """Move a file within the inventory.
1258
1177
 
1259
1178
        This can change either the name, or the parent, or both.
1260
1179
 
1261
 
        This does not move the working file.
1262
 
        """
1263
 
        new_name = ensure_normalized_name(new_name)
 
1180
        This does not move the working file."""
1264
1181
        if not is_valid_name(new_name):
1265
1182
            raise BzrError("not an acceptable filename: %r" % new_name)
1266
1183
 
1284
1201
        file_ie.name = new_name
1285
1202
        file_ie.parent_id = new_parent_id
1286
1203
 
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
1204
 
1298
1205
def make_entry(kind, name, parent_id, file_id=None):
1299
1206
    """Create an inventory entry.
1304
1211
    :param file_id: the file_id to use. if None, one will be created.
1305
1212
    """
1306
1213
    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:
 
1214
        file_id = bzrlib.workingtree.gen_file_id(name)
 
1215
    if kind == 'directory':
 
1216
        return InventoryDirectory(file_id, name, parent_id)
 
1217
    elif kind == 'file':
 
1218
        return InventoryFile(file_id, name, parent_id)
 
1219
    elif kind == 'symlink':
 
1220
        return InventoryLink(file_id, name, parent_id)
 
1221
    else:
1312
1222
        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
 
1223
 
1336
1224
 
1337
1225
 
1338
1226
_NAME_RE = None
1339
1227
 
1340
1228
def is_valid_name(name):
1341
1229
    global _NAME_RE
1342
 
    if _NAME_RE is None:
 
1230
    if _NAME_RE == None:
1343
1231
        _NAME_RE = re.compile(r'^[^/\\]+$')
1344
1232
        
1345
1233
    return bool(_NAME_RE.match(name))