~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 04:08:15 UTC
  • Revision ID: mbp@sourcefrog.net-20050309040815-13242001617e4a06
import from baz patch-364

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
 
 
31
 
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
from xml import XMLMixin
 
28
from ElementTree import ElementTree, Element
 
29
from errors import bailout
 
30
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
31
from trace import mutter
 
32
 
 
33
class InventoryEntry(XMLMixin):
32
34
    """Description of a versioned file.
33
35
 
34
36
    An InventoryEntry has the following fields, which are also
51
53
 
52
54
    >>> i = Inventory()
53
55
    >>> 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'))
 
56
    >>> i.add(InventoryEntry('123', 'src', kind='directory'))
 
57
    >>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
57
58
    >>> for j in i.iter_entries():
58
59
    ...   print j
59
60
    ... 
60
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
61
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
61
62
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
62
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
63
    >>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
63
64
    Traceback (most recent call last):
64
65
    ...
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'))
 
66
    BzrError: ('inventory already contains entry with id {2323}', [])
 
67
    >>> i.add(InventoryEntry('2324', 'bye.c', parent_id='123'))
 
68
    >>> i.add(InventoryEntry('2325', 'wibble', parent_id='123', kind='directory'))
68
69
    >>> i.path2id('src/wibble')
69
70
    '2325'
70
71
    >>> '2325' in i
71
72
    True
72
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
73
    >>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
73
74
    >>> i['2326']
74
75
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
75
76
    >>> for j in i.iter_entries():
84
85
    >>> i.id2path('2326')
85
86
    'src/wibble/wibble.c'
86
87
 
87
 
    TODO: Maybe also keep the full path of the entry, and the children?
 
88
    :todo: Maybe also keep the full path of the entry, and the children?
88
89
           But those depend on its position within a particular inventory, and
89
90
           it would be nice not to need to hold the backpointer here.
90
91
    """
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):
 
92
    def __init__(self, file_id, name, kind='file', text_id=None,
 
93
                 parent_id=None):
99
94
        """Create an InventoryEntry
100
95
        
101
96
        The filename must be a single component, relative to the
102
97
        parent directory; it cannot be a whole path or relative name.
103
98
 
104
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
99
        >>> e = InventoryEntry('123', 'hello.c')
105
100
        >>> e.name
106
101
        'hello.c'
107
102
        >>> e.file_id
108
103
        '123'
109
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
104
        >>> e = InventoryEntry('123', 'src/hello.c')
110
105
        Traceback (most recent call last):
111
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
106
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
112
107
        """
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
 
    
 
108
        
 
109
        if len(splitpath(name)) != 1:
 
110
            bailout('InventoryEntry name is not a simple filename: %r'
 
111
                    % name)
 
112
        
119
113
        self.file_id = file_id
120
114
        self.name = name
 
115
        assert kind in ['file', 'directory']
121
116
        self.kind = kind
122
117
        self.text_id = text_id
123
118
        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
 
119
        self.text_sha1 = None
 
120
        self.text_size = None
137
121
 
138
122
 
139
123
    def copy(self):
140
124
        other = InventoryEntry(self.file_id, self.name, self.kind,
141
 
                               self.parent_id, text_id=self.text_id)
 
125
                               self.text_id, self.parent_id)
142
126
        other.text_sha1 = self.text_sha1
143
127
        other.text_size = self.text_size
144
 
        # note that children are *not* copied; they're pulled across when
145
 
        # others are added
146
128
        return other
147
129
 
148
130
 
157
139
    
158
140
    def to_element(self):
159
141
        """Convert to XML element"""
160
 
        from bzrlib.xml import Element
161
 
        
162
142
        e = Element('entry')
163
143
 
164
144
        e.set('name', self.name)
165
145
        e.set('file_id', self.file_id)
166
146
        e.set('kind', self.kind)
167
147
 
168
 
        if self.text_size != None:
 
148
        if self.text_size is not None:
169
149
            e.set('text_size', '%d' % self.text_size)
170
150
            
171
 
        for f in ['text_id', 'text_sha1']:
 
151
        for f in ['text_id', 'text_sha1', 'parent_id']:
172
152
            v = getattr(self, f)
173
 
            if v != None:
 
153
            if v is not None:
174
154
                e.set(f, v)
175
155
 
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
156
        e.tail = '\n'
184
157
            
185
158
        return e
187
160
 
188
161
    def from_element(cls, elt):
189
162
        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)
 
163
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
199
164
        self.text_id = elt.get('text_id')
200
165
        self.text_sha1 = elt.get('text_sha1')
 
166
        self.parent_id = elt.get('parent_id')
201
167
        
202
168
        ## mutter("read inventoryentry: %r" % (elt.attrib))
203
169
 
209
175
 
210
176
    from_element = classmethod(from_element)
211
177
 
212
 
    def __eq__(self, other):
 
178
    def __cmp__(self, other):
 
179
        if self is other:
 
180
            return 0
213
181
        if not isinstance(other, InventoryEntry):
214
182
            return NotImplemented
215
183
 
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):
 
184
        return cmp(self.file_id, other.file_id) \
 
185
               or cmp(self.name, other.name) \
 
186
               or cmp(self.text_sha1, other.text_sha1) \
 
187
               or cmp(self.text_size, other.text_size) \
 
188
               or cmp(self.text_id, other.text_id) \
 
189
               or cmp(self.parent_id, other.parent_id) \
 
190
               or cmp(self.kind, other.kind)
 
191
 
 
192
 
 
193
 
 
194
class Inventory(XMLMixin):
251
195
    """Inventory of versioned files in a tree.
252
196
 
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.
 
197
    An Inventory acts like a set of InventoryEntry items.  You can
 
198
    also look files up by their file_id or name.
 
199
    
 
200
    May be read from and written to a metadata file in a tree.  To
 
201
    manipulate the inventory (for example to add a file), it is read
 
202
    in, modified, and then written back out.
256
203
 
257
204
    The inventory represents a typical unix file tree, with
258
205
    directories containing files and subdirectories.  We never store
262
209
    returned quickly.
263
210
 
264
211
    InventoryEntry objects must not be modified after they are
265
 
    inserted, other than through the Inventory API.
 
212
    inserted.
266
213
 
267
214
    >>> inv = Inventory()
268
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
215
    >>> inv.write_xml(sys.stdout)
 
216
    <inventory>
 
217
    </inventory>
 
218
    >>> inv.add(InventoryEntry('123-123', 'hello.c'))
269
219
    >>> inv['123-123'].name
270
220
    'hello.c'
 
221
    >>> for file_id in inv: print file_id
 
222
    ...
 
223
    123-123
271
224
 
272
225
    May be treated as an iterator or set to look up file ids:
273
226
    
280
233
 
281
234
    >>> [x[0] for x in inv.iter_entries()]
282
235
    ['hello.c']
283
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
284
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
236
    
 
237
    >>> inv.write_xml(sys.stdout)
 
238
    <inventory>
 
239
    <entry file_id="123-123" kind="file" name="hello.c" />
 
240
    </inventory>
 
241
 
285
242
    """
286
 
    def __init__(self, root_id=ROOT_ID):
 
243
 
 
244
    ## TODO: Clear up handling of files in subdirectories; we probably
 
245
    ## do want to be able to just look them up by name but this
 
246
    ## probably means gradually walking down the path, looking up as we go.
 
247
 
 
248
    ## TODO: Make sure only canonical filenames are stored.
 
249
 
 
250
    ## TODO: Do something sensible about the possible collisions on
 
251
    ## case-losing filesystems.  Perhaps we should just always forbid
 
252
    ## such collisions.
 
253
 
 
254
    ## _tree should probably just be stored as
 
255
    ## InventoryEntry._children on each directory.
 
256
 
 
257
    def __init__(self):
287
258
        """Create or read an inventory.
288
259
 
289
260
        If a working directory is specified, the inventory is read
290
261
        from there.  If the file is specified, read from that. If not,
291
262
        the inventory is created empty.
292
 
 
293
 
        The inventory is created with a default root directory, with
294
 
        an id of None.
295
263
        """
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}
 
264
        self._byid = dict()
 
265
 
 
266
        # _tree is indexed by parent_id; at each level a map from name
 
267
        # to ie.  The None entry is the root.
 
268
        self._tree = {None: {}}
302
269
 
303
270
 
304
271
    def __iter__(self):
310
277
        return len(self._byid)
311
278
 
312
279
 
313
 
    def iter_entries(self, from_dir=None):
 
280
    def iter_entries(self, parent_id=None):
314
281
        """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()
 
282
        kids = self._tree[parent_id].items()
322
283
        kids.sort()
323
284
        for name, ie in kids:
324
285
            yield name, ie
325
286
            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
 
287
                for cn, cie in self.iter_entries(parent_id=ie.file_id):
 
288
                    yield joinpath([name, cn]), cie
 
289
 
 
290
 
 
291
    def directories(self, include_root=True):
 
292
        """Return (path, entry) pairs for all directories.
 
293
        """
 
294
        if include_root:
 
295
            yield '', None
 
296
        for path, entry in self.iter_entries():
 
297
            if entry.kind == 'directory':
 
298
                yield path, entry
364
299
        
365
300
 
366
301
 
 
302
    def children(self, parent_id):
 
303
        """Return entries that are direct children of parent_id."""
 
304
        return self._tree[parent_id]
 
305
                    
 
306
 
 
307
 
 
308
    # TODO: return all paths and entries
 
309
 
 
310
 
367
311
    def __contains__(self, file_id):
368
312
        """True if this entry contains a file with given id.
369
313
 
370
314
        >>> inv = Inventory()
371
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
315
        >>> inv.add(InventoryEntry('123', 'foo.c'))
372
316
        >>> '123' in inv
373
317
        True
374
318
        >>> '456' in inv
381
325
        """Return the entry for given file_id.
382
326
 
383
327
        >>> inv = Inventory()
384
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
328
        >>> inv.add(InventoryEntry('123123', 'hello.c'))
385
329
        >>> inv['123123'].name
386
330
        'hello.c'
387
331
        """
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)
 
332
        return self._byid[file_id]
402
333
 
403
334
 
404
335
    def add(self, entry):
406
337
 
407
338
        To add  a file to a branch ready to be committed, use Branch.add,
408
339
        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))
 
340
        if entry.file_id in self:
 
341
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
 
342
 
 
343
        if entry.parent_id != None:
 
344
            if entry.parent_id not in self:
 
345
                bailout("parent_id %s of new entry not found in inventory"
 
346
                        % entry.parent_id)
 
347
            
 
348
        if self._tree[entry.parent_id].has_key(entry.name):
 
349
            bailout("%s is already versioned"
 
350
                    % appendpath(self.id2path(entry.parent_id), entry.name))
423
351
 
424
352
        self._byid[entry.file_id] = entry
425
 
        parent.children[entry.name] = entry
426
 
 
427
 
 
428
 
    def add_path(self, relpath, kind, file_id=None):
429
 
        """Add entry from a path.
430
 
 
431
 
        The immediate parent must already be versioned"""
432
 
        from bzrlib.errors import NotVersionedError
433
 
        
434
 
        parts = bzrlib.osutils.splitpath(relpath)
435
 
        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
 
 
447
 
        ie = InventoryEntry(file_id, parts[-1],
448
 
                            kind=kind, parent_id=parent_id)
449
 
        return self.add(ie)
 
353
        self._tree[entry.parent_id][entry.name] = entry
 
354
 
 
355
        if entry.kind == 'directory':
 
356
            self._tree[entry.file_id] = {}
450
357
 
451
358
 
452
359
    def __delitem__(self, file_id):
453
360
        """Remove entry by id.
454
361
 
455
362
        >>> inv = Inventory()
456
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
363
        >>> inv.add(InventoryEntry('123', 'foo.c'))
457
364
        >>> '123' in inv
458
365
        True
459
366
        >>> del inv['123']
462
369
        """
463
370
        ie = self[file_id]
464
371
 
465
 
        assert self[ie.parent_id].children[ie.name] == ie
 
372
        assert self._tree[ie.parent_id][ie.name] == ie
466
373
        
467
374
        # TODO: Test deleting all children; maybe hoist to a separate
468
375
        # deltree method?
469
376
        if ie.kind == 'directory':
470
 
            for cie in ie.children.values():
 
377
            for cie in self._tree[file_id].values():
471
378
                del self[cie.file_id]
472
 
            del ie.children
 
379
            del self._tree[file_id]
473
380
 
474
381
        del self._byid[file_id]
475
 
        del self[ie.parent_id].children[ie.name]
 
382
        del self._tree[ie.parent_id][ie.name]
 
383
 
 
384
 
 
385
    def id_set(self):
 
386
        return Set(self._byid)
476
387
 
477
388
 
478
389
    def to_element(self):
479
390
        """Convert to XML Element"""
480
 
        from bzrlib.xml import Element
481
 
        
482
391
        e = Element('inventory')
483
392
        e.text = '\n'
484
 
        if self.root.file_id not in (None, ROOT_ID):
485
 
            e.set('file_id', self.root.file_id)
486
393
        for path, ie in self.iter_entries():
487
394
            e.append(ie.to_element())
488
395
        return e
490
397
 
491
398
    def from_element(cls, elt):
492
399
        """Construct from XML Element
493
 
        
 
400
 
494
401
        >>> inv = Inventory()
495
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
 
402
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
496
403
        >>> elt = inv.to_element()
497
404
        >>> inv2 = Inventory.from_element(elt)
498
405
        >>> inv2 == inv
499
406
        True
500
407
        """
501
 
        # XXXX: doctest doesn't run this properly under python2.3
502
408
        assert elt.tag == 'inventory'
503
 
        root_id = elt.get('file_id') or ROOT_ID
504
 
        o = cls(root_id)
 
409
        o = cls()
505
410
        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)
 
411
            o.add(InventoryEntry.from_element(e))
510
412
        return o
511
413
        
512
414
    from_element = classmethod(from_element)
513
415
 
514
416
 
515
 
    def __eq__(self, other):
 
417
    def __cmp__(self, other):
516
418
        """Compare two sets by comparing their contents.
517
419
 
518
420
        >>> i1 = Inventory()
519
421
        >>> i2 = Inventory()
520
422
        >>> i1 == i2
521
423
        True
522
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
424
        >>> i1.add(InventoryEntry('123', 'foo'))
523
425
        >>> i1 == i2
524
426
        False
525
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
427
        >>> i2.add(InventoryEntry('123', 'foo'))
526
428
        >>> i1 == i2
527
429
        True
528
430
        """
 
431
        if self is other:
 
432
            return 0
 
433
        
529
434
        if not isinstance(other, Inventory):
530
435
            return NotImplemented
531
436
 
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
 
        """
 
437
        if self.id_set() ^ other.id_set():
 
438
            return 1
 
439
 
 
440
        for file_id in self._byid:
 
441
            c = cmp(self[file_id], other[file_id])
 
442
            if c: return c
 
443
 
 
444
        return 0
 
445
 
 
446
 
 
447
    def id2path(self, file_id):
 
448
        """Return as a list the path to file_id."""
556
449
        p = []
557
450
        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)
 
451
            ie = self[file_id]
 
452
            p = [ie.name] + p
563
453
            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)
 
454
        return joinpath(p)
573
455
            
574
456
 
575
457
 
581
463
 
582
464
        This returns the entry of the last component in the path,
583
465
        which may be either a file or a directory.
584
 
 
585
 
        Returns None iff the path is not found.
586
466
        """
587
 
        if isinstance(name, types.StringTypes):
588
 
            name = splitpath(name)
589
 
 
590
 
        mutter("lookup path %r" % name)
591
 
 
592
 
        parent = self.root
593
 
        for f in name:
 
467
        assert isinstance(name, types.StringTypes)
 
468
 
 
469
        parent_id = None
 
470
        for f in splitpath(name):
594
471
            try:
595
 
                cie = parent.children[f]
 
472
                cie = self._tree[parent_id][f]
596
473
                assert cie.name == f
597
 
                assert cie.parent_id == parent.file_id
598
 
                parent = cie
 
474
                parent_id = cie.file_id
599
475
            except KeyError:
600
476
                # or raise an error?
601
477
                return None
602
478
 
603
 
        return parent.file_id
 
479
        return parent_id
 
480
 
 
481
 
 
482
    def get_child(self, parent_id, child_name):
 
483
        return self._tree[parent_id].get(child_name)
604
484
 
605
485
 
606
486
    def has_filename(self, names):
608
488
 
609
489
 
610
490
    def has_id(self, file_id):
 
491
        assert isinstance(file_id, str)
611
492
        return self._byid.has_key(file_id)
612
493
 
613
494
 
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))
 
495
 
 
496
if __name__ == '__main__':
 
497
    import doctest, inventory
 
498
    doctest.testmod(inventory)