~bzr-pqm/bzr/bzr.dev

4012.3.2 by Martin Pool
merge trunk
1
# Copyright (C) 2005, 2009 Canonical Ltd
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
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.
1887.1.1 by Adeodato Simó
Do not separate paragraphs in the copyright statement with blank lines,
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1 by mbp at sourcefrog
import from baz patch-364
16
17
"""Tree classes, representing directory at point in time.
18
"""
19
849 by Martin Pool
- Put files inside an exported tarball into a top-level directory rather than
20
import os
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
21
from collections import deque
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
22
from cStringIO import StringIO
800 by Martin Pool
Merge John's import-speedup branch:
23
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
24
import bzrlib
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
25
from bzrlib import (
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
26
    conflicts as _mod_conflicts,
3368.2.30 by Ian Clatworthy
add -Dfilters support
27
    debug,
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
28
    delta,
3368.2.16 by Ian Clatworthy
add real implementation of Tree.get_filter_stack
29
    filters,
2012.1.8 by Aaron Bentley
Merge from bzr.dev
30
    osutils,
1551.15.46 by Aaron Bentley
Move plan merge to tree
31
    revision as _mod_revision,
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
32
    rules,
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
33
    symbol_versioning,
34
    )
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
35
from bzrlib.decorators import needs_read_lock
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
36
from bzrlib.errors import BzrError, BzrCheckError, NoSuchId
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
37
from bzrlib import errors
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
38
from bzrlib.inventory import Inventory, InventoryFile
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
39
from bzrlib.inter import InterObject
1732.1.1 by John Arbash Meinel
deprecating appendpath, it does exactly what pathjoin does
40
from bzrlib.osutils import fingerprint_file
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
41
import bzrlib.revision
1551.21.1 by Aaron Bentley
Deprecate tree.find_renames
42
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
43
from bzrlib.trace import mutter, note
1 by mbp at sourcefrog
import from baz patch-364
44
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
45
558 by Martin Pool
- All top-level classes inherit from object
46
class Tree(object):
1 by mbp at sourcefrog
import from baz patch-364
47
    """Abstract file tree.
48
49
    There are several subclasses:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
50
1 by mbp at sourcefrog
import from baz patch-364
51
    * `WorkingTree` exists as files on disk editable by the user.
52
53
    * `RevisionTree` is a tree as recorded at some point in the past.
54
55
    Trees contain an `Inventory` object, and also know how to retrieve
56
    file texts mentioned in the inventory, either from a working
57
    directory or from a store.
58
59
    It is possible for trees to contain files that are not described
60
    in their inventory or vice versa; for this use `filenames()`.
61
62
    Trees can be compared, etc, regardless of whether they are working
63
    trees or versioned trees.
64
    """
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
65
1852.9.6 by Robert Collins
Merge the change from Tree.compare to Tree.changes_from.
66
    def changes_from(self, other, want_unchanged=False, specific_files=None,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
67
        extra_trees=None, require_versioned=False, include_root=False,
68
        want_unversioned=False):
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
69
        """Return a TreeDelta of the changes from other to this tree.
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
70
71
        :param other: A tree to compare with.
72
        :param specific_files: An optional list of file paths to restrict the
73
            comparison to. When mapping filenames to ids, all matches in all
74
            trees (including optional extra_trees) are used, and all children of
75
            matched directories are included.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
76
        :param want_unchanged: An optional boolean requesting the inclusion of
77
            unchanged entries in the result.
78
        :param extra_trees: An optional list of additional trees to use when
79
            mapping the contents of specific_files (paths) to file_ids.
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
80
        :param require_versioned: An optional boolean (defaults to False). When
81
            supplied and True all the 'specific_files' must be versioned, or
82
            a PathsNotVersionedError will be thrown.
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
83
        :param want_unversioned: Scan for unversioned paths.
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
84
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
85
        The comparison will be performed by an InterTree object looked up on
1852.8.4 by Robert Collins
Hook InterTree into Tree.
86
        self and other.
87
        """
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
88
        # Martin observes that Tree.changes_from returns a TreeDelta and this
89
        # may confuse people, because the class name of the returned object is
90
        # a synonym of the object referenced in the method name.
1852.9.6 by Robert Collins
Merge the change from Tree.compare to Tree.changes_from.
91
        return InterTree.get(other, self).compare(
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
92
            want_unchanged=want_unchanged,
93
            specific_files=specific_files,
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
94
            extra_trees=extra_trees,
95
            require_versioned=require_versioned,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
96
            include_root=include_root,
97
            want_unversioned=want_unversioned,
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
98
            )
2012.1.1 by Aaron Bentley
Implement change iterator
99
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
100
    def iter_changes(self, from_tree, include_unchanged=False,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
101
                     specific_files=None, pb=None, extra_trees=None,
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
102
                     require_versioned=True, want_unversioned=False):
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
103
        intertree = InterTree.get(from_tree, self)
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
104
        return intertree.iter_changes(include_unchanged, specific_files, pb,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
105
            extra_trees, require_versioned, want_unversioned=want_unversioned)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
106
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
107
    def conflicts(self):
108
        """Get a list of the conflicts in the tree.
109
110
        Each conflict is an instance of bzrlib.conflicts.Conflict.
111
        """
2748.2.1 by Lukáš Lalinsky
Return ConflictsList() instead of [] from Tree.conflicts.
112
        return _mod_conflicts.ConflictList()
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
113
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
114
    def extras(self):
115
        """For trees that can have unversioned files, return all such paths."""
116
        return []
117
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
118
    def get_parent_ids(self):
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
119
        """Get the parent ids for this tree.
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
120
121
        :return: a list of parent ids. [] is returned to indicate
122
        a tree with no parents.
123
        :raises: BzrError if the parents are not known.
124
        """
125
        raise NotImplementedError(self.get_parent_ids)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
126
1 by mbp at sourcefrog
import from baz patch-364
127
    def has_filename(self, filename):
128
        """True if the tree has given filename."""
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
129
        raise NotImplementedError(self.has_filename)
1 by mbp at sourcefrog
import from baz patch-364
130
1185.12.39 by abentley
Propogated has_or_had_id to Tree
131
    def has_id(self, file_id):
132
        return self.inventory.has_id(file_id)
133
3363.15.3 by Aaron Bentley
Change Tree.__contains__ to tolerate subclasssing
134
    def __contains__(self, file_id):
135
        return self.has_id(file_id)
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
136
1185.12.39 by abentley
Propogated has_or_had_id to Tree
137
    def has_or_had_id(self, file_id):
138
        if file_id == self.inventory.root.file_id:
1185.12.38 by abentley
semi-broke merge
139
            return True
1 by mbp at sourcefrog
import from baz patch-364
140
        return self.inventory.has_id(file_id)
141
2255.7.97 by Robert Collins
Teach delta.report_changes about unversioned files, removing all inventory access during status --short.
142
    def is_ignored(self, filename):
143
        """Check whether the filename is ignored by this tree.
144
145
        :param filename: The relative filename within the tree.
146
        :return: True if the filename is ignored.
147
        """
148
        return False
149
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
150
    def __iter__(self):
151
        return iter(self.inventory)
152
3146.8.16 by Aaron Bentley
Updates from review
153
    def all_file_ids(self):
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
154
        """Iterate through all file ids, including ids for missing files."""
3146.8.16 by Aaron Bentley
Updates from review
155
        return set(self.inventory)
3146.8.2 by Aaron Bentley
Introduce iter_all_file_ids, to avoid hitting Inventory for this case
156
1 by mbp at sourcefrog
import from baz patch-364
157
    def id2path(self, file_id):
2255.11.5 by Martin Pool
Tree.id2path should raise NoSuchId, not return None.
158
        """Return the path for a file id.
159
160
        :raises NoSuchId:
161
        """
1 by mbp at sourcefrog
import from baz patch-364
162
        return self.inventory.id2path(file_id)
163
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
164
    def is_control_filename(self, filename):
165
        """True if filename is the name of a control file in this tree.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
166
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
167
        :param filename: A filename within the tree. This is a relative path
168
        from the root of this tree.
169
170
        This is true IF and ONLY IF the filename is part of the meta data
171
        that bzr controls in this tree. I.E. a random .bzr directory placed
172
        on disk will not be a control file for this tree.
173
        """
174
        return self.bzrdir.is_control_filename(filename)
175
2255.2.15 by Robert Collins
Dirstate - truncate state file fixing bug in saving a smaller file, get more tree_implementation tests passing.
176
    @needs_read_lock
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
177
    def iter_entries_by_dir(self, specific_file_ids=None):
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
178
        """Walk the tree in 'by_dir' order.
179
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
180
        This will yield each entry in the tree as a (path, entry) tuple.
181
        The order that they are yielded is:
182
183
        Directories are walked in a depth-first lexicographical order,
184
        however, whenever a directory is reached, all of its direct child
185
        nodes are yielded in  lexicographical order before yielding the
186
        grandchildren.
187
188
        For example, in the tree::
189
190
           a/
191
             b/
192
               c
193
             d/
194
               e
195
           f/
196
             g
197
3363.5.4 by Aaron Bentley
Fix iteration order of iter_entries_by_dir
198
        The yield order (ignoring root) would be::
3363.2.23 by Aaron Bentley
Fix iter_entries_by_dir ordering
199
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
200
        """
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
201
        return self.inventory.iter_entries_by_dir(
202
            specific_file_ids=specific_file_ids)
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
203
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
204
    def iter_references(self):
4370.3.2 by Ian Clatworthy
apply jam's review feedback
205
        if self.supports_tree_reference():
206
            for path, entry in self.iter_entries_by_dir():
207
                if entry.kind == 'tree-reference':
208
                    yield path, entry.file_id
2100.3.27 by Aaron Bentley
Enable nested commits
209
1465 by Robert Collins
Bugfix the new pull --clobber to not generate spurious conflicts.
210
    def kind(self, file_id):
2255.2.159 by Martin Pool
reference-trees in dirstate pass all tests.
211
        raise NotImplementedError("Tree subclass %s must implement kind"
212
            % self.__class__.__name__)
1465 by Robert Collins
Bugfix the new pull --clobber to not generate spurious conflicts.
213
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
214
    def stored_kind(self, file_id):
215
        """File kind stored for this file_id.
216
3146.8.15 by Aaron Bentley
Cleanup and docs
217
        May not match kind on disk for working trees.  Always available
218
        for versioned files, even when the file itself is missing.
3146.8.4 by Aaron Bentley
Eliminate direct use of inventory from transform application
219
        """
220
        return self.kind(file_id)
221
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
222
    def path_content_summary(self, path):
223
        """Get a summary of the information about path.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
224
2776.1.7 by Robert Collins
* New method on ``bzrlib.tree.Tree`` ``path_content_summary`` provides a
225
        :param path: A relative path within the tree.
226
        :return: A tuple containing kind, size, exec, sha1-or-link.
227
            Kind is always present (see tree.kind()).
228
            size is present if kind is file, None otherwise.
229
            exec is None unless kind is file and the platform supports the 'x'
230
                bit.
231
            sha1-or-link is the link target if kind is symlink, or the sha1 if
232
                it can be obtained without reading the file.
233
        """
234
        raise NotImplementedError(self.path_content_summary)
235
2255.2.226 by Robert Collins
Get merge_nested finally working: change nested tree iterators to take file_ids, and ensure the right branch is connected to in the merge logic. May not be suitable for shared repositories yet.
236
    def get_reference_revision(self, file_id, path=None):
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
237
        raise NotImplementedError("Tree subclass %s must implement "
238
                                  "get_reference_revision"
239
            % self.__class__.__name__)
2100.3.20 by Aaron Bentley
Implement tree comparison for tree references
240
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
241
    def _comparison_data(self, entry, path):
2012.1.15 by Aaron Bentley
Minor tweaks
242
        """Return a tuple of kind, executable, stat_value for a file.
243
244
        entry may be None if there is no inventory entry for the file, but
245
        path must always be supplied.
246
247
        kind is None if there is no file present (even if an inventory id is
248
        present).  executable is False for non-file entries.
249
        """
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
250
        raise NotImplementedError(self._comparison_data)
251
2255.2.10 by Robert Collins
Now all tests matching dirstate pass - added generation of inventories for parent trees.
252
    def _file_size(self, entry, stat_value):
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
253
        raise NotImplementedError(self._file_size)
254
1 by mbp at sourcefrog
import from baz patch-364
255
    def _get_inventory(self):
256
        return self._inventory
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
257
2743.3.3 by Ian Clatworthy
Skip path lookup for tree.get_file() when we already know the path
258
    def get_file(self, file_id, path=None):
2772.2.1 by Ian Clatworthy
(Ian Clatworthy) Quicker initial commit - skip SHAing twice & skip path lookup as we know it
259
        """Return a file object for the file file_id in the tree.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
260
2772.2.1 by Ian Clatworthy
(Ian Clatworthy) Quicker initial commit - skip SHAing twice & skip path lookup as we know it
261
        If both file_id and path are defined, it is implementation defined as
262
        to which one is used.
263
        """
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
264
        raise NotImplementedError(self.get_file)
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
265
3774.1.1 by Aaron Bentley
Test Tree.get_file_text() and supply default implementation.
266
    def get_file_text(self, file_id, path=None):
267
        """Return the byte content of a file.
268
269
        :param file_id: The file_id of the file.
270
        :param path: The path of the file.
271
        If both file_id and path are supplied, an implementation may use
272
        either one.
273
        """
274
        my_file = self.get_file(file_id, path)
275
        try:
276
            return my_file.read()
277
        finally:
278
            my_file.close()
279
3774.1.2 by Aaron Bentley
Test Tree.get_file_lines, provide a default implementation
280
    def get_file_lines(self, file_id, path=None):
281
        """Return the content of a file, as lines.
282
283
        :param file_id: The file_id of the file.
284
        :param path: The path of the file.
285
        If both file_id and path are supplied, an implementation may use
286
        either one.
287
        """
288
        return osutils.split_lines(self.get_file_text(file_id, path))
289
2255.7.36 by John Arbash Meinel
All trees should implement get_file_mtime()
290
    def get_file_mtime(self, file_id, path=None):
291
        """Return the modification time for a file.
292
293
        :param file_id: The handle for this file.
294
        :param path: The path that this file can be found at.
295
            These must point to the same object.
296
        """
297
        raise NotImplementedError(self.get_file_mtime)
298
3363.3.4 by Aaron Bentley
Add get_file_size to Tree interface
299
    def get_file_size(self, file_id):
300
        """Return the size of a file in bytes.
301
302
        This applies only to regular files.  If invoked on directories or
303
        symlinks, it will return None.
304
        :param file_id: The file-id of the file
305
        """
306
        raise NotImplementedError(self.get_file_size)
307
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
308
    def get_file_by_path(self, path):
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
309
        return self.get_file(self._inventory.path2id(path), path)
1 by mbp at sourcefrog
import from baz patch-364
310
2708.1.7 by Aaron Bentley
Rename extract_files_bytes to iter_files_bytes
311
    def iter_files_bytes(self, desired_files):
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
312
        """Iterate through file contents.
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
313
2708.1.10 by Aaron Bentley
Update docstrings
314
        Files will not necessarily be returned in the order they occur in
315
        desired_files.  No specific order is guaranteed.
316
317
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
318
        value supplied by the caller as part of desired_files.  It should
319
        uniquely identify the file version in the caller's context.  (Examples:
320
        an index number or a TreeTransform trans_id.)
321
322
        bytes_iterator is an iterable of bytestrings for the file.  The
323
        kind of iterable and length of the bytestrings are unspecified, but for
324
        this implementation, it is a tuple containing a single bytestring with
325
        the complete text of the file.
326
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
327
        :param desired_files: a list of (file_id, identifier) pairs
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
328
        """
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
329
        for file_id, identifier in desired_files:
2708.1.10 by Aaron Bentley
Update docstrings
330
            # We wrap the string in a tuple so that we can return an iterable
331
            # of bytestrings.  (Technically, a bytestring is also an iterable
332
            # of bytestrings, but iterating through each character is not
333
            # performant.)
2708.1.6 by Aaron Bentley
Turn extract_files_bytes into an iterator
334
            cur_file = (self.get_file_text(file_id),)
335
            yield identifier, cur_file
2708.1.1 by Aaron Bentley
Implement Tree.extract_files
336
2255.2.134 by John Arbash Meinel
Add a tree-test for get_symlink_target
337
    def get_symlink_target(self, file_id):
338
        """Get the target for a given file_id.
339
340
        It is assumed that the caller already knows that file_id is referencing
341
        a symlink.
342
        :param file_id: Handle for the symlink entry.
343
        :return: The path the symlink points to.
344
        """
345
        raise NotImplementedError(self.get_symlink_target)
346
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
347
    def get_canonical_inventory_paths(self, paths):
3794.5.35 by Mark Hammond
docstring tweaks
348
        """Like get_canonical_inventory_path() but works on multiple items.
3794.5.5 by Mark Hammond
Add get_canonical_path method to the Tree class, plus tests.
349
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
350
        :param paths: A sequence of paths relative to the root of the tree.
351
        :return: A list of paths, with each item the corresponding input path
352
        adjusted to account for existing elements that match case
353
        insensitively.
354
        """
355
        return list(self._yield_canonical_inventory_paths(paths))
356
357
    def get_canonical_inventory_path(self, path):
3794.5.35 by Mark Hammond
docstring tweaks
358
        """Returns the first inventory item that case-insensitively matches path.
359
360
        If a path matches exactly, it is returned. If no path matches exactly
361
        but more than one path matches case-insensitively, it is implementation
362
        defined which is returned.
363
364
        If no path matches case-insensitively, the input path is returned, but
365
        with as many path entries that do exist changed to their canonical
366
        form.
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
367
368
        If you need to resolve many names from the same tree, you should
369
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
3794.5.35 by Mark Hammond
docstring tweaks
370
371
        :param path: A paths relative to the root of the tree.
372
        :return: The input path adjusted to account for existing elements
373
        that match case insensitively.
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
374
        """
375
        return self._yield_canonical_inventory_paths([path]).next()
376
377
    def _yield_canonical_inventory_paths(self, paths):
378
        for path in paths:
379
            # First, if the path as specified exists exactly, just use it.
380
            if self.path2id(path) is not None:
381
                yield path
382
                continue
383
            # go walkin...
384
            cur_id = self.get_root_id()
385
            cur_path = ''
386
            bit_iter = iter(path.split("/"))
387
            for elt in bit_iter:
388
                lelt = elt.lower()
389
                for child in self.iter_children(cur_id):
390
                    try:
391
                        child_base = os.path.basename(self.id2path(child))
392
                        if child_base.lower() == lelt:
393
                            cur_id = child
394
                            cur_path = osutils.pathjoin(cur_path, child_base)
395
                            break
396
                    except NoSuchId:
397
                        # before a change is committed we can see this error...
398
                        continue
399
                else:
400
                    # got to the end of this directory and no entries matched.
401
                    # Return what matched so far, plus the rest as specified.
402
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
3794.5.5 by Mark Hammond
Add get_canonical_path method to the Tree class, plus tests.
403
                    break
3794.5.18 by Mark Hammond
get_canonical_path renamed to get_canonical_inventory_path() and corresponding get_canonical_inventory_paths() method added.
404
            yield cur_path
405
        # all done.
3794.5.5 by Mark Hammond
Add get_canonical_path method to the Tree class, plus tests.
406
2946.3.2 by John Arbash Meinel
Add tree implementation tests for Tree.get_root_id()
407
    def get_root_id(self):
408
        """Return the file_id for the root of this tree."""
409
        raise NotImplementedError(self.get_root_id)
410
3224.1.2 by John Arbash Meinel
Updated the base Tree.annotate_iter() since all implemenations take an optional kwarg.
411
    def annotate_iter(self, file_id,
412
                      default_revision=_mod_revision.CURRENT_REVISION):
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
413
        """Return an iterator of revision_id, line tuples.
1551.9.18 by Aaron Bentley
Updates from review comments
414
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
415
        For working trees (and mutable trees in general), the special
416
        revision_id 'current:' will be used for lines that are new in this
417
        tree, e.g. uncommitted changes.
418
        :param file_id: The file to produce an annotated version from
3224.1.2 by John Arbash Meinel
Updated the base Tree.annotate_iter() since all implemenations take an optional kwarg.
419
        :param default_revision: For lines that don't match a basis, mark them
420
            with this revision id. Not all implementations will make use of
421
            this value.
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
422
        """
423
        raise NotImplementedError(self.annotate_iter)
424
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
425
    def _get_plan_merge_data(self, file_id, other, base):
3062.1.11 by Aaron Bentley
Update references
426
        from bzrlib import merge, versionedfile
427
        vf = versionedfile._PlanMergeVersionedFile(file_id)
3062.1.3 by Aaron Bentley
Correctly determine file revisions
428
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
429
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
3062.2.4 by Aaron Bentley
Start supporting merge-with-base
430
        if base is None:
431
            last_revision_base = None
432
        else:
3062.2.6 by Aaron Bentley
Get cherrypick-on-weave working
433
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
434
        return vf, last_revision_a, last_revision_b, last_revision_base
435
436
    def plan_file_merge(self, file_id, other, base=None):
437
        """Generate a merge plan based on annotations.
438
439
        If the file contains uncommitted changes in this tree, they will be
440
        attributed to the 'current:' pseudo-revision.  If the file contains
441
        uncommitted changes in the other tree, they will be assigned to the
442
        'other:' pseudo-revision.
443
        """
444
        data = self._get_plan_merge_data(file_id, other, base)
445
        vf, last_revision_a, last_revision_b, last_revision_base = data
3062.2.4 by Aaron Bentley
Start supporting merge-with-base
446
        return vf.plan_merge(last_revision_a, last_revision_b,
447
                             last_revision_base)
3062.1.3 by Aaron Bentley
Correctly determine file revisions
448
3144.3.1 by Aaron Bentley
Implement LCA merge, with problematic conflict markers
449
    def plan_file_lca_merge(self, file_id, other, base=None):
450
        """Generate a merge plan based lca-newness.
451
452
        If the file contains uncommitted changes in this tree, they will be
453
        attributed to the 'current:' pseudo-revision.  If the file contains
454
        uncommitted changes in the other tree, they will be assigned to the
455
        'other:' pseudo-revision.
456
        """
457
        data = self._get_plan_merge_data(file_id, other, base)
458
        vf, last_revision_a, last_revision_b, last_revision_base = data
459
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
460
                                 last_revision_base)
461
3363.9.1 by Aaron Bentley
Implement plan_merge, refactoring various bits
462
    def _iter_parent_trees(self):
463
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
464
        for revision_id in self.get_parent_ids():
465
            try:
466
                yield self.revision_tree(revision_id)
467
            except errors.NoSuchRevisionInTree:
468
                yield self.repository.revision_tree(revision_id)
469
470
    @staticmethod
471
    def _file_revision(revision_tree, file_id):
472
        """Determine the revision associated with a file in a given tree."""
473
        revision_tree.lock_read()
474
        try:
475
            return revision_tree.inventory[file_id].revision
476
        finally:
477
            revision_tree.unlock()
478
3062.1.3 by Aaron Bentley
Correctly determine file revisions
479
    def _get_file_revision(self, file_id, vf, tree_revision):
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
480
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
3062.1.3 by Aaron Bentley
Correctly determine file revisions
481
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
482
        if getattr(self, '_repository', None) is None:
3062.1.3 by Aaron Bentley
Correctly determine file revisions
483
            last_revision = tree_revision
3363.9.1 by Aaron Bentley
Implement plan_merge, refactoring various bits
484
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
485
                self._iter_parent_trees()]
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
486
            vf.add_lines((file_id, last_revision), parent_keys,
3062.1.3 by Aaron Bentley
Correctly determine file revisions
487
                         self.get_file(file_id).readlines())
3062.1.6 by Aaron Bentley
PlanMergeVersionedfile now has multiple Versionedfile fallbacks
488
            repo = self.branch.repository
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
489
            base_vf = repo.texts
3062.1.3 by Aaron Bentley
Correctly determine file revisions
490
        else:
3363.9.1 by Aaron Bentley
Implement plan_merge, refactoring various bits
491
            last_revision = self._file_revision(self, file_id)
3350.6.4 by Robert Collins
First cut at pluralised VersionedFiles. Some rather massive API incompatabilities, primarily because of the difficulty of coherence among competing stores.
492
            base_vf = self._repository.texts
493
        if base_vf not in vf.fallback_versionedfiles:
494
            vf.fallback_versionedfiles.append(base_vf)
3062.1.3 by Aaron Bentley
Correctly determine file revisions
495
        return last_revision
1551.15.46 by Aaron Bentley
Move plan merge to tree
496
1 by mbp at sourcefrog
import from baz patch-364
497
    inventory = property(_get_inventory,
498
                         doc="Inventory of this Tree")
499
500
    def _check_retrieved(self, ie, f):
1364 by Martin Pool
- remove extra verification of files retrieved from tree
501
        if not __debug__:
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
502
            return
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
503
        fp = fingerprint_file(f)
504
        f.seek(0)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
505
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
506
        if ie.text_size is not None:
131 by mbp at sourcefrog
check size and sha1 of files retrieved from the tree
507
            if ie.text_size != fp['size']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
508
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
1 by mbp at sourcefrog
import from baz patch-364
509
                        ["inventory expects %d bytes" % ie.text_size,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
510
                         "file is actually %d bytes" % fp['size'],
1 by mbp at sourcefrog
import from baz patch-364
511
                         "store is probably damaged/corrupt"])
512
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
513
        if ie.text_sha1 != fp['sha1']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
514
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
1 by mbp at sourcefrog
import from baz patch-364
515
                    ["inventory expects %s" % ie.text_sha1,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
516
                     "file is actually %s" % fp['sha1'],
1 by mbp at sourcefrog
import from baz patch-364
517
                     "store is probably damaged/corrupt"])
518
2334.1.1 by John Arbash Meinel
Lazily read working inventory in workingtree.py,
519
    @needs_read_lock
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
520
    def path2id(self, path):
521
        """Return the id for path in this tree."""
522
        return self._inventory.path2id(path)
1 by mbp at sourcefrog
import from baz patch-364
523
2255.2.101 by Robert Collins
Finish making Tree.ids2paths support the file_ids_across_trees api.
524
    def paths2ids(self, paths, trees=[], require_versioned=True):
2255.2.100 by Robert Collins
Create a paths2ids api to replace find_ids_across_trees, with tests.
525
        """Return all the ids that can be reached by walking from paths.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
526
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
527
        Each path is looked up in this tree and any extras provided in
2255.2.100 by Robert Collins
Create a paths2ids api to replace find_ids_across_trees, with tests.
528
        trees, and this is repeated recursively: the children in an extra tree
529
        of a directory that has been renamed under a provided path in this tree
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
530
        are all returned, even if none exist under a provided path in this
2255.2.100 by Robert Collins
Create a paths2ids api to replace find_ids_across_trees, with tests.
531
        tree, and vice versa.
2255.2.101 by Robert Collins
Finish making Tree.ids2paths support the file_ids_across_trees api.
532
533
        :param paths: An iterable of paths to start converting to ids from.
2255.2.104 by Robert Collins
Add WorkingTree4.paths2ids which is inventory-usage free if the trees being examined are in the dirstate.
534
            Alternatively, if paths is None, no ids should be calculated and None
535
            will be returned. This is offered to make calling the api unconditional
536
            for code that *might* take a list of files.
2255.2.101 by Robert Collins
Finish making Tree.ids2paths support the file_ids_across_trees api.
537
        :param trees: Additional trees to consider.
538
        :param require_versioned: If False, do not raise NotVersionedError if
539
            an element of paths is not versioned in this tree and all of trees.
2255.2.100 by Robert Collins
Create a paths2ids api to replace find_ids_across_trees, with tests.
540
        """
2255.2.105 by Robert Collins
Unfuck InterTree.compare which I broke with the paths2ids implementation.
541
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
2255.2.100 by Robert Collins
Create a paths2ids api to replace find_ids_across_trees, with tests.
542
3363.12.2 by Aaron Bentley
Implement tree.iter_children to instead of adjusting InventoryEntry handling
543
    def iter_children(self, file_id):
544
        entry = self.iter_entries_by_dir([file_id]).next()[1]
545
        for child in getattr(entry, 'children', {}).itervalues():
546
            yield child.file_id
547
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
548
    def lock_read(self):
549
        pass
550
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
551
    def revision_tree(self, revision_id):
552
        """Obtain a revision tree for the revision revision_id.
553
554
        The intention of this method is to allow access to possibly cached
555
        tree data. Implementors of this method should raise NoSuchRevision if
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
556
        the tree is not locally available, even if they could obtain the
557
        tree via a repository or some other means. Callers are responsible
1908.11.1 by Robert Collins
Add a new method ``Tree.revision_tree`` which allows access to cached
558
        for finding the ultimate source for a revision tree.
559
560
        :param revision_id: The revision_id of the requested tree.
561
        :return: A Tree.
562
        :raises: NoSuchRevision if the tree cannot be obtained.
563
        """
564
        raise errors.NoSuchRevisionInTree(self, revision_id)
565
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
566
    def unknowns(self):
567
        """What files are present in this tree and unknown.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
568
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
569
        :return: an iterator over the unknown files.
570
        """
571
        return iter([])
572
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
573
    def unlock(self):
574
        pass
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
575
576
    def filter_unversioned_files(self, paths):
2255.7.62 by Robert Collins
Update the Tree.filter_unversioned_files docstring to reflect what the existing implementations actually do, and change the WorkingTree4 implementation to match a newly created test for it.
577
        """Filter out paths that are versioned.
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
578
579
        :return: set of paths.
580
        """
1658.1.10 by Martin Pool
diff on unversiond files should give an error (Malone #3619)
581
        # NB: we specifically *don't* call self.has_filename, because for
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
582
        # WorkingTrees that can indicate files that exist on disk but that
1658.1.10 by Martin Pool
diff on unversiond files should give an error (Malone #3619)
583
        # are not versioned.
584
        pred = self.inventory.has_filename
585
        return set((p for p in paths if not pred(p)))
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
586
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
587
    def walkdirs(self, prefix=""):
588
        """Walk the contents of this tree from path down.
589
590
        This yields all the data about the contents of a directory at a time.
591
        After each directory has been yielded, if the caller has mutated the
592
        list to exclude some directories, they are then not descended into.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
593
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
594
        The data yielded is of the form:
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
595
        ((directory-relpath, directory-path-from-root, directory-fileid),
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
596
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
1852.15.7 by Robert Collins
Start testing behaviour of unknowns in WorkingTree.walkdirs.
597
          versioned_kind), ...]),
598
         - directory-relpath is the containing dirs relpath from prefix
599
         - directory-path-from-root is the containing dirs path from /
600
         - directory-fileid is the id of the directory if it is versioned.
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
601
         - relpath is the relative path within the subtree being walked.
602
         - basename is the basename
603
         - kind is the kind of the file now. If unknonwn then the file is not
604
           present within the tree - but it may be recorded as versioned. See
605
           versioned_kind.
606
         - lstat is the stat data *if* the file was statted.
607
         - path_from_tree_root is the path from the root of the tree.
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
608
         - file_id is the file_id if the entry is versioned.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
609
         - versioned_kind is the kind of the file as last recorded in the
1852.15.3 by Robert Collins
Add a first-cut Tree.walkdirs method.
610
           versioning system. If 'unknown' the file is not versioned.
611
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
612
613
        :param prefix: Start walking from prefix within the tree rather than
614
        at the root. This allows one to walk a subtree but get paths that are
615
        relative to a tree rooted higher up.
616
        :return: an iterator over the directory data.
617
        """
618
        raise NotImplementedError(self.walkdirs)
619
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
620
    def supports_content_filtering(self):
621
        return False
622
3368.2.5 by Ian Clatworthy
incorporate jameinel's review feedback
623
    def _content_filter_stack(self, path=None, file_id=None):
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
624
        """The stack of content filters for a path if filtering is supported.
3368.2.47 by Ian Clatworthy
merge bzr.dev r4042
625
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
626
        Readers will be applied in first-to-last order.
627
        Writers will be applied in last-to-first order.
3368.2.5 by Ian Clatworthy
incorporate jameinel's review feedback
628
        Either the path or the file-id needs to be provided.
629
630
        :param path: path relative to the root of the tree
631
            or None if unknown
632
        :param file_id: file_id or None if unknown
633
        :return: the list of filters - [] if there are none
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
634
        """
3368.2.16 by Ian Clatworthy
add real implementation of Tree.get_filter_stack
635
        filter_pref_names = filters._get_registered_names()
636
        if len(filter_pref_names) == 0:
637
            return []
638
        if path is None:
639
            path = self.id2path(file_id)
3368.2.29 by Ian Clatworthy
access rules via get_special_file to fix recursion bug
640
        prefs = self.iter_search_rules([path], filter_pref_names).next()
3368.2.30 by Ian Clatworthy
add -Dfilters support
641
        stk = filters._get_filter_stack_for(prefs)
642
        if 'filters' in debug.debug_flags:
643
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
644
        return stk
3368.2.4 by Ian Clatworthy
make content filter lookup a tree responsibility
645
3368.2.45 by Ian Clatworthy
add and use supports_content_filtering API
646
    def _content_filter_stack_provider(self):
647
        """A function that returns a stack of ContentFilters.
648
649
        The function takes a path (relative to the top of the tree) and a
650
        file-id as parameters.
651
652
        :return: None if content filtering is not supported by this tree.
653
        """
654
        if self.supports_content_filtering():
655
            return lambda path, file_id: \
656
                    self._content_filter_stack(path, file_id)
657
        else:
658
            return None
659
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
660
    def iter_search_rules(self, path_names, pref_names=None,
4324.4.1 by Marius Kruger
Make it possible to blackboxtest rules
661
        _default_searcher=None):
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
662
        """Find the preferences for filenames in a tree.
663
664
        :param path_names: an iterable of paths to find attributes for.
665
          Paths are given relative to the root of the tree.
666
        :param pref_names: the list of preferences to lookup - None for all
667
        :param _default_searcher: private parameter to assist testing - don't use
668
        :return: an iterator of tuple sequences, one per path-name.
669
          See _RulesSearcher.get_items for details on the tuple sequence.
670
        """
4324.4.1 by Marius Kruger
Make it possible to blackboxtest rules
671
        if _default_searcher is None:
672
            _default_searcher = rules._per_user_searcher
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
673
        searcher = self._get_rules_searcher(_default_searcher)
674
        if searcher is not None:
3398.1.34 by Ian Clatworthy
changed API design as requested by jam during review
675
            if pref_names is not None:
676
                for path in path_names:
677
                    yield searcher.get_selected_items(path, pref_names)
678
            else:
679
                for path in path_names:
680
                    yield searcher.get_items(path)
3398.1.24 by Ian Clatworthy
make iter_search_rules a tree method
681
682
    @needs_read_lock
683
    def _get_rules_searcher(self, default_searcher):
684
        """Get the RulesSearcher for this tree given the default one."""
685
        searcher = default_searcher
686
        return searcher
687
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
688
1 by mbp at sourcefrog
import from baz patch-364
689
######################################################################
690
# diff
691
692
# TODO: Merge these two functions into a single one that can operate
693
# on either a whole tree or a set of files.
694
695
# TODO: Return the diff in order by filename, not by category or in
696
# random order.  Can probably be done by lock-stepping through the
697
# filenames from both trees.
698
699
700
def file_status(filename, old_tree, new_tree):
701
    """Return single-letter status, old and new names for a file.
702
703
    The complexity here is in deciding how to represent renames;
704
    many complex cases are possible.
705
    """
706
    old_inv = old_tree.inventory
707
    new_inv = new_tree.inventory
708
    new_id = new_inv.path2id(filename)
709
    old_id = old_inv.path2id(filename)
710
711
    if not new_id and not old_id:
712
        # easy: doesn't exist in either; not versioned at all
713
        if new_tree.is_ignored(filename):
714
            return 'I', None, None
715
        else:
716
            return '?', None, None
717
    elif new_id:
718
        # There is now a file of this name, great.
719
        pass
720
    else:
721
        # There is no longer a file of this name, but we can describe
722
        # what happened to the file that used to have
723
        # this name.  There are two possibilities: either it was
724
        # deleted entirely, or renamed.
725
        if new_inv.has_id(old_id):
726
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
727
        else:
728
            return 'D', old_inv.id2path(old_id), None
729
730
    # if the file_id is new in this revision, it is added
731
    if new_id and not old_inv.has_id(new_id):
732
        return 'A'
733
734
    # if there used to be a file of this name, but that ID has now
735
    # disappeared, it is deleted
736
    if old_id and not new_inv.has_id(old_id):
737
        return 'D'
738
739
    return 'wtf?'
740
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
741
1551.21.3 by Aaron Bentley
Update deprecation for new version
742
@deprecated_function(deprecated_in((1, 9, 0)))
164 by mbp at sourcefrog
new 'renames' command
743
def find_renames(old_inv, new_inv):
744
    for file_id in old_inv:
745
        if file_id not in new_inv:
746
            continue
747
        old_name = old_inv.id2path(file_id)
748
        new_name = new_inv.id2path(file_id)
749
        if old_name != new_name:
750
            yield (old_name, new_name)
1551.21.1 by Aaron Bentley
Deprecate tree.find_renames
751
678 by Martin Pool
- export to tarballs
752
1551.7.22 by Aaron Bentley
Changes from review
753
def find_ids_across_trees(filenames, trees, require_versioned=True):
754
    """Find the ids corresponding to specified filenames.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
755
1551.7.22 by Aaron Bentley
Changes from review
756
    All matches in all trees will be used, and all children of matched
757
    directories will be used.
758
1551.10.7 by Aaron Bentley
Use new-style output for status
759
    :param filenames: The filenames to find file_ids for (if None, returns
760
        None)
1551.7.22 by Aaron Bentley
Changes from review
761
    :param trees: The trees to find file_ids within
762
    :param require_versioned: if true, all specified filenames must occur in
763
    at least one tree.
764
    :return: a set of file ids for the specified filenames and their children.
765
    """
3363.12.9 by Aaron Bentley
Revert changed select-all test
766
    if not filenames:
1551.7.22 by Aaron Bentley
Changes from review
767
        return None
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
768
    specified_path_ids = _find_ids_across_trees(filenames, trees,
769
        require_versioned)
770
    return _find_children_across_trees(specified_path_ids, trees)
771
772
773
def _find_ids_across_trees(filenames, trees, require_versioned):
1551.7.22 by Aaron Bentley
Changes from review
774
    """Find the ids corresponding to specified filenames.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
775
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
776
    All matches in all trees will be used, but subdirectories are not scanned.
1551.7.22 by Aaron Bentley
Changes from review
777
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
778
    :param filenames: The filenames to find file_ids for
779
    :param trees: The trees to find file_ids within
1551.7.16 by Aaron Bentley
Fix docs
780
    :param require_versioned: if true, all specified filenames must occur in
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
781
        at least one tree.
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
782
    :return: a set of file ids for the specified filenames
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
783
    """
1551.7.17 by Aaron Bentley
Switch to PathsNotVersioned, accept extra_trees
784
    not_versioned = []
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
785
    interesting_ids = set()
786
    for tree_path in filenames:
787
        not_found = True
788
        for tree in trees:
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
789
            file_id = tree.path2id(tree_path)
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
790
            if file_id is not None:
791
                interesting_ids.add(file_id)
792
                not_found = False
793
        if not_found:
794
            not_versioned.append(tree_path)
1551.7.22 by Aaron Bentley
Changes from review
795
    if len(not_versioned) > 0 and require_versioned:
796
        raise errors.PathsNotVersionedError(not_versioned)
797
    return interesting_ids
798
799
800
def _find_children_across_trees(specified_ids, trees):
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
801
    """Return a set including specified ids and their children.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
802
1551.7.22 by Aaron Bentley
Changes from review
803
    All matches in all trees will be used.
804
805
    :param trees: The trees to find file_ids within
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
806
    :return: a set containing all specified ids and their children
1551.7.22 by Aaron Bentley
Changes from review
807
    """
808
    interesting_ids = set(specified_ids)
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
809
    pending = interesting_ids
810
    # now handle children of interesting ids
811
    # we loop so that we handle all children of each id in both trees
812
    while len(pending) > 0:
813
        new_pending = set()
814
        for file_id in pending:
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
815
            for tree in trees:
2292.1.21 by Marius Kruger
undo tree.has_id fake-bugfix, which seems to not be needed anymore..
816
                if not tree.has_id(file_id):
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
817
                    continue
3363.12.2 by Aaron Bentley
Implement tree.iter_children to instead of adjusting InventoryEntry handling
818
                for child_id in tree.iter_children(file_id):
819
                    if child_id not in interesting_ids:
820
                        new_pending.add(child_id)
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
821
        interesting_ids.update(new_pending)
822
        pending = new_pending
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
823
    return interesting_ids
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
824
825
826
class InterTree(InterObject):
827
    """This class represents operations taking place between two Trees.
828
829
    Its instances have methods like 'compare' and contain references to the
830
    source and target trees these operations are to be carried out on.
831
2818.2.1 by Ian Clatworthy
minor tree & dirstate code cleanups
832
    Clients of bzrlib should not need to use InterTree directly, rather they
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
833
    should use the convenience methods on Tree such as 'Tree.compare()' which
834
    will pass through to InterTree as appropriate.
835
    """
836
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
837
    _optimisers = []
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
838
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
839
    @needs_read_lock
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
840
    def compare(self, want_unchanged=False, specific_files=None,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
841
        extra_trees=None, require_versioned=False, include_root=False,
842
        want_unversioned=False):
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
843
        """Return the changes from source to target.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
844
845
        :return: A TreeDelta.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
846
        :param specific_files: An optional list of file paths to restrict the
847
            comparison to. When mapping filenames to ids, all matches in all
848
            trees (including optional extra_trees) are used, and all children of
849
            matched directories are included.
850
        :param want_unchanged: An optional boolean requesting the inclusion of
851
            unchanged entries in the result.
852
        :param extra_trees: An optional list of additional trees to use when
853
            mapping the contents of specific_files (paths) to file_ids.
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
854
        :param require_versioned: An optional boolean (defaults to False). When
855
            supplied and True all the 'specific_files' must be versioned, or
856
            a PathsNotVersionedError will be thrown.
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
857
        :param want_unversioned: Scan for unversioned paths.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
858
        """
2255.2.82 by Robert Collins
various notes about find_ids_across_trees
859
        # NB: show_status depends on being able to pass in non-versioned files
860
        # and report them as unknown
2255.2.105 by Robert Collins
Unfuck InterTree.compare which I broke with the paths2ids implementation.
861
        trees = (self.source,)
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
862
        if extra_trees is not None:
863
            trees = trees + tuple(extra_trees)
2255.2.102 by Robert Collins
Use Tree.path2ids in status operations.
864
        # target is usually the newer tree:
2255.2.105 by Robert Collins
Unfuck InterTree.compare which I broke with the paths2ids implementation.
865
        specific_file_ids = self.target.paths2ids(specific_files, trees,
2255.2.102 by Robert Collins
Use Tree.path2ids in status operations.
866
            require_versioned=require_versioned)
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
867
        if specific_files and not specific_file_ids:
868
            # All files are unversioned, so just return an empty delta
869
            # _compare_trees would think we want a complete delta
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
870
            result = delta.TreeDelta()
2255.7.91 by Robert Collins
Move unknown detection in long status into the delta creation, saving a tree-scan.
871
            fake_entry = InventoryFile('unused', 'unused', 'unused')
872
            result.unversioned = [(path, None,
873
                self.target._comparison_data(fake_entry, path)[0]) for path in
874
                specific_files]
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
875
            return result
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
876
        return delta._compare_trees(self.source, self.target, want_unchanged,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
877
            specific_files, include_root, extra_trees=extra_trees,
2655.2.1 by Marius Kruger
InterTree.compare and delta._compare_trees did not pass its
878
            require_versioned=require_versioned,
2255.7.90 by Robert Collins
Add unversioned path reporting to TreeDelta.
879
            want_unversioned=want_unversioned)
2012.1.1 by Aaron Bentley
Implement change iterator
880
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
881
    def iter_changes(self, include_unchanged=False,
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
882
                      specific_files=None, pb=None, extra_trees=[],
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
883
                      require_versioned=True, want_unversioned=False):
2012.1.1 by Aaron Bentley
Implement change iterator
884
        """Generate an iterator of changes between trees.
885
886
        A tuple is returned:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
887
        (file_id, (path_in_source, path_in_target),
888
         changed_content, versioned, parent, name, kind,
2012.1.1 by Aaron Bentley
Implement change iterator
889
         executable)
890
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
891
        Changed_content is True if the file's content has changed.  This
892
        includes changes to its kind, and to a symlink's target.
2012.1.1 by Aaron Bentley
Implement change iterator
893
2012.1.15 by Aaron Bentley
Minor tweaks
894
        versioned, parent, name, kind, executable are tuples of (from, to).
895
        If a file is missing in a tree, its kind is None.
2012.1.1 by Aaron Bentley
Implement change iterator
896
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
897
        Iteration is done in parent-to-child order, relative to the target
898
        tree.
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
899
900
        There is no guarantee that all paths are in sorted order: the
901
        requirement to expand the search due to renames may result in children
902
        that should be found early being found late in the search, after
903
        lexically later results have been returned.
904
        :param require_versioned: Raise errors.PathsNotVersionedError if a
905
            path in the specific_files list is not versioned in one of
906
            source, target or extra_trees.
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
907
        :param want_unversioned: Should unversioned files be returned in the
908
            output. An unversioned file is defined as one with (False, False)
909
            for the versioned pair.
2012.1.1 by Aaron Bentley
Implement change iterator
910
        """
2255.2.149 by Robert Collins
Crufty but existing _iter_changes implementation for WorkingTreeFormat4.
911
        lookup_trees = [self.source]
912
        if extra_trees:
913
             lookup_trees.extend(extra_trees)
2748.3.1 by Aaron Bentley
Start supporting [] for empty list
914
        if specific_files == []:
915
            specific_file_ids = []
916
        else:
917
            specific_file_ids = self.target.paths2ids(specific_files,
918
                lookup_trees, require_versioned=require_versioned)
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
919
        if want_unversioned:
2748.3.1 by Aaron Bentley
Start supporting [] for empty list
920
            all_unversioned = sorted([(p.split('/'), p) for p in
921
                                     self.target.extras()
922
                if specific_files is None or
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
923
                    osutils.is_inside_any(specific_files, p)])
924
            all_unversioned = deque(all_unversioned)
925
        else:
926
            all_unversioned = deque()
2012.1.1 by Aaron Bentley
Implement change iterator
927
        to_paths = {}
3363.14.2 by Aaron Bentley
Get iter_changes running to completion
928
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
929
            specific_file_ids=specific_file_ids))
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
930
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
3363.14.2 by Aaron Bentley
Get iter_changes running to completion
931
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
932
            specific_file_ids=specific_file_ids))
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
933
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
934
        entry_count = 0
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
935
        # the unversioned path lookup only occurs on real trees - where there
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
936
        # can be extras. So the fake_entry is solely used to look up
937
        # executable it values when execute is not supported.
938
        fake_entry = InventoryFile('unused', 'unused', 'unused')
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
939
        for to_path, to_entry in to_entries_by_dir:
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
940
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
941
                unversioned_path = all_unversioned.popleft()
2255.2.158 by Martin Pool
Most of the integration of dirstate and subtree
942
                to_kind, to_executable, to_stat = \
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
943
                    self.target._comparison_data(fake_entry, unversioned_path[1])
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
944
                yield (None, (None, unversioned_path[1]), True, (False, False),
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
945
                    (None, None),
946
                    (None, unversioned_path[0][-1]),
947
                    (None, to_kind),
948
                    (None, to_executable))
2012.1.1 by Aaron Bentley
Implement change iterator
949
            file_id = to_entry.file_id
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
950
            to_paths[file_id] = to_path
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
951
            entry_count += 1
2012.1.1 by Aaron Bentley
Implement change iterator
952
            changed_content = False
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
953
            from_path, from_entry = from_data.get(file_id, (None, None))
954
            from_versioned = (from_entry is not None)
955
            if from_entry is not None:
956
                from_versioned = True
957
                from_name = from_entry.name
2012.1.1 by Aaron Bentley
Implement change iterator
958
                from_parent = from_entry.parent_id
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
959
                from_kind, from_executable, from_stat = \
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
960
                    self.source._comparison_data(from_entry, from_path)
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
961
                entry_count += 1
2012.1.1 by Aaron Bentley
Implement change iterator
962
            else:
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
963
                from_versioned = False
2012.1.1 by Aaron Bentley
Implement change iterator
964
                from_kind = None
965
                from_parent = None
966
                from_name = None
967
                from_executable = None
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
968
            versioned = (from_versioned, True)
969
            to_kind, to_executable, to_stat = \
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
970
                self.target._comparison_data(to_entry, to_path)
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
971
            kind = (from_kind, to_kind)
972
            if kind[0] != kind[1]:
2012.1.1 by Aaron Bentley
Implement change iterator
973
                changed_content = True
2012.1.2 by Aaron Bentley
reimplement compare_trees
974
            elif from_kind == 'file':
3368.2.1 by Ian Clatworthy
first cut at working tree content filtering
975
                if (self.source.get_file_sha1(file_id, from_path, from_stat) !=
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
976
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
2012.1.2 by Aaron Bentley
reimplement compare_trees
977
                    changed_content = True
978
            elif from_kind == 'symlink':
2255.7.2 by Robert Collins
Add a (currently) disabled test for unversioned paths in the target tree with _iter_changes.
979
                if (self.source.get_symlink_target(file_id) !=
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
980
                    self.target.get_symlink_target(file_id)):
2012.1.2 by Aaron Bentley
reimplement compare_trees
981
                    changed_content = True
4241.1.1 by Ian Clatworthy
tree code cleanups from brisbane-core
982
                # XXX: Yes, the indentation below is wrong. But fixing it broke
983
                # test_merge.TestMergerEntriesLCAOnDisk.
984
                # test_nested_tree_subtree_renamed_and_modified. We'll wait for
985
                # the fix from bzr.dev -- vila 2009026
3735.2.106 by Vincent Ladeuil
Fix one more failing test, waiting for subtrees implementation.
986
                elif from_kind == 'tree-reference':
987
                    if (self.source.get_reference_revision(file_id, from_path)
988
                        != self.target.get_reference_revision(file_id, to_path)):
989
                        changed_content = True
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
990
            parent = (from_parent, to_entry.parent_id)
991
            name = (from_name, to_entry.name)
992
            executable = (from_executable, to_executable)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
993
            if pb is not None:
994
                pb.update('comparing files', entry_count, num_entries)
2255.7.2 by Robert Collins
Add a (currently) disabled test for unversioned paths in the target tree with _iter_changes.
995
            if (changed_content is not False or versioned[0] != versioned[1]
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
996
                or parent[0] != parent[1] or name[0] != name[1] or
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
997
                executable[0] != executable[1] or include_unchanged):
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
998
                yield (file_id, (from_path, to_path), changed_content,
999
                    versioned, parent, name, kind, executable)
1000
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1001
        while all_unversioned:
1002
            # yield any trailing unversioned paths
1003
            unversioned_path = all_unversioned.popleft()
1004
            to_kind, to_executable, to_stat = \
1005
                self.target._comparison_data(fake_entry, unversioned_path[1])
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1006
            yield (None, (None, unversioned_path[1]), True, (False, False),
2255.7.85 by Robert Collins
Teach _iter_changes to gather unversioned path details upon request.
1007
                (None, None),
1008
                (None, unversioned_path[0][-1]),
1009
                (None, to_kind),
1010
                (None, to_executable))
2012.1.1 by Aaron Bentley
Implement change iterator
1011
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1012
        def get_to_path(to_entry):
1013
            if to_entry.parent_id is None:
1014
                to_path = '' # the root
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
1015
            else:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1016
                if to_entry.parent_id not in to_paths:
1017
                    # recurse up
1018
                    return get_to_path(self.target.inventory[to_entry.parent_id])
1019
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
1020
                                           to_entry.name)
1021
            to_paths[to_entry.file_id] = to_path
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
1022
            return to_path
1023
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
1024
        for path, from_entry in from_entries_by_dir:
2012.1.1 by Aaron Bentley
Implement change iterator
1025
            file_id = from_entry.file_id
1026
            if file_id in to_paths:
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1027
                # already returned
2012.1.1 by Aaron Bentley
Implement change iterator
1028
                continue
3363.14.2 by Aaron Bentley
Get iter_changes running to completion
1029
            if not file_id in self.target.all_file_ids():
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1030
                # common case - paths we have not emitted are not present in
1031
                # target.
1032
                to_path = None
1033
            else:
1034
                to_path = get_to_path(self.target.inventory[file_id])
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
1035
            entry_count += 1
1036
            if pb is not None:
1037
                pb.update('comparing files', entry_count, num_entries)
2012.1.1 by Aaron Bentley
Implement change iterator
1038
            versioned = (True, False)
1039
            parent = (from_entry.parent_id, None)
1040
            name = (from_entry.name, None)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
1041
            from_kind, from_executable, stat_value = \
2255.2.122 by Robert Collins
Alter intertree implementation tests to let dirstate inter-trees be correctly parameterised.
1042
                self.source._comparison_data(from_entry, path)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
1043
            kind = (from_kind, None)
2012.1.2 by Aaron Bentley
reimplement compare_trees
1044
            executable = (from_executable, None)
3619.4.1 by Robert Collins
Improve tests for the behaviour of Tree.iter_changes for missing paths that are only present in one tree, and fix found bugs. (Robert Collins)
1045
            changed_content = from_kind is not None
2012.1.1 by Aaron Bentley
Implement change iterator
1046
            # the parent's path is necessarily known at this point.
2255.7.96 by Robert Collins
Change _iter_changes interface to yield both old and new paths.
1047
            yield(file_id, (path, to_path), changed_content, versioned, parent,
2012.1.1 by Aaron Bentley
Implement change iterator
1048
                  name, kind, executable)
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1049
1050
1051
class MultiWalker(object):
1052
    """Walk multiple trees simultaneously, getting combined results."""
1053
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1054
    # Note: This could be written to not assume you can do out-of-order
1055
    #       lookups. Instead any nodes that don't match in all trees could be
1056
    #       marked as 'deferred', and then returned in the final cleanup loop.
1057
    #       For now, I think it is "nicer" to return things as close to the
1058
    #       "master_tree" order as we can.
1059
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1060
    def __init__(self, master_tree, other_trees):
1061
        """Create a new MultiWalker.
1062
1063
        All trees being walked must implement "iter_entries_by_dir()", such
1064
        that they yield (path, object) tuples, where that object will have a
1065
        '.file_id' member, that can be used to check equality.
1066
3514.3.11 by John Arbash Meinel
Cleanups suggested by Ian
1067
        :param master_tree: All trees will be 'slaved' to the master_tree such
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1068
            that nodes in master_tree will be used as 'first-pass' sync points.
1069
            Any nodes that aren't in master_tree will be merged in a second
1070
            pass.
1071
        :param other_trees: A list of other trees to walk simultaneously.
1072
        """
1073
        self._master_tree = master_tree
1074
        self._other_trees = other_trees
1075
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1076
        # Keep track of any nodes that were properly processed just out of
1077
        # order, that way we don't return them at the end, we don't have to
1078
        # track *all* processed file_ids, just the out-of-order ones
1079
        self._out_of_order_processed = set()
1080
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1081
    @staticmethod
1082
    def _step_one(iterator):
1083
        """Step an iter_entries_by_dir iterator.
1084
1085
        :return: (has_more, path, ie)
1086
            If has_more is False, path and ie will be None.
1087
        """
1088
        try:
1089
            path, ie = iterator.next()
1090
        except StopIteration:
1091
            return False, None, None
1092
        else:
1093
            return True, path, ie
1094
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1095
    @staticmethod
1096
    def _cmp_path_by_dirblock(path1, path2):
1097
        """Compare two paths based on what directory they are in.
1098
1099
        This generates a sort order, such that all children of a directory are
1100
        sorted together, and grandchildren are in the same order as the
1101
        children appear. But all grandchildren come after all children.
1102
1103
        :param path1: first path
1104
        :param path2: the second path
1105
        :return: negative number if ``path1`` comes first,
1106
            0 if paths are equal
1107
            and a positive number if ``path2`` sorts first
1108
        """
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1109
        # Shortcut this special case
1110
        if path1 == path2:
1111
            return 0
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1112
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1113
        # Unicode objects. Consider using encode_utf8() and then using the
1114
        # optimized versions, or maybe writing optimized unicode versions.
1115
        if not isinstance(path1, unicode):
1116
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1117
                            % (type(path1), path1))
1118
        if not isinstance(path2, unicode):
1119
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1120
                            % (type(path2), path2))
3514.3.13 by John Arbash Meinel
One code path was using a tuple, another a plain path
1121
        return cmp(MultiWalker._path_to_key(path1),
1122
                   MultiWalker._path_to_key(path2))
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1123
1124
    @staticmethod
3514.3.13 by John Arbash Meinel
One code path was using a tuple, another a plain path
1125
    def _path_to_key(path):
3514.3.11 by John Arbash Meinel
Cleanups suggested by Ian
1126
        dirname, basename = osutils.split(path)
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1127
        return (dirname.split(u'/'), basename)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1128
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1129
    def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1130
        """Lookup an inventory entry by file_id.
1131
1132
        This is called when an entry is missing in the normal order.
1133
        Generally this is because a file was either renamed, or it was
1134
        deleted/added. If the entry was found in the inventory and not in
1135
        extra_entries, it will be added to self._out_of_order_processed
1136
1137
        :param extra_entries: A dictionary of {file_id: (path, ie)}.  This
1138
            should be filled with entries that were found before they were
1139
            used. If file_id is present, it will be removed from the
1140
            dictionary.
1141
        :param other_tree: The Tree to search, in case we didn't find the entry
1142
            yet.
1143
        :param file_id: The file_id to look for
1144
        :return: (path, ie) if found or (None, None) if not present.
1145
        """
1146
        if file_id in extra_entries:
1147
            return extra_entries.pop(file_id)
1148
        # TODO: Is id2path better as the first call, or is
1149
        #       inventory[file_id] better as a first check?
1150
        try:
1151
            cur_path = other_tree.id2path(file_id)
1152
        except errors.NoSuchId:
1153
            cur_path = None
1154
        if cur_path is None:
1155
            return (None, None)
1156
        else:
1157
            self._out_of_order_processed.add(file_id)
1158
            cur_ie = other_tree.inventory[file_id]
1159
            return (cur_path, cur_ie)
1160
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1161
    def iter_all(self):
1162
        """Match up the values in the different trees."""
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1163
        for result in self._walk_master_tree():
1164
            yield result
1165
        self._finish_others()
1166
        for result in self._walk_others():
1167
            yield result
1168
1169
    def _walk_master_tree(self):
1170
        """First pass, walk all trees in lock-step.
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
1171
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1172
        When we are done, all nodes in the master_tree will have been
1173
        processed. _other_walkers, _other_entries, and _others_extra will be
1174
        set on 'self' for future processing.
1175
        """
1176
        # This iterator has the most "inlining" done, because it tends to touch
1177
        # every file in the tree, while the others only hit nodes that don't
1178
        # match.
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1179
        master_iterator = self._master_tree.iter_entries_by_dir()
1180
1181
        other_walkers = [other.iter_entries_by_dir()
1182
                         for other in self._other_trees]
1183
        other_entries = [self._step_one(walker) for walker in other_walkers]
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1184
        # Track extra nodes in the other trees
1185
        others_extra = [{} for i in xrange(len(self._other_trees))]
1186
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1187
        master_has_more = True
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1188
        step_one = self._step_one
1189
        lookup_by_file_id = self._lookup_by_file_id
1190
        out_of_order_processed = self._out_of_order_processed
1191
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1192
        while master_has_more:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1193
            (master_has_more, path, master_ie) = step_one(master_iterator)
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1194
            if not master_has_more:
1195
                break
1196
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1197
            file_id = master_ie.file_id
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1198
            other_values = []
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1199
            other_values_append = other_values.append
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1200
            next_other_entries = []
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1201
            next_other_entries_append = next_other_entries.append
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1202
            for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1203
                if not other_has_more:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1204
                    other_values_append(lookup_by_file_id(
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1205
                        others_extra[idx], self._other_trees[idx], file_id))
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1206
                    next_other_entries_append((False, None, None))
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1207
                elif file_id == other_ie.file_id:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1208
                    # This is the critical code path, as most of the entries
1209
                    # should match between most trees.
1210
                    other_values_append((other_path, other_ie))
1211
                    next_other_entries_append(step_one(other_walkers[idx]))
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1212
                else:
1213
                    # This walker did not match, step it until it either
1214
                    # matches, or we know we are past the current walker.
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1215
                    other_walker = other_walkers[idx]
1216
                    other_extra = others_extra[idx]
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1217
                    while (other_has_more and
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1218
                           self._cmp_path_by_dirblock(other_path, path) < 0):
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1219
                        other_file_id = other_ie.file_id
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1220
                        if other_file_id not in out_of_order_processed:
1221
                            other_extra[other_file_id] = (other_path, other_ie)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1222
                        other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1223
                            step_one(other_walker)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1224
                    if other_has_more and other_ie.file_id == file_id:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1225
                        # We ended up walking to this point, match and step
1226
                        # again
1227
                        other_values_append((other_path, other_ie))
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1228
                        other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1229
                            step_one(other_walker)
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1230
                    else:
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1231
                        # This record isn't in the normal order, see if it
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1232
                        # exists at all.
1233
                        other_values_append(lookup_by_file_id(
1234
                            other_extra, self._other_trees[idx], file_id))
1235
                    next_other_entries_append((other_has_more, other_path,
3514.3.2 by John Arbash Meinel
Handle the case when a record is missing in base
1236
                                               other_ie))
3514.3.1 by John Arbash Meinel
Start working on a special walker that can iterate several trees at once.
1237
            other_entries = next_other_entries
1238
1239
            # We've matched all the walkers, yield this datapoint
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1240
            yield path, file_id, master_ie, other_values
1241
        self._other_walkers = other_walkers
1242
        self._other_entries = other_entries
1243
        self._others_extra = others_extra
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1244
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1245
    def _finish_others(self):
1246
        """Finish walking the other iterators, so we get all entries."""
1247
        for idx, info in enumerate(self._other_entries):
1248
            other_extra = self._others_extra[idx]
1249
            (other_has_more, other_path, other_ie) = info
3514.3.4 by John Arbash Meinel
Handle more cases when the other tree has extra nodes.
1250
            while other_has_more:
1251
                other_file_id = other_ie.file_id
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1252
                if other_file_id not in self._out_of_order_processed:
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1253
                    other_extra[other_file_id] = (other_path, other_ie)
3514.3.4 by John Arbash Meinel
Handle more cases when the other tree has extra nodes.
1254
                other_has_more, other_path, other_ie = \
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1255
                    self._step_one(self._other_walkers[idx])
1256
        del self._other_entries
1257
1258
    def _walk_others(self):
1259
        """Finish up by walking all the 'deferred' nodes."""
1260
        # TODO: One alternative would be to grab all possible unprocessed
1261
        #       file_ids, and then sort by path, and then yield them. That
1262
        #       might ensure better ordering, in case a caller strictly
1263
        #       requires parents before children.
1264
        for idx, other_extra in enumerate(self._others_extra):
3514.3.13 by John Arbash Meinel
One code path was using a tuple, another a plain path
1265
            others = sorted(other_extra.itervalues(),
1266
                            key=lambda x: self._path_to_key(x[0]))
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1267
            for other_path, other_ie in others:
1268
                file_id = other_ie.file_id
3514.3.7 by John Arbash Meinel
comment
1269
                # We don't need to check out_of_order_processed here, because
1270
                # the lookup_by_file_id will be removing anything processed
1271
                # from the extras cache
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1272
                other_extra.pop(file_id)
3514.3.5 by John Arbash Meinel
Handle some edge cases when we have multiple other trees.
1273
                other_values = [(None, None) for i in xrange(idx)]
1274
                other_values.append((other_path, other_ie))
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1275
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1276
                    alt_idx = alt_idx + idx + 1
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1277
                    alt_extra = self._others_extra[alt_idx]
1278
                    alt_tree = self._other_trees[alt_idx]
3514.3.8 by John Arbash Meinel
Start trying to refactor the big function into smaller ones.
1279
                    other_values.append(self._lookup_by_file_id(
3514.3.9 by John Arbash Meinel
Refactor the large function into multiple small ones.
1280
                                            alt_extra, alt_tree, file_id))
3514.3.3 by John Arbash Meinel
Handle when the other tree has extra nodes, and we need to yield them.
1281
                yield other_path, file_id, None, other_values