~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-09-01 02:34:38 UTC
  • Revision ID: mbp@sourcefrog.net-20050901023437-bf791a0ef5edae8d
- old docs: clarify that this is not mainly descended from arch anymore

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