/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/tree.py

  • Committer: Jelmer Vernooij
  • Date: 2018-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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