~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

[merge] jam-integration

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006, 2007 Canonical Ltd
 
1
# (C) 2005 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
27
27
# created, but it's not for now.
28
28
ROOT_ID = "TREE_ROOT"
29
29
 
30
 
import os
 
30
 
 
31
import os.path
31
32
import re
32
33
import sys
33
 
 
34
 
from bzrlib.lazy_import import lazy_import
35
 
lazy_import(globals(), """
36
 
import collections
37
34
import tarfile
 
35
import types
38
36
 
39
37
import bzrlib
40
 
from bzrlib import (
41
 
    errors,
42
 
    generate_ids,
43
 
    osutils,
44
 
    symbol_versioning,
45
 
    workingtree,
46
 
    )
47
 
""")
48
 
 
49
 
from bzrlib.errors import (
50
 
    BzrCheckError,
51
 
    BzrError,
52
 
    )
53
 
from bzrlib.symbol_versioning import deprecated_method, zero_ninetyone
 
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
39
                            pathjoin, sha_strings)
54
40
from bzrlib.trace import mutter
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError)
55
43
 
56
44
 
57
45
class InventoryEntry(object):
88
76
    >>> i.path2id('')
89
77
    'TREE_ROOT'
90
78
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
91
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
 
79
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
92
80
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
93
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
94
 
    >>> shouldbe = {0: '', 1: 'src', 2: 'src/hello.c'}
 
81
    InventoryFile('2323', 'hello.c', parent_id='123')
 
82
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
95
83
    >>> for ix, j in enumerate(i.iter_entries()):
96
84
    ...   print (j[0] == shouldbe[ix], j[1])
97
85
    ... 
98
 
    (True, InventoryDirectory('TREE_ROOT', u'', parent_id=None, revision=None))
99
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
100
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
 
86
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
87
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
 
88
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
89
    Traceback (most recent call last):
 
90
    ...
 
91
    BzrError: inventory already contains entry with id {2323}
101
92
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
102
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
 
93
    InventoryFile('2324', 'bye.c', parent_id='123')
103
94
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
104
 
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
 
95
    InventoryDirectory('2325', 'wibble', parent_id='123')
105
96
    >>> i.path2id('src/wibble')
106
97
    '2325'
107
98
    >>> '2325' in i
108
99
    True
109
100
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
110
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
101
    InventoryFile('2326', 'wibble.c', parent_id='2325')
111
102
    >>> i['2326']
112
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
103
    InventoryFile('2326', 'wibble.c', parent_id='2325')
113
104
    >>> for path, entry in i.iter_entries():
114
105
    ...     print path
115
106
    ...     assert i.path2id(path)
116
107
    ... 
117
 
    <BLANKLINE>
118
108
    src
119
109
    src/bye.c
120
110
    src/hello.c
123
113
    >>> i.id2path('2326')
124
114
    'src/wibble/wibble.c'
125
115
    """
126
 
 
127
 
    # Constants returned by describe_change()
128
 
    #
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 
131
 
    # generate them just for one file at a time.
132
 
    RENAMED = 'renamed'
133
 
    MODIFIED_AND_RENAMED = 'modified and renamed'
134
116
    
135
 
    __slots__ = []
 
117
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
118
                 'text_id', 'parent_id', 'children', 'executable', 
 
119
                 'revision']
 
120
 
 
121
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
 
122
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
 
123
                             transaction)
136
124
 
137
125
    def detect_changes(self, old_entry):
138
126
        """Return a (text_modified, meta_modified) from this to old_entry.
162
150
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
163
151
             output_to, reverse=False):
164
152
        """Perform a diff between two entries of the same kind."""
165
 
    
166
 
    def parent_candidates(self, previous_inventories):
167
 
        """Find possible per-file graph parents.
168
 
 
169
 
        This is currently defined by:
170
 
         - Select the last changed revision in the parent inventory.
171
 
         - Do deal with a short lived bug in bzr 0.8's development two entries
172
 
           that have the same last changed but different 'x' bit settings are
173
 
           changed in-place.
 
153
 
 
154
    def find_previous_heads(self, previous_inventories, entry_weave):
 
155
        """Return the revisions and entries that directly preceed this.
 
156
 
 
157
        Returned as a map from revision to inventory entry.
 
158
 
 
159
        This is a map containing the file revisions in all parents
 
160
        for which the file exists, and its revision is not a parent of
 
161
        any other. If the file is new, the set will be empty.
174
162
        """
175
 
        # revision:ie mapping for each ie found in previous_inventories.
176
 
        candidates = {}
177
 
        # identify candidate head revision ids.
 
163
        def get_ancestors(weave, entry):
 
164
            return set(map(weave.idx_to_name,
 
165
                           weave.inclusions([weave.lookup(entry.revision)])))
 
166
        heads = {}
 
167
        head_ancestors = {}
178
168
        for inv in previous_inventories:
179
169
            if self.file_id in inv:
180
170
                ie = inv[self.file_id]
181
171
                assert ie.file_id == self.file_id
182
 
                if ie.revision in candidates:
183
 
                    # same revision value in two different inventories:
184
 
                    # correct possible inconsistencies:
185
 
                    #     * there was a bug in revision updates with 'x' bit 
186
 
                    #       support.
 
172
                if ie.revision in heads:
 
173
                    # fixup logic, there was a bug in revision updates.
 
174
                    # with x bit support.
187
175
                    try:
188
 
                        if candidates[ie.revision].executable != ie.executable:
189
 
                            candidates[ie.revision].executable = False
 
176
                        if heads[ie.revision].executable != ie.executable:
 
177
                            heads[ie.revision].executable = False
190
178
                            ie.executable = False
191
179
                    except AttributeError:
192
180
                        pass
193
 
                    # must now be the same.
194
 
                    assert candidates[ie.revision] == ie
 
181
                    assert heads[ie.revision] == ie
195
182
                else:
196
 
                    # add this revision as a candidate.
197
 
                    candidates[ie.revision] = ie
198
 
        return candidates
199
 
 
200
 
    @deprecated_method(zero_ninetyone)
201
 
    def find_previous_heads(self, previous_inventories,
202
 
                            versioned_file_store,
203
 
                            transaction,
204
 
                            entry_vf=None):
205
 
        """Return the revisions and entries that directly precede this.
206
 
 
207
 
        Returned as a map from revision to inventory entry.
208
 
 
209
 
        This is a map containing the file revisions in all parents
210
 
        for which the file exists, and its revision is not a parent of
211
 
        any other. If the file is new, the set will be empty.
212
 
 
213
 
        :param versioned_file_store: A store where ancestry data on this
214
 
                                     file id can be queried.
215
 
        :param transaction: The transaction that queries to the versioned 
216
 
                            file store should be completed under.
217
 
        :param entry_vf: The entry versioned file, if its already available.
218
 
        """
219
 
        candidates = self.parent_candidates(previous_inventories)
220
 
 
221
 
        # revision:ie mapping with one revision for each head.
222
 
        heads = {}
223
 
        # common case optimisation
224
 
        if len(candidates) == 1:
225
 
            # if there is only one candidate revision found
226
 
            # then we can avoid opening the versioned file to access ancestry:
227
 
            # there cannot be any ancestors to eliminate when there is 
228
 
            # only one revision available.
229
 
            return candidates
230
 
        
231
 
        # --- what follows is now encapsulated in repository.get_graph.heads(), 
232
 
        #     but that is not accessible from here as we have no repository
233
 
        #     pointer. Note that the repository.get_graph.heads() call can return
234
 
        #     different results *at the moment* because of the kind-changing check
235
 
        #     we have in parent_candidates().
236
 
 
237
 
        # eliminate ancestors amongst the available candidates:
238
 
        # heads are those that are not an ancestor of any other candidate
239
 
        # - this provides convergence at a per-file level.
240
 
        def get_ancestors(weave, entry):
241
 
            return set(weave.get_ancestry(entry.revision, topo_sorted=False))
242
 
        # revision: ancestor list for each head
243
 
        head_ancestors = {}
244
 
        for ie in candidates.values():
245
 
            # may be an ancestor of a known head:
246
 
            already_present = 0 != len(
247
 
                [head for head in heads 
248
 
                 if ie.revision in head_ancestors[head]])
249
 
            if already_present:
250
 
                # an ancestor of an analyzed candidate.
251
 
                continue
252
 
            # not an ancestor of a known head:
253
 
            # load the versioned file for this file id if needed
254
 
            if entry_vf is None:
255
 
                entry_vf = versioned_file_store.get_weave_or_empty(
256
 
                    self.file_id, transaction)
257
 
            ancestors = get_ancestors(entry_vf, ie)
258
 
            # may knock something else out:
259
 
            check_heads = list(heads.keys())
260
 
            for head in check_heads:
261
 
                if head in ancestors:
262
 
                    # this previously discovered 'head' is not
263
 
                    # really a head - its an ancestor of the newly 
264
 
                    # found head,
265
 
                    heads.pop(head)
266
 
            head_ancestors[ie.revision] = ancestors
267
 
            heads[ie.revision] = ie
 
183
                    # may want to add it.
 
184
                    # may already be covered:
 
185
                    already_present = 0 != len(
 
186
                        [head for head in heads 
 
187
                         if ie.revision in head_ancestors[head]])
 
188
                    if already_present:
 
189
                        # an ancestor of a known head.
 
190
                        continue
 
191
                    # definately a head:
 
192
                    ancestors = get_ancestors(entry_weave, ie)
 
193
                    # may knock something else out:
 
194
                    check_heads = list(heads.keys())
 
195
                    for head in check_heads:
 
196
                        if head in ancestors:
 
197
                            # this head is not really a head
 
198
                            heads.pop(head)
 
199
                    head_ancestors[ie.revision] = ancestors
 
200
                    heads[ie.revision] = ie
268
201
        return heads
269
202
 
270
203
    def get_tar_item(self, root, dp, now, tree):
271
204
        """Get a tarfile item and a file stream for its content."""
272
 
        item = tarfile.TarInfo(osutils.pathjoin(root, dp).encode('utf8'))
 
205
        item = tarfile.TarInfo(pathjoin(root, dp))
273
206
        # TODO: would be cool to actually set it to the timestamp of the
274
207
        # revision it was last changed
275
208
        item.mtime = now
304
237
        """
305
238
        assert isinstance(name, basestring), name
306
239
        if '/' in name or '\\' in name:
307
 
            raise errors.InvalidEntryName(name=name)
 
240
            raise InvalidEntryName(name=name)
308
241
        self.executable = False
309
242
        self.revision = None
310
243
        self.text_sha1 = None
311
244
        self.text_size = None
312
245
        self.file_id = file_id
313
 
        assert isinstance(file_id, (str, None.__class__)), \
314
 
            'bad type %r for %r' % (type(file_id), file_id)
315
246
        self.name = name
316
247
        self.text_id = text_id
317
248
        self.parent_id = parent_id
318
249
        self.symlink_target = None
319
 
        self.reference_revision = None
320
250
 
321
251
    def kind_character(self):
322
252
        """Return a short kind indicator useful for appending to names."""
323
253
        raise BzrError('unknown kind %r' % self.kind)
324
254
 
325
 
    known_kinds = ('file', 'directory', 'symlink')
 
255
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
326
256
 
327
257
    def _put_in_tar(self, item, tree):
328
258
        """populate item for stashing in a tar, and return the content stream.
337
267
        
338
268
        This is a template method - implement _put_on_disk in subclasses.
339
269
        """
340
 
        fullpath = osutils.pathjoin(dest, dp)
 
270
        fullpath = pathjoin(dest, dp)
341
271
        self._put_on_disk(fullpath, tree)
342
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
343
 
        #         self.kind, fullpath)
 
272
        mutter("  export {%s} kind %s to %s", self.file_id,
 
273
                self.kind, fullpath)
344
274
 
345
275
    def _put_on_disk(self, fullpath, tree):
346
276
        """Put this entry onto disk at fullpath, from tree tree."""
347
277
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
348
278
 
349
279
    def sorted_children(self):
350
 
        return sorted(self.children.items())
 
280
        l = self.children.items()
 
281
        l.sort()
 
282
        return l
351
283
 
352
284
    @staticmethod
353
285
    def versionable_kind(kind):
354
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
286
        return kind in ('file', 'directory', 'symlink')
355
287
 
356
288
    def check(self, checker, rev_id, inv, tree):
357
289
        """Check this inventory entry is intact.
358
290
 
359
291
        This is a template method, override _check for kind specific
360
292
        tests.
361
 
 
362
 
        :param checker: Check object providing context for the checks; 
363
 
             can be used to find out what parts of the repository have already
364
 
             been checked.
365
 
        :param rev_id: Revision id from which this InventoryEntry was loaded.
366
 
             Not necessarily the last-changed revision for this file.
367
 
        :param inv: Inventory from which the entry was loaded.
368
 
        :param tree: RevisionTree for this entry.
369
293
        """
370
 
        if self.parent_id is not None:
 
294
        if self.parent_id != None:
371
295
            if not inv.has_id(self.parent_id):
372
296
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
373
297
                        % (self.parent_id, rev_id))
378
302
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
379
303
                            (self.kind, rev_id))
380
304
 
 
305
 
381
306
    def copy(self):
382
307
        """Clone this inventory entry."""
383
308
        raise NotImplementedError
384
309
 
385
 
    @staticmethod
386
 
    def describe_change(old_entry, new_entry):
387
 
        """Describe the change between old_entry and this.
388
 
        
389
 
        This smells of being an InterInventoryEntry situation, but as its
390
 
        the first one, we're making it a static method for now.
391
 
 
392
 
        An entry with a different parent, or different name is considered 
393
 
        to be renamed. Reparenting is an internal detail.
394
 
        Note that renaming the parent does not trigger a rename for the
395
 
        child entry itself.
396
 
        """
397
 
        # TODO: Perhaps return an object rather than just a string
398
 
        if old_entry is new_entry:
399
 
            # also the case of both being None
400
 
            return 'unchanged'
401
 
        elif old_entry is None:
 
310
    def _get_snapshot_change(self, previous_entries):
 
311
        if len(previous_entries) > 1:
 
312
            return 'merged'
 
313
        elif len(previous_entries) == 0:
402
314
            return 'added'
403
 
        elif new_entry is None:
404
 
            return 'removed'
405
 
        if old_entry.kind != new_entry.kind:
406
 
            return 'modified'
407
 
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
408
 
        if text_modified or meta_modified:
409
 
            modified = True
410
 
        else:
411
 
            modified = False
412
 
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
413
 
        if old_entry.parent_id != new_entry.parent_id:
414
 
            renamed = True
415
 
        elif old_entry.name != new_entry.name:
416
 
            renamed = True
417
 
        else:
418
 
            renamed = False
419
 
        if renamed and not modified:
420
 
            return InventoryEntry.RENAMED
421
 
        if modified and not renamed:
422
 
            return 'modified'
423
 
        if modified and renamed:
424
 
            return InventoryEntry.MODIFIED_AND_RENAMED
425
 
        return 'unchanged'
 
315
        else:
 
316
            return 'modified/renamed/reparented'
426
317
 
427
318
    def __repr__(self):
428
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
319
        return ("%s(%r, %r, parent_id=%r)"
429
320
                % (self.__class__.__name__,
430
321
                   self.file_id,
431
322
                   self.name,
432
 
                   self.parent_id,
433
 
                   self.revision))
 
323
                   self.parent_id))
 
324
 
 
325
    def snapshot(self, revision, path, previous_entries,
 
326
                 work_tree, weave_store, transaction):
 
327
        """Make a snapshot of this entry which may or may not have changed.
 
328
        
 
329
        This means that all its fields are populated, that it has its
 
330
        text stored in the text store or weave.
 
331
        """
 
332
        mutter('new parents of %s are %r', path, previous_entries)
 
333
        self._read_tree_state(path, work_tree)
 
334
        if len(previous_entries) == 1:
 
335
            # cannot be unchanged unless there is only one parent file rev.
 
336
            parent_ie = previous_entries.values()[0]
 
337
            if self._unchanged(parent_ie):
 
338
                mutter("found unchanged entry")
 
339
                self.revision = parent_ie.revision
 
340
                return "unchanged"
 
341
        return self.snapshot_revision(revision, previous_entries, 
 
342
                                      work_tree, weave_store, transaction)
 
343
 
 
344
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
345
                          weave_store, transaction):
 
346
        """Record this revision unconditionally."""
 
347
        mutter('new revision for {%s}', self.file_id)
 
348
        self.revision = revision
 
349
        change = self._get_snapshot_change(previous_entries)
 
350
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
351
                            transaction)
 
352
        return change
 
353
 
 
354
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
355
        """Record the 'text' of this entry, whatever form that takes.
 
356
        
 
357
        This default implementation simply adds an empty text.
 
358
        """
 
359
        mutter('storing file {%s} in revision {%s}',
 
360
               self.file_id, self.revision)
 
361
        self._add_text_to_weave([], file_parents, weave_store, transaction)
434
362
 
435
363
    def __eq__(self, other):
436
364
        if not isinstance(other, InventoryEntry):
446
374
                and (self.kind == other.kind)
447
375
                and (self.revision == other.revision)
448
376
                and (self.executable == other.executable)
449
 
                and (self.reference_revision == other.reference_revision)
450
377
                )
451
378
 
452
379
    def __ne__(self, other):
458
385
    def _unchanged(self, previous_ie):
459
386
        """Has this entry changed relative to previous_ie.
460
387
 
461
 
        This method should be overridden in child classes.
 
388
        This method should be overriden in child classes.
462
389
        """
463
390
        compatible = True
464
391
        # different inv parent
467
394
        # renamed
468
395
        elif previous_ie.name != self.name:
469
396
            compatible = False
470
 
        elif previous_ie.kind != self.kind:
471
 
            compatible = False
472
397
        return compatible
473
398
 
474
399
    def _read_tree_state(self, path, work_tree):
482
407
        # first requested, or preload them if they're already known
483
408
        pass            # nothing to do by default
484
409
 
485
 
    def _forget_tree_state(self):
486
 
        pass
487
 
 
488
410
 
489
411
class RootEntry(InventoryEntry):
490
412
 
491
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
492
 
                 'text_id', 'parent_id', 'children', 'executable',
493
 
                 'revision', 'symlink_target', 'reference_revision']
494
 
 
495
413
    def _check(self, checker, rev_id, tree):
496
414
        """See InventoryEntry._check"""
497
415
 
498
416
    def __init__(self, file_id):
499
417
        self.file_id = file_id
500
418
        self.children = {}
501
 
        self.kind = 'directory'
 
419
        self.kind = 'root_directory'
502
420
        self.parent_id = None
503
421
        self.name = u''
504
 
        self.revision = None
505
 
        symbol_versioning.warn('RootEntry is deprecated as of bzr 0.10.'
506
 
                               '  Please use InventoryDirectory instead.',
507
 
                               DeprecationWarning, stacklevel=2)
508
422
 
509
423
    def __eq__(self, other):
510
424
        if not isinstance(other, RootEntry):
517
431
class InventoryDirectory(InventoryEntry):
518
432
    """A directory in an inventory."""
519
433
 
520
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
521
 
                 'text_id', 'parent_id', 'children', 'executable',
522
 
                 'revision', 'symlink_target', 'reference_revision']
523
 
 
524
434
    def _check(self, checker, rev_id, tree):
525
435
        """See InventoryEntry._check"""
526
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
436
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
527
437
            raise BzrCheckError('directory {%s} has text in revision {%s}'
528
438
                                % (self.file_id, rev_id))
529
439
 
560
470
class InventoryFile(InventoryEntry):
561
471
    """A file in an inventory."""
562
472
 
563
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
564
 
                 'text_id', 'parent_id', 'children', 'executable',
565
 
                 'revision', 'symlink_target', 'reference_revision']
566
 
 
567
 
    def _check(self, checker, tree_revision_id, tree):
 
473
    def _check(self, checker, rev_id, tree):
568
474
        """See InventoryEntry._check"""
569
 
        t = (self.file_id, self.revision)
 
475
        revision = self.revision
 
476
        t = (self.file_id, revision)
570
477
        if t in checker.checked_texts:
571
 
            prev_sha = checker.checked_texts[t]
 
478
            prev_sha = checker.checked_texts[t] 
572
479
            if prev_sha != self.text_sha1:
573
 
                raise BzrCheckError(
574
 
                    'mismatched sha1 on {%s} in {%s} (%s != %s) %r' %
575
 
                    (self.file_id, tree_revision_id, prev_sha, self.text_sha1,
576
 
                     t))
 
480
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
481
                                    (self.file_id, rev_id))
577
482
            else:
578
483
                checker.repeated_text_cnt += 1
579
484
                return
580
485
 
581
486
        if self.file_id not in checker.checked_weaves:
582
487
            mutter('check weave {%s}', self.file_id)
583
 
            w = tree._get_weave(self.file_id)
 
488
            w = tree.get_weave(self.file_id)
584
489
            # Not passing a progress bar, because it creates a new
585
490
            # progress, which overwrites the current progress,
586
491
            # and doesn't look nice
587
492
            w.check()
588
493
            checker.checked_weaves[self.file_id] = True
589
494
        else:
590
 
            w = tree._get_weave(self.file_id)
 
495
            w = tree.get_weave_prelude(self.file_id)
591
496
 
592
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
593
 
        checker.checked_text_cnt += 1
 
497
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
498
        checker.checked_text_cnt += 1 
594
499
        # We can't check the length, because Weave doesn't store that
595
500
        # information, and the whole point of looking at the weave's
596
501
        # sha1sum is that we don't have to extract the text.
610
515
 
611
516
    def detect_changes(self, old_entry):
612
517
        """See InventoryEntry.detect_changes."""
613
 
        assert self.text_sha1 is not None
614
 
        assert old_entry.text_sha1 is not None
 
518
        assert self.text_sha1 != None
 
519
        assert old_entry.text_sha1 != None
615
520
        text_modified = (self.text_sha1 != old_entry.text_sha1)
616
521
        meta_modified = (self.executable != old_entry.executable)
617
522
        return text_modified, meta_modified
619
524
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
620
525
             output_to, reverse=False):
621
526
        """See InventoryEntry._diff."""
622
 
        try:
623
 
            from_text = tree.get_file(self.file_id).readlines()
624
 
            if to_entry:
625
 
                to_text = to_tree.get_file(to_entry.file_id).readlines()
626
 
            else:
627
 
                to_text = []
628
 
            if not reverse:
629
 
                text_diff(from_label, from_text,
630
 
                          to_label, to_text, output_to)
631
 
            else:
632
 
                text_diff(to_label, to_text,
633
 
                          from_label, from_text, output_to)
634
 
        except errors.BinaryFile:
635
 
            if reverse:
636
 
                label_pair = (to_label, from_label)
637
 
            else:
638
 
                label_pair = (from_label, to_label)
639
 
            output_to.write(
640
 
                  ("Binary files %s and %s differ\n" % label_pair).encode('utf8'))
 
527
        from_text = tree.get_file(self.file_id).readlines()
 
528
        if to_entry:
 
529
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
530
        else:
 
531
            to_text = []
 
532
        if not reverse:
 
533
            text_diff(from_label, from_text,
 
534
                      to_label, to_text, output_to)
 
535
        else:
 
536
            text_diff(to_label, to_text,
 
537
                      from_label, from_text, output_to)
641
538
 
642
539
    def has_text(self):
643
540
        """See InventoryEntry.has_text."""
664
561
 
665
562
    def _put_on_disk(self, fullpath, tree):
666
563
        """See InventoryEntry._put_on_disk."""
667
 
        osutils.pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
564
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
668
565
        if tree.is_executable(self.file_id):
669
566
            os.chmod(fullpath, 0755)
670
567
 
671
568
    def _read_tree_state(self, path, work_tree):
672
569
        """See InventoryEntry._read_tree_state."""
673
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
674
 
        # FIXME: 20050930 probe for the text size when getting sha1
675
 
        # in _read_tree_state
676
 
        self.executable = work_tree.is_executable(self.file_id, path=path)
677
 
 
678
 
    def __repr__(self):
679
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
680
 
                % (self.__class__.__name__,
681
 
                   self.file_id,
682
 
                   self.name,
683
 
                   self.parent_id,
684
 
                   self.text_sha1,
685
 
                   self.text_size))
686
 
 
687
 
    def _forget_tree_state(self):
688
 
        self.text_sha1 = None
 
570
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
571
        self.executable = work_tree.is_executable(self.file_id)
 
572
 
 
573
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
574
        """See InventoryEntry._snapshot_text."""
 
575
        mutter('storing file {%s} in revision {%s}',
 
576
               self.file_id, self.revision)
 
577
        # special case to avoid diffing on renames or 
 
578
        # reparenting
 
579
        if (len(file_parents) == 1
 
580
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
581
            and self.text_size == file_parents.values()[0].text_size):
 
582
            previous_ie = file_parents.values()[0]
 
583
            weave_store.add_identical_text(
 
584
                self.file_id, previous_ie.revision, 
 
585
                self.revision, file_parents, transaction)
 
586
        else:
 
587
            new_lines = work_tree.get_file(self.file_id).readlines()
 
588
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
589
                                    transaction)
 
590
            self.text_sha1 = sha_strings(new_lines)
 
591
            self.text_size = sum(map(len, new_lines))
 
592
 
689
593
 
690
594
    def _unchanged(self, previous_ie):
691
595
        """See InventoryEntry._unchanged."""
704
608
class InventoryLink(InventoryEntry):
705
609
    """A file in an inventory."""
706
610
 
707
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
708
 
                 'text_id', 'parent_id', 'children', 'executable',
709
 
                 'revision', 'symlink_target', 'reference_revision']
 
611
    __slots__ = ['symlink_target']
710
612
 
711
613
    def _check(self, checker, rev_id, tree):
712
614
        """See InventoryEntry._check"""
713
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
615
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
714
616
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
715
617
                    % (self.file_id, rev_id))
716
 
        if self.symlink_target is None:
 
618
        if self.symlink_target == None:
717
619
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
718
620
                    % (self.file_id, rev_id))
719
621
 
742
644
                temp = from_text
743
645
                from_text = to_text
744
646
                to_text = temp
745
 
            output_to.write('=== target changed %r => %r\n' % (from_text, to_text))
 
647
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
746
648
        else:
747
649
            if not reverse:
748
 
                output_to.write('=== target was %r\n' % self.symlink_target)
 
650
                print >>output_to, '=== target was %r' % self.symlink_target
749
651
            else:
750
 
                output_to.write('=== target is %r\n' % self.symlink_target)
 
652
                print >>output_to, '=== target is %r' % self.symlink_target
751
653
 
752
654
    def __init__(self, file_id, name, parent_id):
753
655
        super(InventoryLink, self).__init__(file_id, name, parent_id)
777
679
        """See InventoryEntry._read_tree_state."""
778
680
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
779
681
 
780
 
    def _forget_tree_state(self):
781
 
        self.symlink_target = None
782
 
 
783
682
    def _unchanged(self, previous_ie):
784
683
        """See InventoryEntry._unchanged."""
785
684
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
788
687
        return compatible
789
688
 
790
689
 
791
 
class TreeReference(InventoryEntry):
792
 
    
793
 
    kind = 'tree-reference'
794
 
    
795
 
    def __init__(self, file_id, name, parent_id, revision=None,
796
 
                 reference_revision=None):
797
 
        InventoryEntry.__init__(self, file_id, name, parent_id)
798
 
        self.revision = revision
799
 
        self.reference_revision = reference_revision
800
 
 
801
 
    def copy(self):
802
 
        return TreeReference(self.file_id, self.name, self.parent_id,
803
 
                             self.revision, self.reference_revision)
804
 
 
805
 
    def _read_tree_state(self, path, work_tree):
806
 
        """Populate fields in the inventory entry from the given tree.
807
 
        """
808
 
        self.reference_revision = work_tree.get_reference_revision(
809
 
            self.file_id, path)
810
 
 
811
 
    def _forget_tree_state(self):
812
 
        self.reference_revision = None 
813
 
 
814
 
    def _unchanged(self, previous_ie):
815
 
        """See InventoryEntry._unchanged."""
816
 
        compatible = super(TreeReference, self)._unchanged(previous_ie)
817
 
        if self.reference_revision != previous_ie.reference_revision:
818
 
            compatible = False
819
 
        return compatible
820
 
 
821
 
 
822
690
class Inventory(object):
823
691
    """Inventory of versioned files in a tree.
824
692
 
838
706
 
839
707
    >>> inv = Inventory()
840
708
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
841
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
709
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
842
710
    >>> inv['123-123'].name
843
711
    'hello.c'
844
712
 
852
720
    May also look up by name:
853
721
 
854
722
    >>> [x[0] for x in inv.iter_entries()]
855
 
    ['', u'hello.c']
 
723
    ['hello.c']
856
724
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
857
725
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
858
 
    Traceback (most recent call last):
859
 
    BzrError: parent_id {TREE_ROOT} not in inventory
860
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', 'TREE_ROOT-12345678-12345678'))
861
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
 
726
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
862
727
    """
863
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
728
    def __init__(self, root_id=ROOT_ID):
864
729
        """Create or read an inventory.
865
730
 
866
731
        If a working directory is specified, the inventory is read
870
735
        The inventory is created with a default root directory, with
871
736
        an id of None.
872
737
        """
873
 
        if root_id is not None:
874
 
            assert root_id.__class__ == str
875
 
            self._set_root(InventoryDirectory(root_id, u'', None))
876
 
        else:
877
 
            self.root = None
878
 
            self._byid = {}
879
 
        self.revision_id = revision_id
880
 
 
881
 
    def __repr__(self):
882
 
        return "<Inventory object at %x, contents=%r>" % (id(self), self._byid)
883
 
 
884
 
    def apply_delta(self, delta):
885
 
        """Apply a delta to this inventory.
886
 
 
887
 
        :param delta: A list of changes to apply. After all the changes are
888
 
            applied the final inventory must be internally consistent, but it
889
 
            is ok to supply changes which, if only half-applied would have an
890
 
            invalid result - such as supplying two changes which rename two
891
 
            files, 'A' and 'B' with each other : [('A', 'B', 'A-id', a_entry),
892
 
            ('B', 'A', 'B-id', b_entry)].
893
 
 
894
 
            Each change is a tuple, of the form (old_path, new_path, file_id,
895
 
            new_entry).
896
 
            
897
 
            When new_path is None, the change indicates the removal of an entry
898
 
            from the inventory and new_entry will be ignored (using None is
899
 
            appropriate). If new_path is not None, then new_entry must be an
900
 
            InventoryEntry instance, which will be incorporated into the
901
 
            inventory (and replace any existing entry with the same file id).
902
 
            
903
 
            When old_path is None, the change indicates the addition of
904
 
            a new entry to the inventory.
905
 
            
906
 
            When neither new_path nor old_path are None, the change is a
907
 
            modification to an entry, such as a rename, reparent, kind change
908
 
            etc. 
909
 
 
910
 
            The children attribute of new_entry is ignored. This is because
911
 
            this method preserves children automatically across alterations to
912
 
            the parent of the children, and cases where the parent id of a
913
 
            child is changing require the child to be passed in as a separate
914
 
            change regardless. E.g. in the recursive deletion of a directory -
915
 
            the directory's children must be included in the delta, or the
916
 
            final inventory will be invalid.
917
 
        """
918
 
        children = {}
919
 
        # Remove all affected items which were in the original inventory,
920
 
        # starting with the longest paths, thus ensuring parents are examined
921
 
        # after their children, which means that everything we examine has no
922
 
        # modified children remaining by the time we examine it.
923
 
        for old_path, file_id in sorted(((op, f) for op, np, f, e in delta
924
 
                                        if op is not None), reverse=True):
925
 
            if file_id not in self:
926
 
                # adds come later
927
 
                continue
928
 
            # Preserve unaltered children of file_id for later reinsertion.
929
 
            children[file_id] = getattr(self[file_id], 'children', {})
930
 
            # Remove file_id and the unaltered children. If file_id is not
931
 
            # being deleted it will be reinserted back later.
932
 
            self.remove_recursive_id(file_id)
933
 
        # Insert all affected which should be in the new inventory, reattaching
934
 
        # their children if they had any. This is done from shortest path to
935
 
        # longest, ensuring that items which were modified and whose parents in
936
 
        # the resulting inventory were also modified, are inserted after their
937
 
        # parents.
938
 
        for new_path, new_entry in sorted((np, e) for op, np, f, e in
939
 
                                          delta if np is not None):
940
 
            if new_entry.kind == 'directory':
941
 
                new_entry.children = children.get(new_entry.file_id, {})
942
 
            self.add(new_entry)
943
 
 
944
 
    def _set_root(self, ie):
945
 
        self.root = ie
 
738
        # We are letting Branch.create() create a unique inventory
 
739
        # root id. Rather than generating a random one here.
 
740
        #if root_id is None:
 
741
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
742
        self.root = RootEntry(root_id)
946
743
        self._byid = {self.root.file_id: self.root}
947
744
 
 
745
 
948
746
    def copy(self):
949
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
950
 
        entries = self.iter_entries()
951
 
        if self.root is None:
952
 
            return Inventory(root_id=None)
953
 
        other = Inventory(entries.next()[1].file_id)
 
747
        other = Inventory(self.root.file_id)
954
748
        # copy recursively so we know directories will be added before
955
749
        # their children.  There are more efficient ways than this...
956
 
        for path, entry in entries:
 
750
        for path, entry in self.iter_entries():
 
751
            if entry == self.root:
 
752
                continue
957
753
            other.add(entry.copy())
958
754
        return other
959
755
 
 
756
 
960
757
    def __iter__(self):
961
758
        return iter(self._byid)
962
759
 
 
760
 
963
761
    def __len__(self):
964
762
        """Returns number of entries."""
965
763
        return len(self._byid)
966
764
 
 
765
 
967
766
    def iter_entries(self, from_dir=None):
968
767
        """Return (path, entry) pairs, in order by name."""
969
 
        if from_dir is None:
970
 
            if self.root is None:
971
 
                return
972
 
            from_dir = self.root
973
 
            yield '', self.root
974
 
        elif isinstance(from_dir, basestring):
975
 
            from_dir = self._byid[from_dir]
976
 
            
977
 
        # unrolling the recursive called changed the time from
978
 
        # 440ms/663ms (inline/total) to 116ms/116ms
979
 
        children = from_dir.children.items()
980
 
        children.sort()
981
 
        children = collections.deque(children)
982
 
        stack = [(u'', children)]
983
 
        while stack:
984
 
            from_dir_relpath, children = stack[-1]
985
 
 
986
 
            while children:
987
 
                name, ie = children.popleft()
988
 
 
989
 
                # we know that from_dir_relpath never ends in a slash
990
 
                # and 'f' doesn't begin with one, we can do a string op, rather
991
 
                # than the checks of pathjoin(), though this means that all paths
992
 
                # start with a slash
993
 
                path = from_dir_relpath + '/' + name
994
 
 
995
 
                yield path[1:], ie
996
 
 
997
 
                if ie.kind != 'directory':
998
 
                    continue
999
 
 
1000
 
                # But do this child first
1001
 
                new_children = ie.children.items()
1002
 
                new_children.sort()
1003
 
                new_children = collections.deque(new_children)
1004
 
                stack.append((path, new_children))
1005
 
                # Break out of inner loop, so that we start outer loop with child
1006
 
                break
1007
 
            else:
1008
 
                # if we finished all children, pop it off the stack
1009
 
                stack.pop()
1010
 
 
1011
 
    def iter_entries_by_dir(self, from_dir=None, specific_file_ids=None,
1012
 
        yield_parents=False):
1013
 
        """Iterate over the entries in a directory first order.
1014
 
 
1015
 
        This returns all entries for a directory before returning
1016
 
        the entries for children of a directory. This is not
1017
 
        lexicographically sorted order, and is a hybrid between
1018
 
        depth-first and breadth-first.
1019
 
 
1020
 
        :param yield_parents: If True, yield the parents from the root leading
1021
 
            down to specific_file_ids that have been requested. This has no
1022
 
            impact if specific_file_ids is None.
1023
 
        :return: This yields (path, entry) pairs
1024
 
        """
1025
 
        if specific_file_ids and not isinstance(specific_file_ids, set):
1026
 
            specific_file_ids = set(specific_file_ids)
1027
 
        # TODO? Perhaps this should return the from_dir so that the root is
1028
 
        # yielded? or maybe an option?
1029
 
        if from_dir is None:
1030
 
            if self.root is None:
1031
 
                return
1032
 
            # Optimize a common case
1033
 
            if (not yield_parents and specific_file_ids is not None and
1034
 
                len(specific_file_ids) == 1):
1035
 
                file_id = list(specific_file_ids)[0]
1036
 
                if file_id in self:
1037
 
                    yield self.id2path(file_id), self[file_id]
1038
 
                return 
1039
 
            from_dir = self.root
1040
 
            if (specific_file_ids is None or yield_parents or
1041
 
                self.root.file_id in specific_file_ids):
1042
 
                yield u'', self.root
1043
 
        elif isinstance(from_dir, basestring):
1044
 
            from_dir = self._byid[from_dir]
1045
 
 
1046
 
        if specific_file_ids is not None:
1047
 
            # TODO: jam 20070302 This could really be done as a loop rather
1048
 
            #       than a bunch of recursive calls.
1049
 
            parents = set()
1050
 
            byid = self._byid
1051
 
            def add_ancestors(file_id):
1052
 
                if file_id not in byid:
1053
 
                    return
1054
 
                parent_id = byid[file_id].parent_id
1055
 
                if parent_id is None:
1056
 
                    return
1057
 
                if parent_id not in parents:
1058
 
                    parents.add(parent_id)
1059
 
                    add_ancestors(parent_id)
1060
 
            for file_id in specific_file_ids:
1061
 
                add_ancestors(file_id)
1062
 
        else:
1063
 
            parents = None
1064
 
            
1065
 
        stack = [(u'', from_dir)]
1066
 
        while stack:
1067
 
            cur_relpath, cur_dir = stack.pop()
1068
 
 
1069
 
            child_dirs = []
1070
 
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
1071
 
 
1072
 
                child_relpath = cur_relpath + child_name
1073
 
 
1074
 
                if (specific_file_ids is None or 
1075
 
                    child_ie.file_id in specific_file_ids or
1076
 
                    (yield_parents and child_ie.file_id in parents)):
1077
 
                    yield child_relpath, child_ie
1078
 
 
1079
 
                if child_ie.kind == 'directory':
1080
 
                    if parents is None or child_ie.file_id in parents:
1081
 
                        child_dirs.append((child_relpath+'/', child_ie))
1082
 
            stack.extend(reversed(child_dirs))
1083
 
 
1084
 
    def make_entry(self, kind, name, parent_id, file_id=None):
1085
 
        """Simple thunk to bzrlib.inventory.make_entry."""
1086
 
        return make_entry(kind, name, parent_id, file_id)
 
768
        if from_dir == None:
 
769
            assert self.root
 
770
            from_dir = self.root
 
771
        elif isinstance(from_dir, basestring):
 
772
            from_dir = self._byid[from_dir]
 
773
            
 
774
        kids = from_dir.children.items()
 
775
        kids.sort()
 
776
        for name, ie in kids:
 
777
            yield name, ie
 
778
            if ie.kind == 'directory':
 
779
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
780
                    yield pathjoin(name, cn), cie
 
781
 
1087
782
 
1088
783
    def entries(self):
1089
784
        """Return list of (path, ie) for all entries except the root.
1095
790
            kids = dir_ie.children.items()
1096
791
            kids.sort()
1097
792
            for name, ie in kids:
1098
 
                child_path = osutils.pathjoin(dir_path, name)
 
793
                child_path = pathjoin(dir_path, name)
1099
794
                accum.append((child_path, ie))
1100
795
                if ie.kind == 'directory':
1101
796
                    descend(ie, child_path)
1103
798
        descend(self.root, u'')
1104
799
        return accum
1105
800
 
 
801
 
1106
802
    def directories(self):
1107
803
        """Return (path, entry) pairs for all directories, including the root.
1108
804
        """
1114
810
            kids.sort()
1115
811
 
1116
812
            for name, child_ie in kids:
1117
 
                child_path = osutils.pathjoin(parent_path, name)
 
813
                child_path = pathjoin(parent_path, name)
1118
814
                descend(child_ie, child_path)
1119
815
        descend(self.root, u'')
1120
816
        return accum
1121
817
        
 
818
 
 
819
 
1122
820
    def __contains__(self, file_id):
1123
821
        """True if this entry contains a file with given id.
1124
822
 
1125
823
        >>> inv = Inventory()
1126
824
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1127
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
825
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1128
826
        >>> '123' in inv
1129
827
        True
1130
828
        >>> '456' in inv
1131
829
        False
1132
830
        """
1133
 
        return (file_id in self._byid)
 
831
        return file_id in self._byid
 
832
 
1134
833
 
1135
834
    def __getitem__(self, file_id):
1136
835
        """Return the entry for given file_id.
1137
836
 
1138
837
        >>> inv = Inventory()
1139
838
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1140
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
839
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1141
840
        >>> inv['123123'].name
1142
841
        'hello.c'
1143
842
        """
1144
843
        try:
1145
844
            return self._byid[file_id]
1146
845
        except KeyError:
1147
 
            # really we're passing an inventory, not a tree...
1148
 
            raise errors.NoSuchId(self, file_id)
 
846
            if file_id == None:
 
847
                raise BzrError("can't look up file_id None")
 
848
            else:
 
849
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
850
 
1149
851
 
1150
852
    def get_file_kind(self, file_id):
1151
853
        return self._byid[file_id].kind
1153
855
    def get_child(self, parent_id, filename):
1154
856
        return self[parent_id].children.get(filename)
1155
857
 
1156
 
    def _add_child(self, entry):
1157
 
        """Add an entry to the inventory, without adding it to its parent"""
1158
 
        if entry.file_id in self._byid:
1159
 
            raise BzrError("inventory already contains entry with id {%s}" %
1160
 
                           entry.file_id)
1161
 
        self._byid[entry.file_id] = entry
1162
 
        for child in getattr(entry, 'children', {}).itervalues():
1163
 
            self._add_child(child)
1164
 
        return entry
1165
858
 
1166
859
    def add(self, entry):
1167
860
        """Add entry to inventory.
1172
865
        Returns the new entry object.
1173
866
        """
1174
867
        if entry.file_id in self._byid:
1175
 
            raise errors.DuplicateFileId(entry.file_id,
1176
 
                                         self._byid[entry.file_id])
1177
 
 
1178
 
        if entry.parent_id is None:
1179
 
            assert self.root is None and len(self._byid) == 0
1180
 
            self.root = entry
1181
 
        else:
1182
 
            try:
1183
 
                parent = self._byid[entry.parent_id]
1184
 
            except KeyError:
1185
 
                raise BzrError("parent_id {%s} not in inventory" %
1186
 
                               entry.parent_id)
1187
 
 
1188
 
            if entry.name in parent.children:
1189
 
                raise BzrError("%s is already versioned" %
1190
 
                        osutils.pathjoin(self.id2path(parent.file_id),
1191
 
                        entry.name).encode('utf-8'))
1192
 
            parent.children[entry.name] = entry
1193
 
        return self._add_child(entry)
1194
 
 
1195
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
868
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
869
 
 
870
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
871
            entry.parent_id = self.root.file_id
 
872
 
 
873
        try:
 
874
            parent = self._byid[entry.parent_id]
 
875
        except KeyError:
 
876
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
877
 
 
878
        if parent.children.has_key(entry.name):
 
879
            raise BzrError("%s is already versioned" %
 
880
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
881
 
 
882
        self._byid[entry.file_id] = entry
 
883
        parent.children[entry.name] = entry
 
884
        return entry
 
885
 
 
886
 
 
887
    def add_path(self, relpath, kind, file_id=None):
1196
888
        """Add entry from a path.
1197
889
 
1198
890
        The immediate parent must already be versioned.
1199
891
 
1200
892
        Returns the new entry object."""
 
893
        from bzrlib.workingtree import gen_file_id
1201
894
        
1202
 
        parts = osutils.splitpath(relpath)
1203
 
 
 
895
        parts = bzrlib.osutils.splitpath(relpath)
1204
896
        if len(parts) == 0:
1205
 
            if file_id is None:
1206
 
                file_id = generate_ids.gen_root_id()
1207
 
            self.root = InventoryDirectory(file_id, '', None)
1208
 
            self._byid = {self.root.file_id: self.root}
1209
 
            return self.root
 
897
            raise BzrError("cannot re-add root of inventory")
 
898
 
 
899
        if file_id == None:
 
900
            file_id = gen_file_id(relpath)
 
901
 
 
902
        parent_path = parts[:-1]
 
903
        parent_id = self.path2id(parent_path)
 
904
        if parent_id == None:
 
905
            raise NotVersionedError(path=parent_path)
 
906
        if kind == 'directory':
 
907
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
908
        elif kind == 'file':
 
909
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
910
        elif kind == 'symlink':
 
911
            ie = InventoryLink(file_id, parts[-1], parent_id)
1210
912
        else:
1211
 
            parent_path = parts[:-1]
1212
 
            parent_id = self.path2id(parent_path)
1213
 
            if parent_id is None:
1214
 
                raise errors.NotVersionedError(path=parent_path)
1215
 
        ie = make_entry(kind, parts[-1], parent_id, file_id)
 
913
            raise BzrError("unknown kind %r" % kind)
1216
914
        return self.add(ie)
1217
915
 
 
916
 
1218
917
    def __delitem__(self, file_id):
1219
918
        """Remove entry by id.
1220
919
 
1221
920
        >>> inv = Inventory()
1222
921
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1223
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
922
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1224
923
        >>> '123' in inv
1225
924
        True
1226
925
        >>> del inv['123']
1229
928
        """
1230
929
        ie = self[file_id]
1231
930
 
1232
 
        assert ie.parent_id is None or \
1233
 
            self[ie.parent_id].children[ie.name] == ie
 
931
        assert self[ie.parent_id].children[ie.name] == ie
1234
932
        
 
933
        # TODO: Test deleting all children; maybe hoist to a separate
 
934
        # deltree method?
 
935
        if ie.kind == 'directory':
 
936
            for cie in ie.children.values():
 
937
                del self[cie.file_id]
 
938
            del ie.children
 
939
 
1235
940
        del self._byid[file_id]
1236
 
        if ie.parent_id is not None:
1237
 
            del self[ie.parent_id].children[ie.name]
 
941
        del self[ie.parent_id].children[ie.name]
 
942
 
1238
943
 
1239
944
    def __eq__(self, other):
1240
945
        """Compare two sets by comparing their contents.
1244
949
        >>> i1 == i2
1245
950
        True
1246
951
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1247
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
952
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1248
953
        >>> i1 == i2
1249
954
        False
1250
955
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1251
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
956
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1252
957
        >>> i1 == i2
1253
958
        True
1254
959
        """
1255
960
        if not isinstance(other, Inventory):
1256
961
            return NotImplemented
1257
962
 
 
963
        if len(self._byid) != len(other._byid):
 
964
            # shortcut: obviously not the same
 
965
            return False
 
966
 
1258
967
        return self._byid == other._byid
1259
968
 
 
969
 
1260
970
    def __ne__(self, other):
1261
971
        return not self.__eq__(other)
1262
972
 
 
973
 
1263
974
    def __hash__(self):
1264
975
        raise ValueError('not hashable')
1265
976
 
1266
 
    def _iter_file_id_parents(self, file_id):
1267
 
        """Yield the parents of file_id up to the root."""
1268
 
        while file_id is not None:
1269
 
            try:
1270
 
                ie = self._byid[file_id]
1271
 
            except KeyError:
1272
 
                raise errors.NoSuchId(tree=None, file_id=file_id)
1273
 
            yield ie
1274
 
            file_id = ie.parent_id
1275
977
 
1276
978
    def get_idpath(self, file_id):
1277
979
        """Return a list of file_ids for the path to an entry.
1282
984
        root directory as depth 1.
1283
985
        """
1284
986
        p = []
1285
 
        for parent in self._iter_file_id_parents(file_id):
1286
 
            p.insert(0, parent.file_id)
 
987
        while file_id != None:
 
988
            try:
 
989
                ie = self._byid[file_id]
 
990
            except KeyError:
 
991
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
992
            p.insert(0, ie.file_id)
 
993
            file_id = ie.parent_id
1287
994
        return p
1288
995
 
 
996
 
1289
997
    def id2path(self, file_id):
1290
 
        """Return as a string the path to file_id.
 
998
        """Return as a list the path to file_id.
1291
999
        
1292
1000
        >>> i = Inventory()
1293
1001
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1296
1004
        src/foo.c
1297
1005
        """
1298
1006
        # get all names, skipping root
1299
 
        return '/'.join(reversed(
1300
 
            [parent.name for parent in 
1301
 
             self._iter_file_id_parents(file_id)][:-1]))
 
1007
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
1008
        if p:
 
1009
            return pathjoin(*p)
 
1010
        else:
 
1011
            return ''
1302
1012
            
 
1013
 
 
1014
 
1303
1015
    def path2id(self, name):
1304
1016
        """Walk down through directories to return entry of last component.
1305
1017
 
1309
1021
        This returns the entry of the last component in the path,
1310
1022
        which may be either a file or a directory.
1311
1023
 
1312
 
        Returns None IFF the path is not found.
 
1024
        Returns None iff the path is not found.
1313
1025
        """
1314
 
        if isinstance(name, basestring):
1315
 
            name = osutils.splitpath(name)
 
1026
        if isinstance(name, types.StringTypes):
 
1027
            name = splitpath(name)
1316
1028
 
1317
 
        # mutter("lookup path %r" % name)
 
1029
        mutter("lookup path %r" % name)
1318
1030
 
1319
1031
        parent = self.root
1320
 
        if parent is None:
1321
 
            return None
1322
1032
        for f in name:
1323
1033
            try:
1324
 
                children = getattr(parent, 'children', None)
1325
 
                if children is None:
1326
 
                    return None
1327
 
                cie = children[f]
 
1034
                cie = parent.children[f]
1328
1035
                assert cie.name == f
1329
1036
                assert cie.parent_id == parent.file_id
1330
1037
                parent = cie
1334
1041
 
1335
1042
        return parent.file_id
1336
1043
 
 
1044
 
1337
1045
    def has_filename(self, names):
1338
1046
        return bool(self.path2id(names))
1339
1047
 
 
1048
 
1340
1049
    def has_id(self, file_id):
1341
 
        return (file_id in self._byid)
 
1050
        return self._byid.has_key(file_id)
1342
1051
 
1343
 
    def remove_recursive_id(self, file_id):
1344
 
        """Remove file_id, and children, from the inventory.
1345
 
        
1346
 
        :param file_id: A file_id to remove.
1347
 
        """
1348
 
        to_find_delete = [self._byid[file_id]]
1349
 
        to_delete = []
1350
 
        while to_find_delete:
1351
 
            ie = to_find_delete.pop()
1352
 
            to_delete.append(ie.file_id)
1353
 
            if ie.kind == 'directory':
1354
 
                to_find_delete.extend(ie.children.values())
1355
 
        for file_id in reversed(to_delete):
1356
 
            ie = self[file_id]
1357
 
            del self._byid[file_id]
1358
 
        if ie.parent_id is not None:
1359
 
            del self[ie.parent_id].children[ie.name]
1360
 
        else:
1361
 
            self.root = None
1362
1052
 
1363
1053
    def rename(self, file_id, new_parent_id, new_name):
1364
1054
        """Move a file within the inventory.
1365
1055
 
1366
1056
        This can change either the name, or the parent, or both.
1367
1057
 
1368
 
        This does not move the working file.
1369
 
        """
1370
 
        new_name = ensure_normalized_name(new_name)
 
1058
        This does not move the working file."""
1371
1059
        if not is_valid_name(new_name):
1372
1060
            raise BzrError("not an acceptable filename: %r" % new_name)
1373
1061
 
1391
1079
        file_ie.name = new_name
1392
1080
        file_ie.parent_id = new_parent_id
1393
1081
 
1394
 
    def is_root(self, file_id):
1395
 
        return self.root is not None and file_id == self.root.file_id
1396
 
 
1397
 
 
1398
 
entry_factory = {
1399
 
    'directory': InventoryDirectory,
1400
 
    'file': InventoryFile,
1401
 
    'symlink': InventoryLink,
1402
 
    'tree-reference': TreeReference
1403
 
}
1404
 
 
1405
 
def make_entry(kind, name, parent_id, file_id=None):
1406
 
    """Create an inventory entry.
1407
 
 
1408
 
    :param kind: the type of inventory entry to create.
1409
 
    :param name: the basename of the entry.
1410
 
    :param parent_id: the parent_id of the entry.
1411
 
    :param file_id: the file_id to use. if None, one will be created.
1412
 
    """
1413
 
    if file_id is None:
1414
 
        file_id = generate_ids.gen_file_id(name)
1415
 
    name = ensure_normalized_name(name)
1416
 
    try:
1417
 
        factory = entry_factory[kind]
1418
 
    except KeyError:
1419
 
        raise BzrError("unknown kind %r" % kind)
1420
 
    return factory(file_id, name, parent_id)
1421
 
 
1422
 
 
1423
 
def ensure_normalized_name(name):
1424
 
    """Normalize name.
1425
 
 
1426
 
    :raises InvalidNormalization: When name is not normalized, and cannot be
1427
 
        accessed on this platform by the normalized path.
1428
 
    :return: The NFC/NFKC normalised version of name.
1429
 
    """
1430
 
    #------- This has been copied to bzrlib.dirstate.DirState.add, please
1431
 
    # keep them synchronised.
1432
 
    # we dont import normalized_filename directly because we want to be
1433
 
    # able to change the implementation at runtime for tests.
1434
 
    norm_name, can_access = osutils.normalized_filename(name)
1435
 
    if norm_name != name:
1436
 
        if can_access:
1437
 
            return norm_name
1438
 
        else:
1439
 
            # TODO: jam 20060701 This would probably be more useful
1440
 
            #       if the error was raised with the full path
1441
 
            raise errors.InvalidNormalization(name)
1442
 
    return name
 
1082
 
1443
1083
 
1444
1084
 
1445
1085
_NAME_RE = None
1446
1086
 
1447
1087
def is_valid_name(name):
1448
1088
    global _NAME_RE
1449
 
    if _NAME_RE is None:
 
1089
    if _NAME_RE == None:
1450
1090
        _NAME_RE = re.compile(r'^[^/\\]+$')
1451
1091
        
1452
1092
    return bool(_NAME_RE.match(name))