~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-07-04 08:06:51 UTC
  • Revision ID: mbp@sourcefrog.net-20050704080651-6ecec49164359e48
- track pending-merges

- unit tests for this

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