2
# -*- coding: UTF-8 -*-
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
11
# GNU General Public License for more details.
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
from bzrlib.trace import mutter
24
# compatability - plugins import compare_trees from diff!!!
25
# deprecated as of 0.10
26
from bzrlib.delta import compare_trees
19
27
from bzrlib.errors import BzrError
20
from bzrlib.delta import compare_trees
28
import bzrlib.errors as errors
30
from bzrlib.patiencediff import unified_diff
31
import bzrlib.patiencediff
32
from bzrlib.symbol_versioning import (deprecated_function,
34
from bzrlib.textfile import check_text_lines
35
from bzrlib.trace import mutter, warning
22
38
# TODO: Rather than building a changeset object, we should probably
23
39
# invoke callbacks on an object. That object can either accumulate a
24
40
# list, write them out directly, etc etc.
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
42
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
43
allow_binary=False, sequence_matcher=None,
44
path_encoding='utf8'):
29
45
# FIXME: difflib is wrong if there is no trailing newline.
30
46
# The syntax used by patch seems to be "\ No newline at
31
47
# end of file" following the last diff line from that
41
57
# both sequences are empty.
42
58
if not oldlines and not newlines:
45
ud = difflib.unified_diff(oldlines, newlines,
46
fromfile=old_label, tofile=new_label)
61
if allow_binary is False:
62
check_text_lines(oldlines)
63
check_text_lines(newlines)
65
if sequence_matcher is None:
66
sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
67
ud = unified_diff(oldlines, newlines,
68
fromfile=old_filename.encode(path_encoding),
69
tofile=new_filename.encode(path_encoding),
70
sequencematcher=sequence_matcher)
48
73
# work-around for difflib being too smart for its own good
49
74
# if /dev/null is "1,0", patch won't recognize it as /dev/null
52
76
ud[2] = ud[2].replace('-1,0', '-0,0')
55
78
ud[2] = ud[2].replace('+1,0', '+0,0')
79
# work around for difflib emitting random spaces after the label
80
ud[0] = ud[0][:-2] + '\n'
81
ud[1] = ud[1][:-2] + '\n'
58
84
to_file.write(line)
66
def external_diff(old_label, oldlines, new_label, newlines, to_file,
90
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
68
92
"""Display a diff by calling out to the external diff program."""
93
if hasattr(to_file, 'fileno'):
97
out_file = subprocess.PIPE
71
if to_file != sys.stdout:
72
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
75
100
# make sure our own output is properly ordered before the diff
78
from tempfile import NamedTemporaryFile
81
oldtmpf = NamedTemporaryFile()
82
newtmpf = NamedTemporaryFile()
103
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
104
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
105
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
106
newtmpf = os.fdopen(newtmp_fd, 'wb')
85
109
# TODO: perhaps a special case for comparing to or from the empty
141
179
oldtmpf.close() # and delete
146
def show_diff(b, revision, specific_files, external_diff_options=None):
181
# Clean up. Warn in case the files couldn't be deleted
182
# (in case windows still holds the file open, but not
183
# if the files have already been deleted)
185
os.remove(old_abspath)
187
if e.errno not in (errno.ENOENT,):
188
warning('Failed to delete temporary file: %s %s',
191
os.remove(new_abspath)
193
if e.errno not in (errno.ENOENT,):
194
warning('Failed to delete temporary file: %s %s',
198
@deprecated_function(zero_eight)
199
def show_diff(b, from_spec, specific_files, external_diff_options=None,
200
revision2=None, output=None, b2=None):
147
201
"""Shortcut for showing the diff to the working tree.
203
Please use show_diff_trees instead.
153
None for each, or otherwise the old revision to compare against.
155
The more general form is show_diff_trees(), where the caller
156
supplies any two trees.
161
old_tree = b.basis_tree()
163
old_tree = b.revision_tree(b.lookup_revision(revision))
165
new_tree = b.working_tree()
167
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
168
external_diff_options)
209
None for 'basis tree', or otherwise the old revision to compare against.
211
The more general form is show_diff_trees(), where the caller
212
supplies any two trees.
217
if from_spec is None:
218
old_tree = b.bzrdir.open_workingtree()
220
old_tree = old_tree = old_tree.basis_tree()
222
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
224
if revision2 is None:
226
new_tree = b.bzrdir.open_workingtree()
228
new_tree = b2.bzrdir.open_workingtree()
230
new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
232
return show_diff_trees(old_tree, new_tree, output, specific_files,
233
external_diff_options)
236
def diff_cmd_helper(tree, specific_files, external_diff_options,
237
old_revision_spec=None, new_revision_spec=None,
238
old_label='a/', new_label='b/'):
239
"""Helper for cmd_diff.
245
The specific files to compare, or None
247
external_diff_options
248
If non-None, run an external diff, and pass it these options
251
If None, use basis tree as old revision, otherwise use the tree for
252
the specified revision.
255
If None, use working tree as new revision, otherwise use the tree for
256
the specified revision.
258
The more general form is show_diff_trees(), where the caller
259
supplies any two trees.
263
revision = spec.in_store(tree.branch)
265
revision = spec.in_store(None)
266
revision_id = revision.rev_id
267
branch = revision.branch
268
return branch.repository.revision_tree(revision_id)
269
if old_revision_spec is None:
270
old_tree = tree.basis_tree()
272
old_tree = spec_tree(old_revision_spec)
274
if new_revision_spec is None:
277
new_tree = spec_tree(new_revision_spec)
278
if new_tree is not tree:
279
extra_trees = (tree,)
283
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
284
external_diff_options,
285
old_label=old_label, new_label=new_label,
286
extra_trees=extra_trees)
172
289
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
external_diff_options=None):
290
external_diff_options=None,
291
old_label='a/', new_label='b/',
174
293
"""Show in text form the changes from one tree to another.
179
298
external_diff_options
180
299
If set, use an external GNU diff and pass these options.
302
If set, more Trees to use for looking up file ids
183
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
187
DEVNULL = '/dev/null'
188
# Windows users, don't panic about this filename -- it is a
189
# special signal to GNU patch that the file should be created or
190
# deleted respectively.
308
return _show_diff_trees(old_tree, new_tree, to_file,
309
specific_files, external_diff_options,
310
old_label=old_label, new_label=new_label,
311
extra_trees=extra_trees)
318
def _show_diff_trees(old_tree, new_tree, to_file,
319
specific_files, external_diff_options,
320
old_label='a/', new_label='b/', extra_trees=None):
322
# GNU Patch uses the epoch date to detect files that are being added
323
# or removed in a diff.
324
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
192
326
# TODO: Generation of pseudo-diffs for added/deleted files could
193
327
# be usefully made into a much faster special case.
201
335
diff_file = internal_diff
204
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
specific_files=specific_files)
337
delta = new_tree.changes_from(old_tree,
338
specific_files=specific_files,
339
extra_trees=extra_trees, require_versioned=True)
207
342
for path, file_id, kind in delta.removed:
208
print >>to_file, '*** removed %s %r' % (kind, path)
210
diff_file(old_label + path,
211
old_tree.get_file(file_id).readlines(),
344
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
345
old_name = '%s%s\t%s' % (old_label, path,
346
_patch_header_date(old_tree, file_id, path))
347
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
348
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
349
new_name, None, None, to_file)
216
350
for path, file_id, kind in delta.added:
217
print >>to_file, '*** added %s %r' % (kind, path)
222
new_tree.get_file(file_id).readlines(),
225
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
226
print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
352
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
353
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
354
new_name = '%s%s\t%s' % (new_label, path,
355
_patch_header_date(new_tree, file_id, path))
356
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
357
old_name, None, None, to_file,
359
for (old_path, new_path, file_id, kind,
360
text_modified, meta_modified) in delta.renamed:
362
prop_str = get_prop_change(meta_modified)
363
print >>to_file, '=== renamed %s %r => %r%s' % (
364
kind, old_path.encode('utf8'),
365
new_path.encode('utf8'), prop_str)
366
old_name = '%s%s\t%s' % (old_label, old_path,
367
_patch_header_date(old_tree, file_id,
369
new_name = '%s%s\t%s' % (new_label, new_path,
370
_patch_header_date(new_tree, file_id,
372
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
374
text_modified, kind, to_file, diff_file)
375
for path, file_id, kind, text_modified, meta_modified in delta.modified:
377
prop_str = get_prop_change(meta_modified)
378
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
379
old_name = '%s%s\t%s' % (old_label, path,
380
_patch_header_date(old_tree, file_id, path))
381
new_name = '%s%s\t%s' % (new_label, path,
382
_patch_header_date(new_tree, file_id, path))
227
383
if text_modified:
228
diff_file(old_label + old_path,
229
old_tree.get_file(file_id).readlines(),
230
new_label + new_path,
231
new_tree.get_file(file_id).readlines(),
234
for path, file_id, kind in delta.modified:
235
print >>to_file, '*** modified %s %r' % (kind, path)
237
diff_file(old_label + path,
238
old_tree.get_file(file_id).readlines(),
240
new_tree.get_file(file_id).readlines(),
384
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
386
True, kind, to_file, diff_file)
391
def _patch_header_date(tree, file_id, path):
392
"""Returns a timestamp suitable for use in a patch header."""
393
tm = time.gmtime(tree.get_file_mtime(file_id, path))
394
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
397
def _raise_if_nonexistent(paths, old_tree, new_tree):
398
"""Complain if paths are not in either inventory or tree.
400
It's OK with the files exist in either tree's inventory, or
401
if they exist in the tree but are not versioned.
403
This can be used by operations such as bzr status that can accept
404
unknown or ignored files.
406
mutter("check paths: %r", paths)
409
s = old_tree.filter_unversioned_files(paths)
410
s = new_tree.filter_unversioned_files(s)
411
s = [path for path in s if not new_tree.has_filename(path)]
413
raise errors.PathsDoNotExist(sorted(s))
416
def get_prop_change(meta_modified):
418
return " (properties changed)"
423
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
424
new_path, new_tree, text_modified,
425
kind, to_file, diff_file):
427
new_entry = new_tree.inventory[file_id]
428
old_tree.inventory[file_id].diff(diff_file,
added
removed
bzrlib/diff.py
