~bzr-pqm/bzr/bzr.dev

1669.2.1 by Martin Pool
verbose commit now specifically identifies modified/renamed/reparented files
1
# Copyright (C) 2005, 2006 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
1732.1.23 by John Arbash Meinel
Switch iter_entries from being a recursive function and using pathjoin
31
import collections
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
32
import os.path
33
import re
34
import sys
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
35
import tarfile
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
36
import types
1907.1.4 by Aaron Bentley
Restore RootEntry, but mark it deprecated, restore EmptyTree.kind
37
from warnings import warn
1 by mbp at sourcefrog
import from baz patch-364
38
800 by Martin Pool
Merge John's import-speedup branch:
39
import bzrlib
1830.3.5 by John Arbash Meinel
make_entry refuses to create non-normalized entries.
40
from bzrlib import errors, osutils
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
41
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 \
42
                            pathjoin, sha_strings)
1558.15.2 by Aaron Bentley
Implemented binary file handling for diff
43
from bzrlib.errors import (NotVersionedError, InvalidEntryName,
44
                           BzrError, BzrCheckError, BinaryFile)
70 by mbp at sourcefrog
Prepare for smart recursive add.
45
from bzrlib.trace import mutter
1185.1.41 by Robert Collins
massive patch from Alexander Belchenko - many PEP8 fixes, removes unused function uuid
46
1 by mbp at sourcefrog
import from baz patch-364
47
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
48
class InventoryEntry(object):
1 by mbp at sourcefrog
import from baz patch-364
49
    """Description of a versioned file.
50
51
    An InventoryEntry has the following fields, which are also
52
    present in the XML inventory-entry element:
53
1197 by Martin Pool
doc
54
    file_id
55
56
    name
57
        (within the parent directory)
58
59
    parent_id
60
        file_id of the parent directory, or ROOT_ID
61
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
62
    revision
1398 by Robert Collins
integrate in Gustavos x-bit patch
63
        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
64
        introduced.
1197 by Martin Pool
doc
65
1398 by Robert Collins
integrate in Gustavos x-bit patch
66
    executable
67
        Indicates that this file should be executable on systems
68
        that support it.
69
1197 by Martin Pool
doc
70
    text_sha1
71
        sha-1 of the text of the file
72
        
73
    text_size
74
        size in bytes of the text of the file
75
        
76
    (reading a version 4 tree created a text_id field.)
1 by mbp at sourcefrog
import from baz patch-364
77
78
    >>> i = Inventory()
79
    >>> i.path2id('')
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
80
    'TREE_ROOT'
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
81
    >>> i.add(InventoryDirectory('123', 'src', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
82
    InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None)
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
83
    >>> i.add(InventoryFile('2323', 'hello.c', parent_id='123'))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
84
    InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None)
1852.6.6 by Robert Collins
Finish updating iter_entries change to make all tests pass.
85
    >>> shouldbe = {0: '', 1: 'src', 2: pathjoin('src','hello.c')}
1185.16.151 by Martin Pool
[patch] win32 fix for InventoryEntry doctest (Alexander, patch 21)
86
    >>> for ix, j in enumerate(i.iter_entries()):
87
    ...   print (j[0] == shouldbe[ix], j[1])
1 by mbp at sourcefrog
import from baz patch-364
88
    ... 
1731.1.28 by Aaron Bentley
Merge from bzr.dev
89
    (True, InventoryDirectory('TREE_ROOT', '', parent_id=None, revision=None))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
90
    (True, InventoryDirectory('123', 'src', parent_id='TREE_ROOT', revision=None))
91
    (True, InventoryFile('2323', 'hello.c', parent_id='123', sha1=None, len=None))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
92
    >>> i.add(InventoryFile('2323', 'bye.c', '123'))
1 by mbp at sourcefrog
import from baz patch-364
93
    Traceback (most recent call last):
94
    ...
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
95
    BzrError: inventory already contains entry with id {2323}
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
96
    >>> i.add(InventoryFile('2324', 'bye.c', '123'))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
97
    InventoryFile('2324', 'bye.c', parent_id='123', sha1=None, len=None)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
98
    >>> i.add(InventoryDirectory('2325', 'wibble', '123'))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
99
    InventoryDirectory('2325', 'wibble', parent_id='123', revision=None)
1 by mbp at sourcefrog
import from baz patch-364
100
    >>> i.path2id('src/wibble')
101
    '2325'
102
    >>> '2325' in i
103
    True
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
104
    >>> i.add(InventoryFile('2326', 'wibble.c', '2325'))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
105
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
106
    >>> i['2326']
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
107
    InventoryFile('2326', 'wibble.c', parent_id='2325', sha1=None, len=None)
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
108
    >>> 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 \
109
    ...     print path
1185.1.40 by Robert Collins
Merge what applied of Alexander Belchenko's win32 patch.
110
    ...     assert i.path2id(path)
1 by mbp at sourcefrog
import from baz patch-364
111
    ... 
1852.6.6 by Robert Collins
Finish updating iter_entries change to make all tests pass.
112
    <BLANKLINE>
1 by mbp at sourcefrog
import from baz patch-364
113
    src
114
    src/bye.c
115
    src/hello.c
116
    src/wibble
117
    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 \
118
    >>> i.id2path('2326')
1 by mbp at sourcefrog
import from baz patch-364
119
    'src/wibble/wibble.c'
120
    """
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
121
122
    # Constants returned by describe_change()
123
    #
124
    # TODO: These should probably move to some kind of FileChangeDescription 
125
    # class; that's like what's inside a TreeDelta but we want to be able to 
126
    # generate them just for one file at a time.
127
    RENAMED = 'renamed'
128
    MODIFIED_AND_RENAMED = 'modified and renamed'
1197 by Martin Pool
doc
129
    
1757.2.10 by Robert Collins
Give all inventory entries __slots__ that are useful with the current codebase.
130
    __slots__ = []
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
131
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
132
    def detect_changes(self, old_entry):
133
        """Return a (text_modified, meta_modified) from this to old_entry.
134
        
135
        _read_tree_state must have been called on self and old_entry prior to 
136
        calling detect_changes.
137
        """
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
138
        return False, False
1399.1.3 by Robert Collins
move change detection for text and metadata from delta to entry.detect_changes
139
1399.1.4 by Robert Collins
move diff and symlink conditionals into inventory.py from diff.py
140
    def diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
141
             output_to, reverse=False):
142
        """Perform a diff from this to to_entry.
143
144
        text_diff will be used for textual difference calculation.
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
145
        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
146
        """
1185.12.33 by Aaron Bentley
Fixed symlink reverting
147
        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
148
        if to_entry:
149
            # cannot diff from one kind to another - you must do a removal
150
            # and an addif they do not match.
151
            assert self.kind == to_entry.kind
1185.12.33 by Aaron Bentley
Fixed symlink reverting
152
            to_entry._read_tree_state(to_tree.id2path(to_entry.file_id),
153
                                      to_tree)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
154
        self._diff(text_diff, from_label, tree, to_label, to_entry, to_tree,
155
                   output_to, reverse)
156
157
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
158
             output_to, reverse=False):
159
        """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
160
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
161
    def find_previous_heads(self, previous_inventories,
162
                            versioned_file_store,
163
                            transaction,
164
                            entry_vf=None):
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
165
        """Return the revisions and entries that directly precede this.
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
166
167
        Returned as a map from revision to inventory entry.
168
169
        This is a map containing the file revisions in all parents
170
        for which the file exists, and its revision is not a parent of
171
        any other. If the file is new, the set will be empty.
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
172
173
        :param versioned_file_store: A store where ancestry data on this
174
                                     file id can be queried.
175
        :param transaction: The transaction that queries to the versioned 
176
                            file store should be completed under.
177
        :param entry_vf: The entry versioned file, if its already available.
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
178
        """
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
179
        def get_ancestors(weave, entry):
1563.2.18 by Robert Collins
get knit repositories really using knits for text storage.
180
            return set(weave.get_ancestry(entry.revision))
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
181
        # revision:ie mapping for each ie found in previous_inventories.
182
        candidates = {}
183
        # revision:ie mapping with one revision for each head.
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
184
        heads = {}
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
185
        # revision: ancestor list for each head
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
186
        head_ancestors = {}
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
187
        # identify candidate head revision ids.
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
188
        for inv in previous_inventories:
189
            if self.file_id in inv:
190
                ie = inv[self.file_id]
191
                assert ie.file_id == self.file_id
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
192
                if ie.revision in candidates:
193
                    # same revision value in two different inventories:
194
                    # correct possible inconsistencies:
195
                    #     * there was a bug in revision updates with 'x' bit 
196
                    #       support.
1185.1.51 by Robert Collins
merge in reweave support
197
                    try:
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
198
                        if candidates[ie.revision].executable != ie.executable:
199
                            candidates[ie.revision].executable = False
1185.1.51 by Robert Collins
merge in reweave support
200
                            ie.executable = False
201
                    except AttributeError:
202
                        pass
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
203
                    # must now be the same.
204
                    assert candidates[ie.revision] == ie
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
205
                else:
1596.2.20 by Robert Collins
optimise commit to only access weaves for merged, or altered files during commit.
206
                    # add this revision as a candidate.
207
                    candidates[ie.revision] = ie
208
209
        # common case optimisation
210
        if len(candidates) == 1:
211
            # if there is only one candidate revision found
212
            # then we can opening the versioned file to access ancestry:
213
            # there cannot be any ancestors to eliminate when there is 
214
            # only one revision available.
215
            heads[ie.revision] = ie
216
            return heads
217
218
        # eliminate ancestors amongst the available candidates:
219
        # heads are those that are not an ancestor of any other candidate
220
        # - this provides convergence at a per-file level.
221
        for ie in candidates.values():
222
            # may be an ancestor of a known head:
223
            already_present = 0 != len(
224
                [head for head in heads 
225
                 if ie.revision in head_ancestors[head]])
226
            if already_present:
227
                # an ancestor of an analyzed candidate.
228
                continue
229
            # not an ancestor of a known head:
230
            # load the versioned file for this file id if needed
231
            if entry_vf is None:
232
                entry_vf = versioned_file_store.get_weave_or_empty(
233
                    self.file_id, transaction)
234
            ancestors = get_ancestors(entry_vf, ie)
235
            # may knock something else out:
236
            check_heads = list(heads.keys())
237
            for head in check_heads:
238
                if head in ancestors:
239
                    # this previously discovered 'head' is not
240
                    # really a head - its an ancestor of the newly 
241
                    # found head,
242
                    heads.pop(head)
243
            head_ancestors[ie.revision] = ancestors
244
            heads[ie.revision] = ie
1409 by Robert Collins
unify previous inventory entry parent logic in preparation for fixing the revision-thrashing bug
245
        return heads
246
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
247
    def get_tar_item(self, root, dp, now, tree):
1399.1.7 by Robert Collins
implement symlink exporting to tarballs
248
        """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 \
249
        item = tarfile.TarInfo(pathjoin(root, dp))
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
250
        # TODO: would be cool to actually set it to the timestamp of the
251
        # revision it was last changed
252
        item.mtime = now
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
253
        fileobj = self._put_in_tar(item, tree)
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
254
        return item, fileobj
255
1399.1.5 by Robert Collins
move checking whether an entry stores text into inventory.py from fetch,py
256
    def has_text(self):
257
        """Return true if the object this entry represents has textual data.
258
259
        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
260
261
        Also note that all entries get weave files created for them.
262
        This attribute is primarily used when upgrading from old trees that
263
        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
264
        """
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
265
        return False
1399.1.5 by Robert Collins
move checking whether an entry stores text into inventory.py from fetch,py
266
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
267
    def __init__(self, file_id, name, parent_id, text_id=None):
1 by mbp at sourcefrog
import from baz patch-364
268
        """Create an InventoryEntry
269
        
270
        The filename must be a single component, relative to the
271
        parent directory; it cannot be a whole path or relative name.
272
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
273
        >>> e = InventoryFile('123', 'hello.c', ROOT_ID)
1 by mbp at sourcefrog
import from baz patch-364
274
        >>> e.name
275
        'hello.c'
276
        >>> e.file_id
277
        '123'
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
278
        >>> e = InventoryFile('123', 'src/hello.c', ROOT_ID)
1 by mbp at sourcefrog
import from baz patch-364
279
        Traceback (most recent call last):
1185.16.63 by Martin Pool
- more error conversion
280
        InvalidEntryName: Invalid entry name: src/hello.c
1 by mbp at sourcefrog
import from baz patch-364
281
        """
1183 by Martin Pool
- implement version 5 xml storage, and tests
282
        assert isinstance(name, basestring), name
376 by Martin Pool
- fix slow invariant check when reading in InventoryEntry objects
283
        if '/' in name or '\\' in name:
1185.16.63 by Martin Pool
- more error conversion
284
            raise InvalidEntryName(name=name)
1398 by Robert Collins
integrate in Gustavos x-bit patch
285
        self.executable = False
1092.2.21 by Robert Collins
convert name_version to revision in inventory entries
286
        self.revision = None
955 by Martin Pool
- use __slots__ on InventoryEntry; rather faster
287
        self.text_sha1 = None
288
        self.text_size = None
1 by mbp at sourcefrog
import from baz patch-364
289
        self.file_id = file_id
290
        self.name = name
291
        self.text_id = text_id
292
        self.parent_id = parent_id
1092.2.6 by Robert Collins
symlink support updated to work
293
        self.symlink_target = None
237 by mbp at sourcefrog
- Better assertions in InventoryEntry constructor
294
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
295
    def kind_character(self):
296
        """Return a short kind indicator useful for appending to names."""
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
297
        raise BzrError('unknown kind %r' % self.kind)
1399.1.2 by Robert Collins
push kind character creation into InventoryEntry and TreeEntry
298
1731.1.2 by Aaron Bentley
Removed all remaining uses of root_directory
299
    known_kinds = ('file', 'directory', 'symlink')
1 by mbp at sourcefrog
import from baz patch-364
300
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
301
    def _put_in_tar(self, item, tree):
302
        """populate item for stashing in a tar, and return the content stream.
303
304
        If no content is available, return None.
305
        """
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
306
        raise BzrError("don't know how to export {%s} of kind %r" %
307
                       (self.file_id, self.kind))
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
308
1399.1.6 by Robert Collins
move exporting functionality into inventory.py - uncovers bug in symlink support
309
    def put_on_disk(self, dest, dp, tree):
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
310
        """Create a representation of self on disk in the prefix dest.
311
        
312
        This is a template method - implement _put_on_disk in subclasses.
313
        """
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 \
314
        fullpath = pathjoin(dest, dp)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
315
        self._put_on_disk(fullpath, tree)
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
316
        # mutter("  export {%s} kind %s to %s", self.file_id,
317
        #         self.kind, fullpath)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
318
319
    def _put_on_disk(self, fullpath, tree):
320
        """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
321
        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
322
156 by mbp at sourcefrog
new "directories" command
323
    def sorted_children(self):
1757.2.13 by Robert Collins
Tweak InventoryEntry.sorted_children to be simpler.
324
        return sorted(self.children.items())
156 by mbp at sourcefrog
new "directories" command
325
1399.1.1 by Robert Collins
move checks for versionability of file kinds into InventoryEntry
326
    @staticmethod
327
    def versionable_kind(kind):
328
        return kind in ('file', 'directory', 'symlink')
329
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
330
    def check(self, checker, rev_id, inv, tree):
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
331
        """Check this inventory entry is intact.
332
333
        This is a template method, override _check for kind specific
334
        tests.
1616.1.5 by Martin Pool
Cleanup and document some check code
335
336
        :param checker: Check object providing context for the checks; 
337
             can be used to find out what parts of the repository have already
338
             been checked.
339
        :param rev_id: Revision id from which this InventoryEntry was loaded.
340
             Not necessarily the last-changed revision for this file.
341
        :param inv: Inventory from which the entry was loaded.
342
        :param tree: RevisionTree for this entry.
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
343
        """
1757.2.11 by Robert Collins
Correct bzr diff | less= None clauses in inventory.py to be is not None.
344
        if self.parent_id is not None:
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
345
            if not inv.has_id(self.parent_id):
346
                raise BzrCheckError('missing parent {%s} in inventory for revision {%s}'
347
                        % (self.parent_id, rev_id))
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
348
        self._check(checker, rev_id, tree)
349
350
    def _check(self, checker, rev_id, tree):
351
        """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
352
        raise BzrCheckError('unknown entry kind %r in revision {%s}' % 
353
                            (self.kind, rev_id))
1092.2.20 by Robert Collins
symlink and weaves, whaddya know
354
1 by mbp at sourcefrog
import from baz patch-364
355
    def copy(self):
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
356
        """Clone this inventory entry."""
357
        raise NotImplementedError
1 by mbp at sourcefrog
import from baz patch-364
358
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
359
    @staticmethod
360
    def describe_change(old_entry, new_entry):
361
        """Describe the change between old_entry and this.
362
        
363
        This smells of being an InterInventoryEntry situation, but as its
364
        the first one, we're making it a static method for now.
365
366
        An entry with a different parent, or different name is considered 
367
        to be renamed. Reparenting is an internal detail.
368
        Note that renaming the parent does not trigger a rename for the
369
        child entry itself.
1669.2.1 by Martin Pool
verbose commit now specifically identifies modified/renamed/reparented files
370
        """
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
371
        # TODO: Perhaps return an object rather than just a string
372
        if old_entry is new_entry:
373
            # also the case of both being None
374
            return 'unchanged'
375
        elif old_entry is None:
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
376
            return 'added'
1668.1.5 by Martin Pool
[broken] fix up display of files changed by a commit
377
        elif new_entry is None:
378
            return 'removed'
379
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
380
        if text_modified or meta_modified:
381
            modified = True
382
        else:
383
            modified = False
384
        # TODO 20060511 (mbp, rbc) factor out 'detect_rename' here.
385
        if old_entry.parent_id != new_entry.parent_id:
386
            renamed = True
387
        elif old_entry.name != new_entry.name:
388
            renamed = True
389
        else:
390
            renamed = False
391
        if renamed and not modified:
392
            return InventoryEntry.RENAMED
393
        if modified and not renamed:
394
            return 'modified'
395
        if modified and renamed:
396
            return InventoryEntry.MODIFIED_AND_RENAMED
397
        return 'unchanged'
1 by mbp at sourcefrog
import from baz patch-364
398
399
    def __repr__(self):
1733.1.4 by Robert Collins
Cosmetic niceties for debugging, extra comments etc.
400
        return ("%s(%r, %r, parent_id=%r, revision=%r)"
1 by mbp at sourcefrog
import from baz patch-364
401
                % (self.__class__.__name__,
402
                   self.file_id,
403
                   self.name,
1733.1.4 by Robert Collins
Cosmetic niceties for debugging, extra comments etc.
404
                   self.parent_id,
405
                   self.revision))
1 by mbp at sourcefrog
import from baz patch-364
406
1411 by Robert Collins
use weave ancestry to determine inventory entry previous heads, prevent propogating 'I did a merge' merges.
407
    def snapshot(self, revision, path, previous_entries,
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
408
                 work_tree, commit_builder):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
409
        """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
410
        
411
        This means that all its fields are populated, that it has its
412
        text stored in the text store or weave.
413
        """
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
414
        # mutter('new parents of %s are %r', path, previous_entries)
1185.12.33 by Aaron Bentley
Fixed symlink reverting
415
        self._read_tree_state(path, work_tree)
1740.3.2 by Jelmer Vernooij
Move storing file texts to commit builder.
416
        # TODO: Where should we determine whether to reuse a
417
        # previous revision id or create a new revision? 20060606
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
418
        if len(previous_entries) == 1:
419
            # cannot be unchanged unless there is only one parent file rev.
420
            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
421
            if self._unchanged(parent_ie):
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
422
                # mutter("found unchanged entry")
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
423
                self.revision = parent_ie.revision
424
                return "unchanged"
1669.2.1 by Martin Pool
verbose commit now specifically identifies modified/renamed/reparented files
425
        return self._snapshot_into_revision(revision, previous_entries, 
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
426
                                            work_tree, commit_builder)
1669.2.1 by Martin Pool
verbose commit now specifically identifies modified/renamed/reparented files
427
428
    def _snapshot_into_revision(self, revision, previous_entries, work_tree,
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
429
                                commit_builder):
1669.2.1 by Martin Pool
verbose commit now specifically identifies modified/renamed/reparented files
430
        """Record this revision unconditionally into a store.
431
432
        The entry's last-changed revision property (`revision`) is updated to 
433
        that of the new revision.
434
        
435
        :param revision: id of the new revision that is being recorded.
436
437
        :returns: String description of the commit (e.g. "merged", "modified"), etc.
438
        """
1711.2.101 by John Arbash Meinel
Clean up some unnecessary mutter() calls
439
        # mutter('new revision {%s} for {%s}', revision, self.file_id)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
440
        self.revision = revision
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
441
        self._snapshot_text(previous_entries, work_tree, commit_builder)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
442
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
443
    def _snapshot_text(self, file_parents, work_tree, commit_builder): 
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
444
        """Record the 'text' of this entry, whatever form that takes.
445
        
446
        This default implementation simply adds an empty text.
447
        """
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
448
        raise NotImplementedError(self._snapshot_text)
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
449
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
450
    def __eq__(self, other):
1 by mbp at sourcefrog
import from baz patch-364
451
        if not isinstance(other, InventoryEntry):
452
            return NotImplemented
453
1398 by Robert Collins
integrate in Gustavos x-bit patch
454
        return ((self.file_id == other.file_id)
455
                and (self.name == other.name)
456
                and (other.symlink_target == self.symlink_target)
457
                and (self.text_sha1 == other.text_sha1)
458
                and (self.text_size == other.text_size)
459
                and (self.text_id == other.text_id)
460
                and (self.parent_id == other.parent_id)
461
                and (self.kind == other.kind)
462
                and (self.revision == other.revision)
463
                and (self.executable == other.executable)
464
                )
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
465
466
    def __ne__(self, other):
467
        return not (self == other)
468
469
    def __hash__(self):
470
        raise ValueError('not hashable')
1 by mbp at sourcefrog
import from baz patch-364
471
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
472
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
473
        """Has this entry changed relative to previous_ie.
474
1759.2.1 by Jelmer Vernooij
Fix some types (found using aspell).
475
        This method should be overridden in child classes.
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
476
        """
1092.2.22 by Robert Collins
text_version and name_version unification looking reasonable
477
        compatible = True
478
        # different inv parent
479
        if previous_ie.parent_id != self.parent_id:
480
            compatible = False
481
        # renamed
482
        elif previous_ie.name != self.name:
483
            compatible = False
484
        return compatible
485
1185.12.33 by Aaron Bentley
Fixed symlink reverting
486
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
487
        """Populate fields in the inventory entry from the given tree.
488
        
489
        Note that this should be modified to be a noop on virtual trees
490
        as all entries created there are prepopulated.
491
        """
1185.16.5 by Martin Pool
doc
492
        # TODO: Rather than running this manually, we should check the 
493
        # working sha1 and other expensive properties when they're
494
        # first requested, or preload them if they're already known
495
        pass            # nothing to do by default
1092.2.23 by Robert Collins
move inventory entry centric snapshot taking logic to inventory.py
496
1534.7.175 by Aaron Bentley
Ensured revert writes a normal inventory
497
    def _forget_tree_state(self):
498
        pass
499
1 by mbp at sourcefrog
import from baz patch-364
500
1907.1.4 by Aaron Bentley
Restore RootEntry, but mark it deprecated, restore EmptyTree.kind
501
class RootEntry(InventoryEntry):
502
503
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
504
                 'text_id', 'parent_id', 'children', 'executable', 
505
                 'revision', 'symlink_target']
506
507
    def _check(self, checker, rev_id, tree):
508
        """See InventoryEntry._check"""
509
510
    def __init__(self, file_id):
511
        self.file_id = file_id
512
        self.children = {}
513
        self.kind = 'directory'
514
        self.parent_id = None
515
        self.name = u''
516
        self.revision = None
1907.1.6 by Aaron Bentley
Fix RootEntry deprecation warning
517
        warn('RootEntry is deprecated as of bzr 0.10.  Please use '
518
             'InventoryDirectory instead.',
1907.1.4 by Aaron Bentley
Restore RootEntry, but mark it deprecated, restore EmptyTree.kind
519
            DeprecationWarning, stacklevel=2)
520
521
    def __eq__(self, other):
522
        if not isinstance(other, RootEntry):
523
            return NotImplemented
524
        
525
        return (self.file_id == other.file_id) \
526
               and (self.children == other.children)
527
528
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
529
class InventoryDirectory(InventoryEntry):
530
    """A directory in an inventory."""
531
1757.2.10 by Robert Collins
Give all inventory entries __slots__ that are useful with the current codebase.
532
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
533
                 'text_id', 'parent_id', 'children', 'executable', 
534
                 'revision', 'symlink_target']
535
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
536
    def _check(self, checker, rev_id, tree):
537
        """See InventoryEntry._check"""
1757.2.11 by Robert Collins
Correct bzr diff | less= None clauses in inventory.py to be is not None.
538
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
539
            raise BzrCheckError('directory {%s} has text in revision {%s}'
540
                                % (self.file_id, rev_id))
541
542
    def copy(self):
543
        other = InventoryDirectory(self.file_id, self.name, self.parent_id)
544
        other.revision = self.revision
545
        # note that children are *not* copied; they're pulled across when
546
        # others are added
547
        return other
548
549
    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
550
        super(InventoryDirectory, self).__init__(file_id, name, parent_id)
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
551
        self.children = {}
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
552
        self.kind = 'directory'
1399.1.8 by Robert Collins
factor out inventory directory logic into 'InventoryDirectory' class
553
554
    def kind_character(self):
555
        """See InventoryEntry.kind_character."""
556
        return '/'
557
558
    def _put_in_tar(self, item, tree):
559
        """See InventoryEntry._put_in_tar."""
560
        item.type = tarfile.DIRTYPE
561
        fileobj = None
562
        item.name += '/'
563
        item.size = 0
564
        item.mode = 0755
565
        return fileobj
566
567
    def _put_on_disk(self, fullpath, tree):
568
        """See InventoryEntry._put_on_disk."""
569
        os.mkdir(fullpath)
570
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
571
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
572
        """See InventoryEntry._snapshot_text."""
573
        commit_builder.modified_directory(self.file_id, file_parents)
574
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
575
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
576
class InventoryFile(InventoryEntry):
577
    """A file in an inventory."""
578
1757.2.10 by Robert Collins
Give all inventory entries __slots__ that are useful with the current codebase.
579
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
580
                 'text_id', 'parent_id', 'children', 'executable', 
581
                 'revision', 'symlink_target']
582
1616.1.5 by Martin Pool
Cleanup and document some check code
583
    def _check(self, checker, tree_revision_id, tree):
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
584
        """See InventoryEntry._check"""
1616.1.5 by Martin Pool
Cleanup and document some check code
585
        t = (self.file_id, self.revision)
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
586
        if t in checker.checked_texts:
1616.1.5 by Martin Pool
Cleanup and document some check code
587
            prev_sha = checker.checked_texts[t]
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
588
            if prev_sha != self.text_sha1:
589
                raise BzrCheckError('mismatched sha1 on {%s} in {%s}' %
1616.1.5 by Martin Pool
Cleanup and document some check code
590
                                    (self.file_id, tree_revision_id))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
591
            else:
592
                checker.repeated_text_cnt += 1
593
                return
1185.50.28 by John Arbash Meinel
Lots of updates for 'bzr check'
594
595
        if self.file_id not in checker.checked_weaves:
596
            mutter('check weave {%s}', self.file_id)
597
            w = tree.get_weave(self.file_id)
598
            # Not passing a progress bar, because it creates a new
599
            # progress, which overwrites the current progress,
600
            # and doesn't look nice
601
            w.check()
602
            checker.checked_weaves[self.file_id] = True
603
        else:
1563.2.14 by Robert Collins
Prepare weave store to delegate copy details to the versioned file.
604
            w = tree.get_weave(self.file_id)
1185.50.28 by John Arbash Meinel
Lots of updates for 'bzr check'
605
1616.1.5 by Martin Pool
Cleanup and document some check code
606
        mutter('check version {%s} of {%s}', tree_revision_id, self.file_id)
1616.1.7 by Martin Pool
New developer commands 'weave-list' and 'weave-join'.
607
        checker.checked_text_cnt += 1
1185.50.28 by John Arbash Meinel
Lots of updates for 'bzr check'
608
        # We can't check the length, because Weave doesn't store that
609
        # information, and the whole point of looking at the weave's
610
        # sha1sum is that we don't have to extract the text.
611
        if self.text_sha1 != w.get_sha1(self.revision):
612
            raise BzrCheckError('text {%s} version {%s} wrong sha1' 
613
                                % (self.file_id, self.revision))
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
614
        checker.checked_texts[t] = self.text_sha1
615
616
    def copy(self):
617
        other = InventoryFile(self.file_id, self.name, self.parent_id)
618
        other.executable = self.executable
619
        other.text_id = self.text_id
620
        other.text_sha1 = self.text_sha1
621
        other.text_size = self.text_size
622
        other.revision = self.revision
623
        return other
624
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
625
    def detect_changes(self, old_entry):
626
        """See InventoryEntry.detect_changes."""
1757.2.11 by Robert Collins
Correct bzr diff | less= None clauses in inventory.py to be is not None.
627
        assert self.text_sha1 is not None
628
        assert old_entry.text_sha1 is not None
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
629
        text_modified = (self.text_sha1 != old_entry.text_sha1)
630
        meta_modified = (self.executable != old_entry.executable)
631
        return text_modified, meta_modified
632
633
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
634
             output_to, reverse=False):
635
        """See InventoryEntry._diff."""
1558.15.2 by Aaron Bentley
Implemented binary file handling for diff
636
        try:
637
            from_text = tree.get_file(self.file_id).readlines()
638
            if to_entry:
639
                to_text = to_tree.get_file(to_entry.file_id).readlines()
640
            else:
641
                to_text = []
642
            if not reverse:
643
                text_diff(from_label, from_text,
644
                          to_label, to_text, output_to)
645
            else:
646
                text_diff(to_label, to_text,
647
                          from_label, from_text, output_to)
648
        except BinaryFile:
1558.15.11 by Aaron Bentley
Apply merge review suggestions
649
            if reverse:
650
                label_pair = (to_label, from_label)
651
            else:
652
                label_pair = (from_label, to_label)
653
            print >> output_to, "Binary files %s and %s differ" % label_pair
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
654
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
655
    def has_text(self):
656
        """See InventoryEntry.has_text."""
657
        return True
658
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
659
    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
660
        super(InventoryFile, self).__init__(file_id, name, parent_id)
661
        self.kind = 'file'
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
662
663
    def kind_character(self):
664
        """See InventoryEntry.kind_character."""
665
        return ''
666
667
    def _put_in_tar(self, item, tree):
668
        """See InventoryEntry._put_in_tar."""
669
        item.type = tarfile.REGTYPE
670
        fileobj = tree.get_file(self.file_id)
671
        item.size = self.text_size
672
        if tree.is_executable(self.file_id):
673
            item.mode = 0755
674
        else:
675
            item.mode = 0644
676
        return fileobj
677
678
    def _put_on_disk(self, fullpath, tree):
679
        """See InventoryEntry._put_on_disk."""
680
        pumpfile(tree.get_file(self.file_id), file(fullpath, 'wb'))
681
        if tree.is_executable(self.file_id):
682
            os.chmod(fullpath, 0755)
683
1185.12.33 by Aaron Bentley
Fixed symlink reverting
684
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
685
        """See InventoryEntry._read_tree_state."""
1732.1.19 by John Arbash Meinel
If you have the path, use it rather than looking it up again
686
        self.text_sha1 = work_tree.get_file_sha1(self.file_id, path=path)
1740.3.2 by Jelmer Vernooij
Move storing file texts to commit builder.
687
        # FIXME: 20050930 probe for the text size when getting sha1
688
        # in _read_tree_state
1732.1.19 by John Arbash Meinel
If you have the path, use it rather than looking it up again
689
        self.executable = work_tree.is_executable(self.file_id, path=path)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
690
1733.1.4 by Robert Collins
Cosmetic niceties for debugging, extra comments etc.
691
    def __repr__(self):
692
        return ("%s(%r, %r, parent_id=%r, sha1=%r, len=%s)"
693
                % (self.__class__.__name__,
694
                   self.file_id,
695
                   self.name,
696
                   self.parent_id,
697
                   self.text_sha1,
698
                   self.text_size))
699
1534.7.175 by Aaron Bentley
Ensured revert writes a normal inventory
700
    def _forget_tree_state(self):
701
        self.text_sha1 = None
702
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
703
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
704
        """See InventoryEntry._snapshot_text."""
1740.3.2 by Jelmer Vernooij
Move storing file texts to commit builder.
705
        def get_content_byte_lines():
706
            return work_tree.get_file(self.file_id).readlines()
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
707
        self.text_sha1, self.text_size = commit_builder.modified_file_text(
1740.3.2 by Jelmer Vernooij
Move storing file texts to commit builder.
708
            self.file_id, file_parents, get_content_byte_lines, self.text_sha1, self.text_size)
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
709
710
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
711
        """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
712
        compatible = super(InventoryFile, self)._unchanged(previous_ie)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
713
        if self.text_sha1 != previous_ie.text_sha1:
714
            compatible = False
715
        else:
716
            # FIXME: 20050930 probe for the text size when getting sha1
717
            # in _read_tree_state
718
            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
719
        if self.executable != previous_ie.executable:
720
            compatible = False
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
721
        return compatible
722
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
723
724
class InventoryLink(InventoryEntry):
725
    """A file in an inventory."""
726
1757.2.10 by Robert Collins
Give all inventory entries __slots__ that are useful with the current codebase.
727
    __slots__ = ['text_sha1', 'text_size', 'file_id', 'name', 'kind',
728
                 'text_id', 'parent_id', 'children', 'executable', 
729
                 'revision', 'symlink_target']
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
730
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
731
    def _check(self, checker, rev_id, tree):
732
        """See InventoryEntry._check"""
1757.2.11 by Robert Collins
Correct bzr diff | less= None clauses in inventory.py to be is not None.
733
        if self.text_sha1 is not None or self.text_size is not None or self.text_id is not None:
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
734
            raise BzrCheckError('symlink {%s} has text in revision {%s}'
735
                    % (self.file_id, rev_id))
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
736
        if self.symlink_target is None:
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
737
            raise BzrCheckError('symlink {%s} has no target in revision {%s}'
738
                    % (self.file_id, rev_id))
739
740
    def copy(self):
741
        other = InventoryLink(self.file_id, self.name, self.parent_id)
742
        other.symlink_target = self.symlink_target
743
        other.revision = self.revision
744
        return other
745
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
746
    def detect_changes(self, old_entry):
747
        """See InventoryEntry.detect_changes."""
748
        # FIXME: which _modified field should we use ? RBC 20051003
749
        text_modified = (self.symlink_target != old_entry.symlink_target)
750
        if text_modified:
751
            mutter("    symlink target changed")
752
        meta_modified = False
753
        return text_modified, meta_modified
754
755
    def _diff(self, text_diff, from_label, tree, to_label, to_entry, to_tree,
756
             output_to, reverse=False):
757
        """See InventoryEntry._diff."""
758
        from_text = self.symlink_target
759
        if to_entry is not None:
760
            to_text = to_entry.symlink_target
761
            if reverse:
762
                temp = from_text
763
                from_text = to_text
764
                to_text = temp
765
            print >>output_to, '=== target changed %r => %r' % (from_text, to_text)
766
        else:
767
            if not reverse:
768
                print >>output_to, '=== target was %r' % self.symlink_target
769
            else:
770
                print >>output_to, '=== target is %r' % self.symlink_target
771
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
772
    def __init__(self, file_id, name, parent_id):
773
        super(InventoryLink, self).__init__(file_id, name, parent_id)
774
        self.kind = 'symlink'
775
776
    def kind_character(self):
777
        """See InventoryEntry.kind_character."""
778
        return ''
779
780
    def _put_in_tar(self, item, tree):
781
        """See InventoryEntry._put_in_tar."""
1185.33.3 by Martin Pool
[merge] jelmer
782
        item.type = tarfile.SYMTYPE
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
783
        fileobj = None
784
        item.size = 0
785
        item.mode = 0755
786
        item.linkname = self.symlink_target
787
        return fileobj
788
789
    def _put_on_disk(self, fullpath, tree):
790
        """See InventoryEntry._put_on_disk."""
791
        try:
792
            os.symlink(self.symlink_target, fullpath)
793
        except OSError,e:
794
            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
795
1185.12.33 by Aaron Bentley
Fixed symlink reverting
796
    def _read_tree_state(self, path, work_tree):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
797
        """See InventoryEntry._read_tree_state."""
798
        self.symlink_target = work_tree.get_symlink_target(self.file_id)
799
1534.7.175 by Aaron Bentley
Ensured revert writes a normal inventory
800
    def _forget_tree_state(self):
801
        self.symlink_target = None
802
1405 by Robert Collins
remove some of the upgrade code that was duplicated with inventory_entry, and give all inventory entries a weave
803
    def _unchanged(self, previous_ie):
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
804
        """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
805
        compatible = super(InventoryLink, self)._unchanged(previous_ie)
1399.1.11 by Robert Collins
finish off nearly all of the kind separations
806
        if self.symlink_target != previous_ie.symlink_target:
807
            compatible = False
808
        return compatible
809
1740.3.3 by Jelmer Vernooij
Move storing directories and links to commit builder.
810
    def _snapshot_text(self, file_parents, work_tree, commit_builder):
811
        """See InventoryEntry._snapshot_text."""
812
        commit_builder.modified_link(
813
            self.file_id, file_parents, self.symlink_target)
814
1399.1.9 by Robert Collins
factor out file related logic from InventoryEntry to InventoryFile
815
802 by Martin Pool
- Remove XMLMixin class in favour of simple pack_xml, unpack_xml functions
816
class Inventory(object):
1 by mbp at sourcefrog
import from baz patch-364
817
    """Inventory of versioned files in a tree.
818
240 by mbp at sourcefrog
doc
819
    This describes which file_id is present at each point in the tree,
820
    and possibly the SHA-1 or other information about the file.
821
    Entries can be looked up either by path or by file_id.
1 by mbp at sourcefrog
import from baz patch-364
822
823
    The inventory represents a typical unix file tree, with
824
    directories containing files and subdirectories.  We never store
825
    the full path to a file, because renaming a directory implicitly
826
    moves all of its contents.  This class internally maintains a
827
    lookup tree that allows the children under a directory to be
828
    returned quickly.
829
830
    InventoryEntry objects must not be modified after they are
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
831
    inserted, other than through the Inventory API.
1 by mbp at sourcefrog
import from baz patch-364
832
833
    >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
834
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
835
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
836
    >>> inv['123-123'].name
837
    'hello.c'
838
839
    May be treated as an iterator or set to look up file ids:
840
    
841
    >>> bool(inv.path2id('hello.c'))
842
    True
843
    >>> '123-123' in inv
844
    True
845
846
    May also look up by name:
847
848
    >>> [x[0] for x in inv.iter_entries()]
1852.6.6 by Robert Collins
Finish updating iter_entries change to make all tests pass.
849
    ['', u'hello.c']
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
850
    >>> 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
851
    >>> inv.add(InventoryFile('123-123', 'hello.c', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
852
    InventoryFile('123-123', 'hello.c', parent_id='TREE_ROOT-12345678-12345678', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
853
    """
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
854
    def __init__(self, root_id=ROOT_ID, revision_id=None):
1 by mbp at sourcefrog
import from baz patch-364
855
        """Create or read an inventory.
856
857
        If a working directory is specified, the inventory is read
858
        from there.  If the file is specified, read from that. If not,
859
        the inventory is created empty.
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
860
861
        The inventory is created with a default root directory, with
862
        an id of None.
1 by mbp at sourcefrog
import from baz patch-364
863
        """
1907.1.2 by Aaron Bentley
More removal of unique-root stuff
864
        # We are letting Branch.create() create a unique inventory
865
        # root id. Rather than generating a random one here.
866
        #if root_id is None:
867
        #    root_id = bzrlib.branch.gen_file_id('TREE_ROOT')
868
        self.root = InventoryDirectory(root_id, '', None)
869
        # FIXME: this isn't ever used, changing it to self.revision may break
870
        # things. TODO make everything use self.revision_id
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
871
        self.revision_id = revision_id
1907.1.2 by Aaron Bentley
More removal of unique-root stuff
872
        self._byid = {self.root.file_id: self.root}
1 by mbp at sourcefrog
import from baz patch-364
873
1189 by Martin Pool
- BROKEN: partial support for commit into weave
874
    def copy(self):
1638.1.2 by Robert Collins
Change the basis-inventory file to not have the revision-id in the file name.
875
        # TODO: jam 20051218 Should copy also copy the revision_id?
1852.6.3 by Robert Collins
Make iter(Tree) consistent for all tree types.
876
        entries = self.iter_entries()
877
        other = Inventory(entries.next()[1].file_id)
1206 by Martin Pool
- fix bug in Inventory.copy()
878
        # copy recursively so we know directories will be added before
879
        # their children.  There are more efficient ways than this...
1852.6.3 by Robert Collins
Make iter(Tree) consistent for all tree types.
880
        for path, entry in entries():
1189 by Martin Pool
- BROKEN: partial support for commit into weave
881
            other.add(entry.copy())
882
        return other
883
1 by mbp at sourcefrog
import from baz patch-364
884
    def __iter__(self):
885
        return iter(self._byid)
886
887
    def __len__(self):
888
        """Returns number of entries."""
889
        return len(self._byid)
890
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
891
    def iter_entries(self, from_dir=None):
1 by mbp at sourcefrog
import from baz patch-364
892
        """Return (path, entry) pairs, in order by name."""
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
893
        if from_dir is None:
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
894
            assert self.root
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
895
            from_dir = self.root
1852.6.3 by Robert Collins
Make iter(Tree) consistent for all tree types.
896
            yield '', self.root
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
897
        elif isinstance(from_dir, basestring):
898
            from_dir = self._byid[from_dir]
899
            
1732.1.24 by John Arbash Meinel
iter_entries time drops to 1/6th time
900
        # unrolling the recursive called changed the time from
901
        # 440ms/663ms (inline/total) to 116ms/116ms
1732.1.23 by John Arbash Meinel
Switch iter_entries from being a recursive function and using pathjoin
902
        children = from_dir.children.items()
903
        children.sort()
904
        children = collections.deque(children)
905
        stack = [(u'', children)]
906
        while stack:
907
            from_dir_relpath, children = stack[-1]
908
909
            while children:
910
                name, ie = children.popleft()
911
912
                # we know that from_dir_relpath never ends in a slash
913
                # and 'f' doesn't begin with one, we can do a string op, rather
914
                # than the checks of pathjoin(), though this means that all paths
915
                # start with a slash
916
                path = from_dir_relpath + '/' + name
917
918
                yield path[1:], ie
919
920
                if ie.kind != 'directory':
921
                    continue
922
923
                # But do this child first
924
                new_children = ie.children.items()
925
                new_children.sort()
926
                new_children = collections.deque(new_children)
927
                stack.append((path, new_children))
928
                # Break out of inner loop, so that we start outer loop with child
929
                break
930
            else:
931
                # if we finished all children, pop it off the stack
1732.1.25 by John Arbash Meinel
Fix list_files test, we don't need to check if children are empty if we fall off the loop.
932
                stack.pop()
555 by Martin Pool
- New Inventory.entries() method
933
1711.2.36 by John Arbash Meinel
Add an iter_entries_by_dir which returns directory children before their children.
934
    def iter_entries_by_dir(self, from_dir=None):
935
        """Iterate over the entries in a directory first order.
936
937
        This returns all entries for a directory before returning
938
        the entries for children of a directory. This is not
939
        lexicographically sorted order, and is a hybrid between
940
        depth-first and breadth-first.
941
942
        :return: This yields (path, entry) pairs
943
        """
1755.1.1 by Robert Collins
(jam, robertc, ab)Merge new iter_entries_by_dirs routine which matches the order walkdirs provides.
944
        # TODO? Perhaps this should return the from_dir so that the root is
945
        # yielded? or maybe an option?
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
946
        if from_dir is None:
1711.2.36 by John Arbash Meinel
Add an iter_entries_by_dir which returns directory children before their children.
947
            assert self.root
948
            from_dir = self.root
1852.6.6 by Robert Collins
Finish updating iter_entries change to make all tests pass.
949
            yield '', self.root
1711.2.36 by John Arbash Meinel
Add an iter_entries_by_dir which returns directory children before their children.
950
        elif isinstance(from_dir, basestring):
951
            from_dir = self._byid[from_dir]
952
            
953
        stack = [(u'', from_dir)]
954
        while stack:
955
            cur_relpath, cur_dir = stack.pop()
956
957
            child_dirs = []
958
            for child_name, child_ie in sorted(cur_dir.children.iteritems()):
959
960
                child_relpath = cur_relpath + child_name
961
962
                yield child_relpath, child_ie
963
964
                if child_ie.kind == 'directory':
965
                    child_dirs.append((child_relpath+'/', child_ie))
966
            stack.extend(reversed(child_dirs))
967
555 by Martin Pool
- New Inventory.entries() method
968
    def entries(self):
969
        """Return list of (path, ie) for all entries except the root.
970
971
        This may be faster than iter_entries.
972
        """
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
973
        accum = []
974
        def descend(dir_ie, dir_path):
556 by Martin Pool
- fix up Inventory.entries()
975
            kids = dir_ie.children.items()
555 by Martin Pool
- New Inventory.entries() method
976
            kids.sort()
977
            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 \
978
                child_path = pathjoin(dir_path, name)
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
979
                accum.append((child_path, ie))
555 by Martin Pool
- New Inventory.entries() method
980
                if ie.kind == 'directory':
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
981
                    descend(ie, child_path)
555 by Martin Pool
- New Inventory.entries() method
982
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
983
        descend(self.root, u'')
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
984
        return accum
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
985
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
986
    def directories(self):
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
987
        """Return (path, entry) pairs for all directories, including the root.
1 by mbp at sourcefrog
import from baz patch-364
988
        """
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
989
        accum = []
990
        def descend(parent_ie, parent_path):
991
            accum.append((parent_path, parent_ie))
156 by mbp at sourcefrog
new "directories" command
992
            
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
993
            kids = [(ie.name, ie) for ie in parent_ie.children.itervalues() if ie.kind == 'directory']
994
            kids.sort()
156 by mbp at sourcefrog
new "directories" command
995
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
996
            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 \
997
                child_path = pathjoin(parent_path, name)
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
998
                descend(child_ie, child_path)
1185.33.66 by Martin Pool
[patch] use unicode literals for all hardcoded paths (Alexander Belchenko)
999
        descend(self.root, u'')
557 by Martin Pool
- Refactor/cleanup Inventory.entries()
1000
        return accum
1 by mbp at sourcefrog
import from baz patch-364
1001
        
1002
    def __contains__(self, file_id):
1003
        """True if this entry contains a file with given id.
1004
1005
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
1006
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1007
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
1008
        >>> '123' in inv
1009
        True
1010
        >>> '456' in inv
1011
        False
1012
        """
1013
        return file_id in self._byid
1014
1015
    def __getitem__(self, file_id):
1016
        """Return the entry for given file_id.
1017
1018
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
1019
        >>> inv.add(InventoryFile('123123', 'hello.c', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1020
        InventoryFile('123123', 'hello.c', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
1021
        >>> inv['123123'].name
1022
        'hello.c'
1023
        """
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1024
        try:
1025
            return self._byid[file_id]
1026
        except KeyError:
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
1027
            if file_id is None:
380 by Martin Pool
- Slight optimization for Inventory.__getitem__
1028
                raise BzrError("can't look up file_id None")
1029
            else:
1030
                raise BzrError("file_id {%s} not in inventory" % file_id)
1 by mbp at sourcefrog
import from baz patch-364
1031
460 by Martin Pool
- new testing command compare-trees
1032
    def get_file_kind(self, file_id):
1033
        return self._byid[file_id].kind
1034
138 by mbp at sourcefrog
remove parallel tree from inventory;
1035
    def get_child(self, parent_id, filename):
1732.1.18 by John Arbash Meinel
50ms is probably not worth it
1036
        return self[parent_id].children.get(filename)
138 by mbp at sourcefrog
remove parallel tree from inventory;
1037
1 by mbp at sourcefrog
import from baz patch-364
1038
    def add(self, entry):
1039
        """Add entry to inventory.
1040
1041
        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
1042
        which calls this.
1043
1044
        Returns the new entry object.
1045
        """
139 by mbp at sourcefrog
simplified/faster Inventory.add
1046
        if entry.file_id in self._byid:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1047
            raise BzrError("inventory already contains entry with id {%s}" % entry.file_id)
1 by mbp at sourcefrog
import from baz patch-364
1048
1907.1.1 by Aaron Bentley
Unshelved all changes except those related to removing RootEntry
1049
        if entry.parent_id == ROOT_ID or entry.parent_id is None:
909 by Martin Pool
- merge John's code to give the tree root an explicit file id
1050
            entry.parent_id = self.root.file_id
1051
155 by mbp at sourcefrog
add new explicit RootEntry to inventory (in-core only)
1052
        try:
1053
            parent = self._byid[entry.parent_id]
1054
        except KeyError:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1055
            raise BzrError("parent_id {%s} not in inventory" % entry.parent_id)
139 by mbp at sourcefrog
simplified/faster Inventory.add
1056
1757.2.7 by Robert Collins
Split out the recursive add and add of a single entry in add.py.
1057
        if entry.name in parent.children:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1058
            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 \
1059
                    pathjoin(self.id2path(parent.file_id), entry.name))
1 by mbp at sourcefrog
import from baz patch-364
1060
1061
        self._byid[entry.file_id] = entry
139 by mbp at sourcefrog
simplified/faster Inventory.add
1062
        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
1063
        return entry
1 by mbp at sourcefrog
import from baz patch-364
1064
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1065
    def add_path(self, relpath, kind, file_id=None, parent_id=None):
70 by mbp at sourcefrog
Prepare for smart recursive add.
1066
        """Add entry from a path.
1067
1180 by Martin Pool
- start splitting code for xml (de)serialization away from objects
1068
        The immediate parent must already be versioned.
1069
1070
        Returns the new entry object."""
1015 by Martin Pool
- fix circular imports
1071
        
1830.3.5 by John Arbash Meinel
make_entry refuses to create non-normalized entries.
1072
        parts = osutils.splitpath(relpath)
70 by mbp at sourcefrog
Prepare for smart recursive add.
1073
1534.7.69 by Aaron Bentley
Got real root moves working
1074
        if len(parts) == 0:
1713.1.6 by Robert Collins
Move file id random data selection out of the inner loop for 'bzr add'.
1075
            if file_id is None:
1076
                file_id = bzrlib.workingtree.gen_root_id()
1731.1.1 by Aaron Bentley
Make root entry an InventoryDirectory, make EmptyTree really empty
1077
            self.root = InventoryDirectory(file_id, '', None)
1534.7.69 by Aaron Bentley
Got real root moves working
1078
            self._byid = {self.root.file_id: self.root}
1079
            return
1080
        else:
1081
            parent_path = parts[:-1]
1082
            parent_id = self.path2id(parent_path)
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
1083
            if parent_id is None:
1534.7.69 by Aaron Bentley
Got real root moves working
1084
                raise NotVersionedError(path=parent_path)
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1085
        ie = make_entry(kind, parts[-1], parent_id, file_id)
70 by mbp at sourcefrog
Prepare for smart recursive add.
1086
        return self.add(ie)
1087
1 by mbp at sourcefrog
import from baz patch-364
1088
    def __delitem__(self, file_id):
1089
        """Remove entry by id.
1090
1091
        >>> inv = Inventory()
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
1092
        >>> inv.add(InventoryFile('123', 'foo.c', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1093
        InventoryFile('123', 'foo.c', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
1094
        >>> '123' in inv
1095
        True
1096
        >>> del inv['123']
1097
        >>> '123' in inv
1098
        False
1099
        """
1100
        ie = self[file_id]
1101
1534.7.69 by Aaron Bentley
Got real root moves working
1102
        assert ie.parent_id is None or \
1103
            self[ie.parent_id].children[ie.name] == ie
1 by mbp at sourcefrog
import from baz patch-364
1104
        
1105
        del self._byid[file_id]
1534.7.69 by Aaron Bentley
Got real root moves working
1106
        if ie.parent_id is not None:
1107
            del self[ie.parent_id].children[ie.name]
1 by mbp at sourcefrog
import from baz patch-364
1108
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
1109
    def __eq__(self, other):
1 by mbp at sourcefrog
import from baz patch-364
1110
        """Compare two sets by comparing their contents.
1111
1112
        >>> i1 = Inventory()
1113
        >>> i2 = Inventory()
1114
        >>> i1 == i2
1115
        True
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
1116
        >>> i1.add(InventoryFile('123', 'foo', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1117
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
1118
        >>> i1 == i2
1119
        False
1399.1.10 by Robert Collins
remove kind from the InventoryEntry constructor - only child classes should be created now
1120
        >>> i2.add(InventoryFile('123', 'foo', ROOT_ID))
1733.1.6 by Jelmer Vernooij
Fix a couple of minor issues after review by Martin.
1121
        InventoryFile('123', 'foo', parent_id='TREE_ROOT', sha1=None, len=None)
1 by mbp at sourcefrog
import from baz patch-364
1122
        >>> i1 == i2
1123
        True
1124
        """
1125
        if not isinstance(other, Inventory):
1126
            return NotImplemented
1127
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
1128
        return self._byid == other._byid
1129
1130
    def __ne__(self, other):
1249 by Martin Pool
- improvements to weave commit [broken]
1131
        return not self.__eq__(other)
544 by Martin Pool
- Define __eq__ and __ne__ for Inventory and InventoryEntry objects,
1132
1133
    def __hash__(self):
1134
        raise ValueError('not hashable')
1135
1596.2.19 by Robert Collins
Shave 20% off id2path.
1136
    def _iter_file_id_parents(self, file_id):
1137
        """Yield the parents of file_id up to the root."""
1757.2.11 by Robert Collins
Correct bzr diff | less= None clauses in inventory.py to be is not None.
1138
        while file_id is not None:
1596.2.19 by Robert Collins
Shave 20% off id2path.
1139
            try:
1140
                ie = self._byid[file_id]
1141
            except KeyError:
1142
                raise BzrError("file_id {%s} not found in inventory" % file_id)
1143
            yield ie
1144
            file_id = ie.parent_id
1 by mbp at sourcefrog
import from baz patch-364
1145
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1146
    def get_idpath(self, file_id):
1147
        """Return a list of file_ids for the path to an entry.
1148
1149
        The list contains one element for each directory followed by
1150
        the id of the file itself.  So the length of the returned list
1151
        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
1152
        root directory as depth 1.
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1153
        """
1154
        p = []
1596.2.19 by Robert Collins
Shave 20% off id2path.
1155
        for parent in self._iter_file_id_parents(file_id):
1156
            p.insert(0, parent.file_id)
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1157
        return p
1158
1 by mbp at sourcefrog
import from baz patch-364
1159
    def id2path(self, file_id):
1596.2.19 by Robert Collins
Shave 20% off id2path.
1160
        """Return as a string the path to file_id.
1393.1.32 by Martin Pool
- add docstring demonstrating use of Inventory.id2path
1161
        
1162
        >>> i = Inventory()
1163
        >>> e = i.add(InventoryDirectory('src-id', 'src', ROOT_ID))
1164
        >>> e = i.add(InventoryFile('foo-id', 'foo.c', parent_id='src-id'))
1185.31.34 by John Arbash Meinel
Removing instances of os.sep
1165
        >>> print i.id2path('foo-id')
1393.1.32 by Martin Pool
- add docstring demonstrating use of Inventory.id2path
1166
        src/foo.c
1167
        """
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1168
        # get all names, skipping root
1596.2.19 by Robert Collins
Shave 20% off id2path.
1169
        return '/'.join(reversed(
1170
            [parent.name for parent in 
1171
             self._iter_file_id_parents(file_id)][:-1]))
1 by mbp at sourcefrog
import from baz patch-364
1172
            
1173
    def path2id(self, name):
1174
        """Walk down through directories to return entry of last component.
1175
1176
        names may be either a list of path components, or a single
1177
        string, in which case it is automatically split.
1178
1179
        This returns the entry of the last component in the path,
1180
        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
1181
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1182
        Returns None IFF the path is not found.
1 by mbp at sourcefrog
import from baz patch-364
1183
        """
70 by mbp at sourcefrog
Prepare for smart recursive add.
1184
        if isinstance(name, types.StringTypes):
1185
            name = splitpath(name)
1 by mbp at sourcefrog
import from baz patch-364
1186
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1187
        # mutter("lookup path %r" % name)
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1188
1189
        parent = self.root
70 by mbp at sourcefrog
Prepare for smart recursive add.
1190
        for f in name:
1 by mbp at sourcefrog
import from baz patch-364
1191
            try:
138 by mbp at sourcefrog
remove parallel tree from inventory;
1192
                cie = parent.children[f]
1 by mbp at sourcefrog
import from baz patch-364
1193
                assert cie.name == f
178 by mbp at sourcefrog
- Use a non-null file_id for the branch root directory. At the moment
1194
                assert cie.parent_id == parent.file_id
138 by mbp at sourcefrog
remove parallel tree from inventory;
1195
                parent = cie
1 by mbp at sourcefrog
import from baz patch-364
1196
            except KeyError:
1197
                # or raise an error?
1198
                return None
1199
138 by mbp at sourcefrog
remove parallel tree from inventory;
1200
        return parent.file_id
1 by mbp at sourcefrog
import from baz patch-364
1201
1202
    def has_filename(self, names):
1203
        return bool(self.path2id(names))
1204
1205
    def has_id(self, file_id):
1206
        return self._byid.has_key(file_id)
1207
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
1208
    def rename(self, file_id, new_parent_id, new_name):
1209
        """Move a file within the inventory.
1210
1211
        This can change either the name, or the parent, or both.
1212
1213
        This does not move the working file."""
1214
        if not is_valid_name(new_name):
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1215
            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
1216
1217
        new_parent = self._byid[new_parent_id]
1218
        if new_name in new_parent.children:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1219
            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
1220
172 by mbp at sourcefrog
- clearer check against attempts to introduce directory loops in the inventory
1221
        new_parent_idpath = self.get_idpath(new_parent_id)
1222
        if file_id in new_parent_idpath:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
1223
            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
1224
                    % (self.id2path(file_id), self.id2path(new_parent_id)))
1225
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
1226
        file_ie = self._byid[file_id]
1227
        old_parent = self._byid[file_ie.parent_id]
1228
1229
        # TODO: Don't leave things messed up if this fails
1230
1231
        del old_parent.children[file_ie.name]
1232
        new_parent.children[new_name] = file_ie
1233
        
1234
        file_ie.name = new_name
1235
        file_ie.parent_id = new_parent_id
1236
1237
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1238
def make_entry(kind, name, parent_id, file_id=None):
1239
    """Create an inventory entry.
1240
1241
    :param kind: the type of inventory entry to create.
1242
    :param name: the basename of the entry.
1243
    :param parent_id: the parent_id of the entry.
1244
    :param file_id: the file_id to use. if None, one will be created.
1245
    """
1246
    if file_id is None:
1247
        file_id = bzrlib.workingtree.gen_file_id(name)
1830.3.5 by John Arbash Meinel
make_entry refuses to create non-normalized entries.
1248
1249
    norm_name, can_access = osutils.normalized_filename(name)
1250
    if norm_name != name:
1251
        if can_access:
1252
            name = norm_name
1253
        else:
1254
            # TODO: jam 20060701 This would probably be more useful
1255
            #       if the error was raised with the full path
1256
            raise errors.InvalidNormalization(name)
1257
1713.1.11 by Robert Collins
refactor smart_add to pass around the parent inventory entry and use that, resulting in another 100bzrlib/inventory.py performance improvement, and making inventory writing the dominating factory in add. (Robert Collins)
1258
    if kind == 'directory':
1259
        return InventoryDirectory(file_id, name, parent_id)
1260
    elif kind == 'file':
1261
        return InventoryFile(file_id, name, parent_id)
1262
    elif kind == 'symlink':
1263
        return InventoryLink(file_id, name, parent_id)
1264
    else:
1265
        raise BzrError("unknown kind %r" % kind)
1266
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
1267
1077 by Martin Pool
- avoid compiling REs at module load time
1268
_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
1269
1270
def is_valid_name(name):
1077 by Martin Pool
- avoid compiling REs at module load time
1271
    global _NAME_RE
1753.1.4 by Robert Collins
Fixup '== None' usage in inventory.py.
1272
    if _NAME_RE is None:
1077 by Martin Pool
- avoid compiling REs at module load time
1273
        _NAME_RE = re.compile(r'^[^/\\]+$')
1274
        
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
1275
    return bool(_NAME_RE.match(name))