~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Aaron Bentley
  • Date: 2006-06-20 02:32:24 UTC
  • mto: This revision was merged to the branch mainline in revision 1802.
  • Revision ID: aaron.bentley@utoronto.ca-20060620023224-745f7801d2ef3ac5
Move BundleReader into v07 serializer

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# (C) 2005 Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
# FIXME: This refactoring of the workingtree code doesn't seem to keep 
 
18
# the WorkingTree's copy of the inventory in sync with the branch.  The
 
19
# branch modifies its working inventory when it does a commit to make
 
20
# missing files permanently removed.
 
21
 
 
22
# TODO: Maybe also keep the full path of the entry, and the children?
 
23
# But those depend on its position within a particular inventory, and
 
24
# it would be nice not to need to hold the backpointer here.
17
25
 
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
21
29
 
22
30
 
23
 
import sys, os.path, types, re
24
 
from sets import Set
25
 
 
26
 
try:
27
 
    from cElementTree import Element, ElementTree, SubElement
28
 
except ImportError:
29
 
    from elementtree.ElementTree import Element, ElementTree, SubElement
30
 
 
31
 
from xml import XMLMixin
32
 
from errors import bailout, BzrError, BzrCheckError
 
31
import collections
 
32
import os.path
 
33
import re
 
34
import sys
 
35
import tarfile
 
36
import types
33
37
 
34
38
import bzrlib
35
 
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)
36
43
from bzrlib.trace import mutter
37
44
 
38
 
class InventoryEntry(XMLMixin):
 
45
 
 
46
class InventoryEntry(object):
39
47
    """Description of a versioned file.
40
48
 
41
49
    An InventoryEntry has the following fields, which are also
42
50
    present in the XML inventory-entry element:
43
51
 
44
 
    * *file_id*
45
 
    * *name*: (only the basename within the directory, must not
46
 
      contain slashes)
47
 
    * *kind*: "directory" or "file"
48
 
    * *directory_id*: (if absent/null means the branch root directory)
49
 
    * *text_sha1*: only for files
50
 
    * *text_size*: in bytes, only for files 
51
 
    * *text_id*: identifier for the text version, only for files
52
 
 
53
 
    InventoryEntries can also exist inside a WorkingTree
54
 
    inventory, in which case they are not yet bound to a
55
 
    particular revision of the file.  In that case the text_sha1,
56
 
    text_size and text_id are absent.
57
 
 
 
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.)
58
75
 
59
76
    >>> i = Inventory()
60
77
    >>> i.path2id('')
61
78
    'TREE_ROOT'
62
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
63
 
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
64
 
    >>> for j in i.iter_entries():
65
 
    ...   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])
66
86
    ... 
67
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
68
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
69
 
    >>> 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'))
70
90
    Traceback (most recent call last):
71
91
    ...
72
 
    BzrError: ('inventory already contains entry with id {2323}', [])
73
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
74
 
    >>> 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)
75
97
    >>> i.path2id('src/wibble')
76
98
    '2325'
77
99
    >>> '2325' in i
78
100
    True
79
 
    >>> 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)
80
103
    >>> i['2326']
81
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
 
    >>> for j in i.iter_entries():
83
 
    ...     print j[0]
84
 
    ...     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)
85
108
    ... 
86
109
    src
87
110
    src/bye.c
90
113
    src/wibble/wibble.c
91
114
    >>> i.id2path('2326')
92
115
    'src/wibble/wibble.c'
93
 
 
94
 
    TODO: Maybe also keep the full path of the entry, and the children?
95
 
           But those depend on its position within a particular inventory, and
96
 
           it would be nice not to need to hold the backpointer here.
97
116
    """
98
117
 
99
 
    # TODO: split InventoryEntry into subclasses for files,
100
 
    # directories, etc etc.
101
 
 
102
 
    text_sha1 = None
103
 
    text_size = None
 
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
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
276
        InvalidEntryName: Invalid entry name: src/hello.c
119
277
        """
 
278
        assert isinstance(name, basestring), name
120
279
        if '/' in name or '\\' in name:
121
 
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
122
 
        
 
280
            raise InvalidEntryName(name=name)
 
281
        self.executable = False
 
282
        self.revision = None
 
283
        self.text_sha1 = None
 
284
        self.text_size = None
123
285
        self.file_id = file_id
124
286
        self.name = name
125
 
        self.kind = kind
126
287
        self.text_id = text_id
127
288
        self.parent_id = parent_id
128
 
        if kind == 'directory':
129
 
            self.children = {}
130
 
        elif kind == 'file':
131
 
            pass
132
 
        else:
133
 
            raise BzrError("unhandled entry kind %r" % kind)
134
 
 
135
 
 
 
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))
136
318
 
137
319
    def sorted_children(self):
138
 
        l = self.children.items()
139
 
        l.sort()
140
 
        return l
141
 
 
 
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))
142
350
 
143
351
    def copy(self):
144
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
145
 
                               self.parent_id, text_id=self.text_id)
146
 
        other.text_sha1 = self.text_sha1
147
 
        other.text_size = self.text_size
148
 
        # note that children are *not* copied; they're pulled across when
149
 
        # others are added
150
 
        return other
151
 
 
 
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'
152
394
 
153
395
    def __repr__(self):
154
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
396
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
155
397
                % (self.__class__.__name__,
156
398
                   self.file_id,
157
399
                   self.name,
158
 
                   self.kind,
159
 
                   self.parent_id))
160
 
 
161
 
    
162
 
    def to_element(self):
163
 
        """Convert to XML element"""
164
 
        e = Element('entry')
165
 
 
166
 
        e.set('name', self.name)
167
 
        e.set('file_id', self.file_id)
168
 
        e.set('kind', self.kind)
169
 
 
170
 
        if self.text_size != None:
171
 
            e.set('text_size', '%d' % self.text_size)
172
 
            
173
 
        for f in ['text_id', 'text_sha1']:
174
 
            v = getattr(self, f)
175
 
            if v != None:
176
 
                e.set(f, v)
177
 
 
178
 
        # to be conservative, we don't externalize the root pointers
179
 
        # for now, leaving them as null in the xml form.  in a future
180
 
        # version it will be implied by nested elements.
181
 
        if self.parent_id != ROOT_ID:
182
 
            assert isinstance(self.parent_id, basestring)
183
 
            e.set('parent_id', self.parent_id)
184
 
 
185
 
        e.tail = '\n'
186
 
            
187
 
        return e
188
 
 
189
 
 
190
 
    def from_element(cls, elt):
191
 
        assert elt.tag == 'entry'
192
 
 
193
 
        ## original format inventories don't have a parent_id for
194
 
        ## nodes in the root directory, but it's cleaner to use one
195
 
        ## internally.
196
 
        parent_id = elt.get('parent_id')
197
 
        if parent_id == None:
198
 
            parent_id = ROOT_ID
199
 
 
200
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
201
 
        self.text_id = elt.get('text_id')
202
 
        self.text_sha1 = elt.get('text_sha1')
203
 
        
204
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
205
 
 
206
 
        v = elt.get('text_size')
207
 
        self.text_size = v and int(v)
208
 
 
209
 
        return self
210
 
            
211
 
 
212
 
    from_element = classmethod(from_element)
213
 
 
214
 
    def __cmp__(self, other):
215
 
        if self is other:
216
 
            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):
217
447
        if not isinstance(other, InventoryEntry):
218
448
            return NotImplemented
219
449
 
220
 
        return cmp(self.file_id, other.file_id) \
221
 
               or cmp(self.name, other.name) \
222
 
               or cmp(self.text_sha1, other.text_sha1) \
223
 
               or cmp(self.text_size, other.text_size) \
224
 
               or cmp(self.text_id, other.text_id) \
225
 
               or cmp(self.parent_id, other.parent_id) \
226
 
               or cmp(self.kind, other.kind)
227
 
 
 
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
228
495
 
229
496
 
230
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
 
231
506
    def __init__(self, file_id):
232
507
        self.file_id = file_id
233
508
        self.children = {}
234
509
        self.kind = 'root_directory'
235
510
        self.parent_id = None
236
 
        self.name = ''
 
511
        self.name = u''
 
512
        self.revision = None
237
513
 
238
 
    def __cmp__(self, other):
239
 
        if self is other:
240
 
            return 0
 
514
    def __eq__(self, other):
241
515
        if not isinstance(other, RootEntry):
242
516
            return NotImplemented
243
 
        return cmp(self.file_id, other.file_id) \
244
 
               or cmp(self.children, other.children)
245
 
 
246
 
 
247
 
 
248
 
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
        self.executable = None
 
696
 
 
697
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
698
        """See InventoryEntry._snapshot_text."""
 
699
        def get_content_byte_lines():
 
700
            return work_tree.get_file(self.file_id).readlines()
 
701
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
 
702
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
 
703
 
 
704
    def _unchanged(self, previous_ie):
 
705
        """See InventoryEntry._unchanged."""
 
706
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
707
        if self.text_sha1 != previous_ie.text_sha1:
 
708
            compatible = False
 
709
        else:
 
710
            # FIXME: 20050930 probe for the text size when getting sha1
 
711
            # in _read_tree_state
 
712
            self.text_size = previous_ie.text_size
 
713
        if self.executable != previous_ie.executable:
 
714
            compatible = False
 
715
        return compatible
 
716
 
 
717
 
 
718
class InventoryLink(InventoryEntry):
 
719
    """A file in an inventory."""
 
720
 
 
721
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
722
                 'text_id', 'parent_id', 'children', 'executable', 
 
723
                 'revision', 'symlink_target']
 
724
 
 
725
    def _check(self, checker, rev_id, tree):
 
726
        """See InventoryEntry._check"""
 
727
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
 
728
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
729
                    % (self.file_id, rev_id))
 
730
        if self.symlink_target is None:
 
731
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
732
                    % (self.file_id, rev_id))
 
733
 
 
734
    def copy(self):
 
735
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
736
        other.symlink_target = self.symlink_target
 
737
        other.revision = self.revision
 
738
        return other
 
739
 
 
740
    def detect_changes(self, old_entry):
 
741
        """See InventoryEntry.detect_changes."""
 
742
        # FIXME: which _modified field should we use ? RBC 20051003
 
743
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
744
        if text_modified:
 
745
            mutter("    symlink target changed")
 
746
        meta_modified = False
 
747
        return text_modified, meta_modified
 
748
 
 
749
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
750
             output_to, reverse=False):
 
751
        """See InventoryEntry._diff."""
 
752
        from_text = self.symlink_target
 
753
        if to_entry is not None:
 
754
            to_text = to_entry.symlink_target
 
755
            if reverse:
 
756
                temp = from_text
 
757
                from_text = to_text
 
758
                to_text = temp
 
759
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
760
        else:
 
761
            if not reverse:
 
762
                print >>output_to, '=== target was %r' % self.symlink_target
 
763
            else:
 
764
                print >>output_to, '=== target is %r' % self.symlink_target
 
765
 
 
766
    def __init__(self, file_id, name, parent_id):
 
767
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
768
        self.kind = 'symlink'
 
769
 
 
770
    def kind_character(self):
 
771
        """See InventoryEntry.kind_character."""
 
772
        return ''
 
773
 
 
774
    def _put_in_tar(self, item, tree):
 
775
        """See InventoryEntry._put_in_tar."""
 
776
        item.type = tarfile.SYMTYPE
 
777
        fileobj = None
 
778
        item.size = 0
 
779
        item.mode = 0755
 
780
        item.linkname = self.symlink_target
 
781
        return fileobj
 
782
 
 
783
    def _put_on_disk(self, fullpath, tree):
 
784
        """See InventoryEntry._put_on_disk."""
 
785
        try:
 
786
            os.symlink(self.symlink_target, fullpath)
 
787
        except OSError,e:
 
788
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
789
 
 
790
    def _read_tree_state(self, path, work_tree):
 
791
        """See InventoryEntry._read_tree_state."""
 
792
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
793
 
 
794
    def _forget_tree_state(self):
 
795
        self.symlink_target = None
 
796
 
 
797
    def _unchanged(self, previous_ie):
 
798
        """See InventoryEntry._unchanged."""
 
799
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
800
        if self.symlink_target != previous_ie.symlink_target:
 
801
            compatible = False
 
802
        return compatible
 
803
 
 
804
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
 
805
        """See InventoryEntry._snapshot_text."""
 
806
        commit_builder.modified_link(
 
807
            self.file_id, file_parents, self.symlink_target)
 
808
 
 
809
 
 
810
class Inventory(object):
249
811
    """Inventory of versioned files in a tree.
250
812
 
251
813
    This describes which file_id is present at each point in the tree,
263
825
    inserted, other than through the Inventory API.
264
826
 
265
827
    >>> inv = Inventory()
266
 
    >>> inv.write_xml(sys.stdout)
267
 
    <inventory>
268
 
    </inventory>
269
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
828
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
829
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
270
830
    >>> inv['123-123'].name
271
831
    'hello.c'
272
832
 
280
840
    May also look up by name:
281
841
 
282
842
    >>> [x[0] for x in inv.iter_entries()]
283
 
    ['hello.c']
284
 
    
285
 
    >>> inv.write_xml(sys.stdout)
286
 
    <inventory>
287
 
    <entry file_id="123-123" kind="file" name="hello.c" />
288
 
    </inventory>
289
 
 
 
843
    [u'hello.c']
 
844
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
 
845
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
846
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
290
847
    """
291
 
    def __init__(self):
 
848
    def __init__(self, root_id=ROOT_ID, revision_id=None):
292
849
        """Create or read an inventory.
293
850
 
294
851
        If a working directory is specified, the inventory is read
298
855
        The inventory is created with a default root directory, with
299
856
        an id of None.
300
857
        """
301
 
        self.root = RootEntry(ROOT_ID)
 
858
        # We are letting Branch.create() create a unique inventory
 
859
        # root id. Rather than generating a random one here.
 
860
        #if root_id is None:
 
861
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
 
862
        self.root = RootEntry(root_id)
 
863
        # FIXME: this isn't ever used, changing it to self.revision may break
 
864
        # things. TODO make everything use self.revision_id
 
865
        self.revision_id = revision_id
302
866
        self._byid = {self.root.file_id: self.root}
303
867
 
 
868
    def copy(self):
 
869
        # TODO: jam 20051218 Should copy also copy the revision_id?
 
870
        other = Inventory(self.root.file_id)
 
871
        # copy recursively so we know directories will be added before
 
872
        # their children.  There are more efficient ways than this...
 
873
        for path, entry in self.iter_entries():
 
874
            if entry == self.root:
 
875
                continue
 
876
            other.add(entry.copy())
 
877
        return other
304
878
 
305
879
    def __iter__(self):
306
880
        return iter(self._byid)
307
881
 
308
 
 
309
882
    def __len__(self):
310
883
        """Returns number of entries."""
311
884
        return len(self._byid)
312
885
 
313
 
 
314
886
    def iter_entries(self, from_dir=None):
315
887
        """Return (path, entry) pairs, in order by name."""
316
 
        if from_dir == None:
317
 
            assert self.root
318
 
            from_dir = self.root
319
 
        elif isinstance(from_dir, basestring):
320
 
            from_dir = self._byid[from_dir]
321
 
            
322
 
        kids = from_dir.children.items()
323
 
        kids.sort()
324
 
        for name, ie in kids:
325
 
            yield name, ie
326
 
            if ie.kind == 'directory':
327
 
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
328
 
                    yield os.path.join(name, cn), cie
329
 
                    
330
 
 
 
888
        if from_dir is None:
 
889
            assert self.root
 
890
            from_dir = self.root
 
891
        elif isinstance(from_dir, basestring):
 
892
            from_dir = self._byid[from_dir]
 
893
            
 
894
        # unrolling the recursive called changed the time from
 
895
        # 440ms/663ms (inline/total) to 116ms/116ms
 
896
        children = from_dir.children.items()
 
897
        children.sort()
 
898
        children = collections.deque(children)
 
899
        stack = [(u'', children)]
 
900
        while stack:
 
901
            from_dir_relpath, children = stack[-1]
 
902
 
 
903
            while children:
 
904
                name, ie = children.popleft()
 
905
 
 
906
                # we know that from_dir_relpath never ends in a slash
 
907
                # and 'f' doesn't begin with one, we can do a string op, rather
 
908
                # than the checks of pathjoin(), though this means that all paths
 
909
                # start with a slash
 
910
                path = from_dir_relpath + '/' + name
 
911
 
 
912
                yield path[1:], ie
 
913
 
 
914
                if ie.kind != 'directory':
 
915
                    continue
 
916
 
 
917
                # But do this child first
 
918
                new_children = ie.children.items()
 
919
                new_children.sort()
 
920
                new_children = collections.deque(new_children)
 
921
                stack.append((path, new_children))
 
922
                # Break out of inner loop, so that we start outer loop with child
 
923
                break
 
924
            else:
 
925
                # if we finished all children, pop it off the stack
 
926
                stack.pop()
 
927
 
 
928
    def iter_entries_by_dir(self, from_dir=None):
 
929
        """Iterate over the entries in a directory first order.
 
930
 
 
931
        This returns all entries for a directory before returning
 
932
        the entries for children of a directory. This is not
 
933
        lexicographically sorted order, and is a hybrid between
 
934
        depth-first and breadth-first.
 
935
 
 
936
        :return: This yields (path, entry) pairs
 
937
        """
 
938
        # TODO? Perhaps this should return the from_dir so that the root is
 
939
        # yielded? or maybe an option?
 
940
        if from_dir is None:
 
941
            assert self.root
 
942
            from_dir = self.root
 
943
        elif isinstance(from_dir, basestring):
 
944
            from_dir = self._byid[from_dir]
 
945
            
 
946
        stack = [(u'', from_dir)]
 
947
        while stack:
 
948
            cur_relpath, cur_dir = stack.pop()
 
949
 
 
950
            child_dirs = []
 
951
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
 
952
 
 
953
                child_relpath = cur_relpath + child_name
 
954
 
 
955
                yield child_relpath, child_ie
 
956
 
 
957
                if child_ie.kind == 'directory':
 
958
                    child_dirs.append((child_relpath+'/', child_ie))
 
959
            stack.extend(reversed(child_dirs))
 
960
 
 
961
    def entries(self):
 
962
        """Return list of (path, ie) for all entries except the root.
 
963
 
 
964
        This may be faster than iter_entries.
 
965
        """
 
966
        accum = []
 
967
        def descend(dir_ie, dir_path):
 
968
            kids = dir_ie.children.items()
 
969
            kids.sort()
 
970
            for name, ie in kids:
 
971
                child_path = pathjoin(dir_path, name)
 
972
                accum.append((child_path, ie))
 
973
                if ie.kind == 'directory':
 
974
                    descend(ie, child_path)
 
975
 
 
976
        descend(self.root, u'')
 
977
        return accum
331
978
 
332
979
    def directories(self):
333
 
        """Return (path, entry) pairs for all directories.
 
980
        """Return (path, entry) pairs for all directories, including the root.
334
981
        """
335
 
        def descend(parent_ie):
336
 
            parent_name = parent_ie.name
337
 
            yield parent_name, parent_ie
338
 
 
339
 
            # directory children in sorted order
340
 
            dn = []
341
 
            for ie in parent_ie.children.itervalues():
342
 
                if ie.kind == 'directory':
343
 
                    dn.append((ie.name, ie))
344
 
            dn.sort()
 
982
        accum = []
 
983
        def descend(parent_ie, parent_path):
 
984
            accum.append((parent_path, parent_ie))
345
985
            
346
 
            for name, child_ie in dn:
347
 
                for sub_name, sub_ie in descend(child_ie):
348
 
                    yield appendpath(parent_name, sub_name), sub_ie
 
986
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
 
987
            kids.sort()
349
988
 
350
 
        for name, ie in descend(self.root):
351
 
            yield name, ie
 
989
            for name, child_ie in kids:
 
990
                child_path = pathjoin(parent_path, name)
 
991
                descend(child_ie, child_path)
 
992
        descend(self.root, u'')
 
993
        return accum
352
994
        
353
 
 
354
 
 
355
995
    def __contains__(self, file_id):
356
996
        """True if this entry contains a file with given id.
357
997
 
358
998
        >>> inv = Inventory()
359
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
999
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1000
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
360
1001
        >>> '123' in inv
361
1002
        True
362
1003
        >>> '456' in inv
364
1005
        """
365
1006
        return file_id in self._byid
366
1007
 
367
 
 
368
1008
    def __getitem__(self, file_id):
369
1009
        """Return the entry for given file_id.
370
1010
 
371
1011
        >>> inv = Inventory()
372
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
1012
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
1013
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
373
1014
        >>> inv['123123'].name
374
1015
        'hello.c'
375
1016
        """
376
1017
        try:
377
1018
            return self._byid[file_id]
378
1019
        except KeyError:
379
 
            if file_id == None:
 
1020
            if file_id is None:
380
1021
                raise BzrError("can't look up file_id None")
381
1022
            else:
382
1023
                raise BzrError("file_id {%s} not in inventory" % file_id)
383
1024
 
384
 
 
385
1025
    def get_file_kind(self, file_id):
386
1026
        return self._byid[file_id].kind
387
1027
 
388
1028
    def get_child(self, parent_id, filename):
389
1029
        return self[parent_id].children.get(filename)
390
1030
 
391
 
 
392
1031
    def add(self, entry):
393
1032
        """Add entry to inventory.
394
1033
 
395
1034
        To add  a file to a branch ready to be committed, use Branch.add,
396
 
        which calls this."""
 
1035
        which calls this.
 
1036
 
 
1037
        Returns the new entry object.
 
1038
        """
397
1039
        if entry.file_id in self._byid:
398
 
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
 
1040
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
 
1041
 
 
1042
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
 
1043
            entry.parent_id = self.root.file_id
399
1044
 
400
1045
        try:
401
1046
            parent = self._byid[entry.parent_id]
402
1047
        except KeyError:
403
 
            bailout("parent_id {%s} not in inventory" % entry.parent_id)
 
1048
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
404
1049
 
405
 
        if parent.children.has_key(entry.name):
406
 
            bailout("%s is already versioned" %
407
 
                    appendpath(self.id2path(parent.file_id), entry.name))
 
1050
        if entry.name in parent.children:
 
1051
            raise BzrError("%s is already versioned" %
 
1052
                    pathjoin(self.id2path(parent.file_id), entry.name))
408
1053
 
409
1054
        self._byid[entry.file_id] = entry
410
1055
        parent.children[entry.name] = entry
411
 
 
412
 
 
413
 
    def add_path(self, relpath, kind, file_id=None):
 
1056
        return entry
 
1057
 
 
1058
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
414
1059
        """Add entry from a path.
415
1060
 
416
 
        The immediate parent must already be versioned"""
 
1061
        The immediate parent must already be versioned.
 
1062
 
 
1063
        Returns the new entry object."""
 
1064
        
417
1065
        parts = bzrlib.osutils.splitpath(relpath)
 
1066
 
418
1067
        if len(parts) == 0:
419
 
            bailout("cannot re-add root of inventory")
420
 
 
421
 
        if file_id == None:
422
 
            file_id = bzrlib.branch.gen_file_id(relpath)
423
 
 
424
 
        parent_id = self.path2id(parts[:-1])
425
 
        assert parent_id != None
426
 
        ie = InventoryEntry(file_id, parts[-1],
427
 
                            kind=kind, parent_id=parent_id)
 
1068
            if file_id is None:
 
1069
                file_id = bzrlib.workingtree.gen_root_id()
 
1070
            self.root = RootEntry(file_id)
 
1071
            self._byid = {self.root.file_id: self.root}
 
1072
            return
 
1073
        else:
 
1074
            parent_path = parts[:-1]
 
1075
            parent_id = self.path2id(parent_path)
 
1076
            if parent_id is None:
 
1077
                raise NotVersionedError(path=parent_path)
 
1078
        ie = make_entry(kind, parts[-1], parent_id, file_id)
428
1079
        return self.add(ie)
429
1080
 
430
 
 
431
1081
    def __delitem__(self, file_id):
432
1082
        """Remove entry by id.
433
1083
 
434
1084
        >>> inv = Inventory()
435
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
1085
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
1086
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
436
1087
        >>> '123' in inv
437
1088
        True
438
1089
        >>> del inv['123']
441
1092
        """
442
1093
        ie = self[file_id]
443
1094
 
444
 
        assert self[ie.parent_id].children[ie.name] == ie
 
1095
        assert ie.parent_id is None or \
 
1096
            self[ie.parent_id].children[ie.name] == ie
445
1097
        
446
 
        # TODO: Test deleting all children; maybe hoist to a separate
447
 
        # deltree method?
448
 
        if ie.kind == 'directory':
449
 
            for cie in ie.children.values():
450
 
                del self[cie.file_id]
451
 
            del ie.children
452
 
 
453
1098
        del self._byid[file_id]
454
 
        del self[ie.parent_id].children[ie.name]
455
 
 
456
 
 
457
 
    def id_set(self):
458
 
        return Set(self._byid)
459
 
 
460
 
 
461
 
    def to_element(self):
462
 
        """Convert to XML Element"""
463
 
        e = Element('inventory')
464
 
        e.text = '\n'
465
 
        for path, ie in self.iter_entries():
466
 
            e.append(ie.to_element())
467
 
        return e
468
 
    
469
 
 
470
 
    def from_element(cls, elt):
471
 
        """Construct from XML Element
472
 
 
473
 
        >>> inv = Inventory()
474
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
475
 
        >>> elt = inv.to_element()
476
 
        >>> inv2 = Inventory.from_element(elt)
477
 
        >>> inv2 == inv
478
 
        True
479
 
        """
480
 
        assert elt.tag == 'inventory'
481
 
        o = cls()
482
 
        for e in elt:
483
 
            o.add(InventoryEntry.from_element(e))
484
 
        return o
485
 
        
486
 
    from_element = classmethod(from_element)
487
 
 
488
 
 
489
 
    def __cmp__(self, other):
 
1099
        if ie.parent_id is not None:
 
1100
            del self[ie.parent_id].children[ie.name]
 
1101
 
 
1102
    def __eq__(self, other):
490
1103
        """Compare two sets by comparing their contents.
491
1104
 
492
1105
        >>> i1 = Inventory()
493
1106
        >>> i2 = Inventory()
494
1107
        >>> i1 == i2
495
1108
        True
496
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1109
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
1110
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
497
1111
        >>> i1 == i2
498
1112
        False
499
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
1113
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
1114
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
500
1115
        >>> i1 == i2
501
1116
        True
502
1117
        """
503
 
        if self is other:
504
 
            return 0
505
 
        
506
1118
        if not isinstance(other, Inventory):
507
1119
            return NotImplemented
508
1120
 
509
 
        if self.id_set() ^ other.id_set():
510
 
            return 1
511
 
 
512
 
        for file_id in self._byid:
513
 
            c = cmp(self[file_id], other[file_id])
514
 
            if c: return c
515
 
 
516
 
        return 0
517
 
 
 
1121
        return self._byid == other._byid
 
1122
 
 
1123
    def __ne__(self, other):
 
1124
        return not self.__eq__(other)
 
1125
 
 
1126
    def __hash__(self):
 
1127
        raise ValueError('not hashable')
 
1128
 
 
1129
    def _iter_file_id_parents(self, file_id):
 
1130
        """Yield the parents of file_id up to the root."""
 
1131
        while file_id is not None:
 
1132
            try:
 
1133
                ie = self._byid[file_id]
 
1134
            except KeyError:
 
1135
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
1136
            yield ie
 
1137
            file_id = ie.parent_id
518
1138
 
519
1139
    def get_idpath(self, file_id):
520
1140
        """Return a list of file_ids for the path to an entry.
525
1145
        root directory as depth 1.
526
1146
        """
527
1147
        p = []
528
 
        while file_id != None:
529
 
            try:
530
 
                ie = self._byid[file_id]
531
 
            except KeyError:
532
 
                bailout("file_id {%s} not found in inventory" % file_id)
533
 
            p.insert(0, ie.file_id)
534
 
            file_id = ie.parent_id
 
1148
        for parent in self._iter_file_id_parents(file_id):
 
1149
            p.insert(0, parent.file_id)
535
1150
        return p
536
1151
 
537
 
 
538
1152
    def id2path(self, file_id):
539
 
        """Return as a list the path to file_id."""
540
 
 
 
1153
        """Return as a string the path to file_id.
 
1154
        
 
1155
        >>> i = Inventory()
 
1156
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
1157
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
1158
        >>> print i.id2path('foo-id')
 
1159
        src/foo.c
 
1160
        """
541
1161
        # get all names, skipping root
542
 
        p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
543
 
        return os.sep.join(p)
 
1162
        return '/'.join(reversed(
 
1163
            [parent.name for parent in 
 
1164
             self._iter_file_id_parents(file_id)][:-1]))
544
1165
            
545
 
 
546
 
 
547
1166
    def path2id(self, name):
548
1167
        """Walk down through directories to return entry of last component.
549
1168
 
553
1172
        This returns the entry of the last component in the path,
554
1173
        which may be either a file or a directory.
555
1174
 
556
 
        Returns None iff the path is not found.
 
1175
        Returns None IFF the path is not found.
557
1176
        """
558
1177
        if isinstance(name, types.StringTypes):
559
1178
            name = splitpath(name)
560
1179
 
561
 
        mutter("lookup path %r" % name)
 
1180
        # mutter("lookup path %r" % name)
562
1181
 
563
1182
        parent = self.root
564
1183
        for f in name:
573
1192
 
574
1193
        return parent.file_id
575
1194
 
576
 
 
577
1195
    def has_filename(self, names):
578
1196
        return bool(self.path2id(names))
579
1197
 
580
 
 
581
1198
    def has_id(self, file_id):
582
1199
        return self._byid.has_key(file_id)
583
1200
 
584
 
 
585
1201
    def rename(self, file_id, new_parent_id, new_name):
586
1202
        """Move a file within the inventory.
587
1203
 
589
1205
 
590
1206
        This does not move the working file."""
591
1207
        if not is_valid_name(new_name):
592
 
            bailout("not an acceptable filename: %r" % new_name)
 
1208
            raise BzrError("not an acceptable filename: %r" % new_name)
593
1209
 
594
1210
        new_parent = self._byid[new_parent_id]
595
1211
        if new_name in new_parent.children:
596
 
            bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
1212
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
597
1213
 
598
1214
        new_parent_idpath = self.get_idpath(new_parent_id)
599
1215
        if file_id in new_parent_idpath:
600
 
            bailout("cannot move directory %r into a subdirectory of itself, %r"
 
1216
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
601
1217
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
602
1218
 
603
1219
        file_ie = self._byid[file_id]
612
1228
        file_ie.parent_id = new_parent_id
613
1229
 
614
1230
 
615
 
 
616
 
 
617
 
_NAME_RE = re.compile(r'^[^/\\]+$')
 
1231
def make_entry(kind, name, parent_id, file_id=None):
 
1232
    """Create an inventory entry.
 
1233
 
 
1234
    :param kind: the type of inventory entry to create.
 
1235
    :param name: the basename of the entry.
 
1236
    :param parent_id: the parent_id of the entry.
 
1237
    :param file_id: the file_id to use. if None, one will be created.
 
1238
    """
 
1239
    if file_id is None:
 
1240
        file_id = bzrlib.workingtree.gen_file_id(name)
 
1241
    if kind == 'directory':
 
1242
        return InventoryDirectory(file_id, name, parent_id)
 
1243
    elif kind == 'file':
 
1244
        return InventoryFile(file_id, name, parent_id)
 
1245
    elif kind == 'symlink':
 
1246
        return InventoryLink(file_id, name, parent_id)
 
1247
    else:
 
1248
        raise BzrError("unknown kind %r" % kind)
 
1249
 
 
1250
 
 
1251
 
 
1252
_NAME_RE = None
618
1253
 
619
1254
def is_valid_name(name):
 
1255
    global _NAME_RE
 
1256
    if _NAME_RE is None:
 
1257
        _NAME_RE = re.compile(r'^[^/\\]+$')
 
1258
        
620
1259
    return bool(_NAME_RE.match(name))