/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-08-04 22:04:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050804220440-99562df8151d1ac5
- add pending merge from aaron

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
# (C) 2005 Canonical Ltd
 
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
#
 
7
 
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
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
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 
18
 
# the WorkingTree's copy of the inventory in sync with the branch.  The
19
 
# branch modifies its working inventory when it does a commit to make
20
 
# missing files permanently removed.
21
 
 
22
 
# TODO: Maybe also keep the full path of the entry, and the children?
23
 
# But those depend on its position within a particular inventory, and
24
 
# it would be nice not to need to hold the backpointer here.
25
17
 
26
18
# This should really be an id randomly assigned when the tree is
27
19
# created, but it's not for now.
28
20
ROOT_ID = "TREE_ROOT"
29
21
 
30
22
 
31
 
import collections
32
 
import os.path
33
 
import re
34
 
import sys
35
 
import tarfile
36
 
import types
37
 
from warnings import warn
 
23
import sys, os.path, types, re
38
24
 
39
25
import bzrlib
40
 
from bzrlib import errors, osutils
41
 
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
42
 
                            pathjoin, sha_strings)
43
 
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
44
 
                           BzrError, BzrCheckError, BinaryFile)
 
26
from bzrlib.errors import BzrError, BzrCheckError
 
27
 
 
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
45
29
from bzrlib.trace import mutter
46
 
 
 
30
from bzrlib.errors import NotVersionedError
 
31
        
47
32
 
48
33
class InventoryEntry(object):
49
34
    """Description of a versioned file.
51
36
    An InventoryEntry has the following fields, which are also
52
37
    present in the XML inventory-entry element:
53
38
 
54
 
    file_id
55
 
 
56
 
    name
57
 
        (within the parent directory)
58
 
 
59
 
    parent_id
60
 
        file_id of the parent directory, or ROOT_ID
61
 
 
62
 
    revision
63
 
        the revision_id in which this variation of this file was 
64
 
        introduced.
65
 
 
66
 
    executable
67
 
        Indicates that this file should be executable on systems
68
 
        that support it.
69
 
 
70
 
    text_sha1
71
 
        sha-1 of the text of the file
72
 
        
73
 
    text_size
74
 
        size in bytes of the text of the file
75
 
        
76
 
    (reading a version 4 tree created a text_id field.)
 
39
    * *file_id*
 
40
    * *name*: (only the basename within the directory, must not
 
41
      contain slashes)
 
42
    * *kind*: "directory" or "file"
 
43
    * *directory_id*: (if absent/null means the branch root directory)
 
44
    * *text_sha1*: only for files
 
45
    * *text_size*: in bytes, only for files 
 
46
    * *text_id*: identifier for the text version, only for files
 
47
 
 
48
    InventoryEntries can also exist inside a WorkingTree
 
49
    inventory, in which case they are not yet bound to a
 
50
    particular revision of the file.  In that case the text_sha1,
 
51
    text_size and text_id are absent.
 
52
 
77
53
 
78
54
    >>> i = Inventory()
79
55
    >>> i.path2id('')
80
56
    'TREE_ROOT'
81
 
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
82
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
83
 
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
84
 
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
85
 
    >>> shouldbe = {0: '', 1: 'src', 2: pathjoin('src','hello.c')}
86
 
    >>> for ix, j in enumerate(i.iter_entries()):
87
 
    ...   print (j[0] == shouldbe[ix], j[1])
 
57
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
58
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
59
    >>> for j in i.iter_entries():
 
60
    ...   print j
88
61
    ... 
89
 
    (True, InventoryDirectory('TREE_ROOT', '', parent_id=None, revision=None))
90
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
91
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
92
 
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
62
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
63
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
 
64
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
93
65
    Traceback (most recent call last):
94
66
    ...
95
67
    BzrError: inventory already contains entry with id {2323}
96
 
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
97
 
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
98
 
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
99
 
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
 
68
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
69
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
100
70
    >>> i.path2id('src/wibble')
101
71
    '2325'
102
72
    >>> '2325' in i
103
73
    True
104
 
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
105
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
74
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
106
75
    >>> i['2326']
107
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
108
 
    >>> for path, entry in i.iter_entries():
109
 
    ...     print path
110
 
    ...     assert i.path2id(path)
 
76
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
77
    >>> for j in i.iter_entries():
 
78
    ...     print j[0]
 
79
    ...     assert i.path2id(j[0])
111
80
    ... 
112
 
    <BLANKLINE>
113
81
    src
114
82
    src/bye.c
115
83
    src/hello.c
117
85
    src/wibble/wibble.c
118
86
    >>> i.id2path('2326')
119
87
    'src/wibble/wibble.c'
 
88
 
 
89
    TODO: Maybe also keep the full path of the entry, and the children?
 
90
           But those depend on its position within a particular inventory, and
 
91
           it would be nice not to need to hold the backpointer here.
120
92
    """
121
93
 
122
 
    # Constants returned by describe_change()
123
 
    #
124
 
    # TODO: These should probably move to some kind of FileChangeDescription 
125
 
    # class; that's like what's inside a TreeDelta but we want to be able to 
126
 
    # generate them just for one file at a time.
127
 
    RENAMED = 'renamed'
128
 
    MODIFIED_AND_RENAMED = 'modified and renamed'
129
 
    
130
 
    __slots__ = []
131
 
 
132
 
    def detect_changes(self, old_entry):
133
 
        """Return a (text_modified, meta_modified) from this to old_entry.
134
 
        
135
 
        _read_tree_state must have been called on self and old_entry prior to 
136
 
        calling detect_changes.
137
 
        """
138
 
        return False, False
139
 
 
140
 
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
141
 
             output_to, reverse=False):
142
 
        """Perform a diff from this to to_entry.
143
 
 
144
 
        text_diff will be used for textual difference calculation.
145
 
        This is a template method, override _diff in child classes.
146
 
        """
147
 
        self._read_tree_state(tree.id2path(self.file_id), tree)
148
 
        if to_entry:
149
 
            # cannot diff from one kind to another - you must do a removal
150
 
            # and an addif they do not match.
151
 
            assert self.kind == to_entry.kind
152
 
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
153
 
                                      to_tree)
154
 
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
155
 
                   output_to, reverse)
156
 
 
157
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
158
 
             output_to, reverse=False):
159
 
        """Perform a diff between two entries of the same kind."""
160
 
 
161
 
    def find_previous_heads(self, previous_inventories,
162
 
                            versioned_file_store,
163
 
                            transaction,
164
 
                            entry_vf=None):
165
 
        """Return the revisions and entries that directly precede this.
166
 
 
167
 
        Returned as a map from revision to inventory entry.
168
 
 
169
 
        This is a map containing the file revisions in all parents
170
 
        for which the file exists, and its revision is not a parent of
171
 
        any other. If the file is new, the set will be empty.
172
 
 
173
 
        :param versioned_file_store: A store where ancestry data on this
174
 
                                     file id can be queried.
175
 
        :param transaction: The transaction that queries to the versioned 
176
 
                            file store should be completed under.
177
 
        :param entry_vf: The entry versioned file, if its already available.
178
 
        """
179
 
        def get_ancestors(weave, entry):
180
 
            return set(weave.get_ancestry(entry.revision))
181
 
        # revision:ie mapping for each ie found in previous_inventories.
182
 
        candidates = {}
183
 
        # revision:ie mapping with one revision for each head.
184
 
        heads = {}
185
 
        # revision: ancestor list for each head
186
 
        head_ancestors = {}
187
 
        # identify candidate head revision ids.
188
 
        for inv in previous_inventories:
189
 
            if self.file_id in inv:
190
 
                ie = inv[self.file_id]
191
 
                assert ie.file_id == self.file_id
192
 
                if ie.revision in candidates:
193
 
                    # same revision value in two different inventories:
194
 
                    # correct possible inconsistencies:
195
 
                    #     * there was a bug in revision updates with 'x' bit 
196
 
                    #       support.
197
 
                    try:
198
 
                        if candidates[ie.revision].executable != ie.executable:
199
 
                            candidates[ie.revision].executable = False
200
 
                            ie.executable = False
201
 
                    except AttributeError:
202
 
                        pass
203
 
                    # must now be the same.
204
 
                    assert candidates[ie.revision] == ie
205
 
                else:
206
 
                    # add this revision as a candidate.
207
 
                    candidates[ie.revision] = ie
208
 
 
209
 
        # common case optimisation
210
 
        if len(candidates) == 1:
211
 
            # if there is only one candidate revision found
212
 
            # then we can opening the versioned file to access ancestry:
213
 
            # there cannot be any ancestors to eliminate when there is 
214
 
            # only one revision available.
215
 
            heads[ie.revision] = ie
216
 
            return heads
217
 
 
218
 
        # eliminate ancestors amongst the available candidates:
219
 
        # heads are those that are not an ancestor of any other candidate
220
 
        # - this provides convergence at a per-file level.
221
 
        for ie in candidates.values():
222
 
            # may be an ancestor of a known head:
223
 
            already_present = 0 != len(
224
 
                [head for head in heads 
225
 
                 if ie.revision in head_ancestors[head]])
226
 
            if already_present:
227
 
                # an ancestor of an analyzed candidate.
228
 
                continue
229
 
            # not an ancestor of a known head:
230
 
            # load the versioned file for this file id if needed
231
 
            if entry_vf is None:
232
 
                entry_vf = versioned_file_store.get_weave_or_empty(
233
 
                    self.file_id, transaction)
234
 
            ancestors = get_ancestors(entry_vf, ie)
235
 
            # may knock something else out:
236
 
            check_heads = list(heads.keys())
237
 
            for head in check_heads:
238
 
                if head in ancestors:
239
 
                    # this previously discovered 'head' is not
240
 
                    # really a head - its an ancestor of the newly 
241
 
                    # found head,
242
 
                    heads.pop(head)
243
 
            head_ancestors[ie.revision] = ancestors
244
 
            heads[ie.revision] = ie
245
 
        return heads
246
 
 
247
 
    def get_tar_item(self, root, dp, now, tree):
248
 
        """Get a tarfile item and a file stream for its content."""
249
 
        item = tarfile.TarInfo(pathjoin(root, dp))
250
 
        # TODO: would be cool to actually set it to the timestamp of the
251
 
        # revision it was last changed
252
 
        item.mtime = now
253
 
        fileobj = self._put_in_tar(item, tree)
254
 
        return item, fileobj
255
 
 
256
 
    def has_text(self):
257
 
        """Return true if the object this entry represents has textual data.
258
 
 
259
 
        Note that textual data includes binary content.
260
 
 
261
 
        Also note that all entries get weave files created for them.
262
 
        This attribute is primarily used when upgrading from old trees that
263
 
        did not have the weave index for all inventory entries.
264
 
        """
265
 
        return False
266
 
 
267
 
    def __init__(self, file_id, name, parent_id, text_id=None):
 
94
    # TODO: split InventoryEntry into subclasses for files,
 
95
    # directories, etc etc.
 
96
 
 
97
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
98
                 'text_id', 'parent_id', 'children', ]
 
99
 
 
100
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
268
101
        """Create an InventoryEntry
269
102
        
270
103
        The filename must be a single component, relative to the
271
104
        parent directory; it cannot be a whole path or relative name.
272
105
 
273
 
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
 
106
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
274
107
        >>> e.name
275
108
        'hello.c'
276
109
        >>> e.file_id
277
110
        '123'
278
 
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
 
111
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
279
112
        Traceback (most recent call last):
280
 
        InvalidEntryName: Invalid entry name: src/hello.c
 
113
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
281
114
        """
282
 
        assert isinstance(name, basestring), name
283
115
        if '/' in name or '\\' in name:
284
 
            raise InvalidEntryName(name=name)
285
 
        self.executable = False
286
 
        self.revision = None
 
116
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
117
        
287
118
        self.text_sha1 = None
288
119
        self.text_size = None
 
120
    
289
121
        self.file_id = file_id
290
122
        self.name = name
 
123
        self.kind = kind
291
124
        self.text_id = text_id
292
125
        self.parent_id = parent_id
293
 
        self.symlink_target = None
294
 
 
295
 
    def kind_character(self):
296
 
        """Return a short kind indicator useful for appending to names."""
297
 
        raise BzrError('unknown kind %r' % self.kind)
298
 
 
299
 
    known_kinds = ('file', 'directory', 'symlink')
300
 
 
301
 
    def _put_in_tar(self, item, tree):
302
 
        """populate item for stashing in a tar, and return the content stream.
303
 
 
304
 
        If no content is available, return None.
305
 
        """
306
 
        raise BzrError("don't know how to export {%s} of kind %r" %
307
 
                       (self.file_id, self.kind))
308
 
 
309
 
    def put_on_disk(self, dest, dp, tree):
310
 
        """Create a representation of self on disk in the prefix dest.
311
 
        
312
 
        This is a template method - implement _put_on_disk in subclasses.
313
 
        """
314
 
        fullpath = pathjoin(dest, dp)
315
 
        self._put_on_disk(fullpath, tree)
316
 
        # mutter("  export {%s} kind %s to %s", self.file_id,
317
 
        #         self.kind, fullpath)
318
 
 
319
 
    def _put_on_disk(self, fullpath, tree):
320
 
        """Put this entry onto disk at fullpath, from tree tree."""
321
 
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
 
126
        if kind == 'directory':
 
127
            self.children = {}
 
128
        elif kind == 'file':
 
129
            pass
 
130
        else:
 
131
            raise BzrError("unhandled entry kind %r" % kind)
 
132
 
 
133
 
322
134
 
323
135
    def sorted_children(self):
324
 
        return sorted(self.children.items())
325
 
 
326
 
    @staticmethod
327
 
    def versionable_kind(kind):
328
 
        return (kind in ('file', 'directory', 'symlink'))
329
 
 
330
 
    def check(self, checker, rev_id, inv, tree):
331
 
        """Check this inventory entry is intact.
332
 
 
333
 
        This is a template method, override _check for kind specific
334
 
        tests.
335
 
 
336
 
        :param checker: Check object providing context for the checks; 
337
 
             can be used to find out what parts of the repository have already
338
 
             been checked.
339
 
        :param rev_id: Revision id from which this InventoryEntry was loaded.
340
 
             Not necessarily the last-changed revision for this file.
341
 
        :param inv: Inventory from which the entry was loaded.
342
 
        :param tree: RevisionTree for this entry.
343
 
        """
344
 
        if self.parent_id is not None:
345
 
            if not inv.has_id(self.parent_id):
346
 
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
347
 
                        % (self.parent_id, rev_id))
348
 
        self._check(checker, rev_id, tree)
349
 
 
350
 
    def _check(self, checker, rev_id, tree):
351
 
        """Check this inventory entry for kind specific errors."""
352
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
353
 
                            (self.kind, rev_id))
 
136
        l = self.children.items()
 
137
        l.sort()
 
138
        return l
 
139
 
354
140
 
355
141
    def copy(self):
356
 
        """Clone this inventory entry."""
357
 
        raise NotImplementedError
358
 
 
359
 
    @staticmethod
360
 
    def describe_change(old_entry, new_entry):
361
 
        """Describe the change between old_entry and this.
362
 
        
363
 
        This smells of being an InterInventoryEntry situation, but as its
364
 
        the first one, we're making it a static method for now.
365
 
 
366
 
        An entry with a different parent, or different name is considered 
367
 
        to be renamed. Reparenting is an internal detail.
368
 
        Note that renaming the parent does not trigger a rename for the
369
 
        child entry itself.
370
 
        """
371
 
        # TODO: Perhaps return an object rather than just a string
372
 
        if old_entry is new_entry:
373
 
            # also the case of both being None
374
 
            return 'unchanged'
375
 
        elif old_entry is None:
376
 
            return 'added'
377
 
        elif new_entry is None:
378
 
            return 'removed'
379
 
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
380
 
        if text_modified or meta_modified:
381
 
            modified = True
382
 
        else:
383
 
            modified = False
384
 
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
385
 
        if old_entry.parent_id != new_entry.parent_id:
386
 
            renamed = True
387
 
        elif old_entry.name != new_entry.name:
388
 
            renamed = True
389
 
        else:
390
 
            renamed = False
391
 
        if renamed and not modified:
392
 
            return InventoryEntry.RENAMED
393
 
        if modified and not renamed:
394
 
            return 'modified'
395
 
        if modified and renamed:
396
 
            return InventoryEntry.MODIFIED_AND_RENAMED
397
 
        return 'unchanged'
 
142
        other = InventoryEntry(self.file_id, self.name, self.kind,
 
143
                               self.parent_id, text_id=self.text_id)
 
144
        other.text_sha1 = self.text_sha1
 
145
        other.text_size = self.text_size
 
146
        # note that children are *not* copied; they're pulled across when
 
147
        # others are added
 
148
        return other
 
149
 
398
150
 
399
151
    def __repr__(self):
400
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
152
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
401
153
                % (self.__class__.__name__,
402
154
                   self.file_id,
403
155
                   self.name,
404
 
                   self.parent_id,
405
 
                   self.revision))
406
 
 
407
 
    def snapshot(self, revision, path, previous_entries,
408
 
                 work_tree, commit_builder):
409
 
        """Make a snapshot of this entry which may or may not have changed.
410
 
        
411
 
        This means that all its fields are populated, that it has its
412
 
        text stored in the text store or weave.
413
 
        """
414
 
        # mutter('new parents of %s are %r', path, previous_entries)
415
 
        self._read_tree_state(path, work_tree)
416
 
        # TODO: Where should we determine whether to reuse a
417
 
        # previous revision id or create a new revision? 20060606
418
 
        if len(previous_entries) == 1:
419
 
            # cannot be unchanged unless there is only one parent file rev.
420
 
            parent_ie = previous_entries.values()[0]
421
 
            if self._unchanged(parent_ie):
422
 
                # mutter("found unchanged entry")
423
 
                self.revision = parent_ie.revision
424
 
                return "unchanged"
425
 
        return self._snapshot_into_revision(revision, previous_entries, 
426
 
                                            work_tree, commit_builder)
427
 
 
428
 
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
429
 
                                commit_builder):
430
 
        """Record this revision unconditionally into a store.
431
 
 
432
 
        The entry's last-changed revision property (`revision`) is updated to 
433
 
        that of the new revision.
434
 
        
435
 
        :param revision: id of the new revision that is being recorded.
436
 
 
437
 
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
438
 
        """
439
 
        # mutter('new revision {%s} for {%s}', revision, self.file_id)
440
 
        self.revision = revision
441
 
        self._snapshot_text(previous_entries, work_tree, commit_builder)
442
 
 
443
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
444
 
        """Record the 'text' of this entry, whatever form that takes.
445
 
        
446
 
        This default implementation simply adds an empty text.
447
 
        """
448
 
        raise NotImplementedError(self._snapshot_text)
 
156
                   self.kind,
 
157
                   self.parent_id))
 
158
 
 
159
    
 
160
    def to_element(self):
 
161
        """Convert to XML element"""
 
162
        from bzrlib.xml import Element
 
163
        
 
164
        e = Element('entry')
 
165
 
 
166
        e.set('name', self.name)
 
167
        e.set('file_id', self.file_id)
 
168
        e.set('kind', self.kind)
 
169
 
 
170
        if self.text_size != None:
 
171
            e.set('text_size', '%d' % self.text_size)
 
172
            
 
173
        for f in ['text_id', 'text_sha1']:
 
174
            v = getattr(self, f)
 
175
            if v != None:
 
176
                e.set(f, v)
 
177
 
 
178
        # to be conservative, we don't externalize the root pointers
 
179
        # for now, leaving them as null in the xml form.  in a future
 
180
        # version it will be implied by nested elements.
 
181
        if self.parent_id != ROOT_ID:
 
182
            assert isinstance(self.parent_id, basestring)
 
183
            e.set('parent_id', self.parent_id)
 
184
 
 
185
        e.tail = '\n'
 
186
            
 
187
        return e
 
188
 
 
189
 
 
190
    def from_element(cls, elt):
 
191
        assert elt.tag == 'entry'
 
192
 
 
193
        ## original format inventories don't have a parent_id for
 
194
        ## nodes in the root directory, but it's cleaner to use one
 
195
        ## internally.
 
196
        parent_id = elt.get('parent_id')
 
197
        if parent_id == None:
 
198
            parent_id = ROOT_ID
 
199
 
 
200
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
 
201
        self.text_id = elt.get('text_id')
 
202
        self.text_sha1 = elt.get('text_sha1')
 
203
        
 
204
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
205
 
 
206
        v = elt.get('text_size')
 
207
        self.text_size = v and int(v)
 
208
 
 
209
        return self
 
210
            
 
211
 
 
212
    from_element = classmethod(from_element)
449
213
 
450
214
    def __eq__(self, other):
451
215
        if not isinstance(other, InventoryEntry):
452
216
            return NotImplemented
453
217
 
454
 
        return ((self.file_id == other.file_id)
455
 
                and (self.name == other.name)
456
 
                and (other.symlink_target == self.symlink_target)
457
 
                and (self.text_sha1 == other.text_sha1)
458
 
                and (self.text_size == other.text_size)
459
 
                and (self.text_id == other.text_id)
460
 
                and (self.parent_id == other.parent_id)
461
 
                and (self.kind == other.kind)
462
 
                and (self.revision == other.revision)
463
 
                and (self.executable == other.executable)
464
 
                )
 
218
        return (self.file_id == other.file_id) \
 
219
               and (self.name == other.name) \
 
220
               and (self.text_sha1 == other.text_sha1) \
 
221
               and (self.text_size == other.text_size) \
 
222
               and (self.text_id == other.text_id) \
 
223
               and (self.parent_id == other.parent_id) \
 
224
               and (self.kind == other.kind)
 
225
 
465
226
 
466
227
    def __ne__(self, other):
467
228
        return not (self == other)
469
230
    def __hash__(self):
470
231
        raise ValueError('not hashable')
471
232
 
472
 
    def _unchanged(self, previous_ie):
473
 
        """Has this entry changed relative to previous_ie.
474
 
 
475
 
        This method should be overridden in child classes.
476
 
        """
477
 
        compatible = True
478
 
        # different inv parent
479
 
        if previous_ie.parent_id != self.parent_id:
480
 
            compatible = False
481
 
        # renamed
482
 
        elif previous_ie.name != self.name:
483
 
            compatible = False
484
 
        return compatible
485
 
 
486
 
    def _read_tree_state(self, path, work_tree):
487
 
        """Populate fields in the inventory entry from the given tree.
488
 
        
489
 
        Note that this should be modified to be a noop on virtual trees
490
 
        as all entries created there are prepopulated.
491
 
        """
492
 
        # TODO: Rather than running this manually, we should check the 
493
 
        # working sha1 and other expensive properties when they're
494
 
        # first requested, or preload them if they're already known
495
 
        pass            # nothing to do by default
496
 
 
497
 
    def _forget_tree_state(self):
498
 
        pass
499
233
 
500
234
 
501
235
class RootEntry(InventoryEntry):
502
 
 
503
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
504
 
                 'text_id', 'parent_id', 'children', 'executable', 
505
 
                 'revision', 'symlink_target']
506
 
 
507
 
    def _check(self, checker, rev_id, tree):
508
 
        """See InventoryEntry._check"""
509
 
 
510
236
    def __init__(self, file_id):
511
237
        self.file_id = file_id
512
238
        self.children = {}
513
 
        self.kind = 'directory'
 
239
        self.kind = 'root_directory'
514
240
        self.parent_id = None
515
 
        self.name = u''
516
 
        self.revision = None
517
 
        warn('RootEntry is deprecated as of bzr 0.10.  Please use '
518
 
             'InventoryDirectory instead.',
519
 
            DeprecationWarning, stacklevel=2)
 
241
        self.name = ''
520
242
 
521
243
    def __eq__(self, other):
522
244
        if not isinstance(other, RootEntry):
526
248
               and (self.children == other.children)
527
249
 
528
250
 
529
 
class InventoryDirectory(InventoryEntry):
530
 
    """A directory in an inventory."""
531
 
 
532
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
533
 
                 'text_id', 'parent_id', 'children', 'executable', 
534
 
                 'revision', 'symlink_target']
535
 
 
536
 
    def _check(self, checker, rev_id, tree):
537
 
        """See InventoryEntry._check"""
538
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
539
 
            raise BzrCheckError('directory {%s} has text in revision {%s}'
540
 
                                % (self.file_id, rev_id))
541
 
 
542
 
    def copy(self):
543
 
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
544
 
        other.revision = self.revision
545
 
        # note that children are *not* copied; they're pulled across when
546
 
        # others are added
547
 
        return other
548
 
 
549
 
    def __init__(self, file_id, name, parent_id):
550
 
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
551
 
        self.children = {}
552
 
        self.kind = 'directory'
553
 
 
554
 
    def kind_character(self):
555
 
        """See InventoryEntry.kind_character."""
556
 
        return '/'
557
 
 
558
 
    def _put_in_tar(self, item, tree):
559
 
        """See InventoryEntry._put_in_tar."""
560
 
        item.type = tarfile.DIRTYPE
561
 
        fileobj = None
562
 
        item.name += '/'
563
 
        item.size = 0
564
 
        item.mode = 0755
565
 
        return fileobj
566
 
 
567
 
    def _put_on_disk(self, fullpath, tree):
568
 
        """See InventoryEntry._put_on_disk."""
569
 
        os.mkdir(fullpath)
570
 
 
571
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
572
 
        """See InventoryEntry._snapshot_text."""
573
 
        commit_builder.modified_directory(self.file_id, file_parents)
574
 
 
575
 
 
576
 
class InventoryFile(InventoryEntry):
577
 
    """A file in an inventory."""
578
 
 
579
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
580
 
                 'text_id', 'parent_id', 'children', 'executable', 
581
 
                 'revision', 'symlink_target']
582
 
 
583
 
    def _check(self, checker, tree_revision_id, tree):
584
 
        """See InventoryEntry._check"""
585
 
        t = (self.file_id, self.revision)
586
 
        if t in checker.checked_texts:
587
 
            prev_sha = checker.checked_texts[t]
588
 
            if prev_sha != self.text_sha1:
589
 
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
590
 
                                    (self.file_id, tree_revision_id))
591
 
            else:
592
 
                checker.repeated_text_cnt += 1
593
 
                return
594
 
 
595
 
        if self.file_id not in checker.checked_weaves:
596
 
            mutter('check weave {%s}', self.file_id)
597
 
            w = tree.get_weave(self.file_id)
598
 
            # Not passing a progress bar, because it creates a new
599
 
            # progress, which overwrites the current progress,
600
 
            # and doesn't look nice
601
 
            w.check()
602
 
            checker.checked_weaves[self.file_id] = True
603
 
        else:
604
 
            w = tree.get_weave(self.file_id)
605
 
 
606
 
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
607
 
        checker.checked_text_cnt += 1
608
 
        # We can't check the length, because Weave doesn't store that
609
 
        # information, and the whole point of looking at the weave's
610
 
        # sha1sum is that we don't have to extract the text.
611
 
        if self.text_sha1 != w.get_sha1(self.revision):
612
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
613
 
                                % (self.file_id, self.revision))
614
 
        checker.checked_texts[t] = self.text_sha1
615
 
 
616
 
    def copy(self):
617
 
        other = InventoryFile(self.file_id, self.name, self.parent_id)
618
 
        other.executable = self.executable
619
 
        other.text_id = self.text_id
620
 
        other.text_sha1 = self.text_sha1
621
 
        other.text_size = self.text_size
622
 
        other.revision = self.revision
623
 
        return other
624
 
 
625
 
    def detect_changes(self, old_entry):
626
 
        """See InventoryEntry.detect_changes."""
627
 
        assert self.text_sha1 is not None
628
 
        assert old_entry.text_sha1 is not None
629
 
        text_modified = (self.text_sha1 != old_entry.text_sha1)
630
 
        meta_modified = (self.executable != old_entry.executable)
631
 
        return text_modified, meta_modified
632
 
 
633
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
634
 
             output_to, reverse=False):
635
 
        """See InventoryEntry._diff."""
636
 
        try:
637
 
            from_text = tree.get_file(self.file_id).readlines()
638
 
            if to_entry:
639
 
                to_text = to_tree.get_file(to_entry.file_id).readlines()
640
 
            else:
641
 
                to_text = []
642
 
            if not reverse:
643
 
                text_diff(from_label, from_text,
644
 
                          to_label, to_text, output_to)
645
 
            else:
646
 
                text_diff(to_label, to_text,
647
 
                          from_label, from_text, output_to)
648
 
        except BinaryFile:
649
 
            if reverse:
650
 
                label_pair = (to_label, from_label)
651
 
            else:
652
 
                label_pair = (from_label, to_label)
653
 
            print >> output_to, "Binary files %s and %s differ" % label_pair
654
 
 
655
 
    def has_text(self):
656
 
        """See InventoryEntry.has_text."""
657
 
        return True
658
 
 
659
 
    def __init__(self, file_id, name, parent_id):
660
 
        super(InventoryFile, self).__init__(file_id, name, parent_id)
661
 
        self.kind = 'file'
662
 
 
663
 
    def kind_character(self):
664
 
        """See InventoryEntry.kind_character."""
665
 
        return ''
666
 
 
667
 
    def _put_in_tar(self, item, tree):
668
 
        """See InventoryEntry._put_in_tar."""
669
 
        item.type = tarfile.REGTYPE
670
 
        fileobj = tree.get_file(self.file_id)
671
 
        item.size = self.text_size
672
 
        if tree.is_executable(self.file_id):
673
 
            item.mode = 0755
674
 
        else:
675
 
            item.mode = 0644
676
 
        return fileobj
677
 
 
678
 
    def _put_on_disk(self, fullpath, tree):
679
 
        """See InventoryEntry._put_on_disk."""
680
 
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
681
 
        if tree.is_executable(self.file_id):
682
 
            os.chmod(fullpath, 0755)
683
 
 
684
 
    def _read_tree_state(self, path, work_tree):
685
 
        """See InventoryEntry._read_tree_state."""
686
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
687
 
        # FIXME: 20050930 probe for the text size when getting sha1
688
 
        # in _read_tree_state
689
 
        self.executable = work_tree.is_executable(self.file_id, path=path)
690
 
 
691
 
    def __repr__(self):
692
 
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
693
 
                % (self.__class__.__name__,
694
 
                   self.file_id,
695
 
                   self.name,
696
 
                   self.parent_id,
697
 
                   self.text_sha1,
698
 
                   self.text_size))
699
 
 
700
 
    def _forget_tree_state(self):
701
 
        self.text_sha1 = None
702
 
 
703
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
704
 
        """See InventoryEntry._snapshot_text."""
705
 
        def get_content_byte_lines():
706
 
            return work_tree.get_file(self.file_id).readlines()
707
 
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
708
 
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
709
 
 
710
 
    def _unchanged(self, previous_ie):
711
 
        """See InventoryEntry._unchanged."""
712
 
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
713
 
        if self.text_sha1 != previous_ie.text_sha1:
714
 
            compatible = False
715
 
        else:
716
 
            # FIXME: 20050930 probe for the text size when getting sha1
717
 
            # in _read_tree_state
718
 
            self.text_size = previous_ie.text_size
719
 
        if self.executable != previous_ie.executable:
720
 
            compatible = False
721
 
        return compatible
722
 
 
723
 
 
724
 
class InventoryLink(InventoryEntry):
725
 
    """A file in an inventory."""
726
 
 
727
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
728
 
                 'text_id', 'parent_id', 'children', 'executable', 
729
 
                 'revision', 'symlink_target']
730
 
 
731
 
    def _check(self, checker, rev_id, tree):
732
 
        """See InventoryEntry._check"""
733
 
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
734
 
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
735
 
                    % (self.file_id, rev_id))
736
 
        if self.symlink_target is None:
737
 
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
738
 
                    % (self.file_id, rev_id))
739
 
 
740
 
    def copy(self):
741
 
        other = InventoryLink(self.file_id, self.name, self.parent_id)
742
 
        other.symlink_target = self.symlink_target
743
 
        other.revision = self.revision
744
 
        return other
745
 
 
746
 
    def detect_changes(self, old_entry):
747
 
        """See InventoryEntry.detect_changes."""
748
 
        # FIXME: which _modified field should we use ? RBC 20051003
749
 
        text_modified = (self.symlink_target != old_entry.symlink_target)
750
 
        if text_modified:
751
 
            mutter("    symlink target changed")
752
 
        meta_modified = False
753
 
        return text_modified, meta_modified
754
 
 
755
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
756
 
             output_to, reverse=False):
757
 
        """See InventoryEntry._diff."""
758
 
        from_text = self.symlink_target
759
 
        if to_entry is not None:
760
 
            to_text = to_entry.symlink_target
761
 
            if reverse:
762
 
                temp = from_text
763
 
                from_text = to_text
764
 
                to_text = temp
765
 
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
766
 
        else:
767
 
            if not reverse:
768
 
                print >>output_to, '=== target was %r' % self.symlink_target
769
 
            else:
770
 
                print >>output_to, '=== target is %r' % self.symlink_target
771
 
 
772
 
    def __init__(self, file_id, name, parent_id):
773
 
        super(InventoryLink, self).__init__(file_id, name, parent_id)
774
 
        self.kind = 'symlink'
775
 
 
776
 
    def kind_character(self):
777
 
        """See InventoryEntry.kind_character."""
778
 
        return ''
779
 
 
780
 
    def _put_in_tar(self, item, tree):
781
 
        """See InventoryEntry._put_in_tar."""
782
 
        item.type = tarfile.SYMTYPE
783
 
        fileobj = None
784
 
        item.size = 0
785
 
        item.mode = 0755
786
 
        item.linkname = self.symlink_target
787
 
        return fileobj
788
 
 
789
 
    def _put_on_disk(self, fullpath, tree):
790
 
        """See InventoryEntry._put_on_disk."""
791
 
        try:
792
 
            os.symlink(self.symlink_target, fullpath)
793
 
        except OSError,e:
794
 
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
795
 
 
796
 
    def _read_tree_state(self, path, work_tree):
797
 
        """See InventoryEntry._read_tree_state."""
798
 
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
799
 
 
800
 
    def _forget_tree_state(self):
801
 
        self.symlink_target = None
802
 
 
803
 
    def _unchanged(self, previous_ie):
804
 
        """See InventoryEntry._unchanged."""
805
 
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
806
 
        if self.symlink_target != previous_ie.symlink_target:
807
 
            compatible = False
808
 
        return compatible
809
 
 
810
 
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
811
 
        """See InventoryEntry._snapshot_text."""
812
 
        commit_builder.modified_link(
813
 
            self.file_id, file_parents, self.symlink_target)
814
 
 
815
251
 
816
252
class Inventory(object):
817
253
    """Inventory of versioned files in a tree.
831
267
    inserted, other than through the Inventory API.
832
268
 
833
269
    >>> inv = Inventory()
834
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
835
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
270
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
836
271
    >>> inv['123-123'].name
837
272
    'hello.c'
838
273
 
846
281
    May also look up by name:
847
282
 
848
283
    >>> [x[0] for x in inv.iter_entries()]
849
 
    ['', u'hello.c']
 
284
    ['hello.c']
850
285
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
851
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
852
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
 
286
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
853
287
    """
854
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
288
    def __init__(self, root_id=ROOT_ID):
855
289
        """Create or read an inventory.
856
290
 
857
291
        If a working directory is specified, the inventory is read
861
295
        The inventory is created with a default root directory, with
862
296
        an id of None.
863
297
        """
864
 
        # We are letting Branch.create() create a unique inventory
 
298
        # We are letting Branch(init=True) create a unique inventory
865
299
        # root id. Rather than generating a random one here.
866
300
        #if root_id is None:
867
301
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
868
 
        if root_id is not None:
869
 
            self._set_root(InventoryDirectory(root_id, '', None))
870
 
        else:
871
 
            self.root = None
872
 
            self._byid = {}
873
 
        # FIXME: this isn't ever used, changing it to self.revision may break
874
 
        # things. TODO make everything use self.revision_id
875
 
        self.revision_id = revision_id
876
 
 
877
 
    def _set_root(self, ie):
878
 
        self.root = ie
 
302
        self.root = RootEntry(root_id)
879
303
        self._byid = {self.root.file_id: self.root}
880
304
 
881
 
    def copy(self):
882
 
        # TODO: jam 20051218 Should copy also copy the revision_id?
883
 
        entries = self.iter_entries()
884
 
        other = Inventory(entries.next()[1].file_id)
885
 
        # copy recursively so we know directories will be added before
886
 
        # their children.  There are more efficient ways than this...
887
 
        for path, entry in entries():
888
 
            other.add(entry.copy())
889
 
        return other
890
305
 
891
306
    def __iter__(self):
892
307
        return iter(self._byid)
893
308
 
 
309
 
894
310
    def __len__(self):
895
311
        """Returns number of entries."""
896
312
        return len(self._byid)
897
313
 
 
314
 
898
315
    def iter_entries(self, from_dir=None):
899
316
        """Return (path, entry) pairs, in order by name."""
900
 
        if from_dir is None:
901
 
            assert self.root
902
 
            from_dir = self.root
903
 
            yield '', self.root
904
 
        elif isinstance(from_dir, basestring):
905
 
            from_dir = self._byid[from_dir]
906
 
            
907
 
        # unrolling the recursive called changed the time from
908
 
        # 440ms/663ms (inline/total) to 116ms/116ms
909
 
        children = from_dir.children.items()
910
 
        children.sort()
911
 
        children = collections.deque(children)
912
 
        stack = [(u'', children)]
913
 
        while stack:
914
 
            from_dir_relpath, children = stack[-1]
915
 
 
916
 
            while children:
917
 
                name, ie = children.popleft()
918
 
 
919
 
                # we know that from_dir_relpath never ends in a slash
920
 
                # and 'f' doesn't begin with one, we can do a string op, rather
921
 
                # than the checks of pathjoin(), though this means that all paths
922
 
                # start with a slash
923
 
                path = from_dir_relpath + '/' + name
924
 
 
925
 
                yield path[1:], ie
926
 
 
927
 
                if ie.kind != 'directory':
928
 
                    continue
929
 
 
930
 
                # But do this child first
931
 
                new_children = ie.children.items()
932
 
                new_children.sort()
933
 
                new_children = collections.deque(new_children)
934
 
                stack.append((path, new_children))
935
 
                # Break out of inner loop, so that we start outer loop with child
936
 
                break
937
 
            else:
938
 
                # if we finished all children, pop it off the stack
939
 
                stack.pop()
940
 
 
941
 
    def iter_entries_by_dir(self, from_dir=None):
942
 
        """Iterate over the entries in a directory first order.
943
 
 
944
 
        This returns all entries for a directory before returning
945
 
        the entries for children of a directory. This is not
946
 
        lexicographically sorted order, and is a hybrid between
947
 
        depth-first and breadth-first.
948
 
 
949
 
        :return: This yields (path, entry) pairs
950
 
        """
951
 
        # TODO? Perhaps this should return the from_dir so that the root is
952
 
        # yielded? or maybe an option?
953
 
        if from_dir is None:
954
 
            assert self.root
955
 
            from_dir = self.root
956
 
            yield '', self.root
957
 
        elif isinstance(from_dir, basestring):
958
 
            from_dir = self._byid[from_dir]
959
 
            
960
 
        stack = [(u'', from_dir)]
961
 
        while stack:
962
 
            cur_relpath, cur_dir = stack.pop()
963
 
 
964
 
            child_dirs = []
965
 
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
966
 
 
967
 
                child_relpath = cur_relpath + child_name
968
 
 
969
 
                yield child_relpath, child_ie
970
 
 
971
 
                if child_ie.kind == 'directory':
972
 
                    child_dirs.append((child_relpath+'/', child_ie))
973
 
            stack.extend(reversed(child_dirs))
 
317
        if from_dir == None:
 
318
            assert self.root
 
319
            from_dir = self.root
 
320
        elif isinstance(from_dir, basestring):
 
321
            from_dir = self._byid[from_dir]
 
322
            
 
323
        kids = from_dir.children.items()
 
324
        kids.sort()
 
325
        for name, ie in kids:
 
326
            yield name, ie
 
327
            if ie.kind == 'directory':
 
328
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
329
                    yield os.path.join(name, cn), cie
 
330
 
974
331
 
975
332
    def entries(self):
976
333
        """Return list of (path, ie) for all entries except the root.
982
339
            kids = dir_ie.children.items()
983
340
            kids.sort()
984
341
            for name, ie in kids:
985
 
                child_path = pathjoin(dir_path, name)
 
342
                child_path = os.path.join(dir_path, name)
986
343
                accum.append((child_path, ie))
987
344
                if ie.kind == 'directory':
988
345
                    descend(ie, child_path)
989
346
 
990
 
        descend(self.root, u'')
 
347
        descend(self.root, '')
991
348
        return accum
992
349
 
 
350
 
993
351
    def directories(self):
994
352
        """Return (path, entry) pairs for all directories, including the root.
995
353
        """
1001
359
            kids.sort()
1002
360
 
1003
361
            for name, child_ie in kids:
1004
 
                child_path = pathjoin(parent_path, name)
 
362
                child_path = os.path.join(parent_path, name)
1005
363
                descend(child_ie, child_path)
1006
 
        descend(self.root, u'')
 
364
        descend(self.root, '')
1007
365
        return accum
1008
366
        
 
367
 
 
368
 
1009
369
    def __contains__(self, file_id):
1010
370
        """True if this entry contains a file with given id.
1011
371
 
1012
372
        >>> inv = Inventory()
1013
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1014
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
373
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
1015
374
        >>> '123' in inv
1016
375
        True
1017
376
        >>> '456' in inv
1018
377
        False
1019
378
        """
1020
 
        return (file_id in self._byid)
 
379
        return file_id in self._byid
 
380
 
1021
381
 
1022
382
    def __getitem__(self, file_id):
1023
383
        """Return the entry for given file_id.
1024
384
 
1025
385
        >>> inv = Inventory()
1026
 
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1027
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
386
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
1028
387
        >>> inv['123123'].name
1029
388
        'hello.c'
1030
389
        """
1031
390
        try:
1032
391
            return self._byid[file_id]
1033
392
        except KeyError:
1034
 
            if file_id is None:
 
393
            if file_id == None:
1035
394
                raise BzrError("can't look up file_id None")
1036
395
            else:
1037
396
                raise BzrError("file_id {%s} not in inventory" % file_id)
1038
397
 
 
398
 
1039
399
    def get_file_kind(self, file_id):
1040
400
        return self._byid[file_id].kind
1041
401
 
1042
402
    def get_child(self, parent_id, filename):
1043
403
        return self[parent_id].children.get(filename)
1044
404
 
 
405
 
1045
406
    def add(self, entry):
1046
407
        """Add entry to inventory.
1047
408
 
1048
409
        To add  a file to a branch ready to be committed, use Branch.add,
1049
 
        which calls this.
1050
 
 
1051
 
        Returns the new entry object.
1052
 
        """
 
410
        which calls this."""
1053
411
        if entry.file_id in self._byid:
1054
412
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
1055
413
 
1056
 
        if entry.parent_id is None:
1057
 
            assert self.root is None and len(self._byid) == 0
1058
 
            self._set_root(entry)
1059
 
            return entry
1060
 
        if entry.parent_id == ROOT_ID:
1061
 
            assert self.root is not None, self
 
414
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
1062
415
            entry.parent_id = self.root.file_id
1063
416
 
1064
417
        try:
1066
419
        except KeyError:
1067
420
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
1068
421
 
1069
 
        if entry.name in parent.children:
 
422
        if parent.children.has_key(entry.name):
1070
423
            raise BzrError("%s is already versioned" %
1071
 
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
424
                    appendpath(self.id2path(parent.file_id), entry.name))
1072
425
 
1073
426
        self._byid[entry.file_id] = entry
1074
427
        parent.children[entry.name] = entry
1075
 
        return entry
1076
 
 
1077
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
428
 
 
429
 
 
430
    def add_path(self, relpath, kind, file_id=None):
1078
431
        """Add entry from a path.
1079
432
 
1080
 
        The immediate parent must already be versioned.
1081
 
 
1082
 
        Returns the new entry object."""
 
433
        The immediate parent must already be versioned"""
 
434
        from bzrlib.branch import gen_file_id
1083
435
        
1084
 
        parts = osutils.splitpath(relpath)
1085
 
 
 
436
        parts = bzrlib.osutils.splitpath(relpath)
1086
437
        if len(parts) == 0:
1087
 
            if file_id is None:
1088
 
                file_id = bzrlib.workingtree.gen_root_id()
1089
 
            self.root = InventoryDirectory(file_id, '', None)
1090
 
            self._byid = {self.root.file_id: self.root}
1091
 
            return
1092
 
        else:
1093
 
            parent_path = parts[:-1]
1094
 
            parent_id = self.path2id(parent_path)
1095
 
            if parent_id is None:
1096
 
                raise NotVersionedError(path=parent_path)
1097
 
        ie = make_entry(kind, parts[-1], parent_id, file_id)
 
438
            raise BzrError("cannot re-add root of inventory")
 
439
 
 
440
        if file_id == None:
 
441
            file_id = gen_file_id(relpath)
 
442
 
 
443
        parent_path = parts[:-1]
 
444
        parent_id = self.path2id(parent_path)
 
445
        if parent_id == None:
 
446
            raise NotVersionedError(parent_path)
 
447
 
 
448
        ie = InventoryEntry(file_id, parts[-1],
 
449
                            kind=kind, parent_id=parent_id)
1098
450
        return self.add(ie)
1099
451
 
 
452
 
1100
453
    def __delitem__(self, file_id):
1101
454
        """Remove entry by id.
1102
455
 
1103
456
        >>> inv = Inventory()
1104
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1105
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
457
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
1106
458
        >>> '123' in inv
1107
459
        True
1108
460
        >>> del inv['123']
1111
463
        """
1112
464
        ie = self[file_id]
1113
465
 
1114
 
        assert ie.parent_id is None or \
1115
 
            self[ie.parent_id].children[ie.name] == ie
 
466
        assert self[ie.parent_id].children[ie.name] == ie
1116
467
        
 
468
        # TODO: Test deleting all children; maybe hoist to a separate
 
469
        # deltree method?
 
470
        if ie.kind == 'directory':
 
471
            for cie in ie.children.values():
 
472
                del self[cie.file_id]
 
473
            del ie.children
 
474
 
1117
475
        del self._byid[file_id]
1118
 
        if ie.parent_id is not None:
1119
 
            del self[ie.parent_id].children[ie.name]
 
476
        del self[ie.parent_id].children[ie.name]
 
477
 
 
478
 
 
479
    def to_element(self):
 
480
        """Convert to XML Element"""
 
481
        from bzrlib.xml import Element
 
482
        
 
483
        e = Element('inventory')
 
484
        e.text = '\n'
 
485
        if self.root.file_id not in (None, ROOT_ID):
 
486
            e.set('file_id', self.root.file_id)
 
487
        for path, ie in self.iter_entries():
 
488
            e.append(ie.to_element())
 
489
        return e
 
490
    
 
491
 
 
492
    def from_element(cls, elt):
 
493
        """Construct from XML Element
 
494
        
 
495
        >>> inv = Inventory()
 
496
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
 
497
        >>> elt = inv.to_element()
 
498
        >>> inv2 = Inventory.from_element(elt)
 
499
        >>> inv2 == inv
 
500
        True
 
501
        """
 
502
        # XXXX: doctest doesn't run this properly under python2.3
 
503
        assert elt.tag == 'inventory'
 
504
        root_id = elt.get('file_id') or ROOT_ID
 
505
        o = cls(root_id)
 
506
        for e in elt:
 
507
            ie = InventoryEntry.from_element(e)
 
508
            if ie.parent_id == ROOT_ID:
 
509
                ie.parent_id = root_id
 
510
            o.add(ie)
 
511
        return o
 
512
        
 
513
    from_element = classmethod(from_element)
 
514
 
1120
515
 
1121
516
    def __eq__(self, other):
1122
517
        """Compare two sets by comparing their contents.
1125
520
        >>> i2 = Inventory()
1126
521
        >>> i1 == i2
1127
522
        True
1128
 
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1129
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
523
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
1130
524
        >>> i1 == i2
1131
525
        False
1132
 
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1133
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
526
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
1134
527
        >>> i1 == i2
1135
528
        True
1136
529
        """
1137
530
        if not isinstance(other, Inventory):
1138
531
            return NotImplemented
1139
532
 
 
533
        if len(self._byid) != len(other._byid):
 
534
            # shortcut: obviously not the same
 
535
            return False
 
536
 
1140
537
        return self._byid == other._byid
1141
538
 
 
539
 
1142
540
    def __ne__(self, other):
1143
 
        return not self.__eq__(other)
 
541
        return not (self == other)
 
542
 
1144
543
 
1145
544
    def __hash__(self):
1146
545
        raise ValueError('not hashable')
1147
546
 
1148
 
    def _iter_file_id_parents(self, file_id):
1149
 
        """Yield the parents of file_id up to the root."""
1150
 
        while file_id is not None:
1151
 
            try:
1152
 
                ie = self._byid[file_id]
1153
 
            except KeyError:
1154
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1155
 
            yield ie
1156
 
            file_id = ie.parent_id
 
547
 
1157
548
 
1158
549
    def get_idpath(self, file_id):
1159
550
        """Return a list of file_ids for the path to an entry.
1164
555
        root directory as depth 1.
1165
556
        """
1166
557
        p = []
1167
 
        for parent in self._iter_file_id_parents(file_id):
1168
 
            p.insert(0, parent.file_id)
 
558
        while file_id != None:
 
559
            try:
 
560
                ie = self._byid[file_id]
 
561
            except KeyError:
 
562
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
563
            p.insert(0, ie.file_id)
 
564
            file_id = ie.parent_id
1169
565
        return p
1170
566
 
 
567
 
1171
568
    def id2path(self, file_id):
1172
 
        """Return as a string the path to file_id.
1173
 
        
1174
 
        >>> i = Inventory()
1175
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1176
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1177
 
        >>> print i.id2path('foo-id')
1178
 
        src/foo.c
1179
 
        """
 
569
        """Return as a list the path to file_id."""
 
570
 
1180
571
        # get all names, skipping root
1181
 
        return '/'.join(reversed(
1182
 
            [parent.name for parent in 
1183
 
             self._iter_file_id_parents(file_id)][:-1]))
 
572
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
573
        return os.sep.join(p)
1184
574
            
 
575
 
 
576
 
1185
577
    def path2id(self, name):
1186
578
        """Walk down through directories to return entry of last component.
1187
579
 
1191
583
        This returns the entry of the last component in the path,
1192
584
        which may be either a file or a directory.
1193
585
 
1194
 
        Returns None IFF the path is not found.
 
586
        Returns None iff the path is not found.
1195
587
        """
1196
588
        if isinstance(name, types.StringTypes):
1197
589
            name = splitpath(name)
1198
590
 
1199
 
        # mutter("lookup path %r" % name)
 
591
        mutter("lookup path %r" % name)
1200
592
 
1201
593
        parent = self.root
1202
594
        for f in name:
1211
603
 
1212
604
        return parent.file_id
1213
605
 
 
606
 
1214
607
    def has_filename(self, names):
1215
608
        return bool(self.path2id(names))
1216
609
 
 
610
 
1217
611
    def has_id(self, file_id):
1218
 
        return (file_id in self._byid)
 
612
        return self._byid.has_key(file_id)
1219
613
 
1220
 
    def remove_recursive_id(self, file_id):
1221
 
        """Remove file_id, and children, from the inventory.
1222
 
        
1223
 
        :param file_id: A file_id to remove.
1224
 
        """
1225
 
        to_find_delete = [self._byid[file_id]]
1226
 
        to_delete = []
1227
 
        while to_find_delete:
1228
 
            ie = to_find_delete.pop()
1229
 
            to_delete.append(ie.file_id)
1230
 
            if ie.kind == 'directory':
1231
 
                to_find_delete.extend(ie.children.values())
1232
 
        for file_id in reversed(to_delete):
1233
 
            ie = self[file_id]
1234
 
            del self._byid[file_id]
1235
 
            if ie.parent_id is not None:
1236
 
                del self[ie.parent_id].children[ie.name]
1237
614
 
1238
615
    def rename(self, file_id, new_parent_id, new_name):
1239
616
        """Move a file within the inventory.
1265
642
        file_ie.parent_id = new_parent_id
1266
643
 
1267
644
 
1268
 
def make_entry(kind, name, parent_id, file_id=None):
1269
 
    """Create an inventory entry.
1270
 
 
1271
 
    :param kind: the type of inventory entry to create.
1272
 
    :param name: the basename of the entry.
1273
 
    :param parent_id: the parent_id of the entry.
1274
 
    :param file_id: the file_id to use. if None, one will be created.
1275
 
    """
1276
 
    if file_id is None:
1277
 
        file_id = bzrlib.workingtree.gen_file_id(name)
1278
 
 
1279
 
    norm_name, can_access = osutils.normalized_filename(name)
1280
 
    if norm_name != name:
1281
 
        if can_access:
1282
 
            name = norm_name
1283
 
        else:
1284
 
            # TODO: jam 20060701 This would probably be more useful
1285
 
            #       if the error was raised with the full path
1286
 
            raise errors.InvalidNormalization(name)
1287
 
 
1288
 
    if kind == 'directory':
1289
 
        return InventoryDirectory(file_id, name, parent_id)
1290
 
    elif kind == 'file':
1291
 
        return InventoryFile(file_id, name, parent_id)
1292
 
    elif kind == 'symlink':
1293
 
        return InventoryLink(file_id, name, parent_id)
1294
 
    else:
1295
 
        raise BzrError("unknown kind %r" % kind)
1296
 
 
1297
 
 
1298
 
_NAME_RE = None
 
645
 
 
646
 
 
647
_NAME_RE = re.compile(r'^[^/\\]+$')
1299
648
 
1300
649
def is_valid_name(name):
1301
 
    global _NAME_RE
1302
 
    if _NAME_RE is None:
1303
 
        _NAME_RE = re.compile(r'^[^/\\]+$')
1304
 
        
1305
650
    return bool(_NAME_RE.match(name))