~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Aaron Bentley
  • Date: 2005-09-21 15:33:23 UTC
  • mto: (1185.1.37)
  • mto: This revision was merged to the branch mainline in revision 1390.
  • Revision ID: abentley@panoramicfeedback.com-20050921153323-5db674d572d7649d
Fixed bug in distance-from-root graph operation

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.
25
17
 
26
18
# This should really be an id randomly assigned when the tree is
27
19
# created, but it's not for now.
28
20
ROOT_ID = "TREE_ROOT"
29
21
 
30
22
 
31
 
import collections
32
 
import os.path
33
 
import re
34
 
import sys
35
 
import tarfile
36
 
import types
 
23
import sys, os.path, types, re
37
24
 
38
25
import bzrlib
39
 
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
40
 
                            pathjoin, sha_strings)
41
 
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
42
 
                           BzrError, BzrCheckError, BinaryFile)
 
26
from bzrlib.errors import BzrError, BzrCheckError
 
27
 
 
28
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
43
29
from bzrlib.trace import mutter
44
 
 
 
30
from bzrlib.errors import NotVersionedError
 
31
        
45
32
 
46
33
class InventoryEntry(object):
47
34
    """Description of a versioned file.
49
36
    An InventoryEntry has the following fields, which are also
50
37
    present in the XML inventory-entry element:
51
38
 
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.)
 
39
    * *file_id*
 
40
    * *name*: (only the basename within the directory, must not
 
41
      contain slashes)
 
42
    * *kind*: "directory" or "file"
 
43
    * *directory_id*: (if absent/null means the branch root directory)
 
44
    * *text_sha1*: only for files
 
45
    * *text_size*: in bytes, only for files 
 
46
    * *text_id*: identifier for the text version, only for files
 
47
 
 
48
    InventoryEntries can also exist inside a WorkingTree
 
49
    inventory, in which case they are not yet bound to a
 
50
    particular revision of the file.  In that case the text_sha1,
 
51
    text_size and text_id are absent.
 
52
 
75
53
 
76
54
    >>> i = Inventory()
77
55
    >>> i.path2id('')
78
56
    'TREE_ROOT'
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])
 
57
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
58
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
 
59
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
60
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
 
61
    >>> for j in i.iter_entries():
 
62
    ...   print j
86
63
    ... 
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'))
 
64
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
65
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
 
66
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
90
67
    Traceback (most recent call last):
91
68
    ...
92
69
    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)
 
70
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
71
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
 
72
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
 
73
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
97
74
    >>> i.path2id('src/wibble')
98
75
    '2325'
99
76
    >>> '2325' in i
100
77
    True
101
 
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
102
 
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
 
78
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
 
79
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
103
80
    >>> i['2326']
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)
 
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])
108
85
    ... 
109
86
    src
110
87
    src/bye.c
113
90
    src/wibble/wibble.c
114
91
    >>> i.id2path('2326')
115
92
    '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.
116
97
    """
117
98
 
118
 
    # Constants returned by describe_change()
119
 
    #
120
 
    # TODO: These should probably move to some kind of FileChangeDescription 
121
 
    # class; that's like what's inside a TreeDelta but we want to be able to 
122
 
    # generate them just for one file at a time.
123
 
    RENAMED = 'renamed'
124
 
    MODIFIED_AND_RENAMED = 'modified and renamed'
125
 
    
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):
 
99
    # TODO: split InventoryEntry into subclasses for files,
 
100
    # directories, etc etc.
 
101
 
 
102
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
 
103
                 'text_id', 'parent_id', 'children',
 
104
                 'text_version', 'entry_version', ]
 
105
 
 
106
 
 
107
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
264
108
        """Create an InventoryEntry
265
109
        
266
110
        The filename must be a single component, relative to the
267
111
        parent directory; it cannot be a whole path or relative name.
268
112
 
269
 
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
 
113
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
270
114
        >>> e.name
271
115
        'hello.c'
272
116
        >>> e.file_id
273
117
        '123'
274
 
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
 
118
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
275
119
        Traceback (most recent call last):
276
 
        InvalidEntryName: Invalid entry name: src/hello.c
 
120
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
277
121
        """
278
122
        assert isinstance(name, basestring), name
279
123
        if '/' in name or '\\' in name:
280
 
            raise InvalidEntryName(name=name)
281
 
        self.executable = False
282
 
        self.revision = None
 
124
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
125
        
 
126
        self.text_version = None
 
127
        self.entry_version = None
283
128
        self.text_sha1 = None
284
129
        self.text_size = None
285
130
        self.file_id = file_id
286
131
        self.name = name
 
132
        self.kind = kind
287
133
        self.text_id = text_id
288
134
        self.parent_id = parent_id
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))
 
135
        if kind == 'directory':
 
136
            self.children = {}
 
137
        elif kind == 'file':
 
138
            pass
 
139
        else:
 
140
            raise BzrError("unhandled entry kind %r" % kind)
 
141
 
 
142
 
318
143
 
319
144
    def sorted_children(self):
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))
 
145
        l = self.children.items()
 
146
        l.sort()
 
147
        return l
 
148
 
350
149
 
351
150
    def copy(self):
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'
 
151
        other = InventoryEntry(self.file_id, self.name, self.kind,
 
152
                               self.parent_id, text_id=self.text_id)
 
153
        other.text_sha1 = self.text_sha1
 
154
        other.text_size = self.text_size
 
155
        # note that children are *not* copied; they're pulled across when
 
156
        # others are added
 
157
        return other
 
158
 
394
159
 
395
160
    def __repr__(self):
396
 
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
 
161
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
397
162
                % (self.__class__.__name__,
398
163
                   self.file_id,
399
164
                   self.name,
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
 
 
 
165
                   self.kind,
 
166
                   self.parent_id))
 
167
 
 
168
    
446
169
    def __eq__(self, other):
447
170
        if not isinstance(other, InventoryEntry):
448
171
            return NotImplemented
449
172
 
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
 
                )
 
173
        return (self.file_id == other.file_id) \
 
174
               and (self.name == other.name) \
 
175
               and (self.text_sha1 == other.text_sha1) \
 
176
               and (self.text_size == other.text_size) \
 
177
               and (self.text_id == other.text_id) \
 
178
               and (self.parent_id == other.parent_id) \
 
179
               and (self.kind == other.kind) \
 
180
               and (self.text_version == other.text_version) \
 
181
               and (self.entry_version == other.entry_version)
 
182
 
461
183
 
462
184
    def __ne__(self, other):
463
185
        return not (self == other)
465
187
    def __hash__(self):
466
188
        raise ValueError('not hashable')
467
189
 
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
495
190
 
496
191
 
497
192
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
 
 
506
193
    def __init__(self, file_id):
507
194
        self.file_id = file_id
508
195
        self.children = {}
509
196
        self.kind = 'root_directory'
510
197
        self.parent_id = None
511
 
        self.name = u''
512
 
        self.revision = None
 
198
        self.name = ''
513
199
 
514
200
    def __eq__(self, other):
515
201
        if not isinstance(other, RootEntry):
519
205
               and (self.children == other.children)
520
206
 
521
207
 
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
208
 
810
209
class Inventory(object):
811
210
    """Inventory of versioned files in a tree.
825
224
    inserted, other than through the Inventory API.
826
225
 
827
226
    >>> inv = Inventory()
828
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
829
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
227
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
228
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
830
229
    >>> inv['123-123'].name
831
230
    'hello.c'
832
231
 
840
239
    May also look up by name:
841
240
 
842
241
    >>> [x[0] for x in inv.iter_entries()]
843
 
    [u'hello.c']
 
242
    ['hello.c']
844
243
    >>> 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)
 
244
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
 
245
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
847
246
    """
848
 
    def __init__(self, root_id=ROOT_ID, revision_id=None):
 
247
    def __init__(self, root_id=ROOT_ID):
849
248
        """Create or read an inventory.
850
249
 
851
250
        If a working directory is specified, the inventory is read
855
254
        The inventory is created with a default root directory, with
856
255
        an id of None.
857
256
        """
858
 
        # We are letting Branch.create() create a unique inventory
 
257
        # We are letting Branch.initialize() create a unique inventory
859
258
        # root id. Rather than generating a random one here.
860
259
        #if root_id is None:
861
260
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
862
261
        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
866
262
        self._byid = {self.root.file_id: self.root}
867
263
 
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
878
264
 
879
265
    def __iter__(self):
880
266
        return iter(self._byid)
881
267
 
 
268
 
882
269
    def __len__(self):
883
270
        """Returns number of entries."""
884
271
        return len(self._byid)
885
272
 
 
273
 
886
274
    def iter_entries(self, from_dir=None):
887
275
        """Return (path, entry) pairs, in order by name."""
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))
 
276
        if from_dir == None:
 
277
            assert self.root
 
278
            from_dir = self.root
 
279
        elif isinstance(from_dir, basestring):
 
280
            from_dir = self._byid[from_dir]
 
281
            
 
282
        kids = from_dir.children.items()
 
283
        kids.sort()
 
284
        for name, ie in kids:
 
285
            yield name, ie
 
286
            if ie.kind == 'directory':
 
287
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
 
288
                    yield os.path.join(name, cn), cie
 
289
 
960
290
 
961
291
    def entries(self):
962
292
        """Return list of (path, ie) for all entries except the root.
968
298
            kids = dir_ie.children.items()
969
299
            kids.sort()
970
300
            for name, ie in kids:
971
 
                child_path = pathjoin(dir_path, name)
 
301
                child_path = os.path.join(dir_path, name)
972
302
                accum.append((child_path, ie))
973
303
                if ie.kind == 'directory':
974
304
                    descend(ie, child_path)
975
305
 
976
 
        descend(self.root, u'')
 
306
        descend(self.root, '')
977
307
        return accum
978
308
 
 
309
 
979
310
    def directories(self):
980
311
        """Return (path, entry) pairs for all directories, including the root.
981
312
        """
987
318
            kids.sort()
988
319
 
989
320
            for name, child_ie in kids:
990
 
                child_path = pathjoin(parent_path, name)
 
321
                child_path = os.path.join(parent_path, name)
991
322
                descend(child_ie, child_path)
992
 
        descend(self.root, u'')
 
323
        descend(self.root, '')
993
324
        return accum
994
325
        
 
326
 
 
327
 
995
328
    def __contains__(self, file_id):
996
329
        """True if this entry contains a file with given id.
997
330
 
998
331
        >>> inv = Inventory()
999
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1000
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
332
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
333
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
1001
334
        >>> '123' in inv
1002
335
        True
1003
336
        >>> '456' in inv
1005
338
        """
1006
339
        return file_id in self._byid
1007
340
 
 
341
 
1008
342
    def __getitem__(self, file_id):
1009
343
        """Return the entry for given file_id.
1010
344
 
1011
345
        >>> inv = Inventory()
1012
 
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1013
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
346
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
 
347
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
1014
348
        >>> inv['123123'].name
1015
349
        'hello.c'
1016
350
        """
1017
351
        try:
1018
352
            return self._byid[file_id]
1019
353
        except KeyError:
1020
 
            if file_id is None:
 
354
            if file_id == None:
1021
355
                raise BzrError("can't look up file_id None")
1022
356
            else:
1023
357
                raise BzrError("file_id {%s} not in inventory" % file_id)
1024
358
 
 
359
 
1025
360
    def get_file_kind(self, file_id):
1026
361
        return self._byid[file_id].kind
1027
362
 
1028
363
    def get_child(self, parent_id, filename):
1029
364
        return self[parent_id].children.get(filename)
1030
365
 
 
366
 
1031
367
    def add(self, entry):
1032
368
        """Add entry to inventory.
1033
369
 
1047
383
        except KeyError:
1048
384
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
1049
385
 
1050
 
        if entry.name in parent.children:
 
386
        if parent.children.has_key(entry.name):
1051
387
            raise BzrError("%s is already versioned" %
1052
 
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
388
                    appendpath(self.id2path(parent.file_id), entry.name))
1053
389
 
1054
390
        self._byid[entry.file_id] = entry
1055
391
        parent.children[entry.name] = entry
1056
392
        return entry
1057
393
 
1058
 
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
 
394
 
 
395
    def add_path(self, relpath, kind, file_id=None):
1059
396
        """Add entry from a path.
1060
397
 
1061
398
        The immediate parent must already be versioned.
1062
399
 
1063
400
        Returns the new entry object."""
 
401
        from bzrlib.branch import gen_file_id
1064
402
        
1065
403
        parts = bzrlib.osutils.splitpath(relpath)
1066
 
 
1067
404
        if len(parts) == 0:
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)
 
405
            raise BzrError("cannot re-add root of inventory")
 
406
 
 
407
        if file_id == None:
 
408
            file_id = gen_file_id(relpath)
 
409
 
 
410
        parent_path = parts[:-1]
 
411
        parent_id = self.path2id(parent_path)
 
412
        if parent_id == None:
 
413
            raise NotVersionedError(parent_path)
 
414
 
 
415
        ie = InventoryEntry(file_id, parts[-1],
 
416
                            kind=kind, parent_id=parent_id)
1079
417
        return self.add(ie)
1080
418
 
 
419
 
1081
420
    def __delitem__(self, file_id):
1082
421
        """Remove entry by id.
1083
422
 
1084
423
        >>> inv = Inventory()
1085
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1086
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
 
424
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
 
425
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
1087
426
        >>> '123' in inv
1088
427
        True
1089
428
        >>> del inv['123']
1092
431
        """
1093
432
        ie = self[file_id]
1094
433
 
1095
 
        assert ie.parent_id is None or \
1096
 
            self[ie.parent_id].children[ie.name] == ie
 
434
        assert self[ie.parent_id].children[ie.name] == ie
1097
435
        
 
436
        # TODO: Test deleting all children; maybe hoist to a separate
 
437
        # deltree method?
 
438
        if ie.kind == 'directory':
 
439
            for cie in ie.children.values():
 
440
                del self[cie.file_id]
 
441
            del ie.children
 
442
 
1098
443
        del self._byid[file_id]
1099
 
        if ie.parent_id is not None:
1100
 
            del self[ie.parent_id].children[ie.name]
 
444
        del self[ie.parent_id].children[ie.name]
 
445
 
1101
446
 
1102
447
    def __eq__(self, other):
1103
448
        """Compare two sets by comparing their contents.
1106
451
        >>> i2 = Inventory()
1107
452
        >>> i1 == i2
1108
453
        True
1109
 
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1110
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
454
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
455
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
1111
456
        >>> i1 == i2
1112
457
        False
1113
 
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1114
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
 
458
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
 
459
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
1115
460
        >>> i1 == i2
1116
461
        True
1117
462
        """
1118
463
        if not isinstance(other, Inventory):
1119
464
            return NotImplemented
1120
465
 
 
466
        if len(self._byid) != len(other._byid):
 
467
            # shortcut: obviously not the same
 
468
            return False
 
469
 
1121
470
        return self._byid == other._byid
1122
471
 
 
472
 
1123
473
    def __ne__(self, other):
1124
 
        return not self.__eq__(other)
 
474
        return not (self == other)
 
475
 
1125
476
 
1126
477
    def __hash__(self):
1127
478
        raise ValueError('not hashable')
1128
479
 
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
1138
480
 
1139
481
    def get_idpath(self, file_id):
1140
482
        """Return a list of file_ids for the path to an entry.
1145
487
        root directory as depth 1.
1146
488
        """
1147
489
        p = []
1148
 
        for parent in self._iter_file_id_parents(file_id):
1149
 
            p.insert(0, parent.file_id)
 
490
        while file_id != None:
 
491
            try:
 
492
                ie = self._byid[file_id]
 
493
            except KeyError:
 
494
                raise BzrError("file_id {%s} not found in inventory" % file_id)
 
495
            p.insert(0, ie.file_id)
 
496
            file_id = ie.parent_id
1150
497
        return p
1151
498
 
 
499
 
1152
500
    def id2path(self, file_id):
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
 
        """
 
501
        """Return as a list the path to file_id."""
 
502
 
1161
503
        # get all names, skipping root
1162
 
        return '/'.join(reversed(
1163
 
            [parent.name for parent in 
1164
 
             self._iter_file_id_parents(file_id)][:-1]))
 
504
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
 
505
        return os.sep.join(p)
1165
506
            
 
507
 
 
508
 
1166
509
    def path2id(self, name):
1167
510
        """Walk down through directories to return entry of last component.
1168
511
 
1172
515
        This returns the entry of the last component in the path,
1173
516
        which may be either a file or a directory.
1174
517
 
1175
 
        Returns None IFF the path is not found.
 
518
        Returns None iff the path is not found.
1176
519
        """
1177
520
        if isinstance(name, types.StringTypes):
1178
521
            name = splitpath(name)
1179
522
 
1180
 
        # mutter("lookup path %r" % name)
 
523
        mutter("lookup path %r" % name)
1181
524
 
1182
525
        parent = self.root
1183
526
        for f in name:
1192
535
 
1193
536
        return parent.file_id
1194
537
 
 
538
 
1195
539
    def has_filename(self, names):
1196
540
        return bool(self.path2id(names))
1197
541
 
 
542
 
1198
543
    def has_id(self, file_id):
1199
544
        return self._byid.has_key(file_id)
1200
545
 
 
546
 
1201
547
    def rename(self, file_id, new_parent_id, new_name):
1202
548
        """Move a file within the inventory.
1203
549
 
1228
574
        file_ie.parent_id = new_parent_id
1229
575
 
1230
576
 
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
577
 
1251
578
 
1252
579
_NAME_RE = None
1253
580
 
1254
581
def is_valid_name(name):
1255
582
    global _NAME_RE
1256
 
    if _NAME_RE is None:
 
583
    if _NAME_RE == None:
1257
584
        _NAME_RE = re.compile(r'^[^/\\]+$')
1258
585
        
1259
586
    return bool(_NAME_RE.match(name))