~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-26 22:14:42 UTC
  • mto: This revision was merged to the branch mainline in revision 3747.
  • Revision ID: john@arbash-meinel.com-20080926221442-3r67j99sr9rwe9w0
Make message optional, don't check the memory flag directly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
50
50
    BzrCheckError,
51
51
    BzrError,
52
52
    )
 
53
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
53
54
from bzrlib.trace import mutter
54
55
 
55
56
 
111
112
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
112
113
    >>> for path, entry in i.iter_entries():
113
114
    ...     print path
114
 
    ...     assert i.path2id(path)
115
115
    ... 
116
116
    <BLANKLINE>
117
117
    src
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
 
 
161
144
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
162
145
             output_to, reverse=False):
163
146
        """Perform a diff between two entries of the same kind."""
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 precede 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.
 
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.
182
156
        """
183
 
        def get_ancestors(weave, entry):
184
 
            return set(weave.get_ancestry(entry.revision, topo_sorted=False))
185
157
        # revision:ie mapping for each ie found in previous_inventories.
186
158
        candidates = {}
187
 
        # revision:ie mapping with one revision for each head.
188
 
        heads = {}
189
 
        # revision: ancestor list for each head
190
 
        head_ancestors = {}
191
159
        # identify candidate head revision ids.
192
160
        for inv in previous_inventories:
193
161
            if self.file_id in inv:
194
162
                ie = inv[self.file_id]
195
 
                assert ie.file_id == self.file_id
196
 
                if ie.kind != self.kind:
197
 
                    # Can't be a candidate if the kind has changed.
198
 
                    continue
199
163
                if ie.revision in candidates:
200
164
                    # same revision value in two different inventories:
201
165
                    # correct possible inconsistencies:
207
171
                            ie.executable = False
208
172
                    except AttributeError:
209
173
                        pass
210
 
                    # must now be the same.
211
 
                    assert candidates[ie.revision] == ie
212
174
                else:
213
175
                    # add this revision as a candidate.
214
176
                    candidates[ie.revision] = ie
215
 
 
216
 
        # common case optimisation
217
 
        if len(candidates) == 1:
218
 
            # if there is only one candidate revision found
219
 
            # then we can opening the versioned file to access ancestry:
220
 
            # there cannot be any ancestors to eliminate when there is 
221
 
            # only one revision available.
222
 
            heads[ie.revision] = ie
223
 
            return heads
224
 
 
225
 
        # eliminate ancestors amongst the available candidates:
226
 
        # heads are those that are not an ancestor of any other candidate
227
 
        # - this provides convergence at a per-file level.
228
 
        for ie in candidates.values():
229
 
            # may be an ancestor of a known head:
230
 
            already_present = 0 != len(
231
 
                [head for head in heads 
232
 
                 if ie.revision in head_ancestors[head]])
233
 
            if already_present:
234
 
                # an ancestor of an analyzed candidate.
235
 
                continue
236
 
            # not an ancestor of a known head:
237
 
            # load the versioned file for this file id if needed
238
 
            if entry_vf is None:
239
 
                entry_vf = versioned_file_store.get_weave_or_empty(
240
 
                    self.file_id, transaction)
241
 
            ancestors = get_ancestors(entry_vf, ie)
242
 
            # may knock something else out:
243
 
            check_heads = list(heads.keys())
244
 
            for head in check_heads:
245
 
                if head in ancestors:
246
 
                    # this previously discovered 'head' is not
247
 
                    # really a head - its an ancestor of the newly 
248
 
                    # found head,
249
 
                    heads.pop(head)
250
 
            head_ancestors[ie.revision] = ancestors
251
 
            heads[ie.revision] = ie
252
 
        return heads
253
 
 
 
177
        return candidates
 
178
 
 
179
    @deprecated_method(deprecated_in((1, 6, 0)))
254
180
    def get_tar_item(self, root, dp, now, tree):
255
181
        """Get a tarfile item and a file stream for its content."""
256
182
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
286
212
        Traceback (most recent call last):
287
213
        InvalidEntryName: Invalid entry name: src/hello.c
288
214
        """
289
 
        assert isinstance(name, basestring), name
290
215
        if '/' in name or '\\' in name:
291
216
            raise errors.InvalidEntryName(name=name)
292
217
        self.executable = False
294
219
        self.text_sha1 = None
295
220
        self.text_size = None
296
221
        self.file_id = file_id
297
 
        assert isinstance(file_id, (str, None.__class__)), \
298
 
            'bad type %r for %r' % (type(file_id), file_id)
299
222
        self.name = name
300
223
        self.text_id = text_id
301
224
        self.parent_id = parent_id
316
239
        raise BzrError("don't know how to export {%s} of kind %r" %
317
240
                       (self.file_id, self.kind))
318
241
 
 
242
    @deprecated_method(deprecated_in((1, 6, 0)))
319
243
    def put_on_disk(self, dest, dp, tree):
320
244
        """Create a representation of self on disk in the prefix dest.
321
245
        
416
340
                   self.parent_id,
417
341
                   self.revision))
418
342
 
419
 
    def snapshot(self, revision, path, previous_entries,
420
 
                 work_tree, commit_builder):
421
 
        """Make a snapshot of this entry which may or may not have changed.
422
 
        
423
 
        This means that all its fields are populated, that it has its
424
 
        text stored in the text store or weave.
425
 
        """
426
 
        # mutter('new parents of %s are %r', path, previous_entries)
427
 
        self._read_tree_state(path, work_tree)
428
 
        # TODO: Where should we determine whether to reuse a
429
 
        # previous revision id or create a new revision? 20060606
430
 
        if len(previous_entries) == 1:
431
 
            # cannot be unchanged unless there is only one parent file rev.
432
 
            parent_ie = previous_entries.values()[0]
433
 
            if self._unchanged(parent_ie):
434
 
                # mutter("found unchanged entry")
435
 
                self.revision = parent_ie.revision
436
 
                return "unchanged"
437
 
        return self._snapshot_into_revision(revision, previous_entries, 
438
 
                                            work_tree, commit_builder)
439
 
 
440
 
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
441
 
                                commit_builder):
442
 
        """Record this revision unconditionally into a store.
443
 
 
444
 
        The entry's last-changed revision property (`revision`) is updated to 
445
 
        that of the new revision.
446
 
        
447
 
        :param revision: id of the new revision that is being recorded.
448
 
 
449
 
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
450
 
        """
451
 
        # mutter('new revision {%s} for {%s}', revision, self.file_id)
452
 
        self.revision = revision
453
 
        self._snapshot_text(previous_entries, work_tree, commit_builder)
454
 
 
455
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
456
 
        """Record the 'text' of this entry, whatever form that takes.
457
 
        
458
 
        This default implementation simply adds an empty text.
459
 
        """
460
 
        raise NotImplementedError(self._snapshot_text)
461
 
 
462
343
    def __eq__(self, other):
463
344
        if not isinstance(other, InventoryEntry):
464
345
            return NotImplemented
583
464
        """See InventoryEntry._put_on_disk."""
584
465
        os.mkdir(fullpath)
585
466
 
586
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
587
 
        """See InventoryEntry._snapshot_text."""
588
 
        commit_builder.modified_directory(self.file_id, file_parents)
589
 
 
590
467
 
591
468
class InventoryFile(InventoryEntry):
592
469
    """A file in an inventory."""
597
474
 
598
475
    def _check(self, checker, tree_revision_id, tree):
599
476
        """See InventoryEntry._check"""
600
 
        t = (self.file_id, self.revision)
601
 
        if t in checker.checked_texts:
602
 
            prev_sha = checker.checked_texts[t]
 
477
        key = (self.file_id, self.revision)
 
478
        if key in checker.checked_texts:
 
479
            prev_sha = checker.checked_texts[key]
603
480
            if prev_sha != self.text_sha1:
604
 
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
605
 
                                    (self.file_id, tree_revision_id))
 
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))
606
485
            else:
607
486
                checker.repeated_text_cnt += 1
608
487
                return
609
488
 
610
 
        if self.file_id not in checker.checked_weaves:
611
 
            mutter('check weave {%s}', self.file_id)
612
 
            w = tree.get_weave(self.file_id)
613
 
            # Not passing a progress bar, because it creates a new
614
 
            # progress, which overwrites the current progress,
615
 
            # and doesn't look nice
616
 
            w.check()
617
 
            checker.checked_weaves[self.file_id] = True
618
 
        else:
619
 
            w = tree.get_weave(self.file_id)
620
 
 
621
489
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
622
490
        checker.checked_text_cnt += 1
623
491
        # We can't check the length, because Weave doesn't store that
624
492
        # information, and the whole point of looking at the weave's
625
493
        # sha1sum is that we don't have to extract the text.
626
 
        if self.text_sha1 != w.get_sha1(self.revision):
627
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
628
 
                                % (self.file_id, self.revision))
629
 
        checker.checked_texts[t] = self.text_sha1
 
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
630
497
 
631
498
    def copy(self):
632
499
        other = InventoryFile(self.file_id, self.name, self.parent_id)
639
506
 
640
507
    def detect_changes(self, old_entry):
641
508
        """See InventoryEntry.detect_changes."""
642
 
        assert self.text_sha1 is not None
643
 
        assert old_entry.text_sha1 is not None
644
509
        text_modified = (self.text_sha1 != old_entry.text_sha1)
645
510
        meta_modified = (self.executable != old_entry.executable)
646
511
        return text_modified, meta_modified
648
513
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
649
514
             output_to, reverse=False):
650
515
        """See InventoryEntry._diff."""
651
 
        try:
652
 
            from_text = tree.get_file(self.file_id).readlines()
653
 
            if to_entry:
654
 
                to_text = to_tree.get_file(to_entry.file_id).readlines()
655
 
            else:
656
 
                to_text = []
657
 
            if not reverse:
658
 
                text_diff(from_label, from_text,
659
 
                          to_label, to_text, output_to)
660
 
            else:
661
 
                text_diff(to_label, to_text,
662
 
                          from_label, from_text, output_to)
663
 
        except errors.BinaryFile:
664
 
            if reverse:
665
 
                label_pair = (to_label, from_label)
666
 
            else:
667
 
                label_pair = (from_label, to_label)
668
 
            print >> output_to, "Binary files %s and %s differ" % label_pair
 
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)
669
529
 
670
530
    def has_text(self):
671
531
        """See InventoryEntry.has_text."""
715
575
    def _forget_tree_state(self):
716
576
        self.text_sha1 = None
717
577
 
718
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
719
 
        """See InventoryEntry._snapshot_text."""
720
 
        def get_content_byte_lines():
721
 
            return work_tree.get_file(self.file_id).readlines()
722
 
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
723
 
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
724
 
 
725
578
    def _unchanged(self, previous_ie):
726
579
        """See InventoryEntry._unchanged."""
727
580
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
770
623
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
771
624
             output_to, reverse=False):
772
625
        """See InventoryEntry._diff."""
773
 
        from_text = self.symlink_target
 
626
        from bzrlib.diff import DiffSymlink
 
627
        old_target = self.symlink_target
774
628
        if to_entry is not None:
775
 
            to_text = to_entry.symlink_target
776
 
            if reverse:
777
 
                temp = from_text
778
 
                from_text = to_text
779
 
                to_text = temp
780
 
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
781
 
        else:
782
 
            if not reverse:
783
 
                print >>output_to, '=== target was %r' % self.symlink_target
784
 
            else:
785
 
                print >>output_to, '=== target is %r' % self.symlink_target
 
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)
786
641
 
787
642
    def __init__(self, file_id, name, parent_id):
788
643
        super(InventoryLink, self).__init__(file_id, name, parent_id)
822
677
            compatible = False
823
678
        return compatible
824
679
 
825
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
826
 
        """See InventoryEntry._snapshot_text."""
827
 
        commit_builder.modified_link(
828
 
            self.file_id, file_parents, self.symlink_target)
829
 
 
830
680
 
831
681
class TreeReference(InventoryEntry):
832
682
    
842
692
        return TreeReference(self.file_id, self.name, self.parent_id,
843
693
                             self.revision, self.reference_revision)
844
694
 
845
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
846
 
        commit_builder.modified_reference(self.file_id, file_parents)
847
 
 
848
695
    def _read_tree_state(self, path, work_tree):
849
696
        """Populate fields in the inventory entry from the given tree.
850
697
        """
854
701
    def _forget_tree_state(self):
855
702
        self.reference_revision = None 
856
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
 
857
711
 
858
712
class Inventory(object):
859
713
    """Inventory of versioned files in a tree.
907
761
        an id of None.
908
762
        """
909
763
        if root_id is not None:
910
 
            assert root_id.__class__ == str
911
764
            self._set_root(InventoryDirectory(root_id, u'', None))
912
765
        else:
913
766
            self.root = None
914
767
            self._byid = {}
915
768
        self.revision_id = revision_id
916
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
 
917
843
    def _set_root(self, ie):
918
844
        self.root = ie
919
845
        self._byid = {self.root.file_id: self.root}
921
847
    def copy(self):
922
848
        # TODO: jam 20051218 Should copy also copy the revision_id?
923
849
        entries = self.iter_entries()
 
850
        if self.root is None:
 
851
            return Inventory(root_id=None)
924
852
        other = Inventory(entries.next()[1].file_id)
 
853
        other.root.revision = self.root.revision
925
854
        # copy recursively so we know directories will be added before
926
855
        # their children.  There are more efficient ways than this...
927
 
        for path, entry in entries():
 
856
        for path, entry in entries:
928
857
            other.add(entry.copy())
929
858
        return other
930
859
 
979
908
                # if we finished all children, pop it off the stack
980
909
                stack.pop()
981
910
 
982
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
 
911
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
 
912
        yield_parents=False):
983
913
        """Iterate over the entries in a directory first order.
984
914
 
985
915
        This returns all entries for a directory before returning
987
917
        lexicographically sorted order, and is a hybrid between
988
918
        depth-first and breadth-first.
989
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.
990
923
        :return: This yields (path, entry) pairs
991
924
        """
992
 
        if specific_file_ids:
993
 
            safe = osutils.safe_file_id
994
 
            specific_file_ids = set(safe(fid) for fid in specific_file_ids)
 
925
        if specific_file_ids and not isinstance(specific_file_ids, set):
 
926
            specific_file_ids = set(specific_file_ids)
995
927
        # TODO? Perhaps this should return the from_dir so that the root is
996
928
        # yielded? or maybe an option?
997
929
        if from_dir is None:
998
930
            if self.root is None:
999
931
                return
1000
932
            # Optimize a common case
1001
 
            if specific_file_ids is not None and len(specific_file_ids) == 1:
 
933
            if (not yield_parents and specific_file_ids is not None and
 
934
                len(specific_file_ids) == 1):
1002
935
                file_id = list(specific_file_ids)[0]
1003
936
                if file_id in self:
1004
937
                    yield self.id2path(file_id), self[file_id]
1005
938
                return 
1006
939
            from_dir = self.root
1007
 
            if (specific_file_ids is None or 
 
940
            if (specific_file_ids is None or yield_parents or
1008
941
                self.root.file_id in specific_file_ids):
1009
942
                yield u'', self.root
1010
943
        elif isinstance(from_dir, basestring):
1039
972
                child_relpath = cur_relpath + child_name
1040
973
 
1041
974
                if (specific_file_ids is None or 
1042
 
                    child_ie.file_id in specific_file_ids):
 
975
                    child_ie.file_id in specific_file_ids or
 
976
                    (yield_parents and child_ie.file_id in parents)):
1043
977
                    yield child_relpath, child_ie
1044
978
 
1045
979
                if child_ie.kind == 'directory':
1096
1030
        >>> '456' in inv
1097
1031
        False
1098
1032
        """
1099
 
        file_id = osutils.safe_file_id(file_id)
1100
1033
        return (file_id in self._byid)
1101
1034
 
1102
1035
    def __getitem__(self, file_id):
1108
1041
        >>> inv['123123'].name
1109
1042
        'hello.c'
1110
1043
        """
1111
 
        file_id = osutils.safe_file_id(file_id)
1112
1044
        try:
1113
1045
            return self._byid[file_id]
1114
1046
        except KeyError:
1116
1048
            raise errors.NoSuchId(self, file_id)
1117
1049
 
1118
1050
    def get_file_kind(self, file_id):
1119
 
        file_id = osutils.safe_file_id(file_id)
1120
1051
        return self._byid[file_id].kind
1121
1052
 
1122
1053
    def get_child(self, parent_id, filename):
1123
 
        parent_id = osutils.safe_file_id(parent_id)
1124
1054
        return self[parent_id].children.get(filename)
1125
1055
 
1126
1056
    def _add_child(self, entry):
1146
1076
                                         self._byid[entry.file_id])
1147
1077
 
1148
1078
        if entry.parent_id is None:
1149
 
            assert self.root is None and len(self._byid) == 0
1150
1079
            self.root = entry
1151
1080
        else:
1152
1081
            try:
1174
1103
        if len(parts) == 0:
1175
1104
            if file_id is None:
1176
1105
                file_id = generate_ids.gen_root_id()
1177
 
            else:
1178
 
                file_id = osutils.safe_file_id(file_id)
1179
1106
            self.root = InventoryDirectory(file_id, '', None)
1180
1107
            self._byid = {self.root.file_id: self.root}
1181
1108
            return self.root
1199
1126
        >>> '123' in inv
1200
1127
        False
1201
1128
        """
1202
 
        file_id = osutils.safe_file_id(file_id)
1203
1129
        ie = self[file_id]
1204
 
 
1205
 
        assert ie.parent_id is None or \
1206
 
            self[ie.parent_id].children[ie.name] == ie
1207
 
        
1208
1130
        del self._byid[file_id]
1209
1131
        if ie.parent_id is not None:
1210
1132
            del self[ie.parent_id].children[ie.name]
1238
1160
 
1239
1161
    def _iter_file_id_parents(self, file_id):
1240
1162
        """Yield the parents of file_id up to the root."""
1241
 
        file_id = osutils.safe_file_id(file_id)
1242
1163
        while file_id is not None:
1243
1164
            try:
1244
1165
                ie = self._byid[file_id]
1255
1176
        is equal to the depth of the file in the tree, counting the
1256
1177
        root directory as depth 1.
1257
1178
        """
1258
 
        file_id = osutils.safe_file_id(file_id)
1259
1179
        p = []
1260
1180
        for parent in self._iter_file_id_parents(file_id):
1261
1181
            p.insert(0, parent.file_id)
1270
1190
        >>> print i.id2path('foo-id')
1271
1191
        src/foo.c
1272
1192
        """
1273
 
        file_id = osutils.safe_file_id(file_id)
1274
1193
        # get all names, skipping root
1275
1194
        return '/'.join(reversed(
1276
1195
            [parent.name for parent in 
1301
1220
                if children is None:
1302
1221
                    return None
1303
1222
                cie = children[f]
1304
 
                assert cie.name == f
1305
 
                assert cie.parent_id == parent.file_id
1306
1223
                parent = cie
1307
1224
            except KeyError:
1308
1225
                # or raise an error?
1314
1231
        return bool(self.path2id(names))
1315
1232
 
1316
1233
    def has_id(self, file_id):
1317
 
        file_id = osutils.safe_file_id(file_id)
1318
1234
        return (file_id in self._byid)
1319
1235
 
1320
1236
    def remove_recursive_id(self, file_id):
1322
1238
        
1323
1239
        :param file_id: A file_id to remove.
1324
1240
        """
1325
 
        file_id = osutils.safe_file_id(file_id)
1326
1241
        to_find_delete = [self._byid[file_id]]
1327
1242
        to_delete = []
1328
1243
        while to_find_delete:
1345
1260
 
1346
1261
        This does not move the working file.
1347
1262
        """
1348
 
        file_id = osutils.safe_file_id(file_id)
 
1263
        new_name = ensure_normalized_name(new_name)
1349
1264
        if not is_valid_name(new_name):
1350
1265
            raise BzrError("not an acceptable filename: %r" % new_name)
1351
1266
 
1370
1285
        file_ie.parent_id = new_parent_id
1371
1286
 
1372
1287
    def is_root(self, file_id):
1373
 
        file_id = osutils.safe_file_id(file_id)
1374
1288
        return self.root is not None and file_id == self.root.file_id
1375
1289
 
1376
1290
 
1391
1305
    """
1392
1306
    if file_id is None:
1393
1307
        file_id = generate_ids.gen_file_id(name)
1394
 
    else:
1395
 
        file_id = osutils.safe_file_id(file_id)
1396
 
 
 
1308
    name = ensure_normalized_name(name)
 
1309
    try:
 
1310
        factory = entry_factory[kind]
 
1311
    except KeyError:
 
1312
        raise BzrError("unknown kind %r" % kind)
 
1313
    return factory(file_id, name, parent_id)
 
1314
 
 
1315
 
 
1316
def ensure_normalized_name(name):
 
1317
    """Normalize name.
 
1318
 
 
1319
    :raises InvalidNormalization: When name is not normalized, and cannot be
 
1320
        accessed on this platform by the normalized path.
 
1321
    :return: The NFC normalised version of name.
 
1322
    """
1397
1323
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
1398
1324
    # keep them synchronised.
1399
1325
    # we dont import normalized_filename directly because we want to be
1401
1327
    norm_name, can_access = osutils.normalized_filename(name)
1402
1328
    if norm_name != name:
1403
1329
        if can_access:
1404
 
            name = norm_name
 
1330
            return norm_name
1405
1331
        else:
1406
1332
            # TODO: jam 20060701 This would probably be more useful
1407
1333
            #       if the error was raised with the full path
1408
1334
            raise errors.InvalidNormalization(name)
1409
 
 
1410
 
    try:
1411
 
        factory = entry_factory[kind]
1412
 
    except KeyError:
1413
 
        raise BzrError("unknown kind %r" % kind)
1414
 
    return factory(file_id, name, parent_id)
 
1335
    return name
1415
1336
 
1416
1337
 
1417
1338
_NAME_RE = None