/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/diff.py

  • Committer: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 11:31:40 UTC
  • mfrom: (7143.12.3 annotated-tags)
  • Revision ID: breezy.the.bot@gmail.com-20181116113140-618u04763u0dyxnh
Fix fetching of revisions that are referenced by annotated tags.

Merged from https://code.launchpad.net/~jelmer/brz/annotated-tags/+merge/358536

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/diff.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd.
 
1
# Copyright (C) 2005-2014 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
 
17
19
import difflib
18
20
import os
19
21
import re
20
22
import string
21
23
import sys
22
24
 
23
 
from bzrlib.lazy_import import lazy_import
 
25
from .lazy_import import lazy_import
24
26
lazy_import(globals(), """
25
27
import errno
26
28
import subprocess
27
29
import tempfile
28
 
import time
29
30
 
30
 
from bzrlib import (
31
 
    branch as _mod_branch,
32
 
    bzrdir,
 
31
from breezy import (
33
32
    cmdline,
34
 
    cleanup,
 
33
    controldir,
35
34
    errors,
36
35
    osutils,
37
36
    patiencediff,
40
39
    views,
41
40
    )
42
41
 
43
 
from bzrlib.workingtree import WorkingTree
 
42
from breezy.workingtree import WorkingTree
 
43
from breezy.i18n import gettext
44
44
""")
45
45
 
46
 
from bzrlib.registry import (
 
46
from .registry import (
47
47
    Registry,
48
48
    )
49
 
from bzrlib.symbol_versioning import (
50
 
    deprecated_function,
51
 
    deprecated_in,
52
 
    )
53
 
from bzrlib.trace import mutter, note, warning
54
 
 
 
49
from .sixish import text_type
 
50
from .trace import mutter, note, warning
 
51
from .tree import FileTimestampUnavailable
 
52
 
 
53
 
 
54
DEFAULT_CONTEXT_AMOUNT = 3
55
55
 
56
56
class AtTemplate(string.Template):
57
57
    """Templating class that uses @ instead of $."""
73
73
        self.opcodes = None
74
74
 
75
75
 
76
 
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
76
def internal_diff(old_label, oldlines, new_label, newlines, to_file,
77
77
                  allow_binary=False, sequence_matcher=None,
78
 
                  path_encoding='utf8'):
 
78
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
79
79
    # FIXME: difflib is wrong if there is no trailing newline.
80
80
    # The syntax used by patch seems to be "\ No newline at
81
81
    # end of file" following the last diff line from that
86
86
    # In the meantime we at least make sure the patch isn't
87
87
    # mangled.
88
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
 
 
95
89
    if allow_binary is False:
96
90
        textfile.check_text_lines(oldlines)
97
91
        textfile.check_text_lines(newlines)
98
92
 
99
93
    if sequence_matcher is None:
100
94
        sequence_matcher = patiencediff.PatienceSequenceMatcher
101
 
    ud = patiencediff.unified_diff(oldlines, newlines,
102
 
                      fromfile=old_filename.encode(path_encoding),
103
 
                      tofile=new_filename.encode(path_encoding),
104
 
                      sequencematcher=sequence_matcher)
 
95
    ud = patiencediff.unified_diff_bytes(oldlines, newlines,
 
96
                      fromfile=old_label.encode(path_encoding, 'replace'),
 
97
                      tofile=new_label.encode(path_encoding, 'replace'),
 
98
                      n=context_lines, sequencematcher=sequence_matcher)
105
99
 
106
100
    ud = list(ud)
107
101
    if len(ud) == 0: # Identical contents, nothing to do
109
103
    # work-around for difflib being too smart for its own good
110
104
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
111
105
    if not oldlines:
112
 
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
106
        ud[2] = ud[2].replace(b'-1,0', b'-0,0')
113
107
    elif not newlines:
114
 
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
108
        ud[2] = ud[2].replace(b'+1,0', b'+0,0')
115
109
 
116
110
    for line in ud:
117
111
        to_file.write(line)
118
 
        if not line.endswith('\n'):
119
 
            to_file.write("\n\\ No newline at end of file\n")
120
 
    to_file.write('\n')
 
112
        if not line.endswith(b'\n'):
 
113
            to_file.write(b"\n\\ No newline at end of file\n")
 
114
    to_file.write(b'\n')
121
115
 
122
116
 
123
117
def _spawn_external_diff(diffcmd, capture_errors=True):
124
 
    """Spawn the externall diff process, and return the child handle.
 
118
    """Spawn the external diff process, and return the child handle.
125
119
 
126
120
    :param diffcmd: The command list to spawn
127
121
    :param capture_errors: Capture stderr as well as setting LANG=C
149
143
                                stdout=subprocess.PIPE,
150
144
                                stderr=stderr,
151
145
                                env=env)
152
 
    except OSError, e:
 
146
    except OSError as e:
153
147
        if e.errno == errno.ENOENT:
154
148
            raise errors.NoDiff(str(e))
155
149
        raise
156
150
 
157
151
    return pipe
158
152
 
159
 
 
160
 
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
153
# diff style options as of GNU diff v3.2
 
154
style_option_list = ['-c', '-C', '--context',
 
155
                     '-e', '--ed',
 
156
                     '-f', '--forward-ed',
 
157
                     '-q', '--brief',
 
158
                     '--normal',
 
159
                     '-n', '--rcs',
 
160
                     '-u', '-U', '--unified',
 
161
                     '-y', '--side-by-side',
 
162
                     '-D', '--ifdef']
 
163
 
 
164
def default_style_unified(diff_opts):
 
165
    """Default to unified diff style if alternative not specified in diff_opts.
 
166
 
 
167
        diff only allows one style to be specified; they don't override.
 
168
        Note that some of these take optargs, and the optargs can be
 
169
        directly appended to the options.
 
170
        This is only an approximate parser; it doesn't properly understand
 
171
        the grammar.
 
172
 
 
173
    :param diff_opts: List of options for external (GNU) diff.
 
174
    :return: List of options with default style=='unified'.
 
175
    """
 
176
    for s in style_option_list:
 
177
        for j in diff_opts:
 
178
            if j.startswith(s):
 
179
                break
 
180
        else:
 
181
            continue
 
182
        break
 
183
    else:
 
184
        diff_opts.append('-u')
 
185
    return diff_opts
 
186
 
 
187
 
 
188
def external_diff(old_label, oldlines, new_label, newlines, to_file,
161
189
                  diff_opts):
162
190
    """Display a diff by calling out to the external diff program."""
163
191
    # make sure our own output is properly ordered before the diff
164
192
    to_file.flush()
165
193
 
166
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
167
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
194
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
 
195
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
168
196
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
169
197
    newtmpf = os.fdopen(newtmp_fd, 'wb')
170
198
 
187
215
        if sys.platform == 'win32':
188
216
            # Popen doesn't do the proper encoding for external commands
189
217
            # Since we are dealing with an ANSI api, use mbcs encoding
190
 
            old_filename = old_filename.encode('mbcs')
191
 
            new_filename = new_filename.encode('mbcs')
 
218
            old_label = old_label.encode('mbcs')
 
219
            new_label = new_label.encode('mbcs')
192
220
        diffcmd = ['diff',
193
 
                   '--label', old_filename,
 
221
                   '--label', old_label,
194
222
                   old_abspath,
195
 
                   '--label', new_filename,
 
223
                   '--label', new_label,
196
224
                   new_abspath,
197
225
                   '--binary',
198
226
                  ]
199
227
 
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')
 
228
        diff_opts = default_style_unified(diff_opts)
220
229
 
221
230
        if diff_opts:
222
231
            diffcmd.extend(diff_opts)
223
232
 
224
233
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
225
 
        out,err = pipe.communicate()
 
234
        out, err = pipe.communicate()
226
235
        rc = pipe.returncode
227
236
 
228
237
        # internal_diff() adds a trailing newline, add one here for consistency
229
 
        out += '\n'
 
238
        out += b'\n'
230
239
        if rc == 2:
231
240
            # 'diff' gives retcode == 2 for all sorts of errors
232
241
            # one of those is 'Binary files differ'.
239
248
            out, err = pipe.communicate()
240
249
 
241
250
            # Write out the new i18n diff response
242
 
            to_file.write(out+'\n')
 
251
            to_file.write(out+b'\n')
243
252
            if pipe.returncode != 2:
244
253
                raise errors.BzrError(
245
254
                               'external diff failed with exit code 2'
246
255
                               ' when run with LANG=C and LC_ALL=C,'
247
256
                               ' but not when run natively: %r' % (diffcmd,))
248
257
 
249
 
            first_line = lang_c_out.split('\n', 1)[0]
 
258
            first_line = lang_c_out.split(b'\n', 1)[0]
250
259
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
251
 
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
260
            m = re.match(b'^(binary )?files.*differ$', first_line, re.I)
252
261
            if m is None:
253
262
                raise errors.BzrError('external diff failed with exit code 2;'
254
263
                                      ' command: %r' % (diffcmd,))
267
276
                msg = 'exit code %d' % rc
268
277
 
269
278
            raise errors.BzrError('external diff failed with %s; command: %r'
270
 
                                  % (rc, diffcmd))
 
279
                                  % (msg, diffcmd))
271
280
 
272
281
 
273
282
    finally:
274
283
        oldtmpf.close()                 # and delete
275
284
        newtmpf.close()
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
 
    
 
285
 
 
286
        def cleanup(path):
 
287
            # Warn in case the file couldn't be deleted (in case windows still
 
288
            # holds the file open, but not if the files have already been
 
289
            # deleted)
 
290
            try:
 
291
                os.remove(path)
 
292
            except OSError as e:
 
293
                if e.errno not in (errno.ENOENT,):
 
294
                    warning('Failed to delete temporary file: %s %s', path, e)
 
295
 
 
296
        cleanup(old_abspath)
 
297
        cleanup(new_abspath)
 
298
 
325
299
 
326
300
def get_trees_and_branches_to_diff_locked(
327
301
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
394
368
    if old_url is None:
395
369
        old_url = default_location
396
370
    working_tree, branch, relpath = \
397
 
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
371
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
398
372
    lock_tree_or_branch(working_tree, branch)
399
373
    if consider_relpath and relpath != '':
400
374
        if working_tree is not None and apply_view:
408
382
        new_url = default_location
409
383
    if new_url != old_url:
410
384
        working_tree, branch, relpath = \
411
 
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
385
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
412
386
        lock_tree_or_branch(working_tree, branch)
413
387
        if consider_relpath and relpath != '':
414
388
            if working_tree is not None and apply_view:
420
394
 
421
395
    # Get the specific files (all files is None, no files is [])
422
396
    if make_paths_wt_relative and working_tree is not None:
423
 
        try:
424
 
            from bzrlib.builtins import safe_relpath_files
425
 
            other_paths = safe_relpath_files(working_tree, other_paths,
 
397
        other_paths = working_tree.safe_relpath_files(
 
398
            other_paths,
426
399
            apply_view=apply_view)
427
 
        except errors.FileInWrongBranch:
428
 
            raise errors.BzrCommandError("Files are in different branches")
429
400
    specific_files.extend(other_paths)
430
401
    if len(specific_files) == 0:
431
402
        specific_files = None
435
406
            if view_files:
436
407
                specific_files = view_files
437
408
                view_str = views.view_display_str(view_files)
438
 
                note("*** Ignoring files outside view. View is %s" % view_str)
 
409
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
439
410
 
440
411
    # Get extra trees that ought to be searched for file-ids
441
412
    extra_trees = None
442
413
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
414
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
 
415
    return (old_tree, new_tree, old_branch, new_branch,
 
416
            specific_files, extra_trees)
445
417
 
446
418
 
447
419
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
464
436
                    extra_trees=None,
465
437
                    path_encoding='utf8',
466
438
                    using=None,
467
 
                    format_cls=None):
 
439
                    format_cls=None,
 
440
                    context=DEFAULT_CONTEXT_AMOUNT):
468
441
    """Show in text form the changes from one tree to another.
469
442
 
470
443
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
 
444
    :param specific_files: Include only changes to these files - None for all
472
445
        changes.
473
446
    :param external_diff_options: If set, use an external GNU diff and pass 
474
447
        these options.
477
450
        otherwise is supposed to be utf8
478
451
    :param format_cls: Formatter class (DiffTree subclass)
479
452
    """
 
453
    if context is None:
 
454
        context = DEFAULT_CONTEXT_AMOUNT
480
455
    if format_cls is None:
481
456
        format_cls = DiffTree
482
 
    old_tree.lock_read()
483
 
    try:
 
457
    with old_tree.lock_read():
484
458
        if extra_trees is not None:
485
459
            for tree in extra_trees:
486
460
                tree.lock_read()
489
463
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
490
464
                                                   path_encoding,
491
465
                                                   external_diff_options,
492
 
                                                   old_label, new_label, using)
 
466
                                                   old_label, new_label, using,
 
467
                                                   context_lines=context)
493
468
            return differ.show_diff(specific_files, extra_trees)
494
469
        finally:
495
470
            new_tree.unlock()
496
471
            if extra_trees is not None:
497
472
                for tree in extra_trees:
498
473
                    tree.unlock()
499
 
    finally:
500
 
        old_tree.unlock()
501
474
 
502
475
 
503
476
def _patch_header_date(tree, file_id, path):
504
477
    """Returns a timestamp suitable for use in a patch header."""
505
478
    try:
506
 
        mtime = tree.get_file_mtime(file_id, path)
507
 
    except errors.FileTimestampUnavailable:
 
479
        mtime = tree.get_file_mtime(path, file_id)
 
480
    except FileTimestampUnavailable:
508
481
        mtime = 0
509
482
    return timestamp.format_patch_date(mtime)
510
483
 
511
484
 
512
485
def get_executable_change(old_is_x, new_is_x):
513
 
    descr = { True:"+x", False:"-x", None:"??" }
 
486
    descr = { True:b"+x", False:b"-x", None:b"??" }
514
487
    if old_is_x != new_is_x:
515
 
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
488
        return [b"%s to %s" % (descr[old_is_x], descr[new_is_x],)]
516
489
    else:
517
490
        return []
518
491
 
623
596
        if 'symlink' not in (old_kind, new_kind):
624
597
            return self.CANNOT_DIFF
625
598
        if old_kind == 'symlink':
626
 
            old_target = self.old_tree.get_symlink_target(file_id)
 
599
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
627
600
        elif old_kind is None:
628
601
            old_target = None
629
602
        else:
630
603
            return self.CANNOT_DIFF
631
604
        if new_kind == 'symlink':
632
 
            new_target = self.new_tree.get_symlink_target(file_id)
 
605
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
633
606
        elif new_kind is None:
634
607
            new_target = None
635
608
        else:
638
611
 
639
612
    def diff_symlink(self, old_target, new_target):
640
613
        if old_target is None:
641
 
            self.to_file.write('=== target is %r\n' % new_target)
 
614
            self.to_file.write(b'=== target is \'%s\'\n' %
 
615
                new_target.encode(self.path_encoding, 'replace'))
642
616
        elif new_target is None:
643
 
            self.to_file.write('=== target was %r\n' % old_target)
 
617
            self.to_file.write(b'=== target was \'%s\'\n' %
 
618
                old_target.encode(self.path_encoding, 'replace'))
644
619
        else:
645
 
            self.to_file.write('=== target changed %r => %r\n' %
646
 
                              (old_target, new_target))
 
620
            self.to_file.write(b'=== target changed \'%s\' => \'%s\'\n' %
 
621
                              (old_target.encode(self.path_encoding, 'replace'),
 
622
                               new_target.encode(self.path_encoding, 'replace')))
647
623
        return self.CHANGED
648
624
 
649
625
 
653
629
    # or removed in a diff.
654
630
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
655
631
 
656
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
657
 
                 old_label='', new_label='', text_differ=internal_diff):
 
632
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8', 
 
633
                 old_label='', new_label='', text_differ=internal_diff, 
 
634
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
658
635
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
659
636
        self.text_differ = text_differ
660
637
        self.old_label = old_label
661
638
        self.new_label = new_label
662
639
        self.path_encoding = path_encoding
 
640
        self.context_lines = context_lines
663
641
 
664
642
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
665
643
        """Compare two files in unified diff format
687
665
            to_file_id = None
688
666
        else:
689
667
            return self.CANNOT_DIFF
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)
 
668
        from_label = '%s%s\t%s' % (self.old_label, old_path,
 
669
                old_date)
 
670
        to_label = '%s%s\t%s' % (self.new_label, new_path,
 
671
                new_date)
 
672
        return self.diff_text(old_path, new_path, from_label, to_label,
 
673
            from_file_id, to_file_id)
694
674
 
695
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
 
        from_path=None, to_path=None):
 
675
    def diff_text(self, from_path, to_path, from_label, to_label,
 
676
        from_file_id=None, to_file_id=None):
697
677
        """Diff the content of given files in two trees
698
678
 
699
 
        :param from_file_id: The id of the file in the from tree.  If None,
 
679
        :param from_path: The path in the from tree. If None,
700
680
            the file is not present in the from tree.
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,
 
681
        :param to_path: The path in the to tree. This may refer
 
682
            to a different file from from_path.  If None,
703
683
            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.
 
684
        :param from_file_id: The id of the file in the from tree or None if
 
685
            unknown.
 
686
        :param to_file_id: The id of the file in the to tree or None if
 
687
            unknown.
706
688
        """
707
689
        def _get_text(tree, file_id, path):
708
 
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
710
 
            else:
 
690
            if file_id is None:
711
691
                return []
 
692
            return tree.get_file_lines(path, file_id)
712
693
        try:
713
694
            from_text = _get_text(self.old_tree, from_file_id, from_path)
714
695
            to_text = _get_text(self.new_tree, to_file_id, to_path)
715
696
            self.text_differ(from_label, from_text, to_label, to_text,
716
 
                             self.to_file)
 
697
                             self.to_file, path_encoding=self.path_encoding,
 
698
                             context_lines=self.context_lines)
717
699
        except errors.BinaryFile:
718
700
            self.to_file.write(
719
701
                  ("Binary files %s and %s differ\n" %
720
 
                  (from_label, to_label)).encode(self.path_encoding))
 
702
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
721
703
        return self.CHANGED
722
704
 
723
705
 
727
709
                 path_encoding='utf-8'):
728
710
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
711
        self.command_template = command_template
730
 
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
 
712
        self._root = osutils.mkdtemp(prefix='brz-diff-')
731
713
 
732
714
    @classmethod
733
715
    def from_string(klass, command_string, old_tree, new_tree, to_file,
739
721
                     path_encoding)
740
722
 
741
723
    @classmethod
742
 
    def make_from_diff_tree(klass, command_string):
 
724
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
725
        def from_diff_tree(diff_tree):
744
 
            return klass.from_string(command_string, diff_tree.old_tree,
 
726
            full_command_string = [command_string]
 
727
            if external_diff_options is not None:
 
728
                full_command_string += ' ' + external_diff_options
 
729
            return klass.from_string(full_command_string, diff_tree.old_tree,
745
730
                                     diff_tree.new_tree, diff_tree.to_file)
746
731
        return from_diff_tree
747
732
 
748
733
    def _get_command(self, old_path, new_path):
749
734
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
735
        command = [AtTemplate(t).substitute(my_map) for t in
 
736
                   self.command_template]
 
737
        if sys.platform == 'win32': # Popen doesn't accept unicode on win32
 
738
            command_encoded = []
 
739
            for c in command:
 
740
                if isinstance(c, text_type):
 
741
                    command_encoded.append(c.encode('mbcs'))
 
742
                else:
 
743
                    command_encoded.append(c)
 
744
            return command_encoded
 
745
        else:
 
746
            return command
752
747
 
753
748
    def _execute(self, old_path, new_path):
754
749
        command = self._get_command(old_path, new_path)
755
750
        try:
756
751
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
757
752
                                    cwd=self._root)
758
 
        except OSError, e:
 
753
        except OSError as e:
759
754
            if e.errno == errno.ENOENT:
760
755
                raise errors.ExecutableMissing(command[0])
761
756
            else:
762
757
                raise
763
758
        self.to_file.write(proc.stdout.read())
 
759
        proc.stdout.close()
764
760
        return proc.wait()
765
761
 
766
762
    def _try_symlink_root(self, tree, prefix):
769
765
            return False
770
766
        try:
771
767
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
772
 
        except OSError, e:
 
768
        except OSError as e:
773
769
            if e.errno != errno.EEXIST:
774
770
                raise
775
771
        return True
776
772
 
777
 
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
 
                    allow_write=False):
 
773
    @staticmethod
 
774
    def _fenc():
 
775
        """Returns safe encoding for passing file path to diff tool"""
 
776
        if sys.platform == 'win32':
 
777
            return 'mbcs'
 
778
        else:
 
779
            # Don't fallback to 'utf-8' because subprocess may not be able to
 
780
            # handle utf-8 correctly when locale is not utf-8.
 
781
            return sys.getfilesystemencoding() or 'ascii'
 
782
 
 
783
    def _is_safepath(self, path):
 
784
        """Return true if `path` may be able to pass to subprocess."""
 
785
        fenc = self._fenc()
 
786
        try:
 
787
            return path == path.encode(fenc).decode(fenc)
 
788
        except UnicodeError:
 
789
            return False
 
790
 
 
791
    def _safe_filename(self, prefix, relpath):
 
792
        """Replace unsafe character in `relpath` then join `self._root`,
 
793
        `prefix` and `relpath`."""
 
794
        fenc = self._fenc()
 
795
        # encoded_str.replace('?', '_') may break multibyte char.
 
796
        # So we should encode, decode, then replace(u'?', u'_')
 
797
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
 
798
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
 
799
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
 
800
 
 
801
    def _write_file(self, relpath, tree, prefix, force_temp=False,
 
802
                    allow_write=False, file_id=None):
779
803
        if not force_temp and isinstance(tree, WorkingTree):
780
 
            return tree.abspath(tree.id2path(file_id))
781
 
        
782
 
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
804
            full_path = tree.abspath(relpath)
 
805
            if self._is_safepath(full_path):
 
806
                return full_path
 
807
 
 
808
        full_path = self._safe_filename(prefix, relpath)
783
809
        if not force_temp and self._try_symlink_root(tree, prefix):
784
810
            return full_path
785
811
        parent_dir = osutils.dirname(full_path)
786
812
        try:
787
813
            os.makedirs(parent_dir)
788
 
        except OSError, e:
 
814
        except OSError as e:
789
815
            if e.errno != errno.EEXIST:
790
816
                raise
791
 
        source = tree.get_file(file_id, relpath)
 
817
        source = tree.get_file(relpath, file_id)
792
818
        try:
793
 
            target = open(full_path, 'wb')
794
 
            try:
 
819
            with open(full_path, 'wb') as target:
795
820
                osutils.pumpfile(source, target)
796
 
            finally:
797
 
                target.close()
798
821
        finally:
799
822
            source.close()
800
823
        try:
801
 
            mtime = tree.get_file_mtime(file_id)
802
 
        except errors.FileTimestampUnavailable:
 
824
            mtime = tree.get_file_mtime(relpath, file_id)
 
825
        except FileTimestampUnavailable:
803
826
            pass
804
827
        else:
805
828
            os.utime(full_path, (mtime, mtime))
807
830
            osutils.make_readonly(full_path)
808
831
        return full_path
809
832
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
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,
 
833
    def _prepare_files(self, old_path, new_path, force_temp=False,
 
834
                       allow_write_new=False, file_id=None):
 
835
        old_disk_path = self._write_file(old_path, self.old_tree, 'old',
 
836
                                         force_temp, file_id=file_id)
 
837
        new_disk_path = self._write_file(new_path, self.new_tree, 'new',
 
838
                                         force_temp, file_id=file_id,
816
839
                                         allow_write=allow_write_new)
817
840
        return old_disk_path, new_disk_path
818
841
 
819
842
    def finish(self):
820
843
        try:
821
844
            osutils.rmtree(self._root)
822
 
        except OSError, e:
 
845
        except OSError as e:
823
846
            if e.errno != errno.ENOENT:
824
847
                mutter("The temporary directory \"%s\" was not "
825
848
                        "cleanly removed: %s." % (self._root, e))
828
851
        if (old_kind, new_kind) != ('file', 'file'):
829
852
            return DiffPath.CANNOT_DIFF
830
853
        (old_disk_path, new_disk_path) = self._prepare_files(
831
 
                                                file_id, old_path, new_path)
 
854
                old_path, new_path, file_id=file_id)
832
855
        self._execute(old_disk_path, new_disk_path)
833
856
 
834
 
    def edit_file(self, file_id):
 
857
    def edit_file(self, old_path, new_path, file_id=None):
835
858
        """Use this tool to edit a file.
836
859
 
837
860
        A temporary copy will be edited, and the new contents will be
840
863
        :param file_id: The id of the file to edit.
841
864
        :return: The new contents of the file.
842
865
        """
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))
 
866
        old_abs_path, new_abs_path = self._prepare_files(
 
867
                old_path, new_path, allow_write_new=True, force_temp=True,
 
868
                file_id=file_id)
 
869
        command = self._get_command(old_abs_path, new_abs_path)
850
870
        subprocess.call(command, cwd=self._root)
851
 
        new_file = open(new_abs_path, 'r')
852
 
        try:
 
871
        with open(new_abs_path, 'rb') as new_file:
853
872
            return new_file.read()
854
 
        finally:
855
 
            new_file.close()
856
873
 
857
874
 
858
875
class DiffTree(object):
900
917
    @classmethod
901
918
    def from_trees_options(klass, old_tree, new_tree, to_file,
902
919
                           path_encoding, external_diff_options, old_label,
903
 
                           new_label, using):
 
920
                           new_label, using, context_lines):
904
921
        """Factory for producing a DiffTree.
905
922
 
906
923
        Designed to accept options used by show_diff_trees.
 
924
 
907
925
        :param old_tree: The tree to show as old in the comparison
908
926
        :param new_tree: The tree to show as new in the comparison
909
927
        :param to_file: File to write comparisons to
915
933
        :param using: Commandline to use to invoke an external diff tool
916
934
        """
917
935
        if using is not None:
918
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
936
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
919
937
        else:
920
938
            extra_factories = []
921
939
        if external_diff_options:
922
940
            opts = external_diff_options.split()
923
 
            def diff_file(olab, olines, nlab, nlines, to_file):
 
941
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
 
942
                """:param path_encoding: not used but required
 
943
                        to match the signature of internal_diff.
 
944
                """
924
945
                external_diff(olab, olines, nlab, nlines, to_file, opts)
925
946
        else:
926
947
            diff_file = internal_diff
927
948
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
928
 
                             old_label, new_label, diff_file)
 
949
                             old_label, new_label, diff_file, context_lines=context_lines)
929
950
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
930
951
                     extra_factories)
931
952
 
975
996
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
976
997
 
977
998
            if properties_changed:
978
 
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
 
999
                prop_str = b" (properties changed: %s)" % (
 
1000
                        b", ".join(properties_changed),)
979
1001
            else:
980
 
                prop_str = ""
 
1002
                prop_str = b""
981
1003
 
982
1004
            if (old_present, new_present) == (True, False):
983
 
                self.to_file.write("=== removed %s '%s'\n" %
984
 
                                   (kind[0], oldpath_encoded))
 
1005
                self.to_file.write(b"=== removed %s '%s'\n" %
 
1006
                                   (kind[0].encode('ascii'), oldpath_encoded))
985
1007
                newpath = oldpath
986
1008
            elif (old_present, new_present) == (False, True):
987
 
                self.to_file.write("=== added %s '%s'\n" %
988
 
                                   (kind[1], newpath_encoded))
 
1009
                self.to_file.write(b"=== added %s '%s'\n" %
 
1010
                                   (kind[1].encode('ascii'), newpath_encoded))
989
1011
                oldpath = newpath
990
1012
            elif renamed:
991
 
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
992
 
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
 
1013
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
 
1014
                    (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
993
1015
            else:
994
1016
                # if it was produced by iter_changes, it must be
995
1017
                # modified *somehow*, either content or execute bit.
996
 
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
 
1018
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
997
1019
                                   newpath_encoded, prop_str))
998
1020
            if changed_content:
999
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
 
1021
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
1000
1022
                has_changes = 1
1001
1023
            if renamed:
1002
1024
                has_changes = 1
1009
1031
        :param old_path: The path of the file in the old tree
1010
1032
        :param new_path: The path of the file in the new tree
1011
1033
        """
1012
 
        try:
1013
 
            old_kind = self.old_tree.kind(file_id)
1014
 
        except (errors.NoSuchId, errors.NoSuchFile):
 
1034
        if old_path is None:
1015
1035
            old_kind = None
1016
 
        try:
1017
 
            new_kind = self.new_tree.kind(file_id)
1018
 
        except (errors.NoSuchId, errors.NoSuchFile):
 
1036
        else:
 
1037
            old_kind = self.old_tree.kind(old_path, file_id)
 
1038
        if new_path is None:
1019
1039
            new_kind = None
1020
 
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
1021
 
 
1022
 
 
1023
 
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
1040
        else:
 
1041
            new_kind = self.new_tree.kind(new_path, file_id)
 
1042
        self._diff(old_path, new_path, old_kind, new_kind, file_id=file_id)
 
1043
 
 
1044
    def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
1024
1045
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
 
                                       new_path, old_kind, new_kind)
 
1046
                                     new_path, old_kind, new_kind)
1026
1047
        if result is DiffPath.CANNOT_DIFF:
1027
1048
            error_path = new_path
1028
1049
            if error_path is None: