~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

(John Arbash Meinel) Fix bug #162486,
        RemoteBranch should initialize self._revision_id_to_revno_map

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
# Copyright (C) 2005 Canonical Ltd
2
 
 
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
18
"""
19
19
 
20
20
import os
 
21
from collections import deque
21
22
from cStringIO import StringIO
22
23
 
23
24
import bzrlib
 
25
from bzrlib import (
 
26
    delta,
 
27
    osutils,
 
28
    revision as _mod_revision,
 
29
    conflicts as _mod_conflicts,
 
30
    symbol_versioning,
 
31
    )
 
32
from bzrlib.decorators import needs_read_lock
 
33
from bzrlib.errors import BzrError, BzrCheckError
 
34
from bzrlib import errors
 
35
from bzrlib.inventory import Inventory, InventoryFile
 
36
from bzrlib.inter import InterObject
 
37
from bzrlib.osutils import fingerprint_file
 
38
import bzrlib.revision
24
39
from bzrlib.trace import mutter, note
25
 
from bzrlib.errors import BzrError, BzrCheckError
26
 
from bzrlib.inventory import Inventory
27
 
from bzrlib.osutils import appendpath, fingerprint_file
 
40
 
28
41
 
29
42
class Tree(object):
30
43
    """Abstract file tree.
35
48
 
36
49
    * `RevisionTree` is a tree as recorded at some point in the past.
37
50
 
38
 
    * `EmptyTree`
39
 
 
40
51
    Trees contain an `Inventory` object, and also know how to retrieve
41
52
    file texts mentioned in the inventory, either from a working
42
53
    directory or from a store.
48
59
    trees or versioned trees.
49
60
    """
50
61
    
 
62
    def changes_from(self, other, want_unchanged=False, specific_files=None,
 
63
        extra_trees=None, require_versioned=False, include_root=False,
 
64
        want_unversioned=False):
 
65
        """Return a TreeDelta of the changes from other to this tree.
 
66
 
 
67
        :param other: A tree to compare with.
 
68
        :param specific_files: An optional list of file paths to restrict the
 
69
            comparison to. When mapping filenames to ids, all matches in all
 
70
            trees (including optional extra_trees) are used, and all children of
 
71
            matched directories are included.
 
72
        :param want_unchanged: An optional boolean requesting the inclusion of
 
73
            unchanged entries in the result.
 
74
        :param extra_trees: An optional list of additional trees to use when
 
75
            mapping the contents of specific_files (paths) to file_ids.
 
76
        :param require_versioned: An optional boolean (defaults to False). When
 
77
            supplied and True all the 'specific_files' must be versioned, or
 
78
            a PathsNotVersionedError will be thrown.
 
79
        :param want_unversioned: Scan for unversioned paths.
 
80
 
 
81
        The comparison will be performed by an InterTree object looked up on 
 
82
        self and other.
 
83
        """
 
84
        # Martin observes that Tree.changes_from returns a TreeDelta and this
 
85
        # may confuse people, because the class name of the returned object is
 
86
        # a synonym of the object referenced in the method name.
 
87
        return InterTree.get(other, self).compare(
 
88
            want_unchanged=want_unchanged,
 
89
            specific_files=specific_files,
 
90
            extra_trees=extra_trees,
 
91
            require_versioned=require_versioned,
 
92
            include_root=include_root,
 
93
            want_unversioned=want_unversioned,
 
94
            )
 
95
 
 
96
    def _iter_changes(self, from_tree, include_unchanged=False,
 
97
                     specific_files=None, pb=None, extra_trees=None,
 
98
                     require_versioned=True, want_unversioned=False):
 
99
        intertree = InterTree.get(from_tree, self)
 
100
        return intertree._iter_changes(include_unchanged, specific_files, pb,
 
101
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
102
    
 
103
    def conflicts(self):
 
104
        """Get a list of the conflicts in the tree.
 
105
 
 
106
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
107
        """
 
108
        return _mod_conflicts.ConflictList()
 
109
 
 
110
    def extras(self):
 
111
        """For trees that can have unversioned files, return all such paths."""
 
112
        return []
 
113
 
 
114
    def get_parent_ids(self):
 
115
        """Get the parent ids for this tree. 
 
116
 
 
117
        :return: a list of parent ids. [] is returned to indicate
 
118
        a tree with no parents.
 
119
        :raises: BzrError if the parents are not known.
 
120
        """
 
121
        raise NotImplementedError(self.get_parent_ids)
 
122
    
51
123
    def has_filename(self, filename):
52
124
        """True if the tree has given filename."""
53
 
        raise NotImplementedError()
 
125
        raise NotImplementedError(self.has_filename)
54
126
 
55
127
    def has_id(self, file_id):
56
128
        return self.inventory.has_id(file_id)
57
129
 
 
130
    __contains__ = has_id
 
131
 
58
132
    def has_or_had_id(self, file_id):
59
133
        if file_id == self.inventory.root.file_id:
60
134
            return True
61
135
        return self.inventory.has_id(file_id)
62
136
 
63
 
    __contains__ = has_id
 
137
    def is_ignored(self, filename):
 
138
        """Check whether the filename is ignored by this tree.
 
139
 
 
140
        :param filename: The relative filename within the tree.
 
141
        :return: True if the filename is ignored.
 
142
        """
 
143
        return False
64
144
 
65
145
    def __iter__(self):
66
146
        return iter(self.inventory)
67
147
 
68
148
    def id2path(self, file_id):
 
149
        """Return the path for a file id.
 
150
 
 
151
        :raises NoSuchId:
 
152
        """
69
153
        return self.inventory.id2path(file_id)
70
154
 
 
155
    def is_control_filename(self, filename):
 
156
        """True if filename is the name of a control file in this tree.
 
157
        
 
158
        :param filename: A filename within the tree. This is a relative path
 
159
        from the root of this tree.
 
160
 
 
161
        This is true IF and ONLY IF the filename is part of the meta data
 
162
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
163
        on disk will not be a control file for this tree.
 
164
        """
 
165
        return self.bzrdir.is_control_filename(filename)
 
166
 
 
167
    @needs_read_lock
 
168
    def iter_entries_by_dir(self, specific_file_ids=None):
 
169
        """Walk the tree in 'by_dir' order.
 
170
 
 
171
        This will yield each entry in the tree as a (path, entry) tuple. The
 
172
        order that they are yielded is: the contents of a directory are 
 
173
        preceeded by the parent of a directory, and all the contents of a 
 
174
        directory are grouped together.
 
175
        """
 
176
        return self.inventory.iter_entries_by_dir(
 
177
            specific_file_ids=specific_file_ids)
 
178
 
 
179
    def iter_references(self):
 
180
        for path, entry in self.iter_entries_by_dir():
 
181
            if entry.kind == 'tree-reference':
 
182
                yield path, entry.file_id
 
183
 
71
184
    def kind(self, file_id):
72
 
        raise NotImplementedError("subclasses must implement kind")
 
185
        raise NotImplementedError("Tree subclass %s must implement kind"
 
186
            % self.__class__.__name__)
 
187
 
 
188
    def path_content_summary(self, path):
 
189
        """Get a summary of the information about path.
 
190
        
 
191
        :param path: A relative path within the tree.
 
192
        :return: A tuple containing kind, size, exec, sha1-or-link.
 
193
            Kind is always present (see tree.kind()).
 
194
            size is present if kind is file, None otherwise.
 
195
            exec is None unless kind is file and the platform supports the 'x'
 
196
                bit.
 
197
            sha1-or-link is the link target if kind is symlink, or the sha1 if
 
198
                it can be obtained without reading the file.
 
199
        """
 
200
        raise NotImplementedError(self.path_content_summary)
 
201
 
 
202
    def get_reference_revision(self, file_id, path=None):
 
203
        raise NotImplementedError("Tree subclass %s must implement "
 
204
                                  "get_reference_revision"
 
205
            % self.__class__.__name__)
 
206
 
 
207
    def _comparison_data(self, entry, path):
 
208
        """Return a tuple of kind, executable, stat_value for a file.
 
209
 
 
210
        entry may be None if there is no inventory entry for the file, but
 
211
        path must always be supplied.
 
212
 
 
213
        kind is None if there is no file present (even if an inventory id is
 
214
        present).  executable is False for non-file entries.
 
215
        """
 
216
        raise NotImplementedError(self._comparison_data)
 
217
 
 
218
    def _file_size(self, entry, stat_value):
 
219
        raise NotImplementedError(self._file_size)
73
220
 
74
221
    def _get_inventory(self):
75
222
        return self._inventory
76
223
    
 
224
    def get_file(self, file_id, path=None):
 
225
        """Return a file object for the file file_id in the tree.
 
226
        
 
227
        If both file_id and path are defined, it is implementation defined as
 
228
        to which one is used.
 
229
        """
 
230
        raise NotImplementedError(self.get_file)
 
231
 
 
232
    def get_file_mtime(self, file_id, path=None):
 
233
        """Return the modification time for a file.
 
234
 
 
235
        :param file_id: The handle for this file.
 
236
        :param path: The path that this file can be found at.
 
237
            These must point to the same object.
 
238
        """
 
239
        raise NotImplementedError(self.get_file_mtime)
 
240
 
77
241
    def get_file_by_path(self, path):
78
 
        return self.get_file(self._inventory.path2id(path))
 
242
        return self.get_file(self._inventory.path2id(path), path)
 
243
 
 
244
    def iter_files_bytes(self, desired_files):
 
245
        """Iterate through file contents.
 
246
 
 
247
        Files will not necessarily be returned in the order they occur in
 
248
        desired_files.  No specific order is guaranteed.
 
249
 
 
250
        Yields pairs of identifier, bytes_iterator.  identifier is an opaque
 
251
        value supplied by the caller as part of desired_files.  It should
 
252
        uniquely identify the file version in the caller's context.  (Examples:
 
253
        an index number or a TreeTransform trans_id.)
 
254
 
 
255
        bytes_iterator is an iterable of bytestrings for the file.  The
 
256
        kind of iterable and length of the bytestrings are unspecified, but for
 
257
        this implementation, it is a tuple containing a single bytestring with
 
258
        the complete text of the file.
 
259
 
 
260
        :param desired_files: a list of (file_id, identifier) pairs
 
261
        """
 
262
        for file_id, identifier in desired_files:
 
263
            # We wrap the string in a tuple so that we can return an iterable
 
264
            # of bytestrings.  (Technically, a bytestring is also an iterable
 
265
            # of bytestrings, but iterating through each character is not
 
266
            # performant.)
 
267
            cur_file = (self.get_file_text(file_id),)
 
268
            yield identifier, cur_file
 
269
 
 
270
    def get_symlink_target(self, file_id):
 
271
        """Get the target for a given file_id.
 
272
 
 
273
        It is assumed that the caller already knows that file_id is referencing
 
274
        a symlink.
 
275
        :param file_id: Handle for the symlink entry.
 
276
        :return: The path the symlink points to.
 
277
        """
 
278
        raise NotImplementedError(self.get_symlink_target)
 
279
 
 
280
    def get_root_id(self):
 
281
        """Return the file_id for the root of this tree."""
 
282
        raise NotImplementedError(self.get_root_id)
 
283
 
 
284
    def annotate_iter(self, file_id):
 
285
        """Return an iterator of revision_id, line tuples.
 
286
 
 
287
        For working trees (and mutable trees in general), the special
 
288
        revision_id 'current:' will be used for lines that are new in this
 
289
        tree, e.g. uncommitted changes.
 
290
        :param file_id: The file to produce an annotated version from
 
291
        """
 
292
        raise NotImplementedError(self.annotate_iter)
 
293
 
 
294
    def plan_file_merge(self, file_id, other):
 
295
        """Generate a merge plan based on annotations.
 
296
 
 
297
        If the file contains uncommitted changes in this tree, they will be
 
298
        attributed to the 'current:' pseudo-revision.  If the file contains
 
299
        uncommitted changes in the other tree, they will be assigned to the
 
300
        'other:' pseudo-revision.
 
301
        """
 
302
        from bzrlib import merge
 
303
        annotated_a = list(self.annotate_iter(file_id,
 
304
                                              _mod_revision.CURRENT_REVISION))
 
305
        annotated_b = list(other.annotate_iter(file_id, 'other:'))
 
306
        ancestors_a = self._get_ancestors(_mod_revision.CURRENT_REVISION)
 
307
        ancestors_b = other._get_ancestors('other:')
 
308
        return merge._plan_annotate_merge(annotated_a, annotated_b,
 
309
                                          ancestors_a, ancestors_b)
79
310
 
80
311
    inventory = property(_get_inventory,
81
312
                         doc="Inventory of this Tree")
86
317
        fp = fingerprint_file(f)
87
318
        f.seek(0)
88
319
        
89
 
        if ie.text_size != None:
 
320
        if ie.text_size is not None:
90
321
            if ie.text_size != fp['size']:
91
322
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
92
323
                        ["inventory expects %d bytes" % ie.text_size,
99
330
                     "file is actually %s" % fp['sha1'],
100
331
                     "store is probably damaged/corrupt"])
101
332
 
 
333
    @needs_read_lock
 
334
    def path2id(self, path):
 
335
        """Return the id for path in this tree."""
 
336
        return self._inventory.path2id(path)
 
337
 
 
338
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
339
        """Return all the ids that can be reached by walking from paths.
 
340
        
 
341
        Each path is looked up in this tree and any extras provided in
 
342
        trees, and this is repeated recursively: the children in an extra tree
 
343
        of a directory that has been renamed under a provided path in this tree
 
344
        are all returned, even if none exist under a provided path in this
 
345
        tree, and vice versa.
 
346
 
 
347
        :param paths: An iterable of paths to start converting to ids from.
 
348
            Alternatively, if paths is None, no ids should be calculated and None
 
349
            will be returned. This is offered to make calling the api unconditional
 
350
            for code that *might* take a list of files.
 
351
        :param trees: Additional trees to consider.
 
352
        :param require_versioned: If False, do not raise NotVersionedError if
 
353
            an element of paths is not versioned in this tree and all of trees.
 
354
        """
 
355
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
102
356
 
103
357
    def print_file(self, file_id):
104
358
        """Print file with id `file_id` to stdout."""
105
359
        import sys
106
360
        sys.stdout.write(self.get_file_text(file_id))
107
 
        
108
 
        
109
 
class RevisionTree(Tree):
110
 
    """Tree viewing a previous revision.
111
 
 
112
 
    File text can be retrieved from the text store.
113
 
 
114
 
    TODO: Some kind of `__repr__` method, but a good one
115
 
           probably means knowing the branch and revision number,
116
 
           or at least passing a description to the constructor.
117
 
    """
118
 
    
119
 
    def __init__(self, branch, inv, revision_id):
120
 
        self._branch = branch
121
 
        self._weave_store = branch.weave_store
122
 
        self._inventory = inv
123
 
        self._revision_id = revision_id
124
 
 
125
 
    def get_weave(self, file_id):
126
 
        import bzrlib.transactions as transactions
127
 
        return self._weave_store.get_weave(file_id,
128
 
                self._branch.get_transaction())
129
 
 
130
 
    def get_weave_prelude(self, file_id):
131
 
        import bzrlib.transactions as transactions
132
 
        return self._weave_store.get_weave_prelude(file_id,
133
 
                self._branch.get_transaction())
134
 
 
135
 
    def get_file_lines(self, file_id):
136
 
        ie = self._inventory[file_id]
137
 
        weave = self.get_weave(file_id)
138
 
        return weave.get(ie.revision)
139
 
 
140
 
    def get_file_text(self, file_id):
141
 
        return ''.join(self.get_file_lines(file_id))
142
 
 
143
 
    def get_file(self, file_id):
144
 
        return StringIO(self.get_file_text(file_id))
145
 
 
146
 
    def get_file_size(self, file_id):
147
 
        return self._inventory[file_id].text_size
148
 
 
149
 
    def get_file_sha1(self, file_id):
150
 
        ie = self._inventory[file_id]
151
 
        if ie.kind == "file":
152
 
            return ie.text_sha1
153
 
 
154
 
    def is_executable(self, file_id):
155
 
        ie = self._inventory[file_id]
156
 
        if ie.kind != "file":
157
 
            return None 
158
 
        return self._inventory[file_id].executable
159
 
 
160
 
    def has_filename(self, filename):
161
 
        return bool(self.inventory.path2id(filename))
162
 
 
163
 
    def list_files(self):
164
 
        # The only files returned by this are those from the version
165
 
        for path, entry in self.inventory.iter_entries():
166
 
            yield path, 'V', entry.kind, entry.file_id, entry
167
 
 
168
 
    def get_symlink_target(self, file_id):
169
 
        ie = self._inventory[file_id]
170
 
        return ie.symlink_target;
171
 
 
172
 
    def kind(self, file_id):
173
 
        return self._inventory[file_id].kind
 
361
 
 
362
    def lock_read(self):
 
363
        pass
 
364
 
 
365
    def revision_tree(self, revision_id):
 
366
        """Obtain a revision tree for the revision revision_id.
 
367
 
 
368
        The intention of this method is to allow access to possibly cached
 
369
        tree data. Implementors of this method should raise NoSuchRevision if
 
370
        the tree is not locally available, even if they could obtain the 
 
371
        tree via a repository or some other means. Callers are responsible 
 
372
        for finding the ultimate source for a revision tree.
 
373
 
 
374
        :param revision_id: The revision_id of the requested tree.
 
375
        :return: A Tree.
 
376
        :raises: NoSuchRevision if the tree cannot be obtained.
 
377
        """
 
378
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
379
 
 
380
    def unknowns(self):
 
381
        """What files are present in this tree and unknown.
 
382
        
 
383
        :return: an iterator over the unknown files.
 
384
        """
 
385
        return iter([])
 
386
 
 
387
    def unlock(self):
 
388
        pass
 
389
 
 
390
    def filter_unversioned_files(self, paths):
 
391
        """Filter out paths that are versioned.
 
392
 
 
393
        :return: set of paths.
 
394
        """
 
395
        # NB: we specifically *don't* call self.has_filename, because for
 
396
        # WorkingTrees that can indicate files that exist on disk but that 
 
397
        # are not versioned.
 
398
        pred = self.inventory.has_filename
 
399
        return set((p for p in paths if not pred(p)))
 
400
 
 
401
    def walkdirs(self, prefix=""):
 
402
        """Walk the contents of this tree from path down.
 
403
 
 
404
        This yields all the data about the contents of a directory at a time.
 
405
        After each directory has been yielded, if the caller has mutated the
 
406
        list to exclude some directories, they are then not descended into.
 
407
        
 
408
        The data yielded is of the form:
 
409
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
410
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
411
          versioned_kind), ...]),
 
412
         - directory-relpath is the containing dirs relpath from prefix
 
413
         - directory-path-from-root is the containing dirs path from /
 
414
         - directory-fileid is the id of the directory if it is versioned.
 
415
         - relpath is the relative path within the subtree being walked.
 
416
         - basename is the basename
 
417
         - kind is the kind of the file now. If unknonwn then the file is not
 
418
           present within the tree - but it may be recorded as versioned. See
 
419
           versioned_kind.
 
420
         - lstat is the stat data *if* the file was statted.
 
421
         - path_from_tree_root is the path from the root of the tree.
 
422
         - file_id is the file_id if the entry is versioned.
 
423
         - versioned_kind is the kind of the file as last recorded in the 
 
424
           versioning system. If 'unknown' the file is not versioned.
 
425
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
426
 
 
427
        :param prefix: Start walking from prefix within the tree rather than
 
428
        at the root. This allows one to walk a subtree but get paths that are
 
429
        relative to a tree rooted higher up.
 
430
        :return: an iterator over the directory data.
 
431
        """
 
432
        raise NotImplementedError(self.walkdirs)
174
433
 
175
434
 
176
435
class EmptyTree(Tree):
 
436
 
177
437
    def __init__(self):
178
 
        self._inventory = Inventory()
 
438
        self._inventory = Inventory(root_id=None)
 
439
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
440
                               ' use repository.revision_tree instead.',
 
441
                               DeprecationWarning, stacklevel=2)
 
442
 
 
443
    def get_parent_ids(self):
 
444
        return []
179
445
 
180
446
    def get_symlink_target(self, file_id):
181
447
        return None
184
450
        return False
185
451
 
186
452
    def kind(self, file_id):
187
 
        assert self._inventory[file_id].kind == "root_directory"
188
 
        return "root_directory"
 
453
        assert self._inventory[file_id].kind == "directory"
 
454
        return "directory"
189
455
 
190
 
    def list_files(self):
 
456
    def list_files(self, include_root=False):
191
457
        return iter([])
192
458
    
193
459
    def __contains__(self, file_id):
194
 
        return file_id in self._inventory
 
460
        return (file_id in self._inventory)
195
461
 
196
 
    def get_file_sha1(self, file_id):
197
 
        assert self._inventory[file_id].kind == "root_directory"
 
462
    def get_file_sha1(self, file_id, path=None, stat_value=None):
198
463
        return None
199
464
 
200
465
 
263
528
            yield (old_name, new_name)
264
529
            
265
530
 
 
531
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
532
    """Find the ids corresponding to specified filenames.
 
533
    
 
534
    All matches in all trees will be used, and all children of matched
 
535
    directories will be used.
 
536
 
 
537
    :param filenames: The filenames to find file_ids for (if None, returns
 
538
        None)
 
539
    :param trees: The trees to find file_ids within
 
540
    :param require_versioned: if true, all specified filenames must occur in
 
541
    at least one tree.
 
542
    :return: a set of file ids for the specified filenames and their children.
 
543
    """
 
544
    if not filenames:
 
545
        return None
 
546
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
547
        require_versioned)
 
548
    return _find_children_across_trees(specified_path_ids, trees)
 
549
 
 
550
 
 
551
def _find_ids_across_trees(filenames, trees, require_versioned):
 
552
    """Find the ids corresponding to specified filenames.
 
553
    
 
554
    All matches in all trees will be used, but subdirectories are not scanned.
 
555
 
 
556
    :param filenames: The filenames to find file_ids for
 
557
    :param trees: The trees to find file_ids within
 
558
    :param require_versioned: if true, all specified filenames must occur in
 
559
        at least one tree.
 
560
    :return: a set of file ids for the specified filenames
 
561
    """
 
562
    not_versioned = []
 
563
    interesting_ids = set()
 
564
    for tree_path in filenames:
 
565
        not_found = True
 
566
        for tree in trees:
 
567
            file_id = tree.path2id(tree_path)
 
568
            if file_id is not None:
 
569
                interesting_ids.add(file_id)
 
570
                not_found = False
 
571
        if not_found:
 
572
            not_versioned.append(tree_path)
 
573
    if len(not_versioned) > 0 and require_versioned:
 
574
        raise errors.PathsNotVersionedError(not_versioned)
 
575
    return interesting_ids
 
576
 
 
577
 
 
578
def _find_children_across_trees(specified_ids, trees):
 
579
    """Return a set including specified ids and their children.
 
580
    
 
581
    All matches in all trees will be used.
 
582
 
 
583
    :param trees: The trees to find file_ids within
 
584
    :return: a set containing all specified ids and their children 
 
585
    """
 
586
    interesting_ids = set(specified_ids)
 
587
    pending = interesting_ids
 
588
    # now handle children of interesting ids
 
589
    # we loop so that we handle all children of each id in both trees
 
590
    while len(pending) > 0:
 
591
        new_pending = set()
 
592
        for file_id in pending:
 
593
            for tree in trees:
 
594
                if not tree.has_id(file_id):
 
595
                    continue
 
596
                entry = tree.inventory[file_id]
 
597
                for child in getattr(entry, 'children', {}).itervalues():
 
598
                    if child.file_id not in interesting_ids:
 
599
                        new_pending.add(child.file_id)
 
600
        interesting_ids.update(new_pending)
 
601
        pending = new_pending
 
602
    return interesting_ids
 
603
 
 
604
 
 
605
class InterTree(InterObject):
 
606
    """This class represents operations taking place between two Trees.
 
607
 
 
608
    Its instances have methods like 'compare' and contain references to the
 
609
    source and target trees these operations are to be carried out on.
 
610
 
 
611
    Clients of bzrlib should not need to use InterTree directly, rather they
 
612
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
613
    will pass through to InterTree as appropriate.
 
614
    """
 
615
 
 
616
    _optimisers = []
 
617
 
 
618
    @needs_read_lock
 
619
    def compare(self, want_unchanged=False, specific_files=None,
 
620
        extra_trees=None, require_versioned=False, include_root=False,
 
621
        want_unversioned=False):
 
622
        """Return the changes from source to target.
 
623
 
 
624
        :return: A TreeDelta.
 
625
        :param specific_files: An optional list of file paths to restrict the
 
626
            comparison to. When mapping filenames to ids, all matches in all
 
627
            trees (including optional extra_trees) are used, and all children of
 
628
            matched directories are included.
 
629
        :param want_unchanged: An optional boolean requesting the inclusion of
 
630
            unchanged entries in the result.
 
631
        :param extra_trees: An optional list of additional trees to use when
 
632
            mapping the contents of specific_files (paths) to file_ids.
 
633
        :param require_versioned: An optional boolean (defaults to False). When
 
634
            supplied and True all the 'specific_files' must be versioned, or
 
635
            a PathsNotVersionedError will be thrown.
 
636
        :param want_unversioned: Scan for unversioned paths.
 
637
        """
 
638
        # NB: show_status depends on being able to pass in non-versioned files
 
639
        # and report them as unknown
 
640
        trees = (self.source,)
 
641
        if extra_trees is not None:
 
642
            trees = trees + tuple(extra_trees)
 
643
        # target is usually the newer tree:
 
644
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
645
            require_versioned=require_versioned)
 
646
        if specific_files and not specific_file_ids:
 
647
            # All files are unversioned, so just return an empty delta
 
648
            # _compare_trees would think we want a complete delta
 
649
            result = delta.TreeDelta()
 
650
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
651
            result.unversioned = [(path, None,
 
652
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
653
                specific_files]
 
654
            return result
 
655
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
656
            specific_files, include_root, extra_trees=extra_trees,
 
657
            require_versioned=require_versioned,
 
658
            want_unversioned=want_unversioned)
 
659
 
 
660
    def _iter_changes(self, include_unchanged=False,
 
661
                      specific_files=None, pb=None, extra_trees=[],
 
662
                      require_versioned=True, want_unversioned=False):
 
663
        """Generate an iterator of changes between trees.
 
664
 
 
665
        A tuple is returned:
 
666
        (file_id, (path_in_source, path_in_target),
 
667
         changed_content, versioned, parent, name, kind,
 
668
         executable)
 
669
 
 
670
        Changed_content is True if the file's content has changed.  This
 
671
        includes changes to its kind, and to a symlink's target.
 
672
 
 
673
        versioned, parent, name, kind, executable are tuples of (from, to).
 
674
        If a file is missing in a tree, its kind is None.
 
675
 
 
676
        Iteration is done in parent-to-child order, relative to the target
 
677
        tree.
 
678
 
 
679
        There is no guarantee that all paths are in sorted order: the
 
680
        requirement to expand the search due to renames may result in children
 
681
        that should be found early being found late in the search, after
 
682
        lexically later results have been returned.
 
683
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
684
            path in the specific_files list is not versioned in one of
 
685
            source, target or extra_trees.
 
686
        :param want_unversioned: Should unversioned files be returned in the
 
687
            output. An unversioned file is defined as one with (False, False)
 
688
            for the versioned pair.
 
689
        """
 
690
        result = []
 
691
        lookup_trees = [self.source]
 
692
        if extra_trees:
 
693
             lookup_trees.extend(extra_trees)
 
694
        if specific_files == []:
 
695
            specific_file_ids = []
 
696
        else:
 
697
            specific_file_ids = self.target.paths2ids(specific_files,
 
698
                lookup_trees, require_versioned=require_versioned)
 
699
        if want_unversioned:
 
700
            all_unversioned = sorted([(p.split('/'), p) for p in
 
701
                                     self.target.extras()
 
702
                if specific_files is None or
 
703
                    osutils.is_inside_any(specific_files, p)])
 
704
            all_unversioned = deque(all_unversioned)
 
705
        else:
 
706
            all_unversioned = deque()
 
707
        to_paths = {}
 
708
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
709
            specific_file_ids=specific_file_ids))
 
710
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
711
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
712
            specific_file_ids=specific_file_ids))
 
713
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
714
        entry_count = 0
 
715
        # the unversioned path lookup only occurs on real trees - where there 
 
716
        # can be extras. So the fake_entry is solely used to look up
 
717
        # executable it values when execute is not supported.
 
718
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
719
        for to_path, to_entry in to_entries_by_dir:
 
720
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
721
                unversioned_path = all_unversioned.popleft()
 
722
                to_kind, to_executable, to_stat = \
 
723
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
724
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
725
                    (None, None),
 
726
                    (None, unversioned_path[0][-1]),
 
727
                    (None, to_kind),
 
728
                    (None, to_executable))
 
729
            file_id = to_entry.file_id
 
730
            to_paths[file_id] = to_path
 
731
            entry_count += 1
 
732
            changed_content = False
 
733
            from_path, from_entry = from_data.get(file_id, (None, None))
 
734
            from_versioned = (from_entry is not None)
 
735
            if from_entry is not None:
 
736
                from_versioned = True
 
737
                from_name = from_entry.name
 
738
                from_parent = from_entry.parent_id
 
739
                from_kind, from_executable, from_stat = \
 
740
                    self.source._comparison_data(from_entry, from_path)
 
741
                entry_count += 1
 
742
            else:
 
743
                from_versioned = False
 
744
                from_kind = None
 
745
                from_parent = None
 
746
                from_name = None
 
747
                from_executable = None
 
748
            versioned = (from_versioned, True)
 
749
            to_kind, to_executable, to_stat = \
 
750
                self.target._comparison_data(to_entry, to_path)
 
751
            kind = (from_kind, to_kind)
 
752
            if kind[0] != kind[1]:
 
753
                changed_content = True
 
754
            elif from_kind == 'file':
 
755
                from_size = self.source._file_size(from_entry, from_stat)
 
756
                to_size = self.target._file_size(to_entry, to_stat)
 
757
                if from_size != to_size:
 
758
                    changed_content = True
 
759
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
760
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
761
                    changed_content = True
 
762
            elif from_kind == 'symlink':
 
763
                if (self.source.get_symlink_target(file_id) !=
 
764
                    self.target.get_symlink_target(file_id)):
 
765
                    changed_content = True
 
766
                elif from_kind == 'tree-reference':
 
767
                    if (self.source.get_reference_revision(file_id, from_path)
 
768
                        != self.target.get_reference_revision(file_id, to_path)):
 
769
                        changed_content = True 
 
770
            parent = (from_parent, to_entry.parent_id)
 
771
            name = (from_name, to_entry.name)
 
772
            executable = (from_executable, to_executable)
 
773
            if pb is not None:
 
774
                pb.update('comparing files', entry_count, num_entries)
 
775
            if (changed_content is not False or versioned[0] != versioned[1]
 
776
                or parent[0] != parent[1] or name[0] != name[1] or 
 
777
                executable[0] != executable[1] or include_unchanged):
 
778
                yield (file_id, (from_path, to_path), changed_content,
 
779
                    versioned, parent, name, kind, executable)
 
780
 
 
781
        while all_unversioned:
 
782
            # yield any trailing unversioned paths
 
783
            unversioned_path = all_unversioned.popleft()
 
784
            to_kind, to_executable, to_stat = \
 
785
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
786
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
787
                (None, None),
 
788
                (None, unversioned_path[0][-1]),
 
789
                (None, to_kind),
 
790
                (None, to_executable))
 
791
 
 
792
        def get_to_path(to_entry):
 
793
            if to_entry.parent_id is None:
 
794
                to_path = '' # the root
 
795
            else:
 
796
                if to_entry.parent_id not in to_paths:
 
797
                    # recurse up
 
798
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
799
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
800
                                           to_entry.name)
 
801
            to_paths[to_entry.file_id] = to_path
 
802
            return to_path
 
803
 
 
804
        for path, from_entry in from_entries_by_dir:
 
805
            file_id = from_entry.file_id
 
806
            if file_id in to_paths:
 
807
                # already returned
 
808
                continue
 
809
            if not file_id in self.target.inventory:
 
810
                # common case - paths we have not emitted are not present in
 
811
                # target.
 
812
                to_path = None
 
813
            else:
 
814
                to_path = get_to_path(self.target.inventory[file_id])
 
815
            entry_count += 1
 
816
            if pb is not None:
 
817
                pb.update('comparing files', entry_count, num_entries)
 
818
            versioned = (True, False)
 
819
            parent = (from_entry.parent_id, None)
 
820
            name = (from_entry.name, None)
 
821
            from_kind, from_executable, stat_value = \
 
822
                self.source._comparison_data(from_entry, path)
 
823
            kind = (from_kind, None)
 
824
            executable = (from_executable, None)
 
825
            changed_content = True
 
826
            # the parent's path is necessarily known at this point.
 
827
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
828
                  name, kind, executable)
 
829
 
 
830
 
 
831
# This was deprecated before 0.12, but did not have an official warning
 
832
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
833
def RevisionTree(*args, **kwargs):
 
834
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
835
 
 
836
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
837
    bzr 0.12.
 
838
    """
 
839
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
840
    return _RevisionTree(*args, **kwargs)
 
841
 
266
842