/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 breezy/tree.py

  • Committer: Martin
  • Date: 2018-08-21 00:53:34 UTC
  • mto: This revision was merged to the branch mainline in revision 7074.
  • Revision ID: gzlist@googlemail.com-20180821005334-e1ogxakojyybpwib
Fix recursion check in C bencode implementation

Hard to get Cython to do the right thing but by inverting the
return code can use the standard except handling.

Avoid going through a Python call when encoding, which requires
the encode recursion check to work too.

Adjust tests to use a smaller limit to be more managable.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
 
20
22
import os
21
 
from collections import deque
22
 
 
23
 
import bzrlib
24
 
from bzrlib import (
 
23
 
 
24
from .lazy_import import lazy_import
 
25
lazy_import(globals(), """
 
26
import collections
 
27
 
 
28
from breezy import (
25
29
    conflicts as _mod_conflicts,
26
30
    debug,
27
31
    delta,
28
32
    filters,
29
 
    osutils,
30
33
    revision as _mod_revision,
31
34
    rules,
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
 
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
40
 
from bzrlib.trace import note
 
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 '/'
41
101
 
42
102
 
43
103
class Tree(object):
49
109
 
50
110
    * `RevisionTree` is a tree as recorded at some point in the past.
51
111
 
52
 
    Trees contain an `Inventory` object, and also know how to retrieve
53
 
    file texts mentioned in the inventory, either from a working
54
 
    directory or from a store.
55
 
 
56
 
    It is possible for trees to contain files that are not described
57
 
    in their inventory or vice versa; for this use `filenames()`.
58
 
 
59
112
    Trees can be compared, etc, regardless of whether they are working
60
113
    trees or versioned trees.
61
114
    """
62
115
 
 
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
 
63
132
    def changes_from(self, other, want_unchanged=False, specific_files=None,
64
133
        extra_trees=None, require_versioned=False, include_root=False,
65
134
        want_unversioned=False):
105
174
    def conflicts(self):
106
175
        """Get a list of the conflicts in the tree.
107
176
 
108
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
177
        Each conflict is an instance of breezy.conflicts.Conflict.
109
178
        """
110
179
        return _mod_conflicts.ConflictList()
111
180
 
126
195
        """True if the tree has given filename."""
127
196
        raise NotImplementedError(self.has_filename)
128
197
 
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
 
 
138
198
    def is_ignored(self, filename):
139
199
        """Check whether the filename is ignored by this tree.
140
200
 
143
203
        """
144
204
        return False
145
205
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
148
 
 
149
206
    def all_file_ids(self):
150
207
        """Iterate through all file ids, including ids for missing files."""
151
 
        return set(self.inventory)
 
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)
152
213
 
153
214
    def id2path(self, file_id):
154
215
        """Return the path for a file id.
155
216
 
156
217
        :raises NoSuchId:
157
218
        """
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):
 
219
        raise NotImplementedError(self.id2path)
 
220
 
 
221
    def iter_entries_by_dir(self, specific_files=None):
174
222
        """Walk the tree in 'by_dir' order.
175
223
 
176
224
        This will yield each entry in the tree as a (path, entry) tuple.
192
240
             g
193
241
 
194
242
        The yield order (ignoring root) would be::
 
243
 
195
244
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
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)
 
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)
203
268
 
204
269
    def iter_references(self):
205
270
        if self.supports_tree_reference():
207
272
                if entry.kind == 'tree-reference':
208
273
                    yield path, entry.file_id
209
274
 
210
 
    def kind(self, file_id):
 
275
    def kind(self, path, file_id=None):
211
276
        raise NotImplementedError("Tree subclass %s must implement kind"
212
277
            % self.__class__.__name__)
213
278
 
214
 
    def stored_kind(self, file_id):
 
279
    def stored_kind(self, path, file_id=None):
215
280
        """File kind stored for this file_id.
216
281
 
217
282
        May not match kind on disk for working trees.  Always available
218
283
        for versioned files, even when the file itself is missing.
219
284
        """
220
 
        return self.kind(file_id)
 
285
        return self.kind(path, file_id)
221
286
 
222
287
    def path_content_summary(self, path):
223
288
        """Get a summary of the information about path.
237
302
        """
238
303
        raise NotImplementedError(self.path_content_summary)
239
304
 
240
 
    def get_reference_revision(self, file_id, path=None):
 
305
    def get_reference_revision(self, path, file_id=None):
241
306
        raise NotImplementedError("Tree subclass %s must implement "
242
307
                                  "get_reference_revision"
243
308
            % self.__class__.__name__)
253
318
        """
254
319
        raise NotImplementedError(self._comparison_data)
255
320
 
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):
 
321
    def get_file(self, path, file_id=None):
263
322
        """Return a file object for the file file_id in the tree.
264
323
 
265
324
        If both file_id and path are defined, it is implementation defined as
267
326
        """
268
327
        raise NotImplementedError(self.get_file)
269
328
 
270
 
    def get_file_with_stat(self, file_id, path=None):
 
329
    def get_file_with_stat(self, path, file_id=None):
271
330
        """Get a file handle and stat object for file_id.
272
331
 
273
332
        The default implementation returns (self.get_file, None) for backwards
274
333
        compatibility.
275
334
 
276
 
        :param file_id: The file id to read.
277
 
        :param path: The path of the file, if it is known.
 
335
        :param path: The path of the file.
 
336
        :param file_id: The file id to read, if it is known.
278
337
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
279
338
            no stat facility, or need for a stat cache feedback during commit,
280
339
            it may return None for the second element of the tuple.
281
340
        """
282
 
        return (self.get_file(file_id, path), None)
 
341
        return (self.get_file(path, file_id), None)
283
342
 
284
 
    def get_file_text(self, file_id, path=None):
 
343
    def get_file_text(self, path, file_id=None):
285
344
        """Return the byte content of a file.
286
345
 
 
346
        :param path: The path of the file.
287
347
        :param file_id: The file_id of the file.
288
 
        :param path: The path of the file.
 
348
 
289
349
        If both file_id and path are supplied, an implementation may use
290
350
        either one.
 
351
 
 
352
        :returns: A single byte string for the whole file.
291
353
        """
292
 
        my_file = self.get_file(file_id, path)
293
 
        try:
 
354
        with self.get_file(path, file_id) as my_file:
294
355
            return my_file.read()
295
 
        finally:
296
 
            my_file.close()
297
356
 
298
 
    def get_file_lines(self, file_id, path=None):
 
357
    def get_file_lines(self, path, file_id=None):
299
358
        """Return the content of a file, as lines.
300
359
 
 
360
        :param path: The path of the file.
301
361
        :param file_id: The file_id of the file.
302
 
        :param path: The path of the file.
 
362
 
303
363
        If both file_id and path are supplied, an implementation may use
304
364
        either one.
305
365
        """
306
 
        return osutils.split_lines(self.get_file_text(file_id, path))
307
 
 
308
 
    def get_file_mtime(self, file_id, path=None):
 
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):
309
397
        """Return the modification time for a file.
310
398
 
 
399
        :param path: The path that this file can be found at.
311
400
        :param file_id: The handle for this file.
312
 
        :param path: The path that this file can be found at.
313
401
            These must point to the same object.
314
402
        """
315
403
        raise NotImplementedError(self.get_file_mtime)
316
404
 
317
 
    def get_file_size(self, file_id):
 
405
    def get_file_size(self, path, file_id=None):
318
406
        """Return the size of a file in bytes.
319
407
 
320
408
        This applies only to regular files.  If invoked on directories or
323
411
        """
324
412
        raise NotImplementedError(self.get_file_size)
325
413
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
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)
328
422
 
329
423
    def iter_files_bytes(self, desired_files):
330
424
        """Iterate through file contents.
342
436
        this implementation, it is a tuple containing a single bytestring with
343
437
        the complete text of the file.
344
438
 
345
 
        :param desired_files: a list of (file_id, identifier) pairs
 
439
        :param desired_files: a list of (path, identifier) pairs
346
440
        """
347
 
        for file_id, identifier in desired_files:
 
441
        for path, identifier in desired_files:
348
442
            # We wrap the string in a tuple so that we can return an iterable
349
443
            # of bytestrings.  (Technically, a bytestring is also an iterable
350
444
            # of bytestrings, but iterating through each character is not
351
445
            # performant.)
352
 
            cur_file = (self.get_file_text(file_id),)
 
446
            cur_file = (self.get_file_text(path),)
353
447
            yield identifier, cur_file
354
448
 
355
 
    def get_symlink_target(self, file_id):
 
449
    def get_symlink_target(self, path, file_id=None):
356
450
        """Get the target for a given file_id.
357
451
 
358
452
        It is assumed that the caller already knows that file_id is referencing
359
453
        a symlink.
360
454
        :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.
361
458
        :return: The path the symlink points to.
362
459
        """
363
460
        raise NotImplementedError(self.get_symlink_target)
364
461
 
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
 
                new_path = None
408
 
                for child in self.iter_children(cur_id):
409
 
                    try:
410
 
                        # XXX: it seem like if the child is known to be in the
411
 
                        # tree, we shouldn't need to go from its id back to
412
 
                        # its path -- mbp 2010-02-11
413
 
                        #
414
 
                        # XXX: it seems like we could be more efficient
415
 
                        # by just directly looking up the original name and
416
 
                        # only then searching all children; also by not
417
 
                        # chopping paths so much. -- mbp 2010-02-11
418
 
                        child_base = os.path.basename(self.id2path(child))
419
 
                        if (child_base == elt):
420
 
                            # if we found an exact match, we can stop now; if
421
 
                            # we found an approximate match we need to keep
422
 
                            # searching because there might be an exact match
423
 
                            # later.  
424
 
                            cur_id = child
425
 
                            new_path = osutils.pathjoin(cur_path, child_base)
426
 
                            break
427
 
                        elif child_base.lower() == lelt:
428
 
                            cur_id = child
429
 
                            new_path = osutils.pathjoin(cur_path, child_base)
430
 
                    except NoSuchId:
431
 
                        # before a change is committed we can see this error...
432
 
                        continue
433
 
                if new_path:
434
 
                    cur_path = new_path
435
 
                else:
436
 
                    # got to the end of this directory and no entries matched.
437
 
                    # Return what matched so far, plus the rest as specified.
438
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
439
 
                    break
440
 
            yield cur_path
441
 
        # all done.
442
 
 
443
462
    def get_root_id(self):
444
463
        """Return the file_id for the root of this tree."""
445
464
        raise NotImplementedError(self.get_root_id)
446
465
 
447
 
    def annotate_iter(self, file_id,
 
466
    def annotate_iter(self, path, file_id=None,
448
467
                      default_revision=_mod_revision.CURRENT_REVISION):
449
468
        """Return an iterator of revision_id, line tuples.
450
469
 
458
477
        """
459
478
        raise NotImplementedError(self.annotate_iter)
460
479
 
461
 
    def _get_plan_merge_data(self, file_id, other, base):
462
 
        from bzrlib import versionedfile
463
 
        vf = versionedfile._PlanMergeVersionedFile(file_id)
464
 
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
465
 
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
466
 
        if base is None:
467
 
            last_revision_base = None
468
 
        else:
469
 
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
470
 
        return vf, last_revision_a, last_revision_b, last_revision_base
471
 
 
472
 
    def plan_file_merge(self, file_id, other, base=None):
473
 
        """Generate a merge plan based on annotations.
474
 
 
475
 
        If the file contains uncommitted changes in this tree, they will be
476
 
        attributed to the 'current:' pseudo-revision.  If the file contains
477
 
        uncommitted changes in the other tree, they will be assigned to the
478
 
        'other:' pseudo-revision.
479
 
        """
480
 
        data = self._get_plan_merge_data(file_id, other, base)
481
 
        vf, last_revision_a, last_revision_b, last_revision_base = data
482
 
        return vf.plan_merge(last_revision_a, last_revision_b,
483
 
                             last_revision_base)
484
 
 
485
 
    def plan_file_lca_merge(self, file_id, other, base=None):
486
 
        """Generate a merge plan based lca-newness.
487
 
 
488
 
        If the file contains uncommitted changes in this tree, they will be
489
 
        attributed to the 'current:' pseudo-revision.  If the file contains
490
 
        uncommitted changes in the other tree, they will be assigned to the
491
 
        'other:' pseudo-revision.
492
 
        """
493
 
        data = self._get_plan_merge_data(file_id, other, base)
494
 
        vf, last_revision_a, last_revision_b, last_revision_base = data
495
 
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
496
 
                                 last_revision_base)
497
 
 
498
480
    def _iter_parent_trees(self):
499
481
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
500
482
        for revision_id in self.get_parent_ids():
503
485
            except errors.NoSuchRevisionInTree:
504
486
                yield self.repository.revision_tree(revision_id)
505
487
 
506
 
    @staticmethod
507
 
    def _file_revision(revision_tree, file_id):
508
 
        """Determine the revision associated with a file in a given tree."""
509
 
        revision_tree.lock_read()
510
 
        try:
511
 
            return revision_tree.inventory[file_id].revision
512
 
        finally:
513
 
            revision_tree.unlock()
514
 
 
515
 
    def _get_file_revision(self, file_id, vf, tree_revision):
516
 
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
517
 
 
518
 
        if getattr(self, '_repository', None) is None:
519
 
            last_revision = tree_revision
520
 
            parent_keys = [(file_id, self._file_revision(t, file_id)) for t in
521
 
                self._iter_parent_trees()]
522
 
            vf.add_lines((file_id, last_revision), parent_keys,
523
 
                         self.get_file(file_id).readlines())
524
 
            repo = self.branch.repository
525
 
            base_vf = repo.texts
526
 
        else:
527
 
            last_revision = self._file_revision(self, file_id)
528
 
            base_vf = self._repository.texts
529
 
        if base_vf not in vf.fallback_versionedfiles:
530
 
            vf.fallback_versionedfiles.append(base_vf)
531
 
        return last_revision
532
 
 
533
 
    inventory = property(_get_inventory,
534
 
                         doc="Inventory of this Tree")
535
 
 
536
 
    def _check_retrieved(self, ie, f):
537
 
        if not __debug__:
538
 
            return
539
 
        fp = fingerprint_file(f)
540
 
        f.seek(0)
541
 
 
542
 
        if ie.text_size is not None:
543
 
            if ie.text_size != fp['size']:
544
 
                raise BzrError("mismatched size for file %r in %r" % (ie.file_id, self._store),
545
 
                        ["inventory expects %d bytes" % ie.text_size,
546
 
                         "file is actually %d bytes" % fp['size'],
547
 
                         "store is probably damaged/corrupt"])
548
 
 
549
 
        if ie.text_sha1 != fp['sha1']:
550
 
            raise BzrError("wrong SHA-1 for file %r in %r" % (ie.file_id, self._store),
551
 
                    ["inventory expects %s" % ie.text_sha1,
552
 
                     "file is actually %s" % fp['sha1'],
553
 
                     "store is probably damaged/corrupt"])
554
 
 
555
 
    @needs_read_lock
556
488
    def path2id(self, path):
557
489
        """Return the id for path in this tree."""
558
 
        return self._inventory.path2id(path)
559
 
 
560
 
    def paths2ids(self, paths, trees=[], require_versioned=True):
561
 
        """Return all the ids that can be reached by walking from paths.
562
 
 
563
 
        Each path is looked up in this tree and any extras provided in
564
 
        trees, and this is repeated recursively: the children in an extra tree
565
 
        of a directory that has been renamed under a provided path in this tree
566
 
        are all returned, even if none exist under a provided path in this
567
 
        tree, and vice versa.
568
 
 
569
 
        :param paths: An iterable of paths to start converting to ids from.
570
 
            Alternatively, if paths is None, no ids should be calculated and None
571
 
            will be returned. This is offered to make calling the api unconditional
572
 
            for code that *might* take a list of files.
573
 
        :param trees: Additional trees to consider.
574
 
        :param require_versioned: If False, do not raise NotVersionedError if
575
 
            an element of paths is not versioned in this tree and all of trees.
576
 
        """
577
 
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
578
 
 
579
 
    def iter_children(self, file_id):
580
 
        entry = self.iter_entries_by_dir([file_id]).next()[1]
581
 
        for child in getattr(entry, 'children', {}).itervalues():
582
 
            yield child.file_id
 
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)
583
517
 
584
518
    def lock_read(self):
585
519
        """Lock this tree for multiple read only operations.
586
 
        
587
 
        :return: A bzrlib.lock.LogicalLockResult.
 
520
 
 
521
        :return: A breezy.lock.LogicalLockResult.
588
522
        """
589
 
        pass
 
523
        return lock.LogicalLockResult(self.unlock)
590
524
 
591
525
    def revision_tree(self, revision_id):
592
526
        """Obtain a revision tree for the revision revision_id.
621
555
        # NB: we specifically *don't* call self.has_filename, because for
622
556
        # WorkingTrees that can indicate files that exist on disk but that
623
557
        # are not versioned.
624
 
        pred = self.inventory.has_filename
625
 
        return set((p for p in paths if not pred(p)))
 
558
        return set(p for p in paths if not self.is_versioned(p))
626
559
 
627
560
    def walkdirs(self, prefix=""):
628
561
        """Walk the contents of this tree from path down.
660
593
    def supports_content_filtering(self):
661
594
        return False
662
595
 
663
 
    def _content_filter_stack(self, path=None, file_id=None):
 
596
    def _content_filter_stack(self, path=None):
664
597
        """The stack of content filters for a path if filtering is supported.
665
598
 
666
599
        Readers will be applied in first-to-last order.
669
602
 
670
603
        :param path: path relative to the root of the tree
671
604
            or None if unknown
672
 
        :param file_id: file_id or None if unknown
673
605
        :return: the list of filters - [] if there are none
674
606
        """
675
607
        filter_pref_names = filters._get_registered_names()
676
608
        if len(filter_pref_names) == 0:
677
609
            return []
678
 
        if path is None:
679
 
            path = self.id2path(file_id)
680
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
610
        prefs = next(self.iter_search_rules([path], filter_pref_names))
681
611
        stk = filters._get_filter_stack_for(prefs)
682
612
        if 'filters' in debug.debug_flags:
683
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
613
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
684
614
        return stk
685
615
 
686
616
    def _content_filter_stack_provider(self):
693
623
        """
694
624
        if self.supports_content_filtering():
695
625
            return lambda path, file_id: \
696
 
                    self._content_filter_stack(path, file_id)
 
626
                    self._content_filter_stack(path)
697
627
        else:
698
628
            return None
699
629
 
724
654
        searcher = default_searcher
725
655
        return searcher
726
656
 
727
 
 
728
 
######################################################################
729
 
# diff
730
 
 
731
 
# TODO: Merge these two functions into a single one that can operate
732
 
# on either a whole tree or a set of files.
733
 
 
734
 
# TODO: Return the diff in order by filename, not by category or in
735
 
# random order.  Can probably be done by lock-stepping through the
736
 
# filenames from both trees.
737
 
 
738
 
 
739
 
def file_status(filename, old_tree, new_tree):
740
 
    """Return single-letter status, old and new names for a file.
741
 
 
742
 
    The complexity here is in deciding how to represent renames;
743
 
    many complex cases are possible.
744
 
    """
745
 
    old_inv = old_tree.inventory
746
 
    new_inv = new_tree.inventory
747
 
    new_id = new_inv.path2id(filename)
748
 
    old_id = old_inv.path2id(filename)
749
 
 
750
 
    if not new_id and not old_id:
751
 
        # easy: doesn't exist in either; not versioned at all
752
 
        if new_tree.is_ignored(filename):
753
 
            return 'I', None, None
754
 
        else:
755
 
            return '?', None, None
756
 
    elif new_id:
757
 
        # There is now a file of this name, great.
758
 
        pass
759
 
    else:
760
 
        # There is no longer a file of this name, but we can describe
761
 
        # what happened to the file that used to have
762
 
        # this name.  There are two possibilities: either it was
763
 
        # deleted entirely, or renamed.
764
 
        if new_inv.has_id(old_id):
765
 
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
766
 
        else:
767
 
            return 'D', old_inv.id2path(old_id), None
768
 
 
769
 
    # if the file_id is new in this revision, it is added
770
 
    if new_id and not old_inv.has_id(new_id):
771
 
        return 'A'
772
 
 
773
 
    # if there used to be a file of this name, but that ID has now
774
 
    # disappeared, it is deleted
775
 
    if old_id and not new_inv.has_id(old_id):
776
 
        return 'D'
777
 
 
778
 
    return 'wtf?'
779
 
 
780
 
 
781
 
@deprecated_function(deprecated_in((1, 9, 0)))
782
 
def find_renames(old_inv, new_inv):
783
 
    for file_id in old_inv:
784
 
        if file_id not in new_inv:
785
 
            continue
786
 
        old_name = old_inv.id2path(file_id)
787
 
        new_name = new_inv.id2path(file_id)
788
 
        if old_name != new_name:
789
 
            yield (old_name, new_name)
790
 
 
791
 
 
792
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
793
 
    """Find the ids corresponding to specified filenames.
794
 
 
795
 
    All matches in all trees will be used, and all children of matched
796
 
    directories will be used.
797
 
 
798
 
    :param filenames: The filenames to find file_ids for (if None, returns
799
 
        None)
800
 
    :param trees: The trees to find file_ids within
801
 
    :param require_versioned: if true, all specified filenames must occur in
802
 
    at least one tree.
803
 
    :return: a set of file ids for the specified filenames and their children.
804
 
    """
805
 
    if not filenames:
806
 
        return None
807
 
    specified_path_ids = _find_ids_across_trees(filenames, trees,
808
 
        require_versioned)
809
 
    return _find_children_across_trees(specified_path_ids, trees)
810
 
 
811
 
 
812
 
def _find_ids_across_trees(filenames, trees, require_versioned):
813
 
    """Find the ids corresponding to specified filenames.
814
 
 
815
 
    All matches in all trees will be used, but subdirectories are not scanned.
816
 
 
817
 
    :param filenames: The filenames to find file_ids for
818
 
    :param trees: The trees to find file_ids within
819
 
    :param require_versioned: if true, all specified filenames must occur in
820
 
        at least one tree.
821
 
    :return: a set of file ids for the specified filenames
822
 
    """
823
 
    not_versioned = []
824
 
    interesting_ids = set()
825
 
    for tree_path in filenames:
826
 
        not_found = True
827
 
        for tree in trees:
828
 
            file_id = tree.path2id(tree_path)
829
 
            if file_id is not None:
830
 
                interesting_ids.add(file_id)
831
 
                not_found = False
832
 
        if not_found:
833
 
            not_versioned.append(tree_path)
834
 
    if len(not_versioned) > 0 and require_versioned:
835
 
        raise errors.PathsNotVersionedError(not_versioned)
836
 
    return interesting_ids
837
 
 
838
 
 
839
 
def _find_children_across_trees(specified_ids, trees):
840
 
    """Return a set including specified ids and their children.
841
 
 
842
 
    All matches in all trees will be used.
843
 
 
844
 
    :param trees: The trees to find file_ids within
845
 
    :return: a set containing all specified ids and their children
846
 
    """
847
 
    interesting_ids = set(specified_ids)
848
 
    pending = interesting_ids
849
 
    # now handle children of interesting ids
850
 
    # we loop so that we handle all children of each id in both trees
851
 
    while len(pending) > 0:
852
 
        new_pending = set()
853
 
        for file_id in pending:
854
 
            for tree in trees:
855
 
                if not tree.has_or_had_id(file_id):
856
 
                    continue
857
 
                for child_id in tree.iter_children(file_id):
858
 
                    if child_id not in interesting_ids:
859
 
                        new_pending.add(child_id)
860
 
        interesting_ids.update(new_pending)
861
 
        pending = new_pending
862
 
    return interesting_ids
 
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'))
863
676
 
864
677
 
865
678
class InterTree(InterObject):
868
681
    Its instances have methods like 'compare' and contain references to the
869
682
    source and target trees these operations are to be carried out on.
870
683
 
871
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
684
    Clients of breezy should not need to use InterTree directly, rather they
872
685
    should use the convenience methods on Tree such as 'Tree.compare()' which
873
686
    will pass through to InterTree as appropriate.
874
687
    """
881
694
 
882
695
    _optimisers = []
883
696
 
884
 
    def _changes_from_entries(self, source_entry, target_entry,
885
 
        source_path=None, target_path=None):
 
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):
886
705
        """Generate a iter_changes tuple between source_entry and target_entry.
887
706
 
888
707
        :param source_entry: An inventory entry from self.source, or None.
889
708
        :param target_entry: An inventory entry from self.target, or None.
890
 
        :param source_path: The path of source_entry, if known. If not known
891
 
            it will be looked up.
892
 
        :param target_path: The path of target_entry, if known. If not known
893
 
            it will be looked up.
 
709
        :param source_path: The path of source_entry.
 
710
        :param target_path: The path of target_entry.
894
711
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
895
712
            item 1 is True if there are any changes in the result tuple.
896
713
        """
904
721
            source_versioned = True
905
722
            source_name = source_entry.name
906
723
            source_parent = source_entry.parent_id
907
 
            if source_path is None:
908
 
                source_path = self.source.id2path(file_id)
909
724
            source_kind, source_executable, source_stat = \
910
725
                self.source._comparison_data(source_entry, source_path)
911
726
        else:
918
733
            target_versioned = True
919
734
            target_name = target_entry.name
920
735
            target_parent = target_entry.parent_id
921
 
            if target_path is None:
922
 
                target_path = self.target.id2path(file_id)
923
736
            target_kind, target_executable, target_stat = \
924
737
                self.target._comparison_data(target_entry, target_path)
925
738
        else:
934
747
        if source_kind != target_kind:
935
748
            changed_content = True
936
749
        elif source_kind == 'file':
937
 
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
938
 
                self.target.get_file_sha1(file_id, target_path, target_stat)):
 
750
            if not self.file_content_matches(
 
751
                    source_path, target_path,
 
752
                    file_id, file_id, source_stat, target_stat):
939
753
                changed_content = True
940
754
        elif source_kind == 'symlink':
941
 
            if (self.source.get_symlink_target(file_id) !=
942
 
                self.target.get_symlink_target(file_id)):
 
755
            if (self.source.get_symlink_target(source_path, file_id) !=
 
756
                self.target.get_symlink_target(target_path, file_id)):
943
757
                changed_content = True
944
 
            # XXX: Yes, the indentation below is wrong. But fixing it broke
945
 
            # test_merge.TestMergerEntriesLCAOnDisk.
946
 
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
947
 
            # the fix from bzr.dev -- vila 2009026
948
 
            elif source_kind == 'tree-reference':
949
 
                if (self.source.get_reference_revision(file_id, source_path)
950
 
                    != self.target.get_reference_revision(file_id, target_path)):
 
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)):
951
761
                    changed_content = True
952
762
        parent = (source_parent, target_parent)
953
763
        name = (source_name, target_name)
961
771
        return (file_id, (source_path, target_path), changed_content,
962
772
                versioned, parent, name, kind, executable), changes
963
773
 
964
 
    @needs_read_lock
965
774
    def compare(self, want_unchanged=False, specific_files=None,
966
775
        extra_trees=None, require_versioned=False, include_root=False,
967
776
        want_unversioned=False):
984
793
        trees = (self.source,)
985
794
        if extra_trees is not None:
986
795
            trees = trees + tuple(extra_trees)
987
 
        # target is usually the newer tree:
988
 
        specific_file_ids = self.target.paths2ids(specific_files, trees,
989
 
            require_versioned=require_versioned)
990
 
        if specific_files and not specific_file_ids:
991
 
            # All files are unversioned, so just return an empty delta
992
 
            # _compare_trees would think we want a complete delta
993
 
            result = delta.TreeDelta()
994
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
995
 
            result.unversioned = [(path, None,
996
 
                self.target._comparison_data(fake_entry, path)[0]) for path in
997
 
                specific_files]
998
 
            return result
999
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
1000
 
            specific_files, include_root, extra_trees=extra_trees,
1001
 
            require_versioned=require_versioned,
1002
 
            want_unversioned=want_unversioned)
 
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)
1003
801
 
1004
802
    def iter_changes(self, include_unchanged=False,
1005
803
                      specific_files=None, pb=None, extra_trees=[],
1037
835
            output. An unversioned file is defined as one with (False, False)
1038
836
            for the versioned pair.
1039
837
        """
1040
 
        lookup_trees = [self.source]
1041
 
        if extra_trees:
1042
 
             lookup_trees.extend(extra_trees)
 
838
        if not extra_trees:
 
839
             extra_trees = []
 
840
        else:
 
841
             extra_trees = list(extra_trees)
1043
842
        # The ids of items we need to examine to insure delta consistency.
1044
843
        precise_file_ids = set()
1045
844
        changed_file_ids = []
1046
845
        if specific_files == []:
1047
 
            specific_file_ids = []
 
846
            target_specific_files = []
 
847
            source_specific_files = []
1048
848
        else:
1049
 
            specific_file_ids = self.target.paths2ids(specific_files,
1050
 
                lookup_trees, require_versioned=require_versioned)
 
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)
1051
855
        if specific_files is not None:
1052
856
            # reparented or added entries must have their parents included
1053
857
            # so that valid deltas can be created. The seen_parents set
1062
866
                                     self.target.extras()
1063
867
                if specific_files is None or
1064
868
                    osutils.is_inside_any(specific_files, p)])
1065
 
            all_unversioned = deque(all_unversioned)
 
869
            all_unversioned = collections.deque(all_unversioned)
1066
870
        else:
1067
 
            all_unversioned = deque()
 
871
            all_unversioned = collections.deque()
1068
872
        to_paths = {}
1069
873
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1070
 
            specific_file_ids=specific_file_ids))
 
874
            specific_files=source_specific_files))
1071
875
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1072
876
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1073
 
            specific_file_ids=specific_file_ids))
 
877
            specific_files=target_specific_files))
1074
878
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1075
879
        entry_count = 0
1076
880
        # the unversioned path lookup only occurs on real trees - where there
1077
881
        # can be extras. So the fake_entry is solely used to look up
1078
882
        # executable it values when execute is not supported.
1079
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
883
        fake_entry = TreeFile()
1080
884
        for target_path, target_entry in to_entries_by_dir:
1081
885
            while (all_unversioned and
1082
886
                all_unversioned[0][0] < target_path.split('/')):
1099
903
            if pb is not None:
1100
904
                pb.update('comparing files', entry_count, num_entries)
1101
905
            if changes or include_unchanged:
1102
 
                if specific_file_ids is not None:
 
906
                if specific_files is not None:
1103
907
                    new_parent_id = result[4][1]
1104
908
                    precise_file_ids.add(new_parent_id)
1105
909
                    changed_file_ids.append(result[0])
1130
934
            if file_id in to_paths:
1131
935
                # already returned
1132
936
                continue
1133
 
            if file_id not in self.target.all_file_ids():
1134
 
                # common case - paths we have not emitted are not present in
1135
 
                # target.
1136
 
                to_path = None
1137
 
            else:
1138
 
                to_path = self.target.id2path(file_id)
 
937
            to_path = find_previous_path(self.source, self.target, path)
1139
938
            entry_count += 1
1140
939
            if pb is not None:
1141
940
                pb.update('comparing files', entry_count, num_entries)
1152
951
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1153
952
                  name, kind, executable)
1154
953
        changed_file_ids = set(changed_file_ids)
1155
 
        if specific_file_ids is not None:
 
954
        if specific_files is not None:
1156
955
            for result in self._handle_precise_ids(precise_file_ids,
1157
956
                changed_file_ids):
1158
957
                yield result
1159
958
 
1160
 
    def _get_entry(self, tree, file_id):
 
959
    def _get_entry(self, tree, path):
1161
960
        """Get an inventory entry from a tree, with missing entries as None.
1162
961
 
1163
962
        If the tree raises NotImplementedError on accessing .inventory, then
1167
966
        :param tree: The tree to lookup the entry in.
1168
967
        :param file_id: The file_id to lookup.
1169
968
        """
 
969
        # No inventory available.
1170
970
        try:
1171
 
            inventory = tree.inventory
1172
 
        except NotImplementedError:
1173
 
            # No inventory available.
1174
 
            try:
1175
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1176
 
                return iterator.next()[1]
1177
 
            except StopIteration:
1178
 
                return None
1179
 
        else:
1180
 
            try:
1181
 
                return inventory[file_id]
1182
 
            except errors.NoSuchId:
1183
 
                return None
 
971
            iterator = tree.iter_entries_by_dir(specific_files=[path])
 
972
            return next(iterator)[1]
 
973
        except StopIteration:
 
974
            return None
1184
975
 
1185
976
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1186
977
        discarded_changes=None):
1228
1019
                # Examine file_id
1229
1020
                if discarded_changes:
1230
1021
                    result = discarded_changes.get(file_id)
1231
 
                    old_entry = None
 
1022
                    source_entry = None
1232
1023
                else:
1233
1024
                    result = None
1234
1025
                if result is None:
1235
 
                    old_entry = self._get_entry(self.source, file_id)
1236
 
                    new_entry = self._get_entry(self.target, file_id)
 
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)
1237
1040
                    result, changes = self._changes_from_entries(
1238
 
                        old_entry, new_entry)
 
1041
                        source_entry, target_entry, source_path, target_path)
1239
1042
                else:
1240
1043
                    changes = True
1241
1044
                # Get this parents parent to examine.
1243
1046
                precise_file_ids.add(new_parent_id)
1244
1047
                if changes:
1245
1048
                    if (result[6][0] == 'directory' and
1246
 
                        result[6][1] != 'directory'):
 
1049
                            result[6][1] != 'directory'):
1247
1050
                        # This stopped being a directory, the old children have
1248
1051
                        # to be included.
1249
 
                        if old_entry is None:
 
1052
                        if source_entry is None:
1250
1053
                            # Reusing a discarded change.
1251
 
                            old_entry = self._get_entry(self.source, file_id)
1252
 
                        for child in old_entry.children.values():
1253
 
                            precise_file_ids.add(child.file_id)
 
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]))
1254
1058
                    changed_file_ids.add(result[0])
1255
1059
                    yield result
1256
1060
 
 
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
 
1257
1102
 
1258
1103
class MultiWalker(object):
1259
1104
    """Walk multiple trees simultaneously, getting combined results."""
1293
1138
            If has_more is False, path and ie will be None.
1294
1139
        """
1295
1140
        try:
1296
 
            path, ie = iterator.next()
 
1141
            path, ie = next(iterator)
1297
1142
        except StopIteration:
1298
1143
            return False, None, None
1299
1144
        else:
1300
1145
            return True, path, ie
1301
1146
 
1302
1147
    @staticmethod
1303
 
    def _cmp_path_by_dirblock(path1, path2):
 
1148
    def _lt_path_by_dirblock(path1, path2):
1304
1149
        """Compare two paths based on what directory they are in.
1305
1150
 
1306
1151
        This generates a sort order, such that all children of a directory are
1315
1160
        """
1316
1161
        # Shortcut this special case
1317
1162
        if path1 == path2:
1318
 
            return 0
 
1163
            return False
1319
1164
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1320
1165
        # Unicode objects. Consider using encode_utf8() and then using the
1321
1166
        # optimized versions, or maybe writing optimized unicode versions.
1322
 
        if not isinstance(path1, unicode):
 
1167
        if not isinstance(path1, text_type):
1323
1168
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1324
1169
                            % (type(path1), path1))
1325
 
        if not isinstance(path2, unicode):
 
1170
        if not isinstance(path2, text_type):
1326
1171
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1327
1172
                            % (type(path2), path2))
1328
 
        return cmp(MultiWalker._path_to_key(path1),
1329
 
                   MultiWalker._path_to_key(path2))
 
1173
        return (MultiWalker._path_to_key(path1) <
 
1174
                MultiWalker._path_to_key(path2))
1330
1175
 
1331
1176
    @staticmethod
1332
1177
    def _path_to_key(path):
1362
1207
            return (None, None)
1363
1208
        else:
1364
1209
            self._out_of_order_processed.add(file_id)
1365
 
            cur_ie = other_tree.inventory[file_id]
 
1210
            cur_ie = other_tree.root_inventory.get_entry(file_id)
1366
1211
            return (cur_path, cur_ie)
1367
1212
 
1368
1213
    def iter_all(self):
1389
1234
                         for other in self._other_trees]
1390
1235
        other_entries = [self._step_one(walker) for walker in other_walkers]
1391
1236
        # Track extra nodes in the other trees
1392
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
 
1237
        others_extra = [{} for _ in range(len(self._other_trees))]
1393
1238
 
1394
1239
        master_has_more = True
1395
1240
        step_one = self._step_one
1422
1267
                    other_walker = other_walkers[idx]
1423
1268
                    other_extra = others_extra[idx]
1424
1269
                    while (other_has_more and
1425
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
 
1270
                           self._lt_path_by_dirblock(other_path, path)):
1426
1271
                        other_file_id = other_ie.file_id
1427
1272
                        if other_file_id not in out_of_order_processed:
1428
1273
                            other_extra[other_file_id] = (other_path, other_ie)
1469
1314
        #       might ensure better ordering, in case a caller strictly
1470
1315
        #       requires parents before children.
1471
1316
        for idx, other_extra in enumerate(self._others_extra):
1472
 
            others = sorted(other_extra.itervalues(),
 
1317
            others = sorted(viewvalues(other_extra),
1473
1318
                            key=lambda x: self._path_to_key(x[0]))
1474
1319
            for other_path, other_ie in others:
1475
1320
                file_id = other_ie.file_id
1477
1322
                # the lookup_by_file_id will be removing anything processed
1478
1323
                # from the extras cache
1479
1324
                other_extra.pop(file_id)
1480
 
                other_values = [(None, None) for i in xrange(idx)]
 
1325
                other_values = [(None, None)] * idx
1481
1326
                other_values.append((other_path, other_ie))
1482
1327
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1483
1328
                    alt_idx = alt_idx + idx + 1
1486
1331
                    other_values.append(self._lookup_by_file_id(
1487
1332
                                            alt_extra, alt_tree, file_id))
1488
1333
                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