~bzr-pqm/bzr/bzr.dev

138 by mbp at sourcefrog
remove parallel tree from inventory;
1
# (C) 2005 Canonical Ltd
1448 by Robert Collins
revert symlinks correctly
2
#
1 by mbp at sourcefrog
import from baz patch-364
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
1448 by Robert Collins
revert symlinks correctly
7
#
1 by mbp at sourcefrog
import from baz patch-364
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
# GNU General Public License for more details.
1448 by Robert Collins
revert symlinks correctly
12
#
1 by mbp at sourcefrog
import from baz patch-364
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
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.
1 by mbp at sourcefrog
import from baz patch-364
21
1197 by Martin Pool
doc
22
# TODO: Maybe also keep the full path of the entry, and the children?
23
# But those depend on its position within a particular inventory, and
24
# it would be nice not to need to hold the backpointer here.
25
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
26
# This should really be an id randomly assigned when the tree is
27
# created, but it's not for now.
28
ROOT_ID = "TREE_ROOT"
29
30
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
31
import os.path
32
import re
33
import sys
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
34
import tarfile
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
35
import types
1 by mbp at sourcefrog
import from baz patch-364
36
800 by Martin Pool
Merge John's import-speedup branch:
37
import bzrlib
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
38
from bzrlib.osutils import (pumpfile, quotefn, splitpath, joinpath,
39
                            appendpath, sha_strings)
70 by mbp at sourcefrog
Prepare for smart recursive add.
40
from bzrlib.trace import mutter
1185.16.63 by Martin Pool
- more error conversion
41
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
42
                           BzrError, BzrCheckError)
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
43
1 by mbp at sourcefrog
import from baz patch-364
44
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
45
class InventoryEntry(object):
1 by mbp at sourcefrog
import from baz patch-364
46
    """Description of a versioned file.
47
48
    An InventoryEntry has the following fields, which are also
49
    present in the XML inventory-entry element:
50
1197 by Martin Pool
doc
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
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
59
    revision
1398 by Robert Collins
integrate in Gustavos x-bit patch
60
        the revision_id in which this variation of this file was 
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
61
        introduced.
1197 by Martin Pool
doc
62
1398 by Robert Collins
integrate in Gustavos x-bit patch
63
    executable
64
        Indicates that this file should be executable on systems
65
        that support it.
66
1197 by Martin Pool
doc
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.)
1 by mbp at sourcefrog
import from baz patch-364
74
75
    >>> i = Inventory()
76
    >>> i.path2id('')
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
77
    'TREE_ROOT'
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
78
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
79
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT')
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
80
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
81
    InventoryFile('2323', 'hello.c', parent_id='123')
1 by mbp at sourcefrog
import from baz patch-364
82
    >>> for j in i.iter_entries():
83
    ...   print j
84
    ... 
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
85
    ('src', InventoryDirectory('123', 'src', parent_id='TREE_ROOT'))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
86
    ('src/hello.c', InventoryFile('2323', 'hello.c', parent_id='123'))
87
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
1 by mbp at sourcefrog
import from baz patch-364
88
    Traceback (most recent call last):
89
    ...
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
90
    BzrError: inventory already contains entry with id {2323}
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
91
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
92
    InventoryFile('2324', 'bye.c', parent_id='123')
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
93
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
94
    InventoryDirectory('2325', 'wibble', parent_id='123')
1 by mbp at sourcefrog
import from baz patch-364
95
    >>> i.path2id('src/wibble')
96
    '2325'
97
    >>> '2325' in i
98
    True
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
99
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
100
    InventoryFile('2326', 'wibble.c', parent_id='2325')
1 by mbp at sourcefrog
import from baz patch-364
101
    >>> i['2326']
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
102
    InventoryFile('2326', 'wibble.c', parent_id='2325')
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
103
    >>> for path, entry in i.iter_entries():
104
    ...     print path.replace('\\\\', '/')     # for win32 os.sep
105
    ...     assert i.path2id(path)
1 by mbp at sourcefrog
import from baz patch-364
106
    ... 
107
    src
108
    src/bye.c
109
    src/hello.c
110
    src/wibble
111
    src/wibble/wibble.c
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
112
    >>> i.id2path('2326').replace('\\\\', '/')
1 by mbp at sourcefrog
import from baz patch-364
113
    'src/wibble/wibble.c'
114
    """
1197 by Martin Pool
doc
115
    
955 by Martin Pool
- use __slots__ on InventoryEntry; rather faster
116
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
1398 by Robert Collins
integrate in Gustavos x-bit patch
117
                 'text_id', 'parent_id', 'children', 'executable', 
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
118
                 'revision']
1185 by Martin Pool
- add xml round-trip test for revisions
119
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
120
    def _add_text_to_weave(self, new_lines, parents, weave_store, transaction):
121
        weave_store.add_text(self.file_id, self.revision, new_lines, parents,
122
                             transaction)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
123
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
124
    def detect_changes(self, old_entry):
125
        """Return a (text_modified, meta_modified) from this to old_entry.
126
        
127
        _read_tree_state must have been called on self and old_entry prior to 
128
        calling detect_changes.
129
        """
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
130
        return False, False
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
131
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
132
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
133
             output_to, reverse=False):
134
        """Perform a diff from this to to_entry.
135
136
        text_diff will be used for textual difference calculation.
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
137
        This is a template method, override _diff in child classes.
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
138
        """
1185.12.33 by Aaron Bentley
Fixed symlink reverting
139
        self._read_tree_state(tree.id2path(self.file_id), tree)
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
140
        if to_entry:
141
            # cannot diff from one kind to another - you must do a removal
142
            # and an addif they do not match.
143
            assert self.kind == to_entry.kind
1185.12.33 by Aaron Bentley
Fixed symlink reverting
144
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
145
                                      to_tree)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
146
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
147
                   output_to, reverse)
148
149
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
150
             output_to, reverse=False):
151
        """Perform a diff between two entries of the same kind."""
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
152
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
153
    def find_previous_heads(self, previous_inventories, entry_weave):
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
154
        """Return the revisions and entries that directly preceed this.
155
156
        Returned as a map from revision to inventory entry.
157
158
        This is a map containing the file revisions in all parents
159
        for which the file exists, and its revision is not a parent of
160
        any other. If the file is new, the set will be empty.
161
        """
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
162
        def get_ancestors(weave, entry):
163
            return set(map(weave.idx_to_name,
164
                           weave.inclusions([weave.lookup(entry.revision)])))
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
165
        heads = {}
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
166
        head_ancestors = {}
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
167
        for inv in previous_inventories:
168
            if self.file_id in inv:
169
                ie = inv[self.file_id]
170
                assert ie.file_id == self.file_id
171
                if ie.revision in heads:
1185.1.51 by Robert Collins
merge in reweave support
172
                    # fixup logic, there was a bug in revision updates.
173
                    # with x bit support.
174
                    try:
175
                        if heads[ie.revision].executable != ie.executable:
176
                            heads[ie.revision].executable = False
177
                            ie.executable = False
178
                    except AttributeError:
179
                        pass
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
180
                    assert heads[ie.revision] == ie
181
                else:
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
182
                    # may want to add it.
183
                    # may already be covered:
184
                    already_present = 0 != len(
185
                        [head for head in heads 
186
                         if ie.revision in head_ancestors[head]])
187
                    if already_present:
188
                        # an ancestor of a known head.
189
                        continue
190
                    # definately a head:
191
                    ancestors = get_ancestors(entry_weave, ie)
192
                    # may knock something else out:
193
                    check_heads = list(heads.keys())
194
                    for head in check_heads:
195
                        if head in ancestors:
196
                            # this head is not really a head
197
                            heads.pop(head)
198
                    head_ancestors[ie.revision] = ancestors
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
199
                    heads[ie.revision] = ie
200
        return heads
201
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
202
    def get_tar_item(self, root, dp, now, tree):
1399.1.7 by Robert Collins
implement symlink exporting to tarballs
203
        """Get a tarfile item and a file stream for its content."""
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
204
        item = tarfile.TarInfo(os.path.join(root, dp))
205
        # TODO: would be cool to actually set it to the timestamp of the
206
        # revision it was last changed
207
        item.mtime = now
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
208
        fileobj = self._put_in_tar(item, tree)
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
209
        return item, fileobj
210
1399.1.5 by Robert Collins
move checking whether an entry stores text into inventory.py from fetch,py
211
    def has_text(self):
212
        """Return true if the object this entry represents has textual data.
213
214
        Note that textual data includes binary content.
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
215
216
        Also note that all entries get weave files created for them.
217
        This attribute is primarily used when upgrading from old trees that
218
        did not have the weave index for all inventory entries.
1399.1.5 by Robert Collins
move checking whether an entry stores text into inventory.py from fetch,py
219
        """
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
220
        return False
1399.1.5 by Robert Collins
move checking whether an entry stores text into inventory.py from fetch,py
221
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
222
    def __init__(self, file_id, name, parent_id, text_id=None):
1 by mbp at sourcefrog
import from baz patch-364
223
        """Create an InventoryEntry
224
        
225
        The filename must be a single component, relative to the
226
        parent directory; it cannot be a whole path or relative name.
227
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
228
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
1 by mbp at sourcefrog
import from baz patch-364
229
        >>> e.name
230
        'hello.c'
231
        >>> e.file_id
232
        '123'
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
233
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
1 by mbp at sourcefrog
import from baz patch-364
234
        Traceback (most recent call last):
1185.16.63 by Martin Pool
- more error conversion
235
        InvalidEntryName: Invalid entry name: src/hello.c
1 by mbp at sourcefrog
import from baz patch-364
236
        """
1183 by Martin Pool
- implement version 5 xml storage, and tests
237
        assert isinstance(name, basestring), name
376 by Martin Pool
- fix slow invariant check when reading in InventoryEntry objects
238
        if '/' in name or '\\' in name:
1185.16.63 by Martin Pool
- more error conversion
239
            raise InvalidEntryName(name=name)
1398 by Robert Collins
integrate in Gustavos x-bit patch
240
        self.executable = False
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
241
        self.revision = None
955 by Martin Pool
- use __slots__ on InventoryEntry; rather faster
242
        self.text_sha1 = None
243
        self.text_size = None
1 by mbp at sourcefrog
import from baz patch-364
244
        self.file_id = file_id
245
        self.name = name
246
        self.text_id = text_id
247
        self.parent_id = parent_id
1092.2.6 by Robert Collins
symlink support updated to work
248
        self.symlink_target = None
237 by mbp at sourcefrog
- Better assertions in InventoryEntry constructor
249
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
250
    def kind_character(self):
251
        """Return a short kind indicator useful for appending to names."""
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
252
        raise BzrError('unknown kind %r' % self.kind)
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
253
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
254
    known_kinds = ('file', 'directory', 'symlink', 'root_directory')
1 by mbp at sourcefrog
import from baz patch-364
255
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
256
    def _put_in_tar(self, item, tree):
257
        """populate item for stashing in a tar, and return the content stream.
258
259
        If no content is available, return None.
260
        """
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
261
        raise BzrError("don't know how to export {%s} of kind %r" %
262
                       (self.file_id, self.kind))
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
263
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
264
    def put_on_disk(self, dest, dp, tree):
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
265
        """Create a representation of self on disk in the prefix dest.
266
        
267
        This is a template method - implement _put_on_disk in subclasses.
268
        """
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
269
        fullpath = appendpath(dest, dp)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
270
        self._put_on_disk(fullpath, tree)
271
        mutter("  export {%s} kind %s to %s" % (self.file_id, self.kind, fullpath))
272
273
    def _put_on_disk(self, fullpath, tree):
274
        """Put this entry onto disk at fullpath, from tree tree."""
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
275
        raise BzrError("don't know how to export {%s} of kind %r" % (self.file_id, self.kind))
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
276
156 by mbp at sourcefrog
new "directories" command
277
    def sorted_children(self):
278
        l = self.children.items()
279
        l.sort()
280
        return l
281
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
282
    @staticmethod
283
    def versionable_kind(kind):
284
        return kind in ('file', 'directory', 'symlink')
285
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
286
    def check(self, checker, rev_id, inv, tree):
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
287
        """Check this inventory entry is intact.
288
289
        This is a template method, override _check for kind specific
290
        tests.
291
        """
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
292
        if self.parent_id != None:
293
            if not inv.has_id(self.parent_id):
294
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
295
                        % (self.parent_id, rev_id))
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
296
        self._check(checker, rev_id, tree)
297
298
    def _check(self, checker, rev_id, tree):
299
        """Check this inventory entry for kind specific errors."""
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
300
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
301
                            (self.kind, rev_id))
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
302
156 by mbp at sourcefrog
new "directories" command
303
1 by mbp at sourcefrog
import from baz patch-364
304
    def copy(self):
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
305
        """Clone this inventory entry."""
306
        raise NotImplementedError
1 by mbp at sourcefrog
import from baz patch-364
307
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
308
    def _get_snapshot_change(self, previous_entries):
309
        if len(previous_entries) > 1:
310
            return 'merged'
311
        elif len(previous_entries) == 0:
312
            return 'added'
313
        else:
314
            return 'modified/renamed/reparented'
1 by mbp at sourcefrog
import from baz patch-364
315
316
    def __repr__(self):
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
317
        return ("%s(%r, %r, parent_id=%r)"
1 by mbp at sourcefrog
import from baz patch-364
318
                % (self.__class__.__name__,
319
                   self.file_id,
320
                   self.name,
321
                   self.parent_id))
322
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
323
    def snapshot(self, revision, path, previous_entries,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
324
                 work_tree, weave_store, transaction):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
325
        """Make a snapshot of this entry which may or may not have changed.
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
326
        
327
        This means that all its fields are populated, that it has its
328
        text stored in the text store or weave.
329
        """
330
        mutter('new parents of %s are %r', path, previous_entries)
1185.12.33 by Aaron Bentley
Fixed symlink reverting
331
        self._read_tree_state(path, work_tree)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
332
        if len(previous_entries) == 1:
333
            # cannot be unchanged unless there is only one parent file rev.
334
            parent_ie = previous_entries.values()[0]
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
335
            if self._unchanged(parent_ie):
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
336
                mutter("found unchanged entry")
337
                self.revision = parent_ie.revision
338
                return "unchanged"
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
339
        return self.snapshot_revision(revision, previous_entries, 
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
340
                                      work_tree, weave_store, transaction)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
341
342
    def snapshot_revision(self, revision, previous_entries, work_tree,
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
343
                          weave_store, transaction):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
344
        """Record this revision unconditionally."""
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
345
        mutter('new revision for {%s}', self.file_id)
346
        self.revision = revision
347
        change = self._get_snapshot_change(previous_entries)
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
348
        self._snapshot_text(previous_entries, work_tree, weave_store,
349
                            transaction)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
350
        return change
351
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
352
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction): 
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
353
        """Record the 'text' of this entry, whatever form that takes.
354
        
355
        This default implementation simply adds an empty text.
356
        """
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
357
        mutter('storing file {%s} in revision {%s}',
358
               self.file_id, self.revision)
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
359
        self._add_text_to_weave([], file_parents, weave_store, transaction)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
360
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
361
    def __eq__(self, other):
1 by mbp at sourcefrog
import from baz patch-364
362
        if not isinstance(other, InventoryEntry):
363
            return NotImplemented
364
1398 by Robert Collins
integrate in Gustavos x-bit patch
365
        return ((self.file_id == other.file_id)
366
                and (self.name == other.name)
367
                and (other.symlink_target == self.symlink_target)
368
                and (self.text_sha1 == other.text_sha1)
369
                and (self.text_size == other.text_size)
370
                and (self.text_id == other.text_id)
371
                and (self.parent_id == other.parent_id)
372
                and (self.kind == other.kind)
373
                and (self.revision == other.revision)
374
                and (self.executable == other.executable)
375
                )
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
376
377
    def __ne__(self, other):
378
        return not (self == other)
379
380
    def __hash__(self):
381
        raise ValueError('not hashable')
1 by mbp at sourcefrog
import from baz patch-364
382
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
383
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
384
        """Has this entry changed relative to previous_ie.
385
386
        This method should be overriden in child classes.
387
        """
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
388
        compatible = True
389
        # different inv parent
390
        if previous_ie.parent_id != self.parent_id:
391
            compatible = False
392
        # renamed
393
        elif previous_ie.name != self.name:
394
            compatible = False
395
        return compatible
396
1185.12.33 by Aaron Bentley
Fixed symlink reverting
397
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
398
        """Populate fields in the inventory entry from the given tree.
399
        
400
        Note that this should be modified to be a noop on virtual trees
401
        as all entries created there are prepopulated.
402
        """
1185.16.5 by Martin Pool
doc
403
        # TODO: Rather than running this manually, we should check the 
404
        # working sha1 and other expensive properties when they're
405
        # first requested, or preload them if they're already known
406
        pass            # nothing to do by default
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
407
1 by mbp at sourcefrog
import from baz patch-364
408
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
409
class RootEntry(InventoryEntry):
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
410
411
    def _check(self, checker, rev_id, tree):
412
        """See InventoryEntry._check"""
413
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
414
    def __init__(self, file_id):
415
        self.file_id = file_id
416
        self.children = {}
417
        self.kind = 'root_directory'
418
        self.parent_id = None
156 by mbp at sourcefrog
new "directories" command
419
        self.name = ''
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
420
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
421
    def __eq__(self, other):
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
422
        if not isinstance(other, RootEntry):
423
            return NotImplemented
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
424
        
425
        return (self.file_id == other.file_id) \
426
               and (self.children == other.children)
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
427
428
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
429
class InventoryDirectory(InventoryEntry):
430
    """A directory in an inventory."""
431
432
    def _check(self, checker, rev_id, tree):
433
        """See InventoryEntry._check"""
434
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
435
            raise BzrCheckError('directory {%s} has text in revision {%s}'
436
                                % (self.file_id, rev_id))
437
438
    def copy(self):
439
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
440
        other.revision = self.revision
441
        # note that children are *not* copied; they're pulled across when
442
        # others are added
443
        return other
444
445
    def __init__(self, file_id, name, parent_id):
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
446
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
447
        self.children = {}
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
448
        self.kind = 'directory'
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
449
450
    def kind_character(self):
451
        """See InventoryEntry.kind_character."""
452
        return '/'
453
454
    def _put_in_tar(self, item, tree):
455
        """See InventoryEntry._put_in_tar."""
456
        item.type = tarfile.DIRTYPE
457
        fileobj = None
458
        item.name += '/'
459
        item.size = 0
460
        item.mode = 0755
461
        return fileobj
462
463
    def _put_on_disk(self, fullpath, tree):
464
        """See InventoryEntry._put_on_disk."""
465
        os.mkdir(fullpath)
466
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
467
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
468
class InventoryFile(InventoryEntry):
469
    """A file in an inventory."""
470
471
    def _check(self, checker, rev_id, tree):
472
        """See InventoryEntry._check"""
473
        revision = self.revision
474
        t = (self.file_id, revision)
475
        if t in checker.checked_texts:
476
            prev_sha = checker.checked_texts[t] 
477
            if prev_sha != self.text_sha1:
478
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
479
                                    (self.file_id, rev_id))
480
            else:
481
                checker.repeated_text_cnt += 1
482
                return
483
        mutter('check version {%s} of {%s}', rev_id, self.file_id)
484
        file_lines = tree.get_file_lines(self.file_id)
485
        checker.checked_text_cnt += 1 
486
        if self.text_size != sum(map(len, file_lines)):
487
            raise BzrCheckError('text {%s} wrong size' % self.text_id)
488
        if self.text_sha1 != sha_strings(file_lines):
489
            raise BzrCheckError('text {%s} wrong sha1' % self.text_id)
490
        checker.checked_texts[t] = self.text_sha1
491
492
    def copy(self):
493
        other = InventoryFile(self.file_id, self.name, self.parent_id)
494
        other.executable = self.executable
495
        other.text_id = self.text_id
496
        other.text_sha1 = self.text_sha1
497
        other.text_size = self.text_size
498
        other.revision = self.revision
499
        return other
500
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
501
    def detect_changes(self, old_entry):
502
        """See InventoryEntry.detect_changes."""
503
        assert self.text_sha1 != None
504
        assert old_entry.text_sha1 != None
505
        text_modified = (self.text_sha1 != old_entry.text_sha1)
506
        meta_modified = (self.executable != old_entry.executable)
507
        return text_modified, meta_modified
508
509
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
510
             output_to, reverse=False):
511
        """See InventoryEntry._diff."""
512
        from_text = tree.get_file(self.file_id).readlines()
513
        if to_entry:
514
            to_text = to_tree.get_file(to_entry.file_id).readlines()
515
        else:
516
            to_text = []
517
        if not reverse:
518
            text_diff(from_label, from_text,
519
                      to_label, to_text, output_to)
520
        else:
521
            text_diff(to_label, to_text,
522
                      from_label, from_text, output_to)
523
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
524
    def has_text(self):
525
        """See InventoryEntry.has_text."""
526
        return True
527
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
528
    def __init__(self, file_id, name, parent_id):
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
529
        super(InventoryFile, self).__init__(file_id, name, parent_id)
530
        self.kind = 'file'
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
531
532
    def kind_character(self):
533
        """See InventoryEntry.kind_character."""
534
        return ''
535
536
    def _put_in_tar(self, item, tree):
537
        """See InventoryEntry._put_in_tar."""
538
        item.type = tarfile.REGTYPE
539
        fileobj = tree.get_file(self.file_id)
540
        item.size = self.text_size
541
        if tree.is_executable(self.file_id):
542
            item.mode = 0755
543
        else:
544
            item.mode = 0644
545
        return fileobj
546
547
    def _put_on_disk(self, fullpath, tree):
548
        """See InventoryEntry._put_on_disk."""
549
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
550
        if tree.is_executable(self.file_id):
551
            os.chmod(fullpath, 0755)
552
1185.12.33 by Aaron Bentley
Fixed symlink reverting
553
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
554
        """See InventoryEntry._read_tree_state."""
555
        self.text_sha1 = work_tree.get_file_sha1(self.file_id)
556
        self.executable = work_tree.is_executable(self.file_id)
557
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
558
    def _snapshot_text(self, file_parents, work_tree, weave_store, transaction):
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
559
        """See InventoryEntry._snapshot_text."""
560
        mutter('storing file {%s} in revision {%s}',
561
               self.file_id, self.revision)
562
        # special case to avoid diffing on renames or 
563
        # reparenting
564
        if (len(file_parents) == 1
565
            and self.text_sha1 == file_parents.values()[0].text_sha1
566
            and self.text_size == file_parents.values()[0].text_size):
567
            previous_ie = file_parents.values()[0]
568
            weave_store.add_identical_text(
569
                self.file_id, previous_ie.revision, 
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
570
                self.revision, file_parents, transaction)
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
571
        else:
572
            new_lines = work_tree.get_file(self.file_id).readlines()
1417.1.8 by Robert Collins
use transactions in the weave store interface, which enables caching for log
573
            self._add_text_to_weave(new_lines, file_parents, weave_store,
574
                                    transaction)
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
575
            self.text_sha1 = sha_strings(new_lines)
576
            self.text_size = sum(map(len, new_lines))
577
578
579
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
580
        """See InventoryEntry._unchanged."""
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
581
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
582
        if self.text_sha1 != previous_ie.text_sha1:
583
            compatible = False
584
        else:
585
            # FIXME: 20050930 probe for the text size when getting sha1
586
            # in _read_tree_state
587
            self.text_size = previous_ie.text_size
1185.1.52 by Robert Collins
fix detection of changes in inventory entries when the x bit is toggled
588
        if self.executable != previous_ie.executable:
589
            compatible = False
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
590
        return compatible
591
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
592
593
class InventoryLink(InventoryEntry):
594
    """A file in an inventory."""
595
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
596
    __slots__ = ['symlink_target']
597
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
598
    def _check(self, checker, rev_id, tree):
599
        """See InventoryEntry._check"""
600
        if self.text_sha1 != None or self.text_size != None or self.text_id != None:
601
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
602
                    % (self.file_id, rev_id))
603
        if self.symlink_target == None:
604
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
605
                    % (self.file_id, rev_id))
606
607
    def copy(self):
608
        other = InventoryLink(self.file_id, self.name, self.parent_id)
609
        other.symlink_target = self.symlink_target
610
        other.revision = self.revision
611
        return other
612
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
613
    def detect_changes(self, old_entry):
614
        """See InventoryEntry.detect_changes."""
615
        # FIXME: which _modified field should we use ? RBC 20051003
616
        text_modified = (self.symlink_target != old_entry.symlink_target)
617
        if text_modified:
618
            mutter("    symlink target changed")
619
        meta_modified = False
620
        return text_modified, meta_modified
621
622
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
623
             output_to, reverse=False):
624
        """See InventoryEntry._diff."""
625
        from_text = self.symlink_target
626
        if to_entry is not None:
627
            to_text = to_entry.symlink_target
628
            if reverse:
629
                temp = from_text
630
                from_text = to_text
631
                to_text = temp
632
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
633
        else:
634
            if not reverse:
635
                print >>output_to, '=== target was %r' % self.symlink_target
636
            else:
637
                print >>output_to, '=== target is %r' % self.symlink_target
638
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
639
    def __init__(self, file_id, name, parent_id):
640
        super(InventoryLink, self).__init__(file_id, name, parent_id)
641
        self.kind = 'symlink'
642
643
    def kind_character(self):
644
        """See InventoryEntry.kind_character."""
645
        return ''
646
647
    def _put_in_tar(self, item, tree):
648
        """See InventoryEntry._put_in_tar."""
649
        iterm.type = tarfile.SYMTYPE
650
        fileobj = None
651
        item.size = 0
652
        item.mode = 0755
653
        item.linkname = self.symlink_target
654
        return fileobj
655
656
    def _put_on_disk(self, fullpath, tree):
657
        """See InventoryEntry._put_on_disk."""
658
        try:
659
            os.symlink(self.symlink_target, fullpath)
660
        except OSError,e:
661
            raise BzrError("Failed to create symlink %r -> %r, error: %s" % (fullpath, self.symlink_target, e))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
662
1185.12.33 by Aaron Bentley
Fixed symlink reverting
663
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
664
        """See InventoryEntry._read_tree_state."""
665
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
666
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
667
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
668
        """See InventoryEntry._unchanged."""
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
669
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
670
        if self.symlink_target != previous_ie.symlink_target:
671
            compatible = False
672
        return compatible
673
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
674
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
675
class Inventory(object):
1 by mbp at sourcefrog
import from baz patch-364
676
    """Inventory of versioned files in a tree.
677
240 by mbp at sourcefrog
doc
678
    This describes which file_id is present at each point in the tree,
679
    and possibly the SHA-1 or other information about the file.
680
    Entries can be looked up either by path or by file_id.
1 by mbp at sourcefrog
import from baz patch-364
681
682
    The inventory represents a typical unix file tree, with
683
    directories containing files and subdirectories.  We never store
684
    the full path to a file, because renaming a directory implicitly
685
    moves all of its contents.  This class internally maintains a
686
    lookup tree that allows the children under a directory to be
687
    returned quickly.
688
689
    InventoryEntry objects must not be modified after they are
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
690
    inserted, other than through the Inventory API.
1 by mbp at sourcefrog
import from baz patch-364
691
692
    >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
693
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
694
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
695
    >>> inv['123-123'].name
696
    'hello.c'
697
698
    May be treated as an iterator or set to look up file ids:
699
    
700
    >>> bool(inv.path2id('hello.c'))
701
    True
702
    >>> '123-123' in inv
703
    True
704
705
    May also look up by name:
706
707
    >>> [x[0] for x in inv.iter_entries()]
708
    ['hello.c']
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
709
    >>> inv = Inventory('TREE_ROOT-12345678-12345678')
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
710
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
711
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678')
1 by mbp at sourcefrog
import from baz patch-364
712
    """
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
713
    def __init__(self, root_id=ROOT_ID):
1 by mbp at sourcefrog
import from baz patch-364
714
        """Create or read an inventory.
715
716
        If a working directory is specified, the inventory is read
717
        from there.  If the file is specified, read from that. If not,
718
        the inventory is created empty.
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
719
720
        The inventory is created with a default root directory, with
721
        an id of None.
1 by mbp at sourcefrog
import from baz patch-364
722
        """
1185.11.5 by John Arbash Meinel
Merged up-to-date against mainline, still broken.
723
        # We are letting Branch.initialize() create a unique inventory
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
724
        # root id. Rather than generating a random one here.
725
        #if root_id is None:
726
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
727
        self.root = RootEntry(root_id)
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
728
        self._byid = {self.root.file_id: self.root}
1 by mbp at sourcefrog
import from baz patch-364
729
730
1189 by Martin Pool
- BROKEN: partial support for commit into weave
731
    def copy(self):
732
        other = Inventory(self.root.file_id)
1206 by Martin Pool
- fix bug in Inventory.copy()
733
        # copy recursively so we know directories will be added before
734
        # their children.  There are more efficient ways than this...
735
        for path, entry in self.iter_entries():
1189 by Martin Pool
- BROKEN: partial support for commit into weave
736
            if entry == self.root:
737
                continue
738
            other.add(entry.copy())
739
        return other
740
741
1 by mbp at sourcefrog
import from baz patch-364
742
    def __iter__(self):
743
        return iter(self._byid)
744
745
746
    def __len__(self):
747
        """Returns number of entries."""
748
        return len(self._byid)
749
750
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
751
    def iter_entries(self, from_dir=None):
1 by mbp at sourcefrog
import from baz patch-364
752
        """Return (path, entry) pairs, in order by name."""
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
753
        if from_dir == None:
754
            assert self.root
755
            from_dir = self.root
756
        elif isinstance(from_dir, basestring):
757
            from_dir = self._byid[from_dir]
758
            
759
        kids = from_dir.children.items()
1 by mbp at sourcefrog
import from baz patch-364
760
        kids.sort()
761
        for name, ie in kids:
762
            yield name, ie
763
            if ie.kind == 'directory':
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
764
                for cn, cie in self.iter_entries(from_dir=ie.file_id):
271 by Martin Pool
- Windows path fixes
765
                    yield os.path.join(name, cn), cie
555 by Martin Pool
- New Inventory.entries() method
766
767
768
    def entries(self):
769
        """Return list of (path, ie) for all entries except the root.
770
771
        This may be faster than iter_entries.
772
        """
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
773
        accum = []
774
        def descend(dir_ie, dir_path):
556 by Martin Pool
- fix up Inventory.entries()
775
            kids = dir_ie.children.items()
555 by Martin Pool
- New Inventory.entries() method
776
            kids.sort()
777
            for name, ie in kids:
778
                child_path = os.path.join(dir_path, name)
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
779
                accum.append((child_path, ie))
555 by Martin Pool
- New Inventory.entries() method
780
                if ie.kind == 'directory':
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
781
                    descend(ie, child_path)
555 by Martin Pool
- New Inventory.entries() method
782
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
783
        descend(self.root, '')
784
        return accum
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
785
786
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
787
    def directories(self):
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
788
        """Return (path, entry) pairs for all directories, including the root.
1 by mbp at sourcefrog
import from baz patch-364
789
        """
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
790
        accum = []
791
        def descend(parent_ie, parent_path):
792
            accum.append((parent_path, parent_ie))
156 by mbp at sourcefrog
new "directories" command
793
            
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
794
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
795
            kids.sort()
156 by mbp at sourcefrog
new "directories" command
796
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
797
            for name, child_ie in kids:
798
                child_path = os.path.join(parent_path, name)
799
                descend(child_ie, child_path)
800
        descend(self.root, '')
801
        return accum
1 by mbp at sourcefrog
import from baz patch-364
802
        
803
804
805
    def __contains__(self, file_id):
806
        """True if this entry contains a file with given id.
807
808
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
809
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
810
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
811
        >>> '123' in inv
812
        True
813
        >>> '456' in inv
814
        False
815
        """
816
        return file_id in self._byid
817
818
819
    def __getitem__(self, file_id):
820
        """Return the entry for given file_id.
821
822
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
823
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
824
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
825
        >>> inv['123123'].name
826
        'hello.c'
827
        """
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
828
        try:
829
            return self._byid[file_id]
830
        except KeyError:
380 by Martin Pool
- Slight optimization for Inventory.__getitem__
831
            if file_id == None:
832
                raise BzrError("can't look up file_id None")
833
            else:
834
                raise BzrError("file_id {%s} not in inventory" % file_id)
1 by mbp at sourcefrog
import from baz patch-364
835
836
460 by Martin Pool
- new testing command compare-trees
837
    def get_file_kind(self, file_id):
838
        return self._byid[file_id].kind
839
138 by mbp at sourcefrog
remove parallel tree from inventory;
840
    def get_child(self, parent_id, filename):
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
841
        return self[parent_id].children.get(filename)
138 by mbp at sourcefrog
remove parallel tree from inventory;
842
843
1 by mbp at sourcefrog
import from baz patch-364
844
    def add(self, entry):
845
        """Add entry to inventory.
846
847
        To add  a file to a branch ready to be committed, use Branch.add,
1180 by Martin Pool
- start splitting code for xml (de)serialization away from objects
848
        which calls this.
849
850
        Returns the new entry object.
851
        """
139 by mbp at sourcefrog
simplified/faster Inventory.add
852
        if entry.file_id in self._byid:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
853
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
1 by mbp at sourcefrog
import from baz patch-364
854
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
855
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
856
            entry.parent_id = self.root.file_id
857
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
858
        try:
859
            parent = self._byid[entry.parent_id]
860
        except KeyError:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
861
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
139 by mbp at sourcefrog
simplified/faster Inventory.add
862
863
        if parent.children.has_key(entry.name):
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
864
            raise BzrError("%s is already versioned" %
140 by mbp at sourcefrog
fix error message for repeated add
865
                    appendpath(self.id2path(parent.file_id), entry.name))
1 by mbp at sourcefrog
import from baz patch-364
866
867
        self._byid[entry.file_id] = entry
139 by mbp at sourcefrog
simplified/faster Inventory.add
868
        parent.children[entry.name] = entry
1092.1.30 by Robert Collins
change smart_add reporting of added files to callback with the entry, and change the inventory.add signature to return the added entry
869
        return entry
1 by mbp at sourcefrog
import from baz patch-364
870
871
70 by mbp at sourcefrog
Prepare for smart recursive add.
872
    def add_path(self, relpath, kind, file_id=None):
873
        """Add entry from a path.
874
1180 by Martin Pool
- start splitting code for xml (de)serialization away from objects
875
        The immediate parent must already be versioned.
876
877
        Returns the new entry object."""
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
878
        from bzrlib.branch import gen_file_id
1015 by Martin Pool
- fix circular imports
879
        
70 by mbp at sourcefrog
Prepare for smart recursive add.
880
        parts = bzrlib.osutils.splitpath(relpath)
881
        if len(parts) == 0:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
882
            raise BzrError("cannot re-add root of inventory")
70 by mbp at sourcefrog
Prepare for smart recursive add.
883
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
884
        if file_id == None:
800 by Martin Pool
Merge John's import-speedup branch:
885
            file_id = gen_file_id(relpath)
70 by mbp at sourcefrog
Prepare for smart recursive add.
886
753 by Martin Pool
- new exception NotVersionedError
887
        parent_path = parts[:-1]
888
        parent_id = self.path2id(parent_path)
889
        if parent_id == None:
1185.16.72 by Martin Pool
[merge] from robert and fix up tests
890
            raise NotVersionedError(path=parent_path)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
891
        if kind == 'directory':
892
            ie = InventoryDirectory(file_id, parts[-1], parent_id)
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
893
        elif kind == 'file':
894
            ie = InventoryFile(file_id, parts[-1], parent_id)
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
895
        elif kind == 'symlink':
896
            ie = InventoryLink(file_id, parts[-1], parent_id)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
897
        else:
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
898
            raise BzrError("unknown kind %r" % kind)
70 by mbp at sourcefrog
Prepare for smart recursive add.
899
        return self.add(ie)
900
901
1 by mbp at sourcefrog
import from baz patch-364
902
    def __delitem__(self, file_id):
903
        """Remove entry by id.
904
905
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
906
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
907
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
908
        >>> '123' in inv
909
        True
910
        >>> del inv['123']
911
        >>> '123' in inv
912
        False
913
        """
914
        ie = self[file_id]
915
138 by mbp at sourcefrog
remove parallel tree from inventory;
916
        assert self[ie.parent_id].children[ie.name] == ie
1 by mbp at sourcefrog
import from baz patch-364
917
        
918
        # TODO: Test deleting all children; maybe hoist to a separate
919
        # deltree method?
920
        if ie.kind == 'directory':
138 by mbp at sourcefrog
remove parallel tree from inventory;
921
            for cie in ie.children.values():
1 by mbp at sourcefrog
import from baz patch-364
922
                del self[cie.file_id]
138 by mbp at sourcefrog
remove parallel tree from inventory;
923
            del ie.children
1 by mbp at sourcefrog
import from baz patch-364
924
925
        del self._byid[file_id]
138 by mbp at sourcefrog
remove parallel tree from inventory;
926
        del self[ie.parent_id].children[ie.name]
1 by mbp at sourcefrog
import from baz patch-364
927
928
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
929
    def __eq__(self, other):
1 by mbp at sourcefrog
import from baz patch-364
930
        """Compare two sets by comparing their contents.
931
932
        >>> i1 = Inventory()
933
        >>> i2 = Inventory()
934
        >>> i1 == i2
935
        True
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
936
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
937
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
938
        >>> i1 == i2
939
        False
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
940
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
941
        InventoryFile('123', 'foo', parent_id='TREE_ROOT')
1 by mbp at sourcefrog
import from baz patch-364
942
        >>> i1 == i2
943
        True
944
        """
945
        if not isinstance(other, Inventory):
946
            return NotImplemented
947
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
948
        if len(self._byid) != len(other._byid):
543 by Martin Pool
- More cleanups for set type
949
            # shortcut: obviously not the same
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
950
            return False
951
952
        return self._byid == other._byid
953
954
955
    def __ne__(self, other):
1249 by Martin Pool
- improvements to weave commit [broken]
956
        return not self.__eq__(other)
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
957
958
959
    def __hash__(self):
960
        raise ValueError('not hashable')
961
1 by mbp at sourcefrog
import from baz patch-364
962
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
963
    def get_idpath(self, file_id):
964
        """Return a list of file_ids for the path to an entry.
965
966
        The list contains one element for each directory followed by
967
        the id of the file itself.  So the length of the returned list
968
        is equal to the depth of the file in the tree, counting the
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
969
        root directory as depth 1.
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
970
        """
971
        p = []
972
        while file_id != None:
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
973
            try:
974
                ie = self._byid[file_id]
975
            except KeyError:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
976
                raise BzrError("file_id {%s} not found in inventory" % file_id)
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
977
            p.insert(0, ie.file_id)
978
            file_id = ie.parent_id
979
        return p
980
981
1 by mbp at sourcefrog
import from baz patch-364
982
    def id2path(self, file_id):
1393.1.32 by Martin Pool
- add docstring demonstrating use of Inventory.id2path
983
        """Return as a list the path to file_id.
984
        
985
        >>> i = Inventory()
986
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
987
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
988
        >>> print i.id2path('foo-id').replace(os.sep, '/')
989
        src/foo.c
990
        """
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
991
        # get all names, skipping root
922 by Martin Pool
- optimization for Inventory.id2path; access byid map directly rather than
992
        p = [self._byid[fid].name for fid in self.get_idpath(file_id)[1:]]
271 by Martin Pool
- Windows path fixes
993
        return os.sep.join(p)
1 by mbp at sourcefrog
import from baz patch-364
994
            
995
996
997
    def path2id(self, name):
998
        """Walk down through directories to return entry of last component.
999
1000
        names may be either a list of path components, or a single
1001
        string, in which case it is automatically split.
1002
1003
        This returns the entry of the last component in the path,
1004
        which may be either a file or a directory.
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1005
1006
        Returns None iff the path is not found.
1 by mbp at sourcefrog
import from baz patch-364
1007
        """
70 by mbp at sourcefrog
Prepare for smart recursive add.
1008
        if isinstance(name, types.StringTypes):
1009
            name = splitpath(name)
1 by mbp at sourcefrog
import from baz patch-364
1010
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1011
        mutter("lookup path %r" % name)
1012
1013
        parent = self.root
70 by mbp at sourcefrog
Prepare for smart recursive add.
1014
        for f in name:
1 by mbp at sourcefrog
import from baz patch-364
1015
            try:
138 by mbp at sourcefrog
remove parallel tree from inventory;
1016
                cie = parent.children[f]
1 by mbp at sourcefrog
import from baz patch-364
1017
                assert cie.name == f
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1018
                assert cie.parent_id == parent.file_id
138 by mbp at sourcefrog
remove parallel tree from inventory;
1019
                parent = cie
1 by mbp at sourcefrog
import from baz patch-364
1020
            except KeyError:
1021
                # or raise an error?
1022
                return None
1023
138 by mbp at sourcefrog
remove parallel tree from inventory;
1024
        return parent.file_id
1 by mbp at sourcefrog
import from baz patch-364
1025
1026
1027
    def has_filename(self, names):
1028
        return bool(self.path2id(names))
1029
1030
1031
    def has_id(self, file_id):
1032
        return self._byid.has_key(file_id)
1033
1034
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1035
    def rename(self, file_id, new_parent_id, new_name):
1036
        """Move a file within the inventory.
1037
1038
        This can change either the name, or the parent, or both.
1039
1040
        This does not move the working file."""
1041
        if not is_valid_name(new_name):
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1042
            raise BzrError("not an acceptable filename: %r" % new_name)
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1043
1044
        new_parent = self._byid[new_parent_id]
1045
        if new_name in new_parent.children:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1046
            raise BzrError("%r already exists in %r" % (new_name, self.id2path(new_parent_id)))
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1047
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1048
        new_parent_idpath = self.get_idpath(new_parent_id)
1049
        if file_id in new_parent_idpath:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1050
            raise BzrError("cannot move directory %r into a subdirectory of itself, %r"
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1051
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
1052
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1053
        file_ie = self._byid[file_id]
1054
        old_parent = self._byid[file_ie.parent_id]
1055
1056
        # TODO: Don't leave things messed up if this fails
1057
1058
        del old_parent.children[file_ie.name]
1059
        new_parent.children[new_name] = file_ie
1060
        
1061
        file_ie.name = new_name
1062
        file_ie.parent_id = new_parent_id
1063
1064
1065
1066
1077 by Martin Pool
- avoid compiling REs at module load time
1067
_NAME_RE = None
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1068
1069
def is_valid_name(name):
1077 by Martin Pool
- avoid compiling REs at module load time
1070
    global _NAME_RE
1071
    if _NAME_RE == None:
1072
        _NAME_RE = re.compile(r'^[^/\\]+$')
1073
        
160 by mbp at sourcefrog
- basic support for moving files to different directories - have not done support for renaming them yet, but should be straightforward - some tests, but many cases are not handled yet i think
1074
    return bool(_NAME_RE.match(name))