/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

Merge bzr.dev

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