~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

Always include working tree when calculating file ids for diff

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', revision=None)
 
81
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
 
82
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
 
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', revision=None))
 
88
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
 
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', sha1=None, len=None)
 
95
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
 
96
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
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', sha1=None, len=None)
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', sha1=None, len=None)
 
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__ = []
 
127
 
 
128
    def detect_changes(self, old_entry):
 
129
        """Return a (text_modified, meta_modified) from this to old_entry.
 
130
        
 
131
        _read_tree_state must have been called on self and old_entry prior to 
 
132
        calling detect_changes.
 
133
        """
 
134
        return False, False
 
135
 
 
136
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
137
             output_to, reverse=False):
 
138
        """Perform a diff from this to to_entry.
 
139
 
 
140
        text_diff will be used for textual difference calculation.
 
141
        This is a template method, override _diff in child classes.
 
142
        """
 
143
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
144
        if to_entry:
 
145
            # cannot diff from one kind to another - you must do a removal
 
146
            # and an addif they do not match.
 
147
            assert self.kind == to_entry.kind
 
148
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
149
                                      to_tree)
 
150
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
151
                   output_to, reverse)
 
152
 
 
153
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
154
             output_to, reverse=False):
 
155
        """Perform a diff between two entries of the same kind."""
 
156
 
 
157
    def find_previous_heads(self, previous_inventories,
 
158
                            versioned_file_store,
 
159
                            transaction,
 
160
                            entry_vf=None):
 
161
        """Return the revisions and entries that directly precede this.
 
162
 
 
163
        Returned as a map from revision to inventory entry.
 
164
 
 
165
        This is a map containing the file revisions in all parents
 
166
        for which the file exists, and its revision is not a parent of
 
167
        any other. If the file is new, the set will be empty.
 
168
 
 
169
        :param versioned_file_store: A store where ancestry data on this
 
170
                                     file id can be queried.
 
171
        :param transaction: The transaction that queries to the versioned 
 
172
                            file store should be completed under.
 
173
        :param entry_vf: The entry versioned file, if its already available.
 
174
        """
 
175
        def get_ancestors(weave, entry):
 
176
            return set(weave.get_ancestry(entry.revision))
 
177
        # revision:ie mapping for each ie found in previous_inventories.
 
178
        candidates = {}
 
179
        # revision:ie mapping with one revision for each head.
 
180
        heads = {}
 
181
        # revision: ancestor list for each head
 
182
        head_ancestors = {}
 
183
        # identify candidate head revision ids.
 
184
        for inv in previous_inventories:
 
185
            if self.file_id in inv:
 
186
                ie = inv[self.file_id]
 
187
                assert ie.file_id == self.file_id
 
188
                if ie.revision in candidates:
 
189
                    # same revision value in two different inventories:
 
190
                    # correct possible inconsistencies:
 
191
                    #     * there was a bug in revision updates with 'x' bit 
 
192
                    #       support.
 
193
                    try:
 
194
                        if candidates[ie.revision].executable != ie.executable:
 
195
                            candidates[ie.revision].executable = False
 
196
                            ie.executable = False
 
197
                    except AttributeError:
 
198
                        pass
 
199
                    # must now be the same.
 
200
                    assert candidates[ie.revision] == ie
 
201
                else:
 
202
                    # add this revision as a candidate.
 
203
                    candidates[ie.revision] = ie
 
204
 
 
205
        # common case optimisation
 
206
        if len(candidates) == 1:
 
207
            # if there is only one candidate revision found
 
208
            # then we can opening the versioned file to access ancestry:
 
209
            # there cannot be any ancestors to eliminate when there is 
 
210
            # only one revision available.
 
211
            heads[ie.revision] = ie
 
212
            return heads
 
213
 
 
214
        # eliminate ancestors amongst the available candidates:
 
215
        # heads are those that are not an ancestor of any other candidate
 
216
        # - this provides convergence at a per-file level.
 
217
        for ie in candidates.values():
 
218
            # may be an ancestor of a known head:
 
219
            already_present = 0 != len(
 
220
                [head for head in heads 
 
221
                 if ie.revision in head_ancestors[head]])
 
222
            if already_present:
 
223
                # an ancestor of an analyzed candidate.
 
224
                continue
 
225
            # not an ancestor of a known head:
 
226
            # load the versioned file for this file id if needed
 
227
            if entry_vf is None:
 
228
                entry_vf = versioned_file_store.get_weave_or_empty(
 
229
                    self.file_id, transaction)
 
230
            ancestors = get_ancestors(entry_vf, ie)
 
231
            # may knock something else out:
 
232
            check_heads = list(heads.keys())
 
233
            for head in check_heads:
 
234
                if head in ancestors:
 
235
                    # this previously discovered 'head' is not
 
236
                    # really a head - its an ancestor of the newly 
 
237
                    # found head,
 
238
                    heads.pop(head)
 
239
            head_ancestors[ie.revision] = ancestors
 
240
            heads[ie.revision] = ie
 
241
        return heads
 
242
 
 
243
    def get_tar_item(self, root, dp, now, tree):
 
244
        """Get a tarfile item and a file stream for its content."""
 
245
        item = tarfile.TarInfo(pathjoin(root, dp))
 
246
        # TODO: would be cool to actually set it to the timestamp of the
 
247
        # revision it was last changed
 
248
        item.mtime = now
 
249
        fileobj = self._put_in_tar(item, tree)
 
250
        return item, fileobj
 
251
 
 
252
    def has_text(self):
 
253
        """Return true if the object this entry represents has textual data.
 
254
 
 
255
        Note that textual data includes binary content.
 
256
 
 
257
        Also note that all entries get weave files created for them.
 
258
        This attribute is primarily used when upgrading from old trees that
 
259
        did not have the weave index for all inventory entries.
 
260
        """
 
261
        return False
 
262
 
 
263
    def __init__(self, file_id, name, parent_id, text_id=None):
106
264
        """Create an InventoryEntry
107
265
        
108
266
        The filename must be a single component, relative to the
109
267
        parent directory; it cannot be a whole path or relative name.
110
268
 
111
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
269
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
112
270
        >>> e.name
113
271
        'hello.c'
114
272
        >>> e.file_id
115
273
        '123'
116
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
274
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
117
275
        Traceback (most recent call last):
118
 
        BzrError: ("InventoryEntry name is not a simple filename: 'src/hello.c'", [])
 
276
        InvalidEntryName: Invalid entry name: src/hello.c
119
277
        """
120
 
        
121
 
        if len(splitpath(name)) != 1:
122
 
            bailout('InventoryEntry name is not a simple filename: %r'
123
 
                    % name)
124
 
        
 
278
        assert isinstance(name, basestring), name
 
279
        if '/' in name or '\\' in name:
 
280
            raise InvalidEntryName(name=name)
 
281
        self.executable = False
 
282
        self.revision = None
 
283
        self.text_sha1 = None
 
284
        self.text_size = None
125
285
        self.file_id = file_id
126
286
        self.name = name
127
 
        self.kind = kind
128
287
        self.text_id = text_id
129
288
        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
 
 
 
289
        self.symlink_target = None
 
290
 
 
291
    def kind_character(self):
 
292
        """Return a short kind indicator useful for appending to names."""
 
293
        raise BzrError('unknown kind %r' % self.kind)
 
294
 
 
295
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
296
 
 
297
    def _put_in_tar(self, item, tree):
 
298
        """populate item for stashing in a tar, and return the content stream.
 
299
 
 
300
        If no content is available, return None.
 
301
        """
 
302
        raise BzrError("don't know how to export {%s} of kind %r" %
 
303
                       (self.file_id, self.kind))
 
304
 
 
305
    def put_on_disk(self, dest, dp, tree):
 
306
        """Create a representation of self on disk in the prefix dest.
 
307
        
 
308
        This is a template method - implement _put_on_disk in subclasses.
 
309
        """
 
310
        fullpath = pathjoin(dest, dp)
 
311
        self._put_on_disk(fullpath, tree)
 
312
        mutter("  export {%s} kind %s to %s", self.file_id,
 
313
                self.kind, fullpath)
 
314
 
 
315
    def _put_on_disk(self, fullpath, tree):
 
316
        """Put this entry onto disk at fullpath, from tree tree."""
 
317
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
140
318
 
141
319
    def sorted_children(self):
142
 
        l = self.children.items()
143
 
        l.sort()
144
 
        return l
145
 
 
 
320
        return sorted(self.children.items())
 
321
 
 
322
    @staticmethod
 
323
    def versionable_kind(kind):
 
324
        return kind in ('file', 'directory', 'symlink')
 
325
 
 
326
    def check(self, checker, rev_id, inv, tree):
 
327
        """Check this inventory entry is intact.
 
328
 
 
329
        This is a template method, override _check for kind specific
 
330
        tests.
 
331
 
 
332
        :param checker: Check object providing context for the checks; 
 
333
             can be used to find out what parts of the repository have already
 
334
             been checked.
 
335
        :param rev_id: Revision id from which this InventoryEntry was loaded.
 
336
             Not necessarily the last-changed revision for this file.
 
337
        :param inv: Inventory from which the entry was loaded.
 
338
        :param tree: RevisionTree for this entry.
 
339
        """
 
340
        if self.parent_id is not None:
 
341
            if not inv.has_id(self.parent_id):
 
342
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
343
                        % (self.parent_id, rev_id))
 
344
        self._check(checker, rev_id, tree)
 
345
 
 
346
    def _check(self, checker, rev_id, tree):
 
347
        """Check this inventory entry for kind specific errors."""
 
348
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
349
                            (self.kind, rev_id))
146
350
 
147
351
    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
 
 
 
352
        """Clone this inventory entry."""
 
353
        raise NotImplementedError
 
354
 
 
355
    @staticmethod
 
356
    def describe_change(old_entry, new_entry):
 
357
        """Describe the change between old_entry and this.
 
358
        
 
359
        This smells of being an InterInventoryEntry situation, but as its
 
360
        the first one, we're making it a static method for now.
 
361
 
 
362
        An entry with a different parent, or different name is considered 
 
363
        to be renamed. Reparenting is an internal detail.
 
364
        Note that renaming the parent does not trigger a rename for the
 
365
        child entry itself.
 
366
        """
 
367
        # TODO: Perhaps return an object rather than just a string
 
368
        if old_entry is new_entry:
 
369
            # also the case of both being None
 
370
            return 'unchanged'
 
371
        elif old_entry is None:
 
372
            return 'added'
 
373
        elif new_entry is None:
 
374
            return 'removed'
 
375
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
376
        if text_modified or meta_modified:
 
377
            modified = True
 
378
        else:
 
379
            modified = False
 
380
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
 
381
        if old_entry.parent_id != new_entry.parent_id:
 
382
            renamed = True
 
383
        elif old_entry.name != new_entry.name:
 
384
            renamed = True
 
385
        else:
 
386
            renamed = False
 
387
        if renamed and not modified:
 
388
            return InventoryEntry.RENAMED
 
389
        if modified and not renamed:
 
390
            return 'modified'
 
391
        if modified and renamed:
 
392
            return InventoryEntry.MODIFIED_AND_RENAMED
 
393
        return 'unchanged'
154
394
 
155
395
    def __repr__(self):
156
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
396
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
157
397
                % (self.__class__.__name__,
158
398
                   self.file_id,
159
399
                   self.name,
160
 
                   self.kind,
161
 
                   self.parent_id))
162
 
 
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
 
400
                   self.parent_id,
 
401
                   self.revision))
 
402
 
 
403
    def snapshot(self, revision, path, previous_entries,
 
404
                 work_tree, commit_builder):
 
405
        """Make a snapshot of this entry which may or may not have changed.
 
406
        
 
407
        This means that all its fields are populated, that it has its
 
408
        text stored in the text store or weave.
 
409
        """
 
410
        mutter('new parents of %s are %r', path, previous_entries)
 
411
        self._read_tree_state(path, work_tree)
 
412
        # TODO: Where should we determine whether to reuse a
 
413
        # previous revision id or create a new revision? 20060606
 
414
        if len(previous_entries) == 1:
 
415
            # cannot be unchanged unless there is only one parent file rev.
 
416
            parent_ie = previous_entries.values()[0]
 
417
            if self._unchanged(parent_ie):
 
418
                mutter("found unchanged entry")
 
419
                self.revision = parent_ie.revision
 
420
                return "unchanged"
 
421
        return self._snapshot_into_revision(revision, previous_entries, 
 
422
                                            work_tree, commit_builder)
 
423
 
 
424
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
 
425
                                commit_builder):
 
426
        """Record this revision unconditionally into a store.
 
427
 
 
428
        The entry's last-changed revision property (`revision`) is updated to 
 
429
        that of the new revision.
 
430
        
 
431
        :param revision: id of the new revision that is being recorded.
 
432
 
 
433
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
 
434
        """
 
435
        mutter('new revision {%s} for {%s}', revision, self.file_id)
 
436
        self.revision = revision
 
437
        self._snapshot_text(previous_entries, work_tree, commit_builder)
 
438
 
 
439
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
 
440
        """Record the 'text' of this entry, whatever form that takes.
 
441
        
 
442
        This default implementation simply adds an empty text.
 
443
        """
 
444
        raise NotImplementedError(self._snapshot_text)
 
445
 
 
446
    def __eq__(self, other):
219
447
        if not isinstance(other, InventoryEntry):
220
448
            return NotImplemented
221
449
 
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
 
 
 
450
        return ((self.file_id == other.file_id)
 
451
                and (self.name == other.name)
 
452
                and (other.symlink_target == self.symlink_target)
 
453
                and (self.text_sha1 == other.text_sha1)
 
454
                and (self.text_size == other.text_size)
 
455
                and (self.text_id == other.text_id)
 
456
                and (self.parent_id == other.parent_id)
 
457
                and (self.kind == other.kind)
 
458
                and (self.revision == other.revision)
 
459
                and (self.executable == other.executable)
 
460
                )
 
461
 
 
462
    def __ne__(self, other):
 
463
        return not (self == other)
 
464
 
 
465
    def __hash__(self):
 
466
        raise ValueError('not hashable')
 
467
 
 
468
    def _unchanged(self, previous_ie):
 
469
        """Has this entry changed relative to previous_ie.
 
470
 
 
471
        This method should be overridden in child classes.
 
472
        """
 
473
        compatible = True
 
474
        # different inv parent
 
475
        if previous_ie.parent_id != self.parent_id:
 
476
            compatible = False
 
477
        # renamed
 
478
        elif previous_ie.name != self.name:
 
479
            compatible = False
 
480
        return compatible
 
481
 
 
482
    def _read_tree_state(self, path, work_tree):
 
483
        """Populate fields in the inventory entry from the given tree.
 
484
        
 
485
        Note that this should be modified to be a noop on virtual trees
 
486
        as all entries created there are prepopulated.
 
487
        """
 
488
        # TODO: Rather than running this manually, we should check the 
 
489
        # working sha1 and other expensive properties when they're
 
490
        # first requested, or preload them if they're already known
 
491
        pass            # nothing to do by default
 
492
 
 
493
    def _forget_tree_state(self):
 
494
        pass
230
495
 
231
496
 
232
497
class RootEntry(InventoryEntry):
 
498
 
 
499
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
500
                 'text_id', 'parent_id', 'children', 'executable', 
 
501
                 'revision', 'symlink_target']
 
502
 
 
503
    def _check(self, checker, rev_id, tree):
 
504
        """See InventoryEntry._check"""
 
505
 
233
506
    def __init__(self, file_id):
234
507
        self.file_id = file_id
235
508
        self.children = {}
236
509
        self.kind = 'root_directory'
237
510
        self.parent_id = None
238
 
        self.name = ''
 
511
        self.name = u''
 
512
        self.revision = None
239
513
 
240
 
    def __cmp__(self, other):
241
 
        if self is other:
242
 
            return 0
 
514
    def __eq__(self, other):
243
515
        if not isinstance(other, RootEntry):
244
516
            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):
 
517
        
 
518
        return (self.file_id == other.file_id) \
 
519
               and (self.children == other.children)
 
520
 
 
521
 
 
522
class InventoryDirectory(InventoryEntry):
 
523
    """A directory in an inventory."""
 
524
 
 
525
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
526
                 'text_id', 'parent_id', 'children', 'executable', 
 
527
                 'revision', 'symlink_target']
 
528
 
 
529
    def _check(self, checker, rev_id, tree):
 
530
        """See InventoryEntry._check"""
 
531
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
532
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
533
                                % (self.file_id, rev_id))
 
534
 
 
535
    def copy(self):
 
536
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
537
        other.revision = self.revision
 
538
        # note that children are *not* copied; they're pulled across when
 
539
        # others are added
 
540
        return other
 
541
 
 
542
    def __init__(self, file_id, name, parent_id):
 
543
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
544
        self.children = {}
 
545
        self.kind = 'directory'
 
546
 
 
547
    def kind_character(self):
 
548
        """See InventoryEntry.kind_character."""
 
549
        return '/'
 
550
 
 
551
    def _put_in_tar(self, item, tree):
 
552
        """See InventoryEntry._put_in_tar."""
 
553
        item.type = tarfile.DIRTYPE
 
554
        fileobj = None
 
555
        item.name += '/'
 
556
        item.size = 0
 
557
        item.mode = 0755
 
558
        return fileobj
 
559
 
 
560
    def _put_on_disk(self, fullpath, tree):
 
561
        """See InventoryEntry._put_on_disk."""
 
562
        os.mkdir(fullpath)
 
563
 
 
564
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
565
        """See InventoryEntry._snapshot_text."""
 
566
        commit_builder.modified_directory(self.file_id, file_parents)
 
567
 
 
568
 
 
569
class InventoryFile(InventoryEntry):
 
570
    """A file in an inventory."""
 
571
 
 
572
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
573
                 'text_id', 'parent_id', 'children', 'executable', 
 
574
                 'revision', 'symlink_target']
 
575
 
 
576
    def _check(self, checker, tree_revision_id, tree):
 
577
        """See InventoryEntry._check"""
 
578
        t = (self.file_id, self.revision)
 
579
        if t in checker.checked_texts:
 
580
            prev_sha = checker.checked_texts[t]
 
581
            if prev_sha != self.text_sha1:
 
582
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
583
                                    (self.file_id, tree_revision_id))
 
584
            else:
 
585
                checker.repeated_text_cnt += 1
 
586
                return
 
587
 
 
588
        if self.file_id not in checker.checked_weaves:
 
589
            mutter('check weave {%s}', self.file_id)
 
590
            w = tree.get_weave(self.file_id)
 
591
            # Not passing a progress bar, because it creates a new
 
592
            # progress, which overwrites the current progress,
 
593
            # and doesn't look nice
 
594
            w.check()
 
595
            checker.checked_weaves[self.file_id] = True
 
596
        else:
 
597
            w = tree.get_weave(self.file_id)
 
598
 
 
599
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
 
600
        checker.checked_text_cnt += 1
 
601
        # We can't check the length, because Weave doesn't store that
 
602
        # information, and the whole point of looking at the weave's
 
603
        # sha1sum is that we don't have to extract the text.
 
604
        if self.text_sha1 != w.get_sha1(self.revision):
 
605
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
 
606
                                % (self.file_id, self.revision))
 
607
        checker.checked_texts[t] = self.text_sha1
 
608
 
 
609
    def copy(self):
 
610
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
611
        other.executable = self.executable
 
612
        other.text_id = self.text_id
 
613
        other.text_sha1 = self.text_sha1
 
614
        other.text_size = self.text_size
 
615
        other.revision = self.revision
 
616
        return other
 
617
 
 
618
    def detect_changes(self, old_entry):
 
619
        """See InventoryEntry.detect_changes."""
 
620
        assert self.text_sha1 is not None
 
621
        assert old_entry.text_sha1 is not None
 
622
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
623
        meta_modified = (self.executable != old_entry.executable)
 
624
        return text_modified, meta_modified
 
625
 
 
626
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
627
             output_to, reverse=False):
 
628
        """See InventoryEntry._diff."""
 
629
        try:
 
630
            from_text = tree.get_file(self.file_id).readlines()
 
631
            if to_entry:
 
632
                to_text = to_tree.get_file(to_entry.file_id).readlines()
 
633
            else:
 
634
                to_text = []
 
635
            if not reverse:
 
636
                text_diff(from_label, from_text,
 
637
                          to_label, to_text, output_to)
 
638
            else:
 
639
                text_diff(to_label, to_text,
 
640
                          from_label, from_text, output_to)
 
641
        except BinaryFile:
 
642
            if reverse:
 
643
                label_pair = (to_label, from_label)
 
644
            else:
 
645
                label_pair = (from_label, to_label)
 
646
            print >> output_to, "Binary files %s and %s differ" % label_pair
 
647
 
 
648
    def has_text(self):
 
649
        """See InventoryEntry.has_text."""
 
650
        return True
 
651
 
 
652
    def __init__(self, file_id, name, parent_id):
 
653
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
654
        self.kind = 'file'
 
655
 
 
656
    def kind_character(self):
 
657
        """See InventoryEntry.kind_character."""
 
658
        return ''
 
659
 
 
660
    def _put_in_tar(self, item, tree):
 
661
        """See InventoryEntry._put_in_tar."""
 
662
        item.type = tarfile.REGTYPE
 
663
        fileobj = tree.get_file(self.file_id)
 
664
        item.size = self.text_size
 
665
        if tree.is_executable(self.file_id):
 
666
            item.mode = 0755
 
667
        else:
 
668
            item.mode = 0644
 
669
        return fileobj
 
670
 
 
671
    def _put_on_disk(self, fullpath, tree):
 
672
        """See InventoryEntry._put_on_disk."""
 
673
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
674
        if tree.is_executable(self.file_id):
 
675
            os.chmod(fullpath, 0755)
 
676
 
 
677
    def _read_tree_state(self, path, work_tree):
 
678
        """See InventoryEntry._read_tree_state."""
 
679
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
 
680
        # FIXME: 20050930 probe for the text size when getting sha1
 
681
        # in _read_tree_state
 
682
        self.executable = work_tree.is_executable(self.file_id, path=path)
 
683
 
 
684
    def __repr__(self):
 
685
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
 
686
                % (self.__class__.__name__,
 
687
                   self.file_id,
 
688
                   self.name,
 
689
                   self.parent_id,
 
690
                   self.text_sha1,
 
691
                   self.text_size))
 
692
 
 
693
    def _forget_tree_state(self):
 
694
        self.text_sha1 = None
 
695
 
 
696
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
697
        """See InventoryEntry._snapshot_text."""
 
698
        def get_content_byte_lines():
 
699
            return work_tree.get_file(self.file_id).readlines()
 
700
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
 
701
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
 
702
 
 
703
    def _unchanged(self, previous_ie):
 
704
        """See InventoryEntry._unchanged."""
 
705
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
706
        if self.text_sha1 != previous_ie.text_sha1:
 
707
            compatible = False
 
708
        else:
 
709
            # FIXME: 20050930 probe for the text size when getting sha1
 
710
            # in _read_tree_state
 
711
            self.text_size = previous_ie.text_size
 
712
        if self.executable != previous_ie.executable:
 
713
            compatible = False
 
714
        return compatible
 
715
 
 
716
 
 
717
class InventoryLink(InventoryEntry):
 
718
    """A file in an inventory."""
 
719
 
 
720
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
721
                 'text_id', 'parent_id', 'children', 'executable', 
 
722
                 'revision', 'symlink_target']
 
723
 
 
724
    def _check(self, checker, rev_id, tree):
 
725
        """See InventoryEntry._check"""
 
726
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
727
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
728
                    % (self.file_id, rev_id))
 
729
        if self.symlink_target is None:
 
730
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
731
                    % (self.file_id, rev_id))
 
732
 
 
733
    def copy(self):
 
734
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
735
        other.symlink_target = self.symlink_target
 
736
        other.revision = self.revision
 
737
        return other
 
738
 
 
739
    def detect_changes(self, old_entry):
 
740
        """See InventoryEntry.detect_changes."""
 
741
        # FIXME: which _modified field should we use ? RBC 20051003
 
742
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
743
        if text_modified:
 
744
            mutter("    symlink target changed")
 
745
        meta_modified = False
 
746
        return text_modified, meta_modified
 
747
 
 
748
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
749
             output_to, reverse=False):
 
750
        """See InventoryEntry._diff."""
 
751
        from_text = self.symlink_target
 
752
        if to_entry is not None:
 
753
            to_text = to_entry.symlink_target
 
754
            if reverse:
 
755
                temp = from_text
 
756
                from_text = to_text
 
757
                to_text = temp
 
758
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
759
        else:
 
760
            if not reverse:
 
761
                print >>output_to, '=== target was %r' % self.symlink_target
 
762
            else:
 
763
                print >>output_to, '=== target is %r' % self.symlink_target
 
764
 
 
765
    def __init__(self, file_id, name, parent_id):
 
766
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
767
        self.kind = 'symlink'
 
768
 
 
769
    def kind_character(self):
 
770
        """See InventoryEntry.kind_character."""
 
771
        return ''
 
772
 
 
773
    def _put_in_tar(self, item, tree):
 
774
        """See InventoryEntry._put_in_tar."""
 
775
        item.type = tarfile.SYMTYPE
 
776
        fileobj = None
 
777
        item.size = 0
 
778
        item.mode = 0755
 
779
        item.linkname = self.symlink_target
 
780
        return fileobj
 
781
 
 
782
    def _put_on_disk(self, fullpath, tree):
 
783
        """See InventoryEntry._put_on_disk."""
 
784
        try:
 
785
            os.symlink(self.symlink_target, fullpath)
 
786
        except OSError,e:
 
787
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
788
 
 
789
    def _read_tree_state(self, path, work_tree):
 
790
        """See InventoryEntry._read_tree_state."""
 
791
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
792
 
 
793
    def _forget_tree_state(self):
 
794
        self.symlink_target = None
 
795
 
 
796
    def _unchanged(self, previous_ie):
 
797
        """See InventoryEntry._unchanged."""
 
798
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
799
        if self.symlink_target != previous_ie.symlink_target:
 
800
            compatible = False
 
801
        return compatible
 
802
 
 
803
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
804
        """See InventoryEntry._snapshot_text."""
 
805
        commit_builder.modified_link(
 
806
            self.file_id, file_parents, self.symlink_target)
 
807
 
 
808
 
 
809
class Inventory(object):
251
810
    """Inventory of versioned files in a tree.
252
811
 
253
812
    This describes which file_id is present at each point in the tree,
265
824
    inserted, other than through the Inventory API.
266
825
 
267
826
    >>> inv = Inventory()
268
 
    >>> inv.write_xml(sys.stdout)
269
 
    <inventory>
270
 
    </inventory>
271
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
827
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
828
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
272
829
    >>> inv['123-123'].name
273
830
    'hello.c'
274
831
 
282
839
    May also look up by name:
283
840
 
284
841
    >>> [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
 
 
 
842
    [u'hello.c']
 
843
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
844
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
845
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
292
846
    """
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):
 
847
    def __init__(self, root_id=ROOT_ID, revision_id=None):
310
848
        """Create or read an inventory.
311
849
 
312
850
        If a working directory is specified, the inventory is read
316
854
        The inventory is created with a default root directory, with
317
855
        an id of None.
318
856
        """
319
 
        self.root = RootEntry(ROOT_ID)
 
857
        # We are letting Branch.create() create a unique inventory
 
858
        # root id. Rather than generating a random one here.
 
859
        #if root_id is None:
 
860
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
861
        self.root = RootEntry(root_id)
 
862
        # FIXME: this isn't ever used, changing it to self.revision may break
 
863
        # things. TODO make everything use self.revision_id
 
864
        self.revision_id = revision_id
320
865
        self._byid = {self.root.file_id: self.root}
321
866
 
 
867
    def copy(self):
 
868
        # TODO: jam 20051218 Should copy also copy the revision_id?
 
869
        other = Inventory(self.root.file_id)
 
870
        # copy recursively so we know directories will be added before
 
871
        # their children.  There are more efficient ways than this...
 
872
        for path, entry in self.iter_entries():
 
873
            if entry == self.root:
 
874
                continue
 
875
            other.add(entry.copy())
 
876
        return other
322
877
 
323
878
    def __iter__(self):
324
879
        return iter(self._byid)
325
880
 
326
 
 
327
881
    def __len__(self):
328
882
        """Returns number of entries."""
329
883
        return len(self._byid)
330
884
 
331
 
 
332
885
    def iter_entries(self, from_dir=None):
333
886
        """Return (path, entry) pairs, in order by name."""
334
 
        if from_dir == None:
335
 
            assert self.root
336
 
            from_dir = self.root
337
 
        elif isinstance(from_dir, basestring):
338
 
            from_dir = self._byid[from_dir]
339
 
            
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
 
                    
348
 
 
 
887
        if from_dir is None:
 
888
            assert self.root
 
889
            from_dir = self.root
 
890
        elif isinstance(from_dir, basestring):
 
891
            from_dir = self._byid[from_dir]
 
892
            
 
893
        # unrolling the recursive called changed the time from
 
894
        # 440ms/663ms (inline/total) to 116ms/116ms
 
895
        children = from_dir.children.items()
 
896
        children.sort()
 
897
        children = collections.deque(children)
 
898
        stack = [(u'', children)]
 
899
        while stack:
 
900
            from_dir_relpath, children = stack[-1]
 
901
 
 
902
            while children:
 
903
                name, ie = children.popleft()
 
904
 
 
905
                # we know that from_dir_relpath never ends in a slash
 
906
                # and 'f' doesn't begin with one, we can do a string op, rather
 
907
                # than the checks of pathjoin(), though this means that all paths
 
908
                # start with a slash
 
909
                path = from_dir_relpath + '/' + name
 
910
 
 
911
                yield path[1:], ie
 
912
 
 
913
                if ie.kind != 'directory':
 
914
                    continue
 
915
 
 
916
                # But do this child first
 
917
                new_children = ie.children.items()
 
918
                new_children.sort()
 
919
                new_children = collections.deque(new_children)
 
920
                stack.append((path, new_children))
 
921
                # Break out of inner loop, so that we start outer loop with child
 
922
                break
 
923
            else:
 
924
                # if we finished all children, pop it off the stack
 
925
                stack.pop()
 
926
 
 
927
    def iter_entries_by_dir(self, from_dir=None):
 
928
        """Iterate over the entries in a directory first order.
 
929
 
 
930
        This returns all entries for a directory before returning
 
931
        the entries for children of a directory. This is not
 
932
        lexicographically sorted order, and is a hybrid between
 
933
        depth-first and breadth-first.
 
934
 
 
935
        :return: This yields (path, entry) pairs
 
936
        """
 
937
        # TODO? Perhaps this should return the from_dir so that the root is
 
938
        # yielded? or maybe an option?
 
939
        if from_dir is None:
 
940
            assert self.root
 
941
            from_dir = self.root
 
942
        elif isinstance(from_dir, basestring):
 
943
            from_dir = self._byid[from_dir]
 
944
            
 
945
        stack = [(u'', from_dir)]
 
946
        while stack:
 
947
            cur_relpath, cur_dir = stack.pop()
 
948
 
 
949
            child_dirs = []
 
950
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
 
951
 
 
952
                child_relpath = cur_relpath + child_name
 
953
 
 
954
                yield child_relpath, child_ie
 
955
 
 
956
                if child_ie.kind == 'directory':
 
957
                    child_dirs.append((child_relpath+'/', child_ie))
 
958
            stack.extend(reversed(child_dirs))
 
959
 
 
960
    def entries(self):
 
961
        """Return list of (path, ie) for all entries except the root.
 
962
 
 
963
        This may be faster than iter_entries.
 
964
        """
 
965
        accum = []
 
966
        def descend(dir_ie, dir_path):
 
967
            kids = dir_ie.children.items()
 
968
            kids.sort()
 
969
            for name, ie in kids:
 
970
                child_path = pathjoin(dir_path, name)
 
971
                accum.append((child_path, ie))
 
972
                if ie.kind == 'directory':
 
973
                    descend(ie, child_path)
 
974
 
 
975
        descend(self.root, u'')
 
976
        return accum
349
977
 
350
978
    def directories(self):
351
 
        """Return (path, entry) pairs for all directories.
 
979
        """Return (path, entry) pairs for all directories, including the root.
352
980
        """
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()
 
981
        accum = []
 
982
        def descend(parent_ie, parent_path):
 
983
            accum.append((parent_path, parent_ie))
363
984
            
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
 
985
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
986
            kids.sort()
367
987
 
368
 
        for name, ie in descend(self.root):
369
 
            yield name, ie
 
988
            for name, child_ie in kids:
 
989
                child_path = pathjoin(parent_path, name)
 
990
                descend(child_ie, child_path)
 
991
        descend(self.root, u'')
 
992
        return accum
370
993
        
371
 
 
372
 
 
373
994
    def __contains__(self, file_id):
374
995
        """True if this entry contains a file with given id.
375
996
 
376
997
        >>> inv = Inventory()
377
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
998
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
999
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
378
1000
        >>> '123' in inv
379
1001
        True
380
1002
        >>> '456' in inv
382
1004
        """
383
1005
        return file_id in self._byid
384
1006
 
385
 
 
386
1007
    def __getitem__(self, file_id):
387
1008
        """Return the entry for given file_id.
388
1009
 
389
1010
        >>> inv = Inventory()
390
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
1011
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
1012
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
391
1013
        >>> inv['123123'].name
392
1014
        'hello.c'
393
1015
        """
394
 
        if file_id == None:
395
 
            raise BzrError("can't look up file_id None")
396
 
            
397
1016
        try:
398
1017
            return self._byid[file_id]
399
1018
        except KeyError:
400
 
            raise BzrError("file_id {%s} not in inventory" % file_id)
 
1019
            if file_id is None:
 
1020
                raise BzrError("can't look up file_id None")
 
1021
            else:
 
1022
                raise BzrError("file_id {%s} not in inventory" % file_id)
401
1023
 
 
1024
    def get_file_kind(self, file_id):
 
1025
        return self._byid[file_id].kind
402
1026
 
403
1027
    def get_child(self, parent_id, filename):
404
1028
        return self[parent_id].children.get(filename)
405
1029
 
406
 
 
407
1030
    def add(self, entry):
408
1031
        """Add entry to inventory.
409
1032
 
410
1033
        To add  a file to a branch ready to be committed, use Branch.add,
411
 
        which calls this."""
 
1034
        which calls this.
 
1035
 
 
1036
        Returns the new entry object.
 
1037
        """
412
1038
        if entry.file_id in self._byid:
413
 
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
 
1039
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
1040
 
 
1041
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
1042
            entry.parent_id = self.root.file_id
414
1043
 
415
1044
        try:
416
1045
            parent = self._byid[entry.parent_id]
417
1046
        except KeyError:
418
 
            bailout("parent_id {%s} not in inventory" % entry.parent_id)
 
1047
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
419
1048
 
420
 
        if parent.children.has_key(entry.name):
421
 
            bailout("%s is already versioned" %
422
 
                    appendpath(self.id2path(parent.file_id), entry.name))
 
1049
        if entry.name in parent.children:
 
1050
            raise BzrError("%s is already versioned" %
 
1051
                    pathjoin(self.id2path(parent.file_id), entry.name))
423
1052
 
424
1053
        self._byid[entry.file_id] = entry
425
1054
        parent.children[entry.name] = entry
426
 
 
427
 
 
428
 
    def add_path(self, relpath, kind, file_id=None):
 
1055
        return entry
 
1056
 
 
1057
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
429
1058
        """Add entry from a path.
430
1059
 
431
 
        The immediate parent must already be versioned"""
 
1060
        The immediate parent must already be versioned.
 
1061
 
 
1062
        Returns the new entry object."""
 
1063
        
432
1064
        parts = bzrlib.osutils.splitpath(relpath)
 
1065
 
433
1066
        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)
 
1067
            if file_id is None:
 
1068
                file_id = bzrlib.workingtree.gen_root_id()
 
1069
            self.root = RootEntry(file_id)
 
1070
            self._byid = {self.root.file_id: self.root}
 
1071
            return
 
1072
        else:
 
1073
            parent_path = parts[:-1]
 
1074
            parent_id = self.path2id(parent_path)
 
1075
            if parent_id is None:
 
1076
                raise NotVersionedError(path=parent_path)
 
1077
        ie = make_entry(kind, parts[-1], parent_id, file_id)
443
1078
        return self.add(ie)
444
1079
 
445
 
 
446
1080
    def __delitem__(self, file_id):
447
1081
        """Remove entry by id.
448
1082
 
449
1083
        >>> inv = Inventory()
450
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
1084
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1085
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
451
1086
        >>> '123' in inv
452
1087
        True
453
1088
        >>> del inv['123']
456
1091
        """
457
1092
        ie = self[file_id]
458
1093
 
459
 
        assert self[ie.parent_id].children[ie.name] == ie
 
1094
        assert ie.parent_id is None or \
 
1095
            self[ie.parent_id].children[ie.name] == ie
460
1096
        
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
1097
        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):
 
1098
        if ie.parent_id is not None:
 
1099
            del self[ie.parent_id].children[ie.name]
 
1100
 
 
1101
    def __eq__(self, other):
505
1102
        """Compare two sets by comparing their contents.
506
1103
 
507
1104
        >>> i1 = Inventory()
508
1105
        >>> i2 = Inventory()
509
1106
        >>> i1 == i2
510
1107
        True
511
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1108
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
1109
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
512
1110
        >>> i1 == i2
513
1111
        False
514
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1112
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
1113
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
515
1114
        >>> i1 == i2
516
1115
        True
517
1116
        """
518
 
        if self is other:
519
 
            return 0
520
 
        
521
1117
        if not isinstance(other, Inventory):
522
1118
            return NotImplemented
523
1119
 
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
 
 
 
1120
        return self._byid == other._byid
 
1121
 
 
1122
    def __ne__(self, other):
 
1123
        return not self.__eq__(other)
 
1124
 
 
1125
    def __hash__(self):
 
1126
        raise ValueError('not hashable')
 
1127
 
 
1128
    def _iter_file_id_parents(self, file_id):
 
1129
        """Yield the parents of file_id up to the root."""
 
1130
        while file_id is not None:
 
1131
            try:
 
1132
                ie = self._byid[file_id]
 
1133
            except KeyError:
 
1134
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1135
            yield ie
 
1136
            file_id = ie.parent_id
533
1137
 
534
1138
    def get_idpath(self, file_id):
535
1139
        """Return a list of file_ids for the path to an entry.
540
1144
        root directory as depth 1.
541
1145
        """
542
1146
        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
 
1147
        for parent in self._iter_file_id_parents(file_id):
 
1148
            p.insert(0, parent.file_id)
550
1149
        return p
551
1150
 
552
 
 
553
1151
    def id2path(self, file_id):
554
 
        """Return as a list the path to file_id."""
555
 
 
 
1152
        """Return as a string the path to file_id.
 
1153
        
 
1154
        >>> i = Inventory()
 
1155
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1156
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1157
        >>> print i.id2path('foo-id')
 
1158
        src/foo.c
 
1159
        """
556
1160
        # 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)
 
1161
        return '/'.join(reversed(
 
1162
            [parent.name for parent in 
 
1163
             self._iter_file_id_parents(file_id)][:-1]))
559
1164
            
560
 
 
561
 
 
562
1165
    def path2id(self, name):
563
1166
        """Walk down through directories to return entry of last component.
564
1167
 
568
1171
        This returns the entry of the last component in the path,
569
1172
        which may be either a file or a directory.
570
1173
 
571
 
        Returns None iff the path is not found.
 
1174
        Returns None IFF the path is not found.
572
1175
        """
573
1176
        if isinstance(name, types.StringTypes):
574
1177
            name = splitpath(name)
575
1178
 
576
 
        mutter("lookup path %r" % name)
 
1179
        # mutter("lookup path %r" % name)
577
1180
 
578
1181
        parent = self.root
579
1182
        for f in name:
588
1191
 
589
1192
        return parent.file_id
590
1193
 
591
 
 
592
1194
    def has_filename(self, names):
593
1195
        return bool(self.path2id(names))
594
1196
 
595
 
 
596
1197
    def has_id(self, file_id):
597
1198
        return self._byid.has_key(file_id)
598
1199
 
599
 
 
600
1200
    def rename(self, file_id, new_parent_id, new_name):
601
1201
        """Move a file within the inventory.
602
1202
 
604
1204
 
605
1205
        This does not move the working file."""
606
1206
        if not is_valid_name(new_name):
607
 
            bailout("not an acceptable filename: %r" % new_name)
 
1207
            raise BzrError("not an acceptable filename: %r" % new_name)
608
1208
 
609
1209
        new_parent = self._byid[new_parent_id]
610
1210
        if new_name in new_parent.children:
611
 
            bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
1211
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
612
1212
 
613
1213
        new_parent_idpath = self.get_idpath(new_parent_id)
614
1214
        if file_id in new_parent_idpath:
615
 
            bailout("cannot move directory %r into a subdirectory of itself, %r"
 
1215
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
616
1216
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
617
1217
 
618
1218
        file_ie = self._byid[file_id]
627
1227
        file_ie.parent_id = new_parent_id
628
1228
 
629
1229
 
630
 
 
631
 
 
632
 
_NAME_RE = re.compile(r'^[^/\\]+$')
 
1230
def make_entry(kind, name, parent_id, file_id=None):
 
1231
    """Create an inventory entry.
 
1232
 
 
1233
    :param kind: the type of inventory entry to create.
 
1234
    :param name: the basename of the entry.
 
1235
    :param parent_id: the parent_id of the entry.
 
1236
    :param file_id: the file_id to use. if None, one will be created.
 
1237
    """
 
1238
    if file_id is None:
 
1239
        file_id = bzrlib.workingtree.gen_file_id(name)
 
1240
    if kind == 'directory':
 
1241
        return InventoryDirectory(file_id, name, parent_id)
 
1242
    elif kind == 'file':
 
1243
        return InventoryFile(file_id, name, parent_id)
 
1244
    elif kind == 'symlink':
 
1245
        return InventoryLink(file_id, name, parent_id)
 
1246
    else:
 
1247
        raise BzrError("unknown kind %r" % kind)
 
1248
 
 
1249
 
 
1250
 
 
1251
_NAME_RE = None
633
1252
 
634
1253
def is_valid_name(name):
 
1254
    global _NAME_RE
 
1255
    if _NAME_RE is None:
 
1256
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1257
        
635
1258
    return bool(_NAME_RE.match(name))