~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2006-02-22 10:35:05 UTC
  • mto: (1594.2.4 integration)
  • mto: This revision was merged to the branch mainline in revision 1596.
  • Revision ID: robertc@robertcollins.net-20060222103505-bddb211d353f2543
Merge in a variation of the versionedfile api from versioned-file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# (C) 2005 Canonical Ltd
 
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
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
"""Inventories map files to their name in a revision."""
19
 
 
20
 
 
21
 
__copyright__ = "Copyright (C) 2005 Canonical Ltd."
22
 
__author__ = "Martin Pool <mbp@canonical.com>"
23
 
 
24
 
import sys, os.path, types
25
 
from sets import Set
26
 
 
27
 
try:
28
 
    from cElementTree import Element, ElementTree, SubElement
29
 
except ImportError:
30
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
31
 
 
32
 
from xml import XMLMixin
33
 
from errors import bailout
34
 
from osutils import uuid, quotefn, splitpath, joinpath, appendpath
35
 
from trace import mutter
36
 
 
37
 
class InventoryEntry(XMLMixin):
 
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep 
 
18
# the WorkingTree's copy of the inventory in sync with the branch.  The
 
19
# branch modifies its working inventory when it does a commit to make
 
20
# missing files permanently removed.
 
21
 
 
22
# TODO: Maybe also keep the full path of the entry, and the children?
 
23
# But those depend on its position within a particular inventory, and
 
24
# it would be nice not to need to hold the backpointer here.
 
25
 
 
26
# This should really be an id randomly assigned when the tree is
 
27
# created, but it's not for now.
 
28
ROOT_ID = "TREE_ROOT"
 
29
 
 
30
 
 
31
import os.path
 
32
import re
 
33
import sys
 
34
import tarfile
 
35
import types
 
36
 
 
37
import bzrlib
 
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
39
                            pathjoin, sha_strings)
 
40
from bzrlib.trace import mutter
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError)
 
43
 
 
44
 
 
45
class InventoryEntry(object):
38
46
    """Description of a versioned file.
39
47
 
40
48
    An InventoryEntry has the following fields, which are also
41
49
    present in the XML inventory-entry element:
42
50
 
43
 
    * *file_id*
44
 
    * *name*: (only the basename within the directory, must not
45
 
      contain slashes)
46
 
    * *kind*: "directory" or "file"
47
 
    * *directory_id*: (if absent/null means the branch root directory)
48
 
    * *text_sha1*: only for files
49
 
    * *text_size*: in bytes, only for files 
50
 
    * *text_id*: identifier for the text version, only for files
51
 
 
52
 
    InventoryEntries can also exist inside a WorkingTree
53
 
    inventory, in which case they are not yet bound to a
54
 
    particular revision of the file.  In that case the text_sha1,
55
 
    text_size and text_id are absent.
56
 
 
 
51
    file_id
 
52
 
 
53
    name
 
54
        (within the parent directory)
 
55
 
 
56
    parent_id
 
57
        file_id of the parent directory, or ROOT_ID
 
58
 
 
59
    revision
 
60
        the revision_id in which this variation of this file was 
 
61
        introduced.
 
62
 
 
63
    executable
 
64
        Indicates that this file should be executable on systems
 
65
        that support it.
 
66
 
 
67
    text_sha1
 
68
        sha-1 of the text of the file
 
69
        
 
70
    text_size
 
71
        size in bytes of the text of the file
 
72
        
 
73
    (reading a version 4 tree created a text_id field.)
57
74
 
58
75
    >>> i = Inventory()
59
76
    >>> i.path2id('')
60
 
    >>> i.add(InventoryEntry('123', 'src', kind='directory'))
61
 
    >>> i.add(InventoryEntry('2323', 'hello.c', parent_id='123'))
62
 
    >>> for j in i.iter_entries():
63
 
    ...   print j
 
77
    'TREE_ROOT'
 
78
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
 
79
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
 
80
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
 
81
    InventoryFile('2323', 'hello.c', parent_id='123')
 
82
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
 
83
    >>> for ix, j in enumerate(i.iter_entries()):
 
84
    ...   print (j[0] == shouldbe[ix], j[1])
64
85
    ... 
65
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id=None))
66
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
67
 
    >>> i.add(InventoryEntry('2323', 'bye.c', parent_id='123'))
 
86
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
 
87
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
 
88
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
68
89
    Traceback (most recent call last):
69
90
    ...
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'))
 
91
    BzrError: inventory already contains entry with id {2323}
 
92
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
 
93
    InventoryFile('2324', 'bye.c', parent_id='123')
 
94
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
 
95
    InventoryDirectory('2325', 'wibble', parent_id='123')
73
96
    >>> i.path2id('src/wibble')
74
97
    '2325'
75
98
    >>> '2325' in i
76
99
    True
77
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', parent_id='2325'))
 
100
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
101
    InventoryFile('2326', 'wibble.c', parent_id='2325')
78
102
    >>> i['2326']
79
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
80
 
    >>> for j in i.iter_entries():
81
 
    ...     print j[0]
82
 
    ...     assert i.path2id(j[0])
 
103
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
104
    >>> for path, entry in i.iter_entries():
 
105
    ...     print path
 
106
    ...     assert i.path2id(path)
83
107
    ... 
84
108
    src
85
109
    src/bye.c
88
112
    src/wibble/wibble.c
89
113
    >>> i.id2path('2326')
90
114
    'src/wibble/wibble.c'
91
 
 
92
 
    :todo: Maybe also keep the full path of the entry, and the children?
93
 
           But those depend on its position within a particular inventory, and
94
 
           it would be nice not to need to hold the backpointer here.
95
115
    """
96
 
    def __init__(self, file_id, name, kind='file', text_id=None,
97
 
                 parent_id=None):
 
116
    
 
117
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
118
                 'text_id', 'parent_id', 'children', 'executable', 
 
119
                 'revision']
 
120
 
 
121
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
 
122
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
 
123
                             transaction)
 
124
 
 
125
    def detect_changes(self, old_entry):
 
126
        """Return a (text_modified, meta_modified) from this to old_entry.
 
127
        
 
128
        _read_tree_state must have been called on self and old_entry prior to 
 
129
        calling detect_changes.
 
130
        """
 
131
        return False, False
 
132
 
 
133
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
134
             output_to, reverse=False):
 
135
        """Perform a diff from this to to_entry.
 
136
 
 
137
        text_diff will be used for textual difference calculation.
 
138
        This is a template method, override _diff in child classes.
 
139
        """
 
140
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
141
        if to_entry:
 
142
            # cannot diff from one kind to another - you must do a removal
 
143
            # and an addif they do not match.
 
144
            assert self.kind == to_entry.kind
 
145
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
146
                                      to_tree)
 
147
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
148
                   output_to, reverse)
 
149
 
 
150
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
151
             output_to, reverse=False):
 
152
        """Perform a diff between two entries of the same kind."""
 
153
 
 
154
    def find_previous_heads(self, previous_inventories, entry_weave):
 
155
        """Return the revisions and entries that directly preceed this.
 
156
 
 
157
        Returned as a map from revision to inventory entry.
 
158
 
 
159
        This is a map containing the file revisions in all parents
 
160
        for which the file exists, and its revision is not a parent of
 
161
        any other. If the file is new, the set will be empty.
 
162
        """
 
163
        def get_ancestors(weave, entry):
 
164
            return set(map(weave.idx_to_name,
 
165
                           weave.inclusions([weave.lookup(entry.revision)])))
 
166
        heads = {}
 
167
        head_ancestors = {}
 
168
        for inv in previous_inventories:
 
169
            if self.file_id in inv:
 
170
                ie = inv[self.file_id]
 
171
                assert ie.file_id == self.file_id
 
172
                if ie.revision in heads:
 
173
                    # fixup logic, there was a bug in revision updates.
 
174
                    # with x bit support.
 
175
                    try:
 
176
                        if heads[ie.revision].executable != ie.executable:
 
177
                            heads[ie.revision].executable = False
 
178
                            ie.executable = False
 
179
                    except AttributeError:
 
180
                        pass
 
181
                    assert heads[ie.revision] == ie
 
182
                else:
 
183
                    # may want to add it.
 
184
                    # may already be covered:
 
185
                    already_present = 0 != len(
 
186
                        [head for head in heads 
 
187
                         if ie.revision in head_ancestors[head]])
 
188
                    if already_present:
 
189
                        # an ancestor of a known head.
 
190
                        continue
 
191
                    # definately a head:
 
192
                    ancestors = get_ancestors(entry_weave, ie)
 
193
                    # may knock something else out:
 
194
                    check_heads = list(heads.keys())
 
195
                    for head in check_heads:
 
196
                        if head in ancestors:
 
197
                            # this head is not really a head
 
198
                            heads.pop(head)
 
199
                    head_ancestors[ie.revision] = ancestors
 
200
                    heads[ie.revision] = ie
 
201
        return heads
 
202
 
 
203
    def get_tar_item(self, root, dp, now, tree):
 
204
        """Get a tarfile item and a file stream for its content."""
 
205
        item = tarfile.TarInfo(pathjoin(root, dp))
 
206
        # TODO: would be cool to actually set it to the timestamp of the
 
207
        # revision it was last changed
 
208
        item.mtime = now
 
209
        fileobj = self._put_in_tar(item, tree)
 
210
        return item, fileobj
 
211
 
 
212
    def has_text(self):
 
213
        """Return true if the object this entry represents has textual data.
 
214
 
 
215
        Note that textual data includes binary content.
 
216
 
 
217
        Also note that all entries get weave files created for them.
 
218
        This attribute is primarily used when upgrading from old trees that
 
219
        did not have the weave index for all inventory entries.
 
220
        """
 
221
        return False
 
222
 
 
223
    def __init__(self, file_id, name, parent_id, text_id=None):
98
224
        """Create an InventoryEntry
99
225
        
100
226
        The filename must be a single component, relative to the
101
227
        parent directory; it cannot be a whole path or relative name.
102
228
 
103
 
        >>> e = InventoryEntry('123', 'hello.c')
 
229
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
104
230
        >>> e.name
105
231
        'hello.c'
106
232
        >>> e.file_id
107
233
        '123'
108
 
        >>> e = InventoryEntry('123', 'src/hello.c')
 
234
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
109
235
        Traceback (most recent call last):
110
 
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
 
236
        InvalidEntryName: Invalid entry name: src/hello.c
111
237
        """
112
 
        
113
 
        if len(splitpath(name)) != 1:
114
 
            bailout('InventoryEntry name is not a simple filename: %r'
115
 
                    % name)
116
 
        
 
238
        assert isinstance(name, basestring), name
 
239
        if '/' in name or '\\' in name:
 
240
            raise InvalidEntryName(name=name)
 
241
        self.executable = False
 
242
        self.revision = None
 
243
        self.text_sha1 = None
 
244
        self.text_size = None
117
245
        self.file_id = file_id
118
246
        self.name = name
119
 
        assert kind in ['file', 'directory']
120
 
        self.kind = kind
121
247
        self.text_id = text_id
122
248
        self.parent_id = parent_id
123
 
        self.text_sha1 = None
124
 
        self.text_size = None
 
249
        self.symlink_target = None
 
250
 
 
251
    def kind_character(self):
 
252
        """Return a short kind indicator useful for appending to names."""
 
253
        raise BzrError('unknown kind %r' % self.kind)
 
254
 
 
255
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
256
 
 
257
    def _put_in_tar(self, item, tree):
 
258
        """populate item for stashing in a tar, and return the content stream.
 
259
 
 
260
        If no content is available, return None.
 
261
        """
 
262
        raise BzrError("don't know how to export {%s} of kind %r" %
 
263
                       (self.file_id, self.kind))
 
264
 
 
265
    def put_on_disk(self, dest, dp, tree):
 
266
        """Create a representation of self on disk in the prefix dest.
 
267
        
 
268
        This is a template method - implement _put_on_disk in subclasses.
 
269
        """
 
270
        fullpath = pathjoin(dest, dp)
 
271
        self._put_on_disk(fullpath, tree)
 
272
        mutter("  export {%s} kind %s to %s", self.file_id,
 
273
                self.kind, fullpath)
 
274
 
 
275
    def _put_on_disk(self, fullpath, tree):
 
276
        """Put this entry onto disk at fullpath, from tree tree."""
 
277
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
 
278
 
 
279
    def sorted_children(self):
 
280
        l = self.children.items()
 
281
        l.sort()
 
282
        return l
 
283
 
 
284
    @staticmethod
 
285
    def versionable_kind(kind):
 
286
        return kind in ('file', 'directory', 'symlink')
 
287
 
 
288
    def check(self, checker, rev_id, inv, tree):
 
289
        """Check this inventory entry is intact.
 
290
 
 
291
        This is a template method, override _check for kind specific
 
292
        tests.
 
293
        """
 
294
        if self.parent_id != None:
 
295
            if not inv.has_id(self.parent_id):
 
296
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
297
                        % (self.parent_id, rev_id))
 
298
        self._check(checker, rev_id, tree)
 
299
 
 
300
    def _check(self, checker, rev_id, tree):
 
301
        """Check this inventory entry for kind specific errors."""
 
302
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
303
                            (self.kind, rev_id))
125
304
 
126
305
 
127
306
    def copy(self):
128
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
129
 
                               self.text_id, self.parent_id)
130
 
        other.text_sha1 = self.text_sha1
131
 
        other.text_size = self.text_size
132
 
        return other
 
307
        """Clone this inventory entry."""
 
308
        raise NotImplementedError
133
309
 
 
310
    def _get_snapshot_change(self, previous_entries):
 
311
        if len(previous_entries) > 1:
 
312
            return 'merged'
 
313
        elif len(previous_entries) == 0:
 
314
            return 'added'
 
315
        else:
 
316
            return 'modified/renamed/reparented'
134
317
 
135
318
    def __repr__(self):
136
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
319
        return ("%s(%r, %r, parent_id=%r)"
137
320
                % (self.__class__.__name__,
138
321
                   self.file_id,
139
322
                   self.name,
140
 
                   self.kind,
141
323
                   self.parent_id))
142
324
 
143
 
    
144
 
    def to_element(self):
145
 
        """Convert to XML element"""
146
 
        e = Element('entry')
147
 
 
148
 
        e.set('name', self.name)
149
 
        e.set('file_id', self.file_id)
150
 
        e.set('kind', self.kind)
151
 
 
152
 
        if self.text_size is not None:
153
 
            e.set('text_size', '%d' % self.text_size)
154
 
            
155
 
        for f in ['text_id', 'text_sha1', 'parent_id']:
156
 
            v = getattr(self, f)
157
 
            if v is not None:
158
 
                e.set(f, v)
159
 
 
160
 
        e.tail = '\n'
161
 
            
162
 
        return e
163
 
 
164
 
 
165
 
    def from_element(cls, elt):
166
 
        assert elt.tag == 'entry'
167
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'))
168
 
        self.text_id = elt.get('text_id')
169
 
        self.text_sha1 = elt.get('text_sha1')
170
 
        self.parent_id = elt.get('parent_id')
171
 
        
172
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
173
 
 
174
 
        v = elt.get('text_size')
175
 
        self.text_size = v and int(v)
176
 
 
177
 
        return self
178
 
            
179
 
 
180
 
    from_element = classmethod(from_element)
181
 
 
182
 
    def __cmp__(self, other):
183
 
        if self is other:
184
 
            return 0
 
325
    def snapshot(self, revision, path, previous_entries,
 
326
                 work_tree, weave_store, transaction):
 
327
        """Make a snapshot of this entry which may or may not have changed.
 
328
        
 
329
        This means that all its fields are populated, that it has its
 
330
        text stored in the text store or weave.
 
331
        """
 
332
        mutter('new parents of %s are %r', path, previous_entries)
 
333
        self._read_tree_state(path, work_tree)
 
334
        if len(previous_entries) == 1:
 
335
            # cannot be unchanged unless there is only one parent file rev.
 
336
            parent_ie = previous_entries.values()[0]
 
337
            if self._unchanged(parent_ie):
 
338
                mutter("found unchanged entry")
 
339
                self.revision = parent_ie.revision
 
340
                return "unchanged"
 
341
        return self.snapshot_revision(revision, previous_entries, 
 
342
                                      work_tree, weave_store, transaction)
 
343
 
 
344
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
345
                          weave_store, transaction):
 
346
        """Record this revision unconditionally."""
 
347
        mutter('new revision for {%s}', self.file_id)
 
348
        self.revision = revision
 
349
        change = self._get_snapshot_change(previous_entries)
 
350
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
351
                            transaction)
 
352
        return change
 
353
 
 
354
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
355
        """Record the 'text' of this entry, whatever form that takes.
 
356
        
 
357
        This default implementation simply adds an empty text.
 
358
        """
 
359
        mutter('storing file {%s} in revision {%s}',
 
360
               self.file_id, self.revision)
 
361
        self._add_text_to_weave([], file_parents, weave_store, transaction)
 
362
 
 
363
    def __eq__(self, other):
185
364
        if not isinstance(other, InventoryEntry):
186
365
            return NotImplemented
187
366
 
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):
 
367
        return ((self.file_id == other.file_id)
 
368
                and (self.name == other.name)
 
369
                and (other.symlink_target == self.symlink_target)
 
370
                and (self.text_sha1 == other.text_sha1)
 
371
                and (self.text_size == other.text_size)
 
372
                and (self.text_id == other.text_id)
 
373
                and (self.parent_id == other.parent_id)
 
374
                and (self.kind == other.kind)
 
375
                and (self.revision == other.revision)
 
376
                and (self.executable == other.executable)
 
377
                )
 
378
 
 
379
    def __ne__(self, other):
 
380
        return not (self == other)
 
381
 
 
382
    def __hash__(self):
 
383
        raise ValueError('not hashable')
 
384
 
 
385
    def _unchanged(self, previous_ie):
 
386
        """Has this entry changed relative to previous_ie.
 
387
 
 
388
        This method should be overriden in child classes.
 
389
        """
 
390
        compatible = True
 
391
        # different inv parent
 
392
        if previous_ie.parent_id != self.parent_id:
 
393
            compatible = False
 
394
        # renamed
 
395
        elif previous_ie.name != self.name:
 
396
            compatible = False
 
397
        return compatible
 
398
 
 
399
    def _read_tree_state(self, path, work_tree):
 
400
        """Populate fields in the inventory entry from the given tree.
 
401
        
 
402
        Note that this should be modified to be a noop on virtual trees
 
403
        as all entries created there are prepopulated.
 
404
        """
 
405
        # TODO: Rather than running this manually, we should check the 
 
406
        # working sha1 and other expensive properties when they're
 
407
        # first requested, or preload them if they're already known
 
408
        pass            # nothing to do by default
 
409
 
 
410
    def _forget_tree_state(self):
 
411
        pass
 
412
 
 
413
 
 
414
class RootEntry(InventoryEntry):
 
415
 
 
416
    def _check(self, checker, rev_id, tree):
 
417
        """See InventoryEntry._check"""
 
418
 
 
419
    def __init__(self, file_id):
 
420
        self.file_id = file_id
 
421
        self.children = {}
 
422
        self.kind = 'root_directory'
 
423
        self.parent_id = None
 
424
        self.name = u''
 
425
 
 
426
    def __eq__(self, other):
 
427
        if not isinstance(other, RootEntry):
 
428
            return NotImplemented
 
429
        
 
430
        return (self.file_id == other.file_id) \
 
431
               and (self.children == other.children)
 
432
 
 
433
 
 
434
class InventoryDirectory(InventoryEntry):
 
435
    """A directory in an inventory."""
 
436
 
 
437
    def _check(self, checker, rev_id, tree):
 
438
        """See InventoryEntry._check"""
 
439
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
440
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
441
                                % (self.file_id, rev_id))
 
442
 
 
443
    def copy(self):
 
444
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
445
        other.revision = self.revision
 
446
        # note that children are *not* copied; they're pulled across when
 
447
        # others are added
 
448
        return other
 
449
 
 
450
    def __init__(self, file_id, name, parent_id):
 
451
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
452
        self.children = {}
 
453
        self.kind = 'directory'
 
454
 
 
455
    def kind_character(self):
 
456
        """See InventoryEntry.kind_character."""
 
457
        return '/'
 
458
 
 
459
    def _put_in_tar(self, item, tree):
 
460
        """See InventoryEntry._put_in_tar."""
 
461
        item.type = tarfile.DIRTYPE
 
462
        fileobj = None
 
463
        item.name += '/'
 
464
        item.size = 0
 
465
        item.mode = 0755
 
466
        return fileobj
 
467
 
 
468
    def _put_on_disk(self, fullpath, tree):
 
469
        """See InventoryEntry._put_on_disk."""
 
470
        os.mkdir(fullpath)
 
471
 
 
472
 
 
473
class InventoryFile(InventoryEntry):
 
474
    """A file in an inventory."""
 
475
 
 
476
    def _check(self, checker, rev_id, tree):
 
477
        """See InventoryEntry._check"""
 
478
        revision = self.revision
 
479
        t = (self.file_id, revision)
 
480
        if t in checker.checked_texts:
 
481
            prev_sha = checker.checked_texts[t] 
 
482
            if prev_sha != self.text_sha1:
 
483
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
484
                                    (self.file_id, rev_id))
 
485
            else:
 
486
                checker.repeated_text_cnt += 1
 
487
                return
 
488
 
 
489
        if self.file_id not in checker.checked_weaves:
 
490
            mutter('check weave {%s}', self.file_id)
 
491
            w = tree.get_weave(self.file_id)
 
492
            # Not passing a progress bar, because it creates a new
 
493
            # progress, which overwrites the current progress,
 
494
            # and doesn't look nice
 
495
            w.check()
 
496
            checker.checked_weaves[self.file_id] = True
 
497
        else:
 
498
            w = tree.get_weave_prelude(self.file_id)
 
499
 
 
500
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
501
        checker.checked_text_cnt += 1 
 
502
        # We can't check the length, because Weave doesn't store that
 
503
        # information, and the whole point of looking at the weave's
 
504
        # sha1sum is that we don't have to extract the text.
 
505
        if self.text_sha1 != w.get_sha1(self.revision):
 
506
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
507
                                % (self.file_id, self.revision))
 
508
        checker.checked_texts[t] = self.text_sha1
 
509
 
 
510
    def copy(self):
 
511
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
512
        other.executable = self.executable
 
513
        other.text_id = self.text_id
 
514
        other.text_sha1 = self.text_sha1
 
515
        other.text_size = self.text_size
 
516
        other.revision = self.revision
 
517
        return other
 
518
 
 
519
    def detect_changes(self, old_entry):
 
520
        """See InventoryEntry.detect_changes."""
 
521
        assert self.text_sha1 != None
 
522
        assert old_entry.text_sha1 != None
 
523
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
524
        meta_modified = (self.executable != old_entry.executable)
 
525
        return text_modified, meta_modified
 
526
 
 
527
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
528
             output_to, reverse=False):
 
529
        """See InventoryEntry._diff."""
 
530
        from_text = tree.get_file(self.file_id).readlines()
 
531
        if to_entry:
 
532
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
533
        else:
 
534
            to_text = []
 
535
        if not reverse:
 
536
            text_diff(from_label, from_text,
 
537
                      to_label, to_text, output_to)
 
538
        else:
 
539
            text_diff(to_label, to_text,
 
540
                      from_label, from_text, output_to)
 
541
 
 
542
    def has_text(self):
 
543
        """See InventoryEntry.has_text."""
 
544
        return True
 
545
 
 
546
    def __init__(self, file_id, name, parent_id):
 
547
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
548
        self.kind = 'file'
 
549
 
 
550
    def kind_character(self):
 
551
        """See InventoryEntry.kind_character."""
 
552
        return ''
 
553
 
 
554
    def _put_in_tar(self, item, tree):
 
555
        """See InventoryEntry._put_in_tar."""
 
556
        item.type = tarfile.REGTYPE
 
557
        fileobj = tree.get_file(self.file_id)
 
558
        item.size = self.text_size
 
559
        if tree.is_executable(self.file_id):
 
560
            item.mode = 0755
 
561
        else:
 
562
            item.mode = 0644
 
563
        return fileobj
 
564
 
 
565
    def _put_on_disk(self, fullpath, tree):
 
566
        """See InventoryEntry._put_on_disk."""
 
567
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
568
        if tree.is_executable(self.file_id):
 
569
            os.chmod(fullpath, 0755)
 
570
 
 
571
    def _read_tree_state(self, path, work_tree):
 
572
        """See InventoryEntry._read_tree_state."""
 
573
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
574
        self.executable = work_tree.is_executable(self.file_id)
 
575
 
 
576
    def _forget_tree_state(self):
 
577
        self.text_sha1 = None
 
578
        self.executable = None
 
579
 
 
580
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
581
        """See InventoryEntry._snapshot_text."""
 
582
        mutter('storing file {%s} in revision {%s}',
 
583
               self.file_id, self.revision)
 
584
        # special case to avoid diffing on renames or 
 
585
        # reparenting
 
586
        if (len(file_parents) == 1
 
587
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
588
            and self.text_size == file_parents.values()[0].text_size):
 
589
            previous_ie = file_parents.values()[0]
 
590
            weave_store.add_identical_text(
 
591
                self.file_id, previous_ie.revision, 
 
592
                self.revision, file_parents, transaction)
 
593
        else:
 
594
            new_lines = work_tree.get_file(self.file_id).readlines()
 
595
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
596
                                    transaction)
 
597
            self.text_sha1 = sha_strings(new_lines)
 
598
            self.text_size = sum(map(len, new_lines))
 
599
 
 
600
 
 
601
    def _unchanged(self, previous_ie):
 
602
        """See InventoryEntry._unchanged."""
 
603
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
604
        if self.text_sha1 != previous_ie.text_sha1:
 
605
            compatible = False
 
606
        else:
 
607
            # FIXME: 20050930 probe for the text size when getting sha1
 
608
            # in _read_tree_state
 
609
            self.text_size = previous_ie.text_size
 
610
        if self.executable != previous_ie.executable:
 
611
            compatible = False
 
612
        return compatible
 
613
 
 
614
 
 
615
class InventoryLink(InventoryEntry):
 
616
    """A file in an inventory."""
 
617
 
 
618
    __slots__ = ['symlink_target']
 
619
 
 
620
    def _check(self, checker, rev_id, tree):
 
621
        """See InventoryEntry._check"""
 
622
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
623
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
624
                    % (self.file_id, rev_id))
 
625
        if self.symlink_target == None:
 
626
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
627
                    % (self.file_id, rev_id))
 
628
 
 
629
    def copy(self):
 
630
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
631
        other.symlink_target = self.symlink_target
 
632
        other.revision = self.revision
 
633
        return other
 
634
 
 
635
    def detect_changes(self, old_entry):
 
636
        """See InventoryEntry.detect_changes."""
 
637
        # FIXME: which _modified field should we use ? RBC 20051003
 
638
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
639
        if text_modified:
 
640
            mutter("    symlink target changed")
 
641
        meta_modified = False
 
642
        return text_modified, meta_modified
 
643
 
 
644
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
645
             output_to, reverse=False):
 
646
        """See InventoryEntry._diff."""
 
647
        from_text = self.symlink_target
 
648
        if to_entry is not None:
 
649
            to_text = to_entry.symlink_target
 
650
            if reverse:
 
651
                temp = from_text
 
652
                from_text = to_text
 
653
                to_text = temp
 
654
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
655
        else:
 
656
            if not reverse:
 
657
                print >>output_to, '=== target was %r' % self.symlink_target
 
658
            else:
 
659
                print >>output_to, '=== target is %r' % self.symlink_target
 
660
 
 
661
    def __init__(self, file_id, name, parent_id):
 
662
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
663
        self.kind = 'symlink'
 
664
 
 
665
    def kind_character(self):
 
666
        """See InventoryEntry.kind_character."""
 
667
        return ''
 
668
 
 
669
    def _put_in_tar(self, item, tree):
 
670
        """See InventoryEntry._put_in_tar."""
 
671
        item.type = tarfile.SYMTYPE
 
672
        fileobj = None
 
673
        item.size = 0
 
674
        item.mode = 0755
 
675
        item.linkname = self.symlink_target
 
676
        return fileobj
 
677
 
 
678
    def _put_on_disk(self, fullpath, tree):
 
679
        """See InventoryEntry._put_on_disk."""
 
680
        try:
 
681
            os.symlink(self.symlink_target, fullpath)
 
682
        except OSError,e:
 
683
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
684
 
 
685
    def _read_tree_state(self, path, work_tree):
 
686
        """See InventoryEntry._read_tree_state."""
 
687
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
688
 
 
689
    def _forget_tree_state(self):
 
690
        self.symlink_target = None
 
691
 
 
692
    def _unchanged(self, previous_ie):
 
693
        """See InventoryEntry._unchanged."""
 
694
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
695
        if self.symlink_target != previous_ie.symlink_target:
 
696
            compatible = False
 
697
        return compatible
 
698
 
 
699
 
 
700
class Inventory(object):
199
701
    """Inventory of versioned files in a tree.
200
702
 
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.
 
703
    This describes which file_id is present at each point in the tree,
 
704
    and possibly the SHA-1 or other information about the file.
 
705
    Entries can be looked up either by path or by file_id.
207
706
 
208
707
    The inventory represents a typical unix file tree, with
209
708
    directories containing files and subdirectories.  We never store
213
712
    returned quickly.
214
713
 
215
714
    InventoryEntry objects must not be modified after they are
216
 
    inserted.
 
715
    inserted, other than through the Inventory API.
217
716
 
218
717
    >>> inv = Inventory()
219
 
    >>> inv.write_xml(sys.stdout)
220
 
    <inventory>
221
 
    </inventory>
222
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c'))
 
718
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
719
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
223
720
    >>> inv['123-123'].name
224
721
    'hello.c'
225
 
    >>> for file_id in inv: print file_id
226
 
    ...
227
 
    123-123
228
722
 
229
723
    May be treated as an iterator or set to look up file ids:
230
724
    
237
731
 
238
732
    >>> [x[0] for x in inv.iter_entries()]
239
733
    ['hello.c']
240
 
    
241
 
    >>> inv.write_xml(sys.stdout)
242
 
    <inventory>
243
 
    <entry file_id="123-123" kind="file" name="hello.c" />
244
 
    </inventory>
245
 
 
 
734
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
735
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
736
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
246
737
    """
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):
 
738
    def __init__(self, root_id=ROOT_ID):
262
739
        """Create or read an inventory.
263
740
 
264
741
        If a working directory is specified, the inventory is read
265
742
        from there.  If the file is specified, read from that. If not,
266
743
        the inventory is created empty.
 
744
 
 
745
        The inventory is created with a default root directory, with
 
746
        an id of None.
267
747
        """
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: {}}
 
748
        # We are letting Branch.create() create a unique inventory
 
749
        # root id. Rather than generating a random one here.
 
750
        #if root_id is None:
 
751
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
752
        self.root = RootEntry(root_id)
 
753
        self._byid = {self.root.file_id: self.root}
 
754
 
 
755
 
 
756
    def copy(self):
 
757
        other = Inventory(self.root.file_id)
 
758
        # copy recursively so we know directories will be added before
 
759
        # their children.  There are more efficient ways than this...
 
760
        for path, entry in self.iter_entries():
 
761
            if entry == self.root:
 
762
                continue
 
763
            other.add(entry.copy())
 
764
        return other
273
765
 
274
766
 
275
767
    def __iter__(self):
281
773
        return len(self._byid)
282
774
 
283
775
 
284
 
    def iter_entries(self, parent_id=None):
 
776
    def iter_entries(self, from_dir=None):
285
777
        """Return (path, entry) pairs, in order by name."""
286
 
        kids = self._tree[parent_id].items()
 
778
        if from_dir == None:
 
779
            assert self.root
 
780
            from_dir = self.root
 
781
        elif isinstance(from_dir, basestring):
 
782
            from_dir = self._byid[from_dir]
 
783
            
 
784
        kids = from_dir.children.items()
287
785
        kids.sort()
288
786
        for name, ie in kids:
289
787
            yield name, ie
290
788
            if ie.kind == 'directory':
291
 
                for cn, cie in self.iter_entries(parent_id=ie.file_id):
292
 
                    yield joinpath([name, cn]), cie
293
 
 
294
 
 
295
 
    def directories(self, include_root=True):
296
 
        """Return (path, entry) pairs for all directories.
297
 
        """
298
 
        if include_root:
299
 
            yield '', None
300
 
        for path, entry in self.iter_entries():
301
 
            if entry.kind == 'directory':
302
 
                yield path, entry
 
789
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
790
                    yield pathjoin(name, cn), cie
 
791
 
 
792
 
 
793
    def entries(self):
 
794
        """Return list of (path, ie) for all entries except the root.
 
795
 
 
796
        This may be faster than iter_entries.
 
797
        """
 
798
        accum = []
 
799
        def descend(dir_ie, dir_path):
 
800
            kids = dir_ie.children.items()
 
801
            kids.sort()
 
802
            for name, ie in kids:
 
803
                child_path = pathjoin(dir_path, name)
 
804
                accum.append((child_path, ie))
 
805
                if ie.kind == 'directory':
 
806
                    descend(ie, child_path)
 
807
 
 
808
        descend(self.root, u'')
 
809
        return accum
 
810
 
 
811
 
 
812
    def directories(self):
 
813
        """Return (path, entry) pairs for all directories, including the root.
 
814
        """
 
815
        accum = []
 
816
        def descend(parent_ie, parent_path):
 
817
            accum.append((parent_path, parent_ie))
 
818
            
 
819
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
820
            kids.sort()
 
821
 
 
822
            for name, child_ie in kids:
 
823
                child_path = pathjoin(parent_path, name)
 
824
                descend(child_ie, child_path)
 
825
        descend(self.root, u'')
 
826
        return accum
303
827
        
304
828
 
305
829
 
306
 
    def children(self, parent_id):
307
 
        """Return entries that are direct children of parent_id."""
308
 
        return self._tree[parent_id]
309
 
                    
310
 
 
311
 
 
312
 
    # TODO: return all paths and entries
313
 
 
314
 
 
315
830
    def __contains__(self, file_id):
316
831
        """True if this entry contains a file with given id.
317
832
 
318
833
        >>> inv = Inventory()
319
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
834
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
835
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
320
836
        >>> '123' in inv
321
837
        True
322
838
        >>> '456' in inv
329
845
        """Return the entry for given file_id.
330
846
 
331
847
        >>> inv = Inventory()
332
 
        >>> inv.add(InventoryEntry('123123', 'hello.c'))
 
848
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
849
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
333
850
        >>> inv['123123'].name
334
851
        'hello.c'
335
852
        """
336
 
        return self._byid[file_id]
 
853
        try:
 
854
            return self._byid[file_id]
 
855
        except KeyError:
 
856
            if file_id == None:
 
857
                raise BzrError("can't look up file_id None")
 
858
            else:
 
859
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
860
 
 
861
 
 
862
    def get_file_kind(self, file_id):
 
863
        return self._byid[file_id].kind
 
864
 
 
865
    def get_child(self, parent_id, filename):
 
866
        return self[parent_id].children.get(filename)
337
867
 
338
868
 
339
869
    def add(self, entry):
340
870
        """Add entry to inventory.
341
871
 
342
872
        To add  a file to a branch ready to be committed, use Branch.add,
343
 
        which calls this."""
344
 
        if entry.file_id in self:
345
 
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
346
 
 
347
 
        if entry.parent_id != None:
348
 
            if entry.parent_id not in self:
349
 
                bailout("parent_id %s of new entry not found in inventory"
350
 
                        % entry.parent_id)
351
 
            
352
 
        if self._tree[entry.parent_id].has_key(entry.name):
353
 
            bailout("%s is already versioned"
354
 
                    % appendpath(self.id2path(entry.parent_id), entry.name))
 
873
        which calls this.
 
874
 
 
875
        Returns the new entry object.
 
876
        """
 
877
        if entry.file_id in self._byid:
 
878
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
879
 
 
880
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
881
            entry.parent_id = self.root.file_id
 
882
 
 
883
        try:
 
884
            parent = self._byid[entry.parent_id]
 
885
        except KeyError:
 
886
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
887
 
 
888
        if parent.children.has_key(entry.name):
 
889
            raise BzrError("%s is already versioned" %
 
890
                    pathjoin(self.id2path(parent.file_id), entry.name))
355
891
 
356
892
        self._byid[entry.file_id] = entry
357
 
        self._tree[entry.parent_id][entry.name] = entry
358
 
 
359
 
        if entry.kind == 'directory':
360
 
            self._tree[entry.file_id] = {}
 
893
        parent.children[entry.name] = entry
 
894
        return entry
 
895
 
 
896
 
 
897
    def add_path(self, relpath, kind, file_id=None):
 
898
        """Add entry from a path.
 
899
 
 
900
        The immediate parent must already be versioned.
 
901
 
 
902
        Returns the new entry object."""
 
903
        from bzrlib.workingtree import gen_file_id
 
904
        
 
905
        parts = bzrlib.osutils.splitpath(relpath)
 
906
 
 
907
        if file_id == None:
 
908
            file_id = gen_file_id(relpath)
 
909
 
 
910
        if len(parts) == 0:
 
911
            self.root = RootEntry(file_id)
 
912
            self._byid = {self.root.file_id: self.root}
 
913
            return
 
914
        else:
 
915
            parent_path = parts[:-1]
 
916
            parent_id = self.path2id(parent_path)
 
917
            if parent_id == None:
 
918
                raise NotVersionedError(path=parent_path)
 
919
        if kind == 'directory':
 
920
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
921
        elif kind == 'file':
 
922
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
923
        elif kind == 'symlink':
 
924
            ie = InventoryLink(file_id, parts[-1], parent_id)
 
925
        else:
 
926
            raise BzrError("unknown kind %r" % kind)
 
927
        return self.add(ie)
361
928
 
362
929
 
363
930
    def __delitem__(self, file_id):
364
931
        """Remove entry by id.
365
932
 
366
933
        >>> inv = Inventory()
367
 
        >>> inv.add(InventoryEntry('123', 'foo.c'))
 
934
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
935
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
368
936
        >>> '123' in inv
369
937
        True
370
938
        >>> del inv['123']
373
941
        """
374
942
        ie = self[file_id]
375
943
 
376
 
        assert self._tree[ie.parent_id][ie.name] == ie
 
944
        assert ie.parent_id is None or \
 
945
            self[ie.parent_id].children[ie.name] == ie
377
946
        
378
 
        # TODO: Test deleting all children; maybe hoist to a separate
379
 
        # deltree method?
380
 
        if ie.kind == 'directory':
381
 
            for cie in self._tree[file_id].values():
382
 
                del self[cie.file_id]
383
 
            del self._tree[file_id]
384
 
 
385
947
        del self._byid[file_id]
386
 
        del self._tree[ie.parent_id][ie.name]
387
 
 
388
 
 
389
 
    def id_set(self):
390
 
        return Set(self._byid)
391
 
 
392
 
 
393
 
    def to_element(self):
394
 
        """Convert to XML Element"""
395
 
        e = Element('inventory')
396
 
        e.text = '\n'
397
 
        for path, ie in self.iter_entries():
398
 
            e.append(ie.to_element())
399
 
        return e
400
 
    
401
 
 
402
 
    def from_element(cls, elt):
403
 
        """Construct from XML Element
404
 
 
405
 
        >>> inv = Inventory()
406
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c'))
407
 
        >>> elt = inv.to_element()
408
 
        >>> inv2 = Inventory.from_element(elt)
409
 
        >>> inv2 == inv
410
 
        True
411
 
        """
412
 
        assert elt.tag == 'inventory'
413
 
        o = cls()
414
 
        for e in elt:
415
 
            o.add(InventoryEntry.from_element(e))
416
 
        return o
417
 
        
418
 
    from_element = classmethod(from_element)
419
 
 
420
 
 
421
 
    def __cmp__(self, other):
 
948
        if ie.parent_id is not None:
 
949
            del self[ie.parent_id].children[ie.name]
 
950
 
 
951
 
 
952
    def __eq__(self, other):
422
953
        """Compare two sets by comparing their contents.
423
954
 
424
955
        >>> i1 = Inventory()
425
956
        >>> i2 = Inventory()
426
957
        >>> i1 == i2
427
958
        True
428
 
        >>> i1.add(InventoryEntry('123', 'foo'))
 
959
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
960
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
429
961
        >>> i1 == i2
430
962
        False
431
 
        >>> i2.add(InventoryEntry('123', 'foo'))
 
963
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
964
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
432
965
        >>> i1 == i2
433
966
        True
434
967
        """
435
 
        if self is other:
436
 
            return 0
437
 
        
438
968
        if not isinstance(other, Inventory):
439
969
            return NotImplemented
440
970
 
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."""
 
971
        if len(self._byid) != len(other._byid):
 
972
            # shortcut: obviously not the same
 
973
            return False
 
974
 
 
975
        return self._byid == other._byid
 
976
 
 
977
 
 
978
    def __ne__(self, other):
 
979
        return not self.__eq__(other)
 
980
 
 
981
 
 
982
    def __hash__(self):
 
983
        raise ValueError('not hashable')
 
984
 
 
985
 
 
986
    def get_idpath(self, file_id):
 
987
        """Return a list of file_ids for the path to an entry.
 
988
 
 
989
        The list contains one element for each directory followed by
 
990
        the id of the file itself.  So the length of the returned list
 
991
        is equal to the depth of the file in the tree, counting the
 
992
        root directory as depth 1.
 
993
        """
453
994
        p = []
454
995
        while file_id != None:
455
 
            ie = self[file_id]
456
 
            p = [ie.name] + p
 
996
            try:
 
997
                ie = self._byid[file_id]
 
998
            except KeyError:
 
999
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1000
            p.insert(0, ie.file_id)
457
1001
            file_id = ie.parent_id
458
 
        return joinpath(p)
 
1002
        return p
 
1003
 
 
1004
 
 
1005
    def id2path(self, file_id):
 
1006
        """Return as a list the path to file_id.
 
1007
        
 
1008
        >>> i = Inventory()
 
1009
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1010
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1011
        >>> print i.id2path('foo-id')
 
1012
        src/foo.c
 
1013
        """
 
1014
        # get all names, skipping root
 
1015
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
1016
        if p:
 
1017
            return pathjoin(*p)
 
1018
        else:
 
1019
            return ''
459
1020
            
460
1021
 
461
1022
 
467
1028
 
468
1029
        This returns the entry of the last component in the path,
469
1030
        which may be either a file or a directory.
 
1031
 
 
1032
        Returns None iff the path is not found.
470
1033
        """
471
 
        assert isinstance(name, types.StringTypes)
472
 
 
473
 
        parent_id = None
474
 
        for f in splitpath(name):
 
1034
        if isinstance(name, types.StringTypes):
 
1035
            name = splitpath(name)
 
1036
 
 
1037
        mutter("lookup path %r" % name)
 
1038
 
 
1039
        parent = self.root
 
1040
        for f in name:
475
1041
            try:
476
 
                cie = self._tree[parent_id][f]
 
1042
                cie = parent.children[f]
477
1043
                assert cie.name == f
478
 
                parent_id = cie.file_id
 
1044
                assert cie.parent_id == parent.file_id
 
1045
                parent = cie
479
1046
            except KeyError:
480
1047
                # or raise an error?
481
1048
                return None
482
1049
 
483
 
        return parent_id
484
 
 
485
 
 
486
 
    def get_child(self, parent_id, child_name):
487
 
        return self._tree[parent_id].get(child_name)
 
1050
        return parent.file_id
488
1051
 
489
1052
 
490
1053
    def has_filename(self, names):
492
1055
 
493
1056
 
494
1057
    def has_id(self, file_id):
495
 
        assert isinstance(file_id, str)
496
1058
        return self._byid.has_key(file_id)
497
1059
 
498
1060
 
499
 
 
500
 
if __name__ == '__main__':
501
 
    import doctest, inventory
502
 
    doctest.testmod(inventory)
 
1061
    def rename(self, file_id, new_parent_id, new_name):
 
1062
        """Move a file within the inventory.
 
1063
 
 
1064
        This can change either the name, or the parent, or both.
 
1065
 
 
1066
        This does not move the working file."""
 
1067
        if not is_valid_name(new_name):
 
1068
            raise BzrError("not an acceptable filename: %r" % new_name)
 
1069
 
 
1070
        new_parent = self._byid[new_parent_id]
 
1071
        if new_name in new_parent.children:
 
1072
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
1073
 
 
1074
        new_parent_idpath = self.get_idpath(new_parent_id)
 
1075
        if file_id in new_parent_idpath:
 
1076
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
1077
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
 
1078
 
 
1079
        file_ie = self._byid[file_id]
 
1080
        old_parent = self._byid[file_ie.parent_id]
 
1081
 
 
1082
        # TODO: Don't leave things messed up if this fails
 
1083
 
 
1084
        del old_parent.children[file_ie.name]
 
1085
        new_parent.children[new_name] = file_ie
 
1086
        
 
1087
        file_ie.name = new_name
 
1088
        file_ie.parent_id = new_parent_id
 
1089
 
 
1090
 
 
1091
 
 
1092
 
 
1093
_NAME_RE = None
 
1094
 
 
1095
def is_valid_name(name):
 
1096
    global _NAME_RE
 
1097
    if _NAME_RE == None:
 
1098
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1099
        
 
1100
    return bool(_NAME_RE.match(name))