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