~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:51:05 UTC
  • Revision ID: mbp@sourcefrog.net-20050309045105-d02cd410a115da2c
import all docs from arch

Show diffs side-by-side

added added

removed removed

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