/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: Canonical.com Patch Queue Manager
  • Date: 2010-04-06 06:59:03 UTC
  • mfrom: (5051.5.1 subunit)
  • Revision ID: pqm@pqm.ubuntu.com-20100406065903-y9dxgwmog1pmw7dz
Use subunit when running tests in PQM.

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