~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-07-29 13:40:25 UTC
  • Revision ID: mbp@sourcefrog.net-20050729134025-9abbcae0d0faf25f
- todo: discussion of an uncommit command

  and this is the thousandth 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 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.branch import gen_file_id
 
31
from bzrlib.errors import NotVersionedError
 
32
        
 
33
 
 
34
class InventoryEntry(object):
38
35
    """Description of a versioned file.
39
36
 
40
37
    An InventoryEntry has the following fields, which are also
57
54
 
58
55
    >>> i = Inventory()
59
56
    >>> i.path2id('')
60
 
    >>> i.add(InventoryEntry('123', 'src', kind='directory'))
61
 
    >>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
 
57
    'TREE_ROOT'
 
58
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
59
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
62
60
    >>> for j in i.iter_entries():
63
61
    ...   print j
64
62
    ... 
65
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
 
63
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
66
64
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
67
 
    >>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
 
65
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
68
66
    Traceback (most recent call last):
69
67
    ...
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'))
 
68
    BzrError: inventory already contains entry with id {2323}
 
69
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
70
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
73
71
    >>> i.path2id('src/wibble')
74
72
    '2325'
75
73
    >>> '2325' in i
76
74
    True
77
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
 
75
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
78
76
    >>> i['2326']
79
77
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
78
    >>> for j in i.iter_entries():
89
87
    >>> i.id2path('2326')
90
88
    'src/wibble/wibble.c'
91
89
 
92
 
    :todo: Maybe also keep the full path of the entry, and the children?
 
90
    TODO: Maybe also keep the full path of the entry, and the children?
93
91
           But those depend on its position within a particular inventory, and
94
92
           it would be nice not to need to hold the backpointer here.
95
93
    """
96
 
    def __init__(self, file_id, name, kind='file', text_id=None,
97
 
                 parent_id=None):
 
94
 
 
95
    # TODO: split InventoryEntry into subclasses for files,
 
96
    # directories, etc etc.
 
97
 
 
98
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
99
                 'text_id', 'parent_id', 'children', ]
 
100
 
 
101
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
98
102
        """Create an InventoryEntry
99
103
        
100
104
        The filename must be a single component, relative to the
101
105
        parent directory; it cannot be a whole path or relative name.
102
106
 
103
 
        >>> e = InventoryEntry('123', 'hello.c')
 
107
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
104
108
        >>> e.name
105
109
        'hello.c'
106
110
        >>> e.file_id
107
111
        '123'
108
 
        >>> e = InventoryEntry('123', 'src/hello.c')
 
112
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
109
113
        Traceback (most recent call last):
110
 
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
 
114
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
111
115
        """
112
 
        
113
 
        if len(splitpath(name)) != 1:
114
 
            bailout('InventoryEntry name is not a simple filename: %r'
115
 
                    % name)
116
 
        
 
116
        if '/' in name or '\\' in name:
 
117
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
118
        
 
119
        self.text_sha1 = None
 
120
        self.text_size = None
 
121
    
117
122
        self.file_id = file_id
118
123
        self.name = name
119
 
        assert kind in ['file', 'directory']
120
124
        self.kind = kind
121
125
        self.text_id = text_id
122
126
        self.parent_id = parent_id
123
 
        self.text_sha1 = None
124
 
        self.text_size = None
 
127
        if kind == 'directory':
 
128
            self.children = {}
 
129
        elif kind == 'file':
 
130
            pass
 
131
        else:
 
132
            raise BzrError("unhandled entry kind %r" % kind)
 
133
 
 
134
 
 
135
 
 
136
    def sorted_children(self):
 
137
        l = self.children.items()
 
138
        l.sort()
 
139
        return l
125
140
 
126
141
 
127
142
    def copy(self):
128
143
        other = InventoryEntry(self.file_id, self.name, self.kind,
129
 
                               self.text_id, self.parent_id)
 
144
                               self.parent_id, text_id=self.text_id)
130
145
        other.text_sha1 = self.text_sha1
131
146
        other.text_size = self.text_size
 
147
        # note that children are *not* copied; they're pulled across when
 
148
        # others are added
132
149
        return other
133
150
 
134
151
 
143
160
    
144
161
    def to_element(self):
145
162
        """Convert to XML element"""
 
163
        from bzrlib.xml import Element
 
164
        
146
165
        e = Element('entry')
147
166
 
148
167
        e.set('name', self.name)
149
168
        e.set('file_id', self.file_id)
150
169
        e.set('kind', self.kind)
151
170
 
152
 
        if self.text_size is not None:
 
171
        if self.text_size != None:
153
172
            e.set('text_size', '%d' % self.text_size)
154
173
            
155
 
        for f in ['text_id', 'text_sha1', 'parent_id']:
 
174
        for f in ['text_id', 'text_sha1']:
156
175
            v = getattr(self, f)
157
 
            if v is not None:
 
176
            if v != None:
158
177
                e.set(f, v)
159
178
 
 
179
        # to be conservative, we don't externalize the root pointers
 
180
        # for now, leaving them as null in the xml form.  in a future
 
181
        # version it will be implied by nested elements.
 
182
        if self.parent_id != ROOT_ID:
 
183
            assert isinstance(self.parent_id, basestring)
 
184
            e.set('parent_id', self.parent_id)
 
185
 
160
186
        e.tail = '\n'
161
187
            
162
188
        return e
164
190
 
165
191
    def from_element(cls, elt):
166
192
        assert elt.tag == 'entry'
167
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
 
193
 
 
194
        ## original format inventories don't have a parent_id for
 
195
        ## nodes in the root directory, but it's cleaner to use one
 
196
        ## internally.
 
197
        parent_id = elt.get('parent_id')
 
198
        if parent_id == None:
 
199
            parent_id = ROOT_ID
 
200
 
 
201
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
168
202
        self.text_id = elt.get('text_id')
169
203
        self.text_sha1 = elt.get('text_sha1')
170
 
        self.parent_id = elt.get('parent_id')
171
204
        
172
205
        ## mutter("read inventoryentry: %r" % (elt.attrib))
173
206
 
179
212
 
180
213
    from_element = classmethod(from_element)
181
214
 
182
 
    def __cmp__(self, other):
183
 
        if self is other:
184
 
            return 0
 
215
    def __eq__(self, other):
185
216
        if not isinstance(other, InventoryEntry):
186
217
            return NotImplemented
187
218
 
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):
 
219
        return (self.file_id == other.file_id) \
 
220
               and (self.name == other.name) \
 
221
               and (self.text_sha1 == other.text_sha1) \
 
222
               and (self.text_size == other.text_size) \
 
223
               and (self.text_id == other.text_id) \
 
224
               and (self.parent_id == other.parent_id) \
 
225
               and (self.kind == other.kind)
 
226
 
 
227
 
 
228
    def __ne__(self, other):
 
229
        return not (self == other)
 
230
 
 
231
    def __hash__(self):
 
232
        raise ValueError('not hashable')
 
233
 
 
234
 
 
235
 
 
236
class RootEntry(InventoryEntry):
 
237
    def __init__(self, file_id):
 
238
        self.file_id = file_id
 
239
        self.children = {}
 
240
        self.kind = 'root_directory'
 
241
        self.parent_id = None
 
242
        self.name = ''
 
243
 
 
244
    def __eq__(self, other):
 
245
        if not isinstance(other, RootEntry):
 
246
            return NotImplemented
 
247
        
 
248
        return (self.file_id == other.file_id) \
 
249
               and (self.children == other.children)
 
250
 
 
251
 
 
252
 
 
253
class Inventory(object):
199
254
    """Inventory of versioned files in a tree.
200
255
 
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.
 
256
    This describes which file_id is present at each point in the tree,
 
257
    and possibly the SHA-1 or other information about the file.
 
258
    Entries can be looked up either by path or by file_id.
207
259
 
208
260
    The inventory represents a typical unix file tree, with
209
261
    directories containing files and subdirectories.  We never store
213
265
    returned quickly.
214
266
 
215
267
    InventoryEntry objects must not be modified after they are
216
 
    inserted.
 
268
    inserted, other than through the Inventory API.
217
269
 
218
270
    >>> inv = Inventory()
219
 
    >>> inv.write_xml(sys.stdout)
220
 
    <inventory>
221
 
    </inventory>
222
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c'))
 
271
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
223
272
    >>> inv['123-123'].name
224
273
    'hello.c'
225
 
    >>> for file_id in inv: print file_id
226
 
    ...
227
 
    123-123
228
274
 
229
275
    May be treated as an iterator or set to look up file ids:
230
276
    
237
283
 
238
284
    >>> [x[0] for x in inv.iter_entries()]
239
285
    ['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
 
 
 
286
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
287
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
246
288
    """
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):
 
289
    def __init__(self, root_id=ROOT_ID):
262
290
        """Create or read an inventory.
263
291
 
264
292
        If a working directory is specified, the inventory is read
265
293
        from there.  If the file is specified, read from that. If not,
266
294
        the inventory is created empty.
 
295
 
 
296
        The inventory is created with a default root directory, with
 
297
        an id of None.
267
298
        """
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: {}}
 
299
        # We are letting Branch(init=True) create a unique inventory
 
300
        # root id. Rather than generating a random one here.
 
301
        #if root_id is None:
 
302
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
303
        self.root = RootEntry(root_id)
 
304
        self._byid = {self.root.file_id: self.root}
273
305
 
274
306
 
275
307
    def __iter__(self):
281
313
        return len(self._byid)
282
314
 
283
315
 
284
 
    def iter_entries(self, parent_id=None):
 
316
    def iter_entries(self, from_dir=None):
285
317
        """Return (path, entry) pairs, in order by name."""
286
 
        kids = self._tree[parent_id].items()
 
318
        if from_dir == None:
 
319
            assert self.root
 
320
            from_dir = self.root
 
321
        elif isinstance(from_dir, basestring):
 
322
            from_dir = self._byid[from_dir]
 
323
            
 
324
        kids = from_dir.children.items()
287
325
        kids.sort()
288
326
        for name, ie in kids:
289
327
            yield name, ie
290
328
            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
 
329
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
330
                    yield os.path.join(name, cn), cie
 
331
 
 
332
 
 
333
    def entries(self):
 
334
        """Return list of (path, ie) for all entries except the root.
 
335
 
 
336
        This may be faster than iter_entries.
 
337
        """
 
338
        accum = []
 
339
        def descend(dir_ie, dir_path):
 
340
            kids = dir_ie.children.items()
 
341
            kids.sort()
 
342
            for name, ie in kids:
 
343
                child_path = os.path.join(dir_path, name)
 
344
                accum.append((child_path, ie))
 
345
                if ie.kind == 'directory':
 
346
                    descend(ie, child_path)
 
347
 
 
348
        descend(self.root, '')
 
349
        return accum
 
350
 
 
351
 
 
352
    def directories(self):
 
353
        """Return (path, entry) pairs for all directories, including the root.
 
354
        """
 
355
        accum = []
 
356
        def descend(parent_ie, parent_path):
 
357
            accum.append((parent_path, parent_ie))
 
358
            
 
359
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
360
            kids.sort()
 
361
 
 
362
            for name, child_ie in kids:
 
363
                child_path = os.path.join(parent_path, name)
 
364
                descend(child_ie, child_path)
 
365
        descend(self.root, '')
 
366
        return accum
303
367
        
304
368
 
305
369
 
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
370
    def __contains__(self, file_id):
316
371
        """True if this entry contains a file with given id.
317
372
 
318
373
        >>> inv = Inventory()
319
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
374
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
320
375
        >>> '123' in inv
321
376
        True
322
377
        >>> '456' in inv
329
384
        """Return the entry for given file_id.
330
385
 
331
386
        >>> inv = Inventory()
332
 
        >>> inv.add(InventoryEntry('123123', 'hello.c'))
 
387
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
333
388
        >>> inv['123123'].name
334
389
        'hello.c'
335
390
        """
336
 
        return self._byid[file_id]
 
391
        try:
 
392
            return self._byid[file_id]
 
393
        except KeyError:
 
394
            if file_id == None:
 
395
                raise BzrError("can't look up file_id None")
 
396
            else:
 
397
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
398
 
 
399
 
 
400
    def get_file_kind(self, file_id):
 
401
        return self._byid[file_id].kind
 
402
 
 
403
    def get_child(self, parent_id, filename):
 
404
        return self[parent_id].children.get(filename)
337
405
 
338
406
 
339
407
    def add(self, entry):
341
409
 
342
410
        To add  a file to a branch ready to be committed, use Branch.add,
343
411
        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))
 
412
        if entry.file_id in self._byid:
 
413
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
414
 
 
415
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
416
            entry.parent_id = self.root.file_id
 
417
 
 
418
        try:
 
419
            parent = self._byid[entry.parent_id]
 
420
        except KeyError:
 
421
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
422
 
 
423
        if parent.children.has_key(entry.name):
 
424
            raise BzrError("%s is already versioned" %
 
425
                    appendpath(self.id2path(parent.file_id), entry.name))
355
426
 
356
427
        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] = {}
 
428
        parent.children[entry.name] = entry
 
429
 
 
430
 
 
431
    def add_path(self, relpath, kind, file_id=None):
 
432
        """Add entry from a path.
 
433
 
 
434
        The immediate parent must already be versioned"""
 
435
        parts = bzrlib.osutils.splitpath(relpath)
 
436
        if len(parts) == 0:
 
437
            raise BzrError("cannot re-add root of inventory")
 
438
 
 
439
        if file_id == None:
 
440
            file_id = gen_file_id(relpath)
 
441
 
 
442
        parent_path = parts[:-1]
 
443
        parent_id = self.path2id(parent_path)
 
444
        if parent_id == None:
 
445
            raise NotVersionedError(parent_path)
 
446
 
 
447
        ie = InventoryEntry(file_id, parts[-1],
 
448
                            kind=kind, parent_id=parent_id)
 
449
        return self.add(ie)
361
450
 
362
451
 
363
452
    def __delitem__(self, file_id):
364
453
        """Remove entry by id.
365
454
 
366
455
        >>> inv = Inventory()
367
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
456
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
368
457
        >>> '123' in inv
369
458
        True
370
459
        >>> del inv['123']
373
462
        """
374
463
        ie = self[file_id]
375
464
 
376
 
        assert self._tree[ie.parent_id][ie.name] == ie
 
465
        assert self[ie.parent_id].children[ie.name] == ie
377
466
        
378
467
        # TODO: Test deleting all children; maybe hoist to a separate
379
468
        # deltree method?
380
469
        if ie.kind == 'directory':
381
 
            for cie in self._tree[file_id].values():
 
470
            for cie in ie.children.values():
382
471
                del self[cie.file_id]
383
 
            del self._tree[file_id]
 
472
            del ie.children
384
473
 
385
474
        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)
 
475
        del self[ie.parent_id].children[ie.name]
391
476
 
392
477
 
393
478
    def to_element(self):
394
479
        """Convert to XML Element"""
 
480
        from bzrlib.xml import Element
 
481
        
395
482
        e = Element('inventory')
396
483
        e.text = '\n'
 
484
        if self.root.file_id not in (None, ROOT_ID):
 
485
            e.set('file_id', self.root.file_id)
397
486
        for path, ie in self.iter_entries():
398
487
            e.append(ie.to_element())
399
488
        return e
401
490
 
402
491
    def from_element(cls, elt):
403
492
        """Construct from XML Element
404
 
 
 
493
        
405
494
        >>> inv = Inventory()
406
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
 
495
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
407
496
        >>> elt = inv.to_element()
408
497
        >>> inv2 = Inventory.from_element(elt)
409
498
        >>> inv2 == inv
410
499
        True
411
500
        """
 
501
        # XXXX: doctest doesn't run this properly under python2.3
412
502
        assert elt.tag == 'inventory'
413
 
        o = cls()
 
503
        root_id = elt.get('file_id') or ROOT_ID
 
504
        o = cls(root_id)
414
505
        for e in elt:
415
 
            o.add(InventoryEntry.from_element(e))
 
506
            ie = InventoryEntry.from_element(e)
 
507
            if ie.parent_id == ROOT_ID:
 
508
                ie.parent_id = root_id
 
509
            o.add(ie)
416
510
        return o
417
511
        
418
512
    from_element = classmethod(from_element)
419
513
 
420
514
 
421
 
    def __cmp__(self, other):
 
515
    def __eq__(self, other):
422
516
        """Compare two sets by comparing their contents.
423
517
 
424
518
        >>> i1 = Inventory()
425
519
        >>> i2 = Inventory()
426
520
        >>> i1 == i2
427
521
        True
428
 
        >>> i1.add(InventoryEntry('123', 'foo'))
 
522
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
429
523
        >>> i1 == i2
430
524
        False
431
 
        >>> i2.add(InventoryEntry('123', 'foo'))
 
525
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
432
526
        >>> i1 == i2
433
527
        True
434
528
        """
435
 
        if self is other:
436
 
            return 0
437
 
        
438
529
        if not isinstance(other, Inventory):
439
530
            return NotImplemented
440
531
 
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."""
 
532
        if len(self._byid) != len(other._byid):
 
533
            # shortcut: obviously not the same
 
534
            return False
 
535
 
 
536
        return self._byid == other._byid
 
537
 
 
538
 
 
539
    def __ne__(self, other):
 
540
        return not (self == other)
 
541
 
 
542
 
 
543
    def __hash__(self):
 
544
        raise ValueError('not hashable')
 
545
 
 
546
 
 
547
 
 
548
    def get_idpath(self, file_id):
 
549
        """Return a list of file_ids for the path to an entry.
 
550
 
 
551
        The list contains one element for each directory followed by
 
552
        the id of the file itself.  So the length of the returned list
 
553
        is equal to the depth of the file in the tree, counting the
 
554
        root directory as depth 1.
 
555
        """
453
556
        p = []
454
557
        while file_id != None:
455
 
            ie = self[file_id]
456
 
            p = [ie.name] + p
 
558
            try:
 
559
                ie = self._byid[file_id]
 
560
            except KeyError:
 
561
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
562
            p.insert(0, ie.file_id)
457
563
            file_id = ie.parent_id
458
 
        return joinpath(p)
 
564
        return p
 
565
 
 
566
 
 
567
    def id2path(self, file_id):
 
568
        """Return as a list the path to file_id."""
 
569
 
 
570
        # get all names, skipping root
 
571
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
572
        return os.sep.join(p)
459
573
            
460
574
 
461
575
 
467
581
 
468
582
        This returns the entry of the last component in the path,
469
583
        which may be either a file or a directory.
 
584
 
 
585
        Returns None iff the path is not found.
470
586
        """
471
 
        assert isinstance(name, types.StringTypes)
472
 
 
473
 
        parent_id = None
474
 
        for f in splitpath(name):
 
587
        if isinstance(name, types.StringTypes):
 
588
            name = splitpath(name)
 
589
 
 
590
        mutter("lookup path %r" % name)
 
591
 
 
592
        parent = self.root
 
593
        for f in name:
475
594
            try:
476
 
                cie = self._tree[parent_id][f]
 
595
                cie = parent.children[f]
477
596
                assert cie.name == f
478
 
                parent_id = cie.file_id
 
597
                assert cie.parent_id == parent.file_id
 
598
                parent = cie
479
599
            except KeyError:
480
600
                # or raise an error?
481
601
                return None
482
602
 
483
 
        return parent_id
484
 
 
485
 
 
486
 
    def get_child(self, parent_id, child_name):
487
 
        return self._tree[parent_id].get(child_name)
 
603
        return parent.file_id
488
604
 
489
605
 
490
606
    def has_filename(self, names):
492
608
 
493
609
 
494
610
    def has_id(self, file_id):
495
 
        assert isinstance(file_id, str)
496
611
        return self._byid.has_key(file_id)
497
612
 
498
613
 
499
 
 
500
 
if __name__ == '__main__':
501
 
    import doctest, inventory
502
 
    doctest.testmod(inventory)
 
614
    def rename(self, file_id, new_parent_id, new_name):
 
615
        """Move a file within the inventory.
 
616
 
 
617
        This can change either the name, or the parent, or both.
 
618
 
 
619
        This does not move the working file."""
 
620
        if not is_valid_name(new_name):
 
621
            raise BzrError("not an acceptable filename: %r" % new_name)
 
622
 
 
623
        new_parent = self._byid[new_parent_id]
 
624
        if new_name in new_parent.children:
 
625
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
626
 
 
627
        new_parent_idpath = self.get_idpath(new_parent_id)
 
628
        if file_id in new_parent_idpath:
 
629
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
630
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
 
631
 
 
632
        file_ie = self._byid[file_id]
 
633
        old_parent = self._byid[file_ie.parent_id]
 
634
 
 
635
        # TODO: Don't leave things messed up if this fails
 
636
 
 
637
        del old_parent.children[file_ie.name]
 
638
        new_parent.children[new_name] = file_ie
 
639
        
 
640
        file_ie.name = new_name
 
641
        file_ie.parent_id = new_parent_id
 
642
 
 
643
 
 
644
 
 
645
 
 
646
_NAME_RE = re.compile(r'^[^/\\]+$')
 
647
 
 
648
def is_valid_name(name):
 
649
    return bool(_NAME_RE.match(name))