/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: Jelmer Vernooij
  • Date: 2018-10-30 02:24:12 UTC
  • mto: This revision was merged to the branch mainline in revision 7170.
  • Revision ID: jelmer@jelmer.uk-20181030022412-33hzkg6wg2tfimu4
Fix more tests.

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):
73
142
        :param want_unchanged: An optional boolean requesting the inclusion of
74
143
            unchanged entries in the result.
75
144
        :param extra_trees: An optional list of additional trees to use when
76
 
            mapping the contents of specific_files (paths) to file_ids.
 
145
            mapping the contents of specific_files (paths) to their identities.
77
146
        :param require_versioned: An optional boolean (defaults to False). When
78
147
            supplied and True all the 'specific_files' must be versioned, or
79
148
            a PathsNotVersionedError will be thrown.
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):
 
249
        """Iterate over the children of a directory or tree reference.
 
250
 
 
251
        :param path: Path of the directory
 
252
        :raise NoSuchFile: When the path does not exist
 
253
        :return: Iterator over entries in the directory
 
254
        """
 
255
        raise NotImplementedError(self.iter_child_entries)
 
256
 
 
257
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
258
        """List all files in this tree.
 
259
 
 
260
        :param include_root: Whether to include the entry for the tree root
 
261
        :param from_dir: Directory under which to list files
 
262
        :param recursive: Whether to list files recursively
 
263
        :return: iterator over tuples of (path, versioned, kind, file_id,
 
264
            inventory entry)
 
265
        """
 
266
        raise NotImplementedError(self.list_files)
203
267
 
204
268
    def iter_references(self):
205
269
        if self.supports_tree_reference():
207
271
                if entry.kind == 'tree-reference':
208
272
                    yield path, entry.file_id
209
273
 
210
 
    def kind(self, file_id):
 
274
    def kind(self, path):
211
275
        raise NotImplementedError("Tree subclass %s must implement kind"
212
276
            % self.__class__.__name__)
213
277
 
214
 
    def stored_kind(self, file_id):
215
 
        """File kind stored for this file_id.
 
278
    def stored_kind(self, path):
 
279
        """File kind stored for this path.
216
280
 
217
281
        May not match kind on disk for working trees.  Always available
218
282
        for versioned files, even when the file itself is missing.
219
283
        """
220
 
        return self.kind(file_id)
 
284
        return self.kind(path)
221
285
 
222
286
    def path_content_summary(self, path):
223
287
        """Get a summary of the information about path.
237
301
        """
238
302
        raise NotImplementedError(self.path_content_summary)
239
303
 
240
 
    def get_reference_revision(self, file_id, path=None):
 
304
    def get_reference_revision(self, path):
241
305
        raise NotImplementedError("Tree subclass %s must implement "
242
306
                                  "get_reference_revision"
243
307
            % self.__class__.__name__)
253
317
        """
254
318
        raise NotImplementedError(self._comparison_data)
255
319
 
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.
 
320
    def get_file(self, path):
 
321
        """Return a file object for the file path in the tree.
267
322
        """
268
323
        raise NotImplementedError(self.get_file)
269
324
 
270
 
    def get_file_with_stat(self, file_id, path=None):
271
 
        """Get a file handle and stat object for file_id.
 
325
    def get_file_with_stat(self, path):
 
326
        """Get a file handle and stat object for path.
272
327
 
273
328
        The default implementation returns (self.get_file, None) for backwards
274
329
        compatibility.
275
330
 
276
 
        :param file_id: The file id to read.
277
 
        :param path: The path of the file, if it is known.
 
331
        :param path: The path of the file.
278
332
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
279
333
            no stat facility, or need for a stat cache feedback during commit,
280
334
            it may return None for the second element of the tuple.
281
335
        """
282
 
        return (self.get_file(file_id, path), None)
 
336
        return (self.get_file(path), None)
283
337
 
284
 
    def get_file_text(self, file_id, path=None):
 
338
    def get_file_text(self, path):
285
339
        """Return the byte content of a file.
286
340
 
287
 
        :param file_id: The file_id of the file.
288
341
        :param path: The path of the file.
289
 
        If both file_id and path are supplied, an implementation may use
290
 
        either one.
 
342
 
 
343
        :returns: A single byte string for the whole file.
291
344
        """
292
 
        my_file = self.get_file(file_id, path)
293
 
        try:
 
345
        with self.get_file(path) as my_file:
294
346
            return my_file.read()
295
 
        finally:
296
 
            my_file.close()
297
347
 
298
 
    def get_file_lines(self, file_id, path=None):
 
348
    def get_file_lines(self, path):
299
349
        """Return the content of a file, as lines.
300
350
 
301
 
        :param file_id: The file_id of the file.
302
351
        :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):
 
352
        """
 
353
        return osutils.split_lines(self.get_file_text(path))
 
354
 
 
355
    def get_file_verifier(self, path, stat_value=None):
 
356
        """Return a verifier for a file.
 
357
 
 
358
        The default implementation returns a sha1.
 
359
 
 
360
        :param path: The path that this file can be found at.
 
361
            These must point to the same object.
 
362
        :param stat_value: Optional stat value for the object
 
363
        :return: Tuple with verifier name and verifier data
 
364
        """
 
365
        return ("SHA1", self.get_file_sha1(path, stat_value=stat_value))
 
366
 
 
367
    def get_file_sha1(self, path, stat_value=None):
 
368
        """Return the SHA1 file for a file.
 
369
 
 
370
        :note: callers should use get_file_verifier instead
 
371
            where possible, as the underlying repository implementation may
 
372
            have quicker access to a non-sha1 verifier.
 
373
 
 
374
        :param path: The path that this file can be found at.
 
375
        :param stat_value: Optional stat value for the object
 
376
        """
 
377
        raise NotImplementedError(self.get_file_sha1)
 
378
 
 
379
    def get_file_mtime(self, path):
309
380
        """Return the modification time for a file.
310
381
 
311
 
        :param file_id: The handle for this file.
312
382
        :param path: The path that this file can be found at.
313
 
            These must point to the same object.
314
383
        """
315
384
        raise NotImplementedError(self.get_file_mtime)
316
385
 
317
 
    def get_file_size(self, file_id):
 
386
    def get_file_size(self, path):
318
387
        """Return the size of a file in bytes.
319
388
 
320
389
        This applies only to regular files.  If invoked on directories or
321
390
        symlinks, it will return None.
322
 
        :param file_id: The file-id of the file
323
391
        """
324
392
        raise NotImplementedError(self.get_file_size)
325
393
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
394
    def is_executable(self, path):
 
395
        """Check if a file is executable.
 
396
 
 
397
        :param path: The path that this file can be found at.
 
398
        """
 
399
        raise NotImplementedError(self.is_executable)
328
400
 
329
401
    def iter_files_bytes(self, desired_files):
330
402
        """Iterate through file contents.
342
414
        this implementation, it is a tuple containing a single bytestring with
343
415
        the complete text of the file.
344
416
 
345
 
        :param desired_files: a list of (file_id, identifier) pairs
 
417
        :param desired_files: a list of (path, identifier) pairs
346
418
        """
347
 
        for file_id, identifier in desired_files:
 
419
        for path, identifier in desired_files:
348
420
            # We wrap the string in a tuple so that we can return an iterable
349
421
            # of bytestrings.  (Technically, a bytestring is also an iterable
350
422
            # of bytestrings, but iterating through each character is not
351
423
            # performant.)
352
 
            cur_file = (self.get_file_text(file_id),)
 
424
            cur_file = (self.get_file_text(path),)
353
425
            yield identifier, cur_file
354
426
 
355
 
    def get_symlink_target(self, file_id):
356
 
        """Get the target for a given file_id.
 
427
    def get_symlink_target(self, path):
 
428
        """Get the target for a given path.
357
429
 
358
 
        It is assumed that the caller already knows that file_id is referencing
 
430
        It is assumed that the caller already knows that path is referencing
359
431
        a symlink.
360
 
        :param file_id: Handle for the symlink entry.
 
432
        :param path: The path of the file.
361
433
        :return: The path the symlink points to.
362
434
        """
363
435
        raise NotImplementedError(self.get_symlink_target)
364
436
 
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
437
    def get_root_id(self):
444
438
        """Return the file_id for the root of this tree."""
445
439
        raise NotImplementedError(self.get_root_id)
446
440
 
447
 
    def annotate_iter(self, file_id,
 
441
    def annotate_iter(self, path,
448
442
                      default_revision=_mod_revision.CURRENT_REVISION):
449
443
        """Return an iterator of revision_id, line tuples.
450
444
 
451
445
        For working trees (and mutable trees in general), the special
452
446
        revision_id 'current:' will be used for lines that are new in this
453
447
        tree, e.g. uncommitted changes.
454
 
        :param file_id: The file to produce an annotated version from
 
448
        :param path: The file to produce an annotated version from
455
449
        :param default_revision: For lines that don't match a basis, mark them
456
450
            with this revision id. Not all implementations will make use of
457
451
            this value.
458
452
        """
459
453
        raise NotImplementedError(self.annotate_iter)
460
454
 
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
455
    def _iter_parent_trees(self):
499
456
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
500
457
        for revision_id in self.get_parent_ids():
503
460
            except errors.NoSuchRevisionInTree:
504
461
                yield self.repository.revision_tree(revision_id)
505
462
 
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
463
    def path2id(self, path):
557
464
        """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
 
465
        raise NotImplementedError(self.path2id)
 
466
 
 
467
    def is_versioned(self, path):
 
468
        """Check whether path is versioned.
 
469
 
 
470
        :param path: Path to check
 
471
        :return: boolean
 
472
        """
 
473
        return self.path2id(path) is not None
 
474
 
 
475
    def find_related_paths_across_trees(self, paths, trees=[],
 
476
            require_versioned=True):
 
477
        """Find related paths in tree corresponding to specified filenames in any
 
478
        of `lookup_trees`.
 
479
 
 
480
        All matches in all trees will be used, and all children of matched
 
481
        directories will be used.
 
482
 
 
483
        :param paths: The filenames to find related paths for (if None, returns
 
484
            None)
 
485
        :param trees: The trees to find file_ids within
 
486
        :param require_versioned: if true, all specified filenames must occur in
 
487
            at least one tree.
 
488
        :return: a set of paths for the specified filenames and their children
 
489
            in `tree`
 
490
        """
 
491
        raise NotImplementedError(self.find_related_paths_across_trees)
583
492
 
584
493
    def lock_read(self):
585
 
        pass
 
494
        """Lock this tree for multiple read only operations.
 
495
 
 
496
        :return: A breezy.lock.LogicalLockResult.
 
497
        """
 
498
        return lock.LogicalLockResult(self.unlock)
586
499
 
587
500
    def revision_tree(self, revision_id):
588
501
        """Obtain a revision tree for the revision revision_id.
617
530
        # NB: we specifically *don't* call self.has_filename, because for
618
531
        # WorkingTrees that can indicate files that exist on disk but that
619
532
        # are not versioned.
620
 
        pred = self.inventory.has_filename
621
 
        return set((p for p in paths if not pred(p)))
 
533
        return set(p for p in paths if not self.is_versioned(p))
622
534
 
623
535
    def walkdirs(self, prefix=""):
624
536
        """Walk the contents of this tree from path down.
656
568
    def supports_content_filtering(self):
657
569
        return False
658
570
 
659
 
    def _content_filter_stack(self, path=None, file_id=None):
 
571
    def _content_filter_stack(self, path=None):
660
572
        """The stack of content filters for a path if filtering is supported.
661
573
 
662
574
        Readers will be applied in first-to-last order.
665
577
 
666
578
        :param path: path relative to the root of the tree
667
579
            or None if unknown
668
 
        :param file_id: file_id or None if unknown
669
580
        :return: the list of filters - [] if there are none
670
581
        """
671
582
        filter_pref_names = filters._get_registered_names()
672
583
        if len(filter_pref_names) == 0:
673
584
            return []
674
 
        if path is None:
675
 
            path = self.id2path(file_id)
676
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
585
        prefs = next(self.iter_search_rules([path], filter_pref_names))
677
586
        stk = filters._get_filter_stack_for(prefs)
678
587
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
588
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
680
589
        return stk
681
590
 
682
591
    def _content_filter_stack_provider(self):
689
598
        """
690
599
        if self.supports_content_filtering():
691
600
            return lambda path, file_id: \
692
 
                    self._content_filter_stack(path, file_id)
 
601
                    self._content_filter_stack(path)
693
602
        else:
694
603
            return None
695
604
 
720
629
        searcher = default_searcher
721
630
        return searcher
722
631
 
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
 
632
    def archive(self, format, name, root='', subdir=None,
 
633
                force_mtime=None):
 
634
        """Create an archive of this tree.
 
635
 
 
636
        :param format: Format name (e.g. 'tar')
 
637
        :param name: target file name
 
638
        :param root: Root directory name (or None)
 
639
        :param subdir: Subdirectory to export (or None)
 
640
        :return: Iterator over archive chunks
 
641
        """
 
642
        from .archive import create_archive
 
643
        with self.lock_read():
 
644
            return create_archive(format, self, name, root,
 
645
                    subdir, force_mtime=force_mtime)
 
646
 
 
647
    @classmethod
 
648
    def versionable_kind(cls, kind):
 
649
        """Check if this tree support versioning a specific file kind."""
 
650
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
859
651
 
860
652
 
861
653
class InterTree(InterObject):
864
656
    Its instances have methods like 'compare' and contain references to the
865
657
    source and target trees these operations are to be carried out on.
866
658
 
867
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
659
    Clients of breezy should not need to use InterTree directly, rather they
868
660
    should use the convenience methods on Tree such as 'Tree.compare()' which
869
661
    will pass through to InterTree as appropriate.
870
662
    """
877
669
 
878
670
    _optimisers = []
879
671
 
880
 
    def _changes_from_entries(self, source_entry, target_entry,
881
 
        source_path=None, target_path=None):
 
672
    @classmethod
 
673
    def is_compatible(kls, source, target):
 
674
        # The default implementation is naive and uses the public API, so
 
675
        # it works for all trees.
 
676
        return True
 
677
 
 
678
    def _changes_from_entries(self, source_entry, target_entry, source_path,
 
679
                              target_path):
882
680
        """Generate a iter_changes tuple between source_entry and target_entry.
883
681
 
884
682
        :param source_entry: An inventory entry from self.source, or None.
885
683
        :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.
 
684
        :param source_path: The path of source_entry.
 
685
        :param target_path: The path of target_entry.
890
686
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
891
687
            item 1 is True if there are any changes in the result tuple.
892
688
        """
900
696
            source_versioned = True
901
697
            source_name = source_entry.name
902
698
            source_parent = source_entry.parent_id
903
 
            if source_path is None:
904
 
                source_path = self.source.id2path(file_id)
905
699
            source_kind, source_executable, source_stat = \
906
700
                self.source._comparison_data(source_entry, source_path)
907
701
        else:
914
708
            target_versioned = True
915
709
            target_name = target_entry.name
916
710
            target_parent = target_entry.parent_id
917
 
            if target_path is None:
918
 
                target_path = self.target.id2path(file_id)
919
711
            target_kind, target_executable, target_stat = \
920
712
                self.target._comparison_data(target_entry, target_path)
921
713
        else:
930
722
        if source_kind != target_kind:
931
723
            changed_content = True
932
724
        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)):
 
725
            if not self.file_content_matches(
 
726
                    source_path, target_path,
 
727
                    source_stat, target_stat):
935
728
                changed_content = True
936
729
        elif source_kind == 'symlink':
937
 
            if (self.source.get_symlink_target(file_id) !=
938
 
                self.target.get_symlink_target(file_id)):
 
730
            if (self.source.get_symlink_target(source_path) !=
 
731
                self.target.get_symlink_target(target_path)):
939
732
                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)):
 
733
        elif source_kind == 'tree-reference':
 
734
            if (self.source.get_reference_revision(source_path)
 
735
                != self.target.get_reference_revision(target_path)):
947
736
                    changed_content = True
948
737
        parent = (source_parent, target_parent)
949
738
        name = (source_name, target_name)
957
746
        return (file_id, (source_path, target_path), changed_content,
958
747
                versioned, parent, name, kind, executable), changes
959
748
 
960
 
    @needs_read_lock
961
749
    def compare(self, want_unchanged=False, specific_files=None,
962
750
        extra_trees=None, require_versioned=False, include_root=False,
963
751
        want_unversioned=False):
980
768
        trees = (self.source,)
981
769
        if extra_trees is not None:
982
770
            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)
 
771
        with self.lock_read():
 
772
            return delta._compare_trees(self.source, self.target, want_unchanged,
 
773
                specific_files, include_root, extra_trees=extra_trees,
 
774
                require_versioned=require_versioned,
 
775
                want_unversioned=want_unversioned)
999
776
 
1000
777
    def iter_changes(self, include_unchanged=False,
1001
778
                      specific_files=None, pb=None, extra_trees=[],
1033
810
            output. An unversioned file is defined as one with (False, False)
1034
811
            for the versioned pair.
1035
812
        """
1036
 
        lookup_trees = [self.source]
1037
 
        if extra_trees:
1038
 
             lookup_trees.extend(extra_trees)
 
813
        if not extra_trees:
 
814
             extra_trees = []
 
815
        else:
 
816
             extra_trees = list(extra_trees)
1039
817
        # The ids of items we need to examine to insure delta consistency.
1040
818
        precise_file_ids = set()
1041
819
        changed_file_ids = []
1042
820
        if specific_files == []:
1043
 
            specific_file_ids = []
 
821
            target_specific_files = []
 
822
            source_specific_files = []
1044
823
        else:
1045
 
            specific_file_ids = self.target.paths2ids(specific_files,
1046
 
                lookup_trees, require_versioned=require_versioned)
 
824
            target_specific_files = self.target.find_related_paths_across_trees(
 
825
                    specific_files, [self.source] + extra_trees,
 
826
                    require_versioned=require_versioned)
 
827
            source_specific_files = self.source.find_related_paths_across_trees(
 
828
                    specific_files, [self.target] + extra_trees,
 
829
                    require_versioned=require_versioned)
1047
830
        if specific_files is not None:
1048
831
            # reparented or added entries must have their parents included
1049
832
            # so that valid deltas can be created. The seen_parents set
1058
841
                                     self.target.extras()
1059
842
                if specific_files is None or
1060
843
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
844
            all_unversioned = collections.deque(all_unversioned)
1062
845
        else:
1063
 
            all_unversioned = deque()
 
846
            all_unversioned = collections.deque()
1064
847
        to_paths = {}
1065
848
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
 
            specific_file_ids=specific_file_ids))
 
849
            specific_files=source_specific_files))
1067
850
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1068
851
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1069
 
            specific_file_ids=specific_file_ids))
 
852
            specific_files=target_specific_files))
1070
853
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1071
854
        entry_count = 0
1072
855
        # the unversioned path lookup only occurs on real trees - where there
1073
856
        # can be extras. So the fake_entry is solely used to look up
1074
857
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
858
        fake_entry = TreeFile()
1076
859
        for target_path, target_entry in to_entries_by_dir:
1077
860
            while (all_unversioned and
1078
861
                all_unversioned[0][0] < target_path.split('/')):
1095
878
            if pb is not None:
1096
879
                pb.update('comparing files', entry_count, num_entries)
1097
880
            if changes or include_unchanged:
1098
 
                if specific_file_ids is not None:
 
881
                if specific_files is not None:
1099
882
                    new_parent_id = result[4][1]
1100
883
                    precise_file_ids.add(new_parent_id)
1101
884
                    changed_file_ids.append(result[0])
1126
909
            if file_id in to_paths:
1127
910
                # already returned
1128
911
                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)
 
912
            to_path = find_previous_path(self.source, self.target, path)
1135
913
            entry_count += 1
1136
914
            if pb is not None:
1137
915
                pb.update('comparing files', entry_count, num_entries)
1148
926
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1149
927
                  name, kind, executable)
1150
928
        changed_file_ids = set(changed_file_ids)
1151
 
        if specific_file_ids is not None:
 
929
        if specific_files is not None:
1152
930
            for result in self._handle_precise_ids(precise_file_ids,
1153
931
                changed_file_ids):
1154
932
                yield result
1155
933
 
1156
 
    def _get_entry(self, tree, file_id):
 
934
    def _get_entry(self, tree, path):
1157
935
        """Get an inventory entry from a tree, with missing entries as None.
1158
936
 
1159
937
        If the tree raises NotImplementedError on accessing .inventory, then
1161
939
        desired.
1162
940
 
1163
941
        :param tree: The tree to lookup the entry in.
1164
 
        :param file_id: The file_id to lookup.
 
942
        :param path: The path to look up
1165
943
        """
 
944
        # No inventory available.
1166
945
        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
 
946
            iterator = tree.iter_entries_by_dir(specific_files=[path])
 
947
            return next(iterator)[1]
 
948
        except StopIteration:
 
949
            return None
1180
950
 
1181
951
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1182
952
        discarded_changes=None):
1224
994
                # Examine file_id
1225
995
                if discarded_changes:
1226
996
                    result = discarded_changes.get(file_id)
1227
 
                    old_entry = None
 
997
                    source_entry = None
1228
998
                else:
1229
999
                    result = None
1230
1000
                if result is None:
1231
 
                    old_entry = self._get_entry(self.source, file_id)
1232
 
                    new_entry = self._get_entry(self.target, file_id)
 
1001
                    try:
 
1002
                        source_path = self.source.id2path(file_id)
 
1003
                    except errors.NoSuchId:
 
1004
                        source_path = None
 
1005
                        source_entry = None
 
1006
                    else:
 
1007
                        source_entry = self._get_entry(self.source, source_path)
 
1008
                    try:
 
1009
                        target_path = self.target.id2path(file_id)
 
1010
                    except errors.NoSuchId:
 
1011
                        target_path = None
 
1012
                        target_entry = None
 
1013
                    else:
 
1014
                        target_entry = self._get_entry(self.target, target_path)
1233
1015
                    result, changes = self._changes_from_entries(
1234
 
                        old_entry, new_entry)
 
1016
                        source_entry, target_entry, source_path, target_path)
1235
1017
                else:
1236
1018
                    changes = True
1237
1019
                # Get this parents parent to examine.
1239
1021
                precise_file_ids.add(new_parent_id)
1240
1022
                if changes:
1241
1023
                    if (result[6][0] == 'directory' and
1242
 
                        result[6][1] != 'directory'):
 
1024
                            result[6][1] != 'directory'):
1243
1025
                        # This stopped being a directory, the old children have
1244
1026
                        # to be included.
1245
 
                        if old_entry is None:
 
1027
                        if source_entry is None:
1246
1028
                            # 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)
 
1029
                            source_entry = self._get_entry(self.source, result[1][0])
 
1030
                        precise_file_ids.update(
 
1031
                                child.file_id
 
1032
                                for child in self.source.iter_child_entries(result[1][0]))
1250
1033
                    changed_file_ids.add(result[0])
1251
1034
                    yield result
1252
1035
 
 
1036
    def file_content_matches(
 
1037
            self, source_path, target_path,
 
1038
            source_stat=None, target_stat=None):
 
1039
        """Check if two files are the same in the source and target trees.
 
1040
 
 
1041
        This only checks that the contents of the files are the same,
 
1042
        it does not touch anything else.
 
1043
 
 
1044
        :param source_path: Path of the file in the source tree
 
1045
        :param target_path: Path of the file in the target tree
 
1046
        :param source_file_id: Optional file id of the file in the source tree
 
1047
        :param target_file_id: Optional file id of the file in the target tree
 
1048
        :param source_stat: Optional stat value of the file in the source tree
 
1049
        :param target_stat: Optional stat value of the file in the target tree
 
1050
        :return: Boolean indicating whether the files have the same contents
 
1051
        """
 
1052
        with self.lock_read():
 
1053
            source_verifier_kind, source_verifier_data = (
 
1054
                    self.source.get_file_verifier(source_path, source_stat))
 
1055
            target_verifier_kind, target_verifier_data = (
 
1056
                self.target.get_file_verifier(
 
1057
                    target_path, target_stat))
 
1058
            if source_verifier_kind == target_verifier_kind:
 
1059
                return (source_verifier_data == target_verifier_data)
 
1060
            # Fall back to SHA1 for now
 
1061
            if source_verifier_kind != "SHA1":
 
1062
                source_sha1 = self.source.get_file_sha1(
 
1063
                        source_path, source_file_id, source_stat)
 
1064
            else:
 
1065
                source_sha1 = source_verifier_data
 
1066
            if target_verifier_kind != "SHA1":
 
1067
                target_sha1 = self.target.get_file_sha1(
 
1068
                        target_path, target_file_id, target_stat)
 
1069
            else:
 
1070
                target_sha1 = target_verifier_data
 
1071
            return (source_sha1 == target_sha1)
 
1072
 
 
1073
InterTree.register_optimiser(InterTree)
 
1074
 
1253
1075
 
1254
1076
class MultiWalker(object):
1255
1077
    """Walk multiple trees simultaneously, getting combined results."""
1289
1111
            If has_more is False, path and ie will be None.
1290
1112
        """
1291
1113
        try:
1292
 
            path, ie = iterator.next()
 
1114
            path, ie = next(iterator)
1293
1115
        except StopIteration:
1294
1116
            return False, None, None
1295
1117
        else:
1296
1118
            return True, path, ie
1297
1119
 
1298
1120
    @staticmethod
1299
 
    def _cmp_path_by_dirblock(path1, path2):
 
1121
    def _lt_path_by_dirblock(path1, path2):
1300
1122
        """Compare two paths based on what directory they are in.
1301
1123
 
1302
1124
        This generates a sort order, such that all children of a directory are
1311
1133
        """
1312
1134
        # Shortcut this special case
1313
1135
        if path1 == path2:
1314
 
            return 0
 
1136
            return False
1315
1137
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1316
1138
        # Unicode objects. Consider using encode_utf8() and then using the
1317
1139
        # optimized versions, or maybe writing optimized unicode versions.
1318
 
        if not isinstance(path1, unicode):
 
1140
        if not isinstance(path1, text_type):
1319
1141
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1320
1142
                            % (type(path1), path1))
1321
 
        if not isinstance(path2, unicode):
 
1143
        if not isinstance(path2, text_type):
1322
1144
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1323
1145
                            % (type(path2), path2))
1324
 
        return cmp(MultiWalker._path_to_key(path1),
1325
 
                   MultiWalker._path_to_key(path2))
 
1146
        return (MultiWalker._path_to_key(path1) <
 
1147
                MultiWalker._path_to_key(path2))
1326
1148
 
1327
1149
    @staticmethod
1328
1150
    def _path_to_key(path):
1358
1180
            return (None, None)
1359
1181
        else:
1360
1182
            self._out_of_order_processed.add(file_id)
1361
 
            cur_ie = other_tree.inventory[file_id]
 
1183
            cur_ie = other_tree.root_inventory.get_entry(file_id)
1362
1184
            return (cur_path, cur_ie)
1363
1185
 
1364
1186
    def iter_all(self):
1385
1207
                         for other in self._other_trees]
1386
1208
        other_entries = [self._step_one(walker) for walker in other_walkers]
1387
1209
        # Track extra nodes in the other trees
1388
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
 
1210
        others_extra = [{} for _ in range(len(self._other_trees))]
1389
1211
 
1390
1212
        master_has_more = True
1391
1213
        step_one = self._step_one
1418
1240
                    other_walker = other_walkers[idx]
1419
1241
                    other_extra = others_extra[idx]
1420
1242
                    while (other_has_more and
1421
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
 
1243
                           self._lt_path_by_dirblock(other_path, path)):
1422
1244
                        other_file_id = other_ie.file_id
1423
1245
                        if other_file_id not in out_of_order_processed:
1424
1246
                            other_extra[other_file_id] = (other_path, other_ie)
1465
1287
        #       might ensure better ordering, in case a caller strictly
1466
1288
        #       requires parents before children.
1467
1289
        for idx, other_extra in enumerate(self._others_extra):
1468
 
            others = sorted(other_extra.itervalues(),
 
1290
            others = sorted(viewvalues(other_extra),
1469
1291
                            key=lambda x: self._path_to_key(x[0]))
1470
1292
            for other_path, other_ie in others:
1471
1293
                file_id = other_ie.file_id
1473
1295
                # the lookup_by_file_id will be removing anything processed
1474
1296
                # from the extras cache
1475
1297
                other_extra.pop(file_id)
1476
 
                other_values = [(None, None) for i in xrange(idx)]
 
1298
                other_values = [(None, None)] * idx
1477
1299
                other_values.append((other_path, other_ie))
1478
1300
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1479
1301
                    alt_idx = alt_idx + idx + 1
1482
1304
                    other_values.append(self._lookup_by_file_id(
1483
1305
                                            alt_extra, alt_tree, file_id))
1484
1306
                yield other_path, file_id, None, other_values
 
1307
 
 
1308
 
 
1309
def find_previous_paths(from_tree, to_tree, paths):
 
1310
    """Find previous tree paths.
 
1311
 
 
1312
    :param from_tree: From tree
 
1313
    :param to_tree: To tree
 
1314
    :param paths: Iterable over paths to search for
 
1315
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
 
1316
        None if there is no equivalent path.
 
1317
    """
 
1318
    ret = {}
 
1319
    for path in paths:
 
1320
        ret[path] = find_previous_path(from_tree, to_tree, path)
 
1321
    return ret
 
1322
 
 
1323
 
 
1324
def find_previous_path(from_tree, to_tree, path, file_id=None):
 
1325
    """Find previous tree path.
 
1326
 
 
1327
    :param from_tree: From tree
 
1328
    :param to_tree: To tree
 
1329
    :param path: Path to search for
 
1330
    :return: path in to_tree, or None if there is no equivalent path.
 
1331
    """
 
1332
    if file_id is None:
 
1333
        file_id = from_tree.path2id(path)
 
1334
    if file_id is None:
 
1335
        raise errors.NoSuchFile(path)
 
1336
    try:
 
1337
        return to_tree.id2path(file_id)
 
1338
    except errors.NoSuchId:
 
1339
        return None
 
1340
 
 
1341
 
 
1342
def get_canonical_path(tree, path, normalize):
 
1343
    """Find the canonical path of an item, ignoring case.
 
1344
 
 
1345
    :param tree: Tree to traverse
 
1346
    :param path: Case-insensitive path to look up
 
1347
    :param normalize: Function to normalize a filename for comparison
 
1348
    :return: The canonical path
 
1349
    """
 
1350
    # go walkin...
 
1351
    cur_id = tree.get_root_id()
 
1352
    cur_path = ''
 
1353
    bit_iter = iter(path.split("/"))
 
1354
    for elt in bit_iter:
 
1355
        lelt = normalize(elt)
 
1356
        new_path = None
 
1357
        try:
 
1358
            for child in tree.iter_child_entries(cur_path, cur_id):
 
1359
                try:
 
1360
                    if child.name == elt:
 
1361
                        # if we found an exact match, we can stop now; if
 
1362
                        # we found an approximate match we need to keep
 
1363
                        # searching because there might be an exact match
 
1364
                        # later.
 
1365
                        cur_id = child.file_id
 
1366
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1367
                        break
 
1368
                    elif normalize(child.name) == lelt:
 
1369
                        cur_id = child.file_id
 
1370
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1371
                except errors.NoSuchId:
 
1372
                    # before a change is committed we can see this error...
 
1373
                    continue
 
1374
        except errors.NotADirectory:
 
1375
            pass
 
1376
        if new_path:
 
1377
            cur_path = new_path
 
1378
        else:
 
1379
            # got to the end of this directory and no entries matched.
 
1380
            # Return what matched so far, plus the rest as specified.
 
1381
            cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
1382
            break
 
1383
    return cur_path