~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-08-29 07:13:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050829071309-2c62f851915b9825
- bzr log --show-ids includes parent ids

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