~bzr-pqm/bzr/bzr.dev

70 by mbp at sourcefrog
Prepare for smart recursive add.
1
# Copyright (C) 2005 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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
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
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
21
from cStringIO import StringIO
800 by Martin Pool
Merge John's import-speedup branch:
22
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
23
import bzrlib
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
24
from bzrlib import (
25
    delta,
2012.1.8 by Aaron Bentley
Merge from bzr.dev
26
    osutils,
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
27
    symbol_versioning,
28
    )
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
29
from bzrlib.decorators import needs_read_lock
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
30
from bzrlib.errors import BzrError, BzrCheckError
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
31
from bzrlib import errors
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
32
from bzrlib.inventory import Inventory
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
33
from bzrlib.inter import InterObject
1732.1.1 by John Arbash Meinel
deprecating appendpath, it does exactly what pathjoin does
34
from bzrlib.osutils import fingerprint_file
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
35
import bzrlib.revision
36
from bzrlib.trace import mutter, note
1 by mbp at sourcefrog
import from baz patch-364
37
1852.5.1 by Robert Collins
Deprecate EmptyTree in favour of using Repository.revision_tree.
38
558 by Martin Pool
- All top-level classes inherit from object
39
class Tree(object):
1 by mbp at sourcefrog
import from baz patch-364
40
    """Abstract file tree.
41
42
    There are several subclasses:
43
    
44
    * `WorkingTree` exists as files on disk editable by the user.
45
46
    * `RevisionTree` is a tree as recorded at some point in the past.
47
48
    Trees contain an `Inventory` object, and also know how to retrieve
49
    file texts mentioned in the inventory, either from a working
50
    directory or from a store.
51
52
    It is possible for trees to contain files that are not described
53
    in their inventory or vice versa; for this use `filenames()`.
54
55
    Trees can be compared, etc, regardless of whether they are working
56
    trees or versioned trees.
57
    """
58
    
1852.9.6 by Robert Collins
Merge the change from Tree.compare to Tree.changes_from.
59
    def changes_from(self, other, want_unchanged=False, specific_files=None,
1731.1.33 by Aaron Bentley
Revert no-special-root changes
60
        extra_trees=None, require_versioned=False, include_root=False):
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
61
        """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.
62
63
        :param other: A tree to compare with.
64
        :param specific_files: An optional list of file paths to restrict the
65
            comparison to. When mapping filenames to ids, all matches in all
66
            trees (including optional extra_trees) are used, and all children of
67
            matched directories are included.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
68
        :param want_unchanged: An optional boolean requesting the inclusion of
69
            unchanged entries in the result.
70
        :param extra_trees: An optional list of additional trees to use when
71
            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.
72
        :param require_versioned: An optional boolean (defaults to False). When
73
            supplied and True all the 'specific_files' must be versioned, or
74
            a PathsNotVersionedError will be thrown.
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
75
1852.8.4 by Robert Collins
Hook InterTree into Tree.
76
        The comparison will be performed by an InterTree object looked up on 
77
        self and other.
78
        """
1852.8.8 by Robert Collins
change Tree.compare to Tree.changes_from - its better for the common case.
79
        # Martin observes that Tree.changes_from returns a TreeDelta and this
80
        # may confuse people, because the class name of the returned object is
81
        # 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.
82
        return InterTree.get(other, self).compare(
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
83
            want_unchanged=want_unchanged,
84
            specific_files=specific_files,
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
85
            extra_trees=extra_trees,
86
            require_versioned=require_versioned,
1731.1.33 by Aaron Bentley
Revert no-special-root changes
87
            include_root=include_root
1852.9.5 by Robert Collins
Add tests for require_versioned to the InterTree.compare() test suite.
88
            )
2012.1.1 by Aaron Bentley
Implement change iterator
89
2012.1.10 by Aaron Bentley
Make iter_changes private, so it can be changed freely
90
    def _iter_changes(self, from_tree, include_unchanged=False, 
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
91
                     specific_file_ids=None, pb=None):
2012.1.5 by Aaron Bentley
Implement specific file id and dangling id handling
92
        intertree = InterTree.get(from_tree, self)
2012.1.10 by Aaron Bentley
Make iter_changes private, so it can be changed freely
93
        return intertree._iter_changes(from_tree, self, include_unchanged, 
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
94
                                       specific_file_ids, pb)
1852.8.4 by Robert Collins
Hook InterTree into Tree.
95
    
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
96
    def conflicts(self):
97
        """Get a list of the conflicts in the tree.
98
99
        Each conflict is an instance of bzrlib.conflicts.Conflict.
100
        """
101
        return []
102
103
    def get_parent_ids(self):
104
        """Get the parent ids for this tree. 
105
106
        :return: a list of parent ids. [] is returned to indicate
107
        a tree with no parents.
108
        :raises: BzrError if the parents are not known.
109
        """
110
        raise NotImplementedError(self.get_parent_ids)
111
    
1 by mbp at sourcefrog
import from baz patch-364
112
    def has_filename(self, filename):
113
        """True if the tree has given filename."""
114
        raise NotImplementedError()
115
1185.12.39 by abentley
Propogated has_or_had_id to Tree
116
    def has_id(self, file_id):
117
        return self.inventory.has_id(file_id)
118
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
119
    __contains__ = has_id
120
1185.12.39 by abentley
Propogated has_or_had_id to Tree
121
    def has_or_had_id(self, file_id):
122
        if file_id == self.inventory.root.file_id:
1185.12.38 by abentley
semi-broke merge
123
            return True
1 by mbp at sourcefrog
import from baz patch-364
124
        return self.inventory.has_id(file_id)
125
462 by Martin Pool
- New form 'file_id in tree' to check if the file is present
126
    def __iter__(self):
127
        return iter(self.inventory)
128
1 by mbp at sourcefrog
import from baz patch-364
129
    def id2path(self, file_id):
130
        return self.inventory.id2path(file_id)
131
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
132
    def is_control_filename(self, filename):
133
        """True if filename is the name of a control file in this tree.
134
        
135
        :param filename: A filename within the tree. This is a relative path
136
        from the root of this tree.
137
138
        This is true IF and ONLY IF the filename is part of the meta data
139
        that bzr controls in this tree. I.E. a random .bzr directory placed
140
        on disk will not be a control file for this tree.
141
        """
142
        return self.bzrdir.is_control_filename(filename)
143
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
144
    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.
145
        """Walk the tree in 'by_dir' order.
146
147
        This will yield each entry in the tree as a (path, entry) tuple. The
148
        order that they are yielded is: the contents of a directory are 
149
        preceeded by the parent of a directory, and all the contents of a 
150
        directory are grouped together.
151
        """
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
152
        return self.inventory.iter_entries_by_dir(
153
            specific_file_ids=specific_file_ids)
1852.6.9 by Robert Collins
Add more test trees to the tree-implementations tests.
154
1465 by Robert Collins
Bugfix the new pull --clobber to not generate spurious conflicts.
155
    def kind(self, file_id):
156
        raise NotImplementedError("subclasses must implement kind")
157
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
158
    def _comparison_data(self, entry, path):
2012.1.15 by Aaron Bentley
Minor tweaks
159
        """Return a tuple of kind, executable, stat_value for a file.
160
161
        entry may be None if there is no inventory entry for the file, but
162
        path must always be supplied.
163
164
        kind is None if there is no file present (even if an inventory id is
165
        present).  executable is False for non-file entries.
166
        """
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
167
        raise NotImplementedError(self._comparison_data)
168
169
    def _file_size(entry, stat_value):
170
        raise NotImplementedError(self._file_size)
171
1 by mbp at sourcefrog
import from baz patch-364
172
    def _get_inventory(self):
173
        return self._inventory
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
174
    
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
175
    def get_file(self, file_id):
176
        """Return a file object for the file file_id in the tree."""
177
        raise NotImplementedError(self.get_file)
178
    
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
179
    def get_file_by_path(self, path):
180
        return self.get_file(self._inventory.path2id(path))
1 by mbp at sourcefrog
import from baz patch-364
181
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
182
    def annotate_iter(self, file_id):
1551.9.18 by Aaron Bentley
Updates from review comments
183
        """Return an iterator of revision_id, line tuples
184
1551.9.16 by Aaron Bentley
Implement Tree.annotate_iter for RevisionTree and WorkingTree
185
        For working trees (and mutable trees in general), the special
186
        revision_id 'current:' will be used for lines that are new in this
187
        tree, e.g. uncommitted changes.
188
        :param file_id: The file to produce an annotated version from
189
        """
190
        raise NotImplementedError(self.annotate_iter)
191
1 by mbp at sourcefrog
import from baz patch-364
192
    inventory = property(_get_inventory,
193
                         doc="Inventory of this Tree")
194
195
    def _check_retrieved(self, ie, f):
1364 by Martin Pool
- remove extra verification of files retrieved from tree
196
        if not __debug__:
197
            return  
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
198
        fp = fingerprint_file(f)
199
        f.seek(0)
200
        
1963.2.6 by Robey Pointer
pychecker is on crack; go back to using 'is None'.
201
        if ie.text_size is not None:
131 by mbp at sourcefrog
check size and sha1 of files retrieved from the tree
202
            if ie.text_size != fp['size']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
203
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
1 by mbp at sourcefrog
import from baz patch-364
204
                        ["inventory expects %d bytes" % ie.text_size,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
205
                         "file is actually %d bytes" % fp['size'],
1 by mbp at sourcefrog
import from baz patch-364
206
                         "store is probably damaged/corrupt"])
207
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
208
        if ie.text_sha1 != fp['sha1']:
694 by Martin Pool
- weed out all remaining calls to bailout() and remove the function
209
            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
210
                    ["inventory expects %s" % ie.text_sha1,
130 by mbp at sourcefrog
- fixup checks on retrieved files to cope with compression,
211
                     "file is actually %s" % fp['sha1'],
1 by mbp at sourcefrog
import from baz patch-364
212
                     "store is probably damaged/corrupt"])
213
1986.1.2 by Robert Collins
Various changes to allow non-workingtree specific tests to run entirely
214
    def path2id(self, path):
215
        """Return the id for path in this tree."""
216
        return self._inventory.path2id(path)
1 by mbp at sourcefrog
import from baz patch-364
217
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
218
    def print_file(self, file_id):
219
        """Print file with id `file_id` to stdout."""
176 by mbp at sourcefrog
New cat command contributed by janmar.
220
        import sys
1196 by Martin Pool
- [WIP] retrieve historical texts from weaves
221
        sys.stdout.write(self.get_file_text(file_id))
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
222
223
    def lock_read(self):
224
        pass
225
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
226
    def unknowns(self):
227
        """What files are present in this tree and unknown.
228
        
229
        :return: an iterator over the unknown files.
230
        """
231
        return iter([])
232
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
233
    def unlock(self):
234
        pass
1658.1.9 by Martin Pool
Give an error for bzr diff on an nonexistent file (Malone #3619)
235
236
    def filter_unversioned_files(self, paths):
237
        """Filter out paths that are not versioned.
238
239
        :return: set of paths.
240
        """
1658.1.10 by Martin Pool
diff on unversiond files should give an error (Malone #3619)
241
        # NB: we specifically *don't* call self.has_filename, because for
242
        # WorkingTrees that can indicate files that exist on disk but that 
243
        # are not versioned.
244
        pred = self.inventory.has_filename
245
        return set((p for p in paths if not pred(p)))
1852.7.1 by Robert Collins
Move RevisionTree out of tree.py.
246
247
1 by mbp at sourcefrog
import from baz patch-364
248
class EmptyTree(Tree):
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
249
974.1.26 by aaron.bentley at utoronto
merged mbp@sourcefrog.net-20050817233101-0939da1cf91f2472
250
    def __init__(self):
1731.1.33 by Aaron Bentley
Revert no-special-root changes
251
        self._inventory = Inventory(root_id=None)
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
252
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
253
                               ' use repository.revision_tree instead.',
254
                               DeprecationWarning, stacklevel=2)
1 by mbp at sourcefrog
import from baz patch-364
255
1773.2.1 by Robert Collins
Teach all trees about unknowns, conflicts and get_parent_ids.
256
    def get_parent_ids(self):
257
        return []
258
1092.2.6 by Robert Collins
symlink support updated to work
259
    def get_symlink_target(self, file_id):
260
        return None
261
1 by mbp at sourcefrog
import from baz patch-364
262
    def has_filename(self, filename):
263
        return False
264
1907.1.4 by Aaron Bentley
Restore RootEntry, but mark it deprecated, restore EmptyTree.kind
265
    def kind(self, file_id):
266
        assert self._inventory[file_id].kind == "directory"
267
        return "directory"
268
1731.1.56 by Aaron Bentley
Fix EmptyTree's default include_root
269
    def list_files(self, include_root=False):
1732.1.14 by John Arbash Meinel
Some speedups by not calling pathjoin()
270
        return iter([])
1 by mbp at sourcefrog
import from baz patch-364
271
    
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
272
    def __contains__(self, file_id):
1711.9.11 by John Arbash Meinel
change return foo in bar to return (foo in bar)
273
        return (file_id in self._inventory)
974.1.12 by aaron.bentley at utoronto
Switched from text-id to hashcache for merge optimization
274
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
275
    def get_file_sha1(self, file_id, path=None, stat_value=None):
974.1.14 by aaron.bentley at utoronto
Fixed bugs in merge optimization
276
        return None
277
278
1 by mbp at sourcefrog
import from baz patch-364
279
######################################################################
280
# diff
281
282
# TODO: Merge these two functions into a single one that can operate
283
# on either a whole tree or a set of files.
284
285
# TODO: Return the diff in order by filename, not by category or in
286
# random order.  Can probably be done by lock-stepping through the
287
# filenames from both trees.
288
289
290
def file_status(filename, old_tree, new_tree):
291
    """Return single-letter status, old and new names for a file.
292
293
    The complexity here is in deciding how to represent renames;
294
    many complex cases are possible.
295
    """
296
    old_inv = old_tree.inventory
297
    new_inv = new_tree.inventory
298
    new_id = new_inv.path2id(filename)
299
    old_id = old_inv.path2id(filename)
300
301
    if not new_id and not old_id:
302
        # easy: doesn't exist in either; not versioned at all
303
        if new_tree.is_ignored(filename):
304
            return 'I', None, None
305
        else:
306
            return '?', None, None
307
    elif new_id:
308
        # There is now a file of this name, great.
309
        pass
310
    else:
311
        # There is no longer a file of this name, but we can describe
312
        # what happened to the file that used to have
313
        # this name.  There are two possibilities: either it was
314
        # deleted entirely, or renamed.
315
        assert old_id
316
        if new_inv.has_id(old_id):
317
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
318
        else:
319
            return 'D', old_inv.id2path(old_id), None
320
321
    # if the file_id is new in this revision, it is added
322
    if new_id and not old_inv.has_id(new_id):
323
        return 'A'
324
325
    # if there used to be a file of this name, but that ID has now
326
    # disappeared, it is deleted
327
    if old_id and not new_inv.has_id(old_id):
328
        return 'D'
329
330
    return 'wtf?'
331
332
    
333
164 by mbp at sourcefrog
new 'renames' command
334
def find_renames(old_inv, new_inv):
335
    for file_id in old_inv:
336
        if file_id not in new_inv:
337
            continue
338
        old_name = old_inv.id2path(file_id)
339
        new_name = new_inv.id2path(file_id)
340
        if old_name != new_name:
341
            yield (old_name, new_name)
342
            
678 by Martin Pool
- export to tarballs
343
1551.7.22 by Aaron Bentley
Changes from review
344
def find_ids_across_trees(filenames, trees, require_versioned=True):
345
    """Find the ids corresponding to specified filenames.
346
    
347
    All matches in all trees will be used, and all children of matched
348
    directories will be used.
349
1551.10.7 by Aaron Bentley
Use new-style output for status
350
    :param filenames: The filenames to find file_ids for (if None, returns
351
        None)
1551.7.22 by Aaron Bentley
Changes from review
352
    :param trees: The trees to find file_ids within
353
    :param require_versioned: if true, all specified filenames must occur in
354
    at least one tree.
355
    :return: a set of file ids for the specified filenames and their children.
356
    """
357
    if not filenames:
358
        return None
359
    specified_ids = _find_filename_ids_across_trees(filenames, trees, 
360
                                                    require_versioned)
361
    return _find_children_across_trees(specified_ids, trees)
362
363
364
def _find_filename_ids_across_trees(filenames, trees, require_versioned):
365
    """Find the ids corresponding to specified filenames.
366
    
367
    All matches in all trees will be used.
368
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
369
    :param filenames: The filenames to find file_ids for
370
    :param trees: The trees to find file_ids within
1551.7.16 by Aaron Bentley
Fix docs
371
    :param require_versioned: if true, all specified filenames must occur in
372
    at least one tree.
373
    :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
374
    """
1551.7.17 by Aaron Bentley
Switch to PathsNotVersioned, accept extra_trees
375
    not_versioned = []
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
376
    interesting_ids = set()
377
    for tree_path in filenames:
378
        not_found = True
379
        for tree in trees:
380
            file_id = tree.inventory.path2id(tree_path)
381
            if file_id is not None:
382
                interesting_ids.add(file_id)
383
                not_found = False
384
        if not_found:
385
            not_versioned.append(tree_path)
1551.7.22 by Aaron Bentley
Changes from review
386
    if len(not_versioned) > 0 and require_versioned:
387
        raise errors.PathsNotVersionedError(not_versioned)
388
    return interesting_ids
389
390
391
def _find_children_across_trees(specified_ids, trees):
392
    """Return a set including specified ids and their children
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
393
    
1551.7.22 by Aaron Bentley
Changes from review
394
    All matches in all trees will be used.
395
396
    :param trees: The trees to find file_ids within
397
    :return: a set containing all specified ids and their children 
398
    """
399
    interesting_ids = set(specified_ids)
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
400
    pending = interesting_ids
401
    # now handle children of interesting ids
402
    # we loop so that we handle all children of each id in both trees
403
    while len(pending) > 0:
404
        new_pending = set()
405
        for file_id in pending:
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
406
            for tree in trees:
1551.7.18 by Aaron Bentley
Indentation and documentation fixes
407
                if file_id not in tree:
408
                    continue
409
                entry = tree.inventory[file_id]
410
                for child in getattr(entry, 'children', {}).itervalues():
411
                    if child.file_id not in interesting_ids:
412
                        new_pending.add(child.file_id)
413
        interesting_ids.update(new_pending)
414
        pending = new_pending
1551.7.14 by Aaron Bentley
Use specified_file_ids instead of is_inside_any in compare_trees
415
    return interesting_ids
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
416
417
418
class InterTree(InterObject):
419
    """This class represents operations taking place between two Trees.
420
421
    Its instances have methods like 'compare' and contain references to the
422
    source and target trees these operations are to be carried out on.
423
424
    clients of bzrlib should not need to use InterTree directly, rather they
425
    should use the convenience methods on Tree such as 'Tree.compare()' which
426
    will pass through to InterTree as appropriate.
427
    """
428
1910.2.15 by Aaron Bentley
Back out inter.get changes, make optimizers an ordered list
429
    _optimisers = []
1852.8.2 by Robert Collins
Add InterTree class to represent InterTree operations.
430
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
431
    @needs_read_lock
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
432
    def compare(self, want_unchanged=False, specific_files=None,
1731.1.33 by Aaron Bentley
Revert no-special-root changes
433
        extra_trees=None, require_versioned=False, include_root=False):
1852.9.3 by Robert Collins
Convert the test_delta tests to intertree_implementation and workingtree_implementation tests as appropriate.
434
        """Return the changes from source to target.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
435
436
        :return: A TreeDelta.
1852.9.4 by Robert Collins
Add minimal test for Tree.compare(extra_trees=...).
437
        :param specific_files: An optional list of file paths to restrict the
438
            comparison to. When mapping filenames to ids, all matches in all
439
            trees (including optional extra_trees) are used, and all children of
440
            matched directories are included.
441
        :param want_unchanged: An optional boolean requesting the inclusion of
442
            unchanged entries in the result.
443
        :param extra_trees: An optional list of additional trees to use when
444
            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.
445
        :param require_versioned: An optional boolean (defaults to False). When
446
            supplied and True all the 'specific_files' must be versioned, or
447
            a PathsNotVersionedError will be thrown.
1852.8.3 by Robert Collins
Implement an InterTreeTestProvider and a trivial test_compare test case.
448
        """
1852.11.1 by Robert Collins
Deprecate compare_trees and move its body to InterTree.changes_from.
449
        # NB: show_status depends on being able to pass in non-versioned files and
450
        # report them as unknown
451
        trees = (self.source, self.target)
452
        if extra_trees is not None:
453
            trees = trees + tuple(extra_trees)
454
        specific_file_ids = find_ids_across_trees(specific_files,
455
            trees, require_versioned=require_versioned)
456
        if specific_files and not specific_file_ids:
457
            # All files are unversioned, so just return an empty delta
458
            # _compare_trees would think we want a complete delta
459
            return delta.TreeDelta()
460
        return delta._compare_trees(self.source, self.target, want_unchanged,
1910.2.56 by Aaron Bentley
More work on bundles
461
            specific_file_ids, include_root)
2012.1.1 by Aaron Bentley
Implement change iterator
462
2012.1.10 by Aaron Bentley
Make iter_changes private, so it can be changed freely
463
    def _iter_changes(self, from_tree, to_tree, include_unchanged, 
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
464
                      specific_file_ids, pb):
2012.1.1 by Aaron Bentley
Implement change iterator
465
        """Generate an iterator of changes between trees.
466
467
        A tuple is returned:
468
        (file_id, path, changed_content, versioned, parent, name, kind,
469
         executable)
470
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
471
        Path is relative to the to_tree.  changed_content is True if the file's
472
        content has changed.  This includes changes to its kind, and to
473
        a symlink's target.
2012.1.1 by Aaron Bentley
Implement change iterator
474
2012.1.15 by Aaron Bentley
Minor tweaks
475
        versioned, parent, name, kind, executable are tuples of (from, to).
476
        If a file is missing in a tree, its kind is None.
2012.1.1 by Aaron Bentley
Implement change iterator
477
478
        Iteration is done in parent-to-child order, relative to the to_tree.
479
        """
480
        to_paths = {}
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
481
        from_entries_by_dir = list(from_tree.inventory.iter_entries_by_dir(
482
            specific_file_ids=specific_file_ids))
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
483
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
484
        to_entries_by_dir = list(to_tree.inventory.iter_entries_by_dir(
485
            specific_file_ids=specific_file_ids))
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
486
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
487
        entry_count = 0
488
        for to_path, to_entry in to_entries_by_dir:
2012.1.1 by Aaron Bentley
Implement change iterator
489
            file_id = to_entry.file_id
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
490
            to_paths[file_id] = to_path
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
491
            entry_count += 1
2012.1.1 by Aaron Bentley
Implement change iterator
492
            changed_content = False
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
493
            from_path, from_entry = from_data.get(file_id, (None, None))
494
            from_versioned = (from_entry is not None)
495
            if from_entry is not None:
496
                from_versioned = True
497
                from_name = from_entry.name
2012.1.1 by Aaron Bentley
Implement change iterator
498
                from_parent = from_entry.parent_id
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
499
                from_kind, from_executable, from_stat = \
500
                    from_tree._comparison_data(from_entry, from_path)
1551.9.29 by Aaron Bentley
Optimize Tree._iter_changes with specific file_ids
501
                entry_count += 1
2012.1.1 by Aaron Bentley
Implement change iterator
502
            else:
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
503
                from_versioned = False
2012.1.1 by Aaron Bentley
Implement change iterator
504
                from_kind = None
505
                from_parent = None
506
                from_name = None
507
                from_executable = None
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
508
            versioned = (from_versioned, True)
509
            to_kind, to_executable, to_stat = \
510
                to_tree._comparison_data(to_entry, to_path)
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
511
            kind = (from_kind, to_kind)
512
            if kind[0] != kind[1]:
2012.1.1 by Aaron Bentley
Implement change iterator
513
                changed_content = True
2012.1.2 by Aaron Bentley
reimplement compare_trees
514
            elif from_kind == 'file':
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
515
                from_size = from_tree._file_size(from_entry, from_stat)
516
                to_size = to_tree._file_size(to_entry, to_stat)
517
                if from_size != to_size:
518
                    changed_content = True
519
                elif (from_tree.get_file_sha1(file_id, from_path, from_stat) !=
520
                    to_tree.get_file_sha1(file_id, to_path, to_stat)):
2012.1.2 by Aaron Bentley
reimplement compare_trees
521
                    changed_content = True
522
            elif from_kind == 'symlink':
523
                if (from_tree.get_symlink_target(file_id) != 
524
                    to_tree.get_symlink_target(file_id)):
525
                    changed_content = True
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
526
            parent = (from_parent, to_entry.parent_id)
527
            name = (from_name, to_entry.name)
528
            executable = (from_executable, to_executable)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
529
            if pb is not None:
530
                pb.update('comparing files', entry_count, num_entries)
2012.1.3 by Aaron Bentley
Always generate tuples (because kind is always used, even when not different)
531
            if (changed_content is not False or versioned[0] != versioned[1] 
532
                or parent[0] != parent[1] or name[0] != name[1] or 
533
                executable[0] != executable[1] or include_unchanged):
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
534
                yield (file_id, to_path, changed_content, versioned, parent,
2012.1.1 by Aaron Bentley
Implement change iterator
535
                       name, kind, executable)
536
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
537
        def get_to_path(from_entry):
538
            if from_entry.parent_id is None:
539
                to_path = ''
540
            else:
541
                if from_entry.parent_id not in to_paths:
542
                    get_to_path(from_tree.inventory[from_entry.parent_id])
543
                to_path = osutils.pathjoin(to_paths[from_entry.parent_id],
544
                                           from_entry.name)
545
            to_paths[from_entry.file_id] = to_path
546
            return to_path
547
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
548
        for path, from_entry in from_entries_by_dir:
2012.1.1 by Aaron Bentley
Implement change iterator
549
            file_id = from_entry.file_id
550
            if file_id in to_paths:
551
                continue
1551.9.31 by Aaron Bentley
Handle to_paths correctly when parent of file is not in specified_ids
552
            to_path = get_to_path(from_entry)
2012.1.16 by Aaron Bentley
Support progress bars in iter_changes
553
            entry_count += 1
554
            if pb is not None:
555
                pb.update('comparing files', entry_count, num_entries)
2012.1.1 by Aaron Bentley
Implement change iterator
556
            versioned = (True, False)
557
            parent = (from_entry.parent_id, None)
558
            name = (from_entry.name, None)
2012.1.7 by Aaron Bentley
Get tree._iter_changed down to ~ 1 stat per file
559
            from_kind, from_executable, stat_value = \
560
                from_tree._comparison_data(from_entry, path)
561
            kind = (from_kind, None)
2012.1.2 by Aaron Bentley
reimplement compare_trees
562
            executable = (from_executable, None)
2012.1.1 by Aaron Bentley
Implement change iterator
563
            changed_content = True
564
            # the parent's path is necessarily known at this point.
565
            yield(file_id, to_path, changed_content, versioned, parent,
566
                  name, kind, executable)
2012.1.8 by Aaron Bentley
Merge from bzr.dev
567
2079.1.1 by John Arbash Meinel
Create a deprecated bzrlib.tree.RevisionTree() in favor of bzrlib.revisiontree.RevisionTree()
568
569
# This was deprecated before 0.12, but did not have an official warning
570
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
571
def RevisionTree(*args, **kwargs):
572
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
573
574
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
575
    bzr 0.12.
576
    """
577
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
578
    return _RevisionTree(*args, **kwargs)
579
 
580