/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: Aaron Bentley
  • Date: 2006-06-11 21:26:20 UTC
  • mto: This revision was merged to the branch mainline in revision 1764.
  • Revision ID: aaron.bentley@utoronto.ca-20060611212620-2517ff1406176fd9
Rename run_bzr_external -> run_bzr_subprocess, add docstring

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 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.
17
25
 
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
21
29
 
22
30
 
23
 
import sys, os.path, types, re
 
31
import collections
 
32
import os.path
 
33
import re
 
34
import sys
 
35
import tarfile
 
36
import types
24
37
 
25
38
import bzrlib
26
 
from bzrlib.errors import BzrError, BzrCheckError
27
 
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
39
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
40
                            pathjoin, sha_strings)
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError, BinaryFile)
29
43
from bzrlib.trace import mutter
30
 
from bzrlib.errors import NotVersionedError
31
 
        
 
44
 
32
45
 
33
46
class InventoryEntry(object):
34
47
    """Description of a versioned file.
36
49
    An InventoryEntry has the following fields, which are also
37
50
    present in the XML inventory-entry element:
38
51
 
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
 
 
 
52
    file_id
 
53
 
 
54
    name
 
55
        (within the parent directory)
 
56
 
 
57
    parent_id
 
58
        file_id of the parent directory, or ROOT_ID
 
59
 
 
60
    revision
 
61
        the revision_id in which this variation of this file was 
 
62
        introduced.
 
63
 
 
64
    executable
 
65
        Indicates that this file should be executable on systems
 
66
        that support it.
 
67
 
 
68
    text_sha1
 
69
        sha-1 of the text of the file
 
70
        
 
71
    text_size
 
72
        size in bytes of the text of the file
 
73
        
 
74
    (reading a version 4 tree created a text_id field.)
53
75
 
54
76
    >>> i = Inventory()
55
77
    >>> i.path2id('')
56
78
    'TREE_ROOT'
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
 
79
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
 
80
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
 
81
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
 
82
    InventoryFile('2323', 'hello.c', parent_id='123')
 
83
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
 
84
    >>> for ix, j in enumerate(i.iter_entries()):
 
85
    ...   print (j[0] == shouldbe[ix], j[1])
61
86
    ... 
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'))
 
87
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
88
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
 
89
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
65
90
    Traceback (most recent call last):
66
91
    ...
67
92
    BzrError: inventory already contains entry with id {2323}
68
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
69
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
93
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
 
94
    InventoryFile('2324', 'bye.c', parent_id='123')
 
95
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
 
96
    InventoryDirectory('2325', 'wibble', parent_id='123')
70
97
    >>> i.path2id('src/wibble')
71
98
    '2325'
72
99
    >>> '2325' in i
73
100
    True
74
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
101
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
75
103
    >>> i['2326']
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])
 
104
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
105
    >>> for path, entry in i.iter_entries():
 
106
    ...     print path
 
107
    ...     assert i.path2id(path)
80
108
    ... 
81
109
    src
82
110
    src/bye.c
85
113
    src/wibble/wibble.c
86
114
    >>> i.id2path('2326')
87
115
    '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.
92
116
    """
93
117
 
94
 
    # TODO: split InventoryEntry into subclasses for files,
95
 
    # directories, etc etc.
96
 
 
 
118
    # Constants returned by describe_change()
 
119
    #
 
120
    # TODO: These should probably move to some kind of FileChangeDescription 
 
121
    # class; that's like what's inside a TreeDelta but we want to be able to 
 
122
    # generate them just for one file at a time.
 
123
    RENAMED = 'renamed'
 
124
    MODIFIED_AND_RENAMED = 'modified and renamed'
 
125
    
97
126
    __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):
 
127
                 'text_id', 'parent_id', 'children', 'executable', 
 
128
                 'revision']
 
129
 
 
130
    def detect_changes(self, old_entry):
 
131
        """Return a (text_modified, meta_modified) from this to old_entry.
 
132
        
 
133
        _read_tree_state must have been called on self and old_entry prior to 
 
134
        calling detect_changes.
 
135
        """
 
136
        return False, False
 
137
 
 
138
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
139
             output_to, reverse=False):
 
140
        """Perform a diff from this to to_entry.
 
141
 
 
142
        text_diff will be used for textual difference calculation.
 
143
        This is a template method, override _diff in child classes.
 
144
        """
 
145
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
146
        if to_entry:
 
147
            # cannot diff from one kind to another - you must do a removal
 
148
            # and an addif they do not match.
 
149
            assert self.kind == to_entry.kind
 
150
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
151
                                      to_tree)
 
152
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
153
                   output_to, reverse)
 
154
 
 
155
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
156
             output_to, reverse=False):
 
157
        """Perform a diff between two entries of the same kind."""
 
158
 
 
159
    def find_previous_heads(self, previous_inventories,
 
160
                            versioned_file_store,
 
161
                            transaction,
 
162
                            entry_vf=None):
 
163
        """Return the revisions and entries that directly preceed this.
 
164
 
 
165
        Returned as a map from revision to inventory entry.
 
166
 
 
167
        This is a map containing the file revisions in all parents
 
168
        for which the file exists, and its revision is not a parent of
 
169
        any other. If the file is new, the set will be empty.
 
170
 
 
171
        :param versioned_file_store: A store where ancestry data on this
 
172
                                     file id can be queried.
 
173
        :param transaction: The transaction that queries to the versioned 
 
174
                            file store should be completed under.
 
175
        :param entry_vf: The entry versioned file, if its already available.
 
176
        """
 
177
        def get_ancestors(weave, entry):
 
178
            return set(weave.get_ancestry(entry.revision))
 
179
        # revision:ie mapping for each ie found in previous_inventories.
 
180
        candidates = {}
 
181
        # revision:ie mapping with one revision for each head.
 
182
        heads = {}
 
183
        # revision: ancestor list for each head
 
184
        head_ancestors = {}
 
185
        # identify candidate head revision ids.
 
186
        for inv in previous_inventories:
 
187
            if self.file_id in inv:
 
188
                ie = inv[self.file_id]
 
189
                assert ie.file_id == self.file_id
 
190
                if ie.revision in candidates:
 
191
                    # same revision value in two different inventories:
 
192
                    # correct possible inconsistencies:
 
193
                    #     * there was a bug in revision updates with 'x' bit 
 
194
                    #       support.
 
195
                    try:
 
196
                        if candidates[ie.revision].executable != ie.executable:
 
197
                            candidates[ie.revision].executable = False
 
198
                            ie.executable = False
 
199
                    except AttributeError:
 
200
                        pass
 
201
                    # must now be the same.
 
202
                    assert candidates[ie.revision] == ie
 
203
                else:
 
204
                    # add this revision as a candidate.
 
205
                    candidates[ie.revision] = ie
 
206
 
 
207
        # common case optimisation
 
208
        if len(candidates) == 1:
 
209
            # if there is only one candidate revision found
 
210
            # then we can opening the versioned file to access ancestry:
 
211
            # there cannot be any ancestors to eliminate when there is 
 
212
            # only one revision available.
 
213
            heads[ie.revision] = ie
 
214
            return heads
 
215
 
 
216
        # eliminate ancestors amongst the available candidates:
 
217
        # heads are those that are not an ancestor of any other candidate
 
218
        # - this provides convergence at a per-file level.
 
219
        for ie in candidates.values():
 
220
            # may be an ancestor of a known head:
 
221
            already_present = 0 != len(
 
222
                [head for head in heads 
 
223
                 if ie.revision in head_ancestors[head]])
 
224
            if already_present:
 
225
                # an ancestor of an analyzed candidate.
 
226
                continue
 
227
            # not an ancestor of a known head:
 
228
            # load the versioned file for this file id if needed
 
229
            if entry_vf is None:
 
230
                entry_vf = versioned_file_store.get_weave_or_empty(
 
231
                    self.file_id, transaction)
 
232
            ancestors = get_ancestors(entry_vf, ie)
 
233
            # may knock something else out:
 
234
            check_heads = list(heads.keys())
 
235
            for head in check_heads:
 
236
                if head in ancestors:
 
237
                    # this previously discovered 'head' is not
 
238
                    # really a head - its an ancestor of the newly 
 
239
                    # found head,
 
240
                    heads.pop(head)
 
241
            head_ancestors[ie.revision] = ancestors
 
242
            heads[ie.revision] = ie
 
243
        return heads
 
244
 
 
245
    def get_tar_item(self, root, dp, now, tree):
 
246
        """Get a tarfile item and a file stream for its content."""
 
247
        item = tarfile.TarInfo(pathjoin(root, dp))
 
248
        # TODO: would be cool to actually set it to the timestamp of the
 
249
        # revision it was last changed
 
250
        item.mtime = now
 
251
        fileobj = self._put_in_tar(item, tree)
 
252
        return item, fileobj
 
253
 
 
254
    def has_text(self):
 
255
        """Return true if the object this entry represents has textual data.
 
256
 
 
257
        Note that textual data includes binary content.
 
258
 
 
259
        Also note that all entries get weave files created for them.
 
260
        This attribute is primarily used when upgrading from old trees that
 
261
        did not have the weave index for all inventory entries.
 
262
        """
 
263
        return False
 
264
 
 
265
    def __init__(self, file_id, name, parent_id, text_id=None):
101
266
        """Create an InventoryEntry
102
267
        
103
268
        The filename must be a single component, relative to the
104
269
        parent directory; it cannot be a whole path or relative name.
105
270
 
106
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
271
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
107
272
        >>> e.name
108
273
        'hello.c'
109
274
        >>> e.file_id
110
275
        '123'
111
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
276
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
112
277
        Traceback (most recent call last):
113
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
278
        InvalidEntryName: Invalid entry name: src/hello.c
114
279
        """
 
280
        assert isinstance(name, basestring), name
115
281
        if '/' in name or '\\' in name:
116
 
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
117
 
        
 
282
            raise InvalidEntryName(name=name)
 
283
        self.executable = False
 
284
        self.revision = None
118
285
        self.text_sha1 = None
119
286
        self.text_size = None
120
 
    
121
287
        self.file_id = file_id
122
288
        self.name = name
123
 
        self.kind = kind
124
289
        self.text_id = text_id
125
290
        self.parent_id = parent_id
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
 
 
 
291
        self.symlink_target = None
 
292
 
 
293
    def kind_character(self):
 
294
        """Return a short kind indicator useful for appending to names."""
 
295
        raise BzrError('unknown kind %r' % self.kind)
 
296
 
 
297
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
298
 
 
299
    def _put_in_tar(self, item, tree):
 
300
        """populate item for stashing in a tar, and return the content stream.
 
301
 
 
302
        If no content is available, return None.
 
303
        """
 
304
        raise BzrError("don't know how to export {%s} of kind %r" %
 
305
                       (self.file_id, self.kind))
 
306
 
 
307
    def put_on_disk(self, dest, dp, tree):
 
308
        """Create a representation of self on disk in the prefix dest.
 
309
        
 
310
        This is a template method - implement _put_on_disk in subclasses.
 
311
        """
 
312
        fullpath = pathjoin(dest, dp)
 
313
        self._put_on_disk(fullpath, tree)
 
314
        mutter("  export {%s} kind %s to %s", self.file_id,
 
315
                self.kind, fullpath)
 
316
 
 
317
    def _put_on_disk(self, fullpath, tree):
 
318
        """Put this entry onto disk at fullpath, from tree tree."""
 
319
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
134
320
 
135
321
    def sorted_children(self):
136
322
        l = self.children.items()
137
323
        l.sort()
138
324
        return l
139
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 != 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))
140
354
 
141
355
    def copy(self):
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
 
 
 
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'
150
398
 
151
399
    def __repr__(self):
152
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
400
        return ("%s(%r, %r, parent_id=%r)"
153
401
                % (self.__class__.__name__,
154
402
                   self.file_id,
155
403
                   self.name,
156
 
                   self.kind,
157
404
                   self.parent_id))
158
405
 
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)
 
406
    def snapshot(self, revision, path, previous_entries,
 
407
                 work_tree, commit_builder):
 
408
        """Make a snapshot of this entry which may or may not have changed.
 
409
        
 
410
        This means that all its fields are populated, that it has its
 
411
        text stored in the text store or weave.
 
412
        """
 
413
        mutter('new parents of %s are %r', path, previous_entries)
 
414
        self._read_tree_state(path, work_tree)
 
415
        # TODO: Where should we determine whether to reuse a
 
416
        # previous revision id or create a new revision? 20060606
 
417
        if len(previous_entries) == 1:
 
418
            # cannot be unchanged unless there is only one parent file rev.
 
419
            parent_ie = previous_entries.values()[0]
 
420
            if self._unchanged(parent_ie):
 
421
                mutter("found unchanged entry")
 
422
                self.revision = parent_ie.revision
 
423
                return "unchanged"
 
424
        return self._snapshot_into_revision(revision, previous_entries, 
 
425
                                            work_tree, commit_builder)
 
426
 
 
427
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
 
428
                                commit_builder):
 
429
        """Record this revision unconditionally into a store.
 
430
 
 
431
        The entry's last-changed revision property (`revision`) is updated to 
 
432
        that of the new revision.
 
433
        
 
434
        :param revision: id of the new revision that is being recorded.
 
435
 
 
436
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
 
437
        """
 
438
        mutter('new revision {%s} for {%s}', revision, self.file_id)
 
439
        self.revision = revision
 
440
        self._snapshot_text(previous_entries, work_tree, commit_builder)
 
441
 
 
442
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
 
443
        """Record the 'text' of this entry, whatever form that takes.
 
444
        
 
445
        This default implementation simply adds an empty text.
 
446
        """
 
447
        raise NotImplementedError(self._snapshot_text)
213
448
 
214
449
    def __eq__(self, other):
215
450
        if not isinstance(other, InventoryEntry):
216
451
            return NotImplemented
217
452
 
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
 
 
 
453
        return ((self.file_id == other.file_id)
 
454
                and (self.name == other.name)
 
455
                and (other.symlink_target == self.symlink_target)
 
456
                and (self.text_sha1 == other.text_sha1)
 
457
                and (self.text_size == other.text_size)
 
458
                and (self.text_id == other.text_id)
 
459
                and (self.parent_id == other.parent_id)
 
460
                and (self.kind == other.kind)
 
461
                and (self.revision == other.revision)
 
462
                and (self.executable == other.executable)
 
463
                )
226
464
 
227
465
    def __ne__(self, other):
228
466
        return not (self == other)
230
468
    def __hash__(self):
231
469
        raise ValueError('not hashable')
232
470
 
 
471
    def _unchanged(self, previous_ie):
 
472
        """Has this entry changed relative to previous_ie.
 
473
 
 
474
        This method should be overriden in child classes.
 
475
        """
 
476
        compatible = True
 
477
        # different inv parent
 
478
        if previous_ie.parent_id != self.parent_id:
 
479
            compatible = False
 
480
        # renamed
 
481
        elif previous_ie.name != self.name:
 
482
            compatible = False
 
483
        return compatible
 
484
 
 
485
    def _read_tree_state(self, path, work_tree):
 
486
        """Populate fields in the inventory entry from the given tree.
 
487
        
 
488
        Note that this should be modified to be a noop on virtual trees
 
489
        as all entries created there are prepopulated.
 
490
        """
 
491
        # TODO: Rather than running this manually, we should check the 
 
492
        # working sha1 and other expensive properties when they're
 
493
        # first requested, or preload them if they're already known
 
494
        pass            # nothing to do by default
 
495
 
 
496
    def _forget_tree_state(self):
 
497
        pass
233
498
 
234
499
 
235
500
class RootEntry(InventoryEntry):
 
501
 
 
502
    def _check(self, checker, rev_id, tree):
 
503
        """See InventoryEntry._check"""
 
504
 
236
505
    def __init__(self, file_id):
237
506
        self.file_id = file_id
238
507
        self.children = {}
239
508
        self.kind = 'root_directory'
240
509
        self.parent_id = None
241
 
        self.name = ''
 
510
        self.name = u''
242
511
 
243
512
    def __eq__(self, other):
244
513
        if not isinstance(other, RootEntry):
248
517
               and (self.children == other.children)
249
518
 
250
519
 
 
520
class InventoryDirectory(InventoryEntry):
 
521
    """A directory in an inventory."""
 
522
 
 
523
    def _check(self, checker, rev_id, tree):
 
524
        """See InventoryEntry._check"""
 
525
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
526
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
527
                                % (self.file_id, rev_id))
 
528
 
 
529
    def copy(self):
 
530
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
531
        other.revision = self.revision
 
532
        # note that children are *not* copied; they're pulled across when
 
533
        # others are added
 
534
        return other
 
535
 
 
536
    def __init__(self, file_id, name, parent_id):
 
537
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
538
        self.children = {}
 
539
        self.kind = 'directory'
 
540
 
 
541
    def kind_character(self):
 
542
        """See InventoryEntry.kind_character."""
 
543
        return '/'
 
544
 
 
545
    def _put_in_tar(self, item, tree):
 
546
        """See InventoryEntry._put_in_tar."""
 
547
        item.type = tarfile.DIRTYPE
 
548
        fileobj = None
 
549
        item.name += '/'
 
550
        item.size = 0
 
551
        item.mode = 0755
 
552
        return fileobj
 
553
 
 
554
    def _put_on_disk(self, fullpath, tree):
 
555
        """See InventoryEntry._put_on_disk."""
 
556
        os.mkdir(fullpath)
 
557
 
 
558
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
559
        """See InventoryEntry._snapshot_text."""
 
560
        commit_builder.modified_directory(self.file_id, file_parents)
 
561
 
 
562
 
 
563
class InventoryFile(InventoryEntry):
 
564
    """A file in an inventory."""
 
565
 
 
566
    def _check(self, checker, tree_revision_id, tree):
 
567
        """See InventoryEntry._check"""
 
568
        t = (self.file_id, self.revision)
 
569
        if t in checker.checked_texts:
 
570
            prev_sha = checker.checked_texts[t]
 
571
            if prev_sha != self.text_sha1:
 
572
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
573
                                    (self.file_id, tree_revision_id))
 
574
            else:
 
575
                checker.repeated_text_cnt += 1
 
576
                return
 
577
 
 
578
        if self.file_id not in checker.checked_weaves:
 
579
            mutter('check weave {%s}', self.file_id)
 
580
            w = tree.get_weave(self.file_id)
 
581
            # Not passing a progress bar, because it creates a new
 
582
            # progress, which overwrites the current progress,
 
583
            # and doesn't look nice
 
584
            w.check()
 
585
            checker.checked_weaves[self.file_id] = True
 
586
        else:
 
587
            w = tree.get_weave(self.file_id)
 
588
 
 
589
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
 
590
        checker.checked_text_cnt += 1
 
591
        # We can't check the length, because Weave doesn't store that
 
592
        # information, and the whole point of looking at the weave's
 
593
        # sha1sum is that we don't have to extract the text.
 
594
        if self.text_sha1 != w.get_sha1(self.revision):
 
595
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
596
                                % (self.file_id, self.revision))
 
597
        checker.checked_texts[t] = self.text_sha1
 
598
 
 
599
    def copy(self):
 
600
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
601
        other.executable = self.executable
 
602
        other.text_id = self.text_id
 
603
        other.text_sha1 = self.text_sha1
 
604
        other.text_size = self.text_size
 
605
        other.revision = self.revision
 
606
        return other
 
607
 
 
608
    def detect_changes(self, old_entry):
 
609
        """See InventoryEntry.detect_changes."""
 
610
        assert self.text_sha1 != None
 
611
        assert old_entry.text_sha1 != None
 
612
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
613
        meta_modified = (self.executable != old_entry.executable)
 
614
        return text_modified, meta_modified
 
615
 
 
616
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
617
             output_to, reverse=False):
 
618
        """See InventoryEntry._diff."""
 
619
        try:
 
620
            from_text = tree.get_file(self.file_id).readlines()
 
621
            if to_entry:
 
622
                to_text = to_tree.get_file(to_entry.file_id).readlines()
 
623
            else:
 
624
                to_text = []
 
625
            if not reverse:
 
626
                text_diff(from_label, from_text,
 
627
                          to_label, to_text, output_to)
 
628
            else:
 
629
                text_diff(to_label, to_text,
 
630
                          from_label, from_text, output_to)
 
631
        except BinaryFile:
 
632
            if reverse:
 
633
                label_pair = (to_label, from_label)
 
634
            else:
 
635
                label_pair = (from_label, to_label)
 
636
            print >> output_to, "Binary files %s and %s differ" % label_pair
 
637
 
 
638
    def has_text(self):
 
639
        """See InventoryEntry.has_text."""
 
640
        return True
 
641
 
 
642
    def __init__(self, file_id, name, parent_id):
 
643
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
644
        self.kind = 'file'
 
645
 
 
646
    def kind_character(self):
 
647
        """See InventoryEntry.kind_character."""
 
648
        return ''
 
649
 
 
650
    def _put_in_tar(self, item, tree):
 
651
        """See InventoryEntry._put_in_tar."""
 
652
        item.type = tarfile.REGTYPE
 
653
        fileobj = tree.get_file(self.file_id)
 
654
        item.size = self.text_size
 
655
        if tree.is_executable(self.file_id):
 
656
            item.mode = 0755
 
657
        else:
 
658
            item.mode = 0644
 
659
        return fileobj
 
660
 
 
661
    def _put_on_disk(self, fullpath, tree):
 
662
        """See InventoryEntry._put_on_disk."""
 
663
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
664
        if tree.is_executable(self.file_id):
 
665
            os.chmod(fullpath, 0755)
 
666
 
 
667
    def _read_tree_state(self, path, work_tree):
 
668
        """See InventoryEntry._read_tree_state."""
 
669
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
 
670
        # FIXME: 20050930 probe for the text size when getting sha1
 
671
        # in _read_tree_state
 
672
        self.executable = work_tree.is_executable(self.file_id, path=path)
 
673
 
 
674
    def _forget_tree_state(self):
 
675
        self.text_sha1 = None
 
676
        self.executable = None
 
677
 
 
678
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
679
        """See InventoryEntry._snapshot_text."""
 
680
        def get_content_byte_lines():
 
681
            return work_tree.get_file(self.file_id).readlines()
 
682
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
 
683
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
 
684
 
 
685
    def _unchanged(self, previous_ie):
 
686
        """See InventoryEntry._unchanged."""
 
687
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
688
        if self.text_sha1 != previous_ie.text_sha1:
 
689
            compatible = False
 
690
        else:
 
691
            # FIXME: 20050930 probe for the text size when getting sha1
 
692
            # in _read_tree_state
 
693
            self.text_size = previous_ie.text_size
 
694
        if self.executable != previous_ie.executable:
 
695
            compatible = False
 
696
        return compatible
 
697
 
 
698
 
 
699
class InventoryLink(InventoryEntry):
 
700
    """A file in an inventory."""
 
701
 
 
702
    __slots__ = ['symlink_target']
 
703
 
 
704
    def _check(self, checker, rev_id, tree):
 
705
        """See InventoryEntry._check"""
 
706
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
707
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
708
                    % (self.file_id, rev_id))
 
709
        if self.symlink_target == None:
 
710
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
711
                    % (self.file_id, rev_id))
 
712
 
 
713
    def copy(self):
 
714
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
715
        other.symlink_target = self.symlink_target
 
716
        other.revision = self.revision
 
717
        return other
 
718
 
 
719
    def detect_changes(self, old_entry):
 
720
        """See InventoryEntry.detect_changes."""
 
721
        # FIXME: which _modified field should we use ? RBC 20051003
 
722
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
723
        if text_modified:
 
724
            mutter("    symlink target changed")
 
725
        meta_modified = False
 
726
        return text_modified, meta_modified
 
727
 
 
728
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
729
             output_to, reverse=False):
 
730
        """See InventoryEntry._diff."""
 
731
        from_text = self.symlink_target
 
732
        if to_entry is not None:
 
733
            to_text = to_entry.symlink_target
 
734
            if reverse:
 
735
                temp = from_text
 
736
                from_text = to_text
 
737
                to_text = temp
 
738
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
739
        else:
 
740
            if not reverse:
 
741
                print >>output_to, '=== target was %r' % self.symlink_target
 
742
            else:
 
743
                print >>output_to, '=== target is %r' % self.symlink_target
 
744
 
 
745
    def __init__(self, file_id, name, parent_id):
 
746
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
747
        self.kind = 'symlink'
 
748
 
 
749
    def kind_character(self):
 
750
        """See InventoryEntry.kind_character."""
 
751
        return ''
 
752
 
 
753
    def _put_in_tar(self, item, tree):
 
754
        """See InventoryEntry._put_in_tar."""
 
755
        item.type = tarfile.SYMTYPE
 
756
        fileobj = None
 
757
        item.size = 0
 
758
        item.mode = 0755
 
759
        item.linkname = self.symlink_target
 
760
        return fileobj
 
761
 
 
762
    def _put_on_disk(self, fullpath, tree):
 
763
        """See InventoryEntry._put_on_disk."""
 
764
        try:
 
765
            os.symlink(self.symlink_target, fullpath)
 
766
        except OSError,e:
 
767
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
768
 
 
769
    def _read_tree_state(self, path, work_tree):
 
770
        """See InventoryEntry._read_tree_state."""
 
771
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
772
 
 
773
    def _forget_tree_state(self):
 
774
        self.symlink_target = None
 
775
 
 
776
    def _unchanged(self, previous_ie):
 
777
        """See InventoryEntry._unchanged."""
 
778
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
779
        if self.symlink_target != previous_ie.symlink_target:
 
780
            compatible = False
 
781
        return compatible
 
782
 
 
783
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
784
        """See InventoryEntry._snapshot_text."""
 
785
        commit_builder.modified_link(
 
786
            self.file_id, file_parents, self.symlink_target)
 
787
 
251
788
 
252
789
class Inventory(object):
253
790
    """Inventory of versioned files in a tree.
267
804
    inserted, other than through the Inventory API.
268
805
 
269
806
    >>> inv = Inventory()
270
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
807
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
808
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
271
809
    >>> inv['123-123'].name
272
810
    'hello.c'
273
811
 
281
819
    May also look up by name:
282
820
 
283
821
    >>> [x[0] for x in inv.iter_entries()]
284
 
    ['hello.c']
 
822
    [u'hello.c']
285
823
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
286
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
824
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
825
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
287
826
    """
288
 
    def __init__(self, root_id=ROOT_ID):
 
827
    def __init__(self, root_id=ROOT_ID, revision_id=None):
289
828
        """Create or read an inventory.
290
829
 
291
830
        If a working directory is specified, the inventory is read
295
834
        The inventory is created with a default root directory, with
296
835
        an id of None.
297
836
        """
298
 
        # We are letting Branch(init=True) create a unique inventory
 
837
        # We are letting Branch.create() create a unique inventory
299
838
        # root id. Rather than generating a random one here.
300
839
        #if root_id is None:
301
840
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
302
841
        self.root = RootEntry(root_id)
 
842
        self.revision_id = revision_id
303
843
        self._byid = {self.root.file_id: self.root}
304
844
 
305
845
 
 
846
    def copy(self):
 
847
        # TODO: jam 20051218 Should copy also copy the revision_id?
 
848
        other = Inventory(self.root.file_id)
 
849
        # copy recursively so we know directories will be added before
 
850
        # their children.  There are more efficient ways than this...
 
851
        for path, entry in self.iter_entries():
 
852
            if entry == self.root:
 
853
                continue
 
854
            other.add(entry.copy())
 
855
        return other
 
856
 
 
857
 
306
858
    def __iter__(self):
307
859
        return iter(self._byid)
308
860
 
320
872
        elif isinstance(from_dir, basestring):
321
873
            from_dir = self._byid[from_dir]
322
874
            
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
 
 
 
875
        # unrolling the recursive called changed the time from
 
876
        # 440ms/663ms (inline/total) to 116ms/116ms
 
877
        children = from_dir.children.items()
 
878
        children.sort()
 
879
        children = collections.deque(children)
 
880
        stack = [(u'', children)]
 
881
        while stack:
 
882
            from_dir_relpath, children = stack[-1]
 
883
 
 
884
            while children:
 
885
                name, ie = children.popleft()
 
886
 
 
887
                # we know that from_dir_relpath never ends in a slash
 
888
                # and 'f' doesn't begin with one, we can do a string op, rather
 
889
                # than the checks of pathjoin(), though this means that all paths
 
890
                # start with a slash
 
891
                path = from_dir_relpath + '/' + name
 
892
 
 
893
                yield path[1:], ie
 
894
 
 
895
                if ie.kind != 'directory':
 
896
                    continue
 
897
 
 
898
                # But do this child first
 
899
                new_children = ie.children.items()
 
900
                new_children.sort()
 
901
                new_children = collections.deque(new_children)
 
902
                stack.append((path, new_children))
 
903
                # Break out of inner loop, so that we start outer loop with child
 
904
                break
 
905
            else:
 
906
                # if we finished all children, pop it off the stack
 
907
                stack.pop()
331
908
 
332
909
    def entries(self):
333
910
        """Return list of (path, ie) for all entries except the root.
339
916
            kids = dir_ie.children.items()
340
917
            kids.sort()
341
918
            for name, ie in kids:
342
 
                child_path = os.path.join(dir_path, name)
 
919
                child_path = pathjoin(dir_path, name)
343
920
                accum.append((child_path, ie))
344
921
                if ie.kind == 'directory':
345
922
                    descend(ie, child_path)
346
923
 
347
 
        descend(self.root, '')
 
924
        descend(self.root, u'')
348
925
        return accum
349
926
 
350
927
 
359
936
            kids.sort()
360
937
 
361
938
            for name, child_ie in kids:
362
 
                child_path = os.path.join(parent_path, name)
 
939
                child_path = pathjoin(parent_path, name)
363
940
                descend(child_ie, child_path)
364
 
        descend(self.root, '')
 
941
        descend(self.root, u'')
365
942
        return accum
366
943
        
367
944
 
370
947
        """True if this entry contains a file with given id.
371
948
 
372
949
        >>> inv = Inventory()
373
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
950
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
951
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
374
952
        >>> '123' in inv
375
953
        True
376
954
        >>> '456' in inv
383
961
        """Return the entry for given file_id.
384
962
 
385
963
        >>> inv = Inventory()
386
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
964
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
965
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
387
966
        >>> inv['123123'].name
388
967
        'hello.c'
389
968
        """
407
986
        """Add entry to inventory.
408
987
 
409
988
        To add  a file to a branch ready to be committed, use Branch.add,
410
 
        which calls this."""
 
989
        which calls this.
 
990
 
 
991
        Returns the new entry object.
 
992
        """
411
993
        if entry.file_id in self._byid:
412
994
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
413
995
 
421
1003
 
422
1004
        if parent.children.has_key(entry.name):
423
1005
            raise BzrError("%s is already versioned" %
424
 
                    appendpath(self.id2path(parent.file_id), entry.name))
 
1006
                    pathjoin(self.id2path(parent.file_id), entry.name))
425
1007
 
426
1008
        self._byid[entry.file_id] = entry
427
1009
        parent.children[entry.name] = entry
428
 
 
429
 
 
430
 
    def add_path(self, relpath, kind, file_id=None):
 
1010
        return entry
 
1011
 
 
1012
 
 
1013
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
431
1014
        """Add entry from a path.
432
1015
 
433
 
        The immediate parent must already be versioned"""
434
 
        from bzrlib.branch import gen_file_id
 
1016
        The immediate parent must already be versioned.
 
1017
 
 
1018
        Returns the new entry object."""
435
1019
        
436
1020
        parts = bzrlib.osutils.splitpath(relpath)
 
1021
 
437
1022
        if len(parts) == 0:
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)
 
1023
            if file_id is None:
 
1024
                file_id = bzrlib.workingtree.gen_root_id()
 
1025
            self.root = RootEntry(file_id)
 
1026
            self._byid = {self.root.file_id: self.root}
 
1027
            return
 
1028
        else:
 
1029
            parent_path = parts[:-1]
 
1030
            parent_id = self.path2id(parent_path)
 
1031
            if parent_id == None:
 
1032
                raise NotVersionedError(path=parent_path)
 
1033
        ie = make_entry(kind, parts[-1], parent_id, file_id)
450
1034
        return self.add(ie)
451
1035
 
452
 
 
453
1036
    def __delitem__(self, file_id):
454
1037
        """Remove entry by id.
455
1038
 
456
1039
        >>> inv = Inventory()
457
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
1040
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1041
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
458
1042
        >>> '123' in inv
459
1043
        True
460
1044
        >>> del inv['123']
463
1047
        """
464
1048
        ie = self[file_id]
465
1049
 
466
 
        assert self[ie.parent_id].children[ie.name] == ie
 
1050
        assert ie.parent_id is None or \
 
1051
            self[ie.parent_id].children[ie.name] == ie
467
1052
        
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
 
 
475
1053
        del self._byid[file_id]
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)
 
1054
        if ie.parent_id is not None:
 
1055
            del self[ie.parent_id].children[ie.name]
514
1056
 
515
1057
 
516
1058
    def __eq__(self, other):
520
1062
        >>> i2 = Inventory()
521
1063
        >>> i1 == i2
522
1064
        True
523
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1065
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
1066
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
524
1067
        >>> i1 == i2
525
1068
        False
526
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1069
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
1070
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
527
1071
        >>> i1 == i2
528
1072
        True
529
1073
        """
538
1082
 
539
1083
 
540
1084
    def __ne__(self, other):
541
 
        return not (self == other)
 
1085
        return not self.__eq__(other)
542
1086
 
543
1087
 
544
1088
    def __hash__(self):
545
1089
        raise ValueError('not hashable')
546
1090
 
547
 
 
 
1091
    def _iter_file_id_parents(self, file_id):
 
1092
        """Yield the parents of file_id up to the root."""
 
1093
        while file_id != None:
 
1094
            try:
 
1095
                ie = self._byid[file_id]
 
1096
            except KeyError:
 
1097
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1098
            yield ie
 
1099
            file_id = ie.parent_id
548
1100
 
549
1101
    def get_idpath(self, file_id):
550
1102
        """Return a list of file_ids for the path to an entry.
555
1107
        root directory as depth 1.
556
1108
        """
557
1109
        p = []
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
 
1110
        for parent in self._iter_file_id_parents(file_id):
 
1111
            p.insert(0, parent.file_id)
565
1112
        return p
566
1113
 
567
 
 
568
1114
    def id2path(self, file_id):
569
 
        """Return as a list the path to file_id."""
570
 
 
 
1115
        """Return as a string the path to file_id.
 
1116
        
 
1117
        >>> i = Inventory()
 
1118
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1119
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1120
        >>> print i.id2path('foo-id')
 
1121
        src/foo.c
 
1122
        """
571
1123
        # get all names, skipping root
572
 
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
573
 
        return os.sep.join(p)
 
1124
        return '/'.join(reversed(
 
1125
            [parent.name for parent in 
 
1126
             self._iter_file_id_parents(file_id)][:-1]))
574
1127
            
575
 
 
576
 
 
577
1128
    def path2id(self, name):
578
1129
        """Walk down through directories to return entry of last component.
579
1130
 
583
1134
        This returns the entry of the last component in the path,
584
1135
        which may be either a file or a directory.
585
1136
 
586
 
        Returns None iff the path is not found.
 
1137
        Returns None IFF the path is not found.
587
1138
        """
588
1139
        if isinstance(name, types.StringTypes):
589
1140
            name = splitpath(name)
590
1141
 
591
 
        mutter("lookup path %r" % name)
 
1142
        # mutter("lookup path %r" % name)
592
1143
 
593
1144
        parent = self.root
594
1145
        for f in name:
642
1193
        file_ie.parent_id = new_parent_id
643
1194
 
644
1195
 
645
 
 
646
 
 
647
 
_NAME_RE = re.compile(r'^[^/\\]+$')
 
1196
def make_entry(kind, name, parent_id, file_id=None):
 
1197
    """Create an inventory entry.
 
1198
 
 
1199
    :param kind: the type of inventory entry to create.
 
1200
    :param name: the basename of the entry.
 
1201
    :param parent_id: the parent_id of the entry.
 
1202
    :param file_id: the file_id to use. if None, one will be created.
 
1203
    """
 
1204
    if file_id is None:
 
1205
        file_id = bzrlib.workingtree.gen_file_id(name)
 
1206
    if kind == 'directory':
 
1207
        return InventoryDirectory(file_id, name, parent_id)
 
1208
    elif kind == 'file':
 
1209
        return InventoryFile(file_id, name, parent_id)
 
1210
    elif kind == 'symlink':
 
1211
        return InventoryLink(file_id, name, parent_id)
 
1212
    else:
 
1213
        raise BzrError("unknown kind %r" % kind)
 
1214
 
 
1215
 
 
1216
 
 
1217
_NAME_RE = None
648
1218
 
649
1219
def is_valid_name(name):
 
1220
    global _NAME_RE
 
1221
    if _NAME_RE == None:
 
1222
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1223
        
650
1224
    return bool(_NAME_RE.match(name))