← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: Robert Collins
  • Date: 2005-12-24 02:20:45 UTC
  • mto: (1185.50.57 bzr-jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1550.
  • Revision ID: robertc@robertcollins.net-20051224022045-14efc8dfa0e1a4e9
Start tests for api usage.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/inventory.py
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.
17
25
 
18
26
# This should really be an id randomly assigned when the tree is
19
27
# created, but it's not for now.
20
28
ROOT_ID = "TREE_ROOT"
21
29
 
22
30
 
23
 
import sys, os.path, types, re
 
31
import os.path
 
32
import re
 
33
import sys
 
34
import tarfile
 
35
import types
24
36
 
25
37
import bzrlib
26
 
from bzrlib.errors import BzrError, BzrCheckError
27
 
 
28
 
from bzrlib.osutils import uuid, quotefn, splitpath, joinpath, appendpath
 
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
 
39
                            appendpath, sha_strings)
29
40
from bzrlib.trace import mutter
30
 
from bzrlib.errors import NotVersionedError
31
 
        
 
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
 
42
                           BzrError, BzrCheckError)
 
43
 
32
44
 
33
45
class InventoryEntry(object):
34
46
    """Description of a versioned file.
36
48
    An InventoryEntry has the following fields, which are also
37
49
    present in the XML inventory-entry element:
38
50
 
39
 
    * *file_id*
40
 
    * *name*: (only the basename within the directory, must not
41
 
      contain slashes)
42
 
    * *kind*: "directory" or "file"
43
 
    * *directory_id*: (if absent/null means the branch root directory)
44
 
    * *text_sha1*: only for files
45
 
    * *text_size*: in bytes, only for files 
46
 
    * *text_id*: identifier for the text version, only for files
47
 
 
48
 
    InventoryEntries can also exist inside a WorkingTree
49
 
    inventory, in which case they are not yet bound to a
50
 
    particular revision of the file.  In that case the text_sha1,
51
 
    text_size and text_id are absent.
52
 
 
 
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.)
53
74
 
54
75
    >>> i = Inventory()
55
76
    >>> i.path2id('')
56
77
    'TREE_ROOT'
57
 
    >>> i.add(InventoryEntry('123', 'src', 'directory', ROOT_ID))
58
 
    InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT')
59
 
    >>> i.add(InventoryEntry('2323', 'hello.c', 'file', parent_id='123'))
60
 
    InventoryEntry('2323', 'hello.c', kind='file', parent_id='123')
61
 
    >>> for j in i.iter_entries():
62
 
    ...   print j
 
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: os.path.join('src','hello.c')}
 
83
    >>> for ix, j in enumerate(i.iter_entries()):
 
84
    ...   print (j[0] == shouldbe[ix], j[1])
63
85
    ... 
64
 
    ('src', InventoryEntry('123', 'src', kind='directory', parent_id='TREE_ROOT'))
65
 
    ('src/hello.c', InventoryEntry('2323', 'hello.c', kind='file', parent_id='123'))
66
 
    >>> i.add(InventoryEntry('2323', 'bye.c', 'file', '123'))
 
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
89
    Traceback (most recent call last):
68
90
    ...
69
91
    BzrError: inventory already contains entry with id {2323}
70
 
    >>> i.add(InventoryEntry('2324', 'bye.c', 'file', '123'))
71
 
    InventoryEntry('2324', 'bye.c', kind='file', parent_id='123')
72
 
    >>> i.add(InventoryEntry('2325', 'wibble', 'directory', '123'))
73
 
    InventoryEntry('2325', 'wibble', kind='directory', parent_id='123')
 
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')
74
96
    >>> i.path2id('src/wibble')
75
97
    '2325'
76
98
    >>> '2325' in i
77
99
    True
78
 
    >>> i.add(InventoryEntry('2326', 'wibble.c', 'file', '2325'))
79
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
 
100
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
 
101
    InventoryFile('2326', 'wibble.c', parent_id='2325')
80
102
    >>> i['2326']
81
 
    InventoryEntry('2326', 'wibble.c', kind='file', parent_id='2325')
82
 
    >>> for j in i.iter_entries():
83
 
    ...     print j[0]
84
 
    ...     assert i.path2id(j[0])
 
103
    InventoryFile('2326', 'wibble.c', parent_id='2325')
 
104
    >>> for path, entry in i.iter_entries():
 
105
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
 
106
    ...     assert i.path2id(path)
85
107
    ... 
86
108
    src
87
109
    src/bye.c
88
110
    src/hello.c
89
111
    src/wibble
90
112
    src/wibble/wibble.c
91
 
    >>> i.id2path('2326')
 
113
    >>> i.id2path('2326').replace('\\\\', '/')
92
114
    'src/wibble/wibble.c'
93
 
 
94
 
    TODO: Maybe also keep the full path of the entry, and the children?
95
 
           But those depend on its position within a particular inventory, and
96
 
           it would be nice not to need to hold the backpointer here.
97
115
    """
98
 
 
99
 
    # TODO: split InventoryEntry into subclasses for files,
100
 
    # directories, etc etc.
101
 
 
 
116
    
102
117
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
103
 
                 'text_id', 'parent_id', 'children', ]
104
 
 
105
 
    def __init__(self, file_id, name, kind, parent_id, text_id=None):
 
118
                 'text_id', 'parent_id', 'children', 'executable', 
 
119
                 'revision']
 
120
 
 
121
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
 
122
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
 
123
                             transaction)
 
124
 
 
125
    def detect_changes(self, old_entry):
 
126
        """Return a (text_modified, meta_modified) from this to old_entry.
 
127
        
 
128
        _read_tree_state must have been called on self and old_entry prior to 
 
129
        calling detect_changes.
 
130
        """
 
131
        return False, False
 
132
 
 
133
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
134
             output_to, reverse=False):
 
135
        """Perform a diff from this to to_entry.
 
136
 
 
137
        text_diff will be used for textual difference calculation.
 
138
        This is a template method, override _diff in child classes.
 
139
        """
 
140
        self._read_tree_state(tree.id2path(self.file_id), tree)
 
141
        if to_entry:
 
142
            # cannot diff from one kind to another - you must do a removal
 
143
            # and an addif they do not match.
 
144
            assert self.kind == to_entry.kind
 
145
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
 
146
                                      to_tree)
 
147
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
 
148
                   output_to, reverse)
 
149
 
 
150
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
151
             output_to, reverse=False):
 
152
        """Perform a diff between two entries of the same kind."""
 
153
 
 
154
    def find_previous_heads(self, previous_inventories, entry_weave):
 
155
        """Return the revisions and entries that directly preceed this.
 
156
 
 
157
        Returned as a map from revision to inventory entry.
 
158
 
 
159
        This is a map containing the file revisions in all parents
 
160
        for which the file exists, and its revision is not a parent of
 
161
        any other. If the file is new, the set will be empty.
 
162
        """
 
163
        def get_ancestors(weave, entry):
 
164
            return set(map(weave.idx_to_name,
 
165
                           weave.inclusions([weave.lookup(entry.revision)])))
 
166
        heads = {}
 
167
        head_ancestors = {}
 
168
        for inv in previous_inventories:
 
169
            if self.file_id in inv:
 
170
                ie = inv[self.file_id]
 
171
                assert ie.file_id == self.file_id
 
172
                if ie.revision in heads:
 
173
                    # fixup logic, there was a bug in revision updates.
 
174
                    # with x bit support.
 
175
                    try:
 
176
                        if heads[ie.revision].executable != ie.executable:
 
177
                            heads[ie.revision].executable = False
 
178
                            ie.executable = False
 
179
                    except AttributeError:
 
180
                        pass
 
181
                    assert heads[ie.revision] == ie
 
182
                else:
 
183
                    # may want to add it.
 
184
                    # may already be covered:
 
185
                    already_present = 0 != len(
 
186
                        [head for head in heads 
 
187
                         if ie.revision in head_ancestors[head]])
 
188
                    if already_present:
 
189
                        # an ancestor of a known head.
 
190
                        continue
 
191
                    # definately a head:
 
192
                    ancestors = get_ancestors(entry_weave, ie)
 
193
                    # may knock something else out:
 
194
                    check_heads = list(heads.keys())
 
195
                    for head in check_heads:
 
196
                        if head in ancestors:
 
197
                            # this head is not really a head
 
198
                            heads.pop(head)
 
199
                    head_ancestors[ie.revision] = ancestors
 
200
                    heads[ie.revision] = ie
 
201
        return heads
 
202
 
 
203
    def get_tar_item(self, root, dp, now, tree):
 
204
        """Get a tarfile item and a file stream for its content."""
 
205
        item = tarfile.TarInfo(os.path.join(root, dp))
 
206
        # TODO: would be cool to actually set it to the timestamp of the
 
207
        # revision it was last changed
 
208
        item.mtime = now
 
209
        fileobj = self._put_in_tar(item, tree)
 
210
        return item, fileobj
 
211
 
 
212
    def has_text(self):
 
213
        """Return true if the object this entry represents has textual data.
 
214
 
 
215
        Note that textual data includes binary content.
 
216
 
 
217
        Also note that all entries get weave files created for them.
 
218
        This attribute is primarily used when upgrading from old trees that
 
219
        did not have the weave index for all inventory entries.
 
220
        """
 
221
        return False
 
222
 
 
223
    def __init__(self, file_id, name, parent_id, text_id=None):
106
224
        """Create an InventoryEntry
107
225
        
108
226
        The filename must be a single component, relative to the
109
227
        parent directory; it cannot be a whole path or relative name.
110
228
 
111
 
        >>> e = InventoryEntry('123', 'hello.c', 'file', ROOT_ID)
 
229
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
112
230
        >>> e.name
113
231
        'hello.c'
114
232
        >>> e.file_id
115
233
        '123'
116
 
        >>> e = InventoryEntry('123', 'src/hello.c', 'file', ROOT_ID)
 
234
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
117
235
        Traceback (most recent call last):
118
 
        BzrCheckError: InventoryEntry name 'src/hello.c' is invalid
 
236
        InvalidEntryName: Invalid entry name: src/hello.c
119
237
        """
 
238
        assert isinstance(name, basestring), name
120
239
        if '/' in name or '\\' in name:
121
 
            raise BzrCheckError('InventoryEntry name %r is invalid' % name)
122
 
        
 
240
            raise InvalidEntryName(name=name)
 
241
        self.executable = False
 
242
        self.revision = None
123
243
        self.text_sha1 = None
124
244
        self.text_size = None
125
 
    
126
245
        self.file_id = file_id
127
246
        self.name = name
128
 
        self.kind = kind
129
247
        self.text_id = text_id
130
248
        self.parent_id = parent_id
131
 
        if kind == 'directory':
132
 
            self.children = {}
133
 
        elif kind == 'file':
134
 
            pass
135
 
        else:
136
 
            raise BzrError("unhandled entry kind %r" % kind)
137
 
 
138
 
 
 
249
        self.symlink_target = None
 
250
 
 
251
    def kind_character(self):
 
252
        """Return a short kind indicator useful for appending to names."""
 
253
        raise BzrError('unknown kind %r' % self.kind)
 
254
 
 
255
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
 
256
 
 
257
    def _put_in_tar(self, item, tree):
 
258
        """populate item for stashing in a tar, and return the content stream.
 
259
 
 
260
        If no content is available, return None.
 
261
        """
 
262
        raise BzrError("don't know how to export {%s} of kind %r" %
 
263
                       (self.file_id, self.kind))
 
264
 
 
265
    def put_on_disk(self, dest, dp, tree):
 
266
        """Create a representation of self on disk in the prefix dest.
 
267
        
 
268
        This is a template method - implement _put_on_disk in subclasses.
 
269
        """
 
270
        fullpath = appendpath(dest, dp)
 
271
        self._put_on_disk(fullpath, tree)
 
272
        mutter("  export {%s} kind %s to %s", self.file_id,
 
273
                self.kind, fullpath)
 
274
 
 
275
    def _put_on_disk(self, fullpath, tree):
 
276
        """Put this entry onto disk at fullpath, from tree tree."""
 
277
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
139
278
 
140
279
    def sorted_children(self):
141
280
        l = self.children.items()
142
281
        l.sort()
143
282
        return l
144
283
 
 
284
    @staticmethod
 
285
    def versionable_kind(kind):
 
286
        return kind in ('file', 'directory', 'symlink')
 
287
 
 
288
    def check(self, checker, rev_id, inv, tree):
 
289
        """Check this inventory entry is intact.
 
290
 
 
291
        This is a template method, override _check for kind specific
 
292
        tests.
 
293
        """
 
294
        if self.parent_id != None:
 
295
            if not inv.has_id(self.parent_id):
 
296
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
 
297
                        % (self.parent_id, rev_id))
 
298
        self._check(checker, rev_id, tree)
 
299
 
 
300
    def _check(self, checker, rev_id, tree):
 
301
        """Check this inventory entry for kind specific errors."""
 
302
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
 
303
                            (self.kind, rev_id))
 
304
 
145
305
 
146
306
    def copy(self):
147
 
        other = InventoryEntry(self.file_id, self.name, self.kind,
148
 
                               self.parent_id, text_id=self.text_id)
149
 
        other.text_sha1 = self.text_sha1
150
 
        other.text_size = self.text_size
151
 
        # note that children are *not* copied; they're pulled across when
152
 
        # others are added
153
 
        return other
 
307
        """Clone this inventory entry."""
 
308
        raise NotImplementedError
154
309
 
 
310
    def _get_snapshot_change(self, previous_entries):
 
311
        if len(previous_entries) > 1:
 
312
            return 'merged'
 
313
        elif len(previous_entries) == 0:
 
314
            return 'added'
 
315
        else:
 
316
            return 'modified/renamed/reparented'
155
317
 
156
318
    def __repr__(self):
157
 
        return ("%s(%r, %r, kind=%r, parent_id=%r)"
 
319
        return ("%s(%r, %r, parent_id=%r)"
158
320
                % (self.__class__.__name__,
159
321
                   self.file_id,
160
322
                   self.name,
161
 
                   self.kind,
162
323
                   self.parent_id))
163
324
 
164
 
    
165
 
    def to_element(self):
166
 
        """Convert to XML element"""
167
 
        from bzrlib.xml import Element
168
 
        
169
 
        e = Element('entry')
170
 
 
171
 
        e.set('name', self.name)
172
 
        e.set('file_id', self.file_id)
173
 
        e.set('kind', self.kind)
174
 
 
175
 
        if self.text_size != None:
176
 
            e.set('text_size', '%d' % self.text_size)
177
 
            
178
 
        for f in ['text_id', 'text_sha1']:
179
 
            v = getattr(self, f)
180
 
            if v != None:
181
 
                e.set(f, v)
182
 
 
183
 
        # to be conservative, we don't externalize the root pointers
184
 
        # for now, leaving them as null in the xml form.  in a future
185
 
        # version it will be implied by nested elements.
186
 
        if self.parent_id != ROOT_ID:
187
 
            assert isinstance(self.parent_id, basestring)
188
 
            e.set('parent_id', self.parent_id)
189
 
 
190
 
        e.tail = '\n'
191
 
            
192
 
        return e
193
 
 
194
 
 
195
 
    def from_element(cls, elt):
196
 
        assert elt.tag == 'entry'
197
 
 
198
 
        ## original format inventories don't have a parent_id for
199
 
        ## nodes in the root directory, but it's cleaner to use one
200
 
        ## internally.
201
 
        parent_id = elt.get('parent_id')
202
 
        if parent_id == None:
203
 
            parent_id = ROOT_ID
204
 
 
205
 
        self = cls(elt.get('file_id'), elt.get('name'), elt.get('kind'), parent_id)
206
 
        self.text_id = elt.get('text_id')
207
 
        self.text_sha1 = elt.get('text_sha1')
208
 
        
209
 
        ## mutter("read inventoryentry: %r" % (elt.attrib))
210
 
 
211
 
        v = elt.get('text_size')
212
 
        self.text_size = v and int(v)
213
 
 
214
 
        return self
215
 
            
216
 
 
217
 
    from_element = classmethod(from_element)
 
325
    def snapshot(self, revision, path, previous_entries,
 
326
                 work_tree, weave_store, transaction):
 
327
        """Make a snapshot of this entry which may or may not have changed.
 
328
        
 
329
        This means that all its fields are populated, that it has its
 
330
        text stored in the text store or weave.
 
331
        """
 
332
        mutter('new parents of %s are %r', path, previous_entries)
 
333
        self._read_tree_state(path, work_tree)
 
334
        if len(previous_entries) == 1:
 
335
            # cannot be unchanged unless there is only one parent file rev.
 
336
            parent_ie = previous_entries.values()[0]
 
337
            if self._unchanged(parent_ie):
 
338
                mutter("found unchanged entry")
 
339
                self.revision = parent_ie.revision
 
340
                return "unchanged"
 
341
        return self.snapshot_revision(revision, previous_entries, 
 
342
                                      work_tree, weave_store, transaction)
 
343
 
 
344
    def snapshot_revision(self, revision, previous_entries, work_tree,
 
345
                          weave_store, transaction):
 
346
        """Record this revision unconditionally."""
 
347
        mutter('new revision for {%s}', self.file_id)
 
348
        self.revision = revision
 
349
        change = self._get_snapshot_change(previous_entries)
 
350
        self._snapshot_text(previous_entries, work_tree, weave_store,
 
351
                            transaction)
 
352
        return change
 
353
 
 
354
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
 
355
        """Record the 'text' of this entry, whatever form that takes.
 
356
        
 
357
        This default implementation simply adds an empty text.
 
358
        """
 
359
        mutter('storing file {%s} in revision {%s}',
 
360
               self.file_id, self.revision)
 
361
        self._add_text_to_weave([], file_parents, weave_store, transaction)
218
362
 
219
363
    def __eq__(self, other):
220
364
        if not isinstance(other, InventoryEntry):
221
365
            return NotImplemented
222
366
 
223
 
        return (self.file_id == other.file_id) \
224
 
               and (self.name == other.name) \
225
 
               and (self.text_sha1 == other.text_sha1) \
226
 
               and (self.text_size == other.text_size) \
227
 
               and (self.text_id == other.text_id) \
228
 
               and (self.parent_id == other.parent_id) \
229
 
               and (self.kind == other.kind)
230
 
 
 
367
        return ((self.file_id == other.file_id)
 
368
                and (self.name == other.name)
 
369
                and (other.symlink_target == self.symlink_target)
 
370
                and (self.text_sha1 == other.text_sha1)
 
371
                and (self.text_size == other.text_size)
 
372
                and (self.text_id == other.text_id)
 
373
                and (self.parent_id == other.parent_id)
 
374
                and (self.kind == other.kind)
 
375
                and (self.revision == other.revision)
 
376
                and (self.executable == other.executable)
 
377
                )
231
378
 
232
379
    def __ne__(self, other):
233
380
        return not (self == other)
235
382
    def __hash__(self):
236
383
        raise ValueError('not hashable')
237
384
 
 
385
    def _unchanged(self, previous_ie):
 
386
        """Has this entry changed relative to previous_ie.
 
387
 
 
388
        This method should be overriden in child classes.
 
389
        """
 
390
        compatible = True
 
391
        # different inv parent
 
392
        if previous_ie.parent_id != self.parent_id:
 
393
            compatible = False
 
394
        # renamed
 
395
        elif previous_ie.name != self.name:
 
396
            compatible = False
 
397
        return compatible
 
398
 
 
399
    def _read_tree_state(self, path, work_tree):
 
400
        """Populate fields in the inventory entry from the given tree.
 
401
        
 
402
        Note that this should be modified to be a noop on virtual trees
 
403
        as all entries created there are prepopulated.
 
404
        """
 
405
        # TODO: Rather than running this manually, we should check the 
 
406
        # working sha1 and other expensive properties when they're
 
407
        # first requested, or preload them if they're already known
 
408
        pass            # nothing to do by default
238
409
 
239
410
 
240
411
class RootEntry(InventoryEntry):
 
412
 
 
413
    def _check(self, checker, rev_id, tree):
 
414
        """See InventoryEntry._check"""
 
415
 
241
416
    def __init__(self, file_id):
242
417
        self.file_id = file_id
243
418
        self.children = {}
244
419
        self.kind = 'root_directory'
245
420
        self.parent_id = None
246
 
        self.name = ''
 
421
        self.name = u''
247
422
 
248
423
    def __eq__(self, other):
249
424
        if not isinstance(other, RootEntry):
253
428
               and (self.children == other.children)
254
429
 
255
430
 
 
431
class InventoryDirectory(InventoryEntry):
 
432
    """A directory in an inventory."""
 
433
 
 
434
    def _check(self, checker, rev_id, tree):
 
435
        """See InventoryEntry._check"""
 
436
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
437
            raise BzrCheckError('directory {%s} has text in revision {%s}'
 
438
                                % (self.file_id, rev_id))
 
439
 
 
440
    def copy(self):
 
441
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
 
442
        other.revision = self.revision
 
443
        # note that children are *not* copied; they're pulled across when
 
444
        # others are added
 
445
        return other
 
446
 
 
447
    def __init__(self, file_id, name, parent_id):
 
448
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
 
449
        self.children = {}
 
450
        self.kind = 'directory'
 
451
 
 
452
    def kind_character(self):
 
453
        """See InventoryEntry.kind_character."""
 
454
        return '/'
 
455
 
 
456
    def _put_in_tar(self, item, tree):
 
457
        """See InventoryEntry._put_in_tar."""
 
458
        item.type = tarfile.DIRTYPE
 
459
        fileobj = None
 
460
        item.name += '/'
 
461
        item.size = 0
 
462
        item.mode = 0755
 
463
        return fileobj
 
464
 
 
465
    def _put_on_disk(self, fullpath, tree):
 
466
        """See InventoryEntry._put_on_disk."""
 
467
        os.mkdir(fullpath)
 
468
 
 
469
 
 
470
class InventoryFile(InventoryEntry):
 
471
    """A file in an inventory."""
 
472
 
 
473
    def _check(self, checker, rev_id, tree):
 
474
        """See InventoryEntry._check"""
 
475
        revision = self.revision
 
476
        t = (self.file_id, revision)
 
477
        if t in checker.checked_texts:
 
478
            prev_sha = checker.checked_texts[t] 
 
479
            if prev_sha != self.text_sha1:
 
480
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
 
481
                                    (self.file_id, rev_id))
 
482
            else:
 
483
                checker.repeated_text_cnt += 1
 
484
                return
 
485
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
 
486
        file_lines = tree.get_file_lines(self.file_id)
 
487
        checker.checked_text_cnt += 1 
 
488
        if self.text_size != sum(map(len, file_lines)):
 
489
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
 
490
        if self.text_sha1 != sha_strings(file_lines):
 
491
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
 
492
        checker.checked_texts[t] = self.text_sha1
 
493
 
 
494
    def copy(self):
 
495
        other = InventoryFile(self.file_id, self.name, self.parent_id)
 
496
        other.executable = self.executable
 
497
        other.text_id = self.text_id
 
498
        other.text_sha1 = self.text_sha1
 
499
        other.text_size = self.text_size
 
500
        other.revision = self.revision
 
501
        return other
 
502
 
 
503
    def detect_changes(self, old_entry):
 
504
        """See InventoryEntry.detect_changes."""
 
505
        assert self.text_sha1 != None
 
506
        assert old_entry.text_sha1 != None
 
507
        text_modified = (self.text_sha1 != old_entry.text_sha1)
 
508
        meta_modified = (self.executable != old_entry.executable)
 
509
        return text_modified, meta_modified
 
510
 
 
511
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
512
             output_to, reverse=False):
 
513
        """See InventoryEntry._diff."""
 
514
        from_text = tree.get_file(self.file_id).readlines()
 
515
        if to_entry:
 
516
            to_text = to_tree.get_file(to_entry.file_id).readlines()
 
517
        else:
 
518
            to_text = []
 
519
        if not reverse:
 
520
            text_diff(from_label, from_text,
 
521
                      to_label, to_text, output_to)
 
522
        else:
 
523
            text_diff(to_label, to_text,
 
524
                      from_label, from_text, output_to)
 
525
 
 
526
    def has_text(self):
 
527
        """See InventoryEntry.has_text."""
 
528
        return True
 
529
 
 
530
    def __init__(self, file_id, name, parent_id):
 
531
        super(InventoryFile, self).__init__(file_id, name, parent_id)
 
532
        self.kind = 'file'
 
533
 
 
534
    def kind_character(self):
 
535
        """See InventoryEntry.kind_character."""
 
536
        return ''
 
537
 
 
538
    def _put_in_tar(self, item, tree):
 
539
        """See InventoryEntry._put_in_tar."""
 
540
        item.type = tarfile.REGTYPE
 
541
        fileobj = tree.get_file(self.file_id)
 
542
        item.size = self.text_size
 
543
        if tree.is_executable(self.file_id):
 
544
            item.mode = 0755
 
545
        else:
 
546
            item.mode = 0644
 
547
        return fileobj
 
548
 
 
549
    def _put_on_disk(self, fullpath, tree):
 
550
        """See InventoryEntry._put_on_disk."""
 
551
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
 
552
        if tree.is_executable(self.file_id):
 
553
            os.chmod(fullpath, 0755)
 
554
 
 
555
    def _read_tree_state(self, path, work_tree):
 
556
        """See InventoryEntry._read_tree_state."""
 
557
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
 
558
        self.executable = work_tree.is_executable(self.file_id)
 
559
 
 
560
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
 
561
        """See InventoryEntry._snapshot_text."""
 
562
        mutter('storing file {%s} in revision {%s}',
 
563
               self.file_id, self.revision)
 
564
        # special case to avoid diffing on renames or 
 
565
        # reparenting
 
566
        if (len(file_parents) == 1
 
567
            and self.text_sha1 == file_parents.values()[0].text_sha1
 
568
            and self.text_size == file_parents.values()[0].text_size):
 
569
            previous_ie = file_parents.values()[0]
 
570
            weave_store.add_identical_text(
 
571
                self.file_id, previous_ie.revision, 
 
572
                self.revision, file_parents, transaction)
 
573
        else:
 
574
            new_lines = work_tree.get_file(self.file_id).readlines()
 
575
            self._add_text_to_weave(new_lines, file_parents, weave_store,
 
576
                                    transaction)
 
577
            self.text_sha1 = sha_strings(new_lines)
 
578
            self.text_size = sum(map(len, new_lines))
 
579
 
 
580
 
 
581
    def _unchanged(self, previous_ie):
 
582
        """See InventoryEntry._unchanged."""
 
583
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
 
584
        if self.text_sha1 != previous_ie.text_sha1:
 
585
            compatible = False
 
586
        else:
 
587
            # FIXME: 20050930 probe for the text size when getting sha1
 
588
            # in _read_tree_state
 
589
            self.text_size = previous_ie.text_size
 
590
        if self.executable != previous_ie.executable:
 
591
            compatible = False
 
592
        return compatible
 
593
 
 
594
 
 
595
class InventoryLink(InventoryEntry):
 
596
    """A file in an inventory."""
 
597
 
 
598
    __slots__ = ['symlink_target']
 
599
 
 
600
    def _check(self, checker, rev_id, tree):
 
601
        """See InventoryEntry._check"""
 
602
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
 
603
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
 
604
                    % (self.file_id, rev_id))
 
605
        if self.symlink_target == None:
 
606
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
 
607
                    % (self.file_id, rev_id))
 
608
 
 
609
    def copy(self):
 
610
        other = InventoryLink(self.file_id, self.name, self.parent_id)
 
611
        other.symlink_target = self.symlink_target
 
612
        other.revision = self.revision
 
613
        return other
 
614
 
 
615
    def detect_changes(self, old_entry):
 
616
        """See InventoryEntry.detect_changes."""
 
617
        # FIXME: which _modified field should we use ? RBC 20051003
 
618
        text_modified = (self.symlink_target != old_entry.symlink_target)
 
619
        if text_modified:
 
620
            mutter("    symlink target changed")
 
621
        meta_modified = False
 
622
        return text_modified, meta_modified
 
623
 
 
624
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
 
625
             output_to, reverse=False):
 
626
        """See InventoryEntry._diff."""
 
627
        from_text = self.symlink_target
 
628
        if to_entry is not None:
 
629
            to_text = to_entry.symlink_target
 
630
            if reverse:
 
631
                temp = from_text
 
632
                from_text = to_text
 
633
                to_text = temp
 
634
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
 
635
        else:
 
636
            if not reverse:
 
637
                print >>output_to, '=== target was %r' % self.symlink_target
 
638
            else:
 
639
                print >>output_to, '=== target is %r' % self.symlink_target
 
640
 
 
641
    def __init__(self, file_id, name, parent_id):
 
642
        super(InventoryLink, self).__init__(file_id, name, parent_id)
 
643
        self.kind = 'symlink'
 
644
 
 
645
    def kind_character(self):
 
646
        """See InventoryEntry.kind_character."""
 
647
        return ''
 
648
 
 
649
    def _put_in_tar(self, item, tree):
 
650
        """See InventoryEntry._put_in_tar."""
 
651
        item.type = tarfile.SYMTYPE
 
652
        fileobj = None
 
653
        item.size = 0
 
654
        item.mode = 0755
 
655
        item.linkname = self.symlink_target
 
656
        return fileobj
 
657
 
 
658
    def _put_on_disk(self, fullpath, tree):
 
659
        """See InventoryEntry._put_on_disk."""
 
660
        try:
 
661
            os.symlink(self.symlink_target, fullpath)
 
662
        except OSError,e:
 
663
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
 
664
 
 
665
    def _read_tree_state(self, path, work_tree):
 
666
        """See InventoryEntry._read_tree_state."""
 
667
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
 
668
 
 
669
    def _unchanged(self, previous_ie):
 
670
        """See InventoryEntry._unchanged."""
 
671
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
 
672
        if self.symlink_target != previous_ie.symlink_target:
 
673
            compatible = False
 
674
        return compatible
 
675
 
256
676
 
257
677
class Inventory(object):
258
678
    """Inventory of versioned files in a tree.
272
692
    inserted, other than through the Inventory API.
273
693
 
274
694
    >>> inv = Inventory()
275
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
276
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
695
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
696
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
277
697
    >>> inv['123-123'].name
278
698
    'hello.c'
279
699
 
289
709
    >>> [x[0] for x in inv.iter_entries()]
290
710
    ['hello.c']
291
711
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
292
 
    >>> inv.add(InventoryEntry('123-123', 'hello.c', 'file', ROOT_ID))
293
 
    InventoryEntry('123-123', 'hello.c', kind='file', parent_id='TREE_ROOT-12345678-12345678')
 
712
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
 
713
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
294
714
    """
295
715
    def __init__(self, root_id=ROOT_ID):
296
716
        """Create or read an inventory.
302
722
        The inventory is created with a default root directory, with
303
723
        an id of None.
304
724
        """
305
 
        # We are letting Branch(init=True) create a unique inventory
 
725
        # We are letting Branch.initialize() create a unique inventory
306
726
        # root id. Rather than generating a random one here.
307
727
        #if root_id is None:
308
728
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
310
730
        self._byid = {self.root.file_id: self.root}
311
731
 
312
732
 
 
733
    def copy(self):
 
734
        other = Inventory(self.root.file_id)
 
735
        # copy recursively so we know directories will be added before
 
736
        # their children.  There are more efficient ways than this...
 
737
        for path, entry in self.iter_entries():
 
738
            if entry == self.root:
 
739
                continue
 
740
            other.add(entry.copy())
 
741
        return other
 
742
 
 
743
 
313
744
    def __iter__(self):
314
745
        return iter(self._byid)
315
746
 
351
782
                if ie.kind == 'directory':
352
783
                    descend(ie, child_path)
353
784
 
354
 
        descend(self.root, '')
 
785
        descend(self.root, u'')
355
786
        return accum
356
787
 
357
788
 
368
799
            for name, child_ie in kids:
369
800
                child_path = os.path.join(parent_path, name)
370
801
                descend(child_ie, child_path)
371
 
        descend(self.root, '')
 
802
        descend(self.root, u'')
372
803
        return accum
373
804
        
374
805
 
377
808
        """True if this entry contains a file with given id.
378
809
 
379
810
        >>> inv = Inventory()
380
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
381
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
811
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
812
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
382
813
        >>> '123' in inv
383
814
        True
384
815
        >>> '456' in inv
391
822
        """Return the entry for given file_id.
392
823
 
393
824
        >>> inv = Inventory()
394
 
        >>> inv.add(InventoryEntry('123123', 'hello.c', 'file', ROOT_ID))
395
 
        InventoryEntry('123123', 'hello.c', kind='file', parent_id='TREE_ROOT')
 
825
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
 
826
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
396
827
        >>> inv['123123'].name
397
828
        'hello.c'
398
829
        """
416
847
        """Add entry to inventory.
417
848
 
418
849
        To add  a file to a branch ready to be committed, use Branch.add,
419
 
        which calls this."""
 
850
        which calls this.
 
851
 
 
852
        Returns the new entry object.
 
853
        """
420
854
        if entry.file_id in self._byid:
421
855
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
422
856
 
440
874
    def add_path(self, relpath, kind, file_id=None):
441
875
        """Add entry from a path.
442
876
 
443
 
        The immediate parent must already be versioned"""
444
 
        from bzrlib.branch import gen_file_id
 
877
        The immediate parent must already be versioned.
 
878
 
 
879
        Returns the new entry object."""
 
880
        from bzrlib.workingtree import gen_file_id
445
881
        
446
882
        parts = bzrlib.osutils.splitpath(relpath)
447
883
        if len(parts) == 0:
453
889
        parent_path = parts[:-1]
454
890
        parent_id = self.path2id(parent_path)
455
891
        if parent_id == None:
456
 
            raise NotVersionedError(parent_path)
457
 
 
458
 
        ie = InventoryEntry(file_id, parts[-1],
459
 
                            kind=kind, parent_id=parent_id)
 
892
            raise NotVersionedError(path=parent_path)
 
893
        if kind == 'directory':
 
894
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
 
895
        elif kind == 'file':
 
896
            ie = InventoryFile(file_id, parts[-1], parent_id)
 
897
        elif kind == 'symlink':
 
898
            ie = InventoryLink(file_id, parts[-1], parent_id)
 
899
        else:
 
900
            raise BzrError("unknown kind %r" % kind)
460
901
        return self.add(ie)
461
902
 
462
903
 
464
905
        """Remove entry by id.
465
906
 
466
907
        >>> inv = Inventory()
467
 
        >>> inv.add(InventoryEntry('123', 'foo.c', 'file', ROOT_ID))
468
 
        InventoryEntry('123', 'foo.c', kind='file', parent_id='TREE_ROOT')
 
908
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
 
909
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
469
910
        >>> '123' in inv
470
911
        True
471
912
        >>> del inv['123']
487
928
        del self[ie.parent_id].children[ie.name]
488
929
 
489
930
 
490
 
    def to_element(self):
491
 
        """Convert to XML Element"""
492
 
        from bzrlib.xml import Element
493
 
        
494
 
        e = Element('inventory')
495
 
        e.text = '\n'
496
 
        if self.root.file_id not in (None, ROOT_ID):
497
 
            e.set('file_id', self.root.file_id)
498
 
        for path, ie in self.iter_entries():
499
 
            e.append(ie.to_element())
500
 
        return e
501
 
    
502
 
 
503
 
    def from_element(cls, elt):
504
 
        """Construct from XML Element
505
 
        
506
 
        >>> inv = Inventory()
507
 
        >>> inv.add(InventoryEntry('foo.c-123981239', 'foo.c', 'file', ROOT_ID))
508
 
        InventoryEntry('foo.c-123981239', 'foo.c', kind='file', parent_id='TREE_ROOT')
509
 
        >>> elt = inv.to_element()
510
 
        >>> inv2 = Inventory.from_element(elt)
511
 
        >>> inv2 == inv
512
 
        True
513
 
        """
514
 
        # XXXX: doctest doesn't run this properly under python2.3
515
 
        assert elt.tag == 'inventory'
516
 
        root_id = elt.get('file_id') or ROOT_ID
517
 
        o = cls(root_id)
518
 
        for e in elt:
519
 
            ie = InventoryEntry.from_element(e)
520
 
            if ie.parent_id == ROOT_ID:
521
 
                ie.parent_id = root_id
522
 
            o.add(ie)
523
 
        return o
524
 
        
525
 
    from_element = classmethod(from_element)
526
 
 
527
 
 
528
931
    def __eq__(self, other):
529
932
        """Compare two sets by comparing their contents.
530
933
 
532
935
        >>> i2 = Inventory()
533
936
        >>> i1 == i2
534
937
        True
535
 
        >>> i1.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
536
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
938
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
 
939
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
537
940
        >>> i1 == i2
538
941
        False
539
 
        >>> i2.add(InventoryEntry('123', 'foo', 'file', ROOT_ID))
540
 
        InventoryEntry('123', 'foo', kind='file', parent_id='TREE_ROOT')
 
942
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
 
943
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
541
944
        >>> i1 == i2
542
945
        True
543
946
        """
552
955
 
553
956
 
554
957
    def __ne__(self, other):
555
 
        return not (self == other)
 
958
        return not self.__eq__(other)
556
959
 
557
960
 
558
961
    def __hash__(self):
559
962
        raise ValueError('not hashable')
560
963
 
561
964
 
562
 
 
563
965
    def get_idpath(self, file_id):
564
966
        """Return a list of file_ids for the path to an entry.
565
967
 
580
982
 
581
983
 
582
984
    def id2path(self, file_id):
583
 
        """Return as a list the path to file_id."""
584
 
 
 
985
        """Return as a list the path to file_id.
 
986
        
 
987
        >>> i = Inventory()
 
988
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
 
989
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
 
990
        >>> print i.id2path('foo-id').replace(os.sep, '/')
 
991
        src/foo.c
 
992
        """
585
993
        # get all names, skipping root
586
994
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
587
995
        return os.sep.join(p)