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