~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-06-10 09:08:09 UTC
  • Revision ID: mbp@sourcefrog.net-20050610090809-648401fe0bde7b7a
doc

Show diffs side-by-side

added added

removed removed

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