~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-09-06 07:26:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050906072613-1a4a18769aaaa3eb
- add xml round-trip test for revisions

- fix up __eq__ method for Revision

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
 
1
# (C) 2005 Canonical Ltd
3
2
 
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
"""Inventories map files to their name in a revision."""
19
 
 
20
 
 
21
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
22
 
__author__ = "Martin Pool <mbp@canonical.com>"
23
 
 
24
 
import sys, os.path, types
25
 
from sets import Set
26
 
 
27
 
try:
28
 
    from cElementTree import Element, ElementTree, SubElement
29
 
except ImportError:
30
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
31
 
 
32
 
from xml import XMLMixin
33
 
from errors import bailout
34
 
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
35
 
from trace import mutter
36
 
 
37
 
class InventoryEntry(XMLMixin):
 
17
 
 
18
# This should really be an id randomly assigned when the tree is
 
19
# created, but it's not for now.
 
20
ROOT_ID = "TREE_ROOT"
 
21
 
 
22
 
 
23
import sys, os.path, types, re
 
24
 
 
25
import bzrlib
 
26
from bzrlib.errors import BzrError, BzrCheckError
 
27
 
 
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
29
from bzrlib.trace import mutter
 
30
from bzrlib.errors import NotVersionedError
 
31
        
 
32
 
 
33
class InventoryEntry(object):
38
34
    """Description of a versioned file.
39
35
 
40
36
    An InventoryEntry has the following fields, which are also
57
53
 
58
54
    >>> i = Inventory()
59
55
    >>> i.path2id('')
60
 
    >>> i.add(InventoryEntry('123', 'src', kind='directory'))
61
 
    >>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
 
56
    'TREE_ROOT'
 
57
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
58
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
 
59
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
60
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
62
61
    >>> for j in i.iter_entries():
63
62
    ...   print j
64
63
    ... 
65
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
 
64
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
66
65
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
67
 
    >>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
 
66
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
68
67
    Traceback (most recent call last):
69
68
    ...
70
 
    BzrError: ('inventory already contains entry with id {2323}', [])
71
 
    >>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
72
 
    >>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
 
69
    BzrError: inventory already contains entry with id {2323}
 
70
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
71
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
 
72
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
73
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
73
74
    >>> i.path2id('src/wibble')
74
75
    '2325'
75
76
    >>> '2325' in i
76
77
    True
77
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
 
78
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
79
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
78
80
    >>> i['2326']
79
81
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
82
    >>> for j in i.iter_entries():
89
91
    >>> i.id2path('2326')
90
92
    'src/wibble/wibble.c'
91
93
 
92
 
    :todo: Maybe also keep the full path of the entry, and the children?
 
94
    TODO: Maybe also keep the full path of the entry, and the children?
93
95
           But those depend on its position within a particular inventory, and
94
96
           it would be nice not to need to hold the backpointer here.
95
97
    """
96
 
    def __init__(self, file_id, name, kind='file', text_id=None,
97
 
                 parent_id=None):
 
98
 
 
99
    # TODO: split InventoryEntry into subclasses for files,
 
100
    # directories, etc etc.
 
101
 
 
102
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
103
                 'text_id', 'parent_id', 'children',
 
104
                 'text_version', 'entry_version', ]
 
105
 
 
106
 
 
107
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
98
108
        """Create an InventoryEntry
99
109
        
100
110
        The filename must be a single component, relative to the
101
111
        parent directory; it cannot be a whole path or relative name.
102
112
 
103
 
        >>> e = InventoryEntry('123', 'hello.c')
 
113
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
104
114
        >>> e.name
105
115
        'hello.c'
106
116
        >>> e.file_id
107
117
        '123'
108
 
        >>> e = InventoryEntry('123', 'src/hello.c')
 
118
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
109
119
        Traceback (most recent call last):
110
 
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
 
120
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
111
121
        """
112
 
        
113
 
        if len(splitpath(name)) != 1:
114
 
            bailout('InventoryEntry name is not a simple filename: %r'
115
 
                    % name)
116
 
        
 
122
        assert isinstance(name, basestring), name
 
123
        if '/' in name or '\\' in name:
 
124
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
125
        
 
126
        self.text_version = None
 
127
        self.entry_version = None
 
128
        self.text_sha1 = None
 
129
        self.text_size = None
117
130
        self.file_id = file_id
118
131
        self.name = name
119
 
        assert kind in ['file', 'directory']
120
132
        self.kind = kind
121
133
        self.text_id = text_id
122
134
        self.parent_id = parent_id
123
 
        self.text_sha1 = None
124
 
        self.text_size = None
 
135
        if kind == 'directory':
 
136
            self.children = {}
 
137
        elif kind == 'file':
 
138
            pass
 
139
        else:
 
140
            raise BzrError("unhandled entry kind %r" % kind)
 
141
 
 
142
 
 
143
 
 
144
    def sorted_children(self):
 
145
        l = self.children.items()
 
146
        l.sort()
 
147
        return l
125
148
 
126
149
 
127
150
    def copy(self):
128
151
        other = InventoryEntry(self.file_id, self.name, self.kind,
129
 
                               self.text_id, self.parent_id)
 
152
                               self.parent_id, text_id=self.text_id)
130
153
        other.text_sha1 = self.text_sha1
131
154
        other.text_size = self.text_size
 
155
        # note that children are *not* copied; they're pulled across when
 
156
        # others are added
132
157
        return other
133
158
 
134
159
 
141
166
                   self.parent_id))
142
167
 
143
168
    
144
 
    def to_element(self):
145
 
        """Convert to XML element"""
146
 
        e = Element('entry')
147
 
 
148
 
        e.set('name', self.name)
149
 
        e.set('file_id', self.file_id)
150
 
        e.set('kind', self.kind)
151
 
 
152
 
        if self.text_size is not None:
153
 
            e.set('text_size', '%d' % self.text_size)
154
 
            
155
 
        for f in ['text_id', 'text_sha1', 'parent_id']:
156
 
            v = getattr(self, f)
157
 
            if v is not None:
158
 
                e.set(f, v)
159
 
 
160
 
        e.tail = '\n'
161
 
            
162
 
        return e
163
 
 
164
 
 
165
 
    def from_element(cls, elt):
166
 
        assert elt.tag == 'entry'
167
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
168
 
        self.text_id = elt.get('text_id')
169
 
        self.text_sha1 = elt.get('text_sha1')
170
 
        self.parent_id = elt.get('parent_id')
171
 
        
172
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
173
 
 
174
 
        v = elt.get('text_size')
175
 
        self.text_size = v and int(v)
176
 
 
177
 
        return self
178
 
            
179
 
 
180
 
    from_element = classmethod(from_element)
181
 
 
182
 
    def __cmp__(self, other):
183
 
        if self is other:
184
 
            return 0
 
169
    def __eq__(self, other):
185
170
        if not isinstance(other, InventoryEntry):
186
171
            return NotImplemented
187
172
 
188
 
        return cmp(self.file_id, other.file_id) \
189
 
               or cmp(self.name, other.name) \
190
 
               or cmp(self.text_sha1, other.text_sha1) \
191
 
               or cmp(self.text_size, other.text_size) \
192
 
               or cmp(self.text_id, other.text_id) \
193
 
               or cmp(self.parent_id, other.parent_id) \
194
 
               or cmp(self.kind, other.kind)
195
 
 
196
 
 
197
 
 
198
 
class Inventory(XMLMixin):
 
173
        return (self.file_id == other.file_id) \
 
174
               and (self.name == other.name) \
 
175
               and (self.text_sha1 == other.text_sha1) \
 
176
               and (self.text_size == other.text_size) \
 
177
               and (self.text_id == other.text_id) \
 
178
               and (self.parent_id == other.parent_id) \
 
179
               and (self.kind == other.kind) \
 
180
               and (self.text_version == other.text_version) \
 
181
               and (self.entry_version == other.entry_version)
 
182
 
 
183
 
 
184
    def __ne__(self, other):
 
185
        return not (self == other)
 
186
 
 
187
    def __hash__(self):
 
188
        raise ValueError('not hashable')
 
189
 
 
190
 
 
191
 
 
192
class RootEntry(InventoryEntry):
 
193
    def __init__(self, file_id):
 
194
        self.file_id = file_id
 
195
        self.children = {}
 
196
        self.kind = 'root_directory'
 
197
        self.parent_id = None
 
198
        self.name = ''
 
199
 
 
200
    def __eq__(self, other):
 
201
        if not isinstance(other, RootEntry):
 
202
            return NotImplemented
 
203
        
 
204
        return (self.file_id == other.file_id) \
 
205
               and (self.children == other.children)
 
206
 
 
207
 
 
208
 
 
209
class Inventory(object):
199
210
    """Inventory of versioned files in a tree.
200
211
 
201
 
    An Inventory acts like a set of InventoryEntry items.  You can
202
 
    also look files up by their file_id or name.
203
 
    
204
 
    May be read from and written to a metadata file in a tree.  To
205
 
    manipulate the inventory (for example to add a file), it is read
206
 
    in, modified, and then written back out.
 
212
    This describes which file_id is present at each point in the tree,
 
213
    and possibly the SHA-1 or other information about the file.
 
214
    Entries can be looked up either by path or by file_id.
207
215
 
208
216
    The inventory represents a typical unix file tree, with
209
217
    directories containing files and subdirectories.  We never store
213
221
    returned quickly.
214
222
 
215
223
    InventoryEntry objects must not be modified after they are
216
 
    inserted.
 
224
    inserted, other than through the Inventory API.
217
225
 
218
226
    >>> inv = Inventory()
219
 
    >>> inv.write_xml(sys.stdout)
220
 
    <inventory>
221
 
    </inventory>
222
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c'))
 
227
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
228
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
223
229
    >>> inv['123-123'].name
224
230
    'hello.c'
225
 
    >>> for file_id in inv: print file_id
226
 
    ...
227
 
    123-123
228
231
 
229
232
    May be treated as an iterator or set to look up file ids:
230
233
    
237
240
 
238
241
    >>> [x[0] for x in inv.iter_entries()]
239
242
    ['hello.c']
240
 
    
241
 
    >>> inv.write_xml(sys.stdout)
242
 
    <inventory>
243
 
    <entry file_id="123-123" kind="file" name="hello.c" />
244
 
    </inventory>
245
 
 
 
243
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
244
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
245
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
246
246
    """
247
 
 
248
 
    ## TODO: Clear up handling of files in subdirectories; we probably
249
 
    ## do want to be able to just look them up by name but this
250
 
    ## probably means gradually walking down the path, looking up as we go.
251
 
 
252
 
    ## TODO: Make sure only canonical filenames are stored.
253
 
 
254
 
    ## TODO: Do something sensible about the possible collisions on
255
 
    ## case-losing filesystems.  Perhaps we should just always forbid
256
 
    ## such collisions.
257
 
 
258
 
    ## _tree should probably just be stored as
259
 
    ## InventoryEntry._children on each directory.
260
 
 
261
 
    def __init__(self):
 
247
    def __init__(self, root_id=ROOT_ID):
262
248
        """Create or read an inventory.
263
249
 
264
250
        If a working directory is specified, the inventory is read
265
251
        from there.  If the file is specified, read from that. If not,
266
252
        the inventory is created empty.
 
253
 
 
254
        The inventory is created with a default root directory, with
 
255
        an id of None.
267
256
        """
268
 
        self._byid = dict()
269
 
 
270
 
        # _tree is indexed by parent_id; at each level a map from name
271
 
        # to ie.  The None entry is the root.
272
 
        self._tree = {None: {}}
 
257
        # We are letting Branch(init=True) create a unique inventory
 
258
        # root id. Rather than generating a random one here.
 
259
        #if root_id is None:
 
260
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
261
        self.root = RootEntry(root_id)
 
262
        self._byid = {self.root.file_id: self.root}
273
263
 
274
264
 
275
265
    def __iter__(self):
281
271
        return len(self._byid)
282
272
 
283
273
 
284
 
    def iter_entries(self, parent_id=None):
 
274
    def iter_entries(self, from_dir=None):
285
275
        """Return (path, entry) pairs, in order by name."""
286
 
        kids = self._tree[parent_id].items()
 
276
        if from_dir == None:
 
277
            assert self.root
 
278
            from_dir = self.root
 
279
        elif isinstance(from_dir, basestring):
 
280
            from_dir = self._byid[from_dir]
 
281
            
 
282
        kids = from_dir.children.items()
287
283
        kids.sort()
288
284
        for name, ie in kids:
289
285
            yield name, ie
290
286
            if ie.kind == 'directory':
291
 
                for cn, cie in self.iter_entries(parent_id=ie.file_id):
292
 
                    yield joinpath([name, cn]), cie
293
 
 
294
 
 
295
 
    def directories(self, include_root=True):
296
 
        """Return (path, entry) pairs for all directories.
297
 
        """
298
 
        if include_root:
299
 
            yield '', None
300
 
        for path, entry in self.iter_entries():
301
 
            if entry.kind == 'directory':
302
 
                yield path, entry
 
287
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
288
                    yield os.path.join(name, cn), cie
 
289
 
 
290
 
 
291
    def entries(self):
 
292
        """Return list of (path, ie) for all entries except the root.
 
293
 
 
294
        This may be faster than iter_entries.
 
295
        """
 
296
        accum = []
 
297
        def descend(dir_ie, dir_path):
 
298
            kids = dir_ie.children.items()
 
299
            kids.sort()
 
300
            for name, ie in kids:
 
301
                child_path = os.path.join(dir_path, name)
 
302
                accum.append((child_path, ie))
 
303
                if ie.kind == 'directory':
 
304
                    descend(ie, child_path)
 
305
 
 
306
        descend(self.root, '')
 
307
        return accum
 
308
 
 
309
 
 
310
    def directories(self):
 
311
        """Return (path, entry) pairs for all directories, including the root.
 
312
        """
 
313
        accum = []
 
314
        def descend(parent_ie, parent_path):
 
315
            accum.append((parent_path, parent_ie))
 
316
            
 
317
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
318
            kids.sort()
 
319
 
 
320
            for name, child_ie in kids:
 
321
                child_path = os.path.join(parent_path, name)
 
322
                descend(child_ie, child_path)
 
323
        descend(self.root, '')
 
324
        return accum
303
325
        
304
326
 
305
327
 
306
 
    def children(self, parent_id):
307
 
        """Return entries that are direct children of parent_id."""
308
 
        return self._tree[parent_id]
309
 
                    
310
 
 
311
 
 
312
 
    # TODO: return all paths and entries
313
 
 
314
 
 
315
328
    def __contains__(self, file_id):
316
329
        """True if this entry contains a file with given id.
317
330
 
318
331
        >>> inv = Inventory()
319
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
332
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
333
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
320
334
        >>> '123' in inv
321
335
        True
322
336
        >>> '456' in inv
329
343
        """Return the entry for given file_id.
330
344
 
331
345
        >>> inv = Inventory()
332
 
        >>> inv.add(InventoryEntry('123123', 'hello.c'))
 
346
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
347
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
333
348
        >>> inv['123123'].name
334
349
        'hello.c'
335
350
        """
336
 
        return self._byid[file_id]
 
351
        try:
 
352
            return self._byid[file_id]
 
353
        except KeyError:
 
354
            if file_id == None:
 
355
                raise BzrError("can't look up file_id None")
 
356
            else:
 
357
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
358
 
 
359
 
 
360
    def get_file_kind(self, file_id):
 
361
        return self._byid[file_id].kind
 
362
 
 
363
    def get_child(self, parent_id, filename):
 
364
        return self[parent_id].children.get(filename)
337
365
 
338
366
 
339
367
    def add(self, entry):
340
368
        """Add entry to inventory.
341
369
 
342
370
        To add  a file to a branch ready to be committed, use Branch.add,
343
 
        which calls this."""
344
 
        if entry.file_id in self:
345
 
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
346
 
 
347
 
        if entry.parent_id != None:
348
 
            if entry.parent_id not in self:
349
 
                bailout("parent_id %s of new entry not found in inventory"
350
 
                        % entry.parent_id)
351
 
            
352
 
        if self._tree[entry.parent_id].has_key(entry.name):
353
 
            bailout("%s is already versioned"
354
 
                    % appendpath(self.id2path(entry.parent_id), entry.name))
 
371
        which calls this.
 
372
 
 
373
        Returns the new entry object.
 
374
        """
 
375
        if entry.file_id in self._byid:
 
376
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
377
 
 
378
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
379
            entry.parent_id = self.root.file_id
 
380
 
 
381
        try:
 
382
            parent = self._byid[entry.parent_id]
 
383
        except KeyError:
 
384
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
385
 
 
386
        if parent.children.has_key(entry.name):
 
387
            raise BzrError("%s is already versioned" %
 
388
                    appendpath(self.id2path(parent.file_id), entry.name))
355
389
 
356
390
        self._byid[entry.file_id] = entry
357
 
        self._tree[entry.parent_id][entry.name] = entry
358
 
 
359
 
        if entry.kind == 'directory':
360
 
            self._tree[entry.file_id] = {}
 
391
        parent.children[entry.name] = entry
 
392
        return entry
 
393
 
 
394
 
 
395
    def add_path(self, relpath, kind, file_id=None):
 
396
        """Add entry from a path.
 
397
 
 
398
        The immediate parent must already be versioned.
 
399
 
 
400
        Returns the new entry object."""
 
401
        from bzrlib.branch import gen_file_id
 
402
        
 
403
        parts = bzrlib.osutils.splitpath(relpath)
 
404
        if len(parts) == 0:
 
405
            raise BzrError("cannot re-add root of inventory")
 
406
 
 
407
        if file_id == None:
 
408
            file_id = gen_file_id(relpath)
 
409
 
 
410
        parent_path = parts[:-1]
 
411
        parent_id = self.path2id(parent_path)
 
412
        if parent_id == None:
 
413
            raise NotVersionedError(parent_path)
 
414
 
 
415
        ie = InventoryEntry(file_id, parts[-1],
 
416
                            kind=kind, parent_id=parent_id)
 
417
        return self.add(ie)
361
418
 
362
419
 
363
420
    def __delitem__(self, file_id):
364
421
        """Remove entry by id.
365
422
 
366
423
        >>> inv = Inventory()
367
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
424
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
425
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
368
426
        >>> '123' in inv
369
427
        True
370
428
        >>> del inv['123']
373
431
        """
374
432
        ie = self[file_id]
375
433
 
376
 
        assert self._tree[ie.parent_id][ie.name] == ie
 
434
        assert self[ie.parent_id].children[ie.name] == ie
377
435
        
378
436
        # TODO: Test deleting all children; maybe hoist to a separate
379
437
        # deltree method?
380
438
        if ie.kind == 'directory':
381
 
            for cie in self._tree[file_id].values():
 
439
            for cie in ie.children.values():
382
440
                del self[cie.file_id]
383
 
            del self._tree[file_id]
 
441
            del ie.children
384
442
 
385
443
        del self._byid[file_id]
386
 
        del self._tree[ie.parent_id][ie.name]
387
 
 
388
 
 
389
 
    def id_set(self):
390
 
        return Set(self._byid)
391
 
 
392
 
 
393
 
    def to_element(self):
394
 
        """Convert to XML Element"""
395
 
        e = Element('inventory')
396
 
        e.text = '\n'
397
 
        for path, ie in self.iter_entries():
398
 
            e.append(ie.to_element())
399
 
        return e
400
 
    
401
 
 
402
 
    def from_element(cls, elt):
403
 
        """Construct from XML Element
404
 
 
405
 
        >>> inv = Inventory()
406
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
407
 
        >>> elt = inv.to_element()
408
 
        >>> inv2 = Inventory.from_element(elt)
409
 
        >>> inv2 == inv
410
 
        True
411
 
        """
412
 
        assert elt.tag == 'inventory'
413
 
        o = cls()
414
 
        for e in elt:
415
 
            o.add(InventoryEntry.from_element(e))
416
 
        return o
417
 
        
418
 
    from_element = classmethod(from_element)
419
 
 
420
 
 
421
 
    def __cmp__(self, other):
 
444
        del self[ie.parent_id].children[ie.name]
 
445
 
 
446
 
 
447
    def __eq__(self, other):
422
448
        """Compare two sets by comparing their contents.
423
449
 
424
450
        >>> i1 = Inventory()
425
451
        >>> i2 = Inventory()
426
452
        >>> i1 == i2
427
453
        True
428
 
        >>> i1.add(InventoryEntry('123', 'foo'))
 
454
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
455
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
429
456
        >>> i1 == i2
430
457
        False
431
 
        >>> i2.add(InventoryEntry('123', 'foo'))
 
458
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
459
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
432
460
        >>> i1 == i2
433
461
        True
434
462
        """
435
 
        if self is other:
436
 
            return 0
437
 
        
438
463
        if not isinstance(other, Inventory):
439
464
            return NotImplemented
440
465
 
441
 
        if self.id_set() ^ other.id_set():
442
 
            return 1
443
 
 
444
 
        for file_id in self._byid:
445
 
            c = cmp(self[file_id], other[file_id])
446
 
            if c: return c
447
 
 
448
 
        return 0
449
 
 
450
 
 
451
 
    def id2path(self, file_id):
452
 
        """Return as a list the path to file_id."""
 
466
        if len(self._byid) != len(other._byid):
 
467
            # shortcut: obviously not the same
 
468
            return False
 
469
 
 
470
        return self._byid == other._byid
 
471
 
 
472
 
 
473
    def __ne__(self, other):
 
474
        return not (self == other)
 
475
 
 
476
 
 
477
    def __hash__(self):
 
478
        raise ValueError('not hashable')
 
479
 
 
480
 
 
481
    def get_idpath(self, file_id):
 
482
        """Return a list of file_ids for the path to an entry.
 
483
 
 
484
        The list contains one element for each directory followed by
 
485
        the id of the file itself.  So the length of the returned list
 
486
        is equal to the depth of the file in the tree, counting the
 
487
        root directory as depth 1.
 
488
        """
453
489
        p = []
454
490
        while file_id != None:
455
 
            ie = self[file_id]
456
 
            p = [ie.name] + p
 
491
            try:
 
492
                ie = self._byid[file_id]
 
493
            except KeyError:
 
494
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
495
            p.insert(0, ie.file_id)
457
496
            file_id = ie.parent_id
458
 
        return joinpath(p)
 
497
        return p
 
498
 
 
499
 
 
500
    def id2path(self, file_id):
 
501
        """Return as a list the path to file_id."""
 
502
 
 
503
        # get all names, skipping root
 
504
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
505
        return os.sep.join(p)
459
506
            
460
507
 
461
508
 
467
514
 
468
515
        This returns the entry of the last component in the path,
469
516
        which may be either a file or a directory.
 
517
 
 
518
        Returns None iff the path is not found.
470
519
        """
471
 
        assert isinstance(name, types.StringTypes)
472
 
 
473
 
        parent_id = None
474
 
        for f in splitpath(name):
 
520
        if isinstance(name, types.StringTypes):
 
521
            name = splitpath(name)
 
522
 
 
523
        mutter("lookup path %r" % name)
 
524
 
 
525
        parent = self.root
 
526
        for f in name:
475
527
            try:
476
 
                cie = self._tree[parent_id][f]
 
528
                cie = parent.children[f]
477
529
                assert cie.name == f
478
 
                parent_id = cie.file_id
 
530
                assert cie.parent_id == parent.file_id
 
531
                parent = cie
479
532
            except KeyError:
480
533
                # or raise an error?
481
534
                return None
482
535
 
483
 
        return parent_id
484
 
 
485
 
 
486
 
    def get_child(self, parent_id, child_name):
487
 
        return self._tree[parent_id].get(child_name)
 
536
        return parent.file_id
488
537
 
489
538
 
490
539
    def has_filename(self, names):
492
541
 
493
542
 
494
543
    def has_id(self, file_id):
495
 
        assert isinstance(file_id, str)
496
544
        return self._byid.has_key(file_id)
497
545
 
498
546
 
499
 
 
500
 
if __name__ == '__main__':
501
 
    import doctest, inventory
502
 
    doctest.testmod(inventory)
 
547
    def rename(self, file_id, new_parent_id, new_name):
 
548
        """Move a file within the inventory.
 
549
 
 
550
        This can change either the name, or the parent, or both.
 
551
 
 
552
        This does not move the working file."""
 
553
        if not is_valid_name(new_name):
 
554
            raise BzrError("not an acceptable filename: %r" % new_name)
 
555
 
 
556
        new_parent = self._byid[new_parent_id]
 
557
        if new_name in new_parent.children:
 
558
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
559
 
 
560
        new_parent_idpath = self.get_idpath(new_parent_id)
 
561
        if file_id in new_parent_idpath:
 
562
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
563
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
 
564
 
 
565
        file_ie = self._byid[file_id]
 
566
        old_parent = self._byid[file_ie.parent_id]
 
567
 
 
568
        # TODO: Don't leave things messed up if this fails
 
569
 
 
570
        del old_parent.children[file_ie.name]
 
571
        new_parent.children[new_name] = file_ie
 
572
        
 
573
        file_ie.name = new_name
 
574
        file_ie.parent_id = new_parent_id
 
575
 
 
576
 
 
577
 
 
578
 
 
579
_NAME_RE = None
 
580
 
 
581
def is_valid_name(name):
 
582
    global _NAME_RE
 
583
    if _NAME_RE == None:
 
584
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
585
        
 
586
    return bool(_NAME_RE.match(name))