/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/inventory.py

  • Committer: John Arbash Meinel
  • Date: 2006-12-07 20:25:00 UTC
  • mto: This revision was merged to the branch mainline in revision 2171.
  • Revision ID: john@arbash-meinel.com-20061207202500-cdhbw4uw9p60w21o
The logic for when to display 'C' for conflicts was inverted.

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