/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
21
 
 
22
20
import os
23
 
 
24
 
from .lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import collections
27
 
 
28
 
from breezy import (
 
21
from collections import deque
 
22
 
 
23
import bzrlib
 
24
from bzrlib import (
29
25
    conflicts as _mod_conflicts,
30
26
    debug,
31
27
    delta,
32
28
    filters,
 
29
    osutils,
33
30
    revision as _mod_revision,
34
31
    rules,
35
 
    trace,
36
 
    )
37
 
from breezy.i18n import gettext
38
 
""")
39
 
 
40
 
from . import (
41
 
    errors,
42
 
    lock,
43
 
    osutils,
44
 
    )
45
 
from .inter import InterObject
46
 
from .sixish import (
47
 
    text_type,
48
 
    viewvalues,
49
 
    )
50
 
 
51
 
 
52
 
class FileTimestampUnavailable(errors.BzrError):
53
 
 
54
 
    _fmt = "The filestamp for %(path)s is not available."
55
 
 
56
 
    internal_error = True
57
 
 
58
 
    def __init__(self, path):
59
 
        self.path = path
60
 
 
61
 
 
62
 
class TreeEntry(object):
63
 
    """An entry that implements the minimum interface used by commands.
64
 
    """
65
 
 
66
 
    def __eq__(self, other):
67
 
        # yes, this is ugly, TODO: best practice __eq__ style.
68
 
        return (isinstance(other, TreeEntry)
69
 
                and other.__class__ == self.__class__)
70
 
 
71
 
    def kind_character(self):
72
 
        return "???"
73
 
 
74
 
 
75
 
class TreeDirectory(TreeEntry):
76
 
    """See TreeEntry. This is a directory in a working tree."""
77
 
 
78
 
    def kind_character(self):
79
 
        return "/"
80
 
 
81
 
 
82
 
class TreeFile(TreeEntry):
83
 
    """See TreeEntry. This is a regular file in a working tree."""
84
 
 
85
 
    def kind_character(self):
86
 
        return ''
87
 
 
88
 
 
89
 
class TreeLink(TreeEntry):
90
 
    """See TreeEntry. This is a symlink in a working tree."""
91
 
 
92
 
    def kind_character(self):
93
 
        return ''
94
 
 
95
 
 
96
 
class TreeReference(TreeEntry):
97
 
    """See TreeEntry. This is a reference to a nested tree in a working tree."""
98
 
 
99
 
    def kind_character(self):
100
 
        return '/'
 
32
    )
 
33
from bzrlib.decorators import needs_read_lock
 
34
from bzrlib.errors import BzrError, NoSuchId
 
35
from bzrlib import errors
 
36
from bzrlib.inventory import InventoryFile
 
37
from bzrlib.inter import InterObject
 
38
from bzrlib.osutils import fingerprint_file
 
39
from bzrlib.symbol_versioning import deprecated_function, deprecated_in
 
40
from bzrlib.trace import note
101
41
 
102
42
 
103
43
class Tree(object):
109
49
 
110
50
    * `RevisionTree` is a tree as recorded at some point in the past.
111
51
 
 
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
 
112
59
    Trees can be compared, etc, regardless of whether they are working
113
60
    trees or versioned trees.
114
61
    """
115
62
 
116
 
    def supports_rename_tracking(self):
117
 
        """Whether this tree supports rename tracking.
118
 
 
119
 
        This defaults to True, but some implementations may want to override
120
 
        it.
121
 
        """
122
 
        return True
123
 
 
124
 
    def has_versioned_directories(self):
125
 
        """Whether this tree can contain explicitly versioned directories.
126
 
 
127
 
        This defaults to True, but some implementations may want to override
128
 
        it.
129
 
        """
130
 
        return True
131
 
 
132
63
    def changes_from(self, other, want_unchanged=False, specific_files=None,
133
64
        extra_trees=None, require_versioned=False, include_root=False,
134
65
        want_unversioned=False):
174
105
    def conflicts(self):
175
106
        """Get a list of the conflicts in the tree.
176
107
 
177
 
        Each conflict is an instance of breezy.conflicts.Conflict.
 
108
        Each conflict is an instance of bzrlib.conflicts.Conflict.
178
109
        """
179
110
        return _mod_conflicts.ConflictList()
180
111
 
195
126
        """True if the tree has given filename."""
196
127
        raise NotImplementedError(self.has_filename)
197
128
 
 
129
    def has_id(self, file_id):
 
130
        return self.inventory.has_id(file_id)
 
131
 
 
132
    def __contains__(self, file_id):
 
133
        return self.has_id(file_id)
 
134
 
 
135
    def has_or_had_id(self, file_id):
 
136
        return self.inventory.has_id(file_id)
 
137
 
198
138
    def is_ignored(self, filename):
199
139
        """Check whether the filename is ignored by this tree.
200
140
 
203
143
        """
204
144
        return False
205
145
 
 
146
    def __iter__(self):
 
147
        return iter(self.inventory)
 
148
 
206
149
    def all_file_ids(self):
207
150
        """Iterate through all file ids, including ids for missing files."""
208
 
        raise NotImplementedError(self.all_file_ids)
209
 
 
210
 
    def all_versioned_paths(self):
211
 
        """Iterate through all paths, including paths for missing files."""
212
 
        raise NotImplementedError(self.all_versioned_paths)
 
151
        return set(self.inventory)
213
152
 
214
153
    def id2path(self, file_id):
215
154
        """Return the path for a file id.
216
155
 
217
156
        :raises NoSuchId:
218
157
        """
219
 
        raise NotImplementedError(self.id2path)
220
 
 
221
 
    def iter_entries_by_dir(self, specific_files=None):
 
158
        return self.inventory.id2path(file_id)
 
159
 
 
160
    def is_control_filename(self, filename):
 
161
        """True if filename is the name of a control file in this tree.
 
162
 
 
163
        :param filename: A filename within the tree. This is a relative path
 
164
        from the root of this tree.
 
165
 
 
166
        This is true IF and ONLY IF the filename is part of the meta data
 
167
        that bzr controls in this tree. I.E. a random .bzr directory placed
 
168
        on disk will not be a control file for this tree.
 
169
        """
 
170
        return self.bzrdir.is_control_filename(filename)
 
171
 
 
172
    @needs_read_lock
 
173
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
222
174
        """Walk the tree in 'by_dir' order.
223
175
 
224
176
        This will yield each entry in the tree as a (path, entry) tuple.
240
192
             g
241
193
 
242
194
        The yield order (ignoring root) would be::
243
 
 
244
195
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
245
 
        """
246
 
        raise NotImplementedError(self.iter_entries_by_dir)
247
 
 
248
 
    def iter_child_entries(self, path, file_id=None):
249
 
        """Iterate over the children of a directory or tree reference.
250
 
 
251
 
        :param path: Path of the directory
252
 
        :param file_id: Optional file id of the directory/tree-reference
253
 
        :raise NoSuchId: When the file_id does not exist
254
 
        :return: Iterator over entries in the directory
255
 
        """
256
 
        raise NotImplementedError(self.iter_child_entries)
257
 
 
258
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
259
 
        """List all files in this tree.
260
 
 
261
 
        :param include_root: Whether to include the entry for the tree root
262
 
        :param from_dir: Directory under which to list files
263
 
        :param recursive: Whether to list files recursively
264
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
265
 
            inventory entry)
266
 
        """
267
 
        raise NotImplementedError(self.list_files)
 
196
 
 
197
        :param yield_parents: If True, yield the parents from the root leading
 
198
            down to specific_file_ids that have been requested. This has no
 
199
            impact if specific_file_ids is None.
 
200
        """
 
201
        return self.inventory.iter_entries_by_dir(
 
202
            specific_file_ids=specific_file_ids, yield_parents=yield_parents)
268
203
 
269
204
    def iter_references(self):
270
205
        if self.supports_tree_reference():
272
207
                if entry.kind == 'tree-reference':
273
208
                    yield path, entry.file_id
274
209
 
275
 
    def kind(self, path, file_id=None):
 
210
    def kind(self, file_id):
276
211
        raise NotImplementedError("Tree subclass %s must implement kind"
277
212
            % self.__class__.__name__)
278
213
 
279
 
    def stored_kind(self, path, file_id=None):
 
214
    def stored_kind(self, file_id):
280
215
        """File kind stored for this file_id.
281
216
 
282
217
        May not match kind on disk for working trees.  Always available
283
218
        for versioned files, even when the file itself is missing.
284
219
        """
285
 
        return self.kind(path, file_id)
 
220
        return self.kind(file_id)
286
221
 
287
222
    def path_content_summary(self, path):
288
223
        """Get a summary of the information about path.
302
237
        """
303
238
        raise NotImplementedError(self.path_content_summary)
304
239
 
305
 
    def get_reference_revision(self, path, file_id=None):
 
240
    def get_reference_revision(self, file_id, path=None):
306
241
        raise NotImplementedError("Tree subclass %s must implement "
307
242
                                  "get_reference_revision"
308
243
            % self.__class__.__name__)
318
253
        """
319
254
        raise NotImplementedError(self._comparison_data)
320
255
 
321
 
    def get_file(self, path, file_id=None):
 
256
    def _file_size(self, entry, stat_value):
 
257
        raise NotImplementedError(self._file_size)
 
258
 
 
259
    def _get_inventory(self):
 
260
        return self._inventory
 
261
 
 
262
    def get_file(self, file_id, path=None):
322
263
        """Return a file object for the file file_id in the tree.
323
264
 
324
265
        If both file_id and path are defined, it is implementation defined as
326
267
        """
327
268
        raise NotImplementedError(self.get_file)
328
269
 
329
 
    def get_file_with_stat(self, path, file_id=None):
 
270
    def get_file_with_stat(self, file_id, path=None):
330
271
        """Get a file handle and stat object for file_id.
331
272
 
332
273
        The default implementation returns (self.get_file, None) for backwards
333
274
        compatibility.
334
275
 
335
 
        :param path: The path of the file.
336
 
        :param file_id: The file id to read, if it is known.
 
276
        :param file_id: The file id to read.
 
277
        :param path: The path of the file, if it is known.
337
278
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
338
279
            no stat facility, or need for a stat cache feedback during commit,
339
280
            it may return None for the second element of the tuple.
340
281
        """
341
 
        return (self.get_file(path, file_id), None)
 
282
        return (self.get_file(file_id, path), None)
342
283
 
343
 
    def get_file_text(self, path, file_id=None):
 
284
    def get_file_text(self, file_id, path=None):
344
285
        """Return the byte content of a file.
345
286
 
 
287
        :param file_id: The file_id of the file.
346
288
        :param path: The path of the file.
347
 
        :param file_id: The file_id of the file.
348
 
 
349
289
        If both file_id and path are supplied, an implementation may use
350
290
        either one.
351
 
 
352
 
        :returns: A single byte string for the whole file.
353
291
        """
354
 
        with self.get_file(path, file_id) as my_file:
 
292
        my_file = self.get_file(file_id, path)
 
293
        try:
355
294
            return my_file.read()
 
295
        finally:
 
296
            my_file.close()
356
297
 
357
 
    def get_file_lines(self, path, file_id=None):
 
298
    def get_file_lines(self, file_id, path=None):
358
299
        """Return the content of a file, as lines.
359
300
 
 
301
        :param file_id: The file_id of the file.
360
302
        :param path: The path of the file.
361
 
        :param file_id: The file_id of the file.
362
 
 
363
303
        If both file_id and path are supplied, an implementation may use
364
304
        either one.
365
305
        """
366
 
        return osutils.split_lines(self.get_file_text(path, file_id))
367
 
 
368
 
    def get_file_verifier(self, path, file_id=None, stat_value=None):
369
 
        """Return a verifier for a file.
370
 
 
371
 
        The default implementation returns a sha1.
372
 
 
373
 
        :param file_id: The handle for this file.
374
 
        :param path: The path that this file can be found at.
375
 
            These must point to the same object.
376
 
        :param stat_value: Optional stat value for the object
377
 
        :return: Tuple with verifier name and verifier data
378
 
        """
379
 
        return ("SHA1", self.get_file_sha1(path, file_id,
380
 
            stat_value=stat_value))
381
 
 
382
 
    def get_file_sha1(self, path, file_id=None, stat_value=None):
383
 
        """Return the SHA1 file for a file.
384
 
 
385
 
        :note: callers should use get_file_verifier instead
386
 
            where possible, as the underlying repository implementation may
387
 
            have quicker access to a non-sha1 verifier.
388
 
 
389
 
        :param path: The path that this file can be found at.
390
 
        :param file_id: The handle for this file.
391
 
            These must point to the same object.
392
 
        :param stat_value: Optional stat value for the object
393
 
        """
394
 
        raise NotImplementedError(self.get_file_sha1)
395
 
 
396
 
    def get_file_mtime(self, path, file_id=None):
 
306
        return osutils.split_lines(self.get_file_text(file_id, path))
 
307
 
 
308
    def get_file_mtime(self, file_id, path=None):
397
309
        """Return the modification time for a file.
398
310
 
 
311
        :param file_id: The handle for this file.
399
312
        :param path: The path that this file can be found at.
400
 
        :param file_id: The handle for this file.
401
313
            These must point to the same object.
402
314
        """
403
315
        raise NotImplementedError(self.get_file_mtime)
404
316
 
405
 
    def get_file_size(self, path, file_id=None):
 
317
    def get_file_size(self, file_id):
406
318
        """Return the size of a file in bytes.
407
319
 
408
320
        This applies only to regular files.  If invoked on directories or
411
323
        """
412
324
        raise NotImplementedError(self.get_file_size)
413
325
 
414
 
    def is_executable(self, path, file_id=None):
415
 
        """Check if a file is executable.
416
 
 
417
 
        :param path: The path that this file can be found at.
418
 
        :param file_id: The handle for this file.
419
 
            These must point to the same object.
420
 
        """
421
 
        raise NotImplementedError(self.is_executable)
 
326
    def get_file_by_path(self, path):
 
327
        return self.get_file(self._inventory.path2id(path), path)
422
328
 
423
329
    def iter_files_bytes(self, desired_files):
424
330
        """Iterate through file contents.
436
342
        this implementation, it is a tuple containing a single bytestring with
437
343
        the complete text of the file.
438
344
 
439
 
        :param desired_files: a list of (path, identifier) pairs
 
345
        :param desired_files: a list of (file_id, identifier) pairs
440
346
        """
441
 
        for path, identifier in desired_files:
 
347
        for file_id, identifier in desired_files:
442
348
            # We wrap the string in a tuple so that we can return an iterable
443
349
            # of bytestrings.  (Technically, a bytestring is also an iterable
444
350
            # of bytestrings, but iterating through each character is not
445
351
            # performant.)
446
 
            cur_file = (self.get_file_text(path),)
 
352
            cur_file = (self.get_file_text(file_id),)
447
353
            yield identifier, cur_file
448
354
 
449
 
    def get_symlink_target(self, path, file_id=None):
 
355
    def get_symlink_target(self, file_id):
450
356
        """Get the target for a given file_id.
451
357
 
452
358
        It is assumed that the caller already knows that file_id is referencing
453
359
        a symlink.
454
360
        :param file_id: Handle for the symlink entry.
455
 
        :param path: The path of the file.
456
 
        If both file_id and path are supplied, an implementation may use
457
 
        either one.
458
361
        :return: The path the symlink points to.
459
362
        """
460
363
        raise NotImplementedError(self.get_symlink_target)
461
364
 
 
365
    def get_canonical_inventory_paths(self, paths):
 
366
        """Like get_canonical_inventory_path() but works on multiple items.
 
367
 
 
368
        :param paths: A sequence of paths relative to the root of the tree.
 
369
        :return: A list of paths, with each item the corresponding input path
 
370
        adjusted to account for existing elements that match case
 
371
        insensitively.
 
372
        """
 
373
        return list(self._yield_canonical_inventory_paths(paths))
 
374
 
 
375
    def get_canonical_inventory_path(self, path):
 
376
        """Returns the first inventory item that case-insensitively matches path.
 
377
 
 
378
        If a path matches exactly, it is returned. If no path matches exactly
 
379
        but more than one path matches case-insensitively, it is implementation
 
380
        defined which is returned.
 
381
 
 
382
        If no path matches case-insensitively, the input path is returned, but
 
383
        with as many path entries that do exist changed to their canonical
 
384
        form.
 
385
 
 
386
        If you need to resolve many names from the same tree, you should
 
387
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
 
388
 
 
389
        :param path: A paths relative to the root of the tree.
 
390
        :return: The input path adjusted to account for existing elements
 
391
        that match case insensitively.
 
392
        """
 
393
        return self._yield_canonical_inventory_paths([path]).next()
 
394
 
 
395
    def _yield_canonical_inventory_paths(self, paths):
 
396
        for path in paths:
 
397
            # First, if the path as specified exists exactly, just use it.
 
398
            if self.path2id(path) is not None:
 
399
                yield path
 
400
                continue
 
401
            # go walkin...
 
402
            cur_id = self.get_root_id()
 
403
            cur_path = ''
 
404
            bit_iter = iter(path.split("/"))
 
405
            for elt in bit_iter:
 
406
                lelt = elt.lower()
 
407
                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
 
462
443
    def get_root_id(self):
463
444
        """Return the file_id for the root of this tree."""
464
445
        raise NotImplementedError(self.get_root_id)
465
446
 
466
 
    def annotate_iter(self, path, file_id=None,
 
447
    def annotate_iter(self, file_id,
467
448
                      default_revision=_mod_revision.CURRENT_REVISION):
468
449
        """Return an iterator of revision_id, line tuples.
469
450
 
477
458
        """
478
459
        raise NotImplementedError(self.annotate_iter)
479
460
 
 
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
 
480
498
    def _iter_parent_trees(self):
481
499
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
482
500
        for revision_id in self.get_parent_ids():
485
503
            except errors.NoSuchRevisionInTree:
486
504
                yield self.repository.revision_tree(revision_id)
487
505
 
 
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
488
556
    def path2id(self, path):
489
557
        """Return the id for path in this tree."""
490
 
        raise NotImplementedError(self.path2id)
491
 
 
492
 
    def is_versioned(self, path):
493
 
        """Check whether path is versioned.
494
 
 
495
 
        :param path: Path to check
496
 
        :return: boolean
497
 
        """
498
 
        return self.path2id(path) is not None
499
 
 
500
 
    def find_related_paths_across_trees(self, paths, trees=[],
501
 
            require_versioned=True):
502
 
        """Find related paths in tree corresponding to specified filenames in any
503
 
        of `lookup_trees`.
504
 
 
505
 
        All matches in all trees will be used, and all children of matched
506
 
        directories will be used.
507
 
 
508
 
        :param paths: The filenames to find related paths for (if None, returns
509
 
            None)
510
 
        :param trees: The trees to find file_ids within
511
 
        :param require_versioned: if true, all specified filenames must occur in
512
 
            at least one tree.
513
 
        :return: a set of paths for the specified filenames and their children
514
 
            in `tree`
515
 
        """
516
 
        raise NotImplementedError(self.find_related_paths_across_trees)
 
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
517
583
 
518
584
    def lock_read(self):
519
 
        """Lock this tree for multiple read only operations.
520
 
 
521
 
        :return: A breezy.lock.LogicalLockResult.
522
 
        """
523
 
        return lock.LogicalLockResult(self.unlock)
 
585
        pass
524
586
 
525
587
    def revision_tree(self, revision_id):
526
588
        """Obtain a revision tree for the revision revision_id.
555
617
        # NB: we specifically *don't* call self.has_filename, because for
556
618
        # WorkingTrees that can indicate files that exist on disk but that
557
619
        # are not versioned.
558
 
        return set(p for p in paths if not self.is_versioned(p))
 
620
        pred = self.inventory.has_filename
 
621
        return set((p for p in paths if not pred(p)))
559
622
 
560
623
    def walkdirs(self, prefix=""):
561
624
        """Walk the contents of this tree from path down.
593
656
    def supports_content_filtering(self):
594
657
        return False
595
658
 
596
 
    def _content_filter_stack(self, path=None):
 
659
    def _content_filter_stack(self, path=None, file_id=None):
597
660
        """The stack of content filters for a path if filtering is supported.
598
661
 
599
662
        Readers will be applied in first-to-last order.
602
665
 
603
666
        :param path: path relative to the root of the tree
604
667
            or None if unknown
 
668
        :param file_id: file_id or None if unknown
605
669
        :return: the list of filters - [] if there are none
606
670
        """
607
671
        filter_pref_names = filters._get_registered_names()
608
672
        if len(filter_pref_names) == 0:
609
673
            return []
610
 
        prefs = next(self.iter_search_rules([path], filter_pref_names))
 
674
        if path is None:
 
675
            path = self.id2path(file_id)
 
676
        prefs = self.iter_search_rules([path], filter_pref_names).next()
611
677
        stk = filters._get_filter_stack_for(prefs)
612
678
        if 'filters' in debug.debug_flags:
613
 
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk))
 
679
            note("*** %s content-filter: %s => %r" % (path,prefs,stk))
614
680
        return stk
615
681
 
616
682
    def _content_filter_stack_provider(self):
623
689
        """
624
690
        if self.supports_content_filtering():
625
691
            return lambda path, file_id: \
626
 
                    self._content_filter_stack(path)
 
692
                    self._content_filter_stack(path, file_id)
627
693
        else:
628
694
            return None
629
695
 
654
720
        searcher = default_searcher
655
721
        return searcher
656
722
 
657
 
    def archive(self, format, name, root='', subdir=None,
658
 
                force_mtime=None):
659
 
        """Create an archive of this tree.
660
 
 
661
 
        :param format: Format name (e.g. 'tar')
662
 
        :param name: target file name
663
 
        :param root: Root directory name (or None)
664
 
        :param subdir: Subdirectory to export (or None)
665
 
        :return: Iterator over archive chunks
666
 
        """
667
 
        from .archive import create_archive
668
 
        with self.lock_read():
669
 
            return create_archive(format, self, name, root,
670
 
                    subdir, force_mtime=force_mtime)
671
 
 
672
 
    @classmethod
673
 
    def versionable_kind(cls, kind):
674
 
        """Check if this tree support versioning a specific file kind."""
675
 
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
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
676
859
 
677
860
 
678
861
class InterTree(InterObject):
681
864
    Its instances have methods like 'compare' and contain references to the
682
865
    source and target trees these operations are to be carried out on.
683
866
 
684
 
    Clients of breezy should not need to use InterTree directly, rather they
 
867
    Clients of bzrlib should not need to use InterTree directly, rather they
685
868
    should use the convenience methods on Tree such as 'Tree.compare()' which
686
869
    will pass through to InterTree as appropriate.
687
870
    """
694
877
 
695
878
    _optimisers = []
696
879
 
697
 
    @classmethod
698
 
    def is_compatible(kls, source, target):
699
 
        # The default implementation is naive and uses the public API, so
700
 
        # it works for all trees.
701
 
        return True
702
 
 
703
 
    def _changes_from_entries(self, source_entry, target_entry, source_path,
704
 
                              target_path):
 
880
    def _changes_from_entries(self, source_entry, target_entry,
 
881
        source_path=None, target_path=None):
705
882
        """Generate a iter_changes tuple between source_entry and target_entry.
706
883
 
707
884
        :param source_entry: An inventory entry from self.source, or None.
708
885
        :param target_entry: An inventory entry from self.target, or None.
709
 
        :param source_path: The path of source_entry.
710
 
        :param target_path: The path of target_entry.
 
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.
711
890
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
712
891
            item 1 is True if there are any changes in the result tuple.
713
892
        """
721
900
            source_versioned = True
722
901
            source_name = source_entry.name
723
902
            source_parent = source_entry.parent_id
 
903
            if source_path is None:
 
904
                source_path = self.source.id2path(file_id)
724
905
            source_kind, source_executable, source_stat = \
725
906
                self.source._comparison_data(source_entry, source_path)
726
907
        else:
733
914
            target_versioned = True
734
915
            target_name = target_entry.name
735
916
            target_parent = target_entry.parent_id
 
917
            if target_path is None:
 
918
                target_path = self.target.id2path(file_id)
736
919
            target_kind, target_executable, target_stat = \
737
920
                self.target._comparison_data(target_entry, target_path)
738
921
        else:
747
930
        if source_kind != target_kind:
748
931
            changed_content = True
749
932
        elif source_kind == 'file':
750
 
            if not self.file_content_matches(
751
 
                    source_path, target_path,
752
 
                    file_id, file_id, source_stat, target_stat):
 
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)):
753
935
                changed_content = True
754
936
        elif source_kind == 'symlink':
755
 
            if (self.source.get_symlink_target(source_path, file_id) !=
756
 
                self.target.get_symlink_target(target_path, file_id)):
 
937
            if (self.source.get_symlink_target(file_id) !=
 
938
                self.target.get_symlink_target(file_id)):
757
939
                changed_content = True
758
 
        elif source_kind == 'tree-reference':
759
 
            if (self.source.get_reference_revision(source_path, file_id)
760
 
                != self.target.get_reference_revision(target_path, file_id)):
 
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)):
761
947
                    changed_content = True
762
948
        parent = (source_parent, target_parent)
763
949
        name = (source_name, target_name)
771
957
        return (file_id, (source_path, target_path), changed_content,
772
958
                versioned, parent, name, kind, executable), changes
773
959
 
 
960
    @needs_read_lock
774
961
    def compare(self, want_unchanged=False, specific_files=None,
775
962
        extra_trees=None, require_versioned=False, include_root=False,
776
963
        want_unversioned=False):
793
980
        trees = (self.source,)
794
981
        if extra_trees is not None:
795
982
            trees = trees + tuple(extra_trees)
796
 
        with self.lock_read():
797
 
            return delta._compare_trees(self.source, self.target, want_unchanged,
798
 
                specific_files, include_root, extra_trees=extra_trees,
799
 
                require_versioned=require_versioned,
800
 
                want_unversioned=want_unversioned)
 
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)
801
999
 
802
1000
    def iter_changes(self, include_unchanged=False,
803
1001
                      specific_files=None, pb=None, extra_trees=[],
835
1033
            output. An unversioned file is defined as one with (False, False)
836
1034
            for the versioned pair.
837
1035
        """
838
 
        if not extra_trees:
839
 
             extra_trees = []
840
 
        else:
841
 
             extra_trees = list(extra_trees)
 
1036
        lookup_trees = [self.source]
 
1037
        if extra_trees:
 
1038
             lookup_trees.extend(extra_trees)
842
1039
        # The ids of items we need to examine to insure delta consistency.
843
1040
        precise_file_ids = set()
844
1041
        changed_file_ids = []
845
1042
        if specific_files == []:
846
 
            target_specific_files = []
847
 
            source_specific_files = []
 
1043
            specific_file_ids = []
848
1044
        else:
849
 
            target_specific_files = self.target.find_related_paths_across_trees(
850
 
                    specific_files, [self.source] + extra_trees,
851
 
                    require_versioned=require_versioned)
852
 
            source_specific_files = self.source.find_related_paths_across_trees(
853
 
                    specific_files, [self.target] + extra_trees,
854
 
                    require_versioned=require_versioned)
 
1045
            specific_file_ids = self.target.paths2ids(specific_files,
 
1046
                lookup_trees, require_versioned=require_versioned)
855
1047
        if specific_files is not None:
856
1048
            # reparented or added entries must have their parents included
857
1049
            # so that valid deltas can be created. The seen_parents set
866
1058
                                     self.target.extras()
867
1059
                if specific_files is None or
868
1060
                    osutils.is_inside_any(specific_files, p)])
869
 
            all_unversioned = collections.deque(all_unversioned)
 
1061
            all_unversioned = deque(all_unversioned)
870
1062
        else:
871
 
            all_unversioned = collections.deque()
 
1063
            all_unversioned = deque()
872
1064
        to_paths = {}
873
1065
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
874
 
            specific_files=source_specific_files))
 
1066
            specific_file_ids=specific_file_ids))
875
1067
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
876
1068
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
877
 
            specific_files=target_specific_files))
 
1069
            specific_file_ids=specific_file_ids))
878
1070
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
879
1071
        entry_count = 0
880
1072
        # the unversioned path lookup only occurs on real trees - where there
881
1073
        # can be extras. So the fake_entry is solely used to look up
882
1074
        # executable it values when execute is not supported.
883
 
        fake_entry = TreeFile()
 
1075
        fake_entry = InventoryFile('unused', 'unused', 'unused')
884
1076
        for target_path, target_entry in to_entries_by_dir:
885
1077
            while (all_unversioned and
886
1078
                all_unversioned[0][0] < target_path.split('/')):
903
1095
            if pb is not None:
904
1096
                pb.update('comparing files', entry_count, num_entries)
905
1097
            if changes or include_unchanged:
906
 
                if specific_files is not None:
 
1098
                if specific_file_ids is not None:
907
1099
                    new_parent_id = result[4][1]
908
1100
                    precise_file_ids.add(new_parent_id)
909
1101
                    changed_file_ids.append(result[0])
934
1126
            if file_id in to_paths:
935
1127
                # already returned
936
1128
                continue
937
 
            to_path = find_previous_path(self.source, self.target, path)
 
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)
938
1135
            entry_count += 1
939
1136
            if pb is not None:
940
1137
                pb.update('comparing files', entry_count, num_entries)
951
1148
            yield(file_id, (path, to_path), changed_content, versioned, parent,
952
1149
                  name, kind, executable)
953
1150
        changed_file_ids = set(changed_file_ids)
954
 
        if specific_files is not None:
 
1151
        if specific_file_ids is not None:
955
1152
            for result in self._handle_precise_ids(precise_file_ids,
956
1153
                changed_file_ids):
957
1154
                yield result
958
1155
 
959
 
    def _get_entry(self, tree, path):
 
1156
    def _get_entry(self, tree, file_id):
960
1157
        """Get an inventory entry from a tree, with missing entries as None.
961
1158
 
962
1159
        If the tree raises NotImplementedError on accessing .inventory, then
966
1163
        :param tree: The tree to lookup the entry in.
967
1164
        :param file_id: The file_id to lookup.
968
1165
        """
969
 
        # No inventory available.
970
1166
        try:
971
 
            iterator = tree.iter_entries_by_dir(specific_files=[path])
972
 
            return next(iterator)[1]
973
 
        except StopIteration:
974
 
            return None
 
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
975
1180
 
976
1181
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
977
1182
        discarded_changes=None):
1019
1224
                # Examine file_id
1020
1225
                if discarded_changes:
1021
1226
                    result = discarded_changes.get(file_id)
1022
 
                    source_entry = None
 
1227
                    old_entry = None
1023
1228
                else:
1024
1229
                    result = None
1025
1230
                if result is None:
1026
 
                    try:
1027
 
                        source_path = self.source.id2path(file_id)
1028
 
                    except errors.NoSuchId:
1029
 
                        source_path = None
1030
 
                        source_entry = None
1031
 
                    else:
1032
 
                        source_entry = self._get_entry(self.source, source_path)
1033
 
                    try:
1034
 
                        target_path = self.target.id2path(file_id)
1035
 
                    except errors.NoSuchId:
1036
 
                        target_path = None
1037
 
                        target_entry = None
1038
 
                    else:
1039
 
                        target_entry = self._get_entry(self.target, target_path)
 
1231
                    old_entry = self._get_entry(self.source, file_id)
 
1232
                    new_entry = self._get_entry(self.target, file_id)
1040
1233
                    result, changes = self._changes_from_entries(
1041
 
                        source_entry, target_entry, source_path, target_path)
 
1234
                        old_entry, new_entry)
1042
1235
                else:
1043
1236
                    changes = True
1044
1237
                # Get this parents parent to examine.
1046
1239
                precise_file_ids.add(new_parent_id)
1047
1240
                if changes:
1048
1241
                    if (result[6][0] == 'directory' and
1049
 
                            result[6][1] != 'directory'):
 
1242
                        result[6][1] != 'directory'):
1050
1243
                        # This stopped being a directory, the old children have
1051
1244
                        # to be included.
1052
 
                        if source_entry is None:
 
1245
                        if old_entry is None:
1053
1246
                            # Reusing a discarded change.
1054
 
                            source_entry = self._get_entry(self.source, result[1][0])
1055
 
                        precise_file_ids.update(
1056
 
                                child.file_id
1057
 
                                for child in self.source.iter_child_entries(result[1][0]))
 
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)
1058
1250
                    changed_file_ids.add(result[0])
1059
1251
                    yield result
1060
1252
 
1061
 
    def file_content_matches(
1062
 
            self, source_path, target_path,
1063
 
            source_file_id=None, target_file_id=None,
1064
 
            source_stat=None, target_stat=None):
1065
 
        """Check if two files are the same in the source and target trees.
1066
 
 
1067
 
        This only checks that the contents of the files are the same,
1068
 
        it does not touch anything else.
1069
 
 
1070
 
        :param source_path: Path of the file in the source tree
1071
 
        :param target_path: Path of the file in the target tree
1072
 
        :param source_file_id: Optional file id of the file in the source tree
1073
 
        :param target_file_id: Optional file id of the file in the target tree
1074
 
        :param source_stat: Optional stat value of the file in the source tree
1075
 
        :param target_stat: Optional stat value of the file in the target tree
1076
 
        :return: Boolean indicating whether the files have the same contents
1077
 
        """
1078
 
        with self.lock_read():
1079
 
            source_verifier_kind, source_verifier_data = (
1080
 
                    self.source.get_file_verifier(
1081
 
                        source_path, source_file_id, source_stat))
1082
 
            target_verifier_kind, target_verifier_data = (
1083
 
                self.target.get_file_verifier(
1084
 
                    target_path, target_file_id, target_stat))
1085
 
            if source_verifier_kind == target_verifier_kind:
1086
 
                return (source_verifier_data == target_verifier_data)
1087
 
            # Fall back to SHA1 for now
1088
 
            if source_verifier_kind != "SHA1":
1089
 
                source_sha1 = self.source.get_file_sha1(
1090
 
                        source_path, source_file_id, source_stat)
1091
 
            else:
1092
 
                source_sha1 = source_verifier_data
1093
 
            if target_verifier_kind != "SHA1":
1094
 
                target_sha1 = self.target.get_file_sha1(
1095
 
                        target_path, target_file_id, target_stat)
1096
 
            else:
1097
 
                target_sha1 = target_verifier_data
1098
 
            return (source_sha1 == target_sha1)
1099
 
 
1100
 
InterTree.register_optimiser(InterTree)
1101
 
 
1102
1253
 
1103
1254
class MultiWalker(object):
1104
1255
    """Walk multiple trees simultaneously, getting combined results."""
1138
1289
            If has_more is False, path and ie will be None.
1139
1290
        """
1140
1291
        try:
1141
 
            path, ie = next(iterator)
 
1292
            path, ie = iterator.next()
1142
1293
        except StopIteration:
1143
1294
            return False, None, None
1144
1295
        else:
1164
1315
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1165
1316
        # Unicode objects. Consider using encode_utf8() and then using the
1166
1317
        # optimized versions, or maybe writing optimized unicode versions.
1167
 
        if not isinstance(path1, text_type):
 
1318
        if not isinstance(path1, unicode):
1168
1319
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1169
1320
                            % (type(path1), path1))
1170
 
        if not isinstance(path2, text_type):
 
1321
        if not isinstance(path2, unicode):
1171
1322
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1172
1323
                            % (type(path2), path2))
1173
1324
        return cmp(MultiWalker._path_to_key(path1),
1207
1358
            return (None, None)
1208
1359
        else:
1209
1360
            self._out_of_order_processed.add(file_id)
1210
 
            cur_ie = other_tree.root_inventory.get_entry(file_id)
 
1361
            cur_ie = other_tree.inventory[file_id]
1211
1362
            return (cur_path, cur_ie)
1212
1363
 
1213
1364
    def iter_all(self):
1234
1385
                         for other in self._other_trees]
1235
1386
        other_entries = [self._step_one(walker) for walker in other_walkers]
1236
1387
        # Track extra nodes in the other trees
1237
 
        others_extra = [{} for _ in range(len(self._other_trees))]
 
1388
        others_extra = [{} for i in xrange(len(self._other_trees))]
1238
1389
 
1239
1390
        master_has_more = True
1240
1391
        step_one = self._step_one
1314
1465
        #       might ensure better ordering, in case a caller strictly
1315
1466
        #       requires parents before children.
1316
1467
        for idx, other_extra in enumerate(self._others_extra):
1317
 
            others = sorted(viewvalues(other_extra),
 
1468
            others = sorted(other_extra.itervalues(),
1318
1469
                            key=lambda x: self._path_to_key(x[0]))
1319
1470
            for other_path, other_ie in others:
1320
1471
                file_id = other_ie.file_id
1322
1473
                # the lookup_by_file_id will be removing anything processed
1323
1474
                # from the extras cache
1324
1475
                other_extra.pop(file_id)
1325
 
                other_values = [(None, None)] * idx
 
1476
                other_values = [(None, None) for i in xrange(idx)]
1326
1477
                other_values.append((other_path, other_ie))
1327
1478
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1328
1479
                    alt_idx = alt_idx + idx + 1
1331
1482
                    other_values.append(self._lookup_by_file_id(
1332
1483
                                            alt_extra, alt_tree, file_id))
1333
1484
                yield other_path, file_id, None, other_values
1334
 
 
1335
 
 
1336
 
def find_previous_paths(from_tree, to_tree, paths):
1337
 
    """Find previous tree paths.
1338
 
 
1339
 
    :param from_tree: From tree
1340
 
    :param to_tree: To tree
1341
 
    :param paths: Iterable over paths to search for
1342
 
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
1343
 
        None if there is no equivalent path.
1344
 
    """
1345
 
    ret = {}
1346
 
    for path in paths:
1347
 
        ret[path] = find_previous_path(from_tree, to_tree, path)
1348
 
    return ret
1349
 
 
1350
 
 
1351
 
def find_previous_path(from_tree, to_tree, path, file_id=None):
1352
 
    """Find previous tree path.
1353
 
 
1354
 
    :param from_tree: From tree
1355
 
    :param to_tree: To tree
1356
 
    :param path: Path to search for
1357
 
    :return: path in to_tree, or None if there is no equivalent path.
1358
 
    """
1359
 
    if file_id is None:
1360
 
        file_id = from_tree.path2id(path)
1361
 
    if file_id is None:
1362
 
        raise errors.NoSuchFile(path)
1363
 
    try:
1364
 
        return to_tree.id2path(file_id)
1365
 
    except errors.NoSuchId:
1366
 
        return None