/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: Andrew Bennetts
  • Date: 2009-10-21 11:13:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4762.
  • Revision ID: andrew.bennetts@canonical.com-20091021111340-w7x4d5yf83qwjncc
Add test that WSGI glue allows request handlers to access paths above that request's. backing transport, so long as it is within the WSGI app's backing transport.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005, 2009 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
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
21
 
 
22
20
import os
23
 
 
24
 
from .lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import collections
27
 
 
28
 
from breezy import (
 
21
from collections import deque
 
22
 
 
23
import bzrlib
 
24
from bzrlib import (
29
25
    conflicts as _mod_conflicts,
30
26
    debug,
31
27
    delta,
32
28
    filters,
 
29
    osutils,
33
30
    revision as _mod_revision,
34
31
    rules,
35
 
    trace,
36
 
    )
37
 
from breezy.i18n import gettext
38
 
""")
39
 
 
40
 
from . import (
41
 
    errors,
42
 
    lock,
43
 
    osutils,
44
 
    )
45
 
from .inter import InterObject
46
 
from .sixish import (
47
 
    text_type,
48
 
    viewvalues,
49
 
    )
50
 
 
51
 
 
52
 
class FileTimestampUnavailable(errors.BzrError):
53
 
 
54
 
    _fmt = "The filestamp for %(path)s is not available."
55
 
 
56
 
    internal_error = True
57
 
 
58
 
    def __init__(self, path):
59
 
        self.path = path
60
 
 
61
 
 
62
 
class TreeEntry(object):
63
 
    """An entry that implements the minimum interface used by commands.
64
 
    """
65
 
 
66
 
    def __eq__(self, other):
67
 
        # yes, this is ugly, TODO: best practice __eq__ style.
68
 
        return (isinstance(other, TreeEntry)
69
 
                and other.__class__ == self.__class__)
70
 
 
71
 
    def kind_character(self):
72
 
        return "???"
73
 
 
74
 
 
75
 
class TreeDirectory(TreeEntry):
76
 
    """See TreeEntry. This is a directory in a working tree."""
77
 
 
78
 
    def kind_character(self):
79
 
        return "/"
80
 
 
81
 
 
82
 
class TreeFile(TreeEntry):
83
 
    """See TreeEntry. This is a regular file in a working tree."""
84
 
 
85
 
    def kind_character(self):
86
 
        return ''
87
 
 
88
 
 
89
 
class TreeLink(TreeEntry):
90
 
    """See TreeEntry. This is a symlink in a working tree."""
91
 
 
92
 
    def kind_character(self):
93
 
        return ''
94
 
 
95
 
 
96
 
class TreeReference(TreeEntry):
97
 
    """See TreeEntry. This is a reference to a nested tree in a working tree."""
98
 
 
99
 
    def kind_character(self):
100
 
        return '/'
 
32
    )
 
33
from bzrlib.decorators import needs_read_lock
 
34
from bzrlib.errors import BzrError, NoSuchId
 
35
from bzrlib import errors
 
36
from bzrlib.inventory import InventoryFile
 
37
from bzrlib.inter import InterObject
 
38
from bzrlib.osutils import fingerprint_file
 
39
import bzrlib.revision
 
40
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
 
41
from bzrlib.trace import note
101
42
 
102
43
 
103
44
class Tree(object):
109
50
 
110
51
    * `RevisionTree` is a tree as recorded at some point in the past.
111
52
 
 
53
    Trees contain an `Inventory` object, and also know how to retrieve
 
54
    file texts mentioned in the inventory, either from a working
 
55
    directory or from a store.
 
56
 
 
57
    It is possible for trees to contain files that are not described
 
58
    in their inventory or vice versa; for this use `filenames()`.
 
59
 
112
60
    Trees can be compared, etc, regardless of whether they are working
113
61
    trees or versioned trees.
114
62
    """
115
63
 
116
 
    def supports_rename_tracking(self):
117
 
        """Whether this tree supports rename tracking.
118
 
 
119
 
        This defaults to True, but some implementations may want to override
120
 
        it.
121
 
        """
122
 
        return True
123
 
 
124
 
    def has_versioned_directories(self):
125
 
        """Whether this tree can contain explicitly versioned directories.
126
 
 
127
 
        This defaults to True, but some implementations may want to override
128
 
        it.
129
 
        """
130
 
        return True
131
 
 
132
64
    def changes_from(self, other, want_unchanged=False, specific_files=None,
133
65
        extra_trees=None, require_versioned=False, include_root=False,
134
66
        want_unversioned=False):
166
98
    def iter_changes(self, from_tree, include_unchanged=False,
167
99
                     specific_files=None, pb=None, extra_trees=None,
168
100
                     require_versioned=True, want_unversioned=False):
169
 
        """See InterTree.iter_changes"""
170
101
        intertree = InterTree.get(from_tree, self)
171
102
        return intertree.iter_changes(include_unchanged, specific_files, pb,
172
103
            extra_trees, require_versioned, want_unversioned=want_unversioned)
174
105
    def conflicts(self):
175
106
        """Get a list of the conflicts in the tree.
176
107
 
177
 
        Each conflict is an instance of breezy.conflicts.Conflict.
 
108
        Each conflict is an instance of bzrlib.conflicts.Conflict.
178
109
        """
179
110
        return _mod_conflicts.ConflictList()
180
111
 
195
126
        """True if the tree has given filename."""
196
127
        raise NotImplementedError(self.has_filename)
197
128
 
 
129
    def has_id(self, file_id):
 
130
        return self.inventory.has_id(file_id)
 
131
 
 
132
    def __contains__(self, file_id):
 
133
        return self.has_id(file_id)
 
134
 
 
135
    def has_or_had_id(self, file_id):
 
136
        return self.inventory.has_id(file_id)
 
137
 
198
138
    def is_ignored(self, filename):
199
139
        """Check whether the filename is ignored by this tree.
200
140
 
203
143
        """
204
144
        return False
205
145
 
 
146
    def __iter__(self):
 
147
        return iter(self.inventory)
 
148
 
206
149
    def all_file_ids(self):
207
150
        """Iterate through all file ids, including ids for missing files."""
208
 
        raise NotImplementedError(self.all_file_ids)
209
 
 
210
 
    def all_versioned_paths(self):
211
 
        """Iterate through all paths, including paths for missing files."""
212
 
        raise NotImplementedError(self.all_versioned_paths)
 
151
        return set(self.inventory)
213
152
 
214
153
    def id2path(self, file_id):
215
154
        """Return the path for a file id.
216
155
 
217
156
        :raises NoSuchId:
218
157
        """
219
 
        raise NotImplementedError(self.id2path)
220
 
 
221
 
    def iter_entries_by_dir(self, specific_files=None):
 
158
        return self.inventory.id2path(file_id)
 
159
 
 
160
    def is_control_filename(self, filename):
 
161
        """True if filename is the name of a control file in this tree.
 
162
 
 
163
        :param filename: A filename within the tree. This is a relative path
 
164
        from the root of this tree.
 
165
 
 
166
        This is true IF and ONLY IF the filename is part of the meta data
 
167
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
168
        on disk will not be a control file for this tree.
 
169
        """
 
170
        return self.bzrdir.is_control_filename(filename)
 
171
 
 
172
    @needs_read_lock
 
173
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
222
174
        """Walk the tree in 'by_dir' order.
223
175
 
224
176
        This will yield each entry in the tree as a (path, entry) tuple.
240
192
             g
241
193
 
242
194
        The yield order (ignoring root) would be::
243
 
 
244
195
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
245
 
        """
246
 
        raise NotImplementedError(self.iter_entries_by_dir)
247
 
 
248
 
    def iter_child_entries(self, path, file_id=None):
249
 
        """Iterate over the children of a directory or tree reference.
250
 
 
251
 
        :param path: Path of the directory
252
 
        :param file_id: Optional file id of the directory/tree-reference
253
 
        :raise NoSuchId: When the file_id does not exist
254
 
        :return: Iterator over entries in the directory
255
 
        """
256
 
        raise NotImplementedError(self.iter_child_entries)
257
 
 
258
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
259
 
        """List all files in this tree.
260
 
 
261
 
        :param include_root: Whether to include the entry for the tree root
262
 
        :param from_dir: Directory under which to list files
263
 
        :param recursive: Whether to list files recursively
264
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
265
 
            inventory entry)
266
 
        """
267
 
        raise NotImplementedError(self.list_files)
 
196
 
 
197
        :param yield_parents: If True, yield the parents from the root leading
 
198
            down to specific_file_ids that have been requested. This has no
 
199
            impact if specific_file_ids is None.
 
200
        """
 
201
        return self.inventory.iter_entries_by_dir(
 
202
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
268
203
 
269
204
    def iter_references(self):
270
205
        if self.supports_tree_reference():
272
207
                if entry.kind == 'tree-reference':
273
208
                    yield path, entry.file_id
274
209
 
275
 
    def kind(self, path, file_id=None):
 
210
    def kind(self, file_id):
276
211
        raise NotImplementedError("Tree subclass %s must implement kind"
277
212
            % self.__class__.__name__)
278
213
 
279
 
    def stored_kind(self, path, file_id=None):
 
214
    def stored_kind(self, file_id):
280
215
        """File kind stored for this file_id.
281
216
 
282
217
        May not match kind on disk for working trees.  Always available
283
218
        for versioned files, even when the file itself is missing.
284
219
        """
285
 
        return self.kind(path, file_id)
 
220
        return self.kind(file_id)
286
221
 
287
222
    def path_content_summary(self, path):
288
223
        """Get a summary of the information about path.
302
237
        """
303
238
        raise NotImplementedError(self.path_content_summary)
304
239
 
305
 
    def get_reference_revision(self, path, file_id=None):
 
240
    def get_reference_revision(self, file_id, path=None):
306
241
        raise NotImplementedError("Tree subclass %s must implement "
307
242
                                  "get_reference_revision"
308
243
            % self.__class__.__name__)
318
253
        """
319
254
        raise NotImplementedError(self._comparison_data)
320
255
 
321
 
    def get_file(self, path, file_id=None):
 
256
    def _file_size(self, entry, stat_value):
 
257
        raise NotImplementedError(self._file_size)
 
258
 
 
259
    def _get_inventory(self):
 
260
        return self._inventory
 
261
 
 
262
    def get_file(self, file_id, path=None):
322
263
        """Return a file object for the file file_id in the tree.
323
264
 
324
265
        If both file_id and path are defined, it is implementation defined as
326
267
        """
327
268
        raise NotImplementedError(self.get_file)
328
269
 
329
 
    def get_file_with_stat(self, path, file_id=None):
 
270
    def get_file_with_stat(self, file_id, path=None):
330
271
        """Get a file handle and stat object for file_id.
331
272
 
332
273
        The default implementation returns (self.get_file, None) for backwards
333
274
        compatibility.
334
275
 
335
 
        :param path: The path of the file.
336
 
        :param file_id: The file id to read, if it is known.
 
276
        :param file_id: The file id to read.
 
277
        :param path: The path of the file, if it is known.
337
278
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
338
279
            no stat facility, or need for a stat cache feedback during commit,
339
280
            it may return None for the second element of the tuple.
340
281
        """
341
 
        return (self.get_file(path, file_id), None)
 
282
        return (self.get_file(file_id, path), None)
342
283
 
343
 
    def get_file_text(self, path, file_id=None):
 
284
    def get_file_text(self, file_id, path=None):
344
285
        """Return the byte content of a file.
345
286
 
 
287
        :param file_id: The file_id of the file.
346
288
        :param path: The path of the file.
347
 
        :param file_id: The file_id of the file.
348
 
 
349
289
        If both file_id and path are supplied, an implementation may use
350
290
        either one.
351
 
 
352
 
        :returns: A single byte string for the whole file.
353
291
        """
354
 
        with self.get_file(path, file_id) as my_file:
 
292
        my_file = self.get_file(file_id, path)
 
293
        try:
355
294
            return my_file.read()
 
295
        finally:
 
296
            my_file.close()
356
297
 
357
 
    def get_file_lines(self, path, file_id=None):
 
298
    def get_file_lines(self, file_id, path=None):
358
299
        """Return the content of a file, as lines.
359
300
 
 
301
        :param file_id: The file_id of the file.
360
302
        :param path: The path of the file.
361
 
        :param file_id: The file_id of the file.
362
 
 
363
303
        If both file_id and path are supplied, an implementation may use
364
304
        either one.
365
305
        """
366
 
        return osutils.split_lines(self.get_file_text(path, file_id))
367
 
 
368
 
    def get_file_verifier(self, path, file_id=None, stat_value=None):
369
 
        """Return a verifier for a file.
370
 
 
371
 
        The default implementation returns a sha1.
372
 
 
373
 
        :param file_id: The handle for this file.
374
 
        :param path: The path that this file can be found at.
375
 
            These must point to the same object.
376
 
        :param stat_value: Optional stat value for the object
377
 
        :return: Tuple with verifier name and verifier data
378
 
        """
379
 
        return ("SHA1", self.get_file_sha1(path, file_id,
380
 
            stat_value=stat_value))
381
 
 
382
 
    def get_file_sha1(self, path, file_id=None, stat_value=None):
383
 
        """Return the SHA1 file for a file.
384
 
 
385
 
        :note: callers should use get_file_verifier instead
386
 
            where possible, as the underlying repository implementation may
387
 
            have quicker access to a non-sha1 verifier.
388
 
 
389
 
        :param path: The path that this file can be found at.
390
 
        :param file_id: The handle for this file.
391
 
            These must point to the same object.
392
 
        :param stat_value: Optional stat value for the object
393
 
        """
394
 
        raise NotImplementedError(self.get_file_sha1)
395
 
 
396
 
    def get_file_mtime(self, path, file_id=None):
 
306
        return osutils.split_lines(self.get_file_text(file_id, path))
 
307
 
 
308
    def get_file_mtime(self, file_id, path=None):
397
309
        """Return the modification time for a file.
398
310
 
 
311
        :param file_id: The handle for this file.
399
312
        :param path: The path that this file can be found at.
400
 
        :param file_id: The handle for this file.
401
313
            These must point to the same object.
402
314
        """
403
315
        raise NotImplementedError(self.get_file_mtime)
404
316
 
405
 
    def get_file_size(self, path, file_id=None):
 
317
    def get_file_size(self, file_id):
406
318
        """Return the size of a file in bytes.
407
319
 
408
320
        This applies only to regular files.  If invoked on directories or
411
323
        """
412
324
        raise NotImplementedError(self.get_file_size)
413
325
 
414
 
    def is_executable(self, path, file_id=None):
415
 
        """Check if a file is executable.
416
 
 
417
 
        :param path: The path that this file can be found at.
418
 
        :param file_id: The handle for this file.
419
 
            These must point to the same object.
420
 
        """
421
 
        raise NotImplementedError(self.is_executable)
 
326
    def get_file_by_path(self, path):
 
327
        return self.get_file(self._inventory.path2id(path), path)
422
328
 
423
329
    def iter_files_bytes(self, desired_files):
424
330
        """Iterate through file contents.
436
342
        this implementation, it is a tuple containing a single bytestring with
437
343
        the complete text of the file.
438
344
 
439
 
        :param desired_files: a list of (path, identifier) pairs
 
345
        :param desired_files: a list of (file_id, identifier) pairs
440
346
        """
441
 
        for path, identifier in desired_files:
 
347
        for file_id, identifier in desired_files:
442
348
            # We wrap the string in a tuple so that we can return an iterable
443
349
            # of bytestrings.  (Technically, a bytestring is also an iterable
444
350
            # of bytestrings, but iterating through each character is not
445
351
            # performant.)
446
 
            cur_file = (self.get_file_text(path),)
 
352
            cur_file = (self.get_file_text(file_id),)
447
353
            yield identifier, cur_file
448
354
 
449
 
    def get_symlink_target(self, path, file_id=None):
 
355
    def get_symlink_target(self, file_id):
450
356
        """Get the target for a given file_id.
451
357
 
452
358
        It is assumed that the caller already knows that file_id is referencing
453
359
        a symlink.
454
360
        :param file_id: Handle for the symlink entry.
455
 
        :param path: The path of the file.
456
 
        If both file_id and path are supplied, an implementation may use
457
 
        either one.
458
361
        :return: The path the symlink points to.
459
362
        """
460
363
        raise NotImplementedError(self.get_symlink_target)
461
364
 
 
365
    def get_canonical_inventory_paths(self, paths):
 
366
        """Like get_canonical_inventory_path() but works on multiple items.
 
367
 
 
368
        :param paths: A sequence of paths relative to the root of the tree.
 
369
        :return: A list of paths, with each item the corresponding input path
 
370
        adjusted to account for existing elements that match case
 
371
        insensitively.
 
372
        """
 
373
        return list(self._yield_canonical_inventory_paths(paths))
 
374
 
 
375
    def get_canonical_inventory_path(self, path):
 
376
        """Returns the first inventory item that case-insensitively matches path.
 
377
 
 
378
        If a path matches exactly, it is returned. If no path matches exactly
 
379
        but more than one path matches case-insensitively, it is implementation
 
380
        defined which is returned.
 
381
 
 
382
        If no path matches case-insensitively, the input path is returned, but
 
383
        with as many path entries that do exist changed to their canonical
 
384
        form.
 
385
 
 
386
        If you need to resolve many names from the same tree, you should
 
387
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
388
 
 
389
        :param path: A paths relative to the root of the tree.
 
390
        :return: The input path adjusted to account for existing elements
 
391
        that match case insensitively.
 
392
        """
 
393
        return self._yield_canonical_inventory_paths([path]).next()
 
394
 
 
395
    def _yield_canonical_inventory_paths(self, paths):
 
396
        for path in paths:
 
397
            # First, if the path as specified exists exactly, just use it.
 
398
            if self.path2id(path) is not None:
 
399
                yield path
 
400
                continue
 
401
            # go walkin...
 
402
            cur_id = self.get_root_id()
 
403
            cur_path = ''
 
404
            bit_iter = iter(path.split("/"))
 
405
            for elt in bit_iter:
 
406
                lelt = elt.lower()
 
407
                for child in self.iter_children(cur_id):
 
408
                    try:
 
409
                        child_base = os.path.basename(self.id2path(child))
 
410
                        if child_base.lower() == lelt:
 
411
                            cur_id = child
 
412
                            cur_path = osutils.pathjoin(cur_path, child_base)
 
413
                            break
 
414
                    except NoSuchId:
 
415
                        # before a change is committed we can see this error...
 
416
                        continue
 
417
                else:
 
418
                    # got to the end of this directory and no entries matched.
 
419
                    # Return what matched so far, plus the rest as specified.
 
420
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
421
                    break
 
422
            yield cur_path
 
423
        # all done.
 
424
 
462
425
    def get_root_id(self):
463
426
        """Return the file_id for the root of this tree."""
464
427
        raise NotImplementedError(self.get_root_id)
465
428
 
466
 
    def annotate_iter(self, path, file_id=None,
 
429
    def annotate_iter(self, file_id,
467
430
                      default_revision=_mod_revision.CURRENT_REVISION):
468
431
        """Return an iterator of revision_id, line tuples.
469
432
 
477
440
        """
478
441
        raise NotImplementedError(self.annotate_iter)
479
442
 
 
443
    def _get_plan_merge_data(self, file_id, other, base):
 
444
        from bzrlib import versionedfile
 
445
        vf = versionedfile._PlanMergeVersionedFile(file_id)
 
446
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
 
447
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
 
448
        if base is None:
 
449
            last_revision_base = None
 
450
        else:
 
451
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
 
452
        return vf, last_revision_a, last_revision_b, last_revision_base
 
453
 
 
454
    def plan_file_merge(self, file_id, other, base=None):
 
455
        """Generate a merge plan based on annotations.
 
456
 
 
457
        If the file contains uncommitted changes in this tree, they will be
 
458
        attributed to the 'current:' pseudo-revision.  If the file contains
 
459
        uncommitted changes in the other tree, they will be assigned to the
 
460
        'other:' pseudo-revision.
 
461
        """
 
462
        data = self._get_plan_merge_data(file_id, other, base)
 
463
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
464
        return vf.plan_merge(last_revision_a, last_revision_b,
 
465
                             last_revision_base)
 
466
 
 
467
    def plan_file_lca_merge(self, file_id, other, base=None):
 
468
        """Generate a merge plan based lca-newness.
 
469
 
 
470
        If the file contains uncommitted changes in this tree, they will be
 
471
        attributed to the 'current:' pseudo-revision.  If the file contains
 
472
        uncommitted changes in the other tree, they will be assigned to the
 
473
        'other:' pseudo-revision.
 
474
        """
 
475
        data = self._get_plan_merge_data(file_id, other, base)
 
476
        vf, last_revision_a, last_revision_b, last_revision_base = data
 
477
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
 
478
                                 last_revision_base)
 
479
 
480
480
    def _iter_parent_trees(self):
481
481
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
482
482
        for revision_id in self.get_parent_ids():
485
485
            except errors.NoSuchRevisionInTree:
486
486
                yield self.repository.revision_tree(revision_id)
487
487
 
 
488
    @staticmethod
 
489
    def _file_revision(revision_tree, file_id):
 
490
        """Determine the revision associated with a file in a given tree."""
 
491
        revision_tree.lock_read()
 
492
        try:
 
493
            return revision_tree.inventory[file_id].revision
 
494
        finally:
 
495
            revision_tree.unlock()
 
496
 
 
497
    def _get_file_revision(self, file_id, vf, tree_revision):
 
498
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
 
499
 
 
500
        if getattr(self, '_repository', None) is None:
 
501
            last_revision = tree_revision
 
502
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
 
503
                self._iter_parent_trees()]
 
504
            vf.add_lines((file_id, last_revision), parent_keys,
 
505
                         self.get_file(file_id).readlines())
 
506
            repo = self.branch.repository
 
507
            base_vf = repo.texts
 
508
        else:
 
509
            last_revision = self._file_revision(self, file_id)
 
510
            base_vf = self._repository.texts
 
511
        if base_vf not in vf.fallback_versionedfiles:
 
512
            vf.fallback_versionedfiles.append(base_vf)
 
513
        return last_revision
 
514
 
 
515
    inventory = property(_get_inventory,
 
516
                         doc="Inventory of this Tree")
 
517
 
 
518
    def _check_retrieved(self, ie, f):
 
519
        if not __debug__:
 
520
            return
 
521
        fp = fingerprint_file(f)
 
522
        f.seek(0)
 
523
 
 
524
        if ie.text_size is not None:
 
525
            if ie.text_size != fp['size']:
 
526
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
 
527
                        ["inventory expects %d bytes" % ie.text_size,
 
528
                         "file is actually %d bytes" % fp['size'],
 
529
                         "store is probably damaged/corrupt"])
 
530
 
 
531
        if ie.text_sha1 != fp['sha1']:
 
532
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
 
533
                    ["inventory expects %s" % ie.text_sha1,
 
534
                     "file is actually %s" % fp['sha1'],
 
535
                     "store is probably damaged/corrupt"])
 
536
 
 
537
    @needs_read_lock
488
538
    def path2id(self, path):
489
539
        """Return the id for path in this tree."""
490
 
        raise NotImplementedError(self.path2id)
491
 
 
492
 
    def is_versioned(self, path):
493
 
        """Check whether path is versioned.
494
 
 
495
 
        :param path: Path to check
496
 
        :return: boolean
497
 
        """
498
 
        return self.path2id(path) is not None
499
 
 
500
 
    def find_related_paths_across_trees(self, paths, trees=[],
501
 
            require_versioned=True):
502
 
        """Find related paths in tree corresponding to specified filenames in any
503
 
        of `lookup_trees`.
504
 
 
505
 
        All matches in all trees will be used, and all children of matched
506
 
        directories will be used.
507
 
 
508
 
        :param paths: The filenames to find related paths for (if None, returns
509
 
            None)
510
 
        :param trees: The trees to find file_ids within
511
 
        :param require_versioned: if true, all specified filenames must occur in
512
 
            at least one tree.
513
 
        :return: a set of paths for the specified filenames and their children
514
 
            in `tree`
515
 
        """
516
 
        raise NotImplementedError(self.find_related_paths_across_trees)
 
540
        return self._inventory.path2id(path)
 
541
 
 
542
    def paths2ids(self, paths, trees=[], require_versioned=True):
 
543
        """Return all the ids that can be reached by walking from paths.
 
544
 
 
545
        Each path is looked up in this tree and any extras provided in
 
546
        trees, and this is repeated recursively: the children in an extra tree
 
547
        of a directory that has been renamed under a provided path in this tree
 
548
        are all returned, even if none exist under a provided path in this
 
549
        tree, and vice versa.
 
550
 
 
551
        :param paths: An iterable of paths to start converting to ids from.
 
552
            Alternatively, if paths is None, no ids should be calculated and None
 
553
            will be returned. This is offered to make calling the api unconditional
 
554
            for code that *might* take a list of files.
 
555
        :param trees: Additional trees to consider.
 
556
        :param require_versioned: If False, do not raise NotVersionedError if
 
557
            an element of paths is not versioned in this tree and all of trees.
 
558
        """
 
559
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
 
560
 
 
561
    def iter_children(self, file_id):
 
562
        entry = self.iter_entries_by_dir([file_id]).next()[1]
 
563
        for child in getattr(entry, 'children', {}).itervalues():
 
564
            yield child.file_id
517
565
 
518
566
    def lock_read(self):
519
 
        """Lock this tree for multiple read only operations.
520
 
 
521
 
        :return: A breezy.lock.LogicalLockResult.
522
 
        """
523
 
        return lock.LogicalLockResult(self.unlock)
 
567
        pass
524
568
 
525
569
    def revision_tree(self, revision_id):
526
570
        """Obtain a revision tree for the revision revision_id.
555
599
        # NB: we specifically *don't* call self.has_filename, because for
556
600
        # WorkingTrees that can indicate files that exist on disk but that
557
601
        # are not versioned.
558
 
        return set(p for p in paths if not self.is_versioned(p))
 
602
        pred = self.inventory.has_filename
 
603
        return set((p for p in paths if not pred(p)))
559
604
 
560
605
    def walkdirs(self, prefix=""):
561
606
        """Walk the contents of this tree from path down.
593
638
    def supports_content_filtering(self):
594
639
        return False
595
640
 
596
 
    def _content_filter_stack(self, path=None):
 
641
    def _content_filter_stack(self, path=None, file_id=None):
597
642
        """The stack of content filters for a path if filtering is supported.
598
643
 
599
644
        Readers will be applied in first-to-last order.
602
647
 
603
648
        :param path: path relative to the root of the tree
604
649
            or None if unknown
 
650
        :param file_id: file_id or None if unknown
605
651
        :return: the list of filters - [] if there are none
606
652
        """
607
653
        filter_pref_names = filters._get_registered_names()
608
654
        if len(filter_pref_names) == 0:
609
655
            return []
610
 
        prefs = next(self.iter_search_rules([path], filter_pref_names))
 
656
        if path is None:
 
657
            path = self.id2path(file_id)
 
658
        prefs = self.iter_search_rules([path], filter_pref_names).next()
611
659
        stk = filters._get_filter_stack_for(prefs)
612
660
        if 'filters' in debug.debug_flags:
613
 
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
 
661
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
614
662
        return stk
615
663
 
616
664
    def _content_filter_stack_provider(self):
623
671
        """
624
672
        if self.supports_content_filtering():
625
673
            return lambda path, file_id: \
626
 
                    self._content_filter_stack(path)
 
674
                    self._content_filter_stack(path, file_id)
627
675
        else:
628
676
            return None
629
677
 
649
697
                for path in path_names:
650
698
                    yield searcher.get_items(path)
651
699
 
 
700
    @needs_read_lock
652
701
    def _get_rules_searcher(self, default_searcher):
653
702
        """Get the RulesSearcher for this tree given the default one."""
654
703
        searcher = default_searcher
655
704
        return searcher
656
705
 
657
 
    def archive(self, format, name, root='', subdir=None,
658
 
                force_mtime=None):
659
 
        """Create an archive of this tree.
660
 
 
661
 
        :param format: Format name (e.g. 'tar')
662
 
        :param name: target file name
663
 
        :param root: Root directory name (or None)
664
 
        :param subdir: Subdirectory to export (or None)
665
 
        :return: Iterator over archive chunks
666
 
        """
667
 
        from .archive import create_archive
668
 
        with self.lock_read():
669
 
            return create_archive(format, self, name, root,
670
 
                    subdir, force_mtime=force_mtime)
671
 
 
672
 
    @classmethod
673
 
    def versionable_kind(cls, kind):
674
 
        """Check if this tree support versioning a specific file kind."""
675
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
706
 
 
707
######################################################################
 
708
# diff
 
709
 
 
710
# TODO: Merge these two functions into a single one that can operate
 
711
# on either a whole tree or a set of files.
 
712
 
 
713
# TODO: Return the diff in order by filename, not by category or in
 
714
# random order.  Can probably be done by lock-stepping through the
 
715
# filenames from both trees.
 
716
 
 
717
 
 
718
def file_status(filename, old_tree, new_tree):
 
719
    """Return single-letter status, old and new names for a file.
 
720
 
 
721
    The complexity here is in deciding how to represent renames;
 
722
    many complex cases are possible.
 
723
    """
 
724
    old_inv = old_tree.inventory
 
725
    new_inv = new_tree.inventory
 
726
    new_id = new_inv.path2id(filename)
 
727
    old_id = old_inv.path2id(filename)
 
728
 
 
729
    if not new_id and not old_id:
 
730
        # easy: doesn't exist in either; not versioned at all
 
731
        if new_tree.is_ignored(filename):
 
732
            return 'I', None, None
 
733
        else:
 
734
            return '?', None, None
 
735
    elif new_id:
 
736
        # There is now a file of this name, great.
 
737
        pass
 
738
    else:
 
739
        # There is no longer a file of this name, but we can describe
 
740
        # what happened to the file that used to have
 
741
        # this name.  There are two possibilities: either it was
 
742
        # deleted entirely, or renamed.
 
743
        if new_inv.has_id(old_id):
 
744
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
 
745
        else:
 
746
            return 'D', old_inv.id2path(old_id), None
 
747
 
 
748
    # if the file_id is new in this revision, it is added
 
749
    if new_id and not old_inv.has_id(new_id):
 
750
        return 'A'
 
751
 
 
752
    # if there used to be a file of this name, but that ID has now
 
753
    # disappeared, it is deleted
 
754
    if old_id and not new_inv.has_id(old_id):
 
755
        return 'D'
 
756
 
 
757
    return 'wtf?'
 
758
 
 
759
 
 
760
@deprecated_function(deprecated_in((1, 9, 0)))
 
761
def find_renames(old_inv, new_inv):
 
762
    for file_id in old_inv:
 
763
        if file_id not in new_inv:
 
764
            continue
 
765
        old_name = old_inv.id2path(file_id)
 
766
        new_name = new_inv.id2path(file_id)
 
767
        if old_name != new_name:
 
768
            yield (old_name, new_name)
 
769
 
 
770
 
 
771
def find_ids_across_trees(filenames, trees, require_versioned=True):
 
772
    """Find the ids corresponding to specified filenames.
 
773
 
 
774
    All matches in all trees will be used, and all children of matched
 
775
    directories will be used.
 
776
 
 
777
    :param filenames: The filenames to find file_ids for (if None, returns
 
778
        None)
 
779
    :param trees: The trees to find file_ids within
 
780
    :param require_versioned: if true, all specified filenames must occur in
 
781
    at least one tree.
 
782
    :return: a set of file ids for the specified filenames and their children.
 
783
    """
 
784
    if not filenames:
 
785
        return None
 
786
    specified_path_ids = _find_ids_across_trees(filenames, trees,
 
787
        require_versioned)
 
788
    return _find_children_across_trees(specified_path_ids, trees)
 
789
 
 
790
 
 
791
def _find_ids_across_trees(filenames, trees, require_versioned):
 
792
    """Find the ids corresponding to specified filenames.
 
793
 
 
794
    All matches in all trees will be used, but subdirectories are not scanned.
 
795
 
 
796
    :param filenames: The filenames to find file_ids for
 
797
    :param trees: The trees to find file_ids within
 
798
    :param require_versioned: if true, all specified filenames must occur in
 
799
        at least one tree.
 
800
    :return: a set of file ids for the specified filenames
 
801
    """
 
802
    not_versioned = []
 
803
    interesting_ids = set()
 
804
    for tree_path in filenames:
 
805
        not_found = True
 
806
        for tree in trees:
 
807
            file_id = tree.path2id(tree_path)
 
808
            if file_id is not None:
 
809
                interesting_ids.add(file_id)
 
810
                not_found = False
 
811
        if not_found:
 
812
            not_versioned.append(tree_path)
 
813
    if len(not_versioned) > 0 and require_versioned:
 
814
        raise errors.PathsNotVersionedError(not_versioned)
 
815
    return interesting_ids
 
816
 
 
817
 
 
818
def _find_children_across_trees(specified_ids, trees):
 
819
    """Return a set including specified ids and their children.
 
820
 
 
821
    All matches in all trees will be used.
 
822
 
 
823
    :param trees: The trees to find file_ids within
 
824
    :return: a set containing all specified ids and their children
 
825
    """
 
826
    interesting_ids = set(specified_ids)
 
827
    pending = interesting_ids
 
828
    # now handle children of interesting ids
 
829
    # we loop so that we handle all children of each id in both trees
 
830
    while len(pending) > 0:
 
831
        new_pending = set()
 
832
        for file_id in pending:
 
833
            for tree in trees:
 
834
                if not tree.has_or_had_id(file_id):
 
835
                    continue
 
836
                for child_id in tree.iter_children(file_id):
 
837
                    if child_id not in interesting_ids:
 
838
                        new_pending.add(child_id)
 
839
        interesting_ids.update(new_pending)
 
840
        pending = new_pending
 
841
    return interesting_ids
676
842
 
677
843
 
678
844
class InterTree(InterObject):
681
847
    Its instances have methods like 'compare' and contain references to the
682
848
    source and target trees these operations are to be carried out on.
683
849
 
684
 
    Clients of breezy should not need to use InterTree directly, rather they
 
850
    Clients of bzrlib should not need to use InterTree directly, rather they
685
851
    should use the convenience methods on Tree such as 'Tree.compare()' which
686
852
    will pass through to InterTree as appropriate.
687
853
    """
688
854
 
689
 
    # Formats that will be used to test this InterTree. If both are
690
 
    # None, this InterTree will not be tested (e.g. because a complex
691
 
    # setup is required)
692
 
    _matching_from_tree_format = None
693
 
    _matching_to_tree_format = None
694
 
 
695
855
    _optimisers = []
696
856
 
697
 
    @classmethod
698
 
    def is_compatible(kls, source, target):
699
 
        # The default implementation is naive and uses the public API, so
700
 
        # it works for all trees.
701
 
        return True
702
 
 
703
 
    def _changes_from_entries(self, source_entry, target_entry, source_path,
704
 
                              target_path):
 
857
    def _changes_from_entries(self, source_entry, target_entry,
 
858
        source_path=None, target_path=None):
705
859
        """Generate a iter_changes tuple between source_entry and target_entry.
706
860
 
707
861
        :param source_entry: An inventory entry from self.source, or None.
708
862
        :param target_entry: An inventory entry from self.target, or None.
709
 
        :param source_path: The path of source_entry.
710
 
        :param target_path: The path of target_entry.
 
863
        :param source_path: The path of source_entry, if known. If not known
 
864
            it will be looked up.
 
865
        :param target_path: The path of target_entry, if known. If not known
 
866
            it will be looked up.
711
867
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
712
868
            item 1 is True if there are any changes in the result tuple.
713
869
        """
721
877
            source_versioned = True
722
878
            source_name = source_entry.name
723
879
            source_parent = source_entry.parent_id
 
880
            if source_path is None:
 
881
                source_path = self.source.id2path(file_id)
724
882
            source_kind, source_executable, source_stat = \
725
883
                self.source._comparison_data(source_entry, source_path)
726
884
        else:
733
891
            target_versioned = True
734
892
            target_name = target_entry.name
735
893
            target_parent = target_entry.parent_id
 
894
            if target_path is None:
 
895
                target_path = self.target.id2path(file_id)
736
896
            target_kind, target_executable, target_stat = \
737
897
                self.target._comparison_data(target_entry, target_path)
738
898
        else:
747
907
        if source_kind != target_kind:
748
908
            changed_content = True
749
909
        elif source_kind == 'file':
750
 
            if not self.file_content_matches(
751
 
                    source_path, target_path,
752
 
                    file_id, file_id, source_stat, target_stat):
 
910
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
 
911
                self.target.get_file_sha1(file_id, target_path, target_stat)):
753
912
                changed_content = True
754
913
        elif source_kind == 'symlink':
755
 
            if (self.source.get_symlink_target(source_path, file_id) !=
756
 
                self.target.get_symlink_target(target_path, file_id)):
 
914
            if (self.source.get_symlink_target(file_id) !=
 
915
                self.target.get_symlink_target(file_id)):
757
916
                changed_content = True
758
 
        elif source_kind == 'tree-reference':
759
 
            if (self.source.get_reference_revision(source_path, file_id)
760
 
                != self.target.get_reference_revision(target_path, file_id)):
 
917
            # XXX: Yes, the indentation below is wrong. But fixing it broke
 
918
            # test_merge.TestMergerEntriesLCAOnDisk.
 
919
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
 
920
            # the fix from bzr.dev -- vila 2009026
 
921
            elif source_kind == 'tree-reference':
 
922
                if (self.source.get_reference_revision(file_id, source_path)
 
923
                    != self.target.get_reference_revision(file_id, target_path)):
761
924
                    changed_content = True
762
925
        parent = (source_parent, target_parent)
763
926
        name = (source_name, target_name)
771
934
        return (file_id, (source_path, target_path), changed_content,
772
935
                versioned, parent, name, kind, executable), changes
773
936
 
 
937
    @needs_read_lock
774
938
    def compare(self, want_unchanged=False, specific_files=None,
775
939
        extra_trees=None, require_versioned=False, include_root=False,
776
940
        want_unversioned=False):
790
954
            a PathsNotVersionedError will be thrown.
791
955
        :param want_unversioned: Scan for unversioned paths.
792
956
        """
 
957
        # NB: show_status depends on being able to pass in non-versioned files
 
958
        # and report them as unknown
793
959
        trees = (self.source,)
794
960
        if extra_trees is not None:
795
961
            trees = trees + tuple(extra_trees)
796
 
        with self.lock_read():
797
 
            return delta._compare_trees(self.source, self.target, want_unchanged,
798
 
                specific_files, include_root, extra_trees=extra_trees,
799
 
                require_versioned=require_versioned,
800
 
                want_unversioned=want_unversioned)
 
962
        # target is usually the newer tree:
 
963
        specific_file_ids = self.target.paths2ids(specific_files, trees,
 
964
            require_versioned=require_versioned)
 
965
        if specific_files and not specific_file_ids:
 
966
            # All files are unversioned, so just return an empty delta
 
967
            # _compare_trees would think we want a complete delta
 
968
            result = delta.TreeDelta()
 
969
            fake_entry = InventoryFile('unused', 'unused', 'unused')
 
970
            result.unversioned = [(path, None,
 
971
                self.target._comparison_data(fake_entry, path)[0]) for path in
 
972
                specific_files]
 
973
            return result
 
974
        return delta._compare_trees(self.source, self.target, want_unchanged,
 
975
            specific_files, include_root, extra_trees=extra_trees,
 
976
            require_versioned=require_versioned,
 
977
            want_unversioned=want_unversioned)
801
978
 
802
979
    def iter_changes(self, include_unchanged=False,
803
980
                      specific_files=None, pb=None, extra_trees=[],
835
1012
            output. An unversioned file is defined as one with (False, False)
836
1013
            for the versioned pair.
837
1014
        """
838
 
        if not extra_trees:
839
 
             extra_trees = []
840
 
        else:
841
 
             extra_trees = list(extra_trees)
 
1015
        lookup_trees = [self.source]
 
1016
        if extra_trees:
 
1017
             lookup_trees.extend(extra_trees)
842
1018
        # The ids of items we need to examine to insure delta consistency.
843
1019
        precise_file_ids = set()
844
1020
        changed_file_ids = []
845
1021
        if specific_files == []:
846
 
            target_specific_files = []
847
 
            source_specific_files = []
 
1022
            specific_file_ids = []
848
1023
        else:
849
 
            target_specific_files = self.target.find_related_paths_across_trees(
850
 
                    specific_files, [self.source] + extra_trees,
851
 
                    require_versioned=require_versioned)
852
 
            source_specific_files = self.source.find_related_paths_across_trees(
853
 
                    specific_files, [self.target] + extra_trees,
854
 
                    require_versioned=require_versioned)
 
1024
            specific_file_ids = self.target.paths2ids(specific_files,
 
1025
                lookup_trees, require_versioned=require_versioned)
855
1026
        if specific_files is not None:
856
1027
            # reparented or added entries must have their parents included
857
1028
            # so that valid deltas can be created. The seen_parents set
866
1037
                                     self.target.extras()
867
1038
                if specific_files is None or
868
1039
                    osutils.is_inside_any(specific_files, p)])
869
 
            all_unversioned = collections.deque(all_unversioned)
 
1040
            all_unversioned = deque(all_unversioned)
870
1041
        else:
871
 
            all_unversioned = collections.deque()
 
1042
            all_unversioned = deque()
872
1043
        to_paths = {}
873
1044
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
874
 
            specific_files=source_specific_files))
 
1045
            specific_file_ids=specific_file_ids))
875
1046
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
876
1047
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
877
 
            specific_files=target_specific_files))
 
1048
            specific_file_ids=specific_file_ids))
878
1049
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
879
1050
        entry_count = 0
880
1051
        # the unversioned path lookup only occurs on real trees - where there
881
1052
        # can be extras. So the fake_entry is solely used to look up
882
1053
        # executable it values when execute is not supported.
883
 
        fake_entry = TreeFile()
 
1054
        fake_entry = InventoryFile('unused', 'unused', 'unused')
884
1055
        for target_path, target_entry in to_entries_by_dir:
885
1056
            while (all_unversioned and
886
1057
                all_unversioned[0][0] < target_path.split('/')):
903
1074
            if pb is not None:
904
1075
                pb.update('comparing files', entry_count, num_entries)
905
1076
            if changes or include_unchanged:
906
 
                if specific_files is not None:
 
1077
                if specific_file_ids is not None:
907
1078
                    new_parent_id = result[4][1]
908
1079
                    precise_file_ids.add(new_parent_id)
909
1080
                    changed_file_ids.append(result[0])
934
1105
            if file_id in to_paths:
935
1106
                # already returned
936
1107
                continue
937
 
            to_path = find_previous_path(self.source, self.target, path)
 
1108
            if file_id not in self.target.all_file_ids():
 
1109
                # common case - paths we have not emitted are not present in
 
1110
                # target.
 
1111
                to_path = None
 
1112
            else:
 
1113
                to_path = self.target.id2path(file_id)
938
1114
            entry_count += 1
939
1115
            if pb is not None:
940
1116
                pb.update('comparing files', entry_count, num_entries)
951
1127
            yield(file_id, (path, to_path), changed_content, versioned, parent,
952
1128
                  name, kind, executable)
953
1129
        changed_file_ids = set(changed_file_ids)
954
 
        if specific_files is not None:
 
1130
        if specific_file_ids is not None:
955
1131
            for result in self._handle_precise_ids(precise_file_ids,
956
1132
                changed_file_ids):
957
1133
                yield result
958
1134
 
959
 
    def _get_entry(self, tree, path):
 
1135
    def _get_entry(self, tree, file_id):
960
1136
        """Get an inventory entry from a tree, with missing entries as None.
961
1137
 
962
1138
        If the tree raises NotImplementedError on accessing .inventory, then
966
1142
        :param tree: The tree to lookup the entry in.
967
1143
        :param file_id: The file_id to lookup.
968
1144
        """
969
 
        # No inventory available.
970
1145
        try:
971
 
            iterator = tree.iter_entries_by_dir(specific_files=[path])
972
 
            return next(iterator)[1]
973
 
        except StopIteration:
974
 
            return None
 
1146
            inventory = tree.inventory
 
1147
        except NotImplementedError:
 
1148
            # No inventory available.
 
1149
            try:
 
1150
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
 
1151
                return iterator.next()[1]
 
1152
            except StopIteration:
 
1153
                return None
 
1154
        else:
 
1155
            try:
 
1156
                return inventory[file_id]
 
1157
            except errors.NoSuchId:
 
1158
                return None
975
1159
 
976
1160
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
977
1161
        discarded_changes=None):
1019
1203
                # Examine file_id
1020
1204
                if discarded_changes:
1021
1205
                    result = discarded_changes.get(file_id)
1022
 
                    source_entry = None
 
1206
                    old_entry = None
1023
1207
                else:
1024
1208
                    result = None
1025
1209
                if result is None:
1026
 
                    try:
1027
 
                        source_path = self.source.id2path(file_id)
1028
 
                    except errors.NoSuchId:
1029
 
                        source_path = None
1030
 
                        source_entry = None
1031
 
                    else:
1032
 
                        source_entry = self._get_entry(self.source, source_path)
1033
 
                    try:
1034
 
                        target_path = self.target.id2path(file_id)
1035
 
                    except errors.NoSuchId:
1036
 
                        target_path = None
1037
 
                        target_entry = None
1038
 
                    else:
1039
 
                        target_entry = self._get_entry(self.target, target_path)
 
1210
                    old_entry = self._get_entry(self.source, file_id)
 
1211
                    new_entry = self._get_entry(self.target, file_id)
1040
1212
                    result, changes = self._changes_from_entries(
1041
 
                        source_entry, target_entry, source_path, target_path)
 
1213
                        old_entry, new_entry)
1042
1214
                else:
1043
1215
                    changes = True
1044
1216
                # Get this parents parent to examine.
1046
1218
                precise_file_ids.add(new_parent_id)
1047
1219
                if changes:
1048
1220
                    if (result[6][0] == 'directory' and
1049
 
                            result[6][1] != 'directory'):
 
1221
                        result[6][1] != 'directory'):
1050
1222
                        # This stopped being a directory, the old children have
1051
1223
                        # to be included.
1052
 
                        if source_entry is None:
 
1224
                        if old_entry is None:
1053
1225
                            # Reusing a discarded change.
1054
 
                            source_entry = self._get_entry(self.source, result[1][0])
1055
 
                        precise_file_ids.update(
1056
 
                                child.file_id
1057
 
                                for child in self.source.iter_child_entries(result[1][0]))
 
1226
                            old_entry = self._get_entry(self.source, file_id)
 
1227
                        for child in old_entry.children.values():
 
1228
                            precise_file_ids.add(child.file_id)
1058
1229
                    changed_file_ids.add(result[0])
1059
1230
                    yield result
1060
1231
 
1061
 
    def file_content_matches(
1062
 
            self, source_path, target_path,
1063
 
            source_file_id=None, target_file_id=None,
1064
 
            source_stat=None, target_stat=None):
1065
 
        """Check if two files are the same in the source and target trees.
1066
 
 
1067
 
        This only checks that the contents of the files are the same,
1068
 
        it does not touch anything else.
1069
 
 
1070
 
        :param source_path: Path of the file in the source tree
1071
 
        :param target_path: Path of the file in the target tree
1072
 
        :param source_file_id: Optional file id of the file in the source tree
1073
 
        :param target_file_id: Optional file id of the file in the target tree
1074
 
        :param source_stat: Optional stat value of the file in the source tree
1075
 
        :param target_stat: Optional stat value of the file in the target tree
1076
 
        :return: Boolean indicating whether the files have the same contents
1077
 
        """
1078
 
        with self.lock_read():
1079
 
            source_verifier_kind, source_verifier_data = (
1080
 
                    self.source.get_file_verifier(
1081
 
                        source_path, source_file_id, source_stat))
1082
 
            target_verifier_kind, target_verifier_data = (
1083
 
                self.target.get_file_verifier(
1084
 
                    target_path, target_file_id, target_stat))
1085
 
            if source_verifier_kind == target_verifier_kind:
1086
 
                return (source_verifier_data == target_verifier_data)
1087
 
            # Fall back to SHA1 for now
1088
 
            if source_verifier_kind != "SHA1":
1089
 
                source_sha1 = self.source.get_file_sha1(
1090
 
                        source_path, source_file_id, source_stat)
1091
 
            else:
1092
 
                source_sha1 = source_verifier_data
1093
 
            if target_verifier_kind != "SHA1":
1094
 
                target_sha1 = self.target.get_file_sha1(
1095
 
                        target_path, target_file_id, target_stat)
1096
 
            else:
1097
 
                target_sha1 = target_verifier_data
1098
 
            return (source_sha1 == target_sha1)
1099
 
 
1100
 
InterTree.register_optimiser(InterTree)
1101
 
 
1102
1232
 
1103
1233
class MultiWalker(object):
1104
1234
    """Walk multiple trees simultaneously, getting combined results."""
1138
1268
            If has_more is False, path and ie will be None.
1139
1269
        """
1140
1270
        try:
1141
 
            path, ie = next(iterator)
 
1271
            path, ie = iterator.next()
1142
1272
        except StopIteration:
1143
1273
            return False, None, None
1144
1274
        else:
1164
1294
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1165
1295
        # Unicode objects. Consider using encode_utf8() and then using the
1166
1296
        # optimized versions, or maybe writing optimized unicode versions.
1167
 
        if not isinstance(path1, text_type):
 
1297
        if not isinstance(path1, unicode):
1168
1298
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1169
1299
                            % (type(path1), path1))
1170
 
        if not isinstance(path2, text_type):
 
1300
        if not isinstance(path2, unicode):
1171
1301
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1172
1302
                            % (type(path2), path2))
1173
1303
        return cmp(MultiWalker._path_to_key(path1),
1207
1337
            return (None, None)
1208
1338
        else:
1209
1339
            self._out_of_order_processed.add(file_id)
1210
 
            cur_ie = other_tree.root_inventory.get_entry(file_id)
 
1340
            cur_ie = other_tree.inventory[file_id]
1211
1341
            return (cur_path, cur_ie)
1212
1342
 
1213
1343
    def iter_all(self):
1234
1364
                         for other in self._other_trees]
1235
1365
        other_entries = [self._step_one(walker) for walker in other_walkers]
1236
1366
        # Track extra nodes in the other trees
1237
 
        others_extra = [{} for _ in range(len(self._other_trees))]
 
1367
        others_extra = [{} for i in xrange(len(self._other_trees))]
1238
1368
 
1239
1369
        master_has_more = True
1240
1370
        step_one = self._step_one
1314
1444
        #       might ensure better ordering, in case a caller strictly
1315
1445
        #       requires parents before children.
1316
1446
        for idx, other_extra in enumerate(self._others_extra):
1317
 
            others = sorted(viewvalues(other_extra),
 
1447
            others = sorted(other_extra.itervalues(),
1318
1448
                            key=lambda x: self._path_to_key(x[0]))
1319
1449
            for other_path, other_ie in others:
1320
1450
                file_id = other_ie.file_id
1322
1452
                # the lookup_by_file_id will be removing anything processed
1323
1453
                # from the extras cache
1324
1454
                other_extra.pop(file_id)
1325
 
                other_values = [(None, None)] * idx
 
1455
                other_values = [(None, None) for i in xrange(idx)]
1326
1456
                other_values.append((other_path, other_ie))
1327
1457
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1328
1458
                    alt_idx = alt_idx + idx + 1
1331
1461
                    other_values.append(self._lookup_by_file_id(
1332
1462
                                            alt_extra, alt_tree, file_id))
1333
1463
                yield other_path, file_id, None, other_values
1334
 
 
1335
 
 
1336
 
def find_previous_paths(from_tree, to_tree, paths):
1337
 
    """Find previous tree paths.
1338
 
 
1339
 
    :param from_tree: From tree
1340
 
    :param to_tree: To tree
1341
 
    :param paths: Iterable over paths to search for
1342
 
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
1343
 
        None if there is no equivalent path.
1344
 
    """
1345
 
    ret = {}
1346
 
    for path in paths:
1347
 
        ret[path] = find_previous_path(from_tree, to_tree, path)
1348
 
    return ret
1349
 
 
1350
 
 
1351
 
def find_previous_path(from_tree, to_tree, path, file_id=None):
1352
 
    """Find previous tree path.
1353
 
 
1354
 
    :param from_tree: From tree
1355
 
    :param to_tree: To tree
1356
 
    :param path: Path to search for
1357
 
    :return: path in to_tree, or None if there is no equivalent path.
1358
 
    """
1359
 
    if file_id is None:
1360
 
        file_id = from_tree.path2id(path)
1361
 
    if file_id is None:
1362
 
        raise errors.NoSuchFile(path)
1363
 
    try:
1364
 
        return to_tree.id2path(file_id)
1365
 
    except errors.NoSuchId:
1366
 
        return None