~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2006-05-02 11:12:07 UTC
  • mto: (1692.4.1 integration)
  • mto: This revision was merged to the branch mainline in revision 1694.
  • Revision ID: robertc@robertcollins.net-20060502111207-e4ff704e86662870
* Repository.reconcile now takes a thorough keyword parameter to allow
  requesting an indepth reconciliation, rather than just a data-loss 
  check. (Robert Collins)

Show diffs side-by-side

added added

removed removed

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