/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/diff.py

  • Committer: Martin Pool
  • Date: 2010-04-16 07:56:51 UTC
  • mfrom: (5160 +trunk)
  • mto: (5050.3.4 2.2)
  • mto: This revision was merged to the branch mainline in revision 5173.
  • Revision ID: mbp@sourcefrog.net-20100416075651-bf23hr9hlof64gpj
merge trunk to 2.2 preparing for 2.2b2

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2014 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import difflib
20
18
import os
21
19
import re
 
20
import shutil
 
21
import string
22
22
import sys
23
23
 
24
 
from .lazy_import import lazy_import
 
24
from bzrlib.lazy_import import lazy_import
25
25
lazy_import(globals(), """
26
26
import errno
27
 
import patiencediff
28
27
import subprocess
29
28
import tempfile
 
29
import time
30
30
 
31
 
from breezy import (
 
31
from bzrlib import (
 
32
    branch as _mod_branch,
 
33
    bzrdir,
 
34
    cmdline,
32
35
    cleanup,
33
 
    controldir,
 
36
    errors,
34
37
    osutils,
 
38
    patiencediff,
35
39
    textfile,
36
40
    timestamp,
37
41
    views,
38
42
    )
39
43
 
40
 
from breezy.workingtree import WorkingTree
41
 
from breezy.i18n import gettext
 
44
from bzrlib.workingtree import WorkingTree
42
45
""")
43
46
 
44
 
from . import (
45
 
    errors,
46
 
    )
47
 
from .registry import (
 
47
from bzrlib.registry import (
48
48
    Registry,
49
49
    )
50
 
from .sixish import text_type
51
 
from .trace import mutter, note, warning
52
 
from .tree import FileTimestampUnavailable
53
 
 
54
 
 
55
 
DEFAULT_CONTEXT_AMOUNT = 3
 
50
from bzrlib.symbol_versioning import (
 
51
    deprecated_function,
 
52
    deprecated_in,
 
53
    )
 
54
from bzrlib.trace import mutter, note, warning
 
55
 
 
56
 
 
57
class AtTemplate(string.Template):
 
58
    """Templating class that uses @ instead of $."""
 
59
 
 
60
    delimiter = '@'
56
61
 
57
62
 
58
63
# TODO: Rather than building a changeset object, we should probably
69
74
        self.opcodes = None
70
75
 
71
76
 
72
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file,
 
77
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
73
78
                  allow_binary=False, sequence_matcher=None,
74
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
79
                  path_encoding='utf8'):
75
80
    # FIXME: difflib is wrong if there is no trailing newline.
76
81
    # The syntax used by patch seems to be "\ No newline at
77
82
    # end of file" following the last diff line from that
82
87
    # In the meantime we at least make sure the patch isn't
83
88
    # mangled.
84
89
 
 
90
 
 
91
    # Special workaround for Python2.3, where difflib fails if
 
92
    # both sequences are empty.
 
93
    if not oldlines and not newlines:
 
94
        return
 
95
 
85
96
    if allow_binary is False:
86
97
        textfile.check_text_lines(oldlines)
87
98
        textfile.check_text_lines(newlines)
88
99
 
89
100
    if sequence_matcher is None:
90
101
        sequence_matcher = patiencediff.PatienceSequenceMatcher
91
 
    ud = unified_diff_bytes(
92
 
        oldlines, newlines,
93
 
        fromfile=old_label.encode(path_encoding, 'replace'),
94
 
        tofile=new_label.encode(path_encoding, 'replace'),
95
 
        n=context_lines, sequencematcher=sequence_matcher)
 
102
    ud = patiencediff.unified_diff(oldlines, newlines,
 
103
                      fromfile=old_filename.encode(path_encoding),
 
104
                      tofile=new_filename.encode(path_encoding),
 
105
                      sequencematcher=sequence_matcher)
96
106
 
97
107
    ud = list(ud)
98
 
    if len(ud) == 0:  # Identical contents, nothing to do
 
108
    if len(ud) == 0: # Identical contents, nothing to do
99
109
        return
100
110
    # work-around for difflib being too smart for its own good
101
111
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
102
112
    if not oldlines:
103
 
        ud[2] = ud[2].replace(b'-1,0', b'-0,0')
 
113
        ud[2] = ud[2].replace('-1,0', '-0,0')
104
114
    elif not newlines:
105
 
        ud[2] = ud[2].replace(b'+1,0', b'+0,0')
 
115
        ud[2] = ud[2].replace('+1,0', '+0,0')
106
116
 
107
117
    for line in ud:
108
118
        to_file.write(line)
109
 
        if not line.endswith(b'\n'):
110
 
            to_file.write(b"\n\\ No newline at end of file\n")
111
 
    to_file.write(b'\n')
112
 
 
113
 
 
114
 
def unified_diff_bytes(a, b, fromfile=b'', tofile=b'', fromfiledate=b'',
115
 
                       tofiledate=b'', n=3, lineterm=b'\n', sequencematcher=None):
116
 
    r"""
117
 
    Compare two sequences of lines; generate the delta as a unified diff.
118
 
 
119
 
    Unified diffs are a compact way of showing line changes and a few
120
 
    lines of context.  The number of context lines is set by 'n' which
121
 
    defaults to three.
122
 
 
123
 
    By default, the diff control lines (those with ---, +++, or @@) are
124
 
    created with a trailing newline.  This is helpful so that inputs
125
 
    created from file.readlines() result in diffs that are suitable for
126
 
    file.writelines() since both the inputs and outputs have trailing
127
 
    newlines.
128
 
 
129
 
    For inputs that do not have trailing newlines, set the lineterm
130
 
    argument to "" so that the output will be uniformly newline free.
131
 
 
132
 
    The unidiff format normally has a header for filenames and modification
133
 
    times.  Any or all of these may be specified using strings for
134
 
    'fromfile', 'tofile', 'fromfiledate', and 'tofiledate'.  The modification
135
 
    times are normally expressed in the format returned by time.ctime().
136
 
 
137
 
    Example:
138
 
 
139
 
    >>> for line in bytes_unified_diff(b'one two three four'.split(),
140
 
    ...             b'zero one tree four'.split(), b'Original', b'Current',
141
 
    ...             b'Sat Jan 26 23:30:50 1991', b'Fri Jun 06 10:20:52 2003',
142
 
    ...             lineterm=b''):
143
 
    ...     print line
144
 
    --- Original Sat Jan 26 23:30:50 1991
145
 
    +++ Current Fri Jun 06 10:20:52 2003
146
 
    @@ -1,4 +1,4 @@
147
 
    +zero
148
 
     one
149
 
    -two
150
 
    -three
151
 
    +tree
152
 
     four
153
 
    """
154
 
    if sequencematcher is None:
155
 
        sequencematcher = difflib.SequenceMatcher
156
 
 
157
 
    if fromfiledate:
158
 
        fromfiledate = b'\t' + bytes(fromfiledate)
159
 
    if tofiledate:
160
 
        tofiledate = b'\t' + bytes(tofiledate)
161
 
 
162
 
    started = False
163
 
    for group in sequencematcher(None, a, b).get_grouped_opcodes(n):
164
 
        if not started:
165
 
            yield b'--- %s%s%s' % (fromfile, fromfiledate, lineterm)
166
 
            yield b'+++ %s%s%s' % (tofile, tofiledate, lineterm)
167
 
            started = True
168
 
        i1, i2, j1, j2 = group[0][1], group[-1][2], group[0][3], group[-1][4]
169
 
        yield b"@@ -%d,%d +%d,%d @@%s" % (i1 + 1, i2 - i1, j1 + 1, j2 - j1, lineterm)
170
 
        for tag, i1, i2, j1, j2 in group:
171
 
            if tag == 'equal':
172
 
                for line in a[i1:i2]:
173
 
                    yield b' ' + line
174
 
                continue
175
 
            if tag == 'replace' or tag == 'delete':
176
 
                for line in a[i1:i2]:
177
 
                    yield b'-' + line
178
 
            if tag == 'replace' or tag == 'insert':
179
 
                for line in b[j1:j2]:
180
 
                    yield b'+' + line
 
119
        if not line.endswith('\n'):
 
120
            to_file.write("\n\\ No newline at end of file\n")
 
121
    to_file.write('\n')
181
122
 
182
123
 
183
124
def _spawn_external_diff(diffcmd, capture_errors=True):
184
 
    """Spawn the external diff process, and return the child handle.
 
125
    """Spawn the externall diff process, and return the child handle.
185
126
 
186
127
    :param diffcmd: The command list to spawn
187
128
    :param capture_errors: Capture stderr as well as setting LANG=C
209
150
                                stdout=subprocess.PIPE,
210
151
                                stderr=stderr,
211
152
                                env=env)
212
 
    except OSError as e:
 
153
    except OSError, e:
213
154
        if e.errno == errno.ENOENT:
214
155
            raise errors.NoDiff(str(e))
215
156
        raise
217
158
    return pipe
218
159
 
219
160
 
220
 
# diff style options as of GNU diff v3.2
221
 
style_option_list = ['-c', '-C', '--context',
222
 
                     '-e', '--ed',
223
 
                     '-f', '--forward-ed',
224
 
                     '-q', '--brief',
225
 
                     '--normal',
226
 
                     '-n', '--rcs',
227
 
                     '-u', '-U', '--unified',
228
 
                     '-y', '--side-by-side',
229
 
                     '-D', '--ifdef']
230
 
 
231
 
 
232
 
def default_style_unified(diff_opts):
233
 
    """Default to unified diff style if alternative not specified in diff_opts.
234
 
 
235
 
        diff only allows one style to be specified; they don't override.
236
 
        Note that some of these take optargs, and the optargs can be
237
 
        directly appended to the options.
238
 
        This is only an approximate parser; it doesn't properly understand
239
 
        the grammar.
240
 
 
241
 
    :param diff_opts: List of options for external (GNU) diff.
242
 
    :return: List of options with default style=='unified'.
243
 
    """
244
 
    for s in style_option_list:
245
 
        for j in diff_opts:
246
 
            if j.startswith(s):
247
 
                break
248
 
        else:
249
 
            continue
250
 
        break
251
 
    else:
252
 
        diff_opts.append('-u')
253
 
    return diff_opts
254
 
 
255
 
 
256
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
161
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
257
162
                  diff_opts):
258
163
    """Display a diff by calling out to the external diff program."""
259
164
    # make sure our own output is properly ordered before the diff
260
165
    to_file.flush()
261
166
 
262
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
263
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
167
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
168
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
264
169
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
265
170
    newtmpf = os.fdopen(newtmp_fd, 'wb')
266
171
 
283
188
        if sys.platform == 'win32':
284
189
            # Popen doesn't do the proper encoding for external commands
285
190
            # Since we are dealing with an ANSI api, use mbcs encoding
286
 
            old_label = old_label.encode('mbcs')
287
 
            new_label = new_label.encode('mbcs')
 
191
            old_filename = old_filename.encode('mbcs')
 
192
            new_filename = new_filename.encode('mbcs')
288
193
        diffcmd = ['diff',
289
 
                   '--label', old_label,
 
194
                   '--label', old_filename,
290
195
                   old_abspath,
291
 
                   '--label', new_label,
 
196
                   '--label', new_filename,
292
197
                   new_abspath,
293
198
                   '--binary',
294
 
                   ]
 
199
                  ]
295
200
 
296
 
        diff_opts = default_style_unified(diff_opts)
 
201
        # diff only allows one style to be specified; they don't override.
 
202
        # note that some of these take optargs, and the optargs can be
 
203
        # directly appended to the options.
 
204
        # this is only an approximate parser; it doesn't properly understand
 
205
        # the grammar.
 
206
        for s in ['-c', '-u', '-C', '-U',
 
207
                  '-e', '--ed',
 
208
                  '-q', '--brief',
 
209
                  '--normal',
 
210
                  '-n', '--rcs',
 
211
                  '-y', '--side-by-side',
 
212
                  '-D', '--ifdef']:
 
213
            for j in diff_opts:
 
214
                if j.startswith(s):
 
215
                    break
 
216
            else:
 
217
                continue
 
218
            break
 
219
        else:
 
220
            diffcmd.append('-u')
297
221
 
298
222
        if diff_opts:
299
223
            diffcmd.extend(diff_opts)
300
224
 
301
225
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
302
 
        out, err = pipe.communicate()
 
226
        out,err = pipe.communicate()
303
227
        rc = pipe.returncode
304
228
 
305
229
        # internal_diff() adds a trailing newline, add one here for consistency
306
 
        out += b'\n'
 
230
        out += '\n'
307
231
        if rc == 2:
308
232
            # 'diff' gives retcode == 2 for all sorts of errors
309
233
            # one of those is 'Binary files differ'.
316
240
            out, err = pipe.communicate()
317
241
 
318
242
            # Write out the new i18n diff response
319
 
            to_file.write(out + b'\n')
 
243
            to_file.write(out+'\n')
320
244
            if pipe.returncode != 2:
321
245
                raise errors.BzrError(
322
 
                    'external diff failed with exit code 2'
323
 
                    ' when run with LANG=C and LC_ALL=C,'
324
 
                    ' but not when run natively: %r' % (diffcmd,))
 
246
                               'external diff failed with exit code 2'
 
247
                               ' when run with LANG=C and LC_ALL=C,'
 
248
                               ' but not when run natively: %r' % (diffcmd,))
325
249
 
326
 
            first_line = lang_c_out.split(b'\n', 1)[0]
 
250
            first_line = lang_c_out.split('\n', 1)[0]
327
251
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
328
 
            m = re.match(b'^(binary )?files.*differ$', first_line, re.I)
 
252
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
329
253
            if m is None:
330
254
                raise errors.BzrError('external diff failed with exit code 2;'
331
255
                                      ' command: %r' % (diffcmd,))
344
268
                msg = 'exit code %d' % rc
345
269
 
346
270
            raise errors.BzrError('external diff failed with %s; command: %r'
347
 
                                  % (msg, diffcmd))
 
271
                                  % (rc, diffcmd))
 
272
 
348
273
 
349
274
    finally:
350
275
        oldtmpf.close()                 # and delete
351
276
        newtmpf.close()
352
 
 
353
 
        def cleanup(path):
354
 
            # Warn in case the file couldn't be deleted (in case windows still
355
 
            # holds the file open, but not if the files have already been
356
 
            # deleted)
357
 
            try:
358
 
                os.remove(path)
359
 
            except OSError as e:
360
 
                if e.errno not in (errno.ENOENT,):
361
 
                    warning('Failed to delete temporary file: %s %s', path, e)
362
 
 
363
 
        cleanup(old_abspath)
364
 
        cleanup(new_abspath)
365
 
 
 
277
        # Clean up. Warn in case the files couldn't be deleted
 
278
        # (in case windows still holds the file open, but not
 
279
        # if the files have already been deleted)
 
280
        try:
 
281
            os.remove(old_abspath)
 
282
        except OSError, e:
 
283
            if e.errno not in (errno.ENOENT,):
 
284
                warning('Failed to delete temporary file: %s %s',
 
285
                        old_abspath, e)
 
286
        try:
 
287
            os.remove(new_abspath)
 
288
        except OSError:
 
289
            if e.errno not in (errno.ENOENT,):
 
290
                warning('Failed to delete temporary file: %s %s',
 
291
                        new_abspath, e)
 
292
 
 
293
 
 
294
@deprecated_function(deprecated_in((2, 2, 0)))
 
295
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
 
296
                                   apply_view=True):
 
297
    """Get the trees and specific files to diff given a list of paths.
 
298
 
 
299
    This method works out the trees to be diff'ed and the files of
 
300
    interest within those trees.
 
301
 
 
302
    :param path_list:
 
303
        the list of arguments passed to the diff command
 
304
    :param revision_specs:
 
305
        Zero, one or two RevisionSpecs from the diff command line,
 
306
        saying what revisions to compare.
 
307
    :param old_url:
 
308
        The url of the old branch or tree. If None, the tree to use is
 
309
        taken from the first path, if any, or the current working tree.
 
310
    :param new_url:
 
311
        The url of the new branch or tree. If None, the tree to use is
 
312
        taken from the first path, if any, or the current working tree.
 
313
    :param apply_view:
 
314
        if True and a view is set, apply the view or check that the paths
 
315
        are within it
 
316
    :returns:
 
317
        a tuple of (old_tree, new_tree, old_branch, new_branch,
 
318
        specific_files, extra_trees) where extra_trees is a sequence of
 
319
        additional trees to search in for file-ids.  The trees and branches
 
320
        are not locked.
 
321
    """
 
322
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
 
323
    return op.run_simple(path_list, revision_specs, old_url, new_url,
 
324
            op.add_cleanup, apply_view=apply_view)
 
325
    
366
326
 
367
327
def get_trees_and_branches_to_diff_locked(
368
 
        path_list, revision_specs, old_url, new_url, exit_stack, apply_view=True):
 
328
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
369
329
    """Get the trees and specific files to diff given a list of paths.
370
330
 
371
331
    This method works out the trees to be diff'ed and the files of
382
342
    :param new_url:
383
343
        The url of the new branch or tree. If None, the tree to use is
384
344
        taken from the first path, if any, or the current working tree.
385
 
    :param exit_stack:
386
 
        an ExitStack object. get_trees_and_branches_to_diff
 
345
    :param add_cleanup:
 
346
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
387
347
        will register cleanups that must be run to unlock the trees, etc.
388
348
    :param apply_view:
389
349
        if True and a view is set, apply the view or check that the paths
392
352
        a tuple of (old_tree, new_tree, old_branch, new_branch,
393
353
        specific_files, extra_trees) where extra_trees is a sequence of
394
354
        additional trees to search in for file-ids.  The trees and branches
395
 
        will be read-locked until the cleanups registered via the exit_stack
 
355
        will be read-locked until the cleanups registered via the add_cleanup
396
356
        param are run.
397
357
    """
398
358
    # Get the old and new revision specs
424
384
 
425
385
    def lock_tree_or_branch(wt, br):
426
386
        if wt is not None:
427
 
            exit_stack.enter_context(wt.lock_read())
 
387
            wt.lock_read()
 
388
            add_cleanup(wt.unlock)
428
389
        elif br is not None:
429
 
            exit_stack.enter_context(br.lock_read())
 
390
            br.lock_read()
 
391
            add_cleanup(br.unlock)
430
392
 
431
393
    # Get the old location
432
394
    specific_files = []
433
395
    if old_url is None:
434
396
        old_url = default_location
435
397
    working_tree, branch, relpath = \
436
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
 
398
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
437
399
    lock_tree_or_branch(working_tree, branch)
438
400
    if consider_relpath and relpath != '':
439
401
        if working_tree is not None and apply_view:
447
409
        new_url = default_location
448
410
    if new_url != old_url:
449
411
        working_tree, branch, relpath = \
450
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
 
412
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
451
413
        lock_tree_or_branch(working_tree, branch)
452
414
        if consider_relpath and relpath != '':
453
415
            if working_tree is not None and apply_view:
454
416
                views.check_path_in_view(working_tree, relpath)
455
417
            specific_files.append(relpath)
456
418
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
457
 
                                 basis_is_default=working_tree is None)
 
419
        basis_is_default=working_tree is None)
458
420
    new_branch = branch
459
421
 
460
422
    # Get the specific files (all files is None, no files is [])
461
423
    if make_paths_wt_relative and working_tree is not None:
462
 
        other_paths = working_tree.safe_relpath_files(
463
 
            other_paths,
 
424
        try:
 
425
            from bzrlib.builtins import safe_relpath_files
 
426
            other_paths = safe_relpath_files(working_tree, other_paths,
464
427
            apply_view=apply_view)
 
428
        except errors.FileInWrongBranch:
 
429
            raise errors.BzrCommandError("Files are in different branches")
465
430
    specific_files.extend(other_paths)
466
431
    if len(specific_files) == 0:
467
432
        specific_files = None
468
 
        if (working_tree is not None and working_tree.supports_views() and
469
 
                apply_view):
 
433
        if (working_tree is not None and working_tree.supports_views()
 
434
            and apply_view):
470
435
            view_files = working_tree.views.lookup_view()
471
436
            if view_files:
472
437
                specific_files = view_files
473
438
                view_str = views.view_display_str(view_files)
474
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
439
                note("*** Ignoring files outside view. View is %s" % view_str)
475
440
 
476
441
    # Get extra trees that ought to be searched for file-ids
477
442
    extra_trees = None
478
443
    if working_tree is not None and working_tree not in (old_tree, new_tree):
479
444
        extra_trees = (working_tree,)
480
 
    return (old_tree, new_tree, old_branch, new_branch,
481
 
            specific_files, extra_trees)
 
445
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
482
446
 
483
447
 
484
448
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
501
465
                    extra_trees=None,
502
466
                    path_encoding='utf8',
503
467
                    using=None,
504
 
                    format_cls=None,
505
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
468
                    format_cls=None):
506
469
    """Show in text form the changes from one tree to another.
507
470
 
508
471
    :param to_file: The output stream.
509
 
    :param specific_files: Include only changes to these files - None for all
 
472
    :param specific_files:Include only changes to these files - None for all
510
473
        changes.
511
 
    :param external_diff_options: If set, use an external GNU diff and pass
 
474
    :param external_diff_options: If set, use an external GNU diff and pass 
512
475
        these options.
513
476
    :param extra_trees: If set, more Trees to use for looking up file ids
514
 
    :param path_encoding: If set, the path will be encoded as specified,
 
477
    :param path_encoding: If set, the path will be encoded as specified, 
515
478
        otherwise is supposed to be utf8
516
479
    :param format_cls: Formatter class (DiffTree subclass)
517
480
    """
518
 
    if context is None:
519
 
        context = DEFAULT_CONTEXT_AMOUNT
520
481
    if format_cls is None:
521
482
        format_cls = DiffTree
522
 
    with cleanup.ExitStack() as exit_stack:
523
 
        exit_stack.enter_context(old_tree.lock_read())
 
483
    old_tree.lock_read()
 
484
    try:
524
485
        if extra_trees is not None:
525
486
            for tree in extra_trees:
526
 
                exit_stack.enter_context(tree.lock_read())
527
 
        exit_stack.enter_context(new_tree.lock_read())
528
 
        differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
529
 
                                               path_encoding,
530
 
                                               external_diff_options,
531
 
                                               old_label, new_label, using,
532
 
                                               context_lines=context)
533
 
        return differ.show_diff(specific_files, extra_trees)
534
 
 
535
 
 
536
 
def _patch_header_date(tree, path):
 
487
                tree.lock_read()
 
488
        new_tree.lock_read()
 
489
        try:
 
490
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
491
                                                   path_encoding,
 
492
                                                   external_diff_options,
 
493
                                                   old_label, new_label, using)
 
494
            return differ.show_diff(specific_files, extra_trees)
 
495
        finally:
 
496
            new_tree.unlock()
 
497
            if extra_trees is not None:
 
498
                for tree in extra_trees:
 
499
                    tree.unlock()
 
500
    finally:
 
501
        old_tree.unlock()
 
502
 
 
503
 
 
504
def _patch_header_date(tree, file_id, path):
537
505
    """Returns a timestamp suitable for use in a patch header."""
538
506
    try:
539
 
        mtime = tree.get_file_mtime(path)
540
 
    except FileTimestampUnavailable:
 
507
        mtime = tree.get_file_mtime(file_id, path)
 
508
    except errors.FileTimestampUnavailable:
541
509
        mtime = 0
542
510
    return timestamp.format_patch_date(mtime)
543
511
 
544
512
 
545
513
def get_executable_change(old_is_x, new_is_x):
546
 
    descr = {True: b"+x", False: b"-x", None: b"??"}
 
514
    descr = { True:"+x", False:"-x", None:"??" }
547
515
    if old_is_x != new_is_x:
548
 
        return [b"%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
516
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
549
517
    else:
550
518
        return []
551
519
 
582
550
                     diff_tree.to_file, diff_tree.path_encoding)
583
551
 
584
552
    @staticmethod
585
 
    def _diff_many(differs, old_path, new_path, old_kind, new_kind):
 
553
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
586
554
        for file_differ in differs:
587
 
            result = file_differ.diff(old_path, new_path, old_kind, new_kind)
 
555
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
 
556
                                      new_kind)
588
557
            if result is not DiffPath.CANNOT_DIFF:
589
558
                return result
590
559
        else:
597
566
    Represents kind change as deletion + creation.  Uses the other differs
598
567
    to do this.
599
568
    """
600
 
 
601
569
    def __init__(self, differs):
602
570
        self.differs = differs
603
571
 
608
576
    def from_diff_tree(klass, diff_tree):
609
577
        return klass(diff_tree.differs)
610
578
 
611
 
    def diff(self, old_path, new_path, old_kind, new_kind):
 
579
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
612
580
        """Perform comparison
613
581
 
 
582
        :param file_id: The file_id of the file to compare
614
583
        :param old_path: Path of the file in the old tree
615
584
        :param new_path: Path of the file in the new tree
616
585
        :param old_kind: Old file-kind of the file
618
587
        """
619
588
        if None in (old_kind, new_kind):
620
589
            return DiffPath.CANNOT_DIFF
621
 
        result = DiffPath._diff_many(
622
 
            self.differs, old_path, new_path, old_kind, None)
 
590
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
591
                                       new_path, old_kind, None)
623
592
        if result is DiffPath.CANNOT_DIFF:
624
593
            return result
625
 
        return DiffPath._diff_many(
626
 
            self.differs, old_path, new_path, None, new_kind)
627
 
 
628
 
 
629
 
class DiffTreeReference(DiffPath):
630
 
 
631
 
    def diff(self, old_path, new_path, old_kind, new_kind):
632
 
        """Perform comparison between two tree references.  (dummy)
633
 
 
634
 
        """
635
 
        if 'tree-reference' not in (old_kind, new_kind):
636
 
            return self.CANNOT_DIFF
637
 
        if old_kind not in ('tree-reference', None):
638
 
            return self.CANNOT_DIFF
639
 
        if new_kind not in ('tree-reference', None):
640
 
            return self.CANNOT_DIFF
641
 
        return self.CHANGED
 
594
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
 
595
                                     None, new_kind)
642
596
 
643
597
 
644
598
class DiffDirectory(DiffPath):
645
599
 
646
 
    def diff(self, old_path, new_path, old_kind, new_kind):
 
600
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
647
601
        """Perform comparison between two directories.  (dummy)
648
602
 
649
603
        """
658
612
 
659
613
class DiffSymlink(DiffPath):
660
614
 
661
 
    def diff(self, old_path, new_path, old_kind, new_kind):
 
615
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
662
616
        """Perform comparison between two symlinks
663
617
 
 
618
        :param file_id: The file_id of the file to compare
664
619
        :param old_path: Path of the file in the old tree
665
620
        :param new_path: Path of the file in the new tree
666
621
        :param old_kind: Old file-kind of the file
669
624
        if 'symlink' not in (old_kind, new_kind):
670
625
            return self.CANNOT_DIFF
671
626
        if old_kind == 'symlink':
672
 
            old_target = self.old_tree.get_symlink_target(old_path)
 
627
            old_target = self.old_tree.get_symlink_target(file_id)
673
628
        elif old_kind is None:
674
629
            old_target = None
675
630
        else:
676
631
            return self.CANNOT_DIFF
677
632
        if new_kind == 'symlink':
678
 
            new_target = self.new_tree.get_symlink_target(new_path)
 
633
            new_target = self.new_tree.get_symlink_target(file_id)
679
634
        elif new_kind is None:
680
635
            new_target = None
681
636
        else:
684
639
 
685
640
    def diff_symlink(self, old_target, new_target):
686
641
        if old_target is None:
687
 
            self.to_file.write(b'=== target is \'%s\'\n' %
688
 
                               new_target.encode(self.path_encoding, 'replace'))
 
642
            self.to_file.write('=== target is %r\n' % new_target)
689
643
        elif new_target is None:
690
 
            self.to_file.write(b'=== target was \'%s\'\n' %
691
 
                               old_target.encode(self.path_encoding, 'replace'))
 
644
            self.to_file.write('=== target was %r\n' % old_target)
692
645
        else:
693
 
            self.to_file.write(b'=== target changed \'%s\' => \'%s\'\n' %
694
 
                               (old_target.encode(self.path_encoding, 'replace'),
695
 
                                new_target.encode(self.path_encoding, 'replace')))
 
646
            self.to_file.write('=== target changed %r => %r\n' %
 
647
                              (old_target, new_target))
696
648
        return self.CHANGED
697
649
 
698
650
 
703
655
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
704
656
 
705
657
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
706
 
                 old_label='', new_label='', text_differ=internal_diff,
707
 
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
 
658
                 old_label='', new_label='', text_differ=internal_diff):
708
659
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
709
660
        self.text_differ = text_differ
710
661
        self.old_label = old_label
711
662
        self.new_label = new_label
712
663
        self.path_encoding = path_encoding
713
 
        self.context_lines = context_lines
714
664
 
715
 
    def diff(self, old_path, new_path, old_kind, new_kind):
 
665
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
716
666
        """Compare two files in unified diff format
717
667
 
 
668
        :param file_id: The file_id of the file to compare
718
669
        :param old_path: Path of the file in the old tree
719
670
        :param new_path: Path of the file in the new tree
720
671
        :param old_kind: Old file-kind of the file
722
673
        """
723
674
        if 'file' not in (old_kind, new_kind):
724
675
            return self.CANNOT_DIFF
 
676
        from_file_id = to_file_id = file_id
725
677
        if old_kind == 'file':
726
 
            old_date = _patch_header_date(self.old_tree, old_path)
 
678
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
727
679
        elif old_kind is None:
728
680
            old_date = self.EPOCH_DATE
 
681
            from_file_id = None
729
682
        else:
730
683
            return self.CANNOT_DIFF
731
684
        if new_kind == 'file':
732
 
            new_date = _patch_header_date(self.new_tree, new_path)
 
685
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
733
686
        elif new_kind is None:
734
687
            new_date = self.EPOCH_DATE
 
688
            to_file_id = None
735
689
        else:
736
690
            return self.CANNOT_DIFF
737
 
        from_label = '%s%s\t%s' % (self.old_label, old_path,
738
 
                                   old_date)
739
 
        to_label = '%s%s\t%s' % (self.new_label, new_path,
740
 
                                 new_date)
741
 
        return self.diff_text(old_path, new_path, from_label, to_label)
 
691
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
692
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
693
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
694
            old_path, new_path)
742
695
 
743
 
    def diff_text(self, from_path, to_path, from_label, to_label):
 
696
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
697
        from_path=None, to_path=None):
744
698
        """Diff the content of given files in two trees
745
699
 
746
 
        :param from_path: The path in the from tree. If None,
 
700
        :param from_file_id: The id of the file in the from tree.  If None,
747
701
            the file is not present in the from tree.
748
 
        :param to_path: The path in the to tree. This may refer
749
 
            to a different file from from_path.  If None,
 
702
        :param to_file_id: The id of the file in the to tree.  This may refer
 
703
            to a different file from from_file_id.  If None,
750
704
            the file is not present in the to tree.
 
705
        :param from_path: The path in the from tree or None if unknown.
 
706
        :param to_path: The path in the to tree or None if unknown.
751
707
        """
752
 
        def _get_text(tree, path):
753
 
            if path is None:
754
 
                return []
755
 
            try:
756
 
                return tree.get_file_lines(path)
757
 
            except errors.NoSuchFile:
 
708
        def _get_text(tree, file_id, path):
 
709
            if file_id is not None:
 
710
                return tree.get_file(file_id, path).readlines()
 
711
            else:
758
712
                return []
759
713
        try:
760
 
            from_text = _get_text(self.old_tree, from_path)
761
 
            to_text = _get_text(self.new_tree, to_path)
 
714
            from_text = _get_text(self.old_tree, from_file_id, from_path)
 
715
            to_text = _get_text(self.new_tree, to_file_id, to_path)
762
716
            self.text_differ(from_label, from_text, to_label, to_text,
763
 
                             self.to_file, path_encoding=self.path_encoding,
764
 
                             context_lines=self.context_lines)
 
717
                             self.to_file)
765
718
        except errors.BinaryFile:
766
719
            self.to_file.write(
767
 
                ("Binary files %s%s and %s%s differ\n" %
768
 
                 (self.old_label, from_path, self.new_label, to_path)).encode(self.path_encoding, 'replace'))
 
720
                  ("Binary files %s and %s differ\n" %
 
721
                  (from_label, to_label)).encode(self.path_encoding))
769
722
        return self.CHANGED
770
723
 
771
724
 
775
728
                 path_encoding='utf-8'):
776
729
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
777
730
        self.command_template = command_template
778
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
731
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
779
732
 
780
733
    @classmethod
781
 
    def from_string(klass, command_template, old_tree, new_tree, to_file,
 
734
    def from_string(klass, command_string, old_tree, new_tree, to_file,
782
735
                    path_encoding='utf-8'):
 
736
        command_template = cmdline.split(command_string)
 
737
        if '@' not in command_string:
 
738
            command_template.extend(['@old_path', '@new_path'])
783
739
        return klass(command_template, old_tree, new_tree, to_file,
784
740
                     path_encoding)
785
741
 
786
742
    @classmethod
787
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
743
    def make_from_diff_tree(klass, command_string):
788
744
        def from_diff_tree(diff_tree):
789
 
            full_command_string = [command_string]
790
 
            if external_diff_options is not None:
791
 
                full_command_string += ' ' + external_diff_options
792
 
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
745
            return klass.from_string(command_string, diff_tree.old_tree,
793
746
                                     diff_tree.new_tree, diff_tree.to_file)
794
747
        return from_diff_tree
795
748
 
796
749
    def _get_command(self, old_path, new_path):
797
750
        my_map = {'old_path': old_path, 'new_path': new_path}
798
 
        command = [t.format(**my_map) for t in
799
 
                   self.command_template]
800
 
        if command == self.command_template:
801
 
            command += [old_path, new_path]
802
 
        if sys.platform == 'win32':  # Popen doesn't accept unicode on win32
803
 
            command_encoded = []
804
 
            for c in command:
805
 
                if isinstance(c, text_type):
806
 
                    command_encoded.append(c.encode('mbcs'))
807
 
                else:
808
 
                    command_encoded.append(c)
809
 
            return command_encoded
810
 
        else:
811
 
            return command
 
751
        return [AtTemplate(t).substitute(my_map) for t in
 
752
                self.command_template]
812
753
 
813
754
    def _execute(self, old_path, new_path):
814
755
        command = self._get_command(old_path, new_path)
815
756
        try:
816
757
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
817
758
                                    cwd=self._root)
818
 
        except OSError as e:
 
759
        except OSError, e:
819
760
            if e.errno == errno.ENOENT:
820
761
                raise errors.ExecutableMissing(command[0])
821
762
            else:
822
763
                raise
823
764
        self.to_file.write(proc.stdout.read())
824
 
        proc.stdout.close()
825
765
        return proc.wait()
826
766
 
827
767
    def _try_symlink_root(self, tree, prefix):
828
 
        if (getattr(tree, 'abspath', None) is None or
829
 
                not osutils.host_os_dereferences_symlinks()):
 
768
        if (getattr(tree, 'abspath', None) is None
 
769
            or not osutils.host_os_dereferences_symlinks()):
830
770
            return False
831
771
        try:
832
772
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
833
 
        except OSError as e:
 
773
        except OSError, e:
834
774
            if e.errno != errno.EEXIST:
835
775
                raise
836
776
        return True
837
777
 
838
 
    @staticmethod
839
 
    def _fenc():
840
 
        """Returns safe encoding for passing file path to diff tool"""
841
 
        if sys.platform == 'win32':
842
 
            return 'mbcs'
843
 
        else:
844
 
            # Don't fallback to 'utf-8' because subprocess may not be able to
845
 
            # handle utf-8 correctly when locale is not utf-8.
846
 
            return sys.getfilesystemencoding() or 'ascii'
847
 
 
848
 
    def _is_safepath(self, path):
849
 
        """Return true if `path` may be able to pass to subprocess."""
850
 
        fenc = self._fenc()
851
 
        try:
852
 
            return path == path.encode(fenc).decode(fenc)
853
 
        except UnicodeError:
854
 
            return False
855
 
 
856
 
    def _safe_filename(self, prefix, relpath):
857
 
        """Replace unsafe character in `relpath` then join `self._root`,
858
 
        `prefix` and `relpath`."""
859
 
        fenc = self._fenc()
860
 
        # encoded_str.replace('?', '_') may break multibyte char.
861
 
        # So we should encode, decode, then replace(u'?', u'_')
862
 
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
863
 
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
864
 
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
865
 
 
866
 
    def _write_file(self, relpath, tree, prefix, force_temp=False,
 
778
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
867
779
                    allow_write=False):
868
780
        if not force_temp and isinstance(tree, WorkingTree):
869
 
            full_path = tree.abspath(relpath)
870
 
            if self._is_safepath(full_path):
871
 
                return full_path
872
 
 
873
 
        full_path = self._safe_filename(prefix, relpath)
 
781
            return tree.abspath(tree.id2path(file_id))
 
782
        
 
783
        full_path = osutils.pathjoin(self._root, prefix, relpath)
874
784
        if not force_temp and self._try_symlink_root(tree, prefix):
875
785
            return full_path
876
786
        parent_dir = osutils.dirname(full_path)
877
787
        try:
878
788
            os.makedirs(parent_dir)
879
 
        except OSError as e:
 
789
        except OSError, e:
880
790
            if e.errno != errno.EEXIST:
881
791
                raise
882
 
        with tree.get_file(relpath) as source, \
883
 
                open(full_path, 'wb') as target:
884
 
            osutils.pumpfile(source, target)
 
792
        source = tree.get_file(file_id, relpath)
885
793
        try:
886
 
            mtime = tree.get_file_mtime(relpath)
887
 
        except FileTimestampUnavailable:
888
 
            pass
889
 
        else:
890
 
            os.utime(full_path, (mtime, mtime))
 
794
            target = open(full_path, 'wb')
 
795
            try:
 
796
                osutils.pumpfile(source, target)
 
797
            finally:
 
798
                target.close()
 
799
        finally:
 
800
            source.close()
891
801
        if not allow_write:
892
802
            osutils.make_readonly(full_path)
 
803
        try:
 
804
            mtime = tree.get_file_mtime(file_id)
 
805
        except errors.FileTimestampUnavailable:
 
806
            mtime = 0
 
807
        os.utime(full_path, (mtime, mtime))
893
808
        return full_path
894
809
 
895
 
    def _prepare_files(self, old_path, new_path, force_temp=False,
 
810
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
896
811
                       allow_write_new=False):
897
 
        old_disk_path = self._write_file(
898
 
            old_path, self.old_tree, 'old', force_temp)
899
 
        new_disk_path = self._write_file(
900
 
            new_path, self.new_tree, 'new', force_temp,
901
 
            allow_write=allow_write_new)
 
812
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
813
                                         old_path, force_temp)
 
814
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
815
                                         new_path, force_temp,
 
816
                                         allow_write=allow_write_new)
902
817
        return old_disk_path, new_disk_path
903
818
 
904
819
    def finish(self):
905
820
        try:
906
821
            osutils.rmtree(self._root)
907
 
        except OSError as e:
 
822
        except OSError, e:
908
823
            if e.errno != errno.ENOENT:
909
824
                mutter("The temporary directory \"%s\" was not "
910
 
                       "cleanly removed: %s." % (self._root, e))
 
825
                        "cleanly removed: %s." % (self._root, e))
911
826
 
912
 
    def diff(self, old_path, new_path, old_kind, new_kind):
 
827
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
913
828
        if (old_kind, new_kind) != ('file', 'file'):
914
829
            return DiffPath.CANNOT_DIFF
915
830
        (old_disk_path, new_disk_path) = self._prepare_files(
916
 
            old_path, new_path)
 
831
                                                file_id, old_path, new_path)
917
832
        self._execute(old_disk_path, new_disk_path)
918
833
 
919
 
    def edit_file(self, old_path, new_path):
 
834
    def edit_file(self, file_id):
920
835
        """Use this tool to edit a file.
921
836
 
922
837
        A temporary copy will be edited, and the new contents will be
923
838
        returned.
924
839
 
 
840
        :param file_id: The id of the file to edit.
925
841
        :return: The new contents of the file.
926
842
        """
927
 
        old_abs_path, new_abs_path = self._prepare_files(
928
 
            old_path, new_path, allow_write_new=True, force_temp=True)
929
 
        command = self._get_command(old_abs_path, new_abs_path)
 
843
        old_path = self.old_tree.id2path(file_id)
 
844
        new_path = self.new_tree.id2path(file_id)
 
845
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
 
846
                                           allow_write_new=True,
 
847
                                           force_temp=True)[1]
 
848
        command = self._get_command(osutils.pathjoin('old', old_path),
 
849
                                    osutils.pathjoin('new', new_path))
930
850
        subprocess.call(command, cwd=self._root)
931
 
        with open(new_abs_path, 'rb') as new_file:
 
851
        new_file = open(new_abs_path, 'r')
 
852
        try:
932
853
            return new_file.read()
 
854
        finally:
 
855
            new_file.close()
933
856
 
934
857
 
935
858
class DiffTree(object):
947
870
    # list of factories that can provide instances of DiffPath objects
948
871
    # may be extended by plugins.
949
872
    diff_factories = [DiffSymlink.from_diff_tree,
950
 
                      DiffDirectory.from_diff_tree,
951
 
                      DiffTreeReference.from_diff_tree]
 
873
                      DiffDirectory.from_diff_tree]
952
874
 
953
875
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
954
876
                 diff_text=None, extra_factories=None):
964
886
            DiffPaths"""
965
887
        if diff_text is None:
966
888
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
967
 
                                 '', '', internal_diff)
 
889
                                 '', '',  internal_diff)
968
890
        self.old_tree = old_tree
969
891
        self.new_tree = new_tree
970
892
        self.to_file = to_file
978
900
    @classmethod
979
901
    def from_trees_options(klass, old_tree, new_tree, to_file,
980
902
                           path_encoding, external_diff_options, old_label,
981
 
                           new_label, using, context_lines):
 
903
                           new_label, using):
982
904
        """Factory for producing a DiffTree.
983
905
 
984
906
        Designed to accept options used by show_diff_trees.
985
 
 
986
907
        :param old_tree: The tree to show as old in the comparison
987
908
        :param new_tree: The tree to show as new in the comparison
988
909
        :param to_file: File to write comparisons to
994
915
        :param using: Commandline to use to invoke an external diff tool
995
916
        """
996
917
        if using is not None:
997
 
            extra_factories = [DiffFromTool.make_from_diff_tree(
998
 
                using, external_diff_options)]
 
918
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
999
919
        else:
1000
920
            extra_factories = []
1001
921
        if external_diff_options:
1002
922
            opts = external_diff_options.split()
1003
 
 
1004
 
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
1005
 
                """:param path_encoding: not used but required
1006
 
                        to match the signature of internal_diff.
1007
 
                """
 
923
            def diff_file(olab, olines, nlab, nlines, to_file):
1008
924
                external_diff(olab, olines, nlab, nlines, to_file, opts)
1009
925
        else:
1010
926
            diff_file = internal_diff
1011
927
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
1012
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
928
                             old_label, new_label, diff_file)
1013
929
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
1014
930
                     extra_factories)
1015
931
 
1029
945
        # TODO: Generation of pseudo-diffs for added/deleted files could
1030
946
        # be usefully made into a much faster special case.
1031
947
        iterator = self.new_tree.iter_changes(self.old_tree,
1032
 
                                              specific_files=specific_files,
1033
 
                                              extra_trees=extra_trees,
1034
 
                                              require_versioned=True)
 
948
                                               specific_files=specific_files,
 
949
                                               extra_trees=extra_trees,
 
950
                                               require_versioned=True)
1035
951
        has_changes = 0
1036
 
 
1037
952
        def changes_key(change):
1038
 
            old_path, new_path = change.path
 
953
            old_path, new_path = change[1]
1039
954
            path = new_path
1040
955
            if path is None:
1041
956
                path = old_path
1042
957
            return path
1043
 
 
1044
958
        def get_encoded_path(path):
1045
959
            if path is not None:
1046
960
                return path.encode(self.path_encoding, "replace")
1047
 
        for change in sorted(iterator, key=changes_key):
 
961
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
962
             executable) in sorted(iterator, key=changes_key):
1048
963
            # The root does not get diffed, and items with no known kind (that
1049
964
            # is, missing) in both trees are skipped as well.
1050
 
            if change.parent_id == (None, None) or change.kind == (None, None):
1051
 
                continue
1052
 
            if change.kind[0] == 'symlink' and not self.new_tree.supports_symlinks():
1053
 
                warning(
1054
 
                    'Ignoring "%s" as symlinks are not '
1055
 
                    'supported on this filesystem.' % (change.path[0],))
1056
 
                continue
1057
 
            oldpath, newpath = change.path
1058
 
            oldpath_encoded = get_encoded_path(change.path[0])
1059
 
            newpath_encoded = get_encoded_path(change.path[1])
1060
 
            old_present = (change.kind[0] is not None and change.versioned[0])
1061
 
            new_present = (change.kind[1] is not None and change.versioned[1])
1062
 
            executable = change.executable
1063
 
            kind = change.kind
1064
 
            renamed = (change.parent_id[0], change.name[0]) != (change.parent_id[1], change.name[1])
 
965
            if parent == (None, None) or kind == (None, None):
 
966
                continue
 
967
            oldpath, newpath = paths
 
968
            oldpath_encoded = get_encoded_path(paths[0])
 
969
            newpath_encoded = get_encoded_path(paths[1])
 
970
            old_present = (kind[0] is not None and versioned[0])
 
971
            new_present = (kind[1] is not None and versioned[1])
 
972
            renamed = (parent[0], name[0]) != (parent[1], name[1])
1065
973
 
1066
974
            properties_changed = []
1067
 
            properties_changed.extend(
1068
 
                get_executable_change(executable[0], executable[1]))
 
975
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
1069
976
 
1070
977
            if properties_changed:
1071
 
                prop_str = b" (properties changed: %s)" % (
1072
 
                    b", ".join(properties_changed),)
 
978
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
1073
979
            else:
1074
 
                prop_str = b""
 
980
                prop_str = ""
1075
981
 
1076
982
            if (old_present, new_present) == (True, False):
1077
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1078
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
983
                self.to_file.write("=== removed %s '%s'\n" %
 
984
                                   (kind[0], oldpath_encoded))
1079
985
                newpath = oldpath
1080
986
            elif (old_present, new_present) == (False, True):
1081
 
                self.to_file.write(b"=== added %s '%s'\n" %
1082
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
987
                self.to_file.write("=== added %s '%s'\n" %
 
988
                                   (kind[1], newpath_encoded))
1083
989
                oldpath = newpath
1084
990
            elif renamed:
1085
 
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
1086
 
                                   (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
 
991
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
992
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1087
993
            else:
1088
994
                # if it was produced by iter_changes, it must be
1089
995
                # modified *somehow*, either content or execute bit.
1090
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
1091
 
                                                                  newpath_encoded, prop_str))
1092
 
            if change.changed_content:
1093
 
                self._diff(oldpath, newpath, kind[0], kind[1])
 
996
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
 
997
                                   newpath_encoded, prop_str))
 
998
            if changed_content:
 
999
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1094
1000
                has_changes = 1
1095
1001
            if renamed:
1096
1002
                has_changes = 1
1097
1003
        return has_changes
1098
1004
 
1099
 
    def diff(self, old_path, new_path):
 
1005
    def diff(self, file_id, old_path, new_path):
1100
1006
        """Perform a diff of a single file
1101
1007
 
 
1008
        :param file_id: file-id of the file
1102
1009
        :param old_path: The path of the file in the old tree
1103
1010
        :param new_path: The path of the file in the new tree
1104
1011
        """
1105
 
        if old_path is None:
 
1012
        try:
 
1013
            old_kind = self.old_tree.kind(file_id)
 
1014
        except (errors.NoSuchId, errors.NoSuchFile):
1106
1015
            old_kind = None
1107
 
        else:
1108
 
            old_kind = self.old_tree.kind(old_path)
1109
 
        if new_path is None:
 
1016
        try:
 
1017
            new_kind = self.new_tree.kind(file_id)
 
1018
        except (errors.NoSuchId, errors.NoSuchFile):
1110
1019
            new_kind = None
1111
 
        else:
1112
 
            new_kind = self.new_tree.kind(new_path)
1113
 
        self._diff(old_path, new_path, old_kind, new_kind)
1114
 
 
1115
 
    def _diff(self, old_path, new_path, old_kind, new_kind):
1116
 
        result = DiffPath._diff_many(
1117
 
            self.differs, old_path, new_path, old_kind, new_kind)
 
1020
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
1021
 
 
1022
 
 
1023
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
1024
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
1025
                                       new_path, old_kind, new_kind)
1118
1026
        if result is DiffPath.CANNOT_DIFF:
1119
1027
            error_path = new_path
1120
1028
            if error_path is None: