~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: mbp at sourcefrog
  • Date: 2005-03-28 04:08:13 UTC
  • Revision ID: mbp@sourcefrog.net-20050328040812-f6852e38fba0ad5f
- reactivate basic check command

Show diffs side-by-side

added added

removed removed

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