~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Martin Pool
  • Date: 2005-05-09 03:03:55 UTC
  • Revision ID: mbp@sourcefrog.net-20050509030355-ad6ab558d1362959
- Don't give an error if the trace file can't be opened

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# (C) 2005 Canonical Ltd
2
 
#
 
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 os.path
32
 
import re
33
 
import sys
34
 
import tarfile
35
 
import types
 
23
import sys, os.path, types, re
 
24
from sets import Set
 
25
 
 
26
try:
 
27
    from cElementTree import Element, ElementTree, SubElement
 
28
except ImportError:
 
29
    from elementtree.ElementTree import Element, ElementTree, SubElement
 
30
 
 
31
from xml import XMLMixin
 
32
from errors import bailout, BzrError, BzrCheckError
36
33
 
37
34
import bzrlib
38
 
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
39
 
                            pathjoin, sha_strings)
 
35
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
40
36
from bzrlib.trace import mutter
41
 
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
42
 
                           BzrError, BzrCheckError)
43
 
 
44
 
 
45
 
class InventoryEntry(object):
 
37
 
 
38
class InventoryEntry(XMLMixin):
46
39
    """Description of a versioned file.
47
40
 
48
41
    An InventoryEntry has the following fields, which are also
49
42
    present in the XML inventory-entry element:
50
43
 
51
 
    file_id
52
 
 
53
 
    name
54
 
        (within the parent directory)
55
 
 
56
 
    parent_id
57
 
        file_id of the parent directory, or ROOT_ID
58
 
 
59
 
    revision
60
 
        the revision_id in which this variation of this file was 
61
 
        introduced.
62
 
 
63
 
    executable
64
 
        Indicates that this file should be executable on systems
65
 
        that support it.
66
 
 
67
 
    text_sha1
68
 
        sha-1 of the text of the file
69
 
        
70
 
    text_size
71
 
        size in bytes of the text of the file
72
 
        
73
 
    (reading a version 4 tree created a text_id field.)
 
44
    * *file_id*
 
45
    * *name*: (only the basename within the directory, must not
 
46
      contain slashes)
 
47
    * *kind*: "directory" or "file"
 
48
    * *directory_id*: (if absent/null means the branch root directory)
 
49
    * *text_sha1*: only for files
 
50
    * *text_size*: in bytes, only for files 
 
51
    * *text_id*: identifier for the text version, only for files
 
52
 
 
53
    InventoryEntries can also exist inside a WorkingTree
 
54
    inventory, in which case they are not yet bound to a
 
55
    particular revision of the file.  In that case the text_sha1,
 
56
    text_size and text_id are absent.
 
57
 
74
58
 
75
59
    >>> i = Inventory()
76
60
    >>> i.path2id('')
77
61
    'TREE_ROOT'
78
 
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
79
 
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
80
 
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
81
 
    InventoryFile('2323', 'hello.c', parent_id='123')
82
 
    >>> shouldbe = {0: 'src', 1: pathjoin('src','hello.c')}
83
 
    >>> for ix, j in enumerate(i.iter_entries()):
84
 
    ...   print (j[0] == shouldbe[ix], j[1])
 
62
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
 
63
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
 
64
    >>> for j in i.iter_entries():
 
65
    ...   print j
85
66
    ... 
86
 
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
87
 
    (True, InventoryFile('2323', 'hello.c', parent_id='123'))
88
 
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
 
67
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
 
68
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
 
69
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
89
70
    Traceback (most recent call last):
90
71
    ...
91
 
    BzrError: inventory already contains entry with id {2323}
92
 
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
93
 
    InventoryFile('2324', 'bye.c', parent_id='123')
94
 
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
95
 
    InventoryDirectory('2325', 'wibble', parent_id='123')
 
72
    BzrError: ('inventory already contains entry with id {2323}', [])
 
73
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
 
74
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
96
75
    >>> i.path2id('src/wibble')
97
76
    '2325'
98
77
    >>> '2325' in i
99
78
    True
100
 
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
101
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
79
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
102
80
    >>> i['2326']
103
 
    InventoryFile('2326', 'wibble.c', parent_id='2325')
104
 
    >>> for path, entry in i.iter_entries():
105
 
    ...     print path
106
 
    ...     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])
107
85
    ... 
108
86
    src
109
87
    src/bye.c
112
90
    src/wibble/wibble.c
113
91
    >>> i.id2path('2326')
114
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.
115
97
    """
 
98
 
 
99
    # TODO: split InventoryEntry into subclasses for files,
 
100
    # directories, etc etc.
 
101
 
 
102
    text_sha1 = None
 
103
    text_size = None
116
104
    
117
 
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
118
 
                 'text_id', 'parent_id', 'children', 'executable', 
119
 
                 'revision']
120
 
 
121
 
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
122
 
        versionedfile = weave_store.get_weave_or_empty(self.file_id,
123
 
                                                       transaction)
124
 
        versionedfile.add_lines(self.revision, parents, new_lines)
125
 
 
126
 
    def detect_changes(self, old_entry):
127
 
        """Return a (text_modified, meta_modified) from this to old_entry.
128
 
        
129
 
        _read_tree_state must have been called on self and old_entry prior to 
130
 
        calling detect_changes.
131
 
        """
132
 
        return False, False
133
 
 
134
 
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
135
 
             output_to, reverse=False):
136
 
        """Perform a diff from this to to_entry.
137
 
 
138
 
        text_diff will be used for textual difference calculation.
139
 
        This is a template method, override _diff in child classes.
140
 
        """
141
 
        self._read_tree_state(tree.id2path(self.file_id), tree)
142
 
        if to_entry:
143
 
            # cannot diff from one kind to another - you must do a removal
144
 
            # and an addif they do not match.
145
 
            assert self.kind == to_entry.kind
146
 
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
147
 
                                      to_tree)
148
 
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
149
 
                   output_to, reverse)
150
 
 
151
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
152
 
             output_to, reverse=False):
153
 
        """Perform a diff between two entries of the same kind."""
154
 
 
155
 
    def find_previous_heads(self, previous_inventories,
156
 
                            versioned_file_store,
157
 
                            transaction,
158
 
                            entry_vf=None):
159
 
        """Return the revisions and entries that directly preceed this.
160
 
 
161
 
        Returned as a map from revision to inventory entry.
162
 
 
163
 
        This is a map containing the file revisions in all parents
164
 
        for which the file exists, and its revision is not a parent of
165
 
        any other. If the file is new, the set will be empty.
166
 
 
167
 
        :param versioned_file_store: A store where ancestry data on this
168
 
                                     file id can be queried.
169
 
        :param transaction: The transaction that queries to the versioned 
170
 
                            file store should be completed under.
171
 
        :param entry_vf: The entry versioned file, if its already available.
172
 
        """
173
 
        def get_ancestors(weave, entry):
174
 
            return set(weave.get_ancestry(entry.revision))
175
 
        # revision:ie mapping for each ie found in previous_inventories.
176
 
        candidates = {}
177
 
        # revision:ie mapping with one revision for each head.
178
 
        heads = {}
179
 
        # revision: ancestor list for each head
180
 
        head_ancestors = {}
181
 
        # identify candidate head revision ids.
182
 
        for inv in previous_inventories:
183
 
            if self.file_id in inv:
184
 
                ie = inv[self.file_id]
185
 
                assert ie.file_id == self.file_id
186
 
                if ie.revision in candidates:
187
 
                    # same revision value in two different inventories:
188
 
                    # correct possible inconsistencies:
189
 
                    #     * there was a bug in revision updates with 'x' bit 
190
 
                    #       support.
191
 
                    try:
192
 
                        if candidates[ie.revision].executable != ie.executable:
193
 
                            candidates[ie.revision].executable = False
194
 
                            ie.executable = False
195
 
                    except AttributeError:
196
 
                        pass
197
 
                    # must now be the same.
198
 
                    assert candidates[ie.revision] == ie
199
 
                else:
200
 
                    # add this revision as a candidate.
201
 
                    candidates[ie.revision] = ie
202
 
 
203
 
        # common case optimisation
204
 
        if len(candidates) == 1:
205
 
            # if there is only one candidate revision found
206
 
            # then we can opening the versioned file to access ancestry:
207
 
            # there cannot be any ancestors to eliminate when there is 
208
 
            # only one revision available.
209
 
            heads[ie.revision] = ie
210
 
            return heads
211
 
 
212
 
        # eliminate ancestors amongst the available candidates:
213
 
        # heads are those that are not an ancestor of any other candidate
214
 
        # - this provides convergence at a per-file level.
215
 
        for ie in candidates.values():
216
 
            # may be an ancestor of a known head:
217
 
            already_present = 0 != len(
218
 
                [head for head in heads 
219
 
                 if ie.revision in head_ancestors[head]])
220
 
            if already_present:
221
 
                # an ancestor of an analyzed candidate.
222
 
                continue
223
 
            # not an ancestor of a known head:
224
 
            # load the versioned file for this file id if needed
225
 
            if entry_vf is None:
226
 
                entry_vf = versioned_file_store.get_weave_or_empty(
227
 
                    self.file_id, transaction)
228
 
            ancestors = get_ancestors(entry_vf, ie)
229
 
            # may knock something else out:
230
 
            check_heads = list(heads.keys())
231
 
            for head in check_heads:
232
 
                if head in ancestors:
233
 
                    # this previously discovered 'head' is not
234
 
                    # really a head - its an ancestor of the newly 
235
 
                    # found head,
236
 
                    heads.pop(head)
237
 
            head_ancestors[ie.revision] = ancestors
238
 
            heads[ie.revision] = ie
239
 
        return heads
240
 
 
241
 
    def get_tar_item(self, root, dp, now, tree):
242
 
        """Get a tarfile item and a file stream for its content."""
243
 
        item = tarfile.TarInfo(pathjoin(root, dp))
244
 
        # TODO: would be cool to actually set it to the timestamp of the
245
 
        # revision it was last changed
246
 
        item.mtime = now
247
 
        fileobj = self._put_in_tar(item, tree)
248
 
        return item, fileobj
249
 
 
250
 
    def has_text(self):
251
 
        """Return true if the object this entry represents has textual data.
252
 
 
253
 
        Note that textual data includes binary content.
254
 
 
255
 
        Also note that all entries get weave files created for them.
256
 
        This attribute is primarily used when upgrading from old trees that
257
 
        did not have the weave index for all inventory entries.
258
 
        """
259
 
        return False
260
 
 
261
 
    def __init__(self, file_id, name, parent_id, text_id=None):
 
105
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
262
106
        """Create an InventoryEntry
263
107
        
264
108
        The filename must be a single component, relative to the
265
109
        parent directory; it cannot be a whole path or relative name.
266
110
 
267
 
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
 
111
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
268
112
        >>> e.name
269
113
        'hello.c'
270
114
        >>> e.file_id
271
115
        '123'
272
 
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
 
116
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
273
117
        Traceback (most recent call last):
274
 
        InvalidEntryName: Invalid entry name: src/hello.c
 
118
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
275
119
        """
276
 
        assert isinstance(name, basestring), name
277
120
        if '/' in name or '\\' in name:
278
 
            raise InvalidEntryName(name=name)
279
 
        self.executable = False
280
 
        self.revision = None
281
 
        self.text_sha1 = None
282
 
        self.text_size = None
 
121
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
 
122
        
283
123
        self.file_id = file_id
284
124
        self.name = name
 
125
        self.kind = kind
285
126
        self.text_id = text_id
286
127
        self.parent_id = parent_id
287
 
        self.symlink_target = None
288
 
 
289
 
    def kind_character(self):
290
 
        """Return a short kind indicator useful for appending to names."""
291
 
        raise BzrError('unknown kind %r' % self.kind)
292
 
 
293
 
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
294
 
 
295
 
    def _put_in_tar(self, item, tree):
296
 
        """populate item for stashing in a tar, and return the content stream.
297
 
 
298
 
        If no content is available, return None.
299
 
        """
300
 
        raise BzrError("don't know how to export {%s} of kind %r" %
301
 
                       (self.file_id, self.kind))
302
 
 
303
 
    def put_on_disk(self, dest, dp, tree):
304
 
        """Create a representation of self on disk in the prefix dest.
305
 
        
306
 
        This is a template method - implement _put_on_disk in subclasses.
307
 
        """
308
 
        fullpath = pathjoin(dest, dp)
309
 
        self._put_on_disk(fullpath, tree)
310
 
        mutter("  export {%s} kind %s to %s", self.file_id,
311
 
                self.kind, fullpath)
312
 
 
313
 
    def _put_on_disk(self, fullpath, tree):
314
 
        """Put this entry onto disk at fullpath, from tree tree."""
315
 
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
 
128
        if kind == 'directory':
 
129
            self.children = {}
 
130
        elif kind == 'file':
 
131
            pass
 
132
        else:
 
133
            raise BzrError("unhandled entry kind %r" % kind)
 
134
 
 
135
 
316
136
 
317
137
    def sorted_children(self):
318
138
        l = self.children.items()
319
139
        l.sort()
320
140
        return l
321
141
 
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
 
        if self.parent_id != None:
333
 
            if not inv.has_id(self.parent_id):
334
 
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
335
 
                        % (self.parent_id, rev_id))
336
 
        self._check(checker, rev_id, tree)
337
 
 
338
 
    def _check(self, checker, rev_id, tree):
339
 
        """Check this inventory entry for kind specific errors."""
340
 
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
341
 
                            (self.kind, rev_id))
342
 
 
343
142
 
344
143
    def copy(self):
345
 
        """Clone this inventory entry."""
346
 
        raise NotImplementedError
 
144
        other = InventoryEntry(self.file_id, self.name, self.kind,
 
145
                               self.parent_id, text_id=self.text_id)
 
146
        other.text_sha1 = self.text_sha1
 
147
        other.text_size = self.text_size
 
148
        return other
347
149
 
348
 
    def _get_snapshot_change(self, previous_entries):
349
 
        if len(previous_entries) > 1:
350
 
            return 'merged'
351
 
        elif len(previous_entries) == 0:
352
 
            return 'added'
353
 
        else:
354
 
            return 'modified/renamed/reparented'
355
150
 
356
151
    def __repr__(self):
357
 
        return ("%s(%r, %r, parent_id=%r)"
 
152
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
358
153
                % (self.__class__.__name__,
359
154
                   self.file_id,
360
155
                   self.name,
 
156
                   self.kind,
361
157
                   self.parent_id))
362
158
 
363
 
    def snapshot(self, revision, path, previous_entries,
364
 
                 work_tree, weave_store, transaction):
365
 
        """Make a snapshot of this entry which may or may not have changed.
366
 
        
367
 
        This means that all its fields are populated, that it has its
368
 
        text stored in the text store or weave.
369
 
        """
370
 
        mutter('new parents of %s are %r', path, previous_entries)
371
 
        self._read_tree_state(path, work_tree)
372
 
        if len(previous_entries) == 1:
373
 
            # cannot be unchanged unless there is only one parent file rev.
374
 
            parent_ie = previous_entries.values()[0]
375
 
            if self._unchanged(parent_ie):
376
 
                mutter("found unchanged entry")
377
 
                self.revision = parent_ie.revision
378
 
                return "unchanged"
379
 
        return self.snapshot_revision(revision, previous_entries, 
380
 
                                      work_tree, weave_store, transaction)
381
 
 
382
 
    def snapshot_revision(self, revision, previous_entries, work_tree,
383
 
                          weave_store, transaction):
384
 
        """Record this revision unconditionally."""
385
 
        mutter('new revision for {%s}', self.file_id)
386
 
        self.revision = revision
387
 
        change = self._get_snapshot_change(previous_entries)
388
 
        self._snapshot_text(previous_entries, work_tree, weave_store,
389
 
                            transaction)
390
 
        return change
391
 
 
392
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
393
 
        """Record the 'text' of this entry, whatever form that takes.
394
 
        
395
 
        This default implementation simply adds an empty text.
396
 
        """
397
 
        mutter('storing file {%s} in revision {%s}',
398
 
               self.file_id, self.revision)
399
 
        self._add_text_to_weave([], file_parents.keys(), weave_store, transaction)
400
 
 
401
 
    def __eq__(self, other):
 
159
    
 
160
    def to_element(self):
 
161
        """Convert to XML element"""
 
162
        e = Element('entry')
 
163
 
 
164
        e.set('name', self.name)
 
165
        e.set('file_id', self.file_id)
 
166
        e.set('kind', self.kind)
 
167
 
 
168
        if self.text_size != None:
 
169
            e.set('text_size', '%d' % self.text_size)
 
170
            
 
171
        for f in ['text_id', 'text_sha1']:
 
172
            v = getattr(self, f)
 
173
            if v != None:
 
174
                e.set(f, v)
 
175
 
 
176
        # to be conservative, we don't externalize the root pointers
 
177
        # for now, leaving them as null in the xml form.  in a future
 
178
        # version it will be implied by nested elements.
 
179
        if self.parent_id != ROOT_ID:
 
180
            assert isinstance(self.parent_id, basestring)
 
181
            e.set('parent_id', self.parent_id)
 
182
 
 
183
        e.tail = '\n'
 
184
            
 
185
        return e
 
186
 
 
187
 
 
188
    def from_element(cls, elt):
 
189
        assert elt.tag == 'entry'
 
190
 
 
191
        ## original format inventories don't have a parent_id for
 
192
        ## nodes in the root directory, but it's cleaner to use one
 
193
        ## internally.
 
194
        parent_id = elt.get('parent_id')
 
195
        if parent_id == None:
 
196
            parent_id = ROOT_ID
 
197
 
 
198
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
 
199
        self.text_id = elt.get('text_id')
 
200
        self.text_sha1 = elt.get('text_sha1')
 
201
        
 
202
        ## mutter("read inventoryentry: %r" % (elt.attrib))
 
203
 
 
204
        v = elt.get('text_size')
 
205
        self.text_size = v and int(v)
 
206
 
 
207
        return self
 
208
            
 
209
 
 
210
    from_element = classmethod(from_element)
 
211
 
 
212
    def __cmp__(self, other):
 
213
        if self is other:
 
214
            return 0
402
215
        if not isinstance(other, InventoryEntry):
403
216
            return NotImplemented
404
217
 
405
 
        return ((self.file_id == other.file_id)
406
 
                and (self.name == other.name)
407
 
                and (other.symlink_target == self.symlink_target)
408
 
                and (self.text_sha1 == other.text_sha1)
409
 
                and (self.text_size == other.text_size)
410
 
                and (self.text_id == other.text_id)
411
 
                and (self.parent_id == other.parent_id)
412
 
                and (self.kind == other.kind)
413
 
                and (self.revision == other.revision)
414
 
                and (self.executable == other.executable)
415
 
                )
416
 
 
417
 
    def __ne__(self, other):
418
 
        return not (self == other)
419
 
 
420
 
    def __hash__(self):
421
 
        raise ValueError('not hashable')
422
 
 
423
 
    def _unchanged(self, previous_ie):
424
 
        """Has this entry changed relative to previous_ie.
425
 
 
426
 
        This method should be overriden in child classes.
427
 
        """
428
 
        compatible = True
429
 
        # different inv parent
430
 
        if previous_ie.parent_id != self.parent_id:
431
 
            compatible = False
432
 
        # renamed
433
 
        elif previous_ie.name != self.name:
434
 
            compatible = False
435
 
        return compatible
436
 
 
437
 
    def _read_tree_state(self, path, work_tree):
438
 
        """Populate fields in the inventory entry from the given tree.
439
 
        
440
 
        Note that this should be modified to be a noop on virtual trees
441
 
        as all entries created there are prepopulated.
442
 
        """
443
 
        # TODO: Rather than running this manually, we should check the 
444
 
        # working sha1 and other expensive properties when they're
445
 
        # first requested, or preload them if they're already known
446
 
        pass            # nothing to do by default
447
 
 
448
 
    def _forget_tree_state(self):
449
 
        pass
 
218
        return cmp(self.file_id, other.file_id) \
 
219
               or cmp(self.name, other.name) \
 
220
               or cmp(self.text_sha1, other.text_sha1) \
 
221
               or cmp(self.text_size, other.text_size) \
 
222
               or cmp(self.text_id, other.text_id) \
 
223
               or cmp(self.parent_id, other.parent_id) \
 
224
               or cmp(self.kind, other.kind)
 
225
 
450
226
 
451
227
 
452
228
class RootEntry(InventoryEntry):
453
 
 
454
 
    def _check(self, checker, rev_id, tree):
455
 
        """See InventoryEntry._check"""
456
 
 
457
229
    def __init__(self, file_id):
458
230
        self.file_id = file_id
459
231
        self.children = {}
460
232
        self.kind = 'root_directory'
461
233
        self.parent_id = None
462
 
        self.name = u''
 
234
        self.name = ''
463
235
 
464
 
    def __eq__(self, other):
 
236
    def __cmp__(self, other):
 
237
        if self is other:
 
238
            return 0
465
239
        if not isinstance(other, RootEntry):
466
240
            return NotImplemented
467
 
        
468
 
        return (self.file_id == other.file_id) \
469
 
               and (self.children == other.children)
470
 
 
471
 
 
472
 
class InventoryDirectory(InventoryEntry):
473
 
    """A directory in an inventory."""
474
 
 
475
 
    def _check(self, checker, rev_id, tree):
476
 
        """See InventoryEntry._check"""
477
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
478
 
            raise BzrCheckError('directory {%s} has text in revision {%s}'
479
 
                                % (self.file_id, rev_id))
480
 
 
481
 
    def copy(self):
482
 
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
483
 
        other.revision = self.revision
484
 
        # note that children are *not* copied; they're pulled across when
485
 
        # others are added
486
 
        return other
487
 
 
488
 
    def __init__(self, file_id, name, parent_id):
489
 
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
490
 
        self.children = {}
491
 
        self.kind = 'directory'
492
 
 
493
 
    def kind_character(self):
494
 
        """See InventoryEntry.kind_character."""
495
 
        return '/'
496
 
 
497
 
    def _put_in_tar(self, item, tree):
498
 
        """See InventoryEntry._put_in_tar."""
499
 
        item.type = tarfile.DIRTYPE
500
 
        fileobj = None
501
 
        item.name += '/'
502
 
        item.size = 0
503
 
        item.mode = 0755
504
 
        return fileobj
505
 
 
506
 
    def _put_on_disk(self, fullpath, tree):
507
 
        """See InventoryEntry._put_on_disk."""
508
 
        os.mkdir(fullpath)
509
 
 
510
 
 
511
 
class InventoryFile(InventoryEntry):
512
 
    """A file in an inventory."""
513
 
 
514
 
    def _check(self, checker, rev_id, tree):
515
 
        """See InventoryEntry._check"""
516
 
        revision = self.revision
517
 
        t = (self.file_id, revision)
518
 
        if t in checker.checked_texts:
519
 
            prev_sha = checker.checked_texts[t] 
520
 
            if prev_sha != self.text_sha1:
521
 
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
522
 
                                    (self.file_id, rev_id))
523
 
            else:
524
 
                checker.repeated_text_cnt += 1
525
 
                return
526
 
 
527
 
        if self.file_id not in checker.checked_weaves:
528
 
            mutter('check weave {%s}', self.file_id)
529
 
            w = tree.get_weave(self.file_id)
530
 
            # Not passing a progress bar, because it creates a new
531
 
            # progress, which overwrites the current progress,
532
 
            # and doesn't look nice
533
 
            w.check()
534
 
            checker.checked_weaves[self.file_id] = True
535
 
        else:
536
 
            w = tree.get_weave(self.file_id)
537
 
 
538
 
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
539
 
        checker.checked_text_cnt += 1 
540
 
        # We can't check the length, because Weave doesn't store that
541
 
        # information, and the whole point of looking at the weave's
542
 
        # sha1sum is that we don't have to extract the text.
543
 
        if self.text_sha1 != w.get_sha1(self.revision):
544
 
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
545
 
                                % (self.file_id, self.revision))
546
 
        checker.checked_texts[t] = self.text_sha1
547
 
 
548
 
    def copy(self):
549
 
        other = InventoryFile(self.file_id, self.name, self.parent_id)
550
 
        other.executable = self.executable
551
 
        other.text_id = self.text_id
552
 
        other.text_sha1 = self.text_sha1
553
 
        other.text_size = self.text_size
554
 
        other.revision = self.revision
555
 
        return other
556
 
 
557
 
    def detect_changes(self, old_entry):
558
 
        """See InventoryEntry.detect_changes."""
559
 
        assert self.text_sha1 != None
560
 
        assert old_entry.text_sha1 != None
561
 
        text_modified = (self.text_sha1 != old_entry.text_sha1)
562
 
        meta_modified = (self.executable != old_entry.executable)
563
 
        return text_modified, meta_modified
564
 
 
565
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
566
 
             output_to, reverse=False):
567
 
        """See InventoryEntry._diff."""
568
 
        from_text = tree.get_file(self.file_id).readlines()
569
 
        if to_entry:
570
 
            to_text = to_tree.get_file(to_entry.file_id).readlines()
571
 
        else:
572
 
            to_text = []
573
 
        if not reverse:
574
 
            text_diff(from_label, from_text,
575
 
                      to_label, to_text, output_to)
576
 
        else:
577
 
            text_diff(to_label, to_text,
578
 
                      from_label, from_text, output_to)
579
 
 
580
 
    def has_text(self):
581
 
        """See InventoryEntry.has_text."""
582
 
        return True
583
 
 
584
 
    def __init__(self, file_id, name, parent_id):
585
 
        super(InventoryFile, self).__init__(file_id, name, parent_id)
586
 
        self.kind = 'file'
587
 
 
588
 
    def kind_character(self):
589
 
        """See InventoryEntry.kind_character."""
590
 
        return ''
591
 
 
592
 
    def _put_in_tar(self, item, tree):
593
 
        """See InventoryEntry._put_in_tar."""
594
 
        item.type = tarfile.REGTYPE
595
 
        fileobj = tree.get_file(self.file_id)
596
 
        item.size = self.text_size
597
 
        if tree.is_executable(self.file_id):
598
 
            item.mode = 0755
599
 
        else:
600
 
            item.mode = 0644
601
 
        return fileobj
602
 
 
603
 
    def _put_on_disk(self, fullpath, tree):
604
 
        """See InventoryEntry._put_on_disk."""
605
 
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
606
 
        if tree.is_executable(self.file_id):
607
 
            os.chmod(fullpath, 0755)
608
 
 
609
 
    def _read_tree_state(self, path, work_tree):
610
 
        """See InventoryEntry._read_tree_state."""
611
 
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
612
 
        self.executable = work_tree.is_executable(self.file_id)
613
 
 
614
 
    def _forget_tree_state(self):
615
 
        self.text_sha1 = None
616
 
        self.executable = None
617
 
 
618
 
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
619
 
        """See InventoryEntry._snapshot_text."""
620
 
        mutter('storing file {%s} in revision {%s}',
621
 
               self.file_id, self.revision)
622
 
        # special case to avoid diffing on renames or 
623
 
        # reparenting
624
 
        if (len(file_parents) == 1
625
 
            and self.text_sha1 == file_parents.values()[0].text_sha1
626
 
            and self.text_size == file_parents.values()[0].text_size):
627
 
            previous_ie = file_parents.values()[0]
628
 
            versionedfile = weave_store.get_weave(self.file_id, transaction)
629
 
            versionedfile.clone_text(self.revision, previous_ie.revision, file_parents.keys())
630
 
        else:
631
 
            new_lines = work_tree.get_file(self.file_id).readlines()
632
 
            self._add_text_to_weave(new_lines, file_parents.keys(), weave_store,
633
 
                                    transaction)
634
 
            self.text_sha1 = sha_strings(new_lines)
635
 
            self.text_size = sum(map(len, new_lines))
636
 
 
637
 
 
638
 
    def _unchanged(self, previous_ie):
639
 
        """See InventoryEntry._unchanged."""
640
 
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
641
 
        if self.text_sha1 != previous_ie.text_sha1:
642
 
            compatible = False
643
 
        else:
644
 
            # FIXME: 20050930 probe for the text size when getting sha1
645
 
            # in _read_tree_state
646
 
            self.text_size = previous_ie.text_size
647
 
        if self.executable != previous_ie.executable:
648
 
            compatible = False
649
 
        return compatible
650
 
 
651
 
 
652
 
class InventoryLink(InventoryEntry):
653
 
    """A file in an inventory."""
654
 
 
655
 
    __slots__ = ['symlink_target']
656
 
 
657
 
    def _check(self, checker, rev_id, tree):
658
 
        """See InventoryEntry._check"""
659
 
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
660
 
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
661
 
                    % (self.file_id, rev_id))
662
 
        if self.symlink_target == None:
663
 
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
664
 
                    % (self.file_id, rev_id))
665
 
 
666
 
    def copy(self):
667
 
        other = InventoryLink(self.file_id, self.name, self.parent_id)
668
 
        other.symlink_target = self.symlink_target
669
 
        other.revision = self.revision
670
 
        return other
671
 
 
672
 
    def detect_changes(self, old_entry):
673
 
        """See InventoryEntry.detect_changes."""
674
 
        # FIXME: which _modified field should we use ? RBC 20051003
675
 
        text_modified = (self.symlink_target != old_entry.symlink_target)
676
 
        if text_modified:
677
 
            mutter("    symlink target changed")
678
 
        meta_modified = False
679
 
        return text_modified, meta_modified
680
 
 
681
 
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
682
 
             output_to, reverse=False):
683
 
        """See InventoryEntry._diff."""
684
 
        from_text = self.symlink_target
685
 
        if to_entry is not None:
686
 
            to_text = to_entry.symlink_target
687
 
            if reverse:
688
 
                temp = from_text
689
 
                from_text = to_text
690
 
                to_text = temp
691
 
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
692
 
        else:
693
 
            if not reverse:
694
 
                print >>output_to, '=== target was %r' % self.symlink_target
695
 
            else:
696
 
                print >>output_to, '=== target is %r' % self.symlink_target
697
 
 
698
 
    def __init__(self, file_id, name, parent_id):
699
 
        super(InventoryLink, self).__init__(file_id, name, parent_id)
700
 
        self.kind = 'symlink'
701
 
 
702
 
    def kind_character(self):
703
 
        """See InventoryEntry.kind_character."""
704
 
        return ''
705
 
 
706
 
    def _put_in_tar(self, item, tree):
707
 
        """See InventoryEntry._put_in_tar."""
708
 
        item.type = tarfile.SYMTYPE
709
 
        fileobj = None
710
 
        item.size = 0
711
 
        item.mode = 0755
712
 
        item.linkname = self.symlink_target
713
 
        return fileobj
714
 
 
715
 
    def _put_on_disk(self, fullpath, tree):
716
 
        """See InventoryEntry._put_on_disk."""
717
 
        try:
718
 
            os.symlink(self.symlink_target, fullpath)
719
 
        except OSError,e:
720
 
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
721
 
 
722
 
    def _read_tree_state(self, path, work_tree):
723
 
        """See InventoryEntry._read_tree_state."""
724
 
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
725
 
 
726
 
    def _forget_tree_state(self):
727
 
        self.symlink_target = None
728
 
 
729
 
    def _unchanged(self, previous_ie):
730
 
        """See InventoryEntry._unchanged."""
731
 
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
732
 
        if self.symlink_target != previous_ie.symlink_target:
733
 
            compatible = False
734
 
        return compatible
735
 
 
736
 
 
737
 
class Inventory(object):
 
241
        return cmp(self.file_id, other.file_id) \
 
242
               or cmp(self.children, other.children)
 
243
 
 
244
 
 
245
 
 
246
class Inventory(XMLMixin):
738
247
    """Inventory of versioned files in a tree.
739
248
 
740
249
    This describes which file_id is present at each point in the tree,
752
261
    inserted, other than through the Inventory API.
753
262
 
754
263
    >>> inv = Inventory()
755
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
756
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
 
264
    >>> inv.write_xml(sys.stdout)
 
265
    <inventory>
 
266
    </inventory>
 
267
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
757
268
    >>> inv['123-123'].name
758
269
    'hello.c'
759
270
 
768
279
 
769
280
    >>> [x[0] for x in inv.iter_entries()]
770
281
    ['hello.c']
771
 
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
772
 
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
773
 
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
 
282
    
 
283
    >>> inv.write_xml(sys.stdout)
 
284
    <inventory>
 
285
    <entry file_id="123-123" kind="file" name="hello.c" />
 
286
    </inventory>
 
287
 
774
288
    """
775
 
    def __init__(self, root_id=ROOT_ID):
 
289
    def __init__(self):
776
290
        """Create or read an inventory.
777
291
 
778
292
        If a working directory is specified, the inventory is read
782
296
        The inventory is created with a default root directory, with
783
297
        an id of None.
784
298
        """
785
 
        # We are letting Branch.create() create a unique inventory
786
 
        # root id. Rather than generating a random one here.
787
 
        #if root_id is None:
788
 
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
789
 
        self.root = RootEntry(root_id)
 
299
        self.root = RootEntry(ROOT_ID)
790
300
        self._byid = {self.root.file_id: self.root}
791
301
 
792
302
 
793
 
    def copy(self):
794
 
        other = Inventory(self.root.file_id)
795
 
        # copy recursively so we know directories will be added before
796
 
        # their children.  There are more efficient ways than this...
797
 
        for path, entry in self.iter_entries():
798
 
            if entry == self.root:
799
 
                continue
800
 
            other.add(entry.copy())
801
 
        return other
802
 
 
803
 
 
804
303
    def __iter__(self):
805
304
        return iter(self._byid)
806
305
 
824
323
            yield name, ie
825
324
            if ie.kind == 'directory':
826
325
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
827
 
                    yield pathjoin(name, cn), cie
828
 
 
829
 
 
830
 
    def entries(self):
831
 
        """Return list of (path, ie) for all entries except the root.
832
 
 
833
 
        This may be faster than iter_entries.
 
326
                    yield os.path.join(name, cn), cie
 
327
                    
 
328
 
 
329
 
 
330
    def directories(self):
 
331
        """Return (path, entry) pairs for all directories.
834
332
        """
835
 
        accum = []
836
 
        def descend(dir_ie, dir_path):
837
 
            kids = dir_ie.children.items()
838
 
            kids.sort()
839
 
            for name, ie in kids:
840
 
                child_path = pathjoin(dir_path, name)
841
 
                accum.append((child_path, ie))
 
333
        def descend(parent_ie):
 
334
            parent_name = parent_ie.name
 
335
            yield parent_name, parent_ie
 
336
 
 
337
            # directory children in sorted order
 
338
            dn = []
 
339
            for ie in parent_ie.children.itervalues():
842
340
                if ie.kind == 'directory':
843
 
                    descend(ie, child_path)
844
 
 
845
 
        descend(self.root, u'')
846
 
        return accum
847
 
 
848
 
 
849
 
    def directories(self):
850
 
        """Return (path, entry) pairs for all directories, including the root.
851
 
        """
852
 
        accum = []
853
 
        def descend(parent_ie, parent_path):
854
 
            accum.append((parent_path, parent_ie))
 
341
                    dn.append((ie.name, ie))
 
342
            dn.sort()
855
343
            
856
 
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
857
 
            kids.sort()
 
344
            for name, child_ie in dn:
 
345
                for sub_name, sub_ie in descend(child_ie):
 
346
                    yield appendpath(parent_name, sub_name), sub_ie
858
347
 
859
 
            for name, child_ie in kids:
860
 
                child_path = pathjoin(parent_path, name)
861
 
                descend(child_ie, child_path)
862
 
        descend(self.root, u'')
863
 
        return accum
 
348
        for name, ie in descend(self.root):
 
349
            yield name, ie
864
350
        
865
351
 
866
352
 
868
354
        """True if this entry contains a file with given id.
869
355
 
870
356
        >>> inv = Inventory()
871
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
872
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
357
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
873
358
        >>> '123' in inv
874
359
        True
875
360
        >>> '456' in inv
882
367
        """Return the entry for given file_id.
883
368
 
884
369
        >>> inv = Inventory()
885
 
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
886
 
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
 
370
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
887
371
        >>> inv['123123'].name
888
372
        'hello.c'
889
373
        """
896
380
                raise BzrError("file_id {%s} not in inventory" % file_id)
897
381
 
898
382
 
899
 
    def get_file_kind(self, file_id):
900
 
        return self._byid[file_id].kind
901
 
 
902
383
    def get_child(self, parent_id, filename):
903
384
        return self[parent_id].children.get(filename)
904
385
 
907
388
        """Add entry to inventory.
908
389
 
909
390
        To add  a file to a branch ready to be committed, use Branch.add,
910
 
        which calls this.
911
 
 
912
 
        Returns the new entry object.
913
 
        """
 
391
        which calls this."""
914
392
        if entry.file_id in self._byid:
915
 
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
916
 
 
917
 
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
918
 
            entry.parent_id = self.root.file_id
 
393
            bailout("inventory already contains entry with id {%s}" % entry.file_id)
919
394
 
920
395
        try:
921
396
            parent = self._byid[entry.parent_id]
922
397
        except KeyError:
923
 
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
 
398
            bailout("parent_id {%s} not in inventory" % entry.parent_id)
924
399
 
925
400
        if parent.children.has_key(entry.name):
926
 
            raise BzrError("%s is already versioned" %
927
 
                    pathjoin(self.id2path(parent.file_id), entry.name))
 
401
            bailout("%s is already versioned" %
 
402
                    appendpath(self.id2path(parent.file_id), entry.name))
928
403
 
929
404
        self._byid[entry.file_id] = entry
930
405
        parent.children[entry.name] = entry
931
 
        return entry
932
406
 
933
407
 
934
408
    def add_path(self, relpath, kind, file_id=None):
935
409
        """Add entry from a path.
936
410
 
937
 
        The immediate parent must already be versioned.
938
 
 
939
 
        Returns the new entry object."""
940
 
        from bzrlib.workingtree import gen_file_id
941
 
        
 
411
        The immediate parent must already be versioned"""
942
412
        parts = bzrlib.osutils.splitpath(relpath)
 
413
        if len(parts) == 0:
 
414
            bailout("cannot re-add root of inventory")
943
415
 
944
416
        if file_id == None:
945
 
            file_id = gen_file_id(relpath)
 
417
            file_id = bzrlib.branch.gen_file_id(relpath)
946
418
 
947
 
        if len(parts) == 0:
948
 
            self.root = RootEntry(file_id)
949
 
            self._byid = {self.root.file_id: self.root}
950
 
            return
951
 
        else:
952
 
            parent_path = parts[:-1]
953
 
            parent_id = self.path2id(parent_path)
954
 
            if parent_id == None:
955
 
                raise NotVersionedError(path=parent_path)
956
 
        if kind == 'directory':
957
 
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
958
 
        elif kind == 'file':
959
 
            ie = InventoryFile(file_id, parts[-1], parent_id)
960
 
        elif kind == 'symlink':
961
 
            ie = InventoryLink(file_id, parts[-1], parent_id)
962
 
        else:
963
 
            raise BzrError("unknown kind %r" % kind)
 
419
        parent_id = self.path2id(parts[:-1])
 
420
        assert parent_id != None
 
421
        ie = InventoryEntry(file_id, parts[-1],
 
422
                            kind=kind, parent_id=parent_id)
964
423
        return self.add(ie)
965
424
 
966
425
 
968
427
        """Remove entry by id.
969
428
 
970
429
        >>> inv = Inventory()
971
 
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
972
 
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
 
430
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
973
431
        >>> '123' in inv
974
432
        True
975
433
        >>> del inv['123']
978
436
        """
979
437
        ie = self[file_id]
980
438
 
981
 
        assert ie.parent_id is None or \
982
 
            self[ie.parent_id].children[ie.name] == ie
 
439
        assert self[ie.parent_id].children[ie.name] == ie
983
440
        
 
441
        # TODO: Test deleting all children; maybe hoist to a separate
 
442
        # deltree method?
 
443
        if ie.kind == 'directory':
 
444
            for cie in ie.children.values():
 
445
                del self[cie.file_id]
 
446
            del ie.children
 
447
 
984
448
        del self._byid[file_id]
985
 
        if ie.parent_id is not None:
986
 
            del self[ie.parent_id].children[ie.name]
987
 
 
988
 
 
989
 
    def __eq__(self, other):
 
449
        del self[ie.parent_id].children[ie.name]
 
450
 
 
451
 
 
452
    def id_set(self):
 
453
        return Set(self._byid)
 
454
 
 
455
 
 
456
    def to_element(self):
 
457
        """Convert to XML Element"""
 
458
        e = Element('inventory')
 
459
        e.text = '\n'
 
460
        for path, ie in self.iter_entries():
 
461
            e.append(ie.to_element())
 
462
        return e
 
463
    
 
464
 
 
465
    def from_element(cls, elt):
 
466
        """Construct from XML Element
 
467
 
 
468
        >>> inv = Inventory()
 
469
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
 
470
        >>> elt = inv.to_element()
 
471
        >>> inv2 = Inventory.from_element(elt)
 
472
        >>> inv2 == inv
 
473
        True
 
474
        """
 
475
        assert elt.tag == 'inventory'
 
476
        o = cls()
 
477
        for e in elt:
 
478
            o.add(InventoryEntry.from_element(e))
 
479
        return o
 
480
        
 
481
    from_element = classmethod(from_element)
 
482
 
 
483
 
 
484
    def __cmp__(self, other):
990
485
        """Compare two sets by comparing their contents.
991
486
 
992
487
        >>> i1 = Inventory()
993
488
        >>> i2 = Inventory()
994
489
        >>> i1 == i2
995
490
        True
996
 
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
997
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
491
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
998
492
        >>> i1 == i2
999
493
        False
1000
 
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1001
 
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
 
494
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
1002
495
        >>> i1 == i2
1003
496
        True
1004
497
        """
 
498
        if self is other:
 
499
            return 0
 
500
        
1005
501
        if not isinstance(other, Inventory):
1006
502
            return NotImplemented
1007
503
 
1008
 
        if len(self._byid) != len(other._byid):
1009
 
            # shortcut: obviously not the same
1010
 
            return False
1011
 
 
1012
 
        return self._byid == other._byid
1013
 
 
1014
 
 
1015
 
    def __ne__(self, other):
1016
 
        return not self.__eq__(other)
1017
 
 
1018
 
 
1019
 
    def __hash__(self):
1020
 
        raise ValueError('not hashable')
1021
 
 
1022
 
    def _iter_file_id_parents(self, file_id):
1023
 
        """Yield the parents of file_id up to the root."""
1024
 
        while file_id != None:
1025
 
            try:
1026
 
                ie = self._byid[file_id]
1027
 
            except KeyError:
1028
 
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1029
 
            yield ie
1030
 
            file_id = ie.parent_id
 
504
        if self.id_set() ^ other.id_set():
 
505
            return 1
 
506
 
 
507
        for file_id in self._byid:
 
508
            c = cmp(self[file_id], other[file_id])
 
509
            if c: return c
 
510
 
 
511
        return 0
 
512
 
1031
513
 
1032
514
    def get_idpath(self, file_id):
1033
515
        """Return a list of file_ids for the path to an entry.
1038
520
        root directory as depth 1.
1039
521
        """
1040
522
        p = []
1041
 
        for parent in self._iter_file_id_parents(file_id):
1042
 
            p.insert(0, parent.file_id)
 
523
        while file_id != None:
 
524
            try:
 
525
                ie = self._byid[file_id]
 
526
            except KeyError:
 
527
                bailout("file_id {%s} not found in inventory" % file_id)
 
528
            p.insert(0, ie.file_id)
 
529
            file_id = ie.parent_id
1043
530
        return p
1044
531
 
 
532
 
1045
533
    def id2path(self, file_id):
1046
 
        """Return as a string the path to file_id.
1047
 
        
1048
 
        >>> i = Inventory()
1049
 
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1050
 
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1051
 
        >>> print i.id2path('foo-id')
1052
 
        src/foo.c
1053
 
        """
 
534
        """Return as a list the path to file_id."""
 
535
 
1054
536
        # get all names, skipping root
1055
 
        return '/'.join(reversed(
1056
 
            [parent.name for parent in 
1057
 
             self._iter_file_id_parents(file_id)][:-1]))
 
537
        p = [self[fid].name for fid in self.get_idpath(file_id)[1:]]
 
538
        return os.sep.join(p)
1058
539
            
 
540
 
 
541
 
1059
542
    def path2id(self, name):
1060
543
        """Walk down through directories to return entry of last component.
1061
544
 
1101
584
 
1102
585
        This does not move the working file."""
1103
586
        if not is_valid_name(new_name):
1104
 
            raise BzrError("not an acceptable filename: %r" % new_name)
 
587
            bailout("not an acceptable filename: %r" % new_name)
1105
588
 
1106
589
        new_parent = self._byid[new_parent_id]
1107
590
        if new_name in new_parent.children:
1108
 
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
 
591
            bailout("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
1109
592
 
1110
593
        new_parent_idpath = self.get_idpath(new_parent_id)
1111
594
        if file_id in new_parent_idpath:
1112
 
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
 
595
            bailout("cannot move directory %r into a subdirectory of itself, %r"
1113
596
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
1114
597
 
1115
598
        file_ie = self._byid[file_id]
1126
609
 
1127
610
 
1128
611
 
1129
 
_NAME_RE = None
 
612
_NAME_RE = re.compile(r'^[^/\\]+$')
1130
613
 
1131
614
def is_valid_name(name):
1132
 
    global _NAME_RE
1133
 
    if _NAME_RE == None:
1134
 
        _NAME_RE = re.compile(r'^[^/\\]+$')
1135
 
        
1136
615
    return bool(_NAME_RE.match(name))