~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-05-03 07:48:54 UTC
  • Revision ID: mbp@sourcefrog.net-20050503074854-adb6f9d6382e27a9
- sketchy experiments in bash and zsh completion

Show diffs side-by-side

added added

removed removed

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