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