/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 18:26:22 UTC
  • mfrom: (7167.1.4 run-flake8)
  • Revision ID: breezy.the.bot@gmail.com-20181116182622-qw3gan3hz78a2imw
Add a flake8 test.

Merged from https://code.launchpad.net/~jelmer/brz/run-flake8/+merge/358902

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
 
import os
21
 
from collections import deque
22
 
 
23
 
import bzrlib
24
 
from bzrlib import (
 
20
from __future__ import absolute_import
 
21
 
 
22
from .lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import collections
 
25
 
 
26
from breezy import (
25
27
    conflicts as _mod_conflicts,
26
28
    debug,
27
29
    delta,
28
30
    filters,
29
 
    osutils,
30
31
    revision as _mod_revision,
31
32
    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
 
33
    trace,
 
34
    )
 
35
from breezy.i18n import gettext
 
36
""")
 
37
 
 
38
from . import (
 
39
    errors,
 
40
    lock,
 
41
    osutils,
 
42
    )
 
43
from .inter import InterObject
 
44
from .sixish import (
 
45
    text_type,
 
46
    viewvalues,
 
47
    )
 
48
 
 
49
 
 
50
class FileTimestampUnavailable(errors.BzrError):
 
51
 
 
52
    _fmt = "The filestamp for %(path)s is not available."
 
53
 
 
54
    internal_error = True
 
55
 
 
56
    def __init__(self, path):
 
57
        self.path = path
 
58
 
 
59
 
 
60
class TreeEntry(object):
 
61
    """An entry that implements the minimum interface used by commands.
 
62
    """
 
63
 
 
64
    def __eq__(self, other):
 
65
        # yes, this is ugly, TODO: best practice __eq__ style.
 
66
        return (isinstance(other, TreeEntry)
 
67
                and other.__class__ == self.__class__)
 
68
 
 
69
    def kind_character(self):
 
70
        return "???"
 
71
 
 
72
 
 
73
class TreeDirectory(TreeEntry):
 
74
    """See TreeEntry. This is a directory in a working tree."""
 
75
 
 
76
    def kind_character(self):
 
77
        return "/"
 
78
 
 
79
 
 
80
class TreeFile(TreeEntry):
 
81
    """See TreeEntry. This is a regular file in a working tree."""
 
82
 
 
83
    def kind_character(self):
 
84
        return ''
 
85
 
 
86
 
 
87
class TreeLink(TreeEntry):
 
88
    """See TreeEntry. This is a symlink in a working tree."""
 
89
 
 
90
    def kind_character(self):
 
91
        return ''
 
92
 
 
93
 
 
94
class TreeReference(TreeEntry):
 
95
    """See TreeEntry. This is a reference to a nested tree in a working tree."""
 
96
 
 
97
    def kind_character(self):
 
98
        return '+'
41
99
 
42
100
 
43
101
class Tree(object):
49
107
 
50
108
    * `RevisionTree` is a tree as recorded at some point in the past.
51
109
 
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
110
    Trees can be compared, etc, regardless of whether they are working
60
111
    trees or versioned trees.
61
112
    """
62
113
 
 
114
    def supports_rename_tracking(self):
 
115
        """Whether this tree supports rename tracking.
 
116
 
 
117
        This defaults to True, but some implementations may want to override
 
118
        it.
 
119
        """
 
120
        return True
 
121
 
 
122
    def has_versioned_directories(self):
 
123
        """Whether this tree can contain explicitly versioned directories.
 
124
 
 
125
        This defaults to True, but some implementations may want to override
 
126
        it.
 
127
        """
 
128
        return True
 
129
 
63
130
    def changes_from(self, other, want_unchanged=False, specific_files=None,
64
131
        extra_trees=None, require_versioned=False, include_root=False,
65
132
        want_unversioned=False):
73
140
        :param want_unchanged: An optional boolean requesting the inclusion of
74
141
            unchanged entries in the result.
75
142
        :param extra_trees: An optional list of additional trees to use when
76
 
            mapping the contents of specific_files (paths) to file_ids.
 
143
            mapping the contents of specific_files (paths) to their identities.
77
144
        :param require_versioned: An optional boolean (defaults to False). When
78
145
            supplied and True all the 'specific_files' must be versioned, or
79
146
            a PathsNotVersionedError will be thrown.
105
172
    def conflicts(self):
106
173
        """Get a list of the conflicts in the tree.
107
174
 
108
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
175
        Each conflict is an instance of breezy.conflicts.Conflict.
109
176
        """
110
177
        return _mod_conflicts.ConflictList()
111
178
 
126
193
        """True if the tree has given filename."""
127
194
        raise NotImplementedError(self.has_filename)
128
195
 
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
196
    def is_ignored(self, filename):
139
197
        """Check whether the filename is ignored by this tree.
140
198
 
143
201
        """
144
202
        return False
145
203
 
146
 
    def __iter__(self):
147
 
        return iter(self.inventory)
148
 
 
149
204
    def all_file_ids(self):
150
205
        """Iterate through all file ids, including ids for missing files."""
151
 
        return set(self.inventory)
 
206
        raise NotImplementedError(self.all_file_ids)
 
207
 
 
208
    def all_versioned_paths(self):
 
209
        """Iterate through all paths, including paths for missing files."""
 
210
        raise NotImplementedError(self.all_versioned_paths)
152
211
 
153
212
    def id2path(self, file_id):
154
213
        """Return the path for a file id.
155
214
 
156
215
        :raises NoSuchId:
157
216
        """
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):
 
217
        raise NotImplementedError(self.id2path)
 
218
 
 
219
    def iter_entries_by_dir(self, specific_files=None):
174
220
        """Walk the tree in 'by_dir' order.
175
221
 
176
222
        This will yield each entry in the tree as a (path, entry) tuple.
192
238
             g
193
239
 
194
240
        The yield order (ignoring root) would be::
 
241
 
195
242
          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)
 
243
        """
 
244
        raise NotImplementedError(self.iter_entries_by_dir)
 
245
 
 
246
    def iter_child_entries(self, path):
 
247
        """Iterate over the children of a directory or tree reference.
 
248
 
 
249
        :param path: Path of the directory
 
250
        :raise NoSuchFile: When the path does not exist
 
251
        :return: Iterator over entries in the directory
 
252
        """
 
253
        raise NotImplementedError(self.iter_child_entries)
 
254
 
 
255
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
256
        """List all files in this tree.
 
257
 
 
258
        :param include_root: Whether to include the entry for the tree root
 
259
        :param from_dir: Directory under which to list files
 
260
        :param recursive: Whether to list files recursively
 
261
        :return: iterator over tuples of (path, versioned, kind, file_id,
 
262
            inventory entry)
 
263
        """
 
264
        raise NotImplementedError(self.list_files)
203
265
 
204
266
    def iter_references(self):
205
267
        if self.supports_tree_reference():
207
269
                if entry.kind == 'tree-reference':
208
270
                    yield path, entry.file_id
209
271
 
210
 
    def kind(self, file_id):
 
272
    def kind(self, path):
211
273
        raise NotImplementedError("Tree subclass %s must implement kind"
212
274
            % self.__class__.__name__)
213
275
 
214
 
    def stored_kind(self, file_id):
215
 
        """File kind stored for this file_id.
 
276
    def stored_kind(self, path):
 
277
        """File kind stored for this path.
216
278
 
217
279
        May not match kind on disk for working trees.  Always available
218
280
        for versioned files, even when the file itself is missing.
219
281
        """
220
 
        return self.kind(file_id)
 
282
        return self.kind(path)
221
283
 
222
284
    def path_content_summary(self, path):
223
285
        """Get a summary of the information about path.
237
299
        """
238
300
        raise NotImplementedError(self.path_content_summary)
239
301
 
240
 
    def get_reference_revision(self, file_id, path=None):
 
302
    def get_reference_revision(self, path):
241
303
        raise NotImplementedError("Tree subclass %s must implement "
242
304
                                  "get_reference_revision"
243
305
            % self.__class__.__name__)
253
315
        """
254
316
        raise NotImplementedError(self._comparison_data)
255
317
 
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):
263
 
        """Return a file object for the file file_id in the tree.
264
 
 
265
 
        If both file_id and path are defined, it is implementation defined as
266
 
        to which one is used.
 
318
    def get_file(self, path):
 
319
        """Return a file object for the file path in the tree.
267
320
        """
268
321
        raise NotImplementedError(self.get_file)
269
322
 
270
 
    def get_file_with_stat(self, file_id, path=None):
271
 
        """Get a file handle and stat object for file_id.
 
323
    def get_file_with_stat(self, path):
 
324
        """Get a file handle and stat object for path.
272
325
 
273
326
        The default implementation returns (self.get_file, None) for backwards
274
327
        compatibility.
275
328
 
276
 
        :param file_id: The file id to read.
277
 
        :param path: The path of the file, if it is known.
 
329
        :param path: The path of the file.
278
330
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
279
331
            no stat facility, or need for a stat cache feedback during commit,
280
332
            it may return None for the second element of the tuple.
281
333
        """
282
 
        return (self.get_file(file_id, path), None)
 
334
        return (self.get_file(path), None)
283
335
 
284
 
    def get_file_text(self, file_id, path=None):
 
336
    def get_file_text(self, path):
285
337
        """Return the byte content of a file.
286
338
 
287
 
        :param file_id: The file_id of the file.
288
339
        :param path: The path of the file.
289
 
        If both file_id and path are supplied, an implementation may use
290
 
        either one.
 
340
 
 
341
        :returns: A single byte string for the whole file.
291
342
        """
292
 
        my_file = self.get_file(file_id, path)
293
 
        try:
 
343
        with self.get_file(path) as my_file:
294
344
            return my_file.read()
295
 
        finally:
296
 
            my_file.close()
297
345
 
298
 
    def get_file_lines(self, file_id, path=None):
 
346
    def get_file_lines(self, path):
299
347
        """Return the content of a file, as lines.
300
348
 
301
 
        :param file_id: The file_id of the file.
302
349
        :param path: The path of the file.
303
 
        If both file_id and path are supplied, an implementation may use
304
 
        either one.
305
 
        """
306
 
        return osutils.split_lines(self.get_file_text(file_id, path))
307
 
 
308
 
    def get_file_mtime(self, file_id, path=None):
 
350
        """
 
351
        return osutils.split_lines(self.get_file_text(path))
 
352
 
 
353
    def get_file_verifier(self, path, stat_value=None):
 
354
        """Return a verifier for a file.
 
355
 
 
356
        The default implementation returns a sha1.
 
357
 
 
358
        :param path: The path that this file can be found at.
 
359
            These must point to the same object.
 
360
        :param stat_value: Optional stat value for the object
 
361
        :return: Tuple with verifier name and verifier data
 
362
        """
 
363
        return ("SHA1", self.get_file_sha1(path, stat_value=stat_value))
 
364
 
 
365
    def get_file_sha1(self, path, stat_value=None):
 
366
        """Return the SHA1 file for a file.
 
367
 
 
368
        :note: callers should use get_file_verifier instead
 
369
            where possible, as the underlying repository implementation may
 
370
            have quicker access to a non-sha1 verifier.
 
371
 
 
372
        :param path: The path that this file can be found at.
 
373
        :param stat_value: Optional stat value for the object
 
374
        """
 
375
        raise NotImplementedError(self.get_file_sha1)
 
376
 
 
377
    def get_file_mtime(self, path):
309
378
        """Return the modification time for a file.
310
379
 
311
 
        :param file_id: The handle for this file.
312
380
        :param path: The path that this file can be found at.
313
 
            These must point to the same object.
314
381
        """
315
382
        raise NotImplementedError(self.get_file_mtime)
316
383
 
317
 
    def get_file_size(self, file_id):
 
384
    def get_file_size(self, path):
318
385
        """Return the size of a file in bytes.
319
386
 
320
387
        This applies only to regular files.  If invoked on directories or
321
388
        symlinks, it will return None.
322
 
        :param file_id: The file-id of the file
323
389
        """
324
390
        raise NotImplementedError(self.get_file_size)
325
391
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
392
    def is_executable(self, path):
 
393
        """Check if a file is executable.
 
394
 
 
395
        :param path: The path that this file can be found at.
 
396
        """
 
397
        raise NotImplementedError(self.is_executable)
328
398
 
329
399
    def iter_files_bytes(self, desired_files):
330
400
        """Iterate through file contents.
342
412
        this implementation, it is a tuple containing a single bytestring with
343
413
        the complete text of the file.
344
414
 
345
 
        :param desired_files: a list of (file_id, identifier) pairs
 
415
        :param desired_files: a list of (path, identifier) pairs
346
416
        """
347
 
        for file_id, identifier in desired_files:
 
417
        for path, identifier in desired_files:
348
418
            # We wrap the string in a tuple so that we can return an iterable
349
419
            # of bytestrings.  (Technically, a bytestring is also an iterable
350
420
            # of bytestrings, but iterating through each character is not
351
421
            # performant.)
352
 
            cur_file = (self.get_file_text(file_id),)
 
422
            cur_file = (self.get_file_text(path),)
353
423
            yield identifier, cur_file
354
424
 
355
 
    def get_symlink_target(self, file_id):
356
 
        """Get the target for a given file_id.
 
425
    def get_symlink_target(self, path):
 
426
        """Get the target for a given path.
357
427
 
358
 
        It is assumed that the caller already knows that file_id is referencing
 
428
        It is assumed that the caller already knows that path is referencing
359
429
        a symlink.
360
 
        :param file_id: Handle for the symlink entry.
 
430
        :param path: The path of the file.
361
431
        :return: The path the symlink points to.
362
432
        """
363
433
        raise NotImplementedError(self.get_symlink_target)
364
434
 
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
435
    def get_root_id(self):
444
436
        """Return the file_id for the root of this tree."""
445
437
        raise NotImplementedError(self.get_root_id)
446
438
 
447
 
    def annotate_iter(self, file_id,
 
439
    def annotate_iter(self, path,
448
440
                      default_revision=_mod_revision.CURRENT_REVISION):
449
441
        """Return an iterator of revision_id, line tuples.
450
442
 
451
443
        For working trees (and mutable trees in general), the special
452
444
        revision_id 'current:' will be used for lines that are new in this
453
445
        tree, e.g. uncommitted changes.
454
 
        :param file_id: The file to produce an annotated version from
 
446
        :param path: The file to produce an annotated version from
455
447
        :param default_revision: For lines that don't match a basis, mark them
456
448
            with this revision id. Not all implementations will make use of
457
449
            this value.
458
450
        """
459
451
        raise NotImplementedError(self.annotate_iter)
460
452
 
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
453
    def _iter_parent_trees(self):
499
454
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
500
455
        for revision_id in self.get_parent_ids():
503
458
            except errors.NoSuchRevisionInTree:
504
459
                yield self.repository.revision_tree(revision_id)
505
460
 
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
461
    def path2id(self, path):
557
462
        """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
 
463
        raise NotImplementedError(self.path2id)
 
464
 
 
465
    def is_versioned(self, path):
 
466
        """Check whether path is versioned.
 
467
 
 
468
        :param path: Path to check
 
469
        :return: boolean
 
470
        """
 
471
        return self.path2id(path) is not None
 
472
 
 
473
    def find_related_paths_across_trees(self, paths, trees=[],
 
474
            require_versioned=True):
 
475
        """Find related paths in tree corresponding to specified filenames in any
 
476
        of `lookup_trees`.
 
477
 
 
478
        All matches in all trees will be used, and all children of matched
 
479
        directories will be used.
 
480
 
 
481
        :param paths: The filenames to find related paths for (if None, returns
 
482
            None)
 
483
        :param trees: The trees to find file_ids within
 
484
        :param require_versioned: if true, all specified filenames must occur in
 
485
            at least one tree.
 
486
        :return: a set of paths for the specified filenames and their children
 
487
            in `tree`
 
488
        """
 
489
        raise NotImplementedError(self.find_related_paths_across_trees)
583
490
 
584
491
    def lock_read(self):
585
 
        pass
 
492
        """Lock this tree for multiple read only operations.
 
493
 
 
494
        :return: A breezy.lock.LogicalLockResult.
 
495
        """
 
496
        return lock.LogicalLockResult(self.unlock)
586
497
 
587
498
    def revision_tree(self, revision_id):
588
499
        """Obtain a revision tree for the revision revision_id.
617
528
        # NB: we specifically *don't* call self.has_filename, because for
618
529
        # WorkingTrees that can indicate files that exist on disk but that
619
530
        # are not versioned.
620
 
        pred = self.inventory.has_filename
621
 
        return set((p for p in paths if not pred(p)))
 
531
        return set(p for p in paths if not self.is_versioned(p))
622
532
 
623
533
    def walkdirs(self, prefix=""):
624
534
        """Walk the contents of this tree from path down.
656
566
    def supports_content_filtering(self):
657
567
        return False
658
568
 
659
 
    def _content_filter_stack(self, path=None, file_id=None):
 
569
    def _content_filter_stack(self, path=None):
660
570
        """The stack of content filters for a path if filtering is supported.
661
571
 
662
572
        Readers will be applied in first-to-last order.
665
575
 
666
576
        :param path: path relative to the root of the tree
667
577
            or None if unknown
668
 
        :param file_id: file_id or None if unknown
669
578
        :return: the list of filters - [] if there are none
670
579
        """
671
580
        filter_pref_names = filters._get_registered_names()
672
581
        if len(filter_pref_names) == 0:
673
582
            return []
674
 
        if path is None:
675
 
            path = self.id2path(file_id)
676
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
583
        prefs = next(self.iter_search_rules([path], filter_pref_names))
677
584
        stk = filters._get_filter_stack_for(prefs)
678
585
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
586
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
680
587
        return stk
681
588
 
682
589
    def _content_filter_stack_provider(self):
689
596
        """
690
597
        if self.supports_content_filtering():
691
598
            return lambda path, file_id: \
692
 
                    self._content_filter_stack(path, file_id)
 
599
                    self._content_filter_stack(path)
693
600
        else:
694
601
            return None
695
602
 
720
627
        searcher = default_searcher
721
628
        return searcher
722
629
 
723
 
 
724
 
######################################################################
725
 
# diff
726
 
 
727
 
# TODO: Merge these two functions into a single one that can operate
728
 
# on either a whole tree or a set of files.
729
 
 
730
 
# TODO: Return the diff in order by filename, not by category or in
731
 
# random order.  Can probably be done by lock-stepping through the
732
 
# filenames from both trees.
733
 
 
734
 
 
735
 
def file_status(filename, old_tree, new_tree):
736
 
    """Return single-letter status, old and new names for a file.
737
 
 
738
 
    The complexity here is in deciding how to represent renames;
739
 
    many complex cases are possible.
740
 
    """
741
 
    old_inv = old_tree.inventory
742
 
    new_inv = new_tree.inventory
743
 
    new_id = new_inv.path2id(filename)
744
 
    old_id = old_inv.path2id(filename)
745
 
 
746
 
    if not new_id and not old_id:
747
 
        # easy: doesn't exist in either; not versioned at all
748
 
        if new_tree.is_ignored(filename):
749
 
            return 'I', None, None
750
 
        else:
751
 
            return '?', None, None
752
 
    elif new_id:
753
 
        # There is now a file of this name, great.
754
 
        pass
755
 
    else:
756
 
        # There is no longer a file of this name, but we can describe
757
 
        # what happened to the file that used to have
758
 
        # this name.  There are two possibilities: either it was
759
 
        # deleted entirely, or renamed.
760
 
        if new_inv.has_id(old_id):
761
 
            return 'X', old_inv.id2path(old_id), new_inv.id2path(old_id)
762
 
        else:
763
 
            return 'D', old_inv.id2path(old_id), None
764
 
 
765
 
    # if the file_id is new in this revision, it is added
766
 
    if new_id and not old_inv.has_id(new_id):
767
 
        return 'A'
768
 
 
769
 
    # if there used to be a file of this name, but that ID has now
770
 
    # disappeared, it is deleted
771
 
    if old_id and not new_inv.has_id(old_id):
772
 
        return 'D'
773
 
 
774
 
    return 'wtf?'
775
 
 
776
 
 
777
 
@deprecated_function(deprecated_in((1, 9, 0)))
778
 
def find_renames(old_inv, new_inv):
779
 
    for file_id in old_inv:
780
 
        if file_id not in new_inv:
781
 
            continue
782
 
        old_name = old_inv.id2path(file_id)
783
 
        new_name = new_inv.id2path(file_id)
784
 
        if old_name != new_name:
785
 
            yield (old_name, new_name)
786
 
 
787
 
 
788
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
789
 
    """Find the ids corresponding to specified filenames.
790
 
 
791
 
    All matches in all trees will be used, and all children of matched
792
 
    directories will be used.
793
 
 
794
 
    :param filenames: The filenames to find file_ids for (if None, returns
795
 
        None)
796
 
    :param trees: The trees to find file_ids within
797
 
    :param require_versioned: if true, all specified filenames must occur in
798
 
    at least one tree.
799
 
    :return: a set of file ids for the specified filenames and their children.
800
 
    """
801
 
    if not filenames:
802
 
        return None
803
 
    specified_path_ids = _find_ids_across_trees(filenames, trees,
804
 
        require_versioned)
805
 
    return _find_children_across_trees(specified_path_ids, trees)
806
 
 
807
 
 
808
 
def _find_ids_across_trees(filenames, trees, require_versioned):
809
 
    """Find the ids corresponding to specified filenames.
810
 
 
811
 
    All matches in all trees will be used, but subdirectories are not scanned.
812
 
 
813
 
    :param filenames: The filenames to find file_ids for
814
 
    :param trees: The trees to find file_ids within
815
 
    :param require_versioned: if true, all specified filenames must occur in
816
 
        at least one tree.
817
 
    :return: a set of file ids for the specified filenames
818
 
    """
819
 
    not_versioned = []
820
 
    interesting_ids = set()
821
 
    for tree_path in filenames:
822
 
        not_found = True
823
 
        for tree in trees:
824
 
            file_id = tree.path2id(tree_path)
825
 
            if file_id is not None:
826
 
                interesting_ids.add(file_id)
827
 
                not_found = False
828
 
        if not_found:
829
 
            not_versioned.append(tree_path)
830
 
    if len(not_versioned) > 0 and require_versioned:
831
 
        raise errors.PathsNotVersionedError(not_versioned)
832
 
    return interesting_ids
833
 
 
834
 
 
835
 
def _find_children_across_trees(specified_ids, trees):
836
 
    """Return a set including specified ids and their children.
837
 
 
838
 
    All matches in all trees will be used.
839
 
 
840
 
    :param trees: The trees to find file_ids within
841
 
    :return: a set containing all specified ids and their children
842
 
    """
843
 
    interesting_ids = set(specified_ids)
844
 
    pending = interesting_ids
845
 
    # now handle children of interesting ids
846
 
    # we loop so that we handle all children of each id in both trees
847
 
    while len(pending) > 0:
848
 
        new_pending = set()
849
 
        for file_id in pending:
850
 
            for tree in trees:
851
 
                if not tree.has_or_had_id(file_id):
852
 
                    continue
853
 
                for child_id in tree.iter_children(file_id):
854
 
                    if child_id not in interesting_ids:
855
 
                        new_pending.add(child_id)
856
 
        interesting_ids.update(new_pending)
857
 
        pending = new_pending
858
 
    return interesting_ids
 
630
    def archive(self, format, name, root='', subdir=None,
 
631
                force_mtime=None):
 
632
        """Create an archive of this tree.
 
633
 
 
634
        :param format: Format name (e.g. 'tar')
 
635
        :param name: target file name
 
636
        :param root: Root directory name (or None)
 
637
        :param subdir: Subdirectory to export (or None)
 
638
        :return: Iterator over archive chunks
 
639
        """
 
640
        from .archive import create_archive
 
641
        with self.lock_read():
 
642
            return create_archive(format, self, name, root,
 
643
                    subdir, force_mtime=force_mtime)
 
644
 
 
645
    @classmethod
 
646
    def versionable_kind(cls, kind):
 
647
        """Check if this tree support versioning a specific file kind."""
 
648
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
859
649
 
860
650
 
861
651
class InterTree(InterObject):
864
654
    Its instances have methods like 'compare' and contain references to the
865
655
    source and target trees these operations are to be carried out on.
866
656
 
867
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
657
    Clients of breezy should not need to use InterTree directly, rather they
868
658
    should use the convenience methods on Tree such as 'Tree.compare()' which
869
659
    will pass through to InterTree as appropriate.
870
660
    """
877
667
 
878
668
    _optimisers = []
879
669
 
880
 
    def _changes_from_entries(self, source_entry, target_entry,
881
 
        source_path=None, target_path=None):
 
670
    @classmethod
 
671
    def is_compatible(kls, source, target):
 
672
        # The default implementation is naive and uses the public API, so
 
673
        # it works for all trees.
 
674
        return True
 
675
 
 
676
    def _changes_from_entries(self, source_entry, target_entry, source_path,
 
677
                              target_path):
882
678
        """Generate a iter_changes tuple between source_entry and target_entry.
883
679
 
884
680
        :param source_entry: An inventory entry from self.source, or None.
885
681
        :param target_entry: An inventory entry from self.target, or None.
886
 
        :param source_path: The path of source_entry, if known. If not known
887
 
            it will be looked up.
888
 
        :param target_path: The path of target_entry, if known. If not known
889
 
            it will be looked up.
 
682
        :param source_path: The path of source_entry.
 
683
        :param target_path: The path of target_entry.
890
684
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
891
685
            item 1 is True if there are any changes in the result tuple.
892
686
        """
900
694
            source_versioned = True
901
695
            source_name = source_entry.name
902
696
            source_parent = source_entry.parent_id
903
 
            if source_path is None:
904
 
                source_path = self.source.id2path(file_id)
905
697
            source_kind, source_executable, source_stat = \
906
698
                self.source._comparison_data(source_entry, source_path)
907
699
        else:
914
706
            target_versioned = True
915
707
            target_name = target_entry.name
916
708
            target_parent = target_entry.parent_id
917
 
            if target_path is None:
918
 
                target_path = self.target.id2path(file_id)
919
709
            target_kind, target_executable, target_stat = \
920
710
                self.target._comparison_data(target_entry, target_path)
921
711
        else:
930
720
        if source_kind != target_kind:
931
721
            changed_content = True
932
722
        elif source_kind == 'file':
933
 
            if (self.source.get_file_sha1(file_id, source_path, source_stat) !=
934
 
                self.target.get_file_sha1(file_id, target_path, target_stat)):
 
723
            if not self.file_content_matches(
 
724
                    source_path, target_path,
 
725
                    source_stat, target_stat):
935
726
                changed_content = True
936
727
        elif source_kind == 'symlink':
937
 
            if (self.source.get_symlink_target(file_id) !=
938
 
                self.target.get_symlink_target(file_id)):
 
728
            if (self.source.get_symlink_target(source_path) !=
 
729
                self.target.get_symlink_target(target_path)):
939
730
                changed_content = True
940
 
            # XXX: Yes, the indentation below is wrong. But fixing it broke
941
 
            # test_merge.TestMergerEntriesLCAOnDisk.
942
 
            # test_nested_tree_subtree_renamed_and_modified. We'll wait for
943
 
            # the fix from bzr.dev -- vila 2009026
944
 
            elif source_kind == 'tree-reference':
945
 
                if (self.source.get_reference_revision(file_id, source_path)
946
 
                    != self.target.get_reference_revision(file_id, target_path)):
 
731
        elif source_kind == 'tree-reference':
 
732
            if (self.source.get_reference_revision(source_path)
 
733
                != self.target.get_reference_revision(target_path)):
947
734
                    changed_content = True
948
735
        parent = (source_parent, target_parent)
949
736
        name = (source_name, target_name)
957
744
        return (file_id, (source_path, target_path), changed_content,
958
745
                versioned, parent, name, kind, executable), changes
959
746
 
960
 
    @needs_read_lock
961
747
    def compare(self, want_unchanged=False, specific_files=None,
962
748
        extra_trees=None, require_versioned=False, include_root=False,
963
749
        want_unversioned=False):
980
766
        trees = (self.source,)
981
767
        if extra_trees is not None:
982
768
            trees = trees + tuple(extra_trees)
983
 
        # target is usually the newer tree:
984
 
        specific_file_ids = self.target.paths2ids(specific_files, trees,
985
 
            require_versioned=require_versioned)
986
 
        if specific_files and not specific_file_ids:
987
 
            # All files are unversioned, so just return an empty delta
988
 
            # _compare_trees would think we want a complete delta
989
 
            result = delta.TreeDelta()
990
 
            fake_entry = InventoryFile('unused', 'unused', 'unused')
991
 
            result.unversioned = [(path, None,
992
 
                self.target._comparison_data(fake_entry, path)[0]) for path in
993
 
                specific_files]
994
 
            return result
995
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
996
 
            specific_files, include_root, extra_trees=extra_trees,
997
 
            require_versioned=require_versioned,
998
 
            want_unversioned=want_unversioned)
 
769
        with self.lock_read():
 
770
            return delta._compare_trees(self.source, self.target, want_unchanged,
 
771
                specific_files, include_root, extra_trees=extra_trees,
 
772
                require_versioned=require_versioned,
 
773
                want_unversioned=want_unversioned)
999
774
 
1000
775
    def iter_changes(self, include_unchanged=False,
1001
776
                      specific_files=None, pb=None, extra_trees=[],
1033
808
            output. An unversioned file is defined as one with (False, False)
1034
809
            for the versioned pair.
1035
810
        """
1036
 
        lookup_trees = [self.source]
1037
 
        if extra_trees:
1038
 
             lookup_trees.extend(extra_trees)
 
811
        if not extra_trees:
 
812
             extra_trees = []
 
813
        else:
 
814
             extra_trees = list(extra_trees)
1039
815
        # The ids of items we need to examine to insure delta consistency.
1040
816
        precise_file_ids = set()
1041
817
        changed_file_ids = []
1042
818
        if specific_files == []:
1043
 
            specific_file_ids = []
 
819
            target_specific_files = []
 
820
            source_specific_files = []
1044
821
        else:
1045
 
            specific_file_ids = self.target.paths2ids(specific_files,
1046
 
                lookup_trees, require_versioned=require_versioned)
 
822
            target_specific_files = self.target.find_related_paths_across_trees(
 
823
                    specific_files, [self.source] + extra_trees,
 
824
                    require_versioned=require_versioned)
 
825
            source_specific_files = self.source.find_related_paths_across_trees(
 
826
                    specific_files, [self.target] + extra_trees,
 
827
                    require_versioned=require_versioned)
1047
828
        if specific_files is not None:
1048
829
            # reparented or added entries must have their parents included
1049
830
            # so that valid deltas can be created. The seen_parents set
1058
839
                                     self.target.extras()
1059
840
                if specific_files is None or
1060
841
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
842
            all_unversioned = collections.deque(all_unversioned)
1062
843
        else:
1063
 
            all_unversioned = deque()
 
844
            all_unversioned = collections.deque()
1064
845
        to_paths = {}
1065
846
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
 
            specific_file_ids=specific_file_ids))
 
847
            specific_files=source_specific_files))
1067
848
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1068
849
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1069
 
            specific_file_ids=specific_file_ids))
 
850
            specific_files=target_specific_files))
1070
851
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1071
852
        entry_count = 0
1072
853
        # the unversioned path lookup only occurs on real trees - where there
1073
854
        # can be extras. So the fake_entry is solely used to look up
1074
855
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
856
        fake_entry = TreeFile()
1076
857
        for target_path, target_entry in to_entries_by_dir:
1077
858
            while (all_unversioned and
1078
859
                all_unversioned[0][0] < target_path.split('/')):
1095
876
            if pb is not None:
1096
877
                pb.update('comparing files', entry_count, num_entries)
1097
878
            if changes or include_unchanged:
1098
 
                if specific_file_ids is not None:
 
879
                if specific_files is not None:
1099
880
                    new_parent_id = result[4][1]
1100
881
                    precise_file_ids.add(new_parent_id)
1101
882
                    changed_file_ids.append(result[0])
1126
907
            if file_id in to_paths:
1127
908
                # already returned
1128
909
                continue
1129
 
            if file_id not in self.target.all_file_ids():
1130
 
                # common case - paths we have not emitted are not present in
1131
 
                # target.
1132
 
                to_path = None
1133
 
            else:
1134
 
                to_path = self.target.id2path(file_id)
 
910
            to_path = find_previous_path(self.source, self.target, path)
1135
911
            entry_count += 1
1136
912
            if pb is not None:
1137
913
                pb.update('comparing files', entry_count, num_entries)
1148
924
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1149
925
                  name, kind, executable)
1150
926
        changed_file_ids = set(changed_file_ids)
1151
 
        if specific_file_ids is not None:
 
927
        if specific_files is not None:
1152
928
            for result in self._handle_precise_ids(precise_file_ids,
1153
929
                changed_file_ids):
1154
930
                yield result
1155
931
 
1156
 
    def _get_entry(self, tree, file_id):
 
932
    def _get_entry(self, tree, path):
1157
933
        """Get an inventory entry from a tree, with missing entries as None.
1158
934
 
1159
935
        If the tree raises NotImplementedError on accessing .inventory, then
1161
937
        desired.
1162
938
 
1163
939
        :param tree: The tree to lookup the entry in.
1164
 
        :param file_id: The file_id to lookup.
 
940
        :param path: The path to look up
1165
941
        """
 
942
        # No inventory available.
1166
943
        try:
1167
 
            inventory = tree.inventory
1168
 
        except NotImplementedError:
1169
 
            # No inventory available.
1170
 
            try:
1171
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1172
 
                return iterator.next()[1]
1173
 
            except StopIteration:
1174
 
                return None
1175
 
        else:
1176
 
            try:
1177
 
                return inventory[file_id]
1178
 
            except errors.NoSuchId:
1179
 
                return None
 
944
            iterator = tree.iter_entries_by_dir(specific_files=[path])
 
945
            return next(iterator)[1]
 
946
        except StopIteration:
 
947
            return None
1180
948
 
1181
949
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1182
950
        discarded_changes=None):
1224
992
                # Examine file_id
1225
993
                if discarded_changes:
1226
994
                    result = discarded_changes.get(file_id)
1227
 
                    old_entry = None
 
995
                    source_entry = None
1228
996
                else:
1229
997
                    result = None
1230
998
                if result is None:
1231
 
                    old_entry = self._get_entry(self.source, file_id)
1232
 
                    new_entry = self._get_entry(self.target, file_id)
 
999
                    try:
 
1000
                        source_path = self.source.id2path(file_id)
 
1001
                    except errors.NoSuchId:
 
1002
                        source_path = None
 
1003
                        source_entry = None
 
1004
                    else:
 
1005
                        source_entry = self._get_entry(self.source, source_path)
 
1006
                    try:
 
1007
                        target_path = self.target.id2path(file_id)
 
1008
                    except errors.NoSuchId:
 
1009
                        target_path = None
 
1010
                        target_entry = None
 
1011
                    else:
 
1012
                        target_entry = self._get_entry(self.target, target_path)
1233
1013
                    result, changes = self._changes_from_entries(
1234
 
                        old_entry, new_entry)
 
1014
                        source_entry, target_entry, source_path, target_path)
1235
1015
                else:
1236
1016
                    changes = True
1237
1017
                # Get this parents parent to examine.
1239
1019
                precise_file_ids.add(new_parent_id)
1240
1020
                if changes:
1241
1021
                    if (result[6][0] == 'directory' and
1242
 
                        result[6][1] != 'directory'):
 
1022
                            result[6][1] != 'directory'):
1243
1023
                        # This stopped being a directory, the old children have
1244
1024
                        # to be included.
1245
 
                        if old_entry is None:
 
1025
                        if source_entry is None:
1246
1026
                            # Reusing a discarded change.
1247
 
                            old_entry = self._get_entry(self.source, file_id)
1248
 
                        for child in old_entry.children.values():
1249
 
                            precise_file_ids.add(child.file_id)
 
1027
                            source_entry = self._get_entry(self.source, result[1][0])
 
1028
                        precise_file_ids.update(
 
1029
                                child.file_id
 
1030
                                for child in self.source.iter_child_entries(result[1][0]))
1250
1031
                    changed_file_ids.add(result[0])
1251
1032
                    yield result
1252
1033
 
 
1034
    def file_content_matches(
 
1035
            self, source_path, target_path,
 
1036
            source_stat=None, target_stat=None):
 
1037
        """Check if two files are the same in the source and target trees.
 
1038
 
 
1039
        This only checks that the contents of the files are the same,
 
1040
        it does not touch anything else.
 
1041
 
 
1042
        :param source_path: Path of the file in the source tree
 
1043
        :param target_path: Path of the file in the target tree
 
1044
        :param source_file_id: Optional file id of the file in the source tree
 
1045
        :param target_file_id: Optional file id of the file in the target tree
 
1046
        :param source_stat: Optional stat value of the file in the source tree
 
1047
        :param target_stat: Optional stat value of the file in the target tree
 
1048
        :return: Boolean indicating whether the files have the same contents
 
1049
        """
 
1050
        with self.lock_read():
 
1051
            source_verifier_kind, source_verifier_data = (
 
1052
                    self.source.get_file_verifier(source_path, source_stat))
 
1053
            target_verifier_kind, target_verifier_data = (
 
1054
                self.target.get_file_verifier(
 
1055
                    target_path, target_stat))
 
1056
            if source_verifier_kind == target_verifier_kind:
 
1057
                return (source_verifier_data == target_verifier_data)
 
1058
            # Fall back to SHA1 for now
 
1059
            if source_verifier_kind != "SHA1":
 
1060
                source_sha1 = self.source.get_file_sha1(
 
1061
                        source_path, source_file_id, source_stat)
 
1062
            else:
 
1063
                source_sha1 = source_verifier_data
 
1064
            if target_verifier_kind != "SHA1":
 
1065
                target_sha1 = self.target.get_file_sha1(
 
1066
                        target_path, target_file_id, target_stat)
 
1067
            else:
 
1068
                target_sha1 = target_verifier_data
 
1069
            return (source_sha1 == target_sha1)
 
1070
 
 
1071
InterTree.register_optimiser(InterTree)
 
1072
 
1253
1073
 
1254
1074
class MultiWalker(object):
1255
1075
    """Walk multiple trees simultaneously, getting combined results."""
1289
1109
            If has_more is False, path and ie will be None.
1290
1110
        """
1291
1111
        try:
1292
 
            path, ie = iterator.next()
 
1112
            path, ie = next(iterator)
1293
1113
        except StopIteration:
1294
1114
            return False, None, None
1295
1115
        else:
1296
1116
            return True, path, ie
1297
1117
 
1298
1118
    @staticmethod
1299
 
    def _cmp_path_by_dirblock(path1, path2):
 
1119
    def _lt_path_by_dirblock(path1, path2):
1300
1120
        """Compare two paths based on what directory they are in.
1301
1121
 
1302
1122
        This generates a sort order, such that all children of a directory are
1311
1131
        """
1312
1132
        # Shortcut this special case
1313
1133
        if path1 == path2:
1314
 
            return 0
 
1134
            return False
1315
1135
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1316
1136
        # Unicode objects. Consider using encode_utf8() and then using the
1317
1137
        # optimized versions, or maybe writing optimized unicode versions.
1318
 
        if not isinstance(path1, unicode):
 
1138
        if not isinstance(path1, text_type):
1319
1139
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1320
1140
                            % (type(path1), path1))
1321
 
        if not isinstance(path2, unicode):
 
1141
        if not isinstance(path2, text_type):
1322
1142
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1323
1143
                            % (type(path2), path2))
1324
 
        return cmp(MultiWalker._path_to_key(path1),
1325
 
                   MultiWalker._path_to_key(path2))
 
1144
        return (MultiWalker._path_to_key(path1) <
 
1145
                MultiWalker._path_to_key(path2))
1326
1146
 
1327
1147
    @staticmethod
1328
1148
    def _path_to_key(path):
1358
1178
            return (None, None)
1359
1179
        else:
1360
1180
            self._out_of_order_processed.add(file_id)
1361
 
            cur_ie = other_tree.inventory[file_id]
 
1181
            cur_ie = other_tree.root_inventory.get_entry(file_id)
1362
1182
            return (cur_path, cur_ie)
1363
1183
 
1364
1184
    def iter_all(self):
1385
1205
                         for other in self._other_trees]
1386
1206
        other_entries = [self._step_one(walker) for walker in other_walkers]
1387
1207
        # Track extra nodes in the other trees
1388
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
 
1208
        others_extra = [{} for _ in range(len(self._other_trees))]
1389
1209
 
1390
1210
        master_has_more = True
1391
1211
        step_one = self._step_one
1418
1238
                    other_walker = other_walkers[idx]
1419
1239
                    other_extra = others_extra[idx]
1420
1240
                    while (other_has_more and
1421
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
 
1241
                           self._lt_path_by_dirblock(other_path, path)):
1422
1242
                        other_file_id = other_ie.file_id
1423
1243
                        if other_file_id not in out_of_order_processed:
1424
1244
                            other_extra[other_file_id] = (other_path, other_ie)
1465
1285
        #       might ensure better ordering, in case a caller strictly
1466
1286
        #       requires parents before children.
1467
1287
        for idx, other_extra in enumerate(self._others_extra):
1468
 
            others = sorted(other_extra.itervalues(),
 
1288
            others = sorted(viewvalues(other_extra),
1469
1289
                            key=lambda x: self._path_to_key(x[0]))
1470
1290
            for other_path, other_ie in others:
1471
1291
                file_id = other_ie.file_id
1473
1293
                # the lookup_by_file_id will be removing anything processed
1474
1294
                # from the extras cache
1475
1295
                other_extra.pop(file_id)
1476
 
                other_values = [(None, None) for i in xrange(idx)]
 
1296
                other_values = [(None, None)] * idx
1477
1297
                other_values.append((other_path, other_ie))
1478
1298
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1479
1299
                    alt_idx = alt_idx + idx + 1
1482
1302
                    other_values.append(self._lookup_by_file_id(
1483
1303
                                            alt_extra, alt_tree, file_id))
1484
1304
                yield other_path, file_id, None, other_values
 
1305
 
 
1306
 
 
1307
def find_previous_paths(from_tree, to_tree, paths):
 
1308
    """Find previous tree paths.
 
1309
 
 
1310
    :param from_tree: From tree
 
1311
    :param to_tree: To tree
 
1312
    :param paths: Iterable over paths to search for
 
1313
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
 
1314
        None if there is no equivalent path.
 
1315
    """
 
1316
    ret = {}
 
1317
    for path in paths:
 
1318
        ret[path] = find_previous_path(from_tree, to_tree, path)
 
1319
    return ret
 
1320
 
 
1321
 
 
1322
def find_previous_path(from_tree, to_tree, path, file_id=None):
 
1323
    """Find previous tree path.
 
1324
 
 
1325
    :param from_tree: From tree
 
1326
    :param to_tree: To tree
 
1327
    :param path: Path to search for
 
1328
    :return: path in to_tree, or None if there is no equivalent path.
 
1329
    """
 
1330
    if file_id is None:
 
1331
        file_id = from_tree.path2id(path)
 
1332
    if file_id is None:
 
1333
        raise errors.NoSuchFile(path)
 
1334
    try:
 
1335
        return to_tree.id2path(file_id)
 
1336
    except errors.NoSuchId:
 
1337
        return None
 
1338
 
 
1339
 
 
1340
def get_canonical_path(tree, path, normalize):
 
1341
    """Find the canonical path of an item, ignoring case.
 
1342
 
 
1343
    :param tree: Tree to traverse
 
1344
    :param path: Case-insensitive path to look up
 
1345
    :param normalize: Function to normalize a filename for comparison
 
1346
    :return: The canonical path
 
1347
    """
 
1348
    # go walkin...
 
1349
    cur_id = tree.get_root_id()
 
1350
    cur_path = ''
 
1351
    bit_iter = iter(path.split("/"))
 
1352
    for elt in bit_iter:
 
1353
        lelt = normalize(elt)
 
1354
        new_path = None
 
1355
        try:
 
1356
            for child in tree.iter_child_entries(cur_path, cur_id):
 
1357
                try:
 
1358
                    if child.name == elt:
 
1359
                        # if we found an exact match, we can stop now; if
 
1360
                        # we found an approximate match we need to keep
 
1361
                        # searching because there might be an exact match
 
1362
                        # later.
 
1363
                        cur_id = child.file_id
 
1364
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1365
                        break
 
1366
                    elif normalize(child.name) == lelt:
 
1367
                        cur_id = child.file_id
 
1368
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1369
                except errors.NoSuchId:
 
1370
                    # before a change is committed we can see this error...
 
1371
                    continue
 
1372
        except errors.NotADirectory:
 
1373
            pass
 
1374
        if new_path:
 
1375
            cur_path = new_path
 
1376
        else:
 
1377
            # got to the end of this directory and no entries matched.
 
1378
            # Return what matched so far, plus the rest as specified.
 
1379
            cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
1380
            break
 
1381
    return cur_path