1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
1
# -*- coding: UTF-8 -*-
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
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
11
# GNU General Public License for more details.
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
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
17
from bzrlib.trace import mutter
18
from bzrlib.errors import BzrError
38
19
from bzrlib.delta import compare_trees
39
from bzrlib.symbol_versioning import (
43
from bzrlib.trace import mutter, warning
46
21
# TODO: Rather than building a changeset object, we should probably
47
22
# invoke callbacks on an object. That object can either accumulate a
48
23
# 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'):
25
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
53
28
# FIXME: difflib is wrong if there is no trailing newline.
54
29
# The syntax used by patch seems to be "\ No newline at
55
30
# end of file" following the last diff line from that
99
"""Set the env var LANG=C"""
100
osutils.set_or_unset_env('LANG', 'C')
101
osutils.set_or_unset_env('LC_ALL', None)
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
This lets us read and understand the output of diff, and respond
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 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,
65
def external_diff(old_label, oldlines, new_label, newlines, to_file,
143
67
"""Display a diff by calling out to the external diff program."""
70
if to_file != sys.stdout:
71
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
144
74
# 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')
77
from tempfile import NamedTemporaryFile
80
oldtmpf = NamedTemporaryFile()
81
newtmpf = NamedTemporaryFile()
153
84
# TODO: perhaps a special case for comparing to or from the empty
198
127
diffcmd.extend(diff_opts)
200
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
201
out,err = pipe.communicate()
129
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
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, but not when run'
223
' 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
131
if rc != 0 and rc != 1:
239
132
# returns 1 if files differ; that's OK
241
134
msg = 'signal %d' % (-rc)
243
136
msg = 'exit code %d' % rc
245
raise errors.BzrError('external diff failed with %s; command: %r'
138
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
250
140
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
143
def show_diff(b, from_spec, specific_files, external_diff_options=None,
271
revision2=None, output=None, b2=None):
144
revision2=None, output=None):
272
145
"""Shortcut for showing the diff to the working tree.
274
Please use show_diff_trees instead.
283
154
supplies any two trees.
285
156
if output is None:
286
158
output = sys.stdout
288
160
if from_spec is None:
289
old_tree = b.bzrdir.open_workingtree()
291
old_tree = old_tree = old_tree.basis_tree()
161
old_tree = b.basis_tree()
293
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
163
old_tree = b.revision_tree(from_spec.in_history(b).rev_id)
295
165
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,
309
old_label='a/', new_label='b/'):
310
"""Helper for cmd_diff.
316
The specific files to compare, or None
318
external_diff_options
319
If non-None, run an external diff, and pass it these options
322
If None, use basis tree as old revision, otherwise use the tree for
323
the specified revision.
326
If None, use working tree as new revision, otherwise use the tree for
327
the specified revision.
329
The more general form is show_diff_trees(), where the caller
330
supplies any two trees.
334
revision = spec.in_store(tree.branch)
336
revision = spec.in_store(None)
337
revision_id = revision.rev_id
338
branch = revision.branch
339
return branch.repository.revision_tree(revision_id)
340
if old_revision_spec is None:
341
old_tree = tree.basis_tree()
343
old_tree = spec_tree(old_revision_spec)
345
if new_revision_spec is None:
348
new_tree = spec_tree(new_revision_spec)
349
if new_tree is not tree:
350
extra_trees = (tree,)
354
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
355
external_diff_options,
356
old_label=old_label, new_label=new_label,
357
extra_trees=extra_trees)
166
new_tree = b.working_tree()
168
new_tree = b.revision_tree(revision2.in_history(b).rev_id)
170
show_diff_trees(old_tree, new_tree, output, specific_files,
171
external_diff_options)
360
175
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
361
external_diff_options=None,
362
old_label='a/', new_label='b/',
176
external_diff_options=None):
364
177
"""Show in text form the changes from one tree to another.
369
182
external_diff_options
370
183
If set, use an external GNU diff and pass these options.
373
If set, more Trees to use for looking up file ids
379
return _show_diff_trees(old_tree, new_tree, to_file,
380
specific_files, external_diff_options,
381
old_label=old_label, new_label=new_label,
382
extra_trees=extra_trees)
389
def _show_diff_trees(old_tree, new_tree, to_file,
390
specific_files, external_diff_options,
391
old_label='a/', new_label='b/', extra_trees=None):
393
# GNU Patch uses the epoch date to detect files that are being added
394
# or removed in a diff.
395
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
186
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
190
DEVNULL = '/dev/null'
191
# Windows users, don't panic about this filename -- it is a
192
# special signal to GNU patch that the file should be created or
193
# deleted respectively.
397
195
# TODO: Generation of pseudo-diffs for added/deleted files could
398
196
# be usefully made into a much faster special case.
406
204
diff_file = internal_diff
408
delta = new_tree.changes_from(old_tree,
409
specific_files=specific_files,
410
extra_trees=extra_trees, require_versioned=True)
207
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
208
specific_files=specific_files)
413
210
for path, file_id, kind in delta.removed:
415
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
416
old_name = '%s%s\t%s' % (old_label, path,
417
_patch_header_date(old_tree, file_id, path))
418
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
419
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
420
new_name, None, None, to_file)
211
print >>to_file, '=== removed %s %r' % (kind, path)
212
old_tree.inventory[file_id].diff(diff_file, old_label + path, old_tree,
213
DEVNULL, None, None, to_file)
421
214
for path, file_id, kind in delta.added:
423
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
424
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
425
new_name = '%s%s\t%s' % (new_label, path,
426
_patch_header_date(new_tree, file_id, path))
427
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
428
old_name, None, None, to_file,
215
print >>to_file, '=== added %s %r' % (kind, path)
216
new_tree.inventory[file_id].diff(diff_file, new_label + path, new_tree,
217
DEVNULL, None, None, to_file,
430
219
for (old_path, new_path, file_id, kind,
431
220
text_modified, meta_modified) in delta.renamed:
433
221
prop_str = get_prop_change(meta_modified)
434
222
print >>to_file, '=== renamed %s %r => %r%s' % (
435
kind, old_path.encode('utf8'),
436
new_path.encode('utf8'), prop_str)
437
old_name = '%s%s\t%s' % (old_label, old_path,
438
_patch_header_date(old_tree, file_id,
440
new_name = '%s%s\t%s' % (new_label, new_path,
441
_patch_header_date(new_tree, file_id,
443
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
223
kind, old_path, new_path, prop_str)
224
_maybe_diff_file_or_symlink(old_label, old_path, old_tree, file_id,
225
new_label, new_path, new_tree,
445
226
text_modified, kind, to_file, diff_file)
446
227
for path, file_id, kind, text_modified, meta_modified in delta.modified:
448
228
prop_str = get_prop_change(meta_modified)
449
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
450
old_name = '%s%s\t%s' % (old_label, path,
451
_patch_header_date(old_tree, file_id, path))
452
new_name = '%s%s\t%s' % (new_label, path,
453
_patch_header_date(new_tree, file_id, path))
229
print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
454
230
if text_modified:
455
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
231
_maybe_diff_file_or_symlink(old_label, path, old_tree, file_id,
232
new_label, path, new_tree,
457
233
True, kind, to_file, diff_file)
462
def _patch_header_date(tree, file_id, path):
463
"""Returns a timestamp suitable for use in a patch header."""
464
tm = time.gmtime(tree.get_file_mtime(file_id, path))
465
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
468
def _raise_if_nonexistent(paths, old_tree, new_tree):
469
"""Complain if paths are not in either inventory or tree.
471
It's OK with the files exist in either tree's inventory, or
472
if they exist in the tree but are not versioned.
474
This can be used by operations such as bzr status that can accept
475
unknown or ignored files.
477
mutter("check paths: %r", paths)
480
s = old_tree.filter_unversioned_files(paths)
481
s = new_tree.filter_unversioned_files(s)
482
s = [path for path in s if not new_tree.has_filename(path)]
484
raise errors.PathsDoNotExist(sorted(s))
487
236
def get_prop_change(meta_modified):
488
237
if meta_modified:
added
removed
bzrlib/diff.py
