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
25
# compatability - plugins import compare_trees from diff!!!
26
# deprecated as of 0.10
27
from bzrlib.delta import compare_trees
28
from bzrlib.errors import BzrError
29
import bzrlib.errors as errors
31
from bzrlib.patiencediff import unified_diff
32
import bzrlib.patiencediff
33
from bzrlib.symbol_versioning import (deprecated_function,
35
from bzrlib.textfile import check_text_lines
36
from bzrlib.trace import mutter, warning
39
# TODO: Rather than building a changeset object, we should probably
40
# invoke callbacks on an object. That object can either accumulate a
41
# list, write them out directly, etc etc.
43
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
44
allow_binary=False, sequence_matcher=None,
45
path_encoding='utf8'):
46
# FIXME: difflib is wrong if there is no trailing newline.
47
# The syntax used by patch seems to be "\ No newline at
48
# end of file" following the last diff line from that
49
# file. This is not trivial to insert into the
50
# unified_diff output and it might be better to just fix
51
# or replace that function.
53
# In the meantime we at least make sure the patch isn't
57
# Special workaround for Python2.3, where difflib fails if
58
# both sequences are empty.
59
if not oldlines and not newlines:
62
if allow_binary is False:
63
check_text_lines(oldlines)
64
check_text_lines(newlines)
66
if sequence_matcher is None:
67
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
68
ud = unified_diff(oldlines, newlines,
69
fromfile=old_filename.encode(path_encoding),
70
tofile=new_filename.encode(path_encoding),
71
sequencematcher=sequence_matcher)
74
# work-around for difflib being too smart for its own good
75
# if /dev/null is "1,0", patch won't recognize it as /dev/null
77
ud[2] = ud[2].replace('-1,0', '-0,0')
79
ud[2] = ud[2].replace('+1,0', '+0,0')
80
# work around for difflib emitting random spaces after the label
81
ud[0] = ud[0][:-2] + '\n'
82
ud[1] = ud[1][:-2] + '\n'
86
if not line.endswith('\n'):
87
to_file.write("\n\\ No newline at end of file\n")
91
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
93
"""Display a diff by calling out to the external diff program."""
94
# make sure our own output is properly ordered before the diff
97
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
98
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
99
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
100
newtmpf = os.fdopen(newtmp_fd, 'wb')
103
# TODO: perhaps a special case for comparing to or from the empty
104
# sequence; can just use /dev/null on Unix
106
# TODO: if either of the files being compared already exists as a
107
# regular named file (e.g. in the working directory) then we can
108
# compare directly to that, rather than copying it.
110
oldtmpf.writelines(oldlines)
111
newtmpf.writelines(newlines)
119
'--label', old_filename,
121
'--label', new_filename,
126
# diff only allows one style to be specified; they don't override.
127
# note that some of these take optargs, and the optargs can be
128
# directly appended to the options.
129
# this is only an approximate parser; it doesn't properly understand
131
for s in ['-c', '-u', '-C', '-U',
136
'-y', '--side-by-side',
148
diffcmd.extend(diff_opts)
151
pipe = subprocess.Popen(diffcmd,
152
stdin=subprocess.PIPE,
153
stdout=subprocess.PIPE)
155
if e.errno == errno.ENOENT:
156
raise errors.NoDiff(str(e))
160
first_line = pipe.stdout.readline()
161
to_file.write(first_line)
162
bzrlib.osutils.pumpfile(pipe.stdout, to_file)
166
# 'diff' gives retcode == 2 for all sorts of errors
167
# one of those is 'Binary files differ'.
168
# Bad options could also be the problem.
169
# 'Binary files' is not a real error, so we suppress that error
170
m = re.match('^binary files.*differ$', first_line, re.I)
172
raise BzrError('external diff failed with exit code 2;'
173
' command: %r' % (diffcmd,))
174
elif rc not in (0, 1):
175
# returns 1 if files differ; that's OK
177
msg = 'signal %d' % (-rc)
179
msg = 'exit code %d' % rc
181
raise BzrError('external diff failed with %s; command: %r'
184
# internal_diff() adds a trailing newline, add one here for consistency
188
oldtmpf.close() # and delete
190
# Clean up. Warn in case the files couldn't be deleted
191
# (in case windows still holds the file open, but not
192
# if the files have already been deleted)
194
os.remove(old_abspath)
196
if e.errno not in (errno.ENOENT,):
197
warning('Failed to delete temporary file: %s %s',
200
os.remove(new_abspath)
202
if e.errno not in (errno.ENOENT,):
203
warning('Failed to delete temporary file: %s %s',
207
@deprecated_function(zero_eight)
208
def show_diff(b, from_spec, specific_files, external_diff_options=None,
209
revision2=None, output=None, b2=None):
210
"""Shortcut for showing the diff to the working tree.
212
Please use show_diff_trees instead.
218
None for 'basis tree', or otherwise the old revision to compare against.
220
The more general form is show_diff_trees(), where the caller
221
supplies any two trees.
226
if from_spec is None:
227
old_tree = b.bzrdir.open_workingtree()
229
old_tree = old_tree = old_tree.basis_tree()
231
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
233
if revision2 is None:
235
new_tree = b.bzrdir.open_workingtree()
237
new_tree = b2.bzrdir.open_workingtree()
239
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
241
return show_diff_trees(old_tree, new_tree, output, specific_files,
242
external_diff_options)
245
def diff_cmd_helper(tree, specific_files, external_diff_options,
246
old_revision_spec=None, new_revision_spec=None,
247
old_label='a/', new_label='b/'):
248
"""Helper for cmd_diff.
254
The specific files to compare, or None
256
external_diff_options
257
If non-None, run an external diff, and pass it these options
260
If None, use basis tree as old revision, otherwise use the tree for
261
the specified revision.
264
If None, use working tree as new revision, otherwise use the tree for
265
the specified revision.
267
The more general form is show_diff_trees(), where the caller
268
supplies any two trees.
272
revision = spec.in_store(tree.branch)
274
revision = spec.in_store(None)
275
revision_id = revision.rev_id
276
branch = revision.branch
277
return branch.repository.revision_tree(revision_id)
278
if old_revision_spec is None:
279
old_tree = tree.basis_tree()
281
old_tree = spec_tree(old_revision_spec)
283
if new_revision_spec is None:
286
new_tree = spec_tree(new_revision_spec)
287
if new_tree is not tree:
288
extra_trees = (tree,)
292
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
293
external_diff_options,
294
old_label=old_label, new_label=new_label,
295
extra_trees=extra_trees)
298
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
299
external_diff_options=None,
300
old_label='a/', new_label='b/',
302
"""Show in text form the changes from one tree to another.
305
If set, include only changes to these files.
307
external_diff_options
308
If set, use an external GNU diff and pass these options.
311
If set, more Trees to use for looking up file ids
317
return _show_diff_trees(old_tree, new_tree, to_file,
318
specific_files, external_diff_options,
319
old_label=old_label, new_label=new_label,
320
extra_trees=extra_trees)
327
def _show_diff_trees(old_tree, new_tree, to_file,
328
specific_files, external_diff_options,
329
old_label='a/', new_label='b/', extra_trees=None):
331
# GNU Patch uses the epoch date to detect files that are being added
332
# or removed in a diff.
333
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
335
# TODO: Generation of pseudo-diffs for added/deleted files could
336
# be usefully made into a much faster special case.
338
if external_diff_options:
339
assert isinstance(external_diff_options, basestring)
340
opts = external_diff_options.split()
341
def diff_file(olab, olines, nlab, nlines, to_file):
342
external_diff(olab, olines, nlab, nlines, to_file, opts)
344
diff_file = internal_diff
346
delta = new_tree.changes_from(old_tree,
347
specific_files=specific_files,
348
extra_trees=extra_trees, require_versioned=True)
351
for path, file_id, kind in delta.removed:
353
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
354
old_name = '%s%s\t%s' % (old_label, path,
355
_patch_header_date(old_tree, file_id, path))
356
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
357
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
358
new_name, None, None, to_file)
359
for path, file_id, kind in delta.added:
361
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
362
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
363
new_name = '%s%s\t%s' % (new_label, path,
364
_patch_header_date(new_tree, file_id, path))
365
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
366
old_name, None, None, to_file,
368
for (old_path, new_path, file_id, kind,
369
text_modified, meta_modified) in delta.renamed:
371
prop_str = get_prop_change(meta_modified)
372
print >>to_file, '=== renamed %s %r => %r%s' % (
373
kind, old_path.encode('utf8'),
374
new_path.encode('utf8'), prop_str)
375
old_name = '%s%s\t%s' % (old_label, old_path,
376
_patch_header_date(old_tree, file_id,
378
new_name = '%s%s\t%s' % (new_label, new_path,
379
_patch_header_date(new_tree, file_id,
381
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
383
text_modified, kind, to_file, diff_file)
384
for path, file_id, kind, text_modified, meta_modified in delta.modified:
386
prop_str = get_prop_change(meta_modified)
387
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
388
old_name = '%s%s\t%s' % (old_label, path,
389
_patch_header_date(old_tree, file_id, path))
390
new_name = '%s%s\t%s' % (new_label, path,
391
_patch_header_date(new_tree, file_id, path))
393
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
395
True, kind, to_file, diff_file)
400
def _patch_header_date(tree, file_id, path):
401
"""Returns a timestamp suitable for use in a patch header."""
402
tm = time.gmtime(tree.get_file_mtime(file_id, path))
403
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
406
def _raise_if_nonexistent(paths, old_tree, new_tree):
407
"""Complain if paths are not in either inventory or tree.
409
It's OK with the files exist in either tree's inventory, or
410
if they exist in the tree but are not versioned.
412
This can be used by operations such as bzr status that can accept
413
unknown or ignored files.
415
mutter("check paths: %r", paths)
418
s = old_tree.filter_unversioned_files(paths)
419
s = new_tree.filter_unversioned_files(s)
420
s = [path for path in s if not new_tree.has_filename(path)]
422
raise errors.PathsDoNotExist(sorted(s))
425
def get_prop_change(meta_modified):
427
return " (properties changed)"
432
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
433
new_path, new_tree, text_modified,
434
kind, to_file, diff_file):
436
new_entry = new_tree.inventory[file_id]
437
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
