/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: Marius Kruger
  • Date: 2010-07-10 21:28:56 UTC
  • mto: (5384.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5385.
  • Revision ID: marius.kruger@enerweb.co.za-20100710212856-uq4ji3go0u5se7hx
* Update documentation
* add NEWS

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