/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2006-06-04 10:55:31 UTC
  • mfrom: (1728.2.4 bzr.mbp.integration)
  • Revision ID: pqm@pqm.ubuntu.com-20060604105531-0071ce43b2156b7a
(mbp) several small fixes

Show diffs side-by-side

added added

removed removed

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