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