~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-09 06:49:00 UTC
  • Revision ID: mbp@sourcefrog.net-20050309064900-74935ffb7350b24b
import more files from baz

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
24
 
 
25
 
import bzrlib
26
 
from bzrlib.errors import BzrError, BzrCheckError
27
 
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
29
 
from bzrlib.trace import mutter
30
 
from bzrlib.errors import NotVersionedError
31
 
        
32
 
 
33
 
class InventoryEntry(object):
 
18
"""Inventories map files to their name in a revision."""
 
19
 
 
20
 
 
21
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
 
22
__author__ = "Martin Pool <mbp@canonical.com>"
 
23
 
 
24
import sys, os.path, types
 
25
from sets import Set
 
26
 
 
27
try:
 
28
    from cElementTree import Element, ElementTree, SubElement
 
29
except ImportError:
 
30
    from elementtree import Element, ElementTree, SubElement
 
31
 
 
32
from xml import XMLMixin
 
33
from errors import bailout
 
34
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
35
from trace import mutter
 
36
 
 
37
class InventoryEntry(XMLMixin):
34
38
    """Description of a versioned file.
35
39
 
36
40
    An InventoryEntry has the following fields, which are also
53
57
 
54
58
    >>> i = Inventory()
55
59
    >>> i.path2id('')
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')
 
60
    >>> i.add(InventoryEntry('123', 'src', kind='directory'))
 
61
    >>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
61
62
    >>> for j in i.iter_entries():
62
63
    ...   print j
63
64
    ... 
64
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
65
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
65
66
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
66
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
67
    >>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
67
68
    Traceback (most recent call last):
68
69
    ...
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')
 
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'))
74
73
    >>> i.path2id('src/wibble')
75
74
    '2325'
76
75
    >>> '2325' in i
77
76
    True
78
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
77
    >>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
80
78
    >>> i['2326']
81
79
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
80
    >>> for j in i.iter_entries():
91
89
    >>> i.id2path('2326')
92
90
    'src/wibble/wibble.c'
93
91
 
94
 
    TODO: Maybe also keep the full path of the entry, and the children?
 
92
    :todo: Maybe also keep the full path of the entry, and the children?
95
93
           But those depend on its position within a particular inventory, and
96
94
           it would be nice not to need to hold the backpointer here.
97
95
    """
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):
 
96
    def __init__(self, file_id, name, kind='file', text_id=None,
 
97
                 parent_id=None):
106
98
        """Create an InventoryEntry
107
99
        
108
100
        The filename must be a single component, relative to the
109
101
        parent directory; it cannot be a whole path or relative name.
110
102
 
111
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
103
        >>> e = InventoryEntry('123', 'hello.c')
112
104
        >>> e.name
113
105
        'hello.c'
114
106
        >>> e.file_id
115
107
        '123'
116
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
108
        >>> e = InventoryEntry('123', 'src/hello.c')
117
109
        Traceback (most recent call last):
118
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
110
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
119
111
        """
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
 
    
 
112
        
 
113
        if len(splitpath(name)) != 1:
 
114
            bailout('InventoryEntry name is not a simple filename: %r'
 
115
                    % name)
 
116
        
126
117
        self.file_id = file_id
127
118
        self.name = name
 
119
        assert kind in ['file', 'directory']
128
120
        self.kind = kind
129
121
        self.text_id = text_id
130
122
        self.parent_id = parent_id
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
 
123
        self.text_sha1 = None
 
124
        self.text_size = None
144
125
 
145
126
 
146
127
    def copy(self):
147
128
        other = InventoryEntry(self.file_id, self.name, self.kind,
148
 
                               self.parent_id, text_id=self.text_id)
 
129
                               self.text_id, self.parent_id)
149
130
        other.text_sha1 = self.text_sha1
150
131
        other.text_size = self.text_size
151
 
        # note that children are *not* copied; they're pulled across when
152
 
        # others are added
153
132
        return other
154
133
 
155
134
 
164
143
    
165
144
    def to_element(self):
166
145
        """Convert to XML element"""
167
 
        from bzrlib.xml import Element
168
 
        
169
146
        e = Element('entry')
170
147
 
171
148
        e.set('name', self.name)
172
149
        e.set('file_id', self.file_id)
173
150
        e.set('kind', self.kind)
174
151
 
175
 
        if self.text_size != None:
 
152
        if self.text_size is not None:
176
153
            e.set('text_size', '%d' % self.text_size)
177
154
            
178
 
        for f in ['text_id', 'text_sha1']:
 
155
        for f in ['text_id', 'text_sha1', 'parent_id']:
179
156
            v = getattr(self, f)
180
 
            if v != None:
 
157
            if v is not None:
181
158
                e.set(f, v)
182
159
 
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
 
 
190
160
        e.tail = '\n'
191
161
            
192
162
        return e
194
164
 
195
165
    def from_element(cls, elt):
196
166
        assert elt.tag == 'entry'
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)
 
167
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
206
168
        self.text_id = elt.get('text_id')
207
169
        self.text_sha1 = elt.get('text_sha1')
 
170
        self.parent_id = elt.get('parent_id')
208
171
        
209
172
        ## mutter("read inventoryentry: %r" % (elt.attrib))
210
173
 
216
179
 
217
180
    from_element = classmethod(from_element)
218
181
 
219
 
    def __eq__(self, other):
 
182
    def __cmp__(self, other):
 
183
        if self is other:
 
184
            return 0
220
185
        if not isinstance(other, InventoryEntry):
221
186
            return NotImplemented
222
187
 
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):
 
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):
258
199
    """Inventory of versioned files in a tree.
259
200
 
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.
 
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.
263
207
 
264
208
    The inventory represents a typical unix file tree, with
265
209
    directories containing files and subdirectories.  We never store
269
213
    returned quickly.
270
214
 
271
215
    InventoryEntry objects must not be modified after they are
272
 
    inserted, other than through the Inventory API.
 
216
    inserted.
273
217
 
274
218
    >>> inv = Inventory()
275
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
276
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
219
    >>> inv.write_xml(sys.stdout)
 
220
    <inventory>
 
221
    </inventory>
 
222
    >>> inv.add(InventoryEntry('123-123', 'hello.c'))
277
223
    >>> inv['123-123'].name
278
224
    'hello.c'
 
225
    >>> for file_id in inv: print file_id
 
226
    ...
 
227
    123-123
279
228
 
280
229
    May be treated as an iterator or set to look up file ids:
281
230
    
288
237
 
289
238
    >>> [x[0] for x in inv.iter_entries()]
290
239
    ['hello.c']
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')
 
240
    
 
241
    >>> inv.write_xml(sys.stdout)
 
242
    <inventory>
 
243
    <entry file_id="123-123" kind="file" name="hello.c" />
 
244
    </inventory>
 
245
 
294
246
    """
295
 
    def __init__(self, root_id=ROOT_ID):
 
247
 
 
248
    ## TODO: Clear up handling of files in subdirectories; we probably
 
249
    ## do want to be able to just look them up by name but this
 
250
    ## probably means gradually walking down the path, looking up as we go.
 
251
 
 
252
    ## TODO: Make sure only canonical filenames are stored.
 
253
 
 
254
    ## TODO: Do something sensible about the possible collisions on
 
255
    ## case-losing filesystems.  Perhaps we should just always forbid
 
256
    ## such collisions.
 
257
 
 
258
    ## _tree should probably just be stored as
 
259
    ## InventoryEntry._children on each directory.
 
260
 
 
261
    def __init__(self):
296
262
        """Create or read an inventory.
297
263
 
298
264
        If a working directory is specified, the inventory is read
299
265
        from there.  If the file is specified, read from that. If not,
300
266
        the inventory is created empty.
301
 
 
302
 
        The inventory is created with a default root directory, with
303
 
        an id of None.
304
267
        """
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}
 
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: {}}
311
273
 
312
274
 
313
275
    def __iter__(self):
319
281
        return len(self._byid)
320
282
 
321
283
 
322
 
    def iter_entries(self, from_dir=None):
 
284
    def iter_entries(self, parent_id=None):
323
285
        """Return (path, entry) pairs, in order by name."""
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()
 
286
        kids = self._tree[parent_id].items()
331
287
        kids.sort()
332
288
        for name, ie in kids:
333
289
            yield name, ie
334
290
            if ie.kind == 'directory':
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
 
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
373
303
        
374
304
 
375
305
 
 
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
 
376
315
    def __contains__(self, file_id):
377
316
        """True if this entry contains a file with given id.
378
317
 
379
318
        >>> inv = Inventory()
380
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
381
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
319
        >>> inv.add(InventoryEntry('123', 'foo.c'))
382
320
        >>> '123' in inv
383
321
        True
384
322
        >>> '456' in inv
391
329
        """Return the entry for given file_id.
392
330
 
393
331
        >>> inv = Inventory()
394
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
395
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
332
        >>> inv.add(InventoryEntry('123123', 'hello.c'))
396
333
        >>> inv['123123'].name
397
334
        'hello.c'
398
335
        """
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)
 
336
        return self._byid[file_id]
413
337
 
414
338
 
415
339
    def add(self, entry):
417
341
 
418
342
        To add  a file to a branch ready to be committed, use Branch.add,
419
343
        which calls this."""
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))
 
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))
434
355
 
435
356
        self._byid[entry.file_id] = entry
436
 
        parent.children[entry.name] = entry
437
 
        return entry
438
 
 
439
 
 
440
 
    def add_path(self, relpath, kind, file_id=None):
441
 
        """Add entry from a path.
442
 
 
443
 
        The immediate parent must already be versioned"""
444
 
        from bzrlib.branch import gen_file_id
445
 
        
446
 
        parts = bzrlib.osutils.splitpath(relpath)
447
 
        if len(parts) == 0:
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
 
 
458
 
        ie = InventoryEntry(file_id, parts[-1],
459
 
                            kind=kind, parent_id=parent_id)
460
 
        return self.add(ie)
 
357
        self._tree[entry.parent_id][entry.name] = entry
 
358
 
 
359
        if entry.kind == 'directory':
 
360
            self._tree[entry.file_id] = {}
461
361
 
462
362
 
463
363
    def __delitem__(self, file_id):
464
364
        """Remove entry by id.
465
365
 
466
366
        >>> inv = Inventory()
467
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
468
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
367
        >>> inv.add(InventoryEntry('123', 'foo.c'))
469
368
        >>> '123' in inv
470
369
        True
471
370
        >>> del inv['123']
474
373
        """
475
374
        ie = self[file_id]
476
375
 
477
 
        assert self[ie.parent_id].children[ie.name] == ie
 
376
        assert self._tree[ie.parent_id][ie.name] == ie
478
377
        
479
378
        # TODO: Test deleting all children; maybe hoist to a separate
480
379
        # deltree method?
481
380
        if ie.kind == 'directory':
482
 
            for cie in ie.children.values():
 
381
            for cie in self._tree[file_id].values():
483
382
                del self[cie.file_id]
484
 
            del ie.children
 
383
            del self._tree[file_id]
485
384
 
486
385
        del self._byid[file_id]
487
 
        del self[ie.parent_id].children[ie.name]
 
386
        del self._tree[ie.parent_id][ie.name]
 
387
 
 
388
 
 
389
    def id_set(self):
 
390
        return Set(self._byid)
488
391
 
489
392
 
490
393
    def to_element(self):
491
394
        """Convert to XML Element"""
492
 
        from bzrlib.xml import Element
493
 
        
494
395
        e = Element('inventory')
495
396
        e.text = '\n'
496
 
        if self.root.file_id not in (None, ROOT_ID):
497
 
            e.set('file_id', self.root.file_id)
498
397
        for path, ie in self.iter_entries():
499
398
            e.append(ie.to_element())
500
399
        return e
502
401
 
503
402
    def from_element(cls, elt):
504
403
        """Construct from XML Element
505
 
        
 
404
 
506
405
        >>> inv = Inventory()
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')
 
406
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
509
407
        >>> elt = inv.to_element()
510
408
        >>> inv2 = Inventory.from_element(elt)
511
409
        >>> inv2 == inv
512
410
        True
513
411
        """
514
 
        # XXXX: doctest doesn't run this properly under python2.3
515
412
        assert elt.tag == 'inventory'
516
 
        root_id = elt.get('file_id') or ROOT_ID
517
 
        o = cls(root_id)
 
413
        o = cls()
518
414
        for e in elt:
519
 
            ie = InventoryEntry.from_element(e)
520
 
            if ie.parent_id == ROOT_ID:
521
 
                ie.parent_id = root_id
522
 
            o.add(ie)
 
415
            o.add(InventoryEntry.from_element(e))
523
416
        return o
524
417
        
525
418
    from_element = classmethod(from_element)
526
419
 
527
420
 
528
 
    def __eq__(self, other):
 
421
    def __cmp__(self, other):
529
422
        """Compare two sets by comparing their contents.
530
423
 
531
424
        >>> i1 = Inventory()
532
425
        >>> i2 = Inventory()
533
426
        >>> i1 == i2
534
427
        True
535
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
536
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
428
        >>> i1.add(InventoryEntry('123', 'foo'))
537
429
        >>> i1 == i2
538
430
        False
539
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
540
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
431
        >>> i2.add(InventoryEntry('123', 'foo'))
541
432
        >>> i1 == i2
542
433
        True
543
434
        """
 
435
        if self is other:
 
436
            return 0
 
437
        
544
438
        if not isinstance(other, Inventory):
545
439
            return NotImplemented
546
440
 
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
 
        """
 
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."""
571
453
        p = []
572
454
        while file_id != None:
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)
 
455
            ie = self[file_id]
 
456
            p = [ie.name] + p
578
457
            file_id = ie.parent_id
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)
 
458
        return joinpath(p)
588
459
            
589
460
 
590
461
 
596
467
 
597
468
        This returns the entry of the last component in the path,
598
469
        which may be either a file or a directory.
599
 
 
600
 
        Returns None iff the path is not found.
601
470
        """
602
 
        if isinstance(name, types.StringTypes):
603
 
            name = splitpath(name)
604
 
 
605
 
        mutter("lookup path %r" % name)
606
 
 
607
 
        parent = self.root
608
 
        for f in name:
 
471
        assert isinstance(name, types.StringTypes)
 
472
 
 
473
        parent_id = None
 
474
        for f in splitpath(name):
609
475
            try:
610
 
                cie = parent.children[f]
 
476
                cie = self._tree[parent_id][f]
611
477
                assert cie.name == f
612
 
                assert cie.parent_id == parent.file_id
613
 
                parent = cie
 
478
                parent_id = cie.file_id
614
479
            except KeyError:
615
480
                # or raise an error?
616
481
                return None
617
482
 
618
 
        return parent.file_id
 
483
        return parent_id
 
484
 
 
485
 
 
486
    def get_child(self, parent_id, child_name):
 
487
        return self._tree[parent_id].get(child_name)
619
488
 
620
489
 
621
490
    def has_filename(self, names):
623
492
 
624
493
 
625
494
    def has_id(self, file_id):
 
495
        assert isinstance(file_id, str)
626
496
        return self._byid.has_key(file_id)
627
497
 
628
498
 
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))
 
499
 
 
500
if __name__ == '__main__':
 
501
    import doctest, inventory
 
502
    doctest.testmod(inventory)