/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-11-16 10:50:21 UTC
  • mfrom: (7164 work)
  • mto: This revision was merged to the branch mainline in revision 7165.
  • Revision ID: jelmer@jelmer.uk-20181116105021-xl419v2rh4aus1au
Merge trunk.

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):
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, file_id=None):
 
247
        """Iterate over the children of a directory or tree reference.
 
248
 
 
249
        :param path: Path of the directory
 
250
        :param file_id: Optional file id of the directory/tree-reference
 
251
        :raise NoSuchId: When the file_id does not exist
 
252
        :return: Iterator over entries in the directory
 
253
        """
 
254
        raise NotImplementedError(self.iter_child_entries)
 
255
 
 
256
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
257
        """List all files in this tree.
 
258
 
 
259
        :param include_root: Whether to include the entry for the tree root
 
260
        :param from_dir: Directory under which to list files
 
261
        :param recursive: Whether to list files recursively
 
262
        :return: iterator over tuples of (path, versioned, kind, file_id,
 
263
            inventory entry)
 
264
        """
 
265
        raise NotImplementedError(self.list_files)
203
266
 
204
267
    def iter_references(self):
205
268
        if self.supports_tree_reference():
207
270
                if entry.kind == 'tree-reference':
208
271
                    yield path, entry.file_id
209
272
 
210
 
    def kind(self, file_id):
 
273
    def kind(self, path, file_id=None):
211
274
        raise NotImplementedError("Tree subclass %s must implement kind"
212
275
            % self.__class__.__name__)
213
276
 
214
 
    def stored_kind(self, file_id):
 
277
    def stored_kind(self, path, file_id=None):
215
278
        """File kind stored for this file_id.
216
279
 
217
280
        May not match kind on disk for working trees.  Always available
218
281
        for versioned files, even when the file itself is missing.
219
282
        """
220
 
        return self.kind(file_id)
 
283
        return self.kind(path, file_id)
221
284
 
222
285
    def path_content_summary(self, path):
223
286
        """Get a summary of the information about path.
237
300
        """
238
301
        raise NotImplementedError(self.path_content_summary)
239
302
 
240
 
    def get_reference_revision(self, file_id, path=None):
 
303
    def get_reference_revision(self, path, file_id=None):
241
304
        raise NotImplementedError("Tree subclass %s must implement "
242
305
                                  "get_reference_revision"
243
306
            % self.__class__.__name__)
253
316
        """
254
317
        raise NotImplementedError(self._comparison_data)
255
318
 
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):
 
319
    def get_file(self, path, file_id=None):
263
320
        """Return a file object for the file file_id in the tree.
264
321
 
265
322
        If both file_id and path are defined, it is implementation defined as
267
324
        """
268
325
        raise NotImplementedError(self.get_file)
269
326
 
270
 
    def get_file_with_stat(self, file_id, path=None):
 
327
    def get_file_with_stat(self, path, file_id=None):
271
328
        """Get a file handle and stat object for file_id.
272
329
 
273
330
        The default implementation returns (self.get_file, None) for backwards
274
331
        compatibility.
275
332
 
276
 
        :param file_id: The file id to read.
277
 
        :param path: The path of the file, if it is known.
 
333
        :param path: The path of the file.
 
334
        :param file_id: The file id to read, if it is known.
278
335
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
279
336
            no stat facility, or need for a stat cache feedback during commit,
280
337
            it may return None for the second element of the tuple.
281
338
        """
282
 
        return (self.get_file(file_id, path), None)
 
339
        return (self.get_file(path, file_id), None)
283
340
 
284
 
    def get_file_text(self, file_id, path=None):
 
341
    def get_file_text(self, path, file_id=None):
285
342
        """Return the byte content of a file.
286
343
 
 
344
        :param path: The path of the file.
287
345
        :param file_id: The file_id of the file.
288
 
        :param path: The path of the file.
 
346
 
289
347
        If both file_id and path are supplied, an implementation may use
290
348
        either one.
 
349
 
 
350
        :returns: A single byte string for the whole file.
291
351
        """
292
 
        my_file = self.get_file(file_id, path)
293
 
        try:
 
352
        with self.get_file(path, file_id) as my_file:
294
353
            return my_file.read()
295
 
        finally:
296
 
            my_file.close()
297
354
 
298
 
    def get_file_lines(self, file_id, path=None):
 
355
    def get_file_lines(self, path, file_id=None):
299
356
        """Return the content of a file, as lines.
300
357
 
 
358
        :param path: The path of the file.
301
359
        :param file_id: The file_id of the file.
302
 
        :param path: The path of the file.
 
360
 
303
361
        If both file_id and path are supplied, an implementation may use
304
362
        either one.
305
363
        """
306
 
        return osutils.split_lines(self.get_file_text(file_id, path))
307
 
 
308
 
    def get_file_mtime(self, file_id, path=None):
 
364
        return osutils.split_lines(self.get_file_text(path, file_id))
 
365
 
 
366
    def get_file_verifier(self, path, file_id=None, stat_value=None):
 
367
        """Return a verifier for a file.
 
368
 
 
369
        The default implementation returns a sha1.
 
370
 
 
371
        :param file_id: The handle for this file.
 
372
        :param path: The path that this file can be found at.
 
373
            These must point to the same object.
 
374
        :param stat_value: Optional stat value for the object
 
375
        :return: Tuple with verifier name and verifier data
 
376
        """
 
377
        return ("SHA1", self.get_file_sha1(path, file_id,
 
378
            stat_value=stat_value))
 
379
 
 
380
    def get_file_sha1(self, path, file_id=None, stat_value=None):
 
381
        """Return the SHA1 file for a file.
 
382
 
 
383
        :note: callers should use get_file_verifier instead
 
384
            where possible, as the underlying repository implementation may
 
385
            have quicker access to a non-sha1 verifier.
 
386
 
 
387
        :param path: The path that this file can be found at.
 
388
        :param file_id: The handle for this file.
 
389
            These must point to the same object.
 
390
        :param stat_value: Optional stat value for the object
 
391
        """
 
392
        raise NotImplementedError(self.get_file_sha1)
 
393
 
 
394
    def get_file_mtime(self, path, file_id=None):
309
395
        """Return the modification time for a file.
310
396
 
 
397
        :param path: The path that this file can be found at.
311
398
        :param file_id: The handle for this file.
312
 
        :param path: The path that this file can be found at.
313
399
            These must point to the same object.
314
400
        """
315
401
        raise NotImplementedError(self.get_file_mtime)
316
402
 
317
 
    def get_file_size(self, file_id):
 
403
    def get_file_size(self, path, file_id=None):
318
404
        """Return the size of a file in bytes.
319
405
 
320
406
        This applies only to regular files.  If invoked on directories or
323
409
        """
324
410
        raise NotImplementedError(self.get_file_size)
325
411
 
326
 
    def get_file_by_path(self, path):
327
 
        return self.get_file(self._inventory.path2id(path), path)
 
412
    def is_executable(self, path, file_id=None):
 
413
        """Check if a file is executable.
 
414
 
 
415
        :param path: The path that this file can be found at.
 
416
        :param file_id: The handle for this file.
 
417
            These must point to the same object.
 
418
        """
 
419
        raise NotImplementedError(self.is_executable)
328
420
 
329
421
    def iter_files_bytes(self, desired_files):
330
422
        """Iterate through file contents.
342
434
        this implementation, it is a tuple containing a single bytestring with
343
435
        the complete text of the file.
344
436
 
345
 
        :param desired_files: a list of (file_id, identifier) pairs
 
437
        :param desired_files: a list of (path, identifier) pairs
346
438
        """
347
 
        for file_id, identifier in desired_files:
 
439
        for path, identifier in desired_files:
348
440
            # We wrap the string in a tuple so that we can return an iterable
349
441
            # of bytestrings.  (Technically, a bytestring is also an iterable
350
442
            # of bytestrings, but iterating through each character is not
351
443
            # performant.)
352
 
            cur_file = (self.get_file_text(file_id),)
 
444
            cur_file = (self.get_file_text(path),)
353
445
            yield identifier, cur_file
354
446
 
355
 
    def get_symlink_target(self, file_id):
 
447
    def get_symlink_target(self, path, file_id=None):
356
448
        """Get the target for a given file_id.
357
449
 
358
450
        It is assumed that the caller already knows that file_id is referencing
359
451
        a symlink.
360
452
        :param file_id: Handle for the symlink entry.
 
453
        :param path: The path of the file.
 
454
        If both file_id and path are supplied, an implementation may use
 
455
        either one.
361
456
        :return: The path the symlink points to.
362
457
        """
363
458
        raise NotImplementedError(self.get_symlink_target)
364
459
 
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
460
    def get_root_id(self):
444
461
        """Return the file_id for the root of this tree."""
445
462
        raise NotImplementedError(self.get_root_id)
446
463
 
447
 
    def annotate_iter(self, file_id,
 
464
    def annotate_iter(self, path, file_id=None,
448
465
                      default_revision=_mod_revision.CURRENT_REVISION):
449
466
        """Return an iterator of revision_id, line tuples.
450
467
 
458
475
        """
459
476
        raise NotImplementedError(self.annotate_iter)
460
477
 
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
478
    def _iter_parent_trees(self):
499
479
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
500
480
        for revision_id in self.get_parent_ids():
503
483
            except errors.NoSuchRevisionInTree:
504
484
                yield self.repository.revision_tree(revision_id)
505
485
 
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
486
    def path2id(self, path):
557
487
        """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
 
488
        raise NotImplementedError(self.path2id)
 
489
 
 
490
    def is_versioned(self, path):
 
491
        """Check whether path is versioned.
 
492
 
 
493
        :param path: Path to check
 
494
        :return: boolean
 
495
        """
 
496
        return self.path2id(path) is not None
 
497
 
 
498
    def find_related_paths_across_trees(self, paths, trees=[],
 
499
            require_versioned=True):
 
500
        """Find related paths in tree corresponding to specified filenames in any
 
501
        of `lookup_trees`.
 
502
 
 
503
        All matches in all trees will be used, and all children of matched
 
504
        directories will be used.
 
505
 
 
506
        :param paths: The filenames to find related paths for (if None, returns
 
507
            None)
 
508
        :param trees: The trees to find file_ids within
 
509
        :param require_versioned: if true, all specified filenames must occur in
 
510
            at least one tree.
 
511
        :return: a set of paths for the specified filenames and their children
 
512
            in `tree`
 
513
        """
 
514
        raise NotImplementedError(self.find_related_paths_across_trees)
583
515
 
584
516
    def lock_read(self):
585
 
        pass
 
517
        """Lock this tree for multiple read only operations.
 
518
 
 
519
        :return: A breezy.lock.LogicalLockResult.
 
520
        """
 
521
        return lock.LogicalLockResult(self.unlock)
586
522
 
587
523
    def revision_tree(self, revision_id):
588
524
        """Obtain a revision tree for the revision revision_id.
617
553
        # NB: we specifically *don't* call self.has_filename, because for
618
554
        # WorkingTrees that can indicate files that exist on disk but that
619
555
        # are not versioned.
620
 
        pred = self.inventory.has_filename
621
 
        return set((p for p in paths if not pred(p)))
 
556
        return set(p for p in paths if not self.is_versioned(p))
622
557
 
623
558
    def walkdirs(self, prefix=""):
624
559
        """Walk the contents of this tree from path down.
656
591
    def supports_content_filtering(self):
657
592
        return False
658
593
 
659
 
    def _content_filter_stack(self, path=None, file_id=None):
 
594
    def _content_filter_stack(self, path=None):
660
595
        """The stack of content filters for a path if filtering is supported.
661
596
 
662
597
        Readers will be applied in first-to-last order.
665
600
 
666
601
        :param path: path relative to the root of the tree
667
602
            or None if unknown
668
 
        :param file_id: file_id or None if unknown
669
603
        :return: the list of filters - [] if there are none
670
604
        """
671
605
        filter_pref_names = filters._get_registered_names()
672
606
        if len(filter_pref_names) == 0:
673
607
            return []
674
 
        if path is None:
675
 
            path = self.id2path(file_id)
676
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
608
        prefs = next(self.iter_search_rules([path], filter_pref_names))
677
609
        stk = filters._get_filter_stack_for(prefs)
678
610
        if 'filters' in debug.debug_flags:
679
 
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
 
611
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
680
612
        return stk
681
613
 
682
614
    def _content_filter_stack_provider(self):
689
621
        """
690
622
        if self.supports_content_filtering():
691
623
            return lambda path, file_id: \
692
 
                    self._content_filter_stack(path, file_id)
 
624
                    self._content_filter_stack(path)
693
625
        else:
694
626
            return None
695
627
 
720
652
        searcher = default_searcher
721
653
        return searcher
722
654
 
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
 
655
    def archive(self, format, name, root='', subdir=None,
 
656
                force_mtime=None):
 
657
        """Create an archive of this tree.
 
658
 
 
659
        :param format: Format name (e.g. 'tar')
 
660
        :param name: target file name
 
661
        :param root: Root directory name (or None)
 
662
        :param subdir: Subdirectory to export (or None)
 
663
        :return: Iterator over archive chunks
 
664
        """
 
665
        from .archive import create_archive
 
666
        with self.lock_read():
 
667
            return create_archive(format, self, name, root,
 
668
                    subdir, force_mtime=force_mtime)
 
669
 
 
670
    @classmethod
 
671
    def versionable_kind(cls, kind):
 
672
        """Check if this tree support versioning a specific file kind."""
 
673
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
859
674
 
860
675
 
861
676
class InterTree(InterObject):
864
679
    Its instances have methods like 'compare' and contain references to the
865
680
    source and target trees these operations are to be carried out on.
866
681
 
867
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
682
    Clients of breezy should not need to use InterTree directly, rather they
868
683
    should use the convenience methods on Tree such as 'Tree.compare()' which
869
684
    will pass through to InterTree as appropriate.
870
685
    """
877
692
 
878
693
    _optimisers = []
879
694
 
880
 
    def _changes_from_entries(self, source_entry, target_entry,
881
 
        source_path=None, target_path=None):
 
695
    @classmethod
 
696
    def is_compatible(kls, source, target):
 
697
        # The default implementation is naive and uses the public API, so
 
698
        # it works for all trees.
 
699
        return True
 
700
 
 
701
    def _changes_from_entries(self, source_entry, target_entry, source_path,
 
702
                              target_path):
882
703
        """Generate a iter_changes tuple between source_entry and target_entry.
883
704
 
884
705
        :param source_entry: An inventory entry from self.source, or None.
885
706
        :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.
 
707
        :param source_path: The path of source_entry.
 
708
        :param target_path: The path of target_entry.
890
709
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
891
710
            item 1 is True if there are any changes in the result tuple.
892
711
        """
900
719
            source_versioned = True
901
720
            source_name = source_entry.name
902
721
            source_parent = source_entry.parent_id
903
 
            if source_path is None:
904
 
                source_path = self.source.id2path(file_id)
905
722
            source_kind, source_executable, source_stat = \
906
723
                self.source._comparison_data(source_entry, source_path)
907
724
        else:
914
731
            target_versioned = True
915
732
            target_name = target_entry.name
916
733
            target_parent = target_entry.parent_id
917
 
            if target_path is None:
918
 
                target_path = self.target.id2path(file_id)
919
734
            target_kind, target_executable, target_stat = \
920
735
                self.target._comparison_data(target_entry, target_path)
921
736
        else:
930
745
        if source_kind != target_kind:
931
746
            changed_content = True
932
747
        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)):
 
748
            if not self.file_content_matches(
 
749
                    source_path, target_path,
 
750
                    file_id, file_id, source_stat, target_stat):
935
751
                changed_content = True
936
752
        elif source_kind == 'symlink':
937
 
            if (self.source.get_symlink_target(file_id) !=
938
 
                self.target.get_symlink_target(file_id)):
 
753
            if (self.source.get_symlink_target(source_path, file_id) !=
 
754
                self.target.get_symlink_target(target_path, file_id)):
939
755
                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)):
 
756
        elif source_kind == 'tree-reference':
 
757
            if (self.source.get_reference_revision(source_path, file_id)
 
758
                != self.target.get_reference_revision(target_path, file_id)):
947
759
                    changed_content = True
948
760
        parent = (source_parent, target_parent)
949
761
        name = (source_name, target_name)
957
769
        return (file_id, (source_path, target_path), changed_content,
958
770
                versioned, parent, name, kind, executable), changes
959
771
 
960
 
    @needs_read_lock
961
772
    def compare(self, want_unchanged=False, specific_files=None,
962
773
        extra_trees=None, require_versioned=False, include_root=False,
963
774
        want_unversioned=False):
980
791
        trees = (self.source,)
981
792
        if extra_trees is not None:
982
793
            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)
 
794
        with self.lock_read():
 
795
            return delta._compare_trees(self.source, self.target, want_unchanged,
 
796
                specific_files, include_root, extra_trees=extra_trees,
 
797
                require_versioned=require_versioned,
 
798
                want_unversioned=want_unversioned)
999
799
 
1000
800
    def iter_changes(self, include_unchanged=False,
1001
801
                      specific_files=None, pb=None, extra_trees=[],
1033
833
            output. An unversioned file is defined as one with (False, False)
1034
834
            for the versioned pair.
1035
835
        """
1036
 
        lookup_trees = [self.source]
1037
 
        if extra_trees:
1038
 
             lookup_trees.extend(extra_trees)
 
836
        if not extra_trees:
 
837
             extra_trees = []
 
838
        else:
 
839
             extra_trees = list(extra_trees)
1039
840
        # The ids of items we need to examine to insure delta consistency.
1040
841
        precise_file_ids = set()
1041
842
        changed_file_ids = []
1042
843
        if specific_files == []:
1043
 
            specific_file_ids = []
 
844
            target_specific_files = []
 
845
            source_specific_files = []
1044
846
        else:
1045
 
            specific_file_ids = self.target.paths2ids(specific_files,
1046
 
                lookup_trees, require_versioned=require_versioned)
 
847
            target_specific_files = self.target.find_related_paths_across_trees(
 
848
                    specific_files, [self.source] + extra_trees,
 
849
                    require_versioned=require_versioned)
 
850
            source_specific_files = self.source.find_related_paths_across_trees(
 
851
                    specific_files, [self.target] + extra_trees,
 
852
                    require_versioned=require_versioned)
1047
853
        if specific_files is not None:
1048
854
            # reparented or added entries must have their parents included
1049
855
            # so that valid deltas can be created. The seen_parents set
1058
864
                                     self.target.extras()
1059
865
                if specific_files is None or
1060
866
                    osutils.is_inside_any(specific_files, p)])
1061
 
            all_unversioned = deque(all_unversioned)
 
867
            all_unversioned = collections.deque(all_unversioned)
1062
868
        else:
1063
 
            all_unversioned = deque()
 
869
            all_unversioned = collections.deque()
1064
870
        to_paths = {}
1065
871
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1066
 
            specific_file_ids=specific_file_ids))
 
872
            specific_files=source_specific_files))
1067
873
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1068
874
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1069
 
            specific_file_ids=specific_file_ids))
 
875
            specific_files=target_specific_files))
1070
876
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1071
877
        entry_count = 0
1072
878
        # the unversioned path lookup only occurs on real trees - where there
1073
879
        # can be extras. So the fake_entry is solely used to look up
1074
880
        # executable it values when execute is not supported.
1075
 
        fake_entry = InventoryFile('unused', 'unused', 'unused')
 
881
        fake_entry = TreeFile()
1076
882
        for target_path, target_entry in to_entries_by_dir:
1077
883
            while (all_unversioned and
1078
884
                all_unversioned[0][0] < target_path.split('/')):
1095
901
            if pb is not None:
1096
902
                pb.update('comparing files', entry_count, num_entries)
1097
903
            if changes or include_unchanged:
1098
 
                if specific_file_ids is not None:
 
904
                if specific_files is not None:
1099
905
                    new_parent_id = result[4][1]
1100
906
                    precise_file_ids.add(new_parent_id)
1101
907
                    changed_file_ids.append(result[0])
1126
932
            if file_id in to_paths:
1127
933
                # already returned
1128
934
                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)
 
935
            to_path = find_previous_path(self.source, self.target, path)
1135
936
            entry_count += 1
1136
937
            if pb is not None:
1137
938
                pb.update('comparing files', entry_count, num_entries)
1148
949
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1149
950
                  name, kind, executable)
1150
951
        changed_file_ids = set(changed_file_ids)
1151
 
        if specific_file_ids is not None:
 
952
        if specific_files is not None:
1152
953
            for result in self._handle_precise_ids(precise_file_ids,
1153
954
                changed_file_ids):
1154
955
                yield result
1155
956
 
1156
 
    def _get_entry(self, tree, file_id):
 
957
    def _get_entry(self, tree, path):
1157
958
        """Get an inventory entry from a tree, with missing entries as None.
1158
959
 
1159
960
        If the tree raises NotImplementedError on accessing .inventory, then
1163
964
        :param tree: The tree to lookup the entry in.
1164
965
        :param file_id: The file_id to lookup.
1165
966
        """
 
967
        # No inventory available.
1166
968
        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
 
969
            iterator = tree.iter_entries_by_dir(specific_files=[path])
 
970
            return next(iterator)[1]
 
971
        except StopIteration:
 
972
            return None
1180
973
 
1181
974
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1182
975
        discarded_changes=None):
1224
1017
                # Examine file_id
1225
1018
                if discarded_changes:
1226
1019
                    result = discarded_changes.get(file_id)
1227
 
                    old_entry = None
 
1020
                    source_entry = None
1228
1021
                else:
1229
1022
                    result = None
1230
1023
                if result is None:
1231
 
                    old_entry = self._get_entry(self.source, file_id)
1232
 
                    new_entry = self._get_entry(self.target, file_id)
 
1024
                    try:
 
1025
                        source_path = self.source.id2path(file_id)
 
1026
                    except errors.NoSuchId:
 
1027
                        source_path = None
 
1028
                        source_entry = None
 
1029
                    else:
 
1030
                        source_entry = self._get_entry(self.source, source_path)
 
1031
                    try:
 
1032
                        target_path = self.target.id2path(file_id)
 
1033
                    except errors.NoSuchId:
 
1034
                        target_path = None
 
1035
                        target_entry = None
 
1036
                    else:
 
1037
                        target_entry = self._get_entry(self.target, target_path)
1233
1038
                    result, changes = self._changes_from_entries(
1234
 
                        old_entry, new_entry)
 
1039
                        source_entry, target_entry, source_path, target_path)
1235
1040
                else:
1236
1041
                    changes = True
1237
1042
                # Get this parents parent to examine.
1239
1044
                precise_file_ids.add(new_parent_id)
1240
1045
                if changes:
1241
1046
                    if (result[6][0] == 'directory' and
1242
 
                        result[6][1] != 'directory'):
 
1047
                            result[6][1] != 'directory'):
1243
1048
                        # This stopped being a directory, the old children have
1244
1049
                        # to be included.
1245
 
                        if old_entry is None:
 
1050
                        if source_entry is None:
1246
1051
                            # 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)
 
1052
                            source_entry = self._get_entry(self.source, result[1][0])
 
1053
                        precise_file_ids.update(
 
1054
                                child.file_id
 
1055
                                for child in self.source.iter_child_entries(result[1][0]))
1250
1056
                    changed_file_ids.add(result[0])
1251
1057
                    yield result
1252
1058
 
 
1059
    def file_content_matches(
 
1060
            self, source_path, target_path,
 
1061
            source_file_id=None, target_file_id=None,
 
1062
            source_stat=None, target_stat=None):
 
1063
        """Check if two files are the same in the source and target trees.
 
1064
 
 
1065
        This only checks that the contents of the files are the same,
 
1066
        it does not touch anything else.
 
1067
 
 
1068
        :param source_path: Path of the file in the source tree
 
1069
        :param target_path: Path of the file in the target tree
 
1070
        :param source_file_id: Optional file id of the file in the source tree
 
1071
        :param target_file_id: Optional file id of the file in the target tree
 
1072
        :param source_stat: Optional stat value of the file in the source tree
 
1073
        :param target_stat: Optional stat value of the file in the target tree
 
1074
        :return: Boolean indicating whether the files have the same contents
 
1075
        """
 
1076
        with self.lock_read():
 
1077
            source_verifier_kind, source_verifier_data = (
 
1078
                    self.source.get_file_verifier(
 
1079
                        source_path, source_file_id, source_stat))
 
1080
            target_verifier_kind, target_verifier_data = (
 
1081
                self.target.get_file_verifier(
 
1082
                    target_path, target_file_id, target_stat))
 
1083
            if source_verifier_kind == target_verifier_kind:
 
1084
                return (source_verifier_data == target_verifier_data)
 
1085
            # Fall back to SHA1 for now
 
1086
            if source_verifier_kind != "SHA1":
 
1087
                source_sha1 = self.source.get_file_sha1(
 
1088
                        source_path, source_file_id, source_stat)
 
1089
            else:
 
1090
                source_sha1 = source_verifier_data
 
1091
            if target_verifier_kind != "SHA1":
 
1092
                target_sha1 = self.target.get_file_sha1(
 
1093
                        target_path, target_file_id, target_stat)
 
1094
            else:
 
1095
                target_sha1 = target_verifier_data
 
1096
            return (source_sha1 == target_sha1)
 
1097
 
 
1098
InterTree.register_optimiser(InterTree)
 
1099
 
1253
1100
 
1254
1101
class MultiWalker(object):
1255
1102
    """Walk multiple trees simultaneously, getting combined results."""
1289
1136
            If has_more is False, path and ie will be None.
1290
1137
        """
1291
1138
        try:
1292
 
            path, ie = iterator.next()
 
1139
            path, ie = next(iterator)
1293
1140
        except StopIteration:
1294
1141
            return False, None, None
1295
1142
        else:
1296
1143
            return True, path, ie
1297
1144
 
1298
1145
    @staticmethod
1299
 
    def _cmp_path_by_dirblock(path1, path2):
 
1146
    def _lt_path_by_dirblock(path1, path2):
1300
1147
        """Compare two paths based on what directory they are in.
1301
1148
 
1302
1149
        This generates a sort order, such that all children of a directory are
1311
1158
        """
1312
1159
        # Shortcut this special case
1313
1160
        if path1 == path2:
1314
 
            return 0
 
1161
            return False
1315
1162
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1316
1163
        # Unicode objects. Consider using encode_utf8() and then using the
1317
1164
        # optimized versions, or maybe writing optimized unicode versions.
1318
 
        if not isinstance(path1, unicode):
 
1165
        if not isinstance(path1, text_type):
1319
1166
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1320
1167
                            % (type(path1), path1))
1321
 
        if not isinstance(path2, unicode):
 
1168
        if not isinstance(path2, text_type):
1322
1169
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1323
1170
                            % (type(path2), path2))
1324
 
        return cmp(MultiWalker._path_to_key(path1),
1325
 
                   MultiWalker._path_to_key(path2))
 
1171
        return (MultiWalker._path_to_key(path1) <
 
1172
                MultiWalker._path_to_key(path2))
1326
1173
 
1327
1174
    @staticmethod
1328
1175
    def _path_to_key(path):
1358
1205
            return (None, None)
1359
1206
        else:
1360
1207
            self._out_of_order_processed.add(file_id)
1361
 
            cur_ie = other_tree.inventory[file_id]
 
1208
            cur_ie = other_tree.root_inventory.get_entry(file_id)
1362
1209
            return (cur_path, cur_ie)
1363
1210
 
1364
1211
    def iter_all(self):
1385
1232
                         for other in self._other_trees]
1386
1233
        other_entries = [self._step_one(walker) for walker in other_walkers]
1387
1234
        # Track extra nodes in the other trees
1388
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
 
1235
        others_extra = [{} for _ in range(len(self._other_trees))]
1389
1236
 
1390
1237
        master_has_more = True
1391
1238
        step_one = self._step_one
1418
1265
                    other_walker = other_walkers[idx]
1419
1266
                    other_extra = others_extra[idx]
1420
1267
                    while (other_has_more and
1421
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
 
1268
                           self._lt_path_by_dirblock(other_path, path)):
1422
1269
                        other_file_id = other_ie.file_id
1423
1270
                        if other_file_id not in out_of_order_processed:
1424
1271
                            other_extra[other_file_id] = (other_path, other_ie)
1465
1312
        #       might ensure better ordering, in case a caller strictly
1466
1313
        #       requires parents before children.
1467
1314
        for idx, other_extra in enumerate(self._others_extra):
1468
 
            others = sorted(other_extra.itervalues(),
 
1315
            others = sorted(viewvalues(other_extra),
1469
1316
                            key=lambda x: self._path_to_key(x[0]))
1470
1317
            for other_path, other_ie in others:
1471
1318
                file_id = other_ie.file_id
1473
1320
                # the lookup_by_file_id will be removing anything processed
1474
1321
                # from the extras cache
1475
1322
                other_extra.pop(file_id)
1476
 
                other_values = [(None, None) for i in xrange(idx)]
 
1323
                other_values = [(None, None)] * idx
1477
1324
                other_values.append((other_path, other_ie))
1478
1325
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1479
1326
                    alt_idx = alt_idx + idx + 1
1482
1329
                    other_values.append(self._lookup_by_file_id(
1483
1330
                                            alt_extra, alt_tree, file_id))
1484
1331
                yield other_path, file_id, None, other_values
 
1332
 
 
1333
 
 
1334
def find_previous_paths(from_tree, to_tree, paths):
 
1335
    """Find previous tree paths.
 
1336
 
 
1337
    :param from_tree: From tree
 
1338
    :param to_tree: To tree
 
1339
    :param paths: Iterable over paths to search for
 
1340
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
 
1341
        None if there is no equivalent path.
 
1342
    """
 
1343
    ret = {}
 
1344
    for path in paths:
 
1345
        ret[path] = find_previous_path(from_tree, to_tree, path)
 
1346
    return ret
 
1347
 
 
1348
 
 
1349
def find_previous_path(from_tree, to_tree, path, file_id=None):
 
1350
    """Find previous tree path.
 
1351
 
 
1352
    :param from_tree: From tree
 
1353
    :param to_tree: To tree
 
1354
    :param path: Path to search for
 
1355
    :return: path in to_tree, or None if there is no equivalent path.
 
1356
    """
 
1357
    if file_id is None:
 
1358
        file_id = from_tree.path2id(path)
 
1359
    if file_id is None:
 
1360
        raise errors.NoSuchFile(path)
 
1361
    try:
 
1362
        return to_tree.id2path(file_id)
 
1363
    except errors.NoSuchId:
 
1364
        return None
 
1365
 
 
1366
 
 
1367
def get_canonical_path(tree, path, normalize):
 
1368
    """Find the canonical path of an item, ignoring case.
 
1369
 
 
1370
    :param tree: Tree to traverse
 
1371
    :param path: Case-insensitive path to look up
 
1372
    :param normalize: Function to normalize a filename for comparison
 
1373
    :return: The canonical path
 
1374
    """
 
1375
    # go walkin...
 
1376
    cur_id = tree.get_root_id()
 
1377
    cur_path = ''
 
1378
    bit_iter = iter(path.split("/"))
 
1379
    for elt in bit_iter:
 
1380
        lelt = normalize(elt)
 
1381
        new_path = None
 
1382
        try:
 
1383
            for child in tree.iter_child_entries(cur_path, cur_id):
 
1384
                try:
 
1385
                    if child.name == elt:
 
1386
                        # if we found an exact match, we can stop now; if
 
1387
                        # we found an approximate match we need to keep
 
1388
                        # searching because there might be an exact match
 
1389
                        # later.
 
1390
                        cur_id = child.file_id
 
1391
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1392
                        break
 
1393
                    elif normalize(child.name) == lelt:
 
1394
                        cur_id = child.file_id
 
1395
                        new_path = osutils.pathjoin(cur_path, child.name)
 
1396
                except errors.NoSuchId:
 
1397
                    # before a change is committed we can see this error...
 
1398
                    continue
 
1399
        except errors.NotADirectory:
 
1400
            pass
 
1401
        if new_path:
 
1402
            cur_path = new_path
 
1403
        else:
 
1404
            # got to the end of this directory and no entries matched.
 
1405
            # Return what matched so far, plus the rest as specified.
 
1406
            cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
1407
            break
 
1408
    return cur_path