/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/tree.py

  • Committer: Breezy landing bot
  • Author(s): Colin Watson
  • Date: 2020-11-16 21:47:08 UTC
  • mfrom: (7521.1.1 remove-lp-workaround)
  • Revision ID: breezy.the.bot@gmail.com-20201116214708-jos209mgxi41oy15
Remove breezy.git workaround for bazaar.launchpad.net.

Merged from https://code.launchpad.net/~cjwatson/brz/remove-lp-workaround/+merge/393710

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/tree.py
17
17
"""Tree classes, representing directory at point in time.
18
18
"""
19
19
 
20
 
from __future__ import absolute_import
21
 
 
22
 
import os
23
 
 
24
 
from bzrlib.lazy_import import lazy_import
25
 
lazy_import(globals(), """
26
 
import collections
27
 
 
28
 
from bzrlib import (
29
 
    conflicts as _mod_conflicts,
30
 
    debug,
31
 
    delta,
 
20
from . import (
32
21
    errors,
33
 
    filters,
34
 
    inventory,
 
22
    lock,
35
23
    osutils,
36
24
    revision as _mod_revision,
37
 
    rules,
38
25
    trace,
39
26
    )
40
 
from bzrlib.i18n import gettext
41
 
""")
42
 
 
43
 
from bzrlib.decorators import needs_read_lock
44
 
from bzrlib.inter import InterObject
45
 
from bzrlib.symbol_versioning import (
46
 
    deprecated_in,
47
 
    deprecated_method,
48
 
    )
 
27
from .inter import InterObject
 
28
 
 
29
 
 
30
class FileTimestampUnavailable(errors.BzrError):
 
31
 
 
32
    _fmt = "The filestamp for %(path)s is not available."
 
33
 
 
34
    internal_error = True
 
35
 
 
36
    def __init__(self, path):
 
37
        self.path = path
 
38
 
 
39
 
 
40
class MissingNestedTree(errors.BzrError):
 
41
 
 
42
    _fmt = "The nested tree for %(path)s can not be resolved."""
 
43
 
 
44
    def __init__(self, path):
 
45
        self.path = path
 
46
 
 
47
 
 
48
class TreeEntry(object):
 
49
    """An entry that implements the minimum interface used by commands.
 
50
    """
 
51
 
 
52
    __slots__ = []
 
53
 
 
54
    def __eq__(self, other):
 
55
        # yes, this is ugly, TODO: best practice __eq__ style.
 
56
        return (isinstance(other, TreeEntry)
 
57
                and other.__class__ == self.__class__)
 
58
 
 
59
    kind = None
 
60
 
 
61
    def kind_character(self):
 
62
        return "???"
 
63
 
 
64
    def is_unmodified(self, other):
 
65
        """Does this entry reference the same entry?
 
66
 
 
67
        This is mostly the same as __eq__, but returns False
 
68
        for entries without enough information (i.e. revision is None)
 
69
        """
 
70
        return False
 
71
 
 
72
 
 
73
class TreeDirectory(TreeEntry):
 
74
    """See TreeEntry. This is a directory in a working tree."""
 
75
 
 
76
    __slots__ = []
 
77
 
 
78
    kind = 'directory'
 
79
 
 
80
    def kind_character(self):
 
81
        return "/"
 
82
 
 
83
 
 
84
class TreeFile(TreeEntry):
 
85
    """See TreeEntry. This is a regular file in a working tree."""
 
86
 
 
87
    __slots__ = []
 
88
 
 
89
    kind = 'file'
 
90
 
 
91
    def kind_character(self):
 
92
        return ''
 
93
 
 
94
 
 
95
class TreeLink(TreeEntry):
 
96
    """See TreeEntry. This is a symlink in a working tree."""
 
97
 
 
98
    __slots__ = []
 
99
 
 
100
    kind = 'symlink'
 
101
 
 
102
    def kind_character(self):
 
103
        return ''
 
104
 
 
105
 
 
106
class TreeReference(TreeEntry):
 
107
    """See TreeEntry. This is a reference to a nested tree in a working tree."""
 
108
 
 
109
    __slots__ = []
 
110
 
 
111
    kind = 'tree-reference'
 
112
 
 
113
    def kind_character(self):
 
114
        return '+'
 
115
 
 
116
 
 
117
class TreeChange(object):
 
118
    """Describes the changes between the same item in two different trees."""
 
119
 
 
120
    __slots__ = ['path', 'changed_content', 'versioned',
 
121
                 'name', 'kind', 'executable', 'copied']
 
122
 
 
123
    def __init__(self, path, changed_content, versioned,
 
124
                 name, kind, executable, copied=False):
 
125
        self.path = path
 
126
        self.changed_content = changed_content
 
127
        self.versioned = versioned
 
128
        self.name = name
 
129
        self.kind = kind
 
130
        self.executable = executable
 
131
        self.copied = copied
 
132
 
 
133
    def __repr__(self):
 
134
        return "%s%r" % (self.__class__.__name__, self._as_tuple())
 
135
 
 
136
    def _as_tuple(self):
 
137
        return (self.path, self.changed_content, self.versioned,
 
138
                self.name, self.kind, self.executable, self.copied)
 
139
 
 
140
    def __eq__(self, other):
 
141
        if isinstance(other, TreeChange):
 
142
            return self._as_tuple() == other._as_tuple()
 
143
        if isinstance(other, tuple):
 
144
            return self._as_tuple() == other
 
145
        return False
 
146
 
 
147
    def __lt__(self, other):
 
148
        return self._as_tuple() < other._as_tuple()
 
149
 
 
150
    def meta_modified(self):
 
151
        if self.versioned == (True, True):
 
152
            return (self.executable[0] != self.executable[1])
 
153
        return False
 
154
 
 
155
    @property
 
156
    def renamed(self):
 
157
        return (
 
158
            not self.copied and
 
159
            None not in self.name and
 
160
            self.path[0] != self.path[1])
 
161
 
 
162
    def is_reparented(self):
 
163
        return os.path.dirname(self.path[0]) != os.path.dirname(self.path[1])
 
164
 
 
165
    def discard_new(self):
 
166
        return self.__class__(
 
167
            (self.path[0], None), self.changed_content,
 
168
            (self.versioned[0], None),
 
169
            (self.name[0], None), (self.kind[0], None),
 
170
            (self.executable[0], None),
 
171
            copied=False)
49
172
 
50
173
 
51
174
class Tree(object):
61
184
    trees or versioned trees.
62
185
    """
63
186
 
 
187
    def supports_rename_tracking(self):
 
188
        """Whether this tree supports rename tracking.
 
189
 
 
190
        This defaults to True, but some implementations may want to override
 
191
        it.
 
192
        """
 
193
        return True
 
194
 
64
195
    def has_versioned_directories(self):
65
196
        """Whether this tree can contain explicitly versioned directories.
66
197
 
69
200
        """
70
201
        return True
71
202
 
 
203
    def supports_symlinks(self):
 
204
        """Does this tree support symbolic links?
 
205
        """
 
206
        return osutils.has_symlinks()
 
207
 
72
208
    def changes_from(self, other, want_unchanged=False, specific_files=None,
73
 
        extra_trees=None, require_versioned=False, include_root=False,
74
 
        want_unversioned=False):
 
209
                     extra_trees=None, require_versioned=False, include_root=False,
 
210
                     want_unversioned=False):
75
211
        """Return a TreeDelta of the changes from other to this tree.
76
212
 
77
213
        :param other: A tree to compare with.
82
218
        :param want_unchanged: An optional boolean requesting the inclusion of
83
219
            unchanged entries in the result.
84
220
        :param extra_trees: An optional list of additional trees to use when
85
 
            mapping the contents of specific_files (paths) to file_ids.
 
221
            mapping the contents of specific_files (paths) to their identities.
86
222
        :param require_versioned: An optional boolean (defaults to False). When
87
223
            supplied and True all the 'specific_files' must be versioned, or
88
224
            a PathsNotVersionedError will be thrown.
109
245
        """See InterTree.iter_changes"""
110
246
        intertree = InterTree.get(from_tree, self)
111
247
        return intertree.iter_changes(include_unchanged, specific_files, pb,
112
 
            extra_trees, require_versioned, want_unversioned=want_unversioned)
 
248
                                      extra_trees, require_versioned,
 
249
                                      want_unversioned=want_unversioned)
113
250
 
114
251
    def conflicts(self):
115
252
        """Get a list of the conflicts in the tree.
116
253
 
117
 
        Each conflict is an instance of bzrlib.conflicts.Conflict.
 
254
        Each conflict is an instance of breezy.conflicts.Conflict.
118
255
        """
 
256
        from . import conflicts as _mod_conflicts
119
257
        return _mod_conflicts.ConflictList()
120
258
 
121
259
    def extras(self):
135
273
        """True if the tree has given filename."""
136
274
        raise NotImplementedError(self.has_filename)
137
275
 
138
 
    def has_id(self, file_id):
139
 
        raise NotImplementedError(self.has_id)
140
 
 
141
 
    @deprecated_method(deprecated_in((2, 4, 0)))
142
 
    def __contains__(self, file_id):
143
 
        return self.has_id(file_id)
144
 
 
145
 
    def has_or_had_id(self, file_id):
146
 
        raise NotImplementedError(self.has_or_had_id)
147
 
 
148
276
    def is_ignored(self, filename):
149
277
        """Check whether the filename is ignored by this tree.
150
278
 
157
285
        """Iterate through all file ids, including ids for missing files."""
158
286
        raise NotImplementedError(self.all_file_ids)
159
287
 
160
 
    def id2path(self, file_id):
 
288
    def all_versioned_paths(self):
 
289
        """Iterate through all paths, including paths for missing files."""
 
290
        raise NotImplementedError(self.all_versioned_paths)
 
291
 
 
292
    def id2path(self, file_id, recurse='down'):
161
293
        """Return the path for a file id.
162
294
 
163
295
        :raises NoSuchId:
164
296
        """
165
297
        raise NotImplementedError(self.id2path)
166
298
 
167
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
 
299
    def iter_entries_by_dir(self, specific_files=None, recurse_nested=False):
168
300
        """Walk the tree in 'by_dir' order.
169
301
 
170
302
        This will yield each entry in the tree as a (path, entry) tuple.
189
321
 
190
322
          a, f, a/b, a/d, a/b/c, a/d/e, f/g
191
323
 
192
 
        :param yield_parents: If True, yield the parents from the root leading
193
 
            down to specific_file_ids that have been requested. This has no
194
 
            impact if specific_file_ids is None.
 
324
        If recurse_nested is enabled then nested trees are included as if
 
325
        they were a part of the tree. If is disabled then TreeReference
 
326
        objects (without any children) are yielded.
195
327
        """
196
328
        raise NotImplementedError(self.iter_entries_by_dir)
197
329
 
198
 
    def iter_child_entries(self, file_id, path=None):
 
330
    def iter_child_entries(self, path):
199
331
        """Iterate over the children of a directory or tree reference.
200
332
 
201
 
        :param file_id: File id of the directory/tree-reference
202
 
        :param path: Optional path of the directory
203
 
        :raise NoSuchId: When the file_id does not exist
 
333
        :param path: Path of the directory
 
334
        :raise NoSuchFile: When the path does not exist
204
335
        :return: Iterator over entries in the directory
205
336
        """
206
337
        raise NotImplementedError(self.iter_child_entries)
207
338
 
208
 
    def list_files(self, include_root=False, from_dir=None, recursive=True):
 
339
    def list_files(self, include_root=False, from_dir=None, recursive=True,
 
340
                   recurse_nested=False):
209
341
        """List all files in this tree.
210
342
 
211
343
        :param include_root: Whether to include the entry for the tree root
212
344
        :param from_dir: Directory under which to list files
213
345
        :param recursive: Whether to list files recursively
214
 
        :return: iterator over tuples of (path, versioned, kind, file_id,
215
 
            inventory entry)
 
346
        :param recurse_nested: enter nested trees
 
347
        :return: iterator over tuples of
 
348
            (path, versioned, kind, inventory entry)
216
349
        """
217
350
        raise NotImplementedError(self.list_files)
218
351
 
220
353
        if self.supports_tree_reference():
221
354
            for path, entry in self.iter_entries_by_dir():
222
355
                if entry.kind == 'tree-reference':
223
 
                    yield path, entry.file_id
224
 
 
225
 
    def kind(self, file_id):
 
356
                    yield path
 
357
 
 
358
    def get_containing_nested_tree(self, path):
 
359
        """Find the nested tree that contains a path.
 
360
 
 
361
        :return: tuple with (nested tree and path inside the nested tree)
 
362
        """
 
363
        for nested_path in self.iter_references():
 
364
            nested_path += '/'
 
365
            if path.startswith(nested_path):
 
366
                nested_tree = self.get_nested_tree(nested_path)
 
367
                return nested_tree, path[len(nested_path):]
 
368
        else:
 
369
            return None, None
 
370
 
 
371
    def get_nested_tree(self, path):
 
372
        """Open the nested tree at the specified path.
 
373
 
 
374
        :param path: Path from which to resolve tree reference.
 
375
        :return: A Tree object for the nested tree
 
376
        :raise MissingNestedTree: If the nested tree can not be resolved
 
377
        """
 
378
        raise NotImplementedError(self.get_nested_tree)
 
379
 
 
380
    def kind(self, path):
226
381
        raise NotImplementedError("Tree subclass %s must implement kind"
227
 
            % self.__class__.__name__)
 
382
                                  % self.__class__.__name__)
228
383
 
229
 
    def stored_kind(self, file_id):
230
 
        """File kind stored for this file_id.
 
384
    def stored_kind(self, path):
 
385
        """File kind stored for this path.
231
386
 
232
387
        May not match kind on disk for working trees.  Always available
233
388
        for versioned files, even when the file itself is missing.
234
389
        """
235
 
        return self.kind(file_id)
 
390
        return self.kind(path)
236
391
 
237
392
    def path_content_summary(self, path):
238
393
        """Get a summary of the information about path.
243
398
        :param path: A relative path within the tree.
244
399
        :return: A tuple containing kind, size, exec, sha1-or-link.
245
400
            Kind is always present (see tree.kind()).
246
 
            size is present if kind is file and the size of the 
 
401
            size is present if kind is file and the size of the
247
402
                canonical form can be cheaply determined, None otherwise.
248
403
            exec is None unless kind is file and the platform supports the 'x'
249
404
                bit.
252
407
        """
253
408
        raise NotImplementedError(self.path_content_summary)
254
409
 
255
 
    def get_reference_revision(self, file_id, path=None):
 
410
    def get_reference_revision(self, path, branch=None):
256
411
        raise NotImplementedError("Tree subclass %s must implement "
257
412
                                  "get_reference_revision"
258
 
            % self.__class__.__name__)
 
413
                                  % self.__class__.__name__)
259
414
 
260
415
    def _comparison_data(self, entry, path):
261
416
        """Return a tuple of kind, executable, stat_value for a file.
268
423
        """
269
424
        raise NotImplementedError(self._comparison_data)
270
425
 
271
 
    def _file_size(self, entry, stat_value):
272
 
        raise NotImplementedError(self._file_size)
273
 
 
274
 
    def get_file(self, file_id, path=None):
275
 
        """Return a file object for the file file_id in the tree.
276
 
 
277
 
        If both file_id and path are defined, it is implementation defined as
278
 
        to which one is used.
 
426
    def get_file(self, path):
 
427
        """Return a file object for the file path in the tree.
279
428
        """
280
429
        raise NotImplementedError(self.get_file)
281
430
 
282
 
    def get_file_with_stat(self, file_id, path=None):
283
 
        """Get a file handle and stat object for file_id.
 
431
    def get_file_with_stat(self, path):
 
432
        """Get a file handle and stat object for path.
284
433
 
285
434
        The default implementation returns (self.get_file, None) for backwards
286
435
        compatibility.
287
436
 
288
 
        :param file_id: The file id to read.
289
 
        :param path: The path of the file, if it is known.
 
437
        :param path: The path of the file.
290
438
        :return: A tuple (file_handle, stat_value_or_None). If the tree has
291
439
            no stat facility, or need for a stat cache feedback during commit,
292
440
            it may return None for the second element of the tuple.
293
441
        """
294
 
        return (self.get_file(file_id, path), None)
 
442
        return (self.get_file(path), None)
295
443
 
296
 
    def get_file_text(self, file_id, path=None):
 
444
    def get_file_text(self, path):
297
445
        """Return the byte content of a file.
298
446
 
299
 
        :param file_id: The file_id of the file.
300
447
        :param path: The path of the file.
301
448
 
302
 
        If both file_id and path are supplied, an implementation may use
303
 
        either one.
304
 
 
305
449
        :returns: A single byte string for the whole file.
306
450
        """
307
 
        my_file = self.get_file(file_id, path)
308
 
        try:
 
451
        with self.get_file(path) as my_file:
309
452
            return my_file.read()
310
 
        finally:
311
 
            my_file.close()
312
453
 
313
 
    def get_file_lines(self, file_id, path=None):
 
454
    def get_file_lines(self, path):
314
455
        """Return the content of a file, as lines.
315
456
 
316
 
        :param file_id: The file_id of the file.
317
457
        :param path: The path of the file.
318
 
 
319
 
        If both file_id and path are supplied, an implementation may use
320
 
        either one.
321
458
        """
322
 
        return osutils.split_lines(self.get_file_text(file_id, path))
 
459
        return osutils.split_lines(self.get_file_text(path))
323
460
 
324
 
    def get_file_verifier(self, file_id, path=None, stat_value=None):
 
461
    def get_file_verifier(self, path, stat_value=None):
325
462
        """Return a verifier for a file.
326
463
 
327
464
        The default implementation returns a sha1.
328
465
 
329
 
        :param file_id: The handle for this file.
330
466
        :param path: The path that this file can be found at.
331
467
            These must point to the same object.
332
468
        :param stat_value: Optional stat value for the object
333
469
        :return: Tuple with verifier name and verifier data
334
470
        """
335
 
        return ("SHA1", self.get_file_sha1(file_id, path=path,
336
 
            stat_value=stat_value))
 
471
        return ("SHA1", self.get_file_sha1(path, stat_value=stat_value))
337
472
 
338
 
    def get_file_sha1(self, file_id, path=None, stat_value=None):
 
473
    def get_file_sha1(self, path, stat_value=None):
339
474
        """Return the SHA1 file for a file.
340
475
 
341
476
        :note: callers should use get_file_verifier instead
342
477
            where possible, as the underlying repository implementation may
343
478
            have quicker access to a non-sha1 verifier.
344
479
 
345
 
        :param file_id: The handle for this file.
346
480
        :param path: The path that this file can be found at.
347
 
            These must point to the same object.
348
481
        :param stat_value: Optional stat value for the object
349
482
        """
350
483
        raise NotImplementedError(self.get_file_sha1)
351
484
 
352
 
    def get_file_mtime(self, file_id, path=None):
 
485
    def get_file_mtime(self, path):
353
486
        """Return the modification time for a file.
354
487
 
355
 
        :param file_id: The handle for this file.
356
488
        :param path: The path that this file can be found at.
357
 
            These must point to the same object.
358
489
        """
359
490
        raise NotImplementedError(self.get_file_mtime)
360
491
 
361
 
    def get_file_size(self, file_id):
 
492
    def get_file_size(self, path):
362
493
        """Return the size of a file in bytes.
363
494
 
364
495
        This applies only to regular files.  If invoked on directories or
365
496
        symlinks, it will return None.
366
 
        :param file_id: The file-id of the file
367
497
        """
368
498
        raise NotImplementedError(self.get_file_size)
369
499
 
370
 
    def is_executable(self, file_id, path=None):
 
500
    def is_executable(self, path):
371
501
        """Check if a file is executable.
372
502
 
373
 
        :param file_id: The handle for this file.
374
503
        :param path: The path that this file can be found at.
375
 
            These must point to the same object.
376
504
        """
377
505
        raise NotImplementedError(self.is_executable)
378
506
 
392
520
        this implementation, it is a tuple containing a single bytestring with
393
521
        the complete text of the file.
394
522
 
395
 
        :param desired_files: a list of (file_id, identifier) pairs
 
523
        :param desired_files: a list of (path, identifier) pairs
396
524
        """
397
 
        for file_id, identifier in desired_files:
 
525
        for path, identifier in desired_files:
398
526
            # We wrap the string in a tuple so that we can return an iterable
399
527
            # of bytestrings.  (Technically, a bytestring is also an iterable
400
528
            # of bytestrings, but iterating through each character is not
401
529
            # performant.)
402
 
            cur_file = (self.get_file_text(file_id),)
 
530
            cur_file = (self.get_file_text(path),)
403
531
            yield identifier, cur_file
404
532
 
405
 
    def get_symlink_target(self, file_id, path=None):
406
 
        """Get the target for a given file_id.
 
533
    def get_symlink_target(self, path):
 
534
        """Get the target for a given path.
407
535
 
408
 
        It is assumed that the caller already knows that file_id is referencing
 
536
        It is assumed that the caller already knows that path is referencing
409
537
        a symlink.
410
 
        :param file_id: Handle for the symlink entry.
411
538
        :param path: The path of the file.
412
 
        If both file_id and path are supplied, an implementation may use
413
 
        either one.
414
539
        :return: The path the symlink points to.
415
540
        """
416
541
        raise NotImplementedError(self.get_symlink_target)
417
542
 
418
 
    def get_root_id(self):
419
 
        """Return the file_id for the root of this tree."""
420
 
        raise NotImplementedError(self.get_root_id)
421
 
 
422
 
    def annotate_iter(self, file_id,
 
543
    def annotate_iter(self, path,
423
544
                      default_revision=_mod_revision.CURRENT_REVISION):
424
545
        """Return an iterator of revision_id, line tuples.
425
546
 
426
547
        For working trees (and mutable trees in general), the special
427
548
        revision_id 'current:' will be used for lines that are new in this
428
549
        tree, e.g. uncommitted changes.
429
 
        :param file_id: The file to produce an annotated version from
 
550
        :param path: The file to produce an annotated version from
430
551
        :param default_revision: For lines that don't match a basis, mark them
431
552
            with this revision id. Not all implementations will make use of
432
553
            this value.
433
554
        """
434
555
        raise NotImplementedError(self.annotate_iter)
435
556
 
436
 
    def _get_plan_merge_data(self, file_id, other, base):
437
 
        from bzrlib import versionedfile
438
 
        vf = versionedfile._PlanMergeVersionedFile(file_id)
439
 
        last_revision_a = self._get_file_revision(file_id, vf, 'this:')
440
 
        last_revision_b = other._get_file_revision(file_id, vf, 'other:')
441
 
        if base is None:
442
 
            last_revision_base = None
443
 
        else:
444
 
            last_revision_base = base._get_file_revision(file_id, vf, 'base:')
445
 
        return vf, last_revision_a, last_revision_b, last_revision_base
446
 
 
447
 
    def plan_file_merge(self, file_id, other, base=None):
448
 
        """Generate a merge plan based on annotations.
449
 
 
450
 
        If the file contains uncommitted changes in this tree, they will be
451
 
        attributed to the 'current:' pseudo-revision.  If the file contains
452
 
        uncommitted changes in the other tree, they will be assigned to the
453
 
        'other:' pseudo-revision.
454
 
        """
455
 
        data = self._get_plan_merge_data(file_id, other, base)
456
 
        vf, last_revision_a, last_revision_b, last_revision_base = data
457
 
        return vf.plan_merge(last_revision_a, last_revision_b,
458
 
                             last_revision_base)
459
 
 
460
 
    def plan_file_lca_merge(self, file_id, other, base=None):
461
 
        """Generate a merge plan based lca-newness.
462
 
 
463
 
        If the file contains uncommitted changes in this tree, they will be
464
 
        attributed to the 'current:' pseudo-revision.  If the file contains
465
 
        uncommitted changes in the other tree, they will be assigned to the
466
 
        'other:' pseudo-revision.
467
 
        """
468
 
        data = self._get_plan_merge_data(file_id, other, base)
469
 
        vf, last_revision_a, last_revision_b, last_revision_base = data
470
 
        return vf.plan_lca_merge(last_revision_a, last_revision_b,
471
 
                                 last_revision_base)
472
 
 
473
 
    def _iter_parent_trees(self):
474
 
        """Iterate through parent trees, defaulting to Tree.revision_tree."""
475
 
        for revision_id in self.get_parent_ids():
476
 
            try:
477
 
                yield self.revision_tree(revision_id)
478
 
            except errors.NoSuchRevisionInTree:
479
 
                yield self.repository.revision_tree(revision_id)
480
 
 
481
 
    def _get_file_revision(self, file_id, vf, tree_revision):
482
 
        """Ensure that file_id, tree_revision is in vf to plan the merge."""
483
 
 
484
 
        if getattr(self, '_repository', None) is None:
485
 
            last_revision = tree_revision
486
 
            parent_keys = [(file_id, t.get_file_revision(file_id)) for t in
487
 
                self._iter_parent_trees()]
488
 
            vf.add_lines((file_id, last_revision), parent_keys,
489
 
                         self.get_file_lines(file_id))
490
 
            repo = self.branch.repository
491
 
            base_vf = repo.texts
492
 
        else:
493
 
            last_revision = self.get_file_revision(file_id)
494
 
            base_vf = self._repository.texts
495
 
        if base_vf not in vf.fallback_versionedfiles:
496
 
            vf.fallback_versionedfiles.append(base_vf)
497
 
        return last_revision
498
 
 
499
 
    def _check_retrieved(self, ie, f):
500
 
        if not __debug__:
501
 
            return
502
 
        fp = osutils.fingerprint_file(f)
503
 
        f.seek(0)
504
 
 
505
 
        if ie.text_size is not None:
506
 
            if ie.text_size != fp['size']:
507
 
                raise errors.BzrError(
508
 
                        "mismatched size for file %r in %r" %
509
 
                        (ie.file_id, self._store),
510
 
                        ["inventory expects %d bytes" % ie.text_size,
511
 
                         "file is actually %d bytes" % fp['size'],
512
 
                         "store is probably damaged/corrupt"])
513
 
 
514
 
        if ie.text_sha1 != fp['sha1']:
515
 
            raise errors.BzrError("wrong SHA-1 for file %r in %r" %
516
 
                    (ie.file_id, self._store),
517
 
                    ["inventory expects %s" % ie.text_sha1,
518
 
                     "file is actually %s" % fp['sha1'],
519
 
                     "store is probably damaged/corrupt"])
520
 
 
521
557
    def path2id(self, path):
522
558
        """Return the id for path in this tree."""
523
559
        raise NotImplementedError(self.path2id)
524
560
 
525
 
    def paths2ids(self, paths, trees=[], require_versioned=True):
526
 
        """Return all the ids that can be reached by walking from paths.
527
 
 
528
 
        Each path is looked up in this tree and any extras provided in
529
 
        trees, and this is repeated recursively: the children in an extra tree
530
 
        of a directory that has been renamed under a provided path in this tree
531
 
        are all returned, even if none exist under a provided path in this
532
 
        tree, and vice versa.
533
 
 
534
 
        :param paths: An iterable of paths to start converting to ids from.
535
 
            Alternatively, if paths is None, no ids should be calculated and None
536
 
            will be returned. This is offered to make calling the api unconditional
537
 
            for code that *might* take a list of files.
538
 
        :param trees: Additional trees to consider.
539
 
        :param require_versioned: If False, do not raise NotVersionedError if
540
 
            an element of paths is not versioned in this tree and all of trees.
541
 
        """
542
 
        return find_ids_across_trees(paths, [self] + list(trees), require_versioned)
543
 
 
544
 
    def iter_children(self, file_id):
545
 
        """Iterate over the file ids of the children of an entry.
546
 
 
547
 
        :param file_id: File id of the entry
548
 
        :return: Iterator over child file ids.
549
 
        """
550
 
        raise NotImplementedError(self.iter_children)
 
561
    def is_versioned(self, path):
 
562
        """Check whether path is versioned.
 
563
 
 
564
        :param path: Path to check
 
565
        :return: boolean
 
566
        """
 
567
        return self.path2id(path) is not None
 
568
 
 
569
    def find_related_paths_across_trees(self, paths, trees=[],
 
570
                                        require_versioned=True):
 
571
        """Find related paths in tree corresponding to specified filenames in any
 
572
        of `lookup_trees`.
 
573
 
 
574
        All matches in all trees will be used, and all children of matched
 
575
        directories will be used.
 
576
 
 
577
        :param paths: The filenames to find related paths for (if None, returns
 
578
            None)
 
579
        :param trees: The trees to find file_ids within
 
580
        :param require_versioned: if true, all specified filenames must occur in
 
581
            at least one tree.
 
582
        :return: a set of paths for the specified filenames and their children
 
583
            in `tree`
 
584
        """
 
585
        raise NotImplementedError(self.find_related_paths_across_trees)
551
586
 
552
587
    def lock_read(self):
553
588
        """Lock this tree for multiple read only operations.
554
589
 
555
 
        :return: A bzrlib.lock.LogicalLockResult.
 
590
        :return: A breezy.lock.LogicalLockResult.
556
591
        """
557
 
        pass
 
592
        return lock.LogicalLockResult(self.unlock)
558
593
 
559
594
    def revision_tree(self, revision_id):
560
595
        """Obtain a revision tree for the revision revision_id.
586
621
 
587
622
        :return: set of paths.
588
623
        """
589
 
        raise NotImplementedError(self.filter_unversioned_files)
 
624
        # NB: we specifically *don't* call self.has_filename, because for
 
625
        # WorkingTrees that can indicate files that exist on disk but that
 
626
        # are not versioned.
 
627
        return set(p for p in paths if not self.is_versioned(p))
590
628
 
591
629
    def walkdirs(self, prefix=""):
592
630
        """Walk the contents of this tree from path down.
596
634
        list to exclude some directories, they are then not descended into.
597
635
 
598
636
        The data yielded is of the form:
599
 
        ((directory-relpath, directory-path-from-root, directory-fileid),
600
 
        [(relpath, basename, kind, lstat, path_from_tree_root, file_id,
 
637
        (directory-relpath,
 
638
        [(relpath, basename, kind, lstat, path_from_tree_root,
601
639
          versioned_kind), ...]),
602
 
         - directory-relpath is the containing dirs relpath from prefix
603
640
         - directory-path-from-root is the containing dirs path from /
604
 
         - directory-fileid is the id of the directory if it is versioned.
605
641
         - relpath is the relative path within the subtree being walked.
606
642
         - basename is the basename
607
643
         - kind is the kind of the file now. If unknonwn then the file is not
609
645
           versioned_kind.
610
646
         - lstat is the stat data *if* the file was statted.
611
647
         - path_from_tree_root is the path from the root of the tree.
612
 
         - file_id is the file_id if the entry is versioned.
613
648
         - versioned_kind is the kind of the file as last recorded in the
614
649
           versioning system. If 'unknown' the file is not versioned.
615
650
        One of 'kind' and 'versioned_kind' must not be 'unknown'.
624
659
    def supports_content_filtering(self):
625
660
        return False
626
661
 
627
 
    def _content_filter_stack(self, path=None, file_id=None):
 
662
    def _content_filter_stack(self, path=None):
628
663
        """The stack of content filters for a path if filtering is supported.
629
664
 
630
665
        Readers will be applied in first-to-last order.
633
668
 
634
669
        :param path: path relative to the root of the tree
635
670
            or None if unknown
636
 
        :param file_id: file_id or None if unknown
637
671
        :return: the list of filters - [] if there are none
638
672
        """
 
673
        from . import debug, filters
639
674
        filter_pref_names = filters._get_registered_names()
640
675
        if len(filter_pref_names) == 0:
641
676
            return []
642
 
        if path is None:
643
 
            path = self.id2path(file_id)
644
 
        prefs = self.iter_search_rules([path], filter_pref_names).next()
 
677
        prefs = next(self.iter_search_rules([path], filter_pref_names))
645
678
        stk = filters._get_filter_stack_for(prefs)
646
679
        if 'filters' in debug.debug_flags:
647
 
            trace.note(gettext("*** {0} content-filter: {1} => {2!r}").format(path,prefs,stk))
 
680
            trace.note("*** {0} content-filter: {1} => {2!r}").format(path, prefs, stk)
648
681
        return stk
649
682
 
650
683
    def _content_filter_stack_provider(self):
656
689
        :return: None if content filtering is not supported by this tree.
657
690
        """
658
691
        if self.supports_content_filtering():
659
 
            return lambda path, file_id: \
660
 
                    self._content_filter_stack(path, file_id)
 
692
            return self._content_filter_stack
661
693
        else:
662
694
            return None
663
695
 
664
696
    def iter_search_rules(self, path_names, pref_names=None,
665
 
        _default_searcher=None):
 
697
                          _default_searcher=None):
666
698
        """Find the preferences for filenames in a tree.
667
699
 
668
700
        :param path_names: an iterable of paths to find attributes for.
672
704
        :return: an iterator of tuple sequences, one per path-name.
673
705
          See _RulesSearcher.get_items for details on the tuple sequence.
674
706
        """
 
707
        from . import rules
675
708
        if _default_searcher is None:
676
709
            _default_searcher = rules._per_user_searcher
677
710
        searcher = self._get_rules_searcher(_default_searcher)
688
721
        searcher = default_searcher
689
722
        return searcher
690
723
 
691
 
 
692
 
class InventoryTree(Tree):
693
 
    """A tree that relies on an inventory for its metadata.
694
 
 
695
 
    Trees contain an `Inventory` object, and also know how to retrieve
696
 
    file texts mentioned in the inventory, either from a working
697
 
    directory or from a store.
698
 
 
699
 
    It is possible for trees to contain files that are not described
700
 
    in their inventory or vice versa; for this use `filenames()`.
701
 
 
702
 
    Subclasses should set the _inventory attribute, which is considered
703
 
    private to external API users.
704
 
    """
705
 
 
706
 
    def get_canonical_inventory_paths(self, paths):
707
 
        """Like get_canonical_inventory_path() but works on multiple items.
708
 
 
709
 
        :param paths: A sequence of paths relative to the root of the tree.
710
 
        :return: A list of paths, with each item the corresponding input path
711
 
        adjusted to account for existing elements that match case
712
 
        insensitively.
713
 
        """
714
 
        return list(self._yield_canonical_inventory_paths(paths))
715
 
 
716
 
    def get_canonical_inventory_path(self, path):
717
 
        """Returns the first inventory item that case-insensitively matches path.
718
 
 
719
 
        If a path matches exactly, it is returned. If no path matches exactly
720
 
        but more than one path matches case-insensitively, it is implementation
721
 
        defined which is returned.
722
 
 
723
 
        If no path matches case-insensitively, the input path is returned, but
724
 
        with as many path entries that do exist changed to their canonical
725
 
        form.
726
 
 
727
 
        If you need to resolve many names from the same tree, you should
728
 
        use get_canonical_inventory_paths() to avoid O(N) behaviour.
729
 
 
730
 
        :param path: A paths relative to the root of the tree.
731
 
        :return: The input path adjusted to account for existing elements
732
 
        that match case insensitively.
733
 
        """
734
 
        return self._yield_canonical_inventory_paths([path]).next()
735
 
 
736
 
    def _yield_canonical_inventory_paths(self, paths):
737
 
        for path in paths:
738
 
            # First, if the path as specified exists exactly, just use it.
739
 
            if self.path2id(path) is not None:
740
 
                yield path
741
 
                continue
742
 
            # go walkin...
743
 
            cur_id = self.get_root_id()
744
 
            cur_path = ''
745
 
            bit_iter = iter(path.split("/"))
746
 
            for elt in bit_iter:
747
 
                lelt = elt.lower()
748
 
                new_path = None
749
 
                for child in self.iter_children(cur_id):
750
 
                    try:
751
 
                        # XXX: it seem like if the child is known to be in the
752
 
                        # tree, we shouldn't need to go from its id back to
753
 
                        # its path -- mbp 2010-02-11
754
 
                        #
755
 
                        # XXX: it seems like we could be more efficient
756
 
                        # by just directly looking up the original name and
757
 
                        # only then searching all children; also by not
758
 
                        # chopping paths so much. -- mbp 2010-02-11
759
 
                        child_base = os.path.basename(self.id2path(child))
760
 
                        if (child_base == elt):
761
 
                            # if we found an exact match, we can stop now; if
762
 
                            # we found an approximate match we need to keep
763
 
                            # searching because there might be an exact match
764
 
                            # later.  
765
 
                            cur_id = child
766
 
                            new_path = osutils.pathjoin(cur_path, child_base)
767
 
                            break
768
 
                        elif child_base.lower() == lelt:
769
 
                            cur_id = child
770
 
                            new_path = osutils.pathjoin(cur_path, child_base)
771
 
                    except errors.NoSuchId:
772
 
                        # before a change is committed we can see this error...
773
 
                        continue
774
 
                if new_path:
775
 
                    cur_path = new_path
776
 
                else:
777
 
                    # got to the end of this directory and no entries matched.
778
 
                    # Return what matched so far, plus the rest as specified.
779
 
                    cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
780
 
                    break
781
 
            yield cur_path
782
 
        # all done.
783
 
 
784
 
    @deprecated_method(deprecated_in((2, 5, 0)))
785
 
    def _get_inventory(self):
786
 
        return self._inventory
787
 
 
788
 
    inventory = property(_get_inventory,
789
 
                         doc="Inventory of this Tree")
790
 
 
791
 
    def _get_root_inventory(self):
792
 
        return self._inventory
793
 
 
794
 
    root_inventory = property(_get_root_inventory,
795
 
        doc="Root inventory of this tree")
796
 
 
797
 
    def _unpack_file_id(self, file_id):
798
 
        """Find the inventory and inventory file id for a tree file id.
799
 
 
800
 
        :param file_id: The tree file id, as bytestring or tuple
801
 
        :return: Inventory and inventory file id
802
 
        """
803
 
        if isinstance(file_id, tuple):
804
 
            if len(file_id) != 1:
805
 
                raise ValueError("nested trees not yet supported: %r" % file_id)
806
 
            file_id = file_id[0]
807
 
        return self.root_inventory, file_id
808
 
 
809
 
    @needs_read_lock
810
 
    def path2id(self, path):
811
 
        """Return the id for path in this tree."""
812
 
        return self._path2inv_file_id(path)[1]
813
 
 
814
 
    def _path2inv_file_id(self, path):
815
 
        """Lookup a inventory and inventory file id by path.
816
 
 
817
 
        :param path: Path to look up
818
 
        :return: tuple with inventory and inventory file id
819
 
        """
820
 
        # FIXME: Support nested trees
821
 
        return self.root_inventory, self.root_inventory.path2id(path)
822
 
 
823
 
    def id2path(self, file_id):
824
 
        """Return the path for a file id.
825
 
 
826
 
        :raises NoSuchId:
827
 
        """
828
 
        inventory, file_id = self._unpack_file_id(file_id)
829
 
        return inventory.id2path(file_id)
830
 
 
831
 
    def has_id(self, file_id):
832
 
        inventory, file_id = self._unpack_file_id(file_id)
833
 
        return inventory.has_id(file_id)
834
 
 
835
 
    def has_or_had_id(self, file_id):
836
 
        inventory, file_id = self._unpack_file_id(file_id)
837
 
        return inventory.has_id(file_id)
838
 
 
839
 
    def all_file_ids(self):
840
 
        return set(
841
 
            [entry.file_id for path, entry in self.iter_entries_by_dir()])
842
 
 
843
 
    @deprecated_method(deprecated_in((2, 4, 0)))
844
 
    def __iter__(self):
845
 
        return iter(self.all_file_ids())
846
 
 
847
 
    def filter_unversioned_files(self, paths):
848
 
        """Filter out paths that are versioned.
849
 
 
850
 
        :return: set of paths.
851
 
        """
852
 
        # NB: we specifically *don't* call self.has_filename, because for
853
 
        # WorkingTrees that can indicate files that exist on disk but that
854
 
        # are not versioned.
855
 
        return set((p for p in paths if self.path2id(p) is None))
856
 
 
857
 
    @needs_read_lock
858
 
    def iter_entries_by_dir(self, specific_file_ids=None, yield_parents=False):
859
 
        """Walk the tree in 'by_dir' order.
860
 
 
861
 
        This will yield each entry in the tree as a (path, entry) tuple.
862
 
        The order that they are yielded is:
863
 
 
864
 
        See Tree.iter_entries_by_dir for details.
865
 
 
866
 
        :param yield_parents: If True, yield the parents from the root leading
867
 
            down to specific_file_ids that have been requested. This has no
868
 
            impact if specific_file_ids is None.
869
 
        """
870
 
        if specific_file_ids is None:
871
 
            inventory_file_ids = None
872
 
        else:
873
 
            inventory_file_ids = []
874
 
            for tree_file_id in specific_file_ids:
875
 
                inventory, inv_file_id = self._unpack_file_id(tree_file_id)
876
 
                if not inventory is self.root_inventory: # for now
877
 
                    raise AssertionError("%r != %r" % (
878
 
                        inventory, self.root_inventory))
879
 
                inventory_file_ids.append(inv_file_id)
880
 
        # FIXME: Handle nested trees
881
 
        return self.root_inventory.iter_entries_by_dir(
882
 
            specific_file_ids=inventory_file_ids, yield_parents=yield_parents)
883
 
 
884
 
    @needs_read_lock
885
 
    def iter_child_entries(self, file_id, path=None):
886
 
        inv, inv_file_id = self._unpack_file_id(file_id)
887
 
        return inv[inv_file_id].children.itervalues()
888
 
 
889
 
    @deprecated_method(deprecated_in((2, 5, 0)))
890
 
    def get_file_by_path(self, path):
891
 
        return self.get_file(self.path2id(path), path)
892
 
 
893
 
    def iter_children(self, file_id, path=None):
894
 
        """See Tree.iter_children."""
895
 
        entry = self.iter_entries_by_dir([file_id]).next()[1]
896
 
        for child in getattr(entry, 'children', {}).itervalues():
897
 
            yield child.file_id
898
 
 
899
 
 
900
 
def find_ids_across_trees(filenames, trees, require_versioned=True):
901
 
    """Find the ids corresponding to specified filenames.
902
 
 
903
 
    All matches in all trees will be used, and all children of matched
904
 
    directories will be used.
905
 
 
906
 
    :param filenames: The filenames to find file_ids for (if None, returns
907
 
        None)
908
 
    :param trees: The trees to find file_ids within
909
 
    :param require_versioned: if true, all specified filenames must occur in
910
 
        at least one tree.
911
 
    :return: a set of file ids for the specified filenames and their children.
912
 
    """
913
 
    if not filenames:
914
 
        return None
915
 
    specified_path_ids = _find_ids_across_trees(filenames, trees,
916
 
        require_versioned)
917
 
    return _find_children_across_trees(specified_path_ids, trees)
918
 
 
919
 
 
920
 
def _find_ids_across_trees(filenames, trees, require_versioned):
921
 
    """Find the ids corresponding to specified filenames.
922
 
 
923
 
    All matches in all trees will be used, but subdirectories are not scanned.
924
 
 
925
 
    :param filenames: The filenames to find file_ids for
926
 
    :param trees: The trees to find file_ids within
927
 
    :param require_versioned: if true, all specified filenames must occur in
928
 
        at least one tree.
929
 
    :return: a set of file ids for the specified filenames
930
 
    """
931
 
    not_versioned = []
932
 
    interesting_ids = set()
933
 
    for tree_path in filenames:
934
 
        not_found = True
935
 
        for tree in trees:
936
 
            file_id = tree.path2id(tree_path)
937
 
            if file_id is not None:
938
 
                interesting_ids.add(file_id)
939
 
                not_found = False
940
 
        if not_found:
941
 
            not_versioned.append(tree_path)
942
 
    if len(not_versioned) > 0 and require_versioned:
943
 
        raise errors.PathsNotVersionedError(not_versioned)
944
 
    return interesting_ids
945
 
 
946
 
 
947
 
def _find_children_across_trees(specified_ids, trees):
948
 
    """Return a set including specified ids and their children.
949
 
 
950
 
    All matches in all trees will be used.
951
 
 
952
 
    :param trees: The trees to find file_ids within
953
 
    :return: a set containing all specified ids and their children
954
 
    """
955
 
    interesting_ids = set(specified_ids)
956
 
    pending = interesting_ids
957
 
    # now handle children of interesting ids
958
 
    # we loop so that we handle all children of each id in both trees
959
 
    while len(pending) > 0:
960
 
        new_pending = set()
961
 
        for file_id in pending:
962
 
            for tree in trees:
963
 
                if not tree.has_or_had_id(file_id):
964
 
                    continue
965
 
                for child_id in tree.iter_children(file_id):
966
 
                    if child_id not in interesting_ids:
967
 
                        new_pending.add(child_id)
968
 
        interesting_ids.update(new_pending)
969
 
        pending = new_pending
970
 
    return interesting_ids
 
724
    def archive(self, format, name, root='', subdir=None,
 
725
                force_mtime=None):
 
726
        """Create an archive of this tree.
 
727
 
 
728
        :param format: Format name (e.g. 'tar')
 
729
        :param name: target file name
 
730
        :param root: Root directory name (or None)
 
731
        :param subdir: Subdirectory to export (or None)
 
732
        :return: Iterator over archive chunks
 
733
        """
 
734
        from .archive import create_archive
 
735
        with self.lock_read():
 
736
            return create_archive(format, self, name, root,
 
737
                                  subdir, force_mtime=force_mtime)
 
738
 
 
739
    @classmethod
 
740
    def versionable_kind(cls, kind):
 
741
        """Check if this tree support versioning a specific file kind."""
 
742
        return (kind in ('file', 'directory', 'symlink', 'tree-reference'))
 
743
 
 
744
    def preview_transform(self, pb=None):
 
745
        """Obtain a transform object."""
 
746
        raise NotImplementedError(self.preview_transform)
971
747
 
972
748
 
973
749
class InterTree(InterObject):
976
752
    Its instances have methods like 'compare' and contain references to the
977
753
    source and target trees these operations are to be carried out on.
978
754
 
979
 
    Clients of bzrlib should not need to use InterTree directly, rather they
 
755
    Clients of breezy should not need to use InterTree directly, rather they
980
756
    should use the convenience methods on Tree such as 'Tree.compare()' which
981
757
    will pass through to InterTree as appropriate.
982
758
    """
995
771
        # it works for all trees.
996
772
        return True
997
773
 
998
 
    def _changes_from_entries(self, source_entry, target_entry,
999
 
        source_path=None, target_path=None):
1000
 
        """Generate a iter_changes tuple between source_entry and target_entry.
1001
 
 
1002
 
        :param source_entry: An inventory entry from self.source, or None.
1003
 
        :param target_entry: An inventory entry from self.target, or None.
1004
 
        :param source_path: The path of source_entry, if known. If not known
1005
 
            it will be looked up.
1006
 
        :param target_path: The path of target_entry, if known. If not known
1007
 
            it will be looked up.
1008
 
        :return: A tuple, item 0 of which is an iter_changes result tuple, and
1009
 
            item 1 is True if there are any changes in the result tuple.
1010
 
        """
1011
 
        if source_entry is None:
1012
 
            if target_entry is None:
1013
 
                return None
1014
 
            file_id = target_entry.file_id
1015
 
        else:
1016
 
            file_id = source_entry.file_id
1017
 
        if source_entry is not None:
1018
 
            source_versioned = True
1019
 
            source_name = source_entry.name
1020
 
            source_parent = source_entry.parent_id
1021
 
            if source_path is None:
1022
 
                source_path = self.source.id2path(file_id)
1023
 
            source_kind, source_executable, source_stat = \
1024
 
                self.source._comparison_data(source_entry, source_path)
1025
 
        else:
1026
 
            source_versioned = False
1027
 
            source_name = None
1028
 
            source_parent = None
1029
 
            source_kind = None
1030
 
            source_executable = None
1031
 
        if target_entry is not None:
1032
 
            target_versioned = True
1033
 
            target_name = target_entry.name
1034
 
            target_parent = target_entry.parent_id
1035
 
            if target_path is None:
1036
 
                target_path = self.target.id2path(file_id)
1037
 
            target_kind, target_executable, target_stat = \
1038
 
                self.target._comparison_data(target_entry, target_path)
1039
 
        else:
1040
 
            target_versioned = False
1041
 
            target_name = None
1042
 
            target_parent = None
1043
 
            target_kind = None
1044
 
            target_executable = None
1045
 
        versioned = (source_versioned, target_versioned)
1046
 
        kind = (source_kind, target_kind)
1047
 
        changed_content = False
1048
 
        if source_kind != target_kind:
1049
 
            changed_content = True
1050
 
        elif source_kind == 'file':
1051
 
            if not self.file_content_matches(file_id, file_id, source_path,
1052
 
                    target_path, source_stat, target_stat):
1053
 
                changed_content = True
1054
 
        elif source_kind == 'symlink':
1055
 
            if (self.source.get_symlink_target(file_id) !=
1056
 
                self.target.get_symlink_target(file_id)):
1057
 
                changed_content = True
1058
 
        elif source_kind == 'tree-reference':
1059
 
            if (self.source.get_reference_revision(file_id, source_path)
1060
 
                != self.target.get_reference_revision(file_id, target_path)):
1061
 
                    changed_content = True
1062
 
        parent = (source_parent, target_parent)
1063
 
        name = (source_name, target_name)
1064
 
        executable = (source_executable, target_executable)
1065
 
        if (changed_content is not False or versioned[0] != versioned[1]
1066
 
            or parent[0] != parent[1] or name[0] != name[1] or
1067
 
            executable[0] != executable[1]):
1068
 
            changes = True
1069
 
        else:
1070
 
            changes = False
1071
 
        return (file_id, (source_path, target_path), changed_content,
1072
 
                versioned, parent, name, kind, executable), changes
1073
 
 
1074
 
    @needs_read_lock
1075
774
    def compare(self, want_unchanged=False, specific_files=None,
1076
 
        extra_trees=None, require_versioned=False, include_root=False,
1077
 
        want_unversioned=False):
 
775
                extra_trees=None, require_versioned=False, include_root=False,
 
776
                want_unversioned=False):
1078
777
        """Return the changes from source to target.
1079
778
 
1080
779
        :return: A TreeDelta.
1091
790
            a PathsNotVersionedError will be thrown.
1092
791
        :param want_unversioned: Scan for unversioned paths.
1093
792
        """
 
793
        from . import delta
1094
794
        trees = (self.source,)
1095
795
        if extra_trees is not None:
1096
796
            trees = trees + tuple(extra_trees)
1097
 
        # target is usually the newer tree:
1098
 
        specific_file_ids = self.target.paths2ids(specific_files, trees,
1099
 
            require_versioned=require_versioned)
1100
 
        if specific_files and not specific_file_ids:
1101
 
            # All files are unversioned, so just return an empty delta
1102
 
            # _compare_trees would think we want a complete delta
1103
 
            result = delta.TreeDelta()
1104
 
            fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1105
 
            result.unversioned = [(path, None,
1106
 
                self.target._comparison_data(fake_entry, path)[0]) for path in
1107
 
                specific_files]
1108
 
            return result
1109
 
        return delta._compare_trees(self.source, self.target, want_unchanged,
1110
 
            specific_files, include_root, extra_trees=extra_trees,
1111
 
            require_versioned=require_versioned,
1112
 
            want_unversioned=want_unversioned)
 
797
        with self.lock_read():
 
798
            return delta._compare_trees(self.source, self.target, want_unchanged,
 
799
                                        specific_files, include_root, extra_trees=extra_trees,
 
800
                                        require_versioned=require_versioned,
 
801
                                        want_unversioned=want_unversioned)
1113
802
 
1114
803
    def iter_changes(self, include_unchanged=False,
1115
 
                      specific_files=None, pb=None, extra_trees=[],
1116
 
                      require_versioned=True, want_unversioned=False):
 
804
                     specific_files=None, pb=None, extra_trees=[],
 
805
                     require_versioned=True, want_unversioned=False):
1117
806
        """Generate an iterator of changes between trees.
1118
807
 
1119
808
        A tuple is returned:
1147
836
            output. An unversioned file is defined as one with (False, False)
1148
837
            for the versioned pair.
1149
838
        """
1150
 
        lookup_trees = [self.source]
1151
 
        if extra_trees:
1152
 
             lookup_trees.extend(extra_trees)
1153
 
        # The ids of items we need to examine to insure delta consistency.
1154
 
        precise_file_ids = set()
1155
 
        changed_file_ids = []
1156
 
        if specific_files == []:
1157
 
            specific_file_ids = []
1158
 
        else:
1159
 
            specific_file_ids = self.target.paths2ids(specific_files,
1160
 
                lookup_trees, require_versioned=require_versioned)
1161
 
        if specific_files is not None:
1162
 
            # reparented or added entries must have their parents included
1163
 
            # so that valid deltas can be created. The seen_parents set
1164
 
            # tracks the parents that we need to have.
1165
 
            # The seen_dirs set tracks directory entries we've yielded.
1166
 
            # After outputting version object in to_entries we set difference
1167
 
            # the two seen sets and start checking parents.
1168
 
            seen_parents = set()
1169
 
            seen_dirs = set()
1170
 
        if want_unversioned:
1171
 
            all_unversioned = sorted([(p.split('/'), p) for p in
1172
 
                                     self.target.extras()
1173
 
                if specific_files is None or
1174
 
                    osutils.is_inside_any(specific_files, p)])
1175
 
            all_unversioned = collections.deque(all_unversioned)
1176
 
        else:
1177
 
            all_unversioned = collections.deque()
1178
 
        to_paths = {}
1179
 
        from_entries_by_dir = list(self.source.iter_entries_by_dir(
1180
 
            specific_file_ids=specific_file_ids))
1181
 
        from_data = dict((e.file_id, (p, e)) for p, e in from_entries_by_dir)
1182
 
        to_entries_by_dir = list(self.target.iter_entries_by_dir(
1183
 
            specific_file_ids=specific_file_ids))
1184
 
        num_entries = len(from_entries_by_dir) + len(to_entries_by_dir)
1185
 
        entry_count = 0
1186
 
        # the unversioned path lookup only occurs on real trees - where there
1187
 
        # can be extras. So the fake_entry is solely used to look up
1188
 
        # executable it values when execute is not supported.
1189
 
        fake_entry = inventory.InventoryFile('unused', 'unused', 'unused')
1190
 
        for target_path, target_entry in to_entries_by_dir:
1191
 
            while (all_unversioned and
1192
 
                all_unversioned[0][0] < target_path.split('/')):
1193
 
                unversioned_path = all_unversioned.popleft()
1194
 
                target_kind, target_executable, target_stat = \
1195
 
                    self.target._comparison_data(fake_entry, unversioned_path[1])
1196
 
                yield (None, (None, unversioned_path[1]), True, (False, False),
1197
 
                    (None, None),
1198
 
                    (None, unversioned_path[0][-1]),
1199
 
                    (None, target_kind),
1200
 
                    (None, target_executable))
1201
 
            source_path, source_entry = from_data.get(target_entry.file_id,
1202
 
                (None, None))
1203
 
            result, changes = self._changes_from_entries(source_entry,
1204
 
                target_entry, source_path=source_path, target_path=target_path)
1205
 
            to_paths[result[0]] = result[1][1]
1206
 
            entry_count += 1
1207
 
            if result[3][0]:
1208
 
                entry_count += 1
1209
 
            if pb is not None:
1210
 
                pb.update('comparing files', entry_count, num_entries)
1211
 
            if changes or include_unchanged:
1212
 
                if specific_file_ids is not None:
1213
 
                    new_parent_id = result[4][1]
1214
 
                    precise_file_ids.add(new_parent_id)
1215
 
                    changed_file_ids.append(result[0])
1216
 
                yield result
1217
 
            # Ensure correct behaviour for reparented/added specific files.
1218
 
            if specific_files is not None:
1219
 
                # Record output dirs
1220
 
                if result[6][1] == 'directory':
1221
 
                    seen_dirs.add(result[0])
1222
 
                # Record parents of reparented/added entries.
1223
 
                versioned = result[3]
1224
 
                parents = result[4]
1225
 
                if not versioned[0] or parents[0] != parents[1]:
1226
 
                    seen_parents.add(parents[1])
1227
 
        while all_unversioned:
1228
 
            # yield any trailing unversioned paths
1229
 
            unversioned_path = all_unversioned.popleft()
1230
 
            to_kind, to_executable, to_stat = \
1231
 
                self.target._comparison_data(fake_entry, unversioned_path[1])
1232
 
            yield (None, (None, unversioned_path[1]), True, (False, False),
1233
 
                (None, None),
1234
 
                (None, unversioned_path[0][-1]),
1235
 
                (None, to_kind),
1236
 
                (None, to_executable))
1237
 
        # Yield all remaining source paths
1238
 
        for path, from_entry in from_entries_by_dir:
1239
 
            file_id = from_entry.file_id
1240
 
            if file_id in to_paths:
1241
 
                # already returned
1242
 
                continue
1243
 
            if not self.target.has_id(file_id):
1244
 
                # common case - paths we have not emitted are not present in
1245
 
                # target.
1246
 
                to_path = None
1247
 
            else:
1248
 
                to_path = self.target.id2path(file_id)
1249
 
            entry_count += 1
1250
 
            if pb is not None:
1251
 
                pb.update('comparing files', entry_count, num_entries)
1252
 
            versioned = (True, False)
1253
 
            parent = (from_entry.parent_id, None)
1254
 
            name = (from_entry.name, None)
1255
 
            from_kind, from_executable, stat_value = \
1256
 
                self.source._comparison_data(from_entry, path)
1257
 
            kind = (from_kind, None)
1258
 
            executable = (from_executable, None)
1259
 
            changed_content = from_kind is not None
1260
 
            # the parent's path is necessarily known at this point.
1261
 
            changed_file_ids.append(file_id)
1262
 
            yield(file_id, (path, to_path), changed_content, versioned, parent,
1263
 
                  name, kind, executable)
1264
 
        changed_file_ids = set(changed_file_ids)
1265
 
        if specific_file_ids is not None:
1266
 
            for result in self._handle_precise_ids(precise_file_ids,
1267
 
                changed_file_ids):
1268
 
                yield result
1269
 
 
1270
 
    def _get_entry(self, tree, file_id):
1271
 
        """Get an inventory entry from a tree, with missing entries as None.
1272
 
 
1273
 
        If the tree raises NotImplementedError on accessing .inventory, then
1274
 
        this is worked around using iter_entries_by_dir on just the file id
1275
 
        desired.
1276
 
 
1277
 
        :param tree: The tree to lookup the entry in.
1278
 
        :param file_id: The file_id to lookup.
1279
 
        """
1280
 
        try:
1281
 
            inventory = tree.root_inventory
1282
 
        except NotImplementedError:
1283
 
            # No inventory available.
1284
 
            try:
1285
 
                iterator = tree.iter_entries_by_dir(specific_file_ids=[file_id])
1286
 
                return iterator.next()[1]
1287
 
            except StopIteration:
1288
 
                return None
1289
 
        else:
1290
 
            try:
1291
 
                return inventory[file_id]
1292
 
            except errors.NoSuchId:
1293
 
                return None
1294
 
 
1295
 
    def _handle_precise_ids(self, precise_file_ids, changed_file_ids,
1296
 
        discarded_changes=None):
1297
 
        """Fill out a partial iter_changes to be consistent.
1298
 
 
1299
 
        :param precise_file_ids: The file ids of parents that were seen during
1300
 
            the iter_changes.
1301
 
        :param changed_file_ids: The file ids of already emitted items.
1302
 
        :param discarded_changes: An optional dict of precalculated
1303
 
            iter_changes items which the partial iter_changes had not output
1304
 
            but had calculated.
1305
 
        :return: A generator of iter_changes items to output.
1306
 
        """
1307
 
        # process parents of things that had changed under the users
1308
 
        # requested paths to prevent incorrect paths or parent ids which
1309
 
        # aren't in the tree.
1310
 
        while precise_file_ids:
1311
 
            precise_file_ids.discard(None)
1312
 
            # Don't emit file_ids twice
1313
 
            precise_file_ids.difference_update(changed_file_ids)
1314
 
            if not precise_file_ids:
1315
 
                break
1316
 
            # If the there was something at a given output path in source, we
1317
 
            # have to include the entry from source in the delta, or we would
1318
 
            # be putting this entry into a used path.
1319
 
            paths = []
1320
 
            for parent_id in precise_file_ids:
1321
 
                try:
1322
 
                    paths.append(self.target.id2path(parent_id))
1323
 
                except errors.NoSuchId:
1324
 
                    # This id has been dragged in from the source by delta
1325
 
                    # expansion and isn't present in target at all: we don't
1326
 
                    # need to check for path collisions on it.
1327
 
                    pass
1328
 
            for path in paths:
1329
 
                old_id = self.source.path2id(path)
1330
 
                precise_file_ids.add(old_id)
1331
 
            precise_file_ids.discard(None)
1332
 
            current_ids = precise_file_ids
1333
 
            precise_file_ids = set()
1334
 
            # We have to emit all of precise_file_ids that have been altered.
1335
 
            # We may have to output the children of some of those ids if any
1336
 
            # directories have stopped being directories.
1337
 
            for file_id in current_ids:
1338
 
                # Examine file_id
1339
 
                if discarded_changes:
1340
 
                    result = discarded_changes.get(file_id)
1341
 
                    old_entry = None
1342
 
                else:
1343
 
                    result = None
1344
 
                if result is None:
1345
 
                    old_entry = self._get_entry(self.source, file_id)
1346
 
                    new_entry = self._get_entry(self.target, file_id)
1347
 
                    result, changes = self._changes_from_entries(
1348
 
                        old_entry, new_entry)
1349
 
                else:
1350
 
                    changes = True
1351
 
                # Get this parents parent to examine.
1352
 
                new_parent_id = result[4][1]
1353
 
                precise_file_ids.add(new_parent_id)
1354
 
                if changes:
1355
 
                    if (result[6][0] == 'directory' and
1356
 
                        result[6][1] != 'directory'):
1357
 
                        # This stopped being a directory, the old children have
1358
 
                        # to be included.
1359
 
                        if old_entry is None:
1360
 
                            # Reusing a discarded change.
1361
 
                            old_entry = self._get_entry(self.source, file_id)
1362
 
                        precise_file_ids.update(
1363
 
                                self.source.iter_children(file_id))
1364
 
                    changed_file_ids.add(result[0])
1365
 
                    yield result
1366
 
 
1367
 
    @needs_read_lock
1368
 
    def file_content_matches(self, source_file_id, target_file_id,
1369
 
            source_path=None, target_path=None, source_stat=None, target_stat=None):
 
839
        raise NotImplementedError(self.iter_changes)
 
840
 
 
841
    def file_content_matches(
 
842
            self, source_path, target_path,
 
843
            source_stat=None, target_stat=None):
1370
844
        """Check if two files are the same in the source and target trees.
1371
845
 
1372
846
        This only checks that the contents of the files are the same,
1373
847
        it does not touch anything else.
1374
848
 
1375
 
        :param source_file_id: File id of the file in the source tree
1376
 
        :param target_file_id: File id of the file in the target tree
1377
849
        :param source_path: Path of the file in the source tree
1378
850
        :param target_path: Path of the file in the target tree
1379
851
        :param source_stat: Optional stat value of the file in the source tree
1380
852
        :param target_stat: Optional stat value of the file in the target tree
1381
853
        :return: Boolean indicating whether the files have the same contents
1382
854
        """
1383
 
        source_verifier_kind, source_verifier_data = self.source.get_file_verifier(
1384
 
            source_file_id, source_path, source_stat)
1385
 
        target_verifier_kind, target_verifier_data = self.target.get_file_verifier(
1386
 
            target_file_id, target_path, target_stat)
1387
 
        if source_verifier_kind == target_verifier_kind:
1388
 
            return (source_verifier_data == target_verifier_data)
1389
 
        # Fall back to SHA1 for now
1390
 
        if source_verifier_kind != "SHA1":
1391
 
            source_sha1 = self.source.get_file_sha1(source_file_id,
 
855
        with self.lock_read():
 
856
            source_verifier_kind, source_verifier_data = (
 
857
                self.source.get_file_verifier(source_path, source_stat))
 
858
            target_verifier_kind, target_verifier_data = (
 
859
                self.target.get_file_verifier(
 
860
                    target_path, target_stat))
 
861
            if source_verifier_kind == target_verifier_kind:
 
862
                return (source_verifier_data == target_verifier_data)
 
863
            # Fall back to SHA1 for now
 
864
            if source_verifier_kind != "SHA1":
 
865
                source_sha1 = self.source.get_file_sha1(
1392
866
                    source_path, source_stat)
1393
 
        else:
1394
 
            source_sha1 = source_verifier_data
1395
 
        if target_verifier_kind != "SHA1":
1396
 
            target_sha1 = self.target.get_file_sha1(target_file_id,
 
867
            else:
 
868
                source_sha1 = source_verifier_data
 
869
            if target_verifier_kind != "SHA1":
 
870
                target_sha1 = self.target.get_file_sha1(
1397
871
                    target_path, target_stat)
1398
 
        else:
1399
 
            target_sha1 = target_verifier_data
1400
 
        return (source_sha1 == target_sha1)
1401
 
 
1402
 
InterTree.register_optimiser(InterTree)
1403
 
 
1404
 
 
1405
 
class MultiWalker(object):
1406
 
    """Walk multiple trees simultaneously, getting combined results."""
1407
 
 
1408
 
    # Note: This could be written to not assume you can do out-of-order
1409
 
    #       lookups. Instead any nodes that don't match in all trees could be
1410
 
    #       marked as 'deferred', and then returned in the final cleanup loop.
1411
 
    #       For now, I think it is "nicer" to return things as close to the
1412
 
    #       "master_tree" order as we can.
1413
 
 
1414
 
    def __init__(self, master_tree, other_trees):
1415
 
        """Create a new MultiWalker.
1416
 
 
1417
 
        All trees being walked must implement "iter_entries_by_dir()", such
1418
 
        that they yield (path, object) tuples, where that object will have a
1419
 
        '.file_id' member, that can be used to check equality.
1420
 
 
1421
 
        :param master_tree: All trees will be 'slaved' to the master_tree such
1422
 
            that nodes in master_tree will be used as 'first-pass' sync points.
1423
 
            Any nodes that aren't in master_tree will be merged in a second
1424
 
            pass.
1425
 
        :param other_trees: A list of other trees to walk simultaneously.
1426
 
        """
1427
 
        self._master_tree = master_tree
1428
 
        self._other_trees = other_trees
1429
 
 
1430
 
        # Keep track of any nodes that were properly processed just out of
1431
 
        # order, that way we don't return them at the end, we don't have to
1432
 
        # track *all* processed file_ids, just the out-of-order ones
1433
 
        self._out_of_order_processed = set()
1434
 
 
1435
 
    @staticmethod
1436
 
    def _step_one(iterator):
1437
 
        """Step an iter_entries_by_dir iterator.
1438
 
 
1439
 
        :return: (has_more, path, ie)
1440
 
            If has_more is False, path and ie will be None.
1441
 
        """
1442
 
        try:
1443
 
            path, ie = iterator.next()
1444
 
        except StopIteration:
1445
 
            return False, None, None
1446
 
        else:
1447
 
            return True, path, ie
1448
 
 
1449
 
    @staticmethod
1450
 
    def _cmp_path_by_dirblock(path1, path2):
1451
 
        """Compare two paths based on what directory they are in.
1452
 
 
1453
 
        This generates a sort order, such that all children of a directory are
1454
 
        sorted together, and grandchildren are in the same order as the
1455
 
        children appear. But all grandchildren come after all children.
1456
 
 
1457
 
        :param path1: first path
1458
 
        :param path2: the second path
1459
 
        :return: negative number if ``path1`` comes first,
1460
 
            0 if paths are equal
1461
 
            and a positive number if ``path2`` sorts first
1462
 
        """
1463
 
        # Shortcut this special case
1464
 
        if path1 == path2:
1465
 
            return 0
1466
 
        # This is stolen from _dirstate_helpers_py.py, only switching it to
1467
 
        # Unicode objects. Consider using encode_utf8() and then using the
1468
 
        # optimized versions, or maybe writing optimized unicode versions.
1469
 
        if not isinstance(path1, unicode):
1470
 
            raise TypeError("'path1' must be a unicode string, not %s: %r"
1471
 
                            % (type(path1), path1))
1472
 
        if not isinstance(path2, unicode):
1473
 
            raise TypeError("'path2' must be a unicode string, not %s: %r"
1474
 
                            % (type(path2), path2))
1475
 
        return cmp(MultiWalker._path_to_key(path1),
1476
 
                   MultiWalker._path_to_key(path2))
1477
 
 
1478
 
    @staticmethod
1479
 
    def _path_to_key(path):
1480
 
        dirname, basename = osutils.split(path)
1481
 
        return (dirname.split(u'/'), basename)
1482
 
 
1483
 
    def _lookup_by_file_id(self, extra_entries, other_tree, file_id):
1484
 
        """Lookup an inventory entry by file_id.
1485
 
 
1486
 
        This is called when an entry is missing in the normal order.
1487
 
        Generally this is because a file was either renamed, or it was
1488
 
        deleted/added. If the entry was found in the inventory and not in
1489
 
        extra_entries, it will be added to self._out_of_order_processed
1490
 
 
1491
 
        :param extra_entries: A dictionary of {file_id: (path, ie)}.  This
1492
 
            should be filled with entries that were found before they were
1493
 
            used. If file_id is present, it will be removed from the
1494
 
            dictionary.
1495
 
        :param other_tree: The Tree to search, in case we didn't find the entry
1496
 
            yet.
1497
 
        :param file_id: The file_id to look for
1498
 
        :return: (path, ie) if found or (None, None) if not present.
1499
 
        """
1500
 
        if file_id in extra_entries:
1501
 
            return extra_entries.pop(file_id)
1502
 
        # TODO: Is id2path better as the first call, or is
1503
 
        #       inventory[file_id] better as a first check?
1504
 
        try:
1505
 
            cur_path = other_tree.id2path(file_id)
1506
 
        except errors.NoSuchId:
1507
 
            cur_path = None
1508
 
        if cur_path is None:
1509
 
            return (None, None)
1510
 
        else:
1511
 
            self._out_of_order_processed.add(file_id)
1512
 
            cur_ie = other_tree.root_inventory[file_id]
1513
 
            return (cur_path, cur_ie)
1514
 
 
1515
 
    def iter_all(self):
1516
 
        """Match up the values in the different trees."""
1517
 
        for result in self._walk_master_tree():
1518
 
            yield result
1519
 
        self._finish_others()
1520
 
        for result in self._walk_others():
1521
 
            yield result
1522
 
 
1523
 
    def _walk_master_tree(self):
1524
 
        """First pass, walk all trees in lock-step.
1525
 
 
1526
 
        When we are done, all nodes in the master_tree will have been
1527
 
        processed. _other_walkers, _other_entries, and _others_extra will be
1528
 
        set on 'self' for future processing.
1529
 
        """
1530
 
        # This iterator has the most "inlining" done, because it tends to touch
1531
 
        # every file in the tree, while the others only hit nodes that don't
1532
 
        # match.
1533
 
        master_iterator = self._master_tree.iter_entries_by_dir()
1534
 
 
1535
 
        other_walkers = [other.iter_entries_by_dir()
1536
 
                         for other in self._other_trees]
1537
 
        other_entries = [self._step_one(walker) for walker in other_walkers]
1538
 
        # Track extra nodes in the other trees
1539
 
        others_extra = [{} for i in xrange(len(self._other_trees))]
1540
 
 
1541
 
        master_has_more = True
1542
 
        step_one = self._step_one
1543
 
        lookup_by_file_id = self._lookup_by_file_id
1544
 
        out_of_order_processed = self._out_of_order_processed
1545
 
 
1546
 
        while master_has_more:
1547
 
            (master_has_more, path, master_ie) = step_one(master_iterator)
1548
 
            if not master_has_more:
1549
 
                break
1550
 
 
1551
 
            file_id = master_ie.file_id
1552
 
            other_values = []
1553
 
            other_values_append = other_values.append
1554
 
            next_other_entries = []
1555
 
            next_other_entries_append = next_other_entries.append
1556
 
            for idx, (other_has_more, other_path, other_ie) in enumerate(other_entries):
1557
 
                if not other_has_more:
1558
 
                    other_values_append(lookup_by_file_id(
1559
 
                        others_extra[idx], self._other_trees[idx], file_id))
1560
 
                    next_other_entries_append((False, None, None))
1561
 
                elif file_id == other_ie.file_id:
1562
 
                    # This is the critical code path, as most of the entries
1563
 
                    # should match between most trees.
1564
 
                    other_values_append((other_path, other_ie))
1565
 
                    next_other_entries_append(step_one(other_walkers[idx]))
1566
 
                else:
1567
 
                    # This walker did not match, step it until it either
1568
 
                    # matches, or we know we are past the current walker.
1569
 
                    other_walker = other_walkers[idx]
1570
 
                    other_extra = others_extra[idx]
1571
 
                    while (other_has_more and
1572
 
                           self._cmp_path_by_dirblock(other_path, path) < 0):
1573
 
                        other_file_id = other_ie.file_id
1574
 
                        if other_file_id not in out_of_order_processed:
1575
 
                            other_extra[other_file_id] = (other_path, other_ie)
1576
 
                        other_has_more, other_path, other_ie = \
1577
 
                            step_one(other_walker)
1578
 
                    if other_has_more and other_ie.file_id == file_id:
1579
 
                        # We ended up walking to this point, match and step
1580
 
                        # again
1581
 
                        other_values_append((other_path, other_ie))
1582
 
                        other_has_more, other_path, other_ie = \
1583
 
                            step_one(other_walker)
1584
 
                    else:
1585
 
                        # This record isn't in the normal order, see if it
1586
 
                        # exists at all.
1587
 
                        other_values_append(lookup_by_file_id(
1588
 
                            other_extra, self._other_trees[idx], file_id))
1589
 
                    next_other_entries_append((other_has_more, other_path,
1590
 
                                               other_ie))
1591
 
            other_entries = next_other_entries
1592
 
 
1593
 
            # We've matched all the walkers, yield this datapoint
1594
 
            yield path, file_id, master_ie, other_values
1595
 
        self._other_walkers = other_walkers
1596
 
        self._other_entries = other_entries
1597
 
        self._others_extra = others_extra
1598
 
 
1599
 
    def _finish_others(self):
1600
 
        """Finish walking the other iterators, so we get all entries."""
1601
 
        for idx, info in enumerate(self._other_entries):
1602
 
            other_extra = self._others_extra[idx]
1603
 
            (other_has_more, other_path, other_ie) = info
1604
 
            while other_has_more:
1605
 
                other_file_id = other_ie.file_id
1606
 
                if other_file_id not in self._out_of_order_processed:
1607
 
                    other_extra[other_file_id] = (other_path, other_ie)
1608
 
                other_has_more, other_path, other_ie = \
1609
 
                    self._step_one(self._other_walkers[idx])
1610
 
        del self._other_entries
1611
 
 
1612
 
    def _walk_others(self):
1613
 
        """Finish up by walking all the 'deferred' nodes."""
1614
 
        # TODO: One alternative would be to grab all possible unprocessed
1615
 
        #       file_ids, and then sort by path, and then yield them. That
1616
 
        #       might ensure better ordering, in case a caller strictly
1617
 
        #       requires parents before children.
1618
 
        for idx, other_extra in enumerate(self._others_extra):
1619
 
            others = sorted(other_extra.itervalues(),
1620
 
                            key=lambda x: self._path_to_key(x[0]))
1621
 
            for other_path, other_ie in others:
1622
 
                file_id = other_ie.file_id
1623
 
                # We don't need to check out_of_order_processed here, because
1624
 
                # the lookup_by_file_id will be removing anything processed
1625
 
                # from the extras cache
1626
 
                other_extra.pop(file_id)
1627
 
                other_values = [(None, None) for i in xrange(idx)]
1628
 
                other_values.append((other_path, other_ie))
1629
 
                for alt_idx, alt_extra in enumerate(self._others_extra[idx+1:]):
1630
 
                    alt_idx = alt_idx + idx + 1
1631
 
                    alt_extra = self._others_extra[alt_idx]
1632
 
                    alt_tree = self._other_trees[alt_idx]
1633
 
                    other_values.append(self._lookup_by_file_id(
1634
 
                                            alt_extra, alt_tree, file_id))
1635
 
                yield other_path, file_id, None, other_values
 
872
            else:
 
873
                target_sha1 = target_verifier_data
 
874
            return (source_sha1 == target_sha1)
 
875
 
 
876
    def find_target_path(self, path, recurse='none'):
 
877
        """Find target tree path.
 
878
 
 
879
        :param path: Path to search for (exists in source)
 
880
        :return: path in target, or None if there is no equivalent path.
 
881
        :raise NoSuchFile: If the path doesn't exist in source
 
882
        """
 
883
        raise NotImplementedError(self.find_target_path)
 
884
 
 
885
    def find_source_path(self, path, recurse='none'):
 
886
        """Find the source tree path.
 
887
 
 
888
        :param path: Path to search for (exists in target)
 
889
        :return: path in source, or None if there is no equivalent path.
 
890
        :raise NoSuchFile: if the path doesn't exist in target
 
891
        """
 
892
        raise NotImplementedError(self.find_source_path)
 
893
 
 
894
    def find_target_paths(self, paths, recurse='none'):
 
895
        """Find target tree paths.
 
896
 
 
897
        :param paths: Iterable over paths in target to search for
 
898
        :return: Dictionary mapping from source paths to paths in target , or
 
899
            None if there is no equivalent path.
 
900
        """
 
901
        ret = {}
 
902
        for path in paths:
 
903
            ret[path] = self.find_target_path(path, recurse=recurse)
 
904
        return ret
 
905
 
 
906
    def find_source_paths(self, paths, recurse='none'):
 
907
        """Find source tree paths.
 
908
 
 
909
        :param paths: Iterable over paths in target to search for
 
910
        :return: Dictionary mapping from target paths to paths in source, or
 
911
            None if there is no equivalent path.
 
912
        """
 
913
        ret = {}
 
914
        for path in paths:
 
915
            ret[path] = self.find_source_path(path, recurse=recurse)
 
916
        return ret
 
917
 
 
918
 
 
919
def find_previous_paths(from_tree, to_tree, paths, recurse='none'):
 
920
    """Find previous tree paths.
 
921
 
 
922
    :param from_tree: From tree
 
923
    :param to_tree: To tree
 
924
    :param paths: Iterable over paths in from_tree to search for
 
925
    :return: Dictionary mapping from from_tree paths to paths in to_tree, or
 
926
        None if there is no equivalent path.
 
927
    """
 
928
    return InterTree.get(to_tree, from_tree).find_source_paths(paths, recurse=recurse)
 
929
 
 
930
 
 
931
def find_previous_path(from_tree, to_tree, path, recurse='none'):
 
932
    """Find previous tree path.
 
933
 
 
934
    :param from_tree: From tree
 
935
    :param to_tree: To tree
 
936
    :param path: Path to search for (exists in from_tree)
 
937
    :return: path in to_tree, or None if there is no equivalent path.
 
938
    :raise NoSuchFile: If the path doesn't exist in from_tree
 
939
    """
 
940
    return InterTree.get(to_tree, from_tree).find_source_path(
 
941
        path, recurse=recurse)
 
942
 
 
943
 
 
944
def get_canonical_path(tree, path, normalize):
 
945
    """Find the canonical path of an item, ignoring case.
 
946
 
 
947
    :param tree: Tree to traverse
 
948
    :param path: Case-insensitive path to look up
 
949
    :param normalize: Function to normalize a filename for comparison
 
950
    :return: The canonical path
 
951
    """
 
952
    # go walkin...
 
953
    cur_path = ''
 
954
    bit_iter = iter(path.split("/"))
 
955
    for elt in bit_iter:
 
956
        lelt = normalize(elt)
 
957
        new_path = None
 
958
        try:
 
959
            for child in tree.iter_child_entries(cur_path):
 
960
                try:
 
961
                    if child.name == elt:
 
962
                        # if we found an exact match, we can stop now; if
 
963
                        # we found an approximate match we need to keep
 
964
                        # searching because there might be an exact match
 
965
                        # later.
 
966
                        new_path = osutils.pathjoin(cur_path, child.name)
 
967
                        break
 
968
                    elif normalize(child.name) == lelt:
 
969
                        new_path = osutils.pathjoin(cur_path, child.name)
 
970
                except errors.NoSuchId:
 
971
                    # before a change is committed we can see this error...
 
972
                    continue
 
973
        except errors.NotADirectory:
 
974
            pass
 
975
        if new_path:
 
976
            cur_path = new_path
 
977
        else:
 
978
            # got to the end of this directory and no entries matched.
 
979
            # Return what matched so far, plus the rest as specified.
 
980
            cur_path = osutils.pathjoin(cur_path, elt, *list(bit_iter))
 
981
            break
 
982
    return cur_path