/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Aaron Bentley
  • Date: 2007-12-02 23:52:03 UTC
  • mto: This revision was merged to the branch mainline in revision 3073.
  • Revision ID: aaron.bentley@utoronto.ca-20071202235203-e1c69qbqegre7nfj
Move PlanMerge into merge and _PlanMergeVersionedFile into versionedfile

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2005 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
 
20
import os
 
21
from collections import deque
 
22
from cStringIO import StringIO
 
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
 
39
from bzrlib.trace import mutter, note
 
40
 
 
41
 
 
42
class Tree(object):
 
43
    """Abstract file tree.
 
44
 
 
45
    There are several subclasses:
 
46
    
 
47
    * `WorkingTree` exists as files on disk editable by the user.
 
48
 
 
49
    * `RevisionTree` is a tree as recorded at some point in the past.
 
50
 
 
51
    Trees contain an `Inventory` object, and also know how to retrieve
 
52
    file texts mentioned in the inventory, either from a working
 
53
    directory or from a store.
 
54
 
 
55
    It is possible for trees to contain files that are not described
 
56
    in their inventory or vice versa; for this use `filenames()`.
 
57
 
 
58
    Trees can be compared, etc, regardless of whether they are working
 
59
    trees or versioned trees.
 
60
    """
 
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
    
 
123
    def has_filename(self, filename):
 
124
        """True if the tree has given filename."""
 
125
        raise NotImplementedError(self.has_filename)
 
126
 
 
127
    def has_id(self, file_id):
 
128
        return self.inventory.has_id(file_id)
 
129
 
 
130
    __contains__ = has_id
 
131
 
 
132
    def has_or_had_id(self, file_id):
 
133
        if file_id == self.inventory.root.file_id:
 
134
            return True
 
135
        return self.inventory.has_id(file_id)
 
136
 
 
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
 
144
 
 
145
    def __iter__(self):
 
146
        return iter(self.inventory)
 
147
 
 
148
    def id2path(self, file_id):
 
149
        """Return the path for a file id.
 
150
 
 
151
        :raises NoSuchId:
 
152
        """
 
153
        return self.inventory.id2path(file_id)
 
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
 
 
184
    def kind(self, file_id):
 
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)
 
220
 
 
221
    def _get_inventory(self):
 
222
        return self._inventory
 
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
 
 
241
    def get_file_by_path(self, 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 plan_merge
 
303
        vf = plan_merge._PlanMergeVersionedFile(file_id)
 
304
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
 
305
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
 
306
        plan = plan_merge.PlanMerge(last_revision_a, last_revision_b, vf)
 
307
        return plan.plan_merge()
 
308
 
 
309
    def _get_file_revision(self, file_id, vf, tree_revision):
 
310
        def file_revision(revision_tree):
 
311
            revision_tree.lock_read()
 
312
            try:
 
313
                return revision_tree.inventory[file_id].revision
 
314
            finally:
 
315
                revision_tree.unlock()
 
316
 
 
317
        def iter_parent_trees():
 
318
            for revision_id in self.get_parent_ids():
 
319
                try:
 
320
                    yield self.revision_tree(revision_id)
 
321
                except:
 
322
                    yield self.repository.revision_tree(revision_id)
 
323
 
 
324
        if getattr(self, '_get_weave', None) is None:
 
325
            last_revision = tree_revision
 
326
            parent_revisions = [file_revision(t) for t in iter_parent_trees()]
 
327
            vf.add_lines(last_revision, parent_revisions,
 
328
                         self.get_file(file_id).readlines())
 
329
            repo = self.branch.repository
 
330
            transaction = repo.get_transaction()
 
331
            base_vf = repo.weave_store.get_weave(file_id, transaction)
 
332
        else:
 
333
            last_revision = file_revision(self)
 
334
            base_vf = self._get_weave(file_id)
 
335
        vf.fallback_versionedfiles.append(base_vf)
 
336
        return last_revision
 
337
 
 
338
    inventory = property(_get_inventory,
 
339
                         doc="Inventory of this Tree")
 
340
 
 
341
    def _check_retrieved(self, ie, f):
 
342
        if not __debug__:
 
343
            return  
 
344
        fp = fingerprint_file(f)
 
345
        f.seek(0)
 
346
        
 
347
        if ie.text_size is not None:
 
348
            if ie.text_size != fp['size']:
 
349
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
350
                        ["inventory expects %d bytes" % ie.text_size,
 
351
                         "file is actually %d bytes" % fp['size'],
 
352
                         "store is probably damaged/corrupt"])
 
353
 
 
354
        if ie.text_sha1 != fp['sha1']:
 
355
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
356
                    ["inventory expects %s" % ie.text_sha1,
 
357
                     "file is actually %s" % fp['sha1'],
 
358
                     "store is probably damaged/corrupt"])
 
359
 
 
360
    @needs_read_lock
 
361
    def path2id(self, path):
 
362
        """Return the id for path in this tree."""
 
363
        return self._inventory.path2id(path)
 
364
 
 
365
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
366
        """Return all the ids that can be reached by walking from paths.
 
367
        
 
368
        Each path is looked up in this tree and any extras provided in
 
369
        trees, and this is repeated recursively: the children in an extra tree
 
370
        of a directory that has been renamed under a provided path in this tree
 
371
        are all returned, even if none exist under a provided path in this
 
372
        tree, and vice versa.
 
373
 
 
374
        :param paths: An iterable of paths to start converting to ids from.
 
375
            Alternatively, if paths is None, no ids should be calculated and None
 
376
            will be returned. This is offered to make calling the api unconditional
 
377
            for code that *might* take a list of files.
 
378
        :param trees: Additional trees to consider.
 
379
        :param require_versioned: If False, do not raise NotVersionedError if
 
380
            an element of paths is not versioned in this tree and all of trees.
 
381
        """
 
382
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
383
 
 
384
    def print_file(self, file_id):
 
385
        """Print file with id `file_id` to stdout."""
 
386
        import sys
 
387
        sys.stdout.write(self.get_file_text(file_id))
 
388
 
 
389
    def lock_read(self):
 
390
        pass
 
391
 
 
392
    def revision_tree(self, revision_id):
 
393
        """Obtain a revision tree for the revision revision_id.
 
394
 
 
395
        The intention of this method is to allow access to possibly cached
 
396
        tree data. Implementors of this method should raise NoSuchRevision if
 
397
        the tree is not locally available, even if they could obtain the 
 
398
        tree via a repository or some other means. Callers are responsible 
 
399
        for finding the ultimate source for a revision tree.
 
400
 
 
401
        :param revision_id: The revision_id of the requested tree.
 
402
        :return: A Tree.
 
403
        :raises: NoSuchRevision if the tree cannot be obtained.
 
404
        """
 
405
        raise errors.NoSuchRevisionInTree(self, revision_id)
 
406
 
 
407
    def unknowns(self):
 
408
        """What files are present in this tree and unknown.
 
409
        
 
410
        :return: an iterator over the unknown files.
 
411
        """
 
412
        return iter([])
 
413
 
 
414
    def unlock(self):
 
415
        pass
 
416
 
 
417
    def filter_unversioned_files(self, paths):
 
418
        """Filter out paths that are versioned.
 
419
 
 
420
        :return: set of paths.
 
421
        """
 
422
        # NB: we specifically *don't* call self.has_filename, because for
 
423
        # WorkingTrees that can indicate files that exist on disk but that 
 
424
        # are not versioned.
 
425
        pred = self.inventory.has_filename
 
426
        return set((p for p in paths if not pred(p)))
 
427
 
 
428
    def walkdirs(self, prefix=""):
 
429
        """Walk the contents of this tree from path down.
 
430
 
 
431
        This yields all the data about the contents of a directory at a time.
 
432
        After each directory has been yielded, if the caller has mutated the
 
433
        list to exclude some directories, they are then not descended into.
 
434
        
 
435
        The data yielded is of the form:
 
436
        ((directory-relpath, directory-path-from-root, directory-fileid),
 
437
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id, 
 
438
          versioned_kind), ...]),
 
439
         - directory-relpath is the containing dirs relpath from prefix
 
440
         - directory-path-from-root is the containing dirs path from /
 
441
         - directory-fileid is the id of the directory if it is versioned.
 
442
         - relpath is the relative path within the subtree being walked.
 
443
         - basename is the basename
 
444
         - kind is the kind of the file now. If unknonwn then the file is not
 
445
           present within the tree - but it may be recorded as versioned. See
 
446
           versioned_kind.
 
447
         - lstat is the stat data *if* the file was statted.
 
448
         - path_from_tree_root is the path from the root of the tree.
 
449
         - file_id is the file_id if the entry is versioned.
 
450
         - versioned_kind is the kind of the file as last recorded in the 
 
451
           versioning system. If 'unknown' the file is not versioned.
 
452
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
 
453
 
 
454
        :param prefix: Start walking from prefix within the tree rather than
 
455
        at the root. This allows one to walk a subtree but get paths that are
 
456
        relative to a tree rooted higher up.
 
457
        :return: an iterator over the directory data.
 
458
        """
 
459
        raise NotImplementedError(self.walkdirs)
 
460
 
 
461
 
 
462
class EmptyTree(Tree):
 
463
 
 
464
    def __init__(self):
 
465
        self._inventory = Inventory(root_id=None)
 
466
        symbol_versioning.warn('EmptyTree is deprecated as of bzr 0.9 please'
 
467
                               ' use repository.revision_tree instead.',
 
468
                               DeprecationWarning, stacklevel=2)
 
469
 
 
470
    def get_parent_ids(self):
 
471
        return []
 
472
 
 
473
    def get_symlink_target(self, file_id):
 
474
        return None
 
475
 
 
476
    def has_filename(self, filename):
 
477
        return False
 
478
 
 
479
    def kind(self, file_id):
 
480
        assert self._inventory[file_id].kind == "directory"
 
481
        return "directory"
 
482
 
 
483
    def list_files(self, include_root=False):
 
484
        return iter([])
 
485
    
 
486
    def __contains__(self, file_id):
 
487
        return (file_id in self._inventory)
 
488
 
 
489
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
490
        return None
 
491
 
 
492
 
 
493
######################################################################
 
494
# diff
 
495
 
 
496
# TODO: Merge these two functions into a single one that can operate
 
497
# on either a whole tree or a set of files.
 
498
 
 
499
# TODO: Return the diff in order by filename, not by category or in
 
500
# random order.  Can probably be done by lock-stepping through the
 
501
# filenames from both trees.
 
502
 
 
503
 
 
504
def file_status(filename, old_tree, new_tree):
 
505
    """Return single-letter status, old and new names for a file.
 
506
 
 
507
    The complexity here is in deciding how to represent renames;
 
508
    many complex cases are possible.
 
509
    """
 
510
    old_inv = old_tree.inventory
 
511
    new_inv = new_tree.inventory
 
512
    new_id = new_inv.path2id(filename)
 
513
    old_id = old_inv.path2id(filename)
 
514
 
 
515
    if not new_id and not old_id:
 
516
        # easy: doesn't exist in either; not versioned at all
 
517
        if new_tree.is_ignored(filename):
 
518
            return 'I', None, None
 
519
        else:
 
520
            return '?', None, None
 
521
    elif new_id:
 
522
        # There is now a file of this name, great.
 
523
        pass
 
524
    else:
 
525
        # There is no longer a file of this name, but we can describe
 
526
        # what happened to the file that used to have
 
527
        # this name.  There are two possibilities: either it was
 
528
        # deleted entirely, or renamed.
 
529
        assert old_id
 
530
        if new_inv.has_id(old_id):
 
531
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
532
        else:
 
533
            return 'D', old_inv.id2path(old_id), None
 
534
 
 
535
    # if the file_id is new in this revision, it is added
 
536
    if new_id and not old_inv.has_id(new_id):
 
537
        return 'A'
 
538
 
 
539
    # if there used to be a file of this name, but that ID has now
 
540
    # disappeared, it is deleted
 
541
    if old_id and not new_inv.has_id(old_id):
 
542
        return 'D'
 
543
 
 
544
    return 'wtf?'
 
545
 
 
546
    
 
547
 
 
548
def find_renames(old_inv, new_inv):
 
549
    for file_id in old_inv:
 
550
        if file_id not in new_inv:
 
551
            continue
 
552
        old_name = old_inv.id2path(file_id)
 
553
        new_name = new_inv.id2path(file_id)
 
554
        if old_name != new_name:
 
555
            yield (old_name, new_name)
 
556
            
 
557
 
 
558
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
559
    """Find the ids corresponding to specified filenames.
 
560
    
 
561
    All matches in all trees will be used, and all children of matched
 
562
    directories will be used.
 
563
 
 
564
    :param filenames: The filenames to find file_ids for (if None, returns
 
565
        None)
 
566
    :param trees: The trees to find file_ids within
 
567
    :param require_versioned: if true, all specified filenames must occur in
 
568
    at least one tree.
 
569
    :return: a set of file ids for the specified filenames and their children.
 
570
    """
 
571
    if not filenames:
 
572
        return None
 
573
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
574
        require_versioned)
 
575
    return _find_children_across_trees(specified_path_ids, trees)
 
576
 
 
577
 
 
578
def _find_ids_across_trees(filenames, trees, require_versioned):
 
579
    """Find the ids corresponding to specified filenames.
 
580
    
 
581
    All matches in all trees will be used, but subdirectories are not scanned.
 
582
 
 
583
    :param filenames: The filenames to find file_ids for
 
584
    :param trees: The trees to find file_ids within
 
585
    :param require_versioned: if true, all specified filenames must occur in
 
586
        at least one tree.
 
587
    :return: a set of file ids for the specified filenames
 
588
    """
 
589
    not_versioned = []
 
590
    interesting_ids = set()
 
591
    for tree_path in filenames:
 
592
        not_found = True
 
593
        for tree in trees:
 
594
            file_id = tree.path2id(tree_path)
 
595
            if file_id is not None:
 
596
                interesting_ids.add(file_id)
 
597
                not_found = False
 
598
        if not_found:
 
599
            not_versioned.append(tree_path)
 
600
    if len(not_versioned) > 0 and require_versioned:
 
601
        raise errors.PathsNotVersionedError(not_versioned)
 
602
    return interesting_ids
 
603
 
 
604
 
 
605
def _find_children_across_trees(specified_ids, trees):
 
606
    """Return a set including specified ids and their children.
 
607
    
 
608
    All matches in all trees will be used.
 
609
 
 
610
    :param trees: The trees to find file_ids within
 
611
    :return: a set containing all specified ids and their children 
 
612
    """
 
613
    interesting_ids = set(specified_ids)
 
614
    pending = interesting_ids
 
615
    # now handle children of interesting ids
 
616
    # we loop so that we handle all children of each id in both trees
 
617
    while len(pending) > 0:
 
618
        new_pending = set()
 
619
        for file_id in pending:
 
620
            for tree in trees:
 
621
                if not tree.has_id(file_id):
 
622
                    continue
 
623
                entry = tree.inventory[file_id]
 
624
                for child in getattr(entry, 'children', {}).itervalues():
 
625
                    if child.file_id not in interesting_ids:
 
626
                        new_pending.add(child.file_id)
 
627
        interesting_ids.update(new_pending)
 
628
        pending = new_pending
 
629
    return interesting_ids
 
630
 
 
631
 
 
632
class InterTree(InterObject):
 
633
    """This class represents operations taking place between two Trees.
 
634
 
 
635
    Its instances have methods like 'compare' and contain references to the
 
636
    source and target trees these operations are to be carried out on.
 
637
 
 
638
    Clients of bzrlib should not need to use InterTree directly, rather they
 
639
    should use the convenience methods on Tree such as 'Tree.compare()' which
 
640
    will pass through to InterTree as appropriate.
 
641
    """
 
642
 
 
643
    _optimisers = []
 
644
 
 
645
    @needs_read_lock
 
646
    def compare(self, want_unchanged=False, specific_files=None,
 
647
        extra_trees=None, require_versioned=False, include_root=False,
 
648
        want_unversioned=False):
 
649
        """Return the changes from source to target.
 
650
 
 
651
        :return: A TreeDelta.
 
652
        :param specific_files: An optional list of file paths to restrict the
 
653
            comparison to. When mapping filenames to ids, all matches in all
 
654
            trees (including optional extra_trees) are used, and all children of
 
655
            matched directories are included.
 
656
        :param want_unchanged: An optional boolean requesting the inclusion of
 
657
            unchanged entries in the result.
 
658
        :param extra_trees: An optional list of additional trees to use when
 
659
            mapping the contents of specific_files (paths) to file_ids.
 
660
        :param require_versioned: An optional boolean (defaults to False). When
 
661
            supplied and True all the 'specific_files' must be versioned, or
 
662
            a PathsNotVersionedError will be thrown.
 
663
        :param want_unversioned: Scan for unversioned paths.
 
664
        """
 
665
        # NB: show_status depends on being able to pass in non-versioned files
 
666
        # and report them as unknown
 
667
        trees = (self.source,)
 
668
        if extra_trees is not None:
 
669
            trees = trees + tuple(extra_trees)
 
670
        # target is usually the newer tree:
 
671
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
672
            require_versioned=require_versioned)
 
673
        if specific_files and not specific_file_ids:
 
674
            # All files are unversioned, so just return an empty delta
 
675
            # _compare_trees would think we want a complete delta
 
676
            result = delta.TreeDelta()
 
677
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
678
            result.unversioned = [(path, None,
 
679
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
680
                specific_files]
 
681
            return result
 
682
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
683
            specific_files, include_root, extra_trees=extra_trees,
 
684
            require_versioned=require_versioned,
 
685
            want_unversioned=want_unversioned)
 
686
 
 
687
    def _iter_changes(self, include_unchanged=False,
 
688
                      specific_files=None, pb=None, extra_trees=[],
 
689
                      require_versioned=True, want_unversioned=False):
 
690
        """Generate an iterator of changes between trees.
 
691
 
 
692
        A tuple is returned:
 
693
        (file_id, (path_in_source, path_in_target),
 
694
         changed_content, versioned, parent, name, kind,
 
695
         executable)
 
696
 
 
697
        Changed_content is True if the file's content has changed.  This
 
698
        includes changes to its kind, and to a symlink's target.
 
699
 
 
700
        versioned, parent, name, kind, executable are tuples of (from, to).
 
701
        If a file is missing in a tree, its kind is None.
 
702
 
 
703
        Iteration is done in parent-to-child order, relative to the target
 
704
        tree.
 
705
 
 
706
        There is no guarantee that all paths are in sorted order: the
 
707
        requirement to expand the search due to renames may result in children
 
708
        that should be found early being found late in the search, after
 
709
        lexically later results have been returned.
 
710
        :param require_versioned: Raise errors.PathsNotVersionedError if a
 
711
            path in the specific_files list is not versioned in one of
 
712
            source, target or extra_trees.
 
713
        :param want_unversioned: Should unversioned files be returned in the
 
714
            output. An unversioned file is defined as one with (False, False)
 
715
            for the versioned pair.
 
716
        """
 
717
        result = []
 
718
        lookup_trees = [self.source]
 
719
        if extra_trees:
 
720
             lookup_trees.extend(extra_trees)
 
721
        if specific_files == []:
 
722
            specific_file_ids = []
 
723
        else:
 
724
            specific_file_ids = self.target.paths2ids(specific_files,
 
725
                lookup_trees, require_versioned=require_versioned)
 
726
        if want_unversioned:
 
727
            all_unversioned = sorted([(p.split('/'), p) for p in
 
728
                                     self.target.extras()
 
729
                if specific_files is None or
 
730
                    osutils.is_inside_any(specific_files, p)])
 
731
            all_unversioned = deque(all_unversioned)
 
732
        else:
 
733
            all_unversioned = deque()
 
734
        to_paths = {}
 
735
        from_entries_by_dir = list(self.source.inventory.iter_entries_by_dir(
 
736
            specific_file_ids=specific_file_ids))
 
737
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
 
738
        to_entries_by_dir = list(self.target.inventory.iter_entries_by_dir(
 
739
            specific_file_ids=specific_file_ids))
 
740
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
 
741
        entry_count = 0
 
742
        # the unversioned path lookup only occurs on real trees - where there 
 
743
        # can be extras. So the fake_entry is solely used to look up
 
744
        # executable it values when execute is not supported.
 
745
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
746
        for to_path, to_entry in to_entries_by_dir:
 
747
            while all_unversioned and all_unversioned[0][0] < to_path.split('/'):
 
748
                unversioned_path = all_unversioned.popleft()
 
749
                to_kind, to_executable, to_stat = \
 
750
                    self.target._comparison_data(fake_entry, unversioned_path[1])
 
751
                yield (None, (None, unversioned_path[1]), True, (False, False),
 
752
                    (None, None),
 
753
                    (None, unversioned_path[0][-1]),
 
754
                    (None, to_kind),
 
755
                    (None, to_executable))
 
756
            file_id = to_entry.file_id
 
757
            to_paths[file_id] = to_path
 
758
            entry_count += 1
 
759
            changed_content = False
 
760
            from_path, from_entry = from_data.get(file_id, (None, None))
 
761
            from_versioned = (from_entry is not None)
 
762
            if from_entry is not None:
 
763
                from_versioned = True
 
764
                from_name = from_entry.name
 
765
                from_parent = from_entry.parent_id
 
766
                from_kind, from_executable, from_stat = \
 
767
                    self.source._comparison_data(from_entry, from_path)
 
768
                entry_count += 1
 
769
            else:
 
770
                from_versioned = False
 
771
                from_kind = None
 
772
                from_parent = None
 
773
                from_name = None
 
774
                from_executable = None
 
775
            versioned = (from_versioned, True)
 
776
            to_kind, to_executable, to_stat = \
 
777
                self.target._comparison_data(to_entry, to_path)
 
778
            kind = (from_kind, to_kind)
 
779
            if kind[0] != kind[1]:
 
780
                changed_content = True
 
781
            elif from_kind == 'file':
 
782
                from_size = self.source._file_size(from_entry, from_stat)
 
783
                to_size = self.target._file_size(to_entry, to_stat)
 
784
                if from_size != to_size:
 
785
                    changed_content = True
 
786
                elif (self.source.get_file_sha1(file_id, from_path, from_stat) !=
 
787
                    self.target.get_file_sha1(file_id, to_path, to_stat)):
 
788
                    changed_content = True
 
789
            elif from_kind == 'symlink':
 
790
                if (self.source.get_symlink_target(file_id) !=
 
791
                    self.target.get_symlink_target(file_id)):
 
792
                    changed_content = True
 
793
                elif from_kind == 'tree-reference':
 
794
                    if (self.source.get_reference_revision(file_id, from_path)
 
795
                        != self.target.get_reference_revision(file_id, to_path)):
 
796
                        changed_content = True 
 
797
            parent = (from_parent, to_entry.parent_id)
 
798
            name = (from_name, to_entry.name)
 
799
            executable = (from_executable, to_executable)
 
800
            if pb is not None:
 
801
                pb.update('comparing files', entry_count, num_entries)
 
802
            if (changed_content is not False or versioned[0] != versioned[1]
 
803
                or parent[0] != parent[1] or name[0] != name[1] or 
 
804
                executable[0] != executable[1] or include_unchanged):
 
805
                yield (file_id, (from_path, to_path), changed_content,
 
806
                    versioned, parent, name, kind, executable)
 
807
 
 
808
        while all_unversioned:
 
809
            # yield any trailing unversioned paths
 
810
            unversioned_path = all_unversioned.popleft()
 
811
            to_kind, to_executable, to_stat = \
 
812
                self.target._comparison_data(fake_entry, unversioned_path[1])
 
813
            yield (None, (None, unversioned_path[1]), True, (False, False),
 
814
                (None, None),
 
815
                (None, unversioned_path[0][-1]),
 
816
                (None, to_kind),
 
817
                (None, to_executable))
 
818
 
 
819
        def get_to_path(to_entry):
 
820
            if to_entry.parent_id is None:
 
821
                to_path = '' # the root
 
822
            else:
 
823
                if to_entry.parent_id not in to_paths:
 
824
                    # recurse up
 
825
                    return get_to_path(self.target.inventory[to_entry.parent_id])
 
826
                to_path = osutils.pathjoin(to_paths[to_entry.parent_id],
 
827
                                           to_entry.name)
 
828
            to_paths[to_entry.file_id] = to_path
 
829
            return to_path
 
830
 
 
831
        for path, from_entry in from_entries_by_dir:
 
832
            file_id = from_entry.file_id
 
833
            if file_id in to_paths:
 
834
                # already returned
 
835
                continue
 
836
            if not file_id in self.target.inventory:
 
837
                # common case - paths we have not emitted are not present in
 
838
                # target.
 
839
                to_path = None
 
840
            else:
 
841
                to_path = get_to_path(self.target.inventory[file_id])
 
842
            entry_count += 1
 
843
            if pb is not None:
 
844
                pb.update('comparing files', entry_count, num_entries)
 
845
            versioned = (True, False)
 
846
            parent = (from_entry.parent_id, None)
 
847
            name = (from_entry.name, None)
 
848
            from_kind, from_executable, stat_value = \
 
849
                self.source._comparison_data(from_entry, path)
 
850
            kind = (from_kind, None)
 
851
            executable = (from_executable, None)
 
852
            changed_content = True
 
853
            # the parent's path is necessarily known at this point.
 
854
            yield(file_id, (path, to_path), changed_content, versioned, parent,
 
855
                  name, kind, executable)
 
856
 
 
857
 
 
858
# This was deprecated before 0.12, but did not have an official warning
 
859
@symbol_versioning.deprecated_function(symbol_versioning.zero_twelve)
 
860
def RevisionTree(*args, **kwargs):
 
861
    """RevisionTree has moved to bzrlib.revisiontree.RevisionTree()
 
862
 
 
863
    Accessing it as bzrlib.tree.RevisionTree has been deprecated as of
 
864
    bzr 0.12.
 
865
    """
 
866
    from bzrlib.revisiontree import RevisionTree as _RevisionTree
 
867
    return _RevisionTree(*args, **kwargs)
 
868
 
 
869