~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2006-06-04 22:13:03 UTC
  • mto: This revision was merged to the branch mainline in revision 1797.
  • Revision ID: mbp@sourcefrog.net-20060604221303-1f902e4ec57868d4
Show short form for OSError and IOError too

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
 
 
18
 
# TODO: Maybe store inventory_id in the file?  Not really needed.
19
 
 
 
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.
20
25
 
21
26
# This should really be an id randomly assigned when the tree is
22
27
# created, but it's not for now.
23
28
ROOT_ID = "TREE_ROOT"
24
29
 
25
30
 
26
 
import sys, os.path, types, re
27
 
from sets import Set
28
 
 
29
 
try:
30
 
    from cElementTree import Element, ElementTree, SubElement
31
 
except ImportError:
32
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
33
 
 
34
 
from xml import XMLMixin
35
 
from errors import bailout, BzrError
 
31
import collections
 
32
import os.path
 
33
import re
 
34
import sys
 
35
import tarfile
 
36
import types
36
37
 
37
38
import bzrlib
38
 
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)
39
43
from bzrlib.trace import mutter
40
44
 
41
 
class InventoryEntry(XMLMixin):
 
45
 
 
46
class InventoryEntry(object):
42
47
    """Description of a versioned file.
43
48
 
44
49
    An InventoryEntry has the following fields, which are also
45
50
    present in the XML inventory-entry element:
46
51
 
47
 
    * *file_id*
48
 
    * *name*: (only the basename within the directory, must not
49
 
      contain slashes)
50
 
    * *kind*: "directory" or "file"
51
 
    * *directory_id*: (if absent/null means the branch root directory)
52
 
    * *text_sha1*: only for files
53
 
    * *text_size*: in bytes, only for files 
54
 
    * *text_id*: identifier for the text version, only for files
55
 
 
56
 
    InventoryEntries can also exist inside a WorkingTree
57
 
    inventory, in which case they are not yet bound to a
58
 
    particular revision of the file.  In that case the text_sha1,
59
 
    text_size and text_id are absent.
60
 
 
 
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.)
61
75
 
62
76
    >>> i = Inventory()
63
77
    >>> i.path2id('')
64
78
    'TREE_ROOT'
65
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
66
 
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
67
 
    >>> for j in i.iter_entries():
68
 
    ...   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])
69
86
    ... 
70
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
71
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
72
 
    >>> 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'))
73
90
    Traceback (most recent call last):
74
91
    ...
75
 
    BzrError: ('inventory already contains entry with id {2323}', [])
76
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
77
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
92
    BzrError: inventory already contains entry with id {2323}
 
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')
78
97
    >>> i.path2id('src/wibble')
79
98
    '2325'
80
99
    >>> '2325' in i
81
100
    True
82
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
101
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
83
103
    >>> i['2326']
84
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
85
 
    >>> for j in i.iter_entries():
86
 
    ...     print j[0]
87
 
    ...     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)
88
108
    ... 
89
109
    src
90
110
    src/bye.c
93
113
    src/wibble/wibble.c
94
114
    >>> i.id2path('2326')
95
115
    'src/wibble/wibble.c'
96
 
 
97
 
    TODO: Maybe also keep the full path of the entry, and the children?
98
 
           But those depend on its position within a particular inventory, and
99
 
           it would be nice not to need to hold the backpointer here.
100
116
    """
101
117
 
102
 
    # TODO: split InventoryEntry into subclasses for files,
103
 
    # directories, etc etc.
 
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'
104
125
    
105
 
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
 
126
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
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):
106
272
        """Create an InventoryEntry
107
273
        
108
274
        The filename must be a single component, relative to the
109
275
        parent directory; it cannot be a whole path or relative name.
110
276
 
111
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
277
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
112
278
        >>> e.name
113
279
        'hello.c'
114
280
        >>> e.file_id
115
281
        '123'
116
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
282
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
117
283
        Traceback (most recent call last):
118
 
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
 
284
        InvalidEntryName: Invalid entry name: src/hello.c
119
285
        """
120
 
        
121
 
        if len(splitpath(name)) != 1:
122
 
            bailout('InventoryEntry name is not a simple filename: %r'
123
 
                    % name)
124
 
        
 
286
        assert isinstance(name, basestring), name
 
287
        if '/' in name or '\\' in name:
 
288
            raise InvalidEntryName(name=name)
 
289
        self.executable = False
 
290
        self.revision = None
 
291
        self.text_sha1 = None
 
292
        self.text_size = None
125
293
        self.file_id = file_id
126
294
        self.name = name
127
 
        self.kind = kind
128
295
        self.text_id = text_id
129
296
        self.parent_id = parent_id
130
 
        self.text_sha1 = None
131
 
        self.text_size = None
132
 
        if kind == 'directory':
133
 
            self.children = {}
134
 
        elif kind == 'file':
135
 
            pass
136
 
        else:
137
 
            raise BzrError("unhandled entry kind %r" % kind)
138
 
 
139
 
 
 
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))
140
326
 
141
327
    def sorted_children(self):
142
328
        l = self.children.items()
143
329
        l.sort()
144
330
        return l
145
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))
146
360
 
147
361
    def copy(self):
148
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
149
 
                               self.parent_id, text_id=self.text_id)
150
 
        other.text_sha1 = self.text_sha1
151
 
        other.text_size = self.text_size
152
 
        return other
153
 
 
 
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'
154
404
 
155
405
    def __repr__(self):
156
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
406
        return ("%s(%r, %r, parent_id=%r)"
157
407
                % (self.__class__.__name__,
158
408
                   self.file_id,
159
409
                   self.name,
160
 
                   self.kind,
161
410
                   self.parent_id))
162
411
 
163
 
    
164
 
    def to_element(self):
165
 
        """Convert to XML element"""
166
 
        e = Element('entry')
167
 
 
168
 
        e.set('name', self.name)
169
 
        e.set('file_id', self.file_id)
170
 
        e.set('kind', self.kind)
171
 
 
172
 
        if self.text_size != None:
173
 
            e.set('text_size', '%d' % self.text_size)
174
 
            
175
 
        for f in ['text_id', 'text_sha1']:
176
 
            v = getattr(self, f)
177
 
            if v != None:
178
 
                e.set(f, v)
179
 
 
180
 
        # to be conservative, we don't externalize the root pointers
181
 
        # for now, leaving them as null in the xml form.  in a future
182
 
        # version it will be implied by nested elements.
183
 
        if self.parent_id != ROOT_ID:
184
 
            assert isinstance(self.parent_id, basestring)
185
 
            e.set('parent_id', self.parent_id)
186
 
 
187
 
        e.tail = '\n'
188
 
            
189
 
        return e
190
 
 
191
 
 
192
 
    def from_element(cls, elt):
193
 
        assert elt.tag == 'entry'
194
 
 
195
 
        ## original format inventories don't have a parent_id for
196
 
        ## nodes in the root directory, but it's cleaner to use one
197
 
        ## internally.
198
 
        parent_id = elt.get('parent_id')
199
 
        if parent_id == None:
200
 
            parent_id = ROOT_ID
201
 
 
202
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
203
 
        self.text_id = elt.get('text_id')
204
 
        self.text_sha1 = elt.get('text_sha1')
205
 
        
206
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
207
 
 
208
 
        v = elt.get('text_size')
209
 
        self.text_size = v and int(v)
210
 
 
211
 
        return self
212
 
            
213
 
 
214
 
    from_element = classmethod(from_element)
215
 
 
216
 
    def __cmp__(self, other):
217
 
        if self is other:
218
 
            return 0
 
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)
 
455
 
 
456
    def __eq__(self, other):
219
457
        if not isinstance(other, InventoryEntry):
220
458
            return NotImplemented
221
459
 
222
 
        return cmp(self.file_id, other.file_id) \
223
 
               or cmp(self.name, other.name) \
224
 
               or cmp(self.text_sha1, other.text_sha1) \
225
 
               or cmp(self.text_size, other.text_size) \
226
 
               or cmp(self.text_id, other.text_id) \
227
 
               or cmp(self.parent_id, other.parent_id) \
228
 
               or cmp(self.kind, other.kind)
229
 
 
 
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
                )
 
471
 
 
472
    def __ne__(self, other):
 
473
        return not (self == other)
 
474
 
 
475
    def __hash__(self):
 
476
        raise ValueError('not hashable')
 
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
230
505
 
231
506
 
232
507
class RootEntry(InventoryEntry):
 
508
 
 
509
    def _check(self, checker, rev_id, tree):
 
510
        """See InventoryEntry._check"""
 
511
 
233
512
    def __init__(self, file_id):
234
513
        self.file_id = file_id
235
514
        self.children = {}
236
515
        self.kind = 'root_directory'
237
516
        self.parent_id = None
238
 
        self.name = ''
 
517
        self.name = u''
239
518
 
240
 
    def __cmp__(self, other):
241
 
        if self is other:
242
 
            return 0
 
519
    def __eq__(self, other):
243
520
        if not isinstance(other, RootEntry):
244
521
            return NotImplemented
245
 
        return cmp(self.file_id, other.file_id) \
246
 
               or cmp(self.children, other.children)
247
 
 
248
 
 
249
 
 
250
 
class Inventory(XMLMixin):
 
522
        
 
523
        return (self.file_id == other.file_id) \
 
524
               and (self.children == other.children)
 
525
 
 
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
 
 
797
 
 
798
class Inventory(object):
251
799
    """Inventory of versioned files in a tree.
252
800
 
253
801
    This describes which file_id is present at each point in the tree,
265
813
    inserted, other than through the Inventory API.
266
814
 
267
815
    >>> inv = Inventory()
268
 
    >>> inv.write_xml(sys.stdout)
269
 
    <inventory>
270
 
    </inventory>
271
 
    >>> 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')
272
818
    >>> inv['123-123'].name
273
819
    'hello.c'
274
820
 
282
828
    May also look up by name:
283
829
 
284
830
    >>> [x[0] for x in inv.iter_entries()]
285
 
    ['hello.c']
286
 
    
287
 
    >>> inv.write_xml(sys.stdout)
288
 
    <inventory>
289
 
    <entry file_id="123-123" kind="file" name="hello.c" />
290
 
    </inventory>
291
 
 
 
831
    [u'hello.c']
 
832
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
833
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
834
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
292
835
    """
293
 
 
294
 
    ## TODO: Make sure only canonical filenames are stored.
295
 
 
296
 
    ## TODO: Do something sensible about the possible collisions on
297
 
    ## case-losing filesystems.  Perhaps we should just always forbid
298
 
    ## such collisions.
299
 
 
300
 
    ## TODO: No special cases for root, rather just give it a file id
301
 
    ## like everything else.
302
 
 
303
 
    ## TODO: Probably change XML serialization to use nesting rather
304
 
    ## than parent_id pointers.
305
 
 
306
 
    ## TODO: Perhaps hold the ElementTree in memory and work directly
307
 
    ## on that rather than converting into Python objects every time?
308
 
 
309
 
    def __init__(self):
 
836
    def __init__(self, root_id=ROOT_ID, revision_id=None):
310
837
        """Create or read an inventory.
311
838
 
312
839
        If a working directory is specified, the inventory is read
316
843
        The inventory is created with a default root directory, with
317
844
        an id of None.
318
845
        """
319
 
        self.root = RootEntry(ROOT_ID)
 
846
        # We are letting Branch.create() create a unique inventory
 
847
        # root id. Rather than generating a random one here.
 
848
        #if root_id is None:
 
849
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
850
        self.root = RootEntry(root_id)
 
851
        self.revision_id = revision_id
320
852
        self._byid = {self.root.file_id: self.root}
321
853
 
322
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
 
323
867
    def __iter__(self):
324
868
        return iter(self._byid)
325
869
 
337
881
        elif isinstance(from_dir, basestring):
338
882
            from_dir = self._byid[from_dir]
339
883
            
340
 
        kids = from_dir.children.items()
341
 
        kids.sort()
342
 
        for name, ie in kids:
343
 
            yield name, ie
344
 
            if ie.kind == 'directory':
345
 
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
346
 
                    yield os.path.join(name, cn), cie
347
 
                    
 
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()
 
917
 
 
918
    def entries(self):
 
919
        """Return list of (path, ie) for all entries except the root.
 
920
 
 
921
        This may be faster than iter_entries.
 
922
        """
 
923
        accum = []
 
924
        def descend(dir_ie, dir_path):
 
925
            kids = dir_ie.children.items()
 
926
            kids.sort()
 
927
            for name, ie in kids:
 
928
                child_path = pathjoin(dir_path, name)
 
929
                accum.append((child_path, ie))
 
930
                if ie.kind == 'directory':
 
931
                    descend(ie, child_path)
 
932
 
 
933
        descend(self.root, u'')
 
934
        return accum
348
935
 
349
936
 
350
937
    def directories(self):
351
 
        """Return (path, entry) pairs for all directories.
 
938
        """Return (path, entry) pairs for all directories, including the root.
352
939
        """
353
 
        def descend(parent_ie):
354
 
            parent_name = parent_ie.name
355
 
            yield parent_name, parent_ie
356
 
 
357
 
            # directory children in sorted order
358
 
            dn = []
359
 
            for ie in parent_ie.children.itervalues():
360
 
                if ie.kind == 'directory':
361
 
                    dn.append((ie.name, ie))
362
 
            dn.sort()
 
940
        accum = []
 
941
        def descend(parent_ie, parent_path):
 
942
            accum.append((parent_path, parent_ie))
363
943
            
364
 
            for name, child_ie in dn:
365
 
                for sub_name, sub_ie in descend(child_ie):
366
 
                    yield appendpath(parent_name, sub_name), sub_ie
 
944
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
945
            kids.sort()
367
946
 
368
 
        for name, ie in descend(self.root):
369
 
            yield name, ie
 
947
            for name, child_ie in kids:
 
948
                child_path = pathjoin(parent_path, name)
 
949
                descend(child_ie, child_path)
 
950
        descend(self.root, u'')
 
951
        return accum
370
952
        
371
953
 
372
954
 
374
956
        """True if this entry contains a file with given id.
375
957
 
376
958
        >>> inv = Inventory()
377
 
        >>> 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')
378
961
        >>> '123' in inv
379
962
        True
380
963
        >>> '456' in inv
387
970
        """Return the entry for given file_id.
388
971
 
389
972
        >>> inv = Inventory()
390
 
        >>> 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')
391
975
        >>> inv['123123'].name
392
976
        'hello.c'
393
977
        """
394
 
        if file_id == None:
395
 
            raise BzrError("can't look up file_id None")
396
 
            
397
978
        try:
398
979
            return self._byid[file_id]
399
980
        except KeyError:
400
 
            raise BzrError("file_id {%s} not in inventory" % file_id)
401
 
 
 
981
            if file_id == None:
 
982
                raise BzrError("can't look up file_id None")
 
983
            else:
 
984
                raise BzrError("file_id {%s} not in inventory" % file_id)
 
985
 
 
986
 
 
987
    def get_file_kind(self, file_id):
 
988
        return self._byid[file_id].kind
402
989
 
403
990
    def get_child(self, parent_id, filename):
404
991
        return self[parent_id].children.get(filename)
408
995
        """Add entry to inventory.
409
996
 
410
997
        To add  a file to a branch ready to be committed, use Branch.add,
411
 
        which calls this."""
 
998
        which calls this.
 
999
 
 
1000
        Returns the new entry object.
 
1001
        """
412
1002
        if entry.file_id in self._byid:
413
 
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
 
1003
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
1004
 
 
1005
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
1006
            entry.parent_id = self.root.file_id
414
1007
 
415
1008
        try:
416
1009
            parent = self._byid[entry.parent_id]
417
1010
        except KeyError:
418
 
            bailout("parent_id {%s} not in inventory" % entry.parent_id)
 
1011
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
419
1012
 
420
1013
        if parent.children.has_key(entry.name):
421
 
            bailout("%s is already versioned" %
422
 
                    appendpath(self.id2path(parent.file_id), entry.name))
 
1014
            raise BzrError("%s is already versioned" %
 
1015
                    pathjoin(self.id2path(parent.file_id), entry.name))
423
1016
 
424
1017
        self._byid[entry.file_id] = entry
425
1018
        parent.children[entry.name] = entry
426
 
 
427
 
 
428
 
    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):
429
1023
        """Add entry from a path.
430
1024
 
431
 
        The immediate parent must already be versioned"""
 
1025
        The immediate parent must already be versioned.
 
1026
 
 
1027
        Returns the new entry object."""
 
1028
        
432
1029
        parts = bzrlib.osutils.splitpath(relpath)
 
1030
 
433
1031
        if len(parts) == 0:
434
 
            bailout("cannot re-add root of inventory")
435
 
 
436
 
        if file_id == None:
437
 
            file_id = bzrlib.branch.gen_file_id(relpath)
438
 
 
439
 
        parent_id = self.path2id(parts[:-1])
440
 
        assert parent_id != None
441
 
        ie = InventoryEntry(file_id, parts[-1],
442
 
                            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)
443
1043
        return self.add(ie)
444
1044
 
445
 
 
446
1045
    def __delitem__(self, file_id):
447
1046
        """Remove entry by id.
448
1047
 
449
1048
        >>> inv = Inventory()
450
 
        >>> 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')
451
1051
        >>> '123' in inv
452
1052
        True
453
1053
        >>> del inv['123']
456
1056
        """
457
1057
        ie = self[file_id]
458
1058
 
459
 
        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
460
1061
        
461
 
        # TODO: Test deleting all children; maybe hoist to a separate
462
 
        # deltree method?
463
 
        if ie.kind == 'directory':
464
 
            for cie in ie.children.values():
465
 
                del self[cie.file_id]
466
 
            del ie.children
467
 
 
468
1062
        del self._byid[file_id]
469
 
        del self[ie.parent_id].children[ie.name]
470
 
 
471
 
 
472
 
    def id_set(self):
473
 
        return Set(self._byid)
474
 
 
475
 
 
476
 
    def to_element(self):
477
 
        """Convert to XML Element"""
478
 
        e = Element('inventory')
479
 
        e.text = '\n'
480
 
        for path, ie in self.iter_entries():
481
 
            e.append(ie.to_element())
482
 
        return e
483
 
    
484
 
 
485
 
    def from_element(cls, elt):
486
 
        """Construct from XML Element
487
 
 
488
 
        >>> inv = Inventory()
489
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
490
 
        >>> elt = inv.to_element()
491
 
        >>> inv2 = Inventory.from_element(elt)
492
 
        >>> inv2 == inv
493
 
        True
494
 
        """
495
 
        assert elt.tag == 'inventory'
496
 
        o = cls()
497
 
        for e in elt:
498
 
            o.add(InventoryEntry.from_element(e))
499
 
        return o
500
 
        
501
 
    from_element = classmethod(from_element)
502
 
 
503
 
 
504
 
    def __cmp__(self, other):
 
1063
        if ie.parent_id is not None:
 
1064
            del self[ie.parent_id].children[ie.name]
 
1065
 
 
1066
 
 
1067
    def __eq__(self, other):
505
1068
        """Compare two sets by comparing their contents.
506
1069
 
507
1070
        >>> i1 = Inventory()
508
1071
        >>> i2 = Inventory()
509
1072
        >>> i1 == i2
510
1073
        True
511
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1074
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
1075
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
512
1076
        >>> i1 == i2
513
1077
        False
514
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1078
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
1079
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
515
1080
        >>> i1 == i2
516
1081
        True
517
1082
        """
518
 
        if self is other:
519
 
            return 0
520
 
        
521
1083
        if not isinstance(other, Inventory):
522
1084
            return NotImplemented
523
1085
 
524
 
        if self.id_set() ^ other.id_set():
525
 
            return 1
526
 
 
527
 
        for file_id in self._byid:
528
 
            c = cmp(self[file_id], other[file_id])
529
 
            if c: return c
530
 
 
531
 
        return 0
532
 
 
 
1086
        if len(self._byid) != len(other._byid):
 
1087
            # shortcut: obviously not the same
 
1088
            return False
 
1089
 
 
1090
        return self._byid == other._byid
 
1091
 
 
1092
 
 
1093
    def __ne__(self, other):
 
1094
        return not self.__eq__(other)
 
1095
 
 
1096
 
 
1097
    def __hash__(self):
 
1098
        raise ValueError('not hashable')
 
1099
 
 
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
533
1109
 
534
1110
    def get_idpath(self, file_id):
535
1111
        """Return a list of file_ids for the path to an entry.
540
1116
        root directory as depth 1.
541
1117
        """
542
1118
        p = []
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
 
1119
        for parent in self._iter_file_id_parents(file_id):
 
1120
            p.insert(0, parent.file_id)
550
1121
        return p
551
1122
 
552
 
 
553
1123
    def id2path(self, file_id):
554
 
        """Return as a list the path to file_id."""
555
 
 
 
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
        """
556
1132
        # get all names, skipping root
557
 
        p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
558
 
        return os.sep.join(p)
 
1133
        return '/'.join(reversed(
 
1134
            [parent.name for parent in 
 
1135
             self._iter_file_id_parents(file_id)][:-1]))
559
1136
            
560
 
 
561
 
 
562
1137
    def path2id(self, name):
563
1138
        """Walk down through directories to return entry of last component.
564
1139
 
568
1143
        This returns the entry of the last component in the path,
569
1144
        which may be either a file or a directory.
570
1145
 
571
 
        Returns None iff the path is not found.
 
1146
        Returns None IFF the path is not found.
572
1147
        """
573
1148
        if isinstance(name, types.StringTypes):
574
1149
            name = splitpath(name)
575
1150
 
576
 
        mutter("lookup path %r" % name)
 
1151
        # mutter("lookup path %r" % name)
577
1152
 
578
1153
        parent = self.root
579
1154
        for f in name:
604
1179
 
605
1180
        This does not move the working file."""
606
1181
        if not is_valid_name(new_name):
607
 
            bailout("not an acceptable filename: %r" % new_name)
 
1182
            raise BzrError("not an acceptable filename: %r" % new_name)
608
1183
 
609
1184
        new_parent = self._byid[new_parent_id]
610
1185
        if new_name in new_parent.children:
611
 
            bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
1186
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
612
1187
 
613
1188
        new_parent_idpath = self.get_idpath(new_parent_id)
614
1189
        if file_id in new_parent_idpath:
615
 
            bailout("cannot move directory %r into a subdirectory of itself, %r"
 
1190
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
616
1191
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
617
1192
 
618
1193
        file_ie = self._byid[file_id]
627
1202
        file_ie.parent_id = new_parent_id
628
1203
 
629
1204
 
630
 
 
631
 
 
632
 
_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
633
1227
 
634
1228
def is_valid_name(name):
 
1229
    global _NAME_RE
 
1230
    if _NAME_RE == None:
 
1231
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1232
        
635
1233
    return bool(_NAME_RE.match(name))