/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): Jelmer Vernooij
  • Date: 2019-06-06 22:22:47 UTC
  • mfrom: (7143.22.4 progressbar-context)
  • Revision ID: breezy.the.bot@gmail.com-20190606222247-muw4nwibuoh9b30u
Use contexts for progress bars where possible.

Merged from https://code.launchpad.net/~jelmer/brz/progressbar-context/+merge/358460

Show diffs side-by-side

added added

removed removed

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