/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/tree.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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