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

Show diffs side-by-side

added added

removed removed

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