~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2007-04-04 06:17:31 UTC
  • mto: This revision was merged to the branch mainline in revision 2397.
  • Revision ID: mbp@sourcefrog.net-20070404061731-tt2xrzllqhbodn83
Contents of TODO file moved into bug tracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
# FIXME: This refactoring of the workingtree code doesn't seem to keep
 
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep 
18
18
# the WorkingTree's copy of the inventory in sync with the branch.  The
19
19
# branch modifies its working inventory when it does a commit to make
20
20
# missing files permanently removed.
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
from copy import deepcopy
 
30
import os
 
31
import re
 
32
import sys
31
33
 
32
34
from bzrlib.lazy_import import lazy_import
33
35
lazy_import(globals(), """
34
36
import collections
35
 
import os
36
 
import re
37
37
import tarfile
38
38
 
39
39
import bzrlib
40
40
from bzrlib import (
41
 
    chk_map,
42
41
    errors,
43
42
    generate_ids,
44
43
    osutils,
51
50
    BzrCheckError,
52
51
    BzrError,
53
52
    )
54
 
from bzrlib.symbol_versioning import deprecated_in, deprecated_method
55
53
from bzrlib.trace import mutter
56
54
 
57
55
 
70
68
        file_id of the parent directory, or ROOT_ID
71
69
 
72
70
    revision
73
 
        the revision_id in which this variation of this file was
 
71
        the revision_id in which this variation of this file was 
74
72
        introduced.
75
73
 
76
74
    executable
79
77
 
80
78
    text_sha1
81
79
        sha-1 of the text of the file
82
 
 
 
80
        
83
81
    text_size
84
82
        size in bytes of the text of the file
85
 
 
 
83
        
86
84
    (reading a version 4 tree created a text_id field.)
87
85
 
88
86
    >>> i = Inventory()
91
89
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
92
90
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
93
91
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
94
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None)
 
92
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
95
93
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
96
94
    >>> for ix, j in enumerate(i.iter_entries()):
97
95
    ...   print (j[0] == shouldbe[ix], j[1])
98
 
    ...
 
96
    ... 
99
97
    (True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
100
98
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
101
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None, revision=None))
 
99
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
102
100
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
103
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None, revision=None)
 
101
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
104
102
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
105
103
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
106
104
    >>> i.path2id('src/wibble')
108
106
    >>> '2325' in i
109
107
    True
110
108
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
111
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
 
109
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
112
110
    >>> i['2326']
113
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None, revision=None)
 
111
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
114
112
    >>> for path, entry in i.iter_entries():
115
113
    ...     print path
116
 
    ...
 
114
    ...     assert i.path2id(path)
 
115
    ... 
117
116
    <BLANKLINE>
118
117
    src
119
118
    src/bye.c
126
125
 
127
126
    # Constants returned by describe_change()
128
127
    #
129
 
    # TODO: These should probably move to some kind of FileChangeDescription
130
 
    # class; that's like what's inside a TreeDelta but we want to be able to
 
128
    # TODO: These should probably move to some kind of FileChangeDescription 
 
129
    # class; that's like what's inside a TreeDelta but we want to be able to 
131
130
    # generate them just for one file at a time.
132
131
    RENAMED = 'renamed'
133
132
    MODIFIED_AND_RENAMED = 'modified and renamed'
134
 
 
 
133
    
135
134
    __slots__ = []
136
135
 
137
136
    def detect_changes(self, old_entry):
138
137
        """Return a (text_modified, meta_modified) from this to old_entry.
139
 
 
140
 
        _read_tree_state must have been called on self and old_entry prior to
 
138
        
 
139
        _read_tree_state must have been called on self and old_entry prior to 
141
140
        calling detect_changes.
142
141
        """
143
142
        return False, False
144
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
 
145
161
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
146
162
             output_to, reverse=False):
147
163
        """Perform a diff between two entries of the same kind."""
148
164
 
149
 
    def parent_candidates(self, previous_inventories):
150
 
        """Find possible per-file graph parents.
151
 
 
152
 
        This is currently defined by:
153
 
         - Select the last changed revision in the parent inventory.
154
 
         - Do deal with a short lived bug in bzr 0.8's development two entries
155
 
           that have the same last changed but different 'x' bit settings are
156
 
           changed in-place.
 
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.
157
182
        """
 
183
        def get_ancestors(weave, entry):
 
184
            return set(weave.get_ancestry(entry.revision))
158
185
        # revision:ie mapping for each ie found in previous_inventories.
159
186
        candidates = {}
 
187
        # revision:ie mapping with one revision for each head.
 
188
        heads = {}
 
189
        # revision: ancestor list for each head
 
190
        head_ancestors = {}
160
191
        # identify candidate head revision ids.
161
192
        for inv in previous_inventories:
162
193
            if self.file_id in inv:
163
194
                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
164
199
                if ie.revision in candidates:
165
200
                    # same revision value in two different inventories:
166
201
                    # correct possible inconsistencies:
167
 
                    #     * there was a bug in revision updates with 'x' bit
 
202
                    #     * there was a bug in revision updates with 'x' bit 
168
203
                    #       support.
169
204
                    try:
170
205
                        if candidates[ie.revision].executable != ie.executable:
172
207
                            ie.executable = False
173
208
                    except AttributeError:
174
209
                        pass
 
210
                    # must now be the same.
 
211
                    assert candidates[ie.revision] == ie
175
212
                else:
176
213
                    # add this revision as a candidate.
177
214
                    candidates[ie.revision] = ie
178
 
        return candidates
179
 
 
180
 
    @deprecated_method(deprecated_in((1, 6, 0)))
 
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
 
181
254
    def get_tar_item(self, root, dp, now, tree):
182
255
        """Get a tarfile item and a file stream for its content."""
183
256
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
200
273
 
201
274
    def __init__(self, file_id, name, parent_id, text_id=None):
202
275
        """Create an InventoryEntry
203
 
 
 
276
        
204
277
        The filename must be a single component, relative to the
205
278
        parent directory; it cannot be a whole path or relative name.
206
279
 
213
286
        Traceback (most recent call last):
214
287
        InvalidEntryName: Invalid entry name: src/hello.c
215
288
        """
 
289
        assert isinstance(name, basestring), name
216
290
        if '/' in name or '\\' in name:
217
291
            raise errors.InvalidEntryName(name=name)
218
292
        self.executable = False
220
294
        self.text_sha1 = None
221
295
        self.text_size = None
222
296
        self.file_id = file_id
 
297
        assert isinstance(file_id, (str, None.__class__)), \
 
298
            'bad type %r for %r' % (type(file_id), file_id)
223
299
        self.name = name
224
300
        self.text_id = text_id
225
301
        self.parent_id = parent_id
240
316
        raise BzrError("don't know how to export {%s} of kind %r" %
241
317
                       (self.file_id, self.kind))
242
318
 
243
 
    @deprecated_method(deprecated_in((1, 6, 0)))
244
319
    def put_on_disk(self, dest, dp, tree):
245
320
        """Create a representation of self on disk in the prefix dest.
246
 
 
 
321
        
247
322
        This is a template method - implement _put_on_disk in subclasses.
248
323
        """
249
324
        fullpath = osutils.pathjoin(dest, dp)
268
343
        This is a template method, override _check for kind specific
269
344
        tests.
270
345
 
271
 
        :param checker: Check object providing context for the checks;
 
346
        :param checker: Check object providing context for the checks; 
272
347
             can be used to find out what parts of the repository have already
273
348
             been checked.
274
349
        :param rev_id: Revision id from which this InventoryEntry was loaded.
284
359
 
285
360
    def _check(self, checker, rev_id, tree):
286
361
        """Check this inventory entry for kind specific errors."""
287
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' %
 
362
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
288
363
                            (self.kind, rev_id))
289
364
 
290
365
    def copy(self):
294
369
    @staticmethod
295
370
    def describe_change(old_entry, new_entry):
296
371
        """Describe the change between old_entry and this.
297
 
 
 
372
        
298
373
        This smells of being an InterInventoryEntry situation, but as its
299
374
        the first one, we're making it a static method for now.
300
375
 
301
 
        An entry with a different parent, or different name is considered
 
376
        An entry with a different parent, or different name is considered 
302
377
        to be renamed. Reparenting is an internal detail.
303
378
        Note that renaming the parent does not trigger a rename for the
304
379
        child entry itself.
341
416
                   self.parent_id,
342
417
                   self.revision))
343
418
 
 
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
 
344
462
    def __eq__(self, other):
345
 
        if other is self:
346
 
            # For the case when objects are cached
347
 
            return True
348
463
        if not isinstance(other, InventoryEntry):
349
464
            return NotImplemented
350
465
 
385
500
 
386
501
    def _read_tree_state(self, path, work_tree):
387
502
        """Populate fields in the inventory entry from the given tree.
388
 
 
 
503
        
389
504
        Note that this should be modified to be a noop on virtual trees
390
505
        as all entries created there are prepopulated.
391
506
        """
392
 
        # TODO: Rather than running this manually, we should check the
 
507
        # TODO: Rather than running this manually, we should check the 
393
508
        # working sha1 and other expensive properties when they're
394
509
        # first requested, or preload them if they're already known
395
510
        pass            # nothing to do by default
421
536
    def __eq__(self, other):
422
537
        if not isinstance(other, RootEntry):
423
538
            return NotImplemented
424
 
 
 
539
        
425
540
        return (self.file_id == other.file_id) \
426
541
               and (self.children == other.children)
427
542
 
468
583
        """See InventoryEntry._put_on_disk."""
469
584
        os.mkdir(fullpath)
470
585
 
 
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
 
471
590
 
472
591
class InventoryFile(InventoryEntry):
473
592
    """A file in an inventory."""
478
597
 
479
598
    def _check(self, checker, tree_revision_id, tree):
480
599
        """See InventoryEntry._check"""
481
 
        key = (self.file_id, self.revision)
482
 
        if key in checker.checked_texts:
483
 
            prev_sha = checker.checked_texts[key]
 
600
        t = (self.file_id, self.revision)
 
601
        if t in checker.checked_texts:
 
602
            prev_sha = checker.checked_texts[t]
484
603
            if prev_sha != self.text_sha1:
485
 
                raise BzrCheckError(
486
 
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
487
 
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
488
 
                     t))
 
604
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
605
                                    (self.file_id, tree_revision_id))
489
606
            else:
490
607
                checker.repeated_text_cnt += 1
491
608
                return
492
609
 
 
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
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
493
622
        checker.checked_text_cnt += 1
494
623
        # We can't check the length, because Weave doesn't store that
495
624
        # information, and the whole point of looking at the weave's
496
625
        # sha1sum is that we don't have to extract the text.
497
 
        if (self.text_sha1 != tree._repository.texts.get_sha1s([key])[key]):
498
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' % key)
499
 
        checker.checked_texts[key] = self.text_sha1
 
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
500
630
 
501
631
    def copy(self):
502
632
        other = InventoryFile(self.file_id, self.name, self.parent_id)
509
639
 
510
640
    def detect_changes(self, old_entry):
511
641
        """See InventoryEntry.detect_changes."""
 
642
        assert self.text_sha1 is not None
 
643
        assert old_entry.text_sha1 is not None
512
644
        text_modified = (self.text_sha1 != old_entry.text_sha1)
513
645
        meta_modified = (self.executable != old_entry.executable)
514
646
        return text_modified, meta_modified
516
648
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
517
649
             output_to, reverse=False):
518
650
        """See InventoryEntry._diff."""
519
 
        from bzrlib.diff import DiffText
520
 
        from_file_id = self.file_id
521
 
        if to_entry:
522
 
            to_file_id = to_entry.file_id
523
 
        else:
524
 
            to_file_id = None
525
 
        if reverse:
526
 
            to_file_id, from_file_id = from_file_id, to_file_id
527
 
            tree, to_tree = to_tree, tree
528
 
            from_label, to_label = to_label, from_label
529
 
        differ = DiffText(tree, to_tree, output_to, 'utf-8', '', '',
530
 
                          text_diff)
531
 
        return differ.diff_text(from_file_id, to_file_id, from_label, to_label)
 
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
532
669
 
533
670
    def has_text(self):
534
671
        """See InventoryEntry.has_text."""
567
704
        self.executable = work_tree.is_executable(self.file_id, path=path)
568
705
 
569
706
    def __repr__(self):
570
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s, revision=%s)"
 
707
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
571
708
                % (self.__class__.__name__,
572
709
                   self.file_id,
573
710
                   self.name,
574
711
                   self.parent_id,
575
712
                   self.text_sha1,
576
 
                   self.text_size,
577
 
                   self.revision))
 
713
                   self.text_size))
578
714
 
579
715
    def _forget_tree_state(self):
580
716
        self.text_sha1 = None
581
717
 
 
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
 
582
725
    def _unchanged(self, previous_ie):
583
726
        """See InventoryEntry._unchanged."""
584
727
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
627
770
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
628
771
             output_to, reverse=False):
629
772
        """See InventoryEntry._diff."""
630
 
        from bzrlib.diff import DiffSymlink
631
 
        old_target = self.symlink_target
 
773
        from_text = self.symlink_target
632
774
        if to_entry is not None:
633
 
            new_target = to_entry.symlink_target
634
 
        else:
635
 
            new_target = None
636
 
        if not reverse:
637
 
            old_tree = tree
638
 
            new_tree = to_tree
639
 
        else:
640
 
            old_tree = to_tree
641
 
            new_tree = tree
642
 
            new_target, old_target = old_target, new_target
643
 
        differ = DiffSymlink(old_tree, new_tree, output_to)
644
 
        return differ.diff_symlink(old_target, new_target)
 
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
645
786
 
646
787
    def __init__(self, file_id, name, parent_id):
647
788
        super(InventoryLink, self).__init__(file_id, name, parent_id)
681
822
            compatible = False
682
823
        return compatible
683
824
 
 
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
 
684
830
 
685
831
class TreeReference(InventoryEntry):
686
 
 
 
832
    
687
833
    kind = 'tree-reference'
688
 
 
 
834
    
689
835
    def __init__(self, file_id, name, parent_id, revision=None,
690
836
                 reference_revision=None):
691
837
        InventoryEntry.__init__(self, file_id, name, parent_id)
696
842
        return TreeReference(self.file_id, self.name, self.parent_id,
697
843
                             self.revision, self.reference_revision)
698
844
 
 
845
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
846
        commit_builder.modified_reference(self.file_id, file_parents)
 
847
 
699
848
    def _read_tree_state(self, path, work_tree):
700
849
        """Populate fields in the inventory entry from the given tree.
701
850
        """
703
852
            self.file_id, path)
704
853
 
705
854
    def _forget_tree_state(self):
706
 
        self.reference_revision = None
707
 
 
708
 
    def _unchanged(self, previous_ie):
709
 
        """See InventoryEntry._unchanged."""
710
 
        compatible = super(TreeReference, self)._unchanged(previous_ie)
711
 
        if self.reference_revision != previous_ie.reference_revision:
712
 
            compatible = False
713
 
        return compatible
714
 
 
715
 
 
716
 
class CommonInventory(object):
717
 
    """Basic inventory logic, defined in terms of primitives like has_id."""
718
 
 
719
 
    def __contains__(self, file_id):
720
 
        """True if this entry contains a file with given id.
721
 
 
722
 
        >>> inv = Inventory()
723
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
724
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
725
 
        >>> '123' in inv
726
 
        True
727
 
        >>> '456' in inv
728
 
        False
729
 
 
730
 
        Note that this method along with __iter__ are not encouraged for use as
731
 
        they are less clear than specific query methods - they may be rmeoved
732
 
        in the future.
733
 
        """
734
 
        return self.has_id(file_id)
735
 
 
736
 
    def id2path(self, file_id):
737
 
        """Return as a string the path to file_id.
738
 
 
739
 
        >>> i = Inventory()
740
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
741
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
742
 
        >>> print i.id2path('foo-id')
743
 
        src/foo.c
744
 
        """
745
 
        # get all names, skipping root
746
 
        return '/'.join(reversed(
747
 
            [parent.name for parent in
748
 
             self._iter_file_id_parents(file_id)][:-1]))
 
855
        self.reference_revision = None 
 
856
 
 
857
 
 
858
class Inventory(object):
 
859
    """Inventory of versioned files in a tree.
 
860
 
 
861
    This describes which file_id is present at each point in the tree,
 
862
    and possibly the SHA-1 or other information about the file.
 
863
    Entries can be looked up either by path or by file_id.
 
864
 
 
865
    The inventory represents a typical unix file tree, with
 
866
    directories containing files and subdirectories.  We never store
 
867
    the full path to a file, because renaming a directory implicitly
 
868
    moves all of its contents.  This class internally maintains a
 
869
    lookup tree that allows the children under a directory to be
 
870
    returned quickly.
 
871
 
 
872
    InventoryEntry objects must not be modified after they are
 
873
    inserted, other than through the Inventory API.
 
874
 
 
875
    >>> inv = Inventory()
 
876
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
877
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
878
    >>> inv['123-123'].name
 
879
    'hello.c'
 
880
 
 
881
    May be treated as an iterator or set to look up file ids:
 
882
    
 
883
    >>> bool(inv.path2id('hello.c'))
 
884
    True
 
885
    >>> '123-123' in inv
 
886
    True
 
887
 
 
888
    May also look up by name:
 
889
 
 
890
    >>> [x[0] for x in inv.iter_entries()]
 
891
    ['', u'hello.c']
 
892
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
893
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
894
    Traceback (most recent call last):
 
895
    BzrError: parent_id {TREE_ROOT} not in inventory
 
896
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
 
897
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
 
898
    """
 
899
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
900
        """Create or read an inventory.
 
901
 
 
902
        If a working directory is specified, the inventory is read
 
903
        from there.  If the file is specified, read from that. If not,
 
904
        the inventory is created empty.
 
905
 
 
906
        The inventory is created with a default root directory, with
 
907
        an id of None.
 
908
        """
 
909
        if root_id is not None:
 
910
            assert root_id.__class__ == str
 
911
            self._set_root(InventoryDirectory(root_id, u'', None))
 
912
        else:
 
913
            self.root = None
 
914
            self._byid = {}
 
915
        self.revision_id = revision_id
 
916
 
 
917
    def _set_root(self, ie):
 
918
        self.root = ie
 
919
        self._byid = {self.root.file_id: self.root}
 
920
 
 
921
    def copy(self):
 
922
        # TODO: jam 20051218 Should copy also copy the revision_id?
 
923
        entries = self.iter_entries()
 
924
        other = Inventory(entries.next()[1].file_id)
 
925
        # copy recursively so we know directories will be added before
 
926
        # their children.  There are more efficient ways than this...
 
927
        for path, entry in entries():
 
928
            other.add(entry.copy())
 
929
        return other
 
930
 
 
931
    def __iter__(self):
 
932
        return iter(self._byid)
 
933
 
 
934
    def __len__(self):
 
935
        """Returns number of entries."""
 
936
        return len(self._byid)
749
937
 
750
938
    def iter_entries(self, from_dir=None):
751
939
        """Return (path, entry) pairs, in order by name."""
755
943
            from_dir = self.root
756
944
            yield '', self.root
757
945
        elif isinstance(from_dir, basestring):
758
 
            from_dir = self[from_dir]
759
 
 
 
946
            from_dir = self._byid[from_dir]
 
947
            
760
948
        # unrolling the recursive called changed the time from
761
949
        # 440ms/663ms (inline/total) to 116ms/116ms
762
950
        children = from_dir.children.items()
791
979
                # if we finished all children, pop it off the stack
792
980
                stack.pop()
793
981
 
794
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
795
 
        yield_parents=False):
 
982
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None):
796
983
        """Iterate over the entries in a directory first order.
797
984
 
798
985
        This returns all entries for a directory before returning
800
987
        lexicographically sorted order, and is a hybrid between
801
988
        depth-first and breadth-first.
802
989
 
803
 
        :param yield_parents: If True, yield the parents from the root leading
804
 
            down to specific_file_ids that have been requested. This has no
805
 
            impact if specific_file_ids is None.
806
990
        :return: This yields (path, entry) pairs
807
991
        """
808
 
        if specific_file_ids and not isinstance(specific_file_ids, set):
809
 
            specific_file_ids = set(specific_file_ids)
 
992
        if specific_file_ids:
 
993
            safe = osutils.safe_file_id
 
994
            specific_file_ids = set(safe(fid) for fid in specific_file_ids)
810
995
        # TODO? Perhaps this should return the from_dir so that the root is
811
996
        # yielded? or maybe an option?
812
997
        if from_dir is None:
813
998
            if self.root is None:
814
999
                return
815
1000
            # Optimize a common case
816
 
            if (not yield_parents and specific_file_ids is not None and
817
 
                len(specific_file_ids) == 1):
 
1001
            if specific_file_ids is not None and len(specific_file_ids) == 1:
818
1002
                file_id = list(specific_file_ids)[0]
819
1003
                if file_id in self:
820
1004
                    yield self.id2path(file_id), self[file_id]
821
 
                return
 
1005
                return 
822
1006
            from_dir = self.root
823
 
            if (specific_file_ids is None or yield_parents or
 
1007
            if (specific_file_ids is None or 
824
1008
                self.root.file_id in specific_file_ids):
825
1009
                yield u'', self.root
826
1010
        elif isinstance(from_dir, basestring):
827
 
            from_dir = self[from_dir]
 
1011
            from_dir = self._byid[from_dir]
828
1012
 
829
1013
        if specific_file_ids is not None:
830
1014
            # TODO: jam 20070302 This could really be done as a loop rather
831
1015
            #       than a bunch of recursive calls.
832
1016
            parents = set()
833
 
            byid = self
 
1017
            byid = self._byid
834
1018
            def add_ancestors(file_id):
835
1019
                if file_id not in byid:
836
1020
                    return
844
1028
                add_ancestors(file_id)
845
1029
        else:
846
1030
            parents = None
847
 
 
 
1031
            
848
1032
        stack = [(u'', from_dir)]
849
1033
        while stack:
850
1034
            cur_relpath, cur_dir = stack.pop()
854
1038
 
855
1039
                child_relpath = cur_relpath + child_name
856
1040
 
857
 
                if (specific_file_ids is None or
858
 
                    child_ie.file_id in specific_file_ids or
859
 
                    (yield_parents and child_ie.file_id in parents)):
 
1041
                if (specific_file_ids is None or 
 
1042
                    child_ie.file_id in specific_file_ids):
860
1043
                    yield child_relpath, child_ie
861
1044
 
862
1045
                if child_ie.kind == 'directory':
864
1047
                        child_dirs.append((child_relpath+'/', child_ie))
865
1048
            stack.extend(reversed(child_dirs))
866
1049
 
867
 
    def _make_delta(self, old):
868
 
        """Make an inventory delta from two inventories."""
869
 
        old_ids = set(old)
870
 
        new_ids = set(self)
871
 
        adds = new_ids - old_ids
872
 
        deletes = old_ids - new_ids
873
 
        common = old_ids.intersection(new_ids)
874
 
        delta = []
875
 
        for file_id in deletes:
876
 
            delta.append((old.id2path(file_id), None, file_id, None))
877
 
        for file_id in adds:
878
 
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
879
 
        for file_id in common:
880
 
            if old[file_id] != self[file_id]:
881
 
                delta.append((old.id2path(file_id), self.id2path(file_id),
882
 
                    file_id, self[file_id]))
883
 
        return delta
884
 
 
885
 
    def _get_mutable_inventory(self):
886
 
        """Returns a mutable copy of the object.
887
 
 
888
 
        Some inventories are immutable, yet working trees, for example, needs
889
 
        to mutate exisiting inventories instead of creating a new one.
890
 
        """
891
 
        raise NotImplementedError(self._get_mutable_inventory)
892
 
 
893
 
    def make_entry(self, kind, name, parent_id, file_id=None):
894
 
        """Simple thunk to bzrlib.inventory.make_entry."""
895
 
        return make_entry(kind, name, parent_id, file_id)
896
 
 
897
1050
    def entries(self):
898
1051
        """Return list of (path, ie) for all entries except the root.
899
1052
 
918
1071
        accum = []
919
1072
        def descend(parent_ie, parent_path):
920
1073
            accum.append((parent_path, parent_ie))
921
 
 
 
1074
            
922
1075
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
923
1076
            kids.sort()
924
1077
 
927
1080
                descend(child_ie, child_path)
928
1081
        descend(self.root, u'')
929
1082
        return accum
930
 
 
931
 
    def path2id(self, name):
932
 
        """Walk down through directories to return entry of last component.
933
 
 
934
 
        names may be either a list of path components, or a single
935
 
        string, in which case it is automatically split.
936
 
 
937
 
        This returns the entry of the last component in the path,
938
 
        which may be either a file or a directory.
939
 
 
940
 
        Returns None IFF the path is not found.
941
 
        """
942
 
        if isinstance(name, basestring):
943
 
            name = osutils.splitpath(name)
944
 
 
945
 
        # mutter("lookup path %r" % name)
946
 
 
947
 
        try:
948
 
            parent = self.root
949
 
        except errors.NoSuchId:
950
 
            # root doesn't exist yet so nothing else can
951
 
            return None
952
 
        if parent is None:
953
 
            return None
954
 
        for f in name:
955
 
            try:
956
 
                children = getattr(parent, 'children', None)
957
 
                if children is None:
958
 
                    return None
959
 
                cie = children[f]
960
 
                parent = cie
961
 
            except KeyError:
962
 
                # or raise an error?
963
 
                return None
964
 
 
965
 
        return parent.file_id
966
 
 
967
 
    def filter(self, specific_fileids):
968
 
        """Get an inventory view filtered against a set of file-ids.
969
 
 
970
 
        Children of directories and parents are included.
971
 
 
972
 
        The result may or may not reference the underlying inventory
973
 
        so it should be treated as immutable.
974
 
        """
975
 
        interesting_parents = set()
976
 
        for fileid in specific_fileids:
977
 
            try:
978
 
                interesting_parents.update(self.get_idpath(fileid))
979
 
            except errors.NoSuchId:
980
 
                # This fileid is not in the inventory - that's ok
981
 
                pass
982
 
        entries = self.iter_entries()
983
 
        if self.root is None:
984
 
            return Inventory(root_id=None)
985
 
        other = Inventory(entries.next()[1].file_id)
986
 
        other.root.revision = self.root.revision
987
 
        other.revision_id = self.revision_id
988
 
        directories_to_expand = set()
989
 
        for path, entry in entries:
990
 
            file_id = entry.file_id
991
 
            if (file_id in specific_fileids
992
 
                or entry.parent_id in directories_to_expand):
993
 
                if entry.kind == 'directory':
994
 
                    directories_to_expand.add(file_id)
995
 
            elif file_id not in interesting_parents:
996
 
                continue
997
 
            other.add(entry.copy())
998
 
        return other
999
 
 
1000
 
    def get_idpath(self, file_id):
1001
 
        """Return a list of file_ids for the path to an entry.
1002
 
 
1003
 
        The list contains one element for each directory followed by
1004
 
        the id of the file itself.  So the length of the returned list
1005
 
        is equal to the depth of the file in the tree, counting the
1006
 
        root directory as depth 1.
1007
 
        """
1008
 
        p = []
1009
 
        for parent in self._iter_file_id_parents(file_id):
1010
 
            p.insert(0, parent.file_id)
1011
 
        return p
1012
 
 
1013
 
 
1014
 
class Inventory(CommonInventory):
1015
 
    """Inventory of versioned files in a tree.
1016
 
 
1017
 
    This describes which file_id is present at each point in the tree,
1018
 
    and possibly the SHA-1 or other information about the file.
1019
 
    Entries can be looked up either by path or by file_id.
1020
 
 
1021
 
    The inventory represents a typical unix file tree, with
1022
 
    directories containing files and subdirectories.  We never store
1023
 
    the full path to a file, because renaming a directory implicitly
1024
 
    moves all of its contents.  This class internally maintains a
1025
 
    lookup tree that allows the children under a directory to be
1026
 
    returned quickly.
1027
 
 
1028
 
    InventoryEntry objects must not be modified after they are
1029
 
    inserted, other than through the Inventory API.
1030
 
 
1031
 
    >>> inv = Inventory()
1032
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1033
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
1034
 
    >>> inv['123-123'].name
1035
 
    'hello.c'
1036
 
 
1037
 
    May be treated as an iterator or set to look up file ids:
1038
 
 
1039
 
    >>> bool(inv.path2id('hello.c'))
1040
 
    True
1041
 
    >>> '123-123' in inv
1042
 
    True
1043
 
 
1044
 
    May also look up by name:
1045
 
 
1046
 
    >>> [x[0] for x in inv.iter_entries()]
1047
 
    ['', u'hello.c']
1048
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
1049
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1050
 
    Traceback (most recent call last):
1051
 
    BzrError: parent_id {TREE_ROOT} not in inventory
1052
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
1053
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None, revision=None)
1054
 
    """
1055
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
1056
 
        """Create or read an inventory.
1057
 
 
1058
 
        If a working directory is specified, the inventory is read
1059
 
        from there.  If the file is specified, read from that. If not,
1060
 
        the inventory is created empty.
1061
 
 
1062
 
        The inventory is created with a default root directory, with
1063
 
        an id of None.
1064
 
        """
1065
 
        if root_id is not None:
1066
 
            self._set_root(InventoryDirectory(root_id, u'', None))
1067
 
        else:
1068
 
            self.root = None
1069
 
            self._byid = {}
1070
 
        self.revision_id = revision_id
1071
 
 
1072
 
    def __repr__(self):
1073
 
        # More than one page of ouput is not useful anymore to debug
1074
 
        max_len = 2048
1075
 
        closing = '...}'
1076
 
        contents = repr(self._byid)
1077
 
        if len(contents) > max_len:
1078
 
            contents = contents[:(max_len-len(closing))] + closing
1079
 
        return "<Inventory object at %x, contents=%r>" % (id(self), contents)
1080
 
 
1081
 
    def apply_delta(self, delta):
1082
 
        """Apply a delta to this inventory.
1083
 
 
1084
 
        :param delta: A list of changes to apply. After all the changes are
1085
 
            applied the final inventory must be internally consistent, but it
1086
 
            is ok to supply changes which, if only half-applied would have an
1087
 
            invalid result - such as supplying two changes which rename two
1088
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
1089
 
            ('B', 'A', 'B-id', b_entry)].
1090
 
 
1091
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
1092
 
            new_entry).
1093
 
 
1094
 
            When new_path is None, the change indicates the removal of an entry
1095
 
            from the inventory and new_entry will be ignored (using None is
1096
 
            appropriate). If new_path is not None, then new_entry must be an
1097
 
            InventoryEntry instance, which will be incorporated into the
1098
 
            inventory (and replace any existing entry with the same file id).
1099
 
 
1100
 
            When old_path is None, the change indicates the addition of
1101
 
            a new entry to the inventory.
1102
 
 
1103
 
            When neither new_path nor old_path are None, the change is a
1104
 
            modification to an entry, such as a rename, reparent, kind change
1105
 
            etc.
1106
 
 
1107
 
            The children attribute of new_entry is ignored. This is because
1108
 
            this method preserves children automatically across alterations to
1109
 
            the parent of the children, and cases where the parent id of a
1110
 
            child is changing require the child to be passed in as a separate
1111
 
            change regardless. E.g. in the recursive deletion of a directory -
1112
 
            the directory's children must be included in the delta, or the
1113
 
            final inventory will be invalid.
1114
 
 
1115
 
            Note that a file_id must only appear once within a given delta.
1116
 
            An AssertionError is raised otherwise.
1117
 
        """
1118
 
        # Check that the delta is legal. It would be nice if this could be
1119
 
        # done within the loops below but it's safer to validate the delta
1120
 
        # before starting to mutate the inventory.
1121
 
        unique_file_ids = set([f for _, _, f, _ in delta])
1122
 
        if len(unique_file_ids) != len(delta):
1123
 
            raise AssertionError("a file-id appears multiple times in %r"
1124
 
                    % (delta,))
1125
 
        del unique_file_ids
1126
 
 
1127
 
        children = {}
1128
 
        # Remove all affected items which were in the original inventory,
1129
 
        # starting with the longest paths, thus ensuring parents are examined
1130
 
        # after their children, which means that everything we examine has no
1131
 
        # modified children remaining by the time we examine it.
1132
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
1133
 
                                        if op is not None), reverse=True):
1134
 
            if file_id not in self:
1135
 
                # adds come later
1136
 
                continue
1137
 
            # Preserve unaltered children of file_id for later reinsertion.
1138
 
            file_id_children = getattr(self[file_id], 'children', {})
1139
 
            if len(file_id_children):
1140
 
                children[file_id] = file_id_children
1141
 
            # Remove file_id and the unaltered children. If file_id is not
1142
 
            # being deleted it will be reinserted back later.
1143
 
            self.remove_recursive_id(file_id)
1144
 
        # Insert all affected which should be in the new inventory, reattaching
1145
 
        # their children if they had any. This is done from shortest path to
1146
 
        # longest, ensuring that items which were modified and whose parents in
1147
 
        # the resulting inventory were also modified, are inserted after their
1148
 
        # parents.
1149
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
1150
 
                                          delta if np is not None):
1151
 
            if new_entry.kind == 'directory':
1152
 
                # Pop the child which to allow detection of children whose
1153
 
                # parents were deleted and which were not reattached to a new
1154
 
                # parent.
1155
 
                replacement = InventoryDirectory(new_entry.file_id,
1156
 
                    new_entry.name, new_entry.parent_id)
1157
 
                replacement.revision = new_entry.revision
1158
 
                replacement.children = children.pop(replacement.file_id, {})
1159
 
                new_entry = replacement
1160
 
            self.add(new_entry)
1161
 
        if len(children):
1162
 
            # Get the parent id that was deleted
1163
 
            parent_id, children = children.popitem()
1164
 
            raise errors.InconsistentDelta("<deleted>", parent_id,
1165
 
                "The file id was deleted but its children were not deleted.")
1166
 
 
1167
 
    def _set_root(self, ie):
1168
 
        self.root = ie
1169
 
        self._byid = {self.root.file_id: self.root}
1170
 
 
1171
 
    def copy(self):
1172
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
1173
 
        entries = self.iter_entries()
1174
 
        if self.root is None:
1175
 
            return Inventory(root_id=None)
1176
 
        other = Inventory(entries.next()[1].file_id)
1177
 
        other.root.revision = self.root.revision
1178
 
        # copy recursively so we know directories will be added before
1179
 
        # their children.  There are more efficient ways than this...
1180
 
        for path, entry in entries:
1181
 
            other.add(entry.copy())
1182
 
        return other
1183
 
 
1184
 
    def _get_mutable_inventory(self):
1185
 
        """See CommonInventory._get_mutable_inventory."""
1186
 
        return deepcopy(self)
1187
 
 
1188
 
    def __iter__(self):
1189
 
        """Iterate over all file-ids."""
1190
 
        return iter(self._byid)
1191
 
 
1192
 
    def iter_just_entries(self):
1193
 
        """Iterate over all entries.
1194
1083
        
1195
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
1196
 
        and the order of entries is undefined.
 
1084
    def __contains__(self, file_id):
 
1085
        """True if this entry contains a file with given id.
1197
1086
 
1198
 
        XXX: We may not want to merge this into bzr.dev.
 
1087
        >>> inv = Inventory()
 
1088
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1089
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
1090
        >>> '123' in inv
 
1091
        True
 
1092
        >>> '456' in inv
 
1093
        False
1199
1094
        """
1200
 
        if self.root is None:
1201
 
            return
1202
 
        for _, ie in self._byid.iteritems():
1203
 
            yield ie
1204
 
 
1205
 
    def __len__(self):
1206
 
        """Returns number of entries."""
1207
 
        return len(self._byid)
 
1095
        file_id = osutils.safe_file_id(file_id)
 
1096
        return (file_id in self._byid)
1208
1097
 
1209
1098
    def __getitem__(self, file_id):
1210
1099
        """Return the entry for given file_id.
1211
1100
 
1212
1101
        >>> inv = Inventory()
1213
1102
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1214
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
1103
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
1215
1104
        >>> inv['123123'].name
1216
1105
        'hello.c'
1217
1106
        """
 
1107
        file_id = osutils.safe_file_id(file_id)
1218
1108
        try:
1219
1109
            return self._byid[file_id]
1220
1110
        except KeyError:
1222
1112
            raise errors.NoSuchId(self, file_id)
1223
1113
 
1224
1114
    def get_file_kind(self, file_id):
 
1115
        file_id = osutils.safe_file_id(file_id)
1225
1116
        return self._byid[file_id].kind
1226
1117
 
1227
1118
    def get_child(self, parent_id, filename):
 
1119
        parent_id = osutils.safe_file_id(parent_id)
1228
1120
        return self[parent_id].children.get(filename)
1229
1121
 
1230
1122
    def _add_child(self, entry):
1250
1142
                                         self._byid[entry.file_id])
1251
1143
 
1252
1144
        if entry.parent_id is None:
 
1145
            assert self.root is None and len(self._byid) == 0
1253
1146
            self.root = entry
1254
1147
        else:
1255
1148
            try:
1261
1154
            if entry.name in parent.children:
1262
1155
                raise BzrError("%s is already versioned" %
1263
1156
                        osutils.pathjoin(self.id2path(parent.file_id),
1264
 
                        entry.name).encode('utf-8'))
 
1157
                        entry.name))
1265
1158
            parent.children[entry.name] = entry
1266
1159
        return self._add_child(entry)
1267
1160
 
1271
1164
        The immediate parent must already be versioned.
1272
1165
 
1273
1166
        Returns the new entry object."""
1274
 
 
 
1167
        
1275
1168
        parts = osutils.splitpath(relpath)
1276
1169
 
1277
1170
        if len(parts) == 0:
1278
1171
            if file_id is None:
1279
1172
                file_id = generate_ids.gen_root_id()
 
1173
            else:
 
1174
                file_id = osutils.safe_file_id(file_id)
1280
1175
            self.root = InventoryDirectory(file_id, '', None)
1281
1176
            self._byid = {self.root.file_id: self.root}
1282
1177
            return self.root
1293
1188
 
1294
1189
        >>> inv = Inventory()
1295
1190
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1296
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
1191
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1297
1192
        >>> '123' in inv
1298
1193
        True
1299
1194
        >>> del inv['123']
1300
1195
        >>> '123' in inv
1301
1196
        False
1302
1197
        """
 
1198
        file_id = osutils.safe_file_id(file_id)
1303
1199
        ie = self[file_id]
 
1200
 
 
1201
        assert ie.parent_id is None or \
 
1202
            self[ie.parent_id].children[ie.name] == ie
 
1203
        
1304
1204
        del self._byid[file_id]
1305
1205
        if ie.parent_id is not None:
1306
1206
            del self[ie.parent_id].children[ie.name]
1313
1213
        >>> i1 == i2
1314
1214
        True
1315
1215
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1316
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
1216
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1317
1217
        >>> i1 == i2
1318
1218
        False
1319
1219
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1320
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None, revision=None)
 
1220
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1321
1221
        >>> i1 == i2
1322
1222
        True
1323
1223
        """
1334
1234
 
1335
1235
    def _iter_file_id_parents(self, file_id):
1336
1236
        """Yield the parents of file_id up to the root."""
 
1237
        file_id = osutils.safe_file_id(file_id)
1337
1238
        while file_id is not None:
1338
1239
            try:
1339
1240
                ie = self._byid[file_id]
1342
1243
            yield ie
1343
1244
            file_id = ie.parent_id
1344
1245
 
1345
 
    def has_filename(self, filename):
1346
 
        return bool(self.path2id(filename))
 
1246
    def get_idpath(self, file_id):
 
1247
        """Return a list of file_ids for the path to an entry.
 
1248
 
 
1249
        The list contains one element for each directory followed by
 
1250
        the id of the file itself.  So the length of the returned list
 
1251
        is equal to the depth of the file in the tree, counting the
 
1252
        root directory as depth 1.
 
1253
        """
 
1254
        file_id = osutils.safe_file_id(file_id)
 
1255
        p = []
 
1256
        for parent in self._iter_file_id_parents(file_id):
 
1257
            p.insert(0, parent.file_id)
 
1258
        return p
 
1259
 
 
1260
    def id2path(self, file_id):
 
1261
        """Return as a string the path to file_id.
 
1262
        
 
1263
        >>> i = Inventory()
 
1264
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1265
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1266
        >>> print i.id2path('foo-id')
 
1267
        src/foo.c
 
1268
        """
 
1269
        file_id = osutils.safe_file_id(file_id)
 
1270
        # get all names, skipping root
 
1271
        return '/'.join(reversed(
 
1272
            [parent.name for parent in 
 
1273
             self._iter_file_id_parents(file_id)][:-1]))
 
1274
            
 
1275
    def path2id(self, name):
 
1276
        """Walk down through directories to return entry of last component.
 
1277
 
 
1278
        names may be either a list of path components, or a single
 
1279
        string, in which case it is automatically split.
 
1280
 
 
1281
        This returns the entry of the last component in the path,
 
1282
        which may be either a file or a directory.
 
1283
 
 
1284
        Returns None IFF the path is not found.
 
1285
        """
 
1286
        if isinstance(name, basestring):
 
1287
            name = osutils.splitpath(name)
 
1288
 
 
1289
        # mutter("lookup path %r" % name)
 
1290
 
 
1291
        parent = self.root
 
1292
        if parent is None:
 
1293
            return None
 
1294
        for f in name:
 
1295
            try:
 
1296
                children = getattr(parent, 'children', None)
 
1297
                if children is None:
 
1298
                    return None
 
1299
                cie = children[f]
 
1300
                assert cie.name == f
 
1301
                assert cie.parent_id == parent.file_id
 
1302
                parent = cie
 
1303
            except KeyError:
 
1304
                # or raise an error?
 
1305
                return None
 
1306
 
 
1307
        return parent.file_id
 
1308
 
 
1309
    def has_filename(self, names):
 
1310
        return bool(self.path2id(names))
1347
1311
 
1348
1312
    def has_id(self, file_id):
 
1313
        file_id = osutils.safe_file_id(file_id)
1349
1314
        return (file_id in self._byid)
1350
1315
 
1351
 
    def _make_delta(self, old):
1352
 
        """Make an inventory delta from two inventories."""
1353
 
        old_getter = getattr(old, '_byid', old)
1354
 
        new_getter = self._byid
1355
 
        old_ids = set(old_getter)
1356
 
        new_ids = set(new_getter)
1357
 
        adds = new_ids - old_ids
1358
 
        deletes = old_ids - new_ids
1359
 
        if not adds and not deletes:
1360
 
            common = new_ids
1361
 
        else:
1362
 
            common = old_ids.intersection(new_ids)
1363
 
        delta = []
1364
 
        for file_id in deletes:
1365
 
            delta.append((old.id2path(file_id), None, file_id, None))
1366
 
        for file_id in adds:
1367
 
            delta.append((None, self.id2path(file_id), file_id, self[file_id]))
1368
 
        for file_id in common:
1369
 
            new_ie = new_getter[file_id]
1370
 
            old_ie = old_getter[file_id]
1371
 
            # If xml_serializer returns the cached InventoryEntries (rather
1372
 
            # than always doing .copy()), inlining the 'is' check saves 2.7M
1373
 
            # calls to __eq__.  Under lsprof this saves 20s => 6s.
1374
 
            # It is a minor improvement without lsprof.
1375
 
            if old_ie is new_ie or old_ie == new_ie:
1376
 
                continue
1377
 
            else:
1378
 
                delta.append((old.id2path(file_id), self.id2path(file_id),
1379
 
                              file_id, new_ie))
1380
 
        return delta
1381
 
 
1382
1316
    def remove_recursive_id(self, file_id):
1383
1317
        """Remove file_id, and children, from the inventory.
1384
 
 
 
1318
        
1385
1319
        :param file_id: A file_id to remove.
1386
1320
        """
 
1321
        file_id = osutils.safe_file_id(file_id)
1387
1322
        to_find_delete = [self._byid[file_id]]
1388
1323
        to_delete = []
1389
1324
        while to_find_delete:
1406
1341
 
1407
1342
        This does not move the working file.
1408
1343
        """
1409
 
        new_name = ensure_normalized_name(new_name)
 
1344
        file_id = osutils.safe_file_id(file_id)
1410
1345
        if not is_valid_name(new_name):
1411
1346
            raise BzrError("not an acceptable filename: %r" % new_name)
1412
1347
 
1426
1361
 
1427
1362
        del old_parent.children[file_ie.name]
1428
1363
        new_parent.children[new_name] = file_ie
1429
 
 
 
1364
        
1430
1365
        file_ie.name = new_name
1431
1366
        file_ie.parent_id = new_parent_id
1432
1367
 
1433
1368
    def is_root(self, file_id):
 
1369
        file_id = osutils.safe_file_id(file_id)
1434
1370
        return self.root is not None and file_id == self.root.file_id
1435
1371
 
1436
1372
 
1437
 
class CHKInventory(CommonInventory):
1438
 
    """An inventory persisted in a CHK store.
1439
 
 
1440
 
    By design, a CHKInventory is immutable so many of the methods
1441
 
    supported by Inventory - add, rename, apply_delta, etc - are *not*
1442
 
    supported. To create a new CHKInventory, use create_by_apply_delta()
1443
 
    or from_inventory(), say.
1444
 
 
1445
 
    Internally, a CHKInventory has one or two CHKMaps:
1446
 
 
1447
 
    * id_to_entry - a map from (file_id,) => InventoryEntry as bytes
1448
 
    * parent_id_basename_to_file_id - a map from (parent_id, basename_utf8)
1449
 
        => file_id as bytes
1450
 
 
1451
 
    The second map is optional and not present in early CHkRepository's.
1452
 
 
1453
 
    No caching is performed: every method call or item access will perform
1454
 
    requests to the storage layer. As such, keep references to objects you
1455
 
    want to reuse.
1456
 
    """
1457
 
 
1458
 
    def __init__(self, search_key_name):
1459
 
        CommonInventory.__init__(self)
1460
 
        self._fileid_to_entry_cache = {}
1461
 
        self._path_to_fileid_cache = {}
1462
 
        self._search_key_name = search_key_name
1463
 
 
1464
 
    def _entry_to_bytes(self, entry):
1465
 
        """Serialise entry as a single bytestring.
1466
 
 
1467
 
        :param Entry: An inventory entry.
1468
 
        :return: A bytestring for the entry.
1469
 
 
1470
 
        The BNF:
1471
 
        ENTRY ::= FILE | DIR | SYMLINK | TREE
1472
 
        FILE ::= "file: " COMMON SEP SHA SEP SIZE SEP EXECUTABLE
1473
 
        DIR ::= "dir: " COMMON
1474
 
        SYMLINK ::= "symlink: " COMMON SEP TARGET_UTF8
1475
 
        TREE ::= "tree: " COMMON REFERENCE_REVISION
1476
 
        COMMON ::= FILE_ID SEP PARENT_ID SEP NAME_UTF8 SEP REVISION
1477
 
        SEP ::= "\n"
1478
 
        """
1479
 
        if entry.parent_id is not None:
1480
 
            parent_str = entry.parent_id
1481
 
        else:
1482
 
            parent_str = ''
1483
 
        name_str = entry.name.encode("utf8")
1484
 
        if entry.kind == 'file':
1485
 
            if entry.executable:
1486
 
                exec_str = "Y"
1487
 
            else:
1488
 
                exec_str = "N"
1489
 
            return "file: %s\n%s\n%s\n%s\n%s\n%d\n%s" % (
1490
 
                entry.file_id, parent_str, name_str, entry.revision,
1491
 
                entry.text_sha1, entry.text_size, exec_str)
1492
 
        elif entry.kind == 'directory':
1493
 
            return "dir: %s\n%s\n%s\n%s" % (
1494
 
                entry.file_id, parent_str, name_str, entry.revision)
1495
 
        elif entry.kind == 'symlink':
1496
 
            return "symlink: %s\n%s\n%s\n%s\n%s" % (
1497
 
                entry.file_id, parent_str, name_str, entry.revision,
1498
 
                entry.symlink_target.encode("utf8"))
1499
 
        elif entry.kind == 'tree-reference':
1500
 
            return "tree: %s\n%s\n%s\n%s\n%s" % (
1501
 
                entry.file_id, parent_str, name_str, entry.revision,
1502
 
                entry.reference_revision)
1503
 
        else:
1504
 
            raise ValueError("unknown kind %r" % entry.kind)
1505
 
 
1506
 
    @staticmethod
1507
 
    def _bytes_to_utf8name_key(bytes):
1508
 
        """Get the file_id, revision_id key out of bytes."""
1509
 
        # We don't normally care about name, except for times when we want
1510
 
        # to filter out empty names because of non rich-root...
1511
 
        sections = bytes.split('\n')
1512
 
        kind, file_id = sections[0].split(': ')
1513
 
        return (sections[2], file_id, sections[3])
1514
 
 
1515
 
    def _bytes_to_entry(self, bytes):
1516
 
        """Deserialise a serialised entry."""
1517
 
        sections = bytes.split('\n')
1518
 
        if sections[0].startswith("file: "):
1519
 
            result = InventoryFile(sections[0][6:],
1520
 
                sections[2].decode('utf8'),
1521
 
                sections[1])
1522
 
            result.text_sha1 = sections[4]
1523
 
            result.text_size = int(sections[5])
1524
 
            result.executable = sections[6] == "Y"
1525
 
        elif sections[0].startswith("dir: "):
1526
 
            result = CHKInventoryDirectory(sections[0][5:],
1527
 
                sections[2].decode('utf8'),
1528
 
                sections[1], self)
1529
 
        elif sections[0].startswith("symlink: "):
1530
 
            result = InventoryLink(sections[0][9:],
1531
 
                sections[2].decode('utf8'),
1532
 
                sections[1])
1533
 
            result.symlink_target = sections[4].decode('utf8')
1534
 
        elif sections[0].startswith("tree: "):
1535
 
            result = TreeReference(sections[0][6:],
1536
 
                sections[2].decode('utf8'),
1537
 
                sections[1])
1538
 
            result.reference_revision = sections[4]
1539
 
        else:
1540
 
            raise ValueError("Not a serialised entry %r" % bytes)
1541
 
        result.revision = sections[3]
1542
 
        if result.parent_id == '':
1543
 
            result.parent_id = None
1544
 
        self._fileid_to_entry_cache[result.file_id] = result
1545
 
        return result
1546
 
 
1547
 
    def _get_mutable_inventory(self):
1548
 
        """See CommonInventory._get_mutable_inventory."""
1549
 
        entries = self.iter_entries()
1550
 
        if self.root_id is not None:
1551
 
            entries.next()
1552
 
        inv = Inventory(self.root_id, self.revision_id)
1553
 
        for path, inv_entry in entries:
1554
 
            inv.add(inv_entry)
1555
 
        return inv
1556
 
 
1557
 
    def create_by_apply_delta(self, inventory_delta, new_revision_id,
1558
 
        propagate_caches=False):
1559
 
        """Create a new CHKInventory by applying inventory_delta to this one.
1560
 
 
1561
 
        :param inventory_delta: The inventory delta to apply. See
1562
 
            Inventory.apply_delta for details.
1563
 
        :param new_revision_id: The revision id of the resulting CHKInventory.
1564
 
        :param propagate_caches: If True, the caches for this inventory are
1565
 
          copied to and updated for the result.
1566
 
        :return: The new CHKInventory.
1567
 
        """
1568
 
        result = CHKInventory(self._search_key_name)
1569
 
        if propagate_caches:
1570
 
            # Just propagate the path-to-fileid cache for now
1571
 
            result._path_to_fileid_cache = dict(self._path_to_fileid_cache.iteritems())
1572
 
        search_key_func = chk_map.search_key_registry.get(self._search_key_name)
1573
 
        self.id_to_entry._ensure_root()
1574
 
        maximum_size = self.id_to_entry._root_node.maximum_size
1575
 
        result.revision_id = new_revision_id
1576
 
        result.id_to_entry = chk_map.CHKMap(
1577
 
            self.id_to_entry._store,
1578
 
            self.id_to_entry.key(),
1579
 
            search_key_func=search_key_func)
1580
 
        result.id_to_entry._ensure_root()
1581
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1582
 
        parent_id_basename_delta = []
1583
 
        if self.parent_id_basename_to_file_id is not None:
1584
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1585
 
                self.parent_id_basename_to_file_id._store,
1586
 
                self.parent_id_basename_to_file_id.key(),
1587
 
                search_key_func=search_key_func)
1588
 
            result.parent_id_basename_to_file_id._ensure_root()
1589
 
            self.parent_id_basename_to_file_id._ensure_root()
1590
 
            result_p_id_root = result.parent_id_basename_to_file_id._root_node
1591
 
            p_id_root = self.parent_id_basename_to_file_id._root_node
1592
 
            result_p_id_root.set_maximum_size(p_id_root.maximum_size)
1593
 
            result_p_id_root._key_width = p_id_root._key_width
1594
 
        else:
1595
 
            result.parent_id_basename_to_file_id = None
1596
 
        result.root_id = self.root_id
1597
 
        id_to_entry_delta = []
1598
 
        for old_path, new_path, file_id, entry in inventory_delta:
1599
 
            # file id changes
1600
 
            if new_path == '':
1601
 
                result.root_id = file_id
1602
 
            if new_path is None:
1603
 
                # Make a delete:
1604
 
                new_key = None
1605
 
                new_value = None
1606
 
                # Update caches
1607
 
                if propagate_caches:
1608
 
                    try:
1609
 
                        del result._path_to_fileid_cache[old_path]
1610
 
                    except KeyError:
1611
 
                        pass
1612
 
            else:
1613
 
                new_key = (file_id,)
1614
 
                new_value = result._entry_to_bytes(entry)
1615
 
                # Update caches. It's worth doing this whether
1616
 
                # we're propagating the old caches or not.
1617
 
                result._path_to_fileid_cache[new_path] = file_id
1618
 
            if old_path is None:
1619
 
                old_key = None
1620
 
            else:
1621
 
                old_key = (file_id,)
1622
 
            id_to_entry_delta.append((old_key, new_key, new_value))
1623
 
            if result.parent_id_basename_to_file_id is not None:
1624
 
                # parent_id, basename changes
1625
 
                if old_path is None:
1626
 
                    old_key = None
1627
 
                else:
1628
 
                    old_entry = self[file_id]
1629
 
                    old_key = self._parent_id_basename_key(old_entry)
1630
 
                if new_path is None:
1631
 
                    new_key = None
1632
 
                    new_value = None
1633
 
                else:
1634
 
                    new_key = self._parent_id_basename_key(entry)
1635
 
                    new_value = file_id
1636
 
                if old_key != new_key:
1637
 
                    # If the two keys are the same, the value will be unchanged
1638
 
                    # as its always the file id.
1639
 
                    parent_id_basename_delta.append((old_key, new_key, new_value))
1640
 
        result.id_to_entry.apply_delta(id_to_entry_delta)
1641
 
        if parent_id_basename_delta:
1642
 
            result.parent_id_basename_to_file_id.apply_delta(parent_id_basename_delta)
1643
 
        return result
1644
 
 
1645
 
    @classmethod
1646
 
    def deserialise(klass, chk_store, bytes, expected_revision_id):
1647
 
        """Deserialise a CHKInventory.
1648
 
 
1649
 
        :param chk_store: A CHK capable VersionedFiles instance.
1650
 
        :param bytes: The serialised bytes.
1651
 
        :param expected_revision_id: The revision ID we think this inventory is
1652
 
            for.
1653
 
        :return: A CHKInventory
1654
 
        """
1655
 
        lines = bytes.split('\n')
1656
 
        if lines[-1] != '':
1657
 
            raise AssertionError('bytes to deserialize must end with an eol')
1658
 
        lines.pop()
1659
 
        if lines[0] != 'chkinventory:':
1660
 
            raise ValueError("not a serialised CHKInventory: %r" % bytes)
1661
 
        info = {}
1662
 
        allowed_keys = frozenset(['root_id', 'revision_id', 'search_key_name',
1663
 
                                  'parent_id_basename_to_file_id',
1664
 
                                  'id_to_entry'])
1665
 
        for line in lines[1:]:
1666
 
            key, value = line.split(': ', 1)
1667
 
            if key not in allowed_keys:
1668
 
                raise errors.BzrError('Unknown key in inventory: %r\n%r'
1669
 
                                      % (key, bytes))
1670
 
            if key in info:
1671
 
                raise errors.BzrError('Duplicate key in inventory: %r\n%r'
1672
 
                                      % (key, bytes))
1673
 
            info[key] = value
1674
 
        revision_id = info['revision_id']
1675
 
        root_id = info['root_id']
1676
 
        search_key_name = info.get('search_key_name', 'plain')
1677
 
        parent_id_basename_to_file_id = info.get(
1678
 
            'parent_id_basename_to_file_id', None)
1679
 
        id_to_entry = info['id_to_entry']
1680
 
 
1681
 
        result = CHKInventory(search_key_name)
1682
 
        result.revision_id = revision_id
1683
 
        result.root_id = root_id
1684
 
        search_key_func = chk_map.search_key_registry.get(
1685
 
                            result._search_key_name)
1686
 
        if parent_id_basename_to_file_id is not None:
1687
 
            result.parent_id_basename_to_file_id = chk_map.CHKMap(
1688
 
                chk_store, (parent_id_basename_to_file_id,),
1689
 
                search_key_func=search_key_func)
1690
 
        else:
1691
 
            result.parent_id_basename_to_file_id = None
1692
 
 
1693
 
        result.id_to_entry = chk_map.CHKMap(chk_store, (id_to_entry,),
1694
 
                                            search_key_func=search_key_func)
1695
 
        if (result.revision_id,) != expected_revision_id:
1696
 
            raise ValueError("Mismatched revision id and expected: %r, %r" %
1697
 
                (result.revision_id, expected_revision_id))
1698
 
        return result
1699
 
 
1700
 
    @classmethod
1701
 
    def from_inventory(klass, chk_store, inventory, maximum_size=0, search_key_name='plain'):
1702
 
        """Create a CHKInventory from an existing inventory.
1703
 
 
1704
 
        The content of inventory is copied into the chk_store, and a
1705
 
        CHKInventory referencing that is returned.
1706
 
 
1707
 
        :param chk_store: A CHK capable VersionedFiles instance.
1708
 
        :param inventory: The inventory to copy.
1709
 
        :param maximum_size: The CHKMap node size limit.
1710
 
        :param search_key_name: The identifier for the search key function
1711
 
        """
1712
 
        result = CHKInventory(search_key_name)
1713
 
        result.revision_id = inventory.revision_id
1714
 
        result.root_id = inventory.root.file_id
1715
 
        search_key_func = chk_map.search_key_registry.get(search_key_name)
1716
 
        result.id_to_entry = chk_map.CHKMap(chk_store, None, search_key_func)
1717
 
        result.id_to_entry._root_node.set_maximum_size(maximum_size)
1718
 
        file_id_delta = []
1719
 
        result.parent_id_basename_to_file_id = chk_map.CHKMap(chk_store,
1720
 
            None, search_key_func)
1721
 
        result.parent_id_basename_to_file_id._root_node.set_maximum_size(
1722
 
            maximum_size)
1723
 
        result.parent_id_basename_to_file_id._root_node._key_width = 2
1724
 
        parent_id_delta = []
1725
 
        for path, entry in inventory.iter_entries():
1726
 
            file_id_delta.append((None, (entry.file_id,),
1727
 
                result._entry_to_bytes(entry)))
1728
 
            parent_id_delta.append(
1729
 
                (None, result._parent_id_basename_key(entry),
1730
 
                 entry.file_id))
1731
 
        result.id_to_entry.apply_delta(file_id_delta)
1732
 
        result.parent_id_basename_to_file_id.apply_delta(parent_id_delta)
1733
 
        return result
1734
 
 
1735
 
    def _parent_id_basename_key(self, entry):
1736
 
        """Create a key for a entry in a parent_id_basename_to_file_id index."""
1737
 
        if entry.parent_id is not None:
1738
 
            parent_id = entry.parent_id
1739
 
        else:
1740
 
            parent_id = ''
1741
 
        return parent_id, entry.name.encode('utf8')
1742
 
 
1743
 
    def __getitem__(self, file_id):
1744
 
        """map a single file_id -> InventoryEntry."""
1745
 
        if file_id is None:
1746
 
            raise errors.NoSuchId(self, file_id)
1747
 
        result = self._fileid_to_entry_cache.get(file_id, None)
1748
 
        if result is not None:
1749
 
            return result
1750
 
        try:
1751
 
            return self._bytes_to_entry(
1752
 
                self.id_to_entry.iteritems([(file_id,)]).next()[1])
1753
 
        except StopIteration:
1754
 
            # really we're passing an inventory, not a tree...
1755
 
            raise errors.NoSuchId(self, file_id)
1756
 
 
1757
 
    def has_id(self, file_id):
1758
 
        # Perhaps have an explicit 'contains' method on CHKMap ?
1759
 
        if self._fileid_to_entry_cache.get(file_id, None) is not None:
1760
 
            return True
1761
 
        return len(list(self.id_to_entry.iteritems([(file_id,)]))) == 1
1762
 
 
1763
 
    def is_root(self, file_id):
1764
 
        return file_id == self.root_id
1765
 
 
1766
 
    def _iter_file_id_parents(self, file_id):
1767
 
        """Yield the parents of file_id up to the root."""
1768
 
        while file_id is not None:
1769
 
            try:
1770
 
                ie = self[file_id]
1771
 
            except KeyError:
1772
 
                raise errors.NoSuchId(tree=self, file_id=file_id)
1773
 
            yield ie
1774
 
            file_id = ie.parent_id
1775
 
 
1776
 
    def __iter__(self):
1777
 
        """Iterate over all file-ids."""
1778
 
        for key, _ in self.id_to_entry.iteritems():
1779
 
            yield key[-1]
1780
 
 
1781
 
    def iter_just_entries(self):
1782
 
        """Iterate over all entries.
1783
 
        
1784
 
        Unlike iter_entries(), just the entries are returned (not (path, ie))
1785
 
        and the order of entries is undefined.
1786
 
 
1787
 
        XXX: We may not want to merge this into bzr.dev.
1788
 
        """
1789
 
        for key, entry in self.id_to_entry.iteritems():
1790
 
            file_id = key[0]
1791
 
            ie = self._fileid_to_entry_cache.get(file_id, None)
1792
 
            if ie is None:
1793
 
                ie = self._bytes_to_entry(entry)
1794
 
                self._fileid_to_entry_cache[file_id] = ie
1795
 
            yield ie
1796
 
 
1797
 
    def iter_changes(self, basis):
1798
 
        """Generate a Tree.iter_changes change list between this and basis.
1799
 
 
1800
 
        :param basis: Another CHKInventory.
1801
 
        :return: An iterator over the changes between self and basis, as per
1802
 
            tree.iter_changes().
1803
 
        """
1804
 
        # We want: (file_id, (path_in_source, path_in_target),
1805
 
        # changed_content, versioned, parent, name, kind,
1806
 
        # executable)
1807
 
        for key, basis_value, self_value in \
1808
 
            self.id_to_entry.iter_changes(basis.id_to_entry):
1809
 
            file_id = key[0]
1810
 
            if basis_value is not None:
1811
 
                basis_entry = basis._bytes_to_entry(basis_value)
1812
 
                path_in_source = basis.id2path(file_id)
1813
 
                basis_parent = basis_entry.parent_id
1814
 
                basis_name = basis_entry.name
1815
 
                basis_executable = basis_entry.executable
1816
 
            else:
1817
 
                path_in_source = None
1818
 
                basis_parent = None
1819
 
                basis_name = None
1820
 
                basis_executable = None
1821
 
            if self_value is not None:
1822
 
                self_entry = self._bytes_to_entry(self_value)
1823
 
                path_in_target = self.id2path(file_id)
1824
 
                self_parent = self_entry.parent_id
1825
 
                self_name = self_entry.name
1826
 
                self_executable = self_entry.executable
1827
 
            else:
1828
 
                path_in_target = None
1829
 
                self_parent = None
1830
 
                self_name = None
1831
 
                self_executable = None
1832
 
            if basis_value is None:
1833
 
                # add
1834
 
                kind = (None, self_entry.kind)
1835
 
                versioned = (False, True)
1836
 
            elif self_value is None:
1837
 
                # delete
1838
 
                kind = (basis_entry.kind, None)
1839
 
                versioned = (True, False)
1840
 
            else:
1841
 
                kind = (basis_entry.kind, self_entry.kind)
1842
 
                versioned = (True, True)
1843
 
            changed_content = False
1844
 
            if kind[0] != kind[1]:
1845
 
                changed_content = True
1846
 
            elif kind[0] == 'file':
1847
 
                if (self_entry.text_size != basis_entry.text_size or
1848
 
                    self_entry.text_sha1 != basis_entry.text_sha1):
1849
 
                    changed_content = True
1850
 
            elif kind[0] == 'symlink':
1851
 
                if self_entry.symlink_target != basis_entry.symlink_target:
1852
 
                    changed_content = True
1853
 
            elif kind[0] == 'tree-reference':
1854
 
                if (self_entry.reference_revision !=
1855
 
                    basis_entry.reference_revision):
1856
 
                    changed_content = True
1857
 
            parent = (basis_parent, self_parent)
1858
 
            name = (basis_name, self_name)
1859
 
            executable = (basis_executable, self_executable)
1860
 
            if (not changed_content
1861
 
                and parent[0] == parent[1]
1862
 
                and name[0] == name[1]
1863
 
                and executable[0] == executable[1]):
1864
 
                # Could happen when only the revision changed for a directory
1865
 
                # for instance.
1866
 
                continue
1867
 
            yield (file_id, (path_in_source, path_in_target), changed_content,
1868
 
                versioned, parent, name, kind, executable)
1869
 
 
1870
 
    def __len__(self):
1871
 
        """Return the number of entries in the inventory."""
1872
 
        return len(self.id_to_entry)
1873
 
 
1874
 
    def _make_delta(self, old):
1875
 
        """Make an inventory delta from two inventories."""
1876
 
        if type(old) != CHKInventory:
1877
 
            return CommonInventory._make_delta(self, old)
1878
 
        delta = []
1879
 
        for key, old_value, self_value in \
1880
 
            self.id_to_entry.iter_changes(old.id_to_entry):
1881
 
            file_id = key[0]
1882
 
            if old_value is not None:
1883
 
                old_path = old.id2path(file_id)
1884
 
            else:
1885
 
                old_path = None
1886
 
            if self_value is not None:
1887
 
                entry = self._bytes_to_entry(self_value)
1888
 
                self._fileid_to_entry_cache[file_id] = entry
1889
 
                new_path = self.id2path(file_id)
1890
 
            else:
1891
 
                entry = None
1892
 
                new_path = None
1893
 
            delta.append((old_path, new_path, file_id, entry))
1894
 
        return delta
1895
 
 
1896
 
    def path2id(self, name):
1897
 
        """See CommonInventory.path2id()."""
1898
 
        result = self._path_to_fileid_cache.get(name, None)
1899
 
        if result is None:
1900
 
            result = CommonInventory.path2id(self, name)
1901
 
            self._path_to_fileid_cache[name] = result
1902
 
        return result
1903
 
 
1904
 
    def to_lines(self):
1905
 
        """Serialise the inventory to lines."""
1906
 
        lines = ["chkinventory:\n"]
1907
 
        if self._search_key_name != 'plain':
1908
 
            # custom ordering grouping things that don't change together
1909
 
            lines.append('search_key_name: %s\n' % (self._search_key_name,))
1910
 
            lines.append("root_id: %s\n" % self.root_id)
1911
 
            lines.append('parent_id_basename_to_file_id: %s\n' %
1912
 
                self.parent_id_basename_to_file_id.key())
1913
 
            lines.append("revision_id: %s\n" % self.revision_id)
1914
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1915
 
        else:
1916
 
            lines.append("revision_id: %s\n" % self.revision_id)
1917
 
            lines.append("root_id: %s\n" % self.root_id)
1918
 
            if self.parent_id_basename_to_file_id is not None:
1919
 
                lines.append('parent_id_basename_to_file_id: %s\n' %
1920
 
                    self.parent_id_basename_to_file_id.key())
1921
 
            lines.append("id_to_entry: %s\n" % self.id_to_entry.key())
1922
 
        return lines
1923
 
 
1924
 
    @property
1925
 
    def root(self):
1926
 
        """Get the root entry."""
1927
 
        return self[self.root_id]
1928
 
 
1929
 
 
1930
 
class CHKInventoryDirectory(InventoryDirectory):
1931
 
    """A directory in an inventory."""
1932
 
 
1933
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1934
 
                 'text_id', 'parent_id', '_children', 'executable',
1935
 
                 'revision', 'symlink_target', 'reference_revision',
1936
 
                 '_chk_inventory']
1937
 
 
1938
 
    def __init__(self, file_id, name, parent_id, chk_inventory):
1939
 
        # Don't call InventoryDirectory.__init__ - it isn't right for this
1940
 
        # class.
1941
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
1942
 
        self._children = None
1943
 
        self.kind = 'directory'
1944
 
        self._chk_inventory = chk_inventory
1945
 
 
1946
 
    @property
1947
 
    def children(self):
1948
 
        """Access the list of children of this directory.
1949
 
 
1950
 
        With a parent_id_basename_to_file_id index, loads all the children,
1951
 
        without loads the entire index. Without is bad. A more sophisticated
1952
 
        proxy object might be nice, to allow partial loading of children as
1953
 
        well when specific names are accessed. (So path traversal can be
1954
 
        written in the obvious way but not examine siblings.).
1955
 
        """
1956
 
        if self._children is not None:
1957
 
            return self._children
1958
 
        # No longer supported
1959
 
        if self._chk_inventory.parent_id_basename_to_file_id is None:
1960
 
            raise AssertionError("Inventories without"
1961
 
                " parent_id_basename_to_file_id are no longer supported")
1962
 
        result = {}
1963
 
        # XXX: Todo - use proxy objects for the children rather than loading
1964
 
        # all when the attribute is referenced.
1965
 
        parent_id_index = self._chk_inventory.parent_id_basename_to_file_id
1966
 
        child_keys = set()
1967
 
        for (parent_id, name_utf8), file_id in parent_id_index.iteritems(
1968
 
            key_filter=[(self.file_id,)]):
1969
 
            child_keys.add((file_id,))
1970
 
        cached = set()
1971
 
        for file_id_key in child_keys:
1972
 
            entry = self._chk_inventory._fileid_to_entry_cache.get(
1973
 
                file_id_key[0], None)
1974
 
            if entry is not None:
1975
 
                result[entry.name] = entry
1976
 
                cached.add(file_id_key)
1977
 
        child_keys.difference_update(cached)
1978
 
        # populate; todo: do by name
1979
 
        id_to_entry = self._chk_inventory.id_to_entry
1980
 
        for file_id_key, bytes in id_to_entry.iteritems(child_keys):
1981
 
            entry = self._chk_inventory._bytes_to_entry(bytes)
1982
 
            result[entry.name] = entry
1983
 
            self._chk_inventory._fileid_to_entry_cache[file_id_key[0]] = entry
1984
 
        self._children = result
1985
 
        return result
1986
 
 
1987
1373
entry_factory = {
1988
1374
    'directory': InventoryDirectory,
1989
1375
    'file': InventoryFile,
2001
1387
    """
2002
1388
    if file_id is None:
2003
1389
        file_id = generate_ids.gen_file_id(name)
2004
 
    name = ensure_normalized_name(name)
2005
 
    try:
2006
 
        factory = entry_factory[kind]
2007
 
    except KeyError:
2008
 
        raise BzrError("unknown kind %r" % kind)
2009
 
    return factory(file_id, name, parent_id)
2010
 
 
2011
 
 
2012
 
def ensure_normalized_name(name):
2013
 
    """Normalize name.
2014
 
 
2015
 
    :raises InvalidNormalization: When name is not normalized, and cannot be
2016
 
        accessed on this platform by the normalized path.
2017
 
    :return: The NFC normalised version of name.
2018
 
    """
 
1390
    else:
 
1391
        file_id = osutils.safe_file_id(file_id)
 
1392
 
2019
1393
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
2020
1394
    # keep them synchronised.
2021
1395
    # we dont import normalized_filename directly because we want to be
2023
1397
    norm_name, can_access = osutils.normalized_filename(name)
2024
1398
    if norm_name != name:
2025
1399
        if can_access:
2026
 
            return norm_name
 
1400
            name = norm_name
2027
1401
        else:
2028
1402
            # TODO: jam 20060701 This would probably be more useful
2029
1403
            #       if the error was raised with the full path
2030
1404
            raise errors.InvalidNormalization(name)
2031
 
    return name
 
1405
 
 
1406
    try:
 
1407
        factory = entry_factory[kind]
 
1408
    except KeyError:
 
1409
        raise BzrError("unknown kind %r" % kind)
 
1410
    return factory(file_id, name, parent_id)
2032
1411
 
2033
1412
 
2034
1413
_NAME_RE = None
2037
1416
    global _NAME_RE
2038
1417
    if _NAME_RE is None:
2039
1418
        _NAME_RE = re.compile(r'^[^/\\]+$')
2040
 
 
 
1419
        
2041
1420
    return bool(_NAME_RE.match(name))