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
24
from bzrlib.delta import compare_trees
25
from bzrlib.errors import BzrError
26
import bzrlib.errors as errors
28
from bzrlib.patiencediff import unified_diff
29
import bzrlib.patiencediff
30
from bzrlib.symbol_versioning import (deprecated_function,
32
from bzrlib.textfile import check_text_lines
33
from bzrlib.trace import mutter, warning
36
# TODO: Rather than building a changeset object, we should probably
37
# invoke callbacks on an object. That object can either accumulate a
38
# list, write them out directly, etc etc.
40
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
41
allow_binary=False, sequence_matcher=None,
42
path_encoding='utf8'):
43
# FIXME: difflib is wrong if there is no trailing newline.
44
# The syntax used by patch seems to be "\ No newline at
45
# end of file" following the last diff line from that
46
# file. This is not trivial to insert into the
47
# unified_diff output and it might be better to just fix
48
# or replace that function.
50
# In the meantime we at least make sure the patch isn't
54
# Special workaround for Python2.3, where difflib fails if
55
# both sequences are empty.
56
if not oldlines and not newlines:
59
if allow_binary is False:
60
check_text_lines(oldlines)
61
check_text_lines(newlines)
63
if sequence_matcher is None:
64
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
65
ud = unified_diff(oldlines, newlines,
66
fromfile=old_filename.encode(path_encoding),
67
tofile=new_filename.encode(path_encoding),
68
sequencematcher=sequence_matcher)
71
# work-around for difflib being too smart for its own good
72
# if /dev/null is "1,0", patch won't recognize it as /dev/null
74
ud[2] = ud[2].replace('-1,0', '-0,0')
76
ud[2] = ud[2].replace('+1,0', '+0,0')
77
# work around for difflib emitting random spaces after the label
78
ud[0] = ud[0][:-2] + '\n'
79
ud[1] = ud[1][:-2] + '\n'
83
if not line.endswith('\n'):
84
to_file.write("\n\\ No newline at end of file\n")
88
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
90
"""Display a diff by calling out to the external diff program."""
91
if hasattr(to_file, 'fileno'):
95
out_file = subprocess.PIPE
98
# make sure our own output is properly ordered before the diff
101
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
102
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
103
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
104
newtmpf = os.fdopen(newtmp_fd, 'wb')
107
# TODO: perhaps a special case for comparing to or from the empty
108
# sequence; can just use /dev/null on Unix
110
# TODO: if either of the files being compared already exists as a
111
# regular named file (e.g. in the working directory) then we can
112
# compare directly to that, rather than copying it.
114
oldtmpf.writelines(oldlines)
115
newtmpf.writelines(newlines)
123
'--label', old_filename,
125
'--label', new_filename,
130
# diff only allows one style to be specified; they don't override.
131
# note that some of these take optargs, and the optargs can be
132
# directly appended to the options.
133
# this is only an approximate parser; it doesn't properly understand
135
for s in ['-c', '-u', '-C', '-U',
140
'-y', '--side-by-side',
152
diffcmd.extend(diff_opts)
155
pipe = subprocess.Popen(diffcmd,
156
stdin=subprocess.PIPE,
159
if e.errno == errno.ENOENT:
160
raise errors.NoDiff(str(e))
165
bzrlib.osutils.pumpfile(pipe.stdout, to_file)
168
if rc != 0 and rc != 1:
169
# returns 1 if files differ; that's OK
171
msg = 'signal %d' % (-rc)
173
msg = 'exit code %d' % rc
175
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
177
oldtmpf.close() # and delete
179
# Clean up. Warn in case the files couldn't be deleted
180
# (in case windows still holds the file open, but not
181
# if the files have already been deleted)
183
os.remove(old_abspath)
185
if e.errno not in (errno.ENOENT,):
186
warning('Failed to delete temporary file: %s %s',
189
os.remove(new_abspath)
191
if e.errno not in (errno.ENOENT,):
192
warning('Failed to delete temporary file: %s %s',
196
@deprecated_function(zero_eight)
197
def show_diff(b, from_spec, specific_files, external_diff_options=None,
198
revision2=None, output=None, b2=None):
199
"""Shortcut for showing the diff to the working tree.
201
Please use show_diff_trees instead.
207
None for 'basis tree', or otherwise the old revision to compare against.
209
The more general form is show_diff_trees(), where the caller
210
supplies any two trees.
215
if from_spec is None:
216
old_tree = b.bzrdir.open_workingtree()
218
old_tree = old_tree = old_tree.basis_tree()
220
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
222
if revision2 is None:
224
new_tree = b.bzrdir.open_workingtree()
226
new_tree = b2.bzrdir.open_workingtree()
228
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
230
return show_diff_trees(old_tree, new_tree, output, specific_files,
231
external_diff_options)
234
def diff_cmd_helper(tree, specific_files, external_diff_options,
235
old_revision_spec=None, new_revision_spec=None,
236
old_label='a/', new_label='b/'):
237
"""Helper for cmd_diff.
243
The specific files to compare, or None
245
external_diff_options
246
If non-None, run an external diff, and pass it these options
249
If None, use basis tree as old revision, otherwise use the tree for
250
the specified revision.
253
If None, use working tree as new revision, otherwise use the tree for
254
the specified revision.
256
The more general form is show_diff_trees(), where the caller
257
supplies any two trees.
261
revision = spec.in_store(tree.branch)
263
revision = spec.in_store(None)
264
revision_id = revision.rev_id
265
branch = revision.branch
266
return branch.repository.revision_tree(revision_id)
267
if old_revision_spec is None:
268
old_tree = tree.basis_tree()
270
old_tree = spec_tree(old_revision_spec)
272
if new_revision_spec is None:
275
new_tree = spec_tree(new_revision_spec)
276
if new_tree is not tree:
277
extra_trees = (tree,)
281
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
282
external_diff_options,
283
old_label=old_label, new_label=new_label,
284
extra_trees=extra_trees)
287
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
288
external_diff_options=None,
289
old_label='a/', new_label='b/',
291
"""Show in text form the changes from one tree to another.
294
If set, include only changes to these files.
296
external_diff_options
297
If set, use an external GNU diff and pass these options.
300
If set, more Trees to use for looking up file ids
306
return _show_diff_trees(old_tree, new_tree, to_file,
307
specific_files, external_diff_options,
308
old_label=old_label, new_label=new_label,
309
extra_trees=extra_trees)
316
def _show_diff_trees(old_tree, new_tree, to_file,
317
specific_files, external_diff_options,
318
old_label='a/', new_label='b/', extra_trees=None):
320
# GNU Patch uses the epoch date to detect files that are being added
321
# or removed in a diff.
322
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
324
# TODO: Generation of pseudo-diffs for added/deleted files could
325
# be usefully made into a much faster special case.
327
if external_diff_options:
328
assert isinstance(external_diff_options, basestring)
329
opts = external_diff_options.split()
330
def diff_file(olab, olines, nlab, nlines, to_file):
331
external_diff(olab, olines, nlab, nlines, to_file, opts)
333
diff_file = internal_diff
335
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
336
specific_files=specific_files,
337
extra_trees=extra_trees, require_versioned=True)
340
for path, file_id, kind in delta.removed:
342
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
343
old_name = '%s%s\t%s' % (old_label, path,
344
_patch_header_date(old_tree, file_id, path))
345
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
346
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
347
new_name, None, None, to_file)
348
for path, file_id, kind in delta.added:
350
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
351
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
352
new_name = '%s%s\t%s' % (new_label, path,
353
_patch_header_date(new_tree, file_id, path))
354
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
355
old_name, None, None, to_file,
357
for (old_path, new_path, file_id, kind,
358
text_modified, meta_modified) in delta.renamed:
360
prop_str = get_prop_change(meta_modified)
361
print >>to_file, '=== renamed %s %r => %r%s' % (
362
kind, old_path.encode('utf8'),
363
new_path.encode('utf8'), prop_str)
364
old_name = '%s%s\t%s' % (old_label, old_path,
365
_patch_header_date(old_tree, file_id,
367
new_name = '%s%s\t%s' % (new_label, new_path,
368
_patch_header_date(new_tree, file_id,
370
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
372
text_modified, kind, to_file, diff_file)
373
for path, file_id, kind, text_modified, meta_modified in delta.modified:
375
prop_str = get_prop_change(meta_modified)
376
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
377
old_name = '%s%s\t%s' % (old_label, path,
378
_patch_header_date(old_tree, file_id, path))
379
new_name = '%s%s\t%s' % (new_label, path,
380
_patch_header_date(new_tree, file_id, path))
382
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
384
True, kind, to_file, diff_file)
389
def _patch_header_date(tree, file_id, path):
390
"""Returns a timestamp suitable for use in a patch header."""
391
tm = time.gmtime(tree.get_file_mtime(file_id, path))
392
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
395
def _raise_if_nonexistent(paths, old_tree, new_tree):
396
"""Complain if paths are not in either inventory or tree.
398
It's OK with the files exist in either tree's inventory, or
399
if they exist in the tree but are not versioned.
401
This can be used by operations such as bzr status that can accept
402
unknown or ignored files.
404
mutter("check paths: %r", paths)
407
s = old_tree.filter_unversioned_files(paths)
408
s = new_tree.filter_unversioned_files(s)
409
s = [path for path in s if not new_tree.has_filename(path)]
411
raise errors.PathsDoNotExist(sorted(s))
414
def get_prop_change(meta_modified):
416
return " (properties changed)"
421
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
422
new_path, new_tree, text_modified,
423
kind, to_file, diff_file):
425
new_entry = new_tree.inventory[file_id]
426
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
