1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21
from bzrlib.lazy_import import lazy_import
22
lazy_import(globals(), """
36
# compatability - plugins import compare_trees from diff!!!
37
# deprecated as of 0.10
38
from bzrlib.delta import compare_trees
39
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
46
# TODO: Rather than building a changeset object, we should probably
47
# invoke callbacks on an object. That object can either accumulate a
48
# list, write them out directly, etc etc.
50
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
51
allow_binary=False, sequence_matcher=None,
52
path_encoding='utf8'):
53
# FIXME: difflib is wrong if there is no trailing newline.
54
# The syntax used by patch seems to be "\ No newline at
55
# end of file" following the last diff line from that
56
# file. This is not trivial to insert into the
57
# unified_diff output and it might be better to just fix
58
# or replace that function.
60
# In the meantime we at least make sure the patch isn't
64
# Special workaround for Python2.3, where difflib fails if
65
# both sequences are empty.
66
if not oldlines and not newlines:
69
if allow_binary is False:
70
textfile.check_text_lines(oldlines)
71
textfile.check_text_lines(newlines)
73
if sequence_matcher is None:
74
sequence_matcher = patiencediff.PatienceSequenceMatcher
75
ud = patiencediff.unified_diff(oldlines, newlines,
76
fromfile=old_filename.encode(path_encoding),
77
tofile=new_filename.encode(path_encoding),
78
sequencematcher=sequence_matcher)
81
# work-around for difflib being too smart for its own good
82
# if /dev/null is "1,0", patch won't recognize it as /dev/null
84
ud[2] = ud[2].replace('-1,0', '-0,0')
86
ud[2] = ud[2].replace('+1,0', '+0,0')
87
# work around for difflib emitting random spaces after the label
88
ud[0] = ud[0][:-2] + '\n'
89
ud[1] = ud[1][:-2] + '\n'
93
if not line.endswith('\n'):
94
to_file.write("\n\\ No newline at end of file\n")
99
"""Set the env vars LANG=C and LC_ALL=C."""
100
osutils.set_or_unset_env('LANG', 'C')
101
osutils.set_or_unset_env('LC_ALL', 'C')
102
osutils.set_or_unset_env('LC_CTYPE', None)
103
osutils.set_or_unset_env('LANGUAGE', None)
106
def _spawn_external_diff(diffcmd, capture_errors=True):
107
"""Spawn the externall diff process, and return the child handle.
109
:param diffcmd: The command list to spawn
110
:param capture_errors: Capture stderr as well as setting LANG=C
111
and LC_ALL=C. This lets us read and understand the output of diff,
112
and respond to any errors.
113
:return: A Popen object.
116
if sys.platform == 'win32':
117
# Win32 doesn't support preexec_fn, but that is
118
# okay, because it doesn't support LANG and LC_ALL either.
121
preexec_fn = _set_lang_C
122
stderr = subprocess.PIPE
128
pipe = subprocess.Popen(diffcmd,
129
stdin=subprocess.PIPE,
130
stdout=subprocess.PIPE,
132
preexec_fn=preexec_fn)
134
if e.errno == errno.ENOENT:
135
raise errors.NoDiff(str(e))
141
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
143
"""Display a diff by calling out to the external diff program."""
144
# make sure our own output is properly ordered before the diff
147
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
148
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
149
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
150
newtmpf = os.fdopen(newtmp_fd, 'wb')
153
# TODO: perhaps a special case for comparing to or from the empty
154
# sequence; can just use /dev/null on Unix
156
# TODO: if either of the files being compared already exists as a
157
# regular named file (e.g. in the working directory) then we can
158
# compare directly to that, rather than copying it.
160
oldtmpf.writelines(oldlines)
161
newtmpf.writelines(newlines)
169
'--label', old_filename,
171
'--label', new_filename,
176
# diff only allows one style to be specified; they don't override.
177
# note that some of these take optargs, and the optargs can be
178
# directly appended to the options.
179
# this is only an approximate parser; it doesn't properly understand
181
for s in ['-c', '-u', '-C', '-U',
186
'-y', '--side-by-side',
198
diffcmd.extend(diff_opts)
200
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
201
out,err = pipe.communicate()
204
# internal_diff() adds a trailing newline, add one here for consistency
207
# 'diff' gives retcode == 2 for all sorts of errors
208
# one of those is 'Binary files differ'.
209
# Bad options could also be the problem.
210
# 'Binary files' is not a real error, so we suppress that error.
213
# Since we got here, we want to make sure to give an i18n error
214
pipe = _spawn_external_diff(diffcmd, capture_errors=False)
215
out, err = pipe.communicate()
217
# Write out the new i18n diff response
218
to_file.write(out+'\n')
219
if pipe.returncode != 2:
220
raise errors.BzrError(
221
'external diff failed with exit code 2'
222
' when run with LANG=C and LC_ALL=C,'
223
' but not when run natively: %r' % (diffcmd,))
225
first_line = lang_c_out.split('\n', 1)[0]
226
# Starting with diffutils 2.8.4 the word "binary" was dropped.
227
m = re.match('^(binary )?files.*differ$', first_line, re.I)
229
raise errors.BzrError('external diff failed with exit code 2;'
230
' command: %r' % (diffcmd,))
232
# Binary files differ, just return
235
# If we got to here, we haven't written out the output of diff
239
# returns 1 if files differ; that's OK
241
msg = 'signal %d' % (-rc)
243
msg = 'exit code %d' % rc
245
raise errors.BzrError('external diff failed with %s; command: %r'
250
oldtmpf.close() # and delete
252
# Clean up. Warn in case the files couldn't be deleted
253
# (in case windows still holds the file open, but not
254
# if the files have already been deleted)
256
os.remove(old_abspath)
258
if e.errno not in (errno.ENOENT,):
259
warning('Failed to delete temporary file: %s %s',
262
os.remove(new_abspath)
264
if e.errno not in (errno.ENOENT,):
265
warning('Failed to delete temporary file: %s %s',
269
@deprecated_function(zero_eight)
270
def show_diff(b, from_spec, specific_files, external_diff_options=None,
271
revision2=None, output=None, b2=None):
272
"""Shortcut for showing the diff to the working tree.
274
Please use show_diff_trees instead.
280
None for 'basis tree', or otherwise the old revision to compare against.
282
The more general form is show_diff_trees(), where the caller
283
supplies any two trees.
288
if from_spec is None:
289
old_tree = b.bzrdir.open_workingtree()
291
old_tree = old_tree = old_tree.basis_tree()
293
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
295
if revision2 is None:
297
new_tree = b.bzrdir.open_workingtree()
299
new_tree = b2.bzrdir.open_workingtree()
301
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
303
return show_diff_trees(old_tree, new_tree, output, specific_files,
304
external_diff_options)
307
def diff_cmd_helper(tree, specific_files, external_diff_options,
308
old_revision_spec=None, new_revision_spec=None,
310
old_label='a/', new_label='b/'):
311
"""Helper for cmd_diff.
316
:param specific_files:
317
The specific files to compare, or None
319
:param external_diff_options:
320
If non-None, run an external diff, and pass it these options
322
:param old_revision_spec:
323
If None, use basis tree as old revision, otherwise use the tree for
324
the specified revision.
326
:param new_revision_spec:
327
If None, use working tree as new revision, otherwise use the tree for
328
the specified revision.
330
:param revision_specs:
331
Zero, one or two RevisionSpecs from the command line, saying what revisions
332
to compare. This can be passed as an alternative to the old_revision_spec
333
and new_revision_spec parameters.
335
The more general form is show_diff_trees(), where the caller
336
supplies any two trees.
339
# TODO: perhaps remove the old parameters old_revision_spec and
340
# new_revision_spec, since this is only really for use from cmd_diff and
341
# it now always passes through a sequence of revision_specs -- mbp
346
revision = spec.in_store(tree.branch)
348
revision = spec.in_store(None)
349
revision_id = revision.rev_id
350
branch = revision.branch
351
return branch.repository.revision_tree(revision_id)
353
if revision_specs is not None:
354
assert (old_revision_spec is None
355
and new_revision_spec is None)
356
if len(revision_specs) > 0:
357
old_revision_spec = revision_specs[0]
358
if len(revision_specs) > 1:
359
new_revision_spec = revision_specs[1]
361
if old_revision_spec is None:
362
old_tree = tree.basis_tree()
364
old_tree = spec_tree(old_revision_spec)
366
if (new_revision_spec is None
367
or new_revision_spec.spec is None):
370
new_tree = spec_tree(new_revision_spec)
372
if new_tree is not tree:
373
extra_trees = (tree,)
377
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
378
external_diff_options,
379
old_label=old_label, new_label=new_label,
380
extra_trees=extra_trees)
383
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
384
external_diff_options=None,
385
old_label='a/', new_label='b/',
387
"""Show in text form the changes from one tree to another.
390
If set, include only changes to these files.
392
external_diff_options
393
If set, use an external GNU diff and pass these options.
396
If set, more Trees to use for looking up file ids
402
return _show_diff_trees(old_tree, new_tree, to_file,
403
specific_files, external_diff_options,
404
old_label=old_label, new_label=new_label,
405
extra_trees=extra_trees)
412
def _show_diff_trees(old_tree, new_tree, to_file,
413
specific_files, external_diff_options,
414
old_label='a/', new_label='b/', extra_trees=None):
416
# GNU Patch uses the epoch date to detect files that are being added
417
# or removed in a diff.
418
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
420
# TODO: Generation of pseudo-diffs for added/deleted files could
421
# be usefully made into a much faster special case.
423
if external_diff_options:
424
assert isinstance(external_diff_options, basestring)
425
opts = external_diff_options.split()
426
def diff_file(olab, olines, nlab, nlines, to_file):
427
external_diff(olab, olines, nlab, nlines, to_file, opts)
429
diff_file = internal_diff
431
delta = new_tree.changes_from(old_tree,
432
specific_files=specific_files,
433
extra_trees=extra_trees, require_versioned=True)
436
for path, file_id, kind in delta.removed:
438
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
439
old_name = '%s%s\t%s' % (old_label, path,
440
_patch_header_date(old_tree, file_id, path))
441
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
442
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
443
new_name, None, None, to_file)
444
for path, file_id, kind in delta.added:
446
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
447
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
448
new_name = '%s%s\t%s' % (new_label, path,
449
_patch_header_date(new_tree, file_id, path))
450
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
451
old_name, None, None, to_file,
453
for (old_path, new_path, file_id, kind,
454
text_modified, meta_modified) in delta.renamed:
456
prop_str = get_prop_change(meta_modified)
457
print >>to_file, '=== renamed %s %r => %r%s' % (
458
kind, old_path.encode('utf8'),
459
new_path.encode('utf8'), prop_str)
460
old_name = '%s%s\t%s' % (old_label, old_path,
461
_patch_header_date(old_tree, file_id,
463
new_name = '%s%s\t%s' % (new_label, new_path,
464
_patch_header_date(new_tree, file_id,
466
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
468
text_modified, kind, to_file, diff_file)
469
for path, file_id, kind, text_modified, meta_modified in delta.modified:
471
prop_str = get_prop_change(meta_modified)
472
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
473
old_name = '%s%s\t%s' % (old_label, path,
474
_patch_header_date(old_tree, file_id, path))
475
new_name = '%s%s\t%s' % (new_label, path,
476
_patch_header_date(new_tree, file_id, path))
478
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
480
True, kind, to_file, diff_file)
485
def _patch_header_date(tree, file_id, path):
486
"""Returns a timestamp suitable for use in a patch header."""
487
tm = time.gmtime(tree.get_file_mtime(file_id, path))
488
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
491
def _raise_if_nonexistent(paths, old_tree, new_tree):
492
"""Complain if paths are not in either inventory or tree.
494
It's OK with the files exist in either tree's inventory, or
495
if they exist in the tree but are not versioned.
497
This can be used by operations such as bzr status that can accept
498
unknown or ignored files.
500
mutter("check paths: %r", paths)
503
s = old_tree.filter_unversioned_files(paths)
504
s = new_tree.filter_unversioned_files(s)
505
s = [path for path in s if not new_tree.has_filename(path)]
507
raise errors.PathsDoNotExist(sorted(s))
510
def get_prop_change(meta_modified):
512
return " (properties changed)"
517
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
518
new_path, new_tree, text_modified,
519
kind, to_file, diff_file):
521
new_entry = new_tree.inventory[file_id]
522
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
