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
17
from bzrlib.trace import mutter
18
from bzrlib.errors import BzrError
24
19
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
21
# TODO: Rather than building a changeset object, we should probably
37
22
# invoke callbacks on an object. That object can either accumulate a
38
23
# 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'):
25
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
43
28
# FIXME: difflib is wrong if there is no trailing newline.
44
29
# The syntax used by patch seems to be "\ No newline at
45
30
# end of file" following the last diff line from that
88
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
65
def external_diff(old_label, oldlines, new_label, newlines, to_file,
90
67
"""Display a diff by calling out to the external diff program."""
91
if hasattr(to_file, 'fileno'):
95
out_file = subprocess.PIPE
70
if to_file != sys.stdout:
71
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
98
74
# 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')
77
from tempfile import NamedTemporaryFile
80
oldtmpf = NamedTemporaryFile()
81
newtmpf = NamedTemporaryFile()
107
84
# TODO: perhaps a special case for comparing to or from the empty
177
140
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):
143
def show_diff(b, revision, specific_files, external_diff_options=None,
144
revision2=None, output=None):
199
145
"""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.
151
None for each, or otherwise the old revision to compare against.
209
153
The more general form is show_diff_trees(), where the caller
210
154
supplies any two trees.
212
156
if output is None:
213
158
output = sys.stdout
215
if from_spec is None:
216
old_tree = b.bzrdir.open_workingtree()
218
old_tree = old_tree = old_tree.basis_tree()
161
old_tree = b.basis_tree()
220
old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
163
old_tree = b.revision_tree(revision.in_history(b).rev_id)
222
165
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_id = spec.in_store(tree.branch).rev_id
262
return tree.branch.repository.revision_tree(revision_id)
263
if old_revision_spec is None:
264
old_tree = tree.basis_tree()
266
old_tree = spec_tree(old_revision_spec)
268
if new_revision_spec is None:
271
new_tree = spec_tree(new_revision_spec)
273
return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
274
external_diff_options,
275
old_label=old_label, new_label=new_label)
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)
278
175
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
279
external_diff_options=None,
280
old_label='a/', new_label='b/'):
176
external_diff_options=None):
281
177
"""Show in text form the changes from one tree to another.
286
182
external_diff_options
287
183
If set, use an external GNU diff and pass these options.
293
return _show_diff_trees(old_tree, new_tree, to_file,
294
specific_files, external_diff_options,
295
old_label=old_label, new_label=new_label)
302
def _show_diff_trees(old_tree, new_tree, to_file,
303
specific_files, external_diff_options,
304
old_label='a/', new_label='b/' ):
306
# GNU Patch uses the epoch date to detect files that are being added
307
# or removed in a diff.
308
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.
310
195
# TODO: Generation of pseudo-diffs for added/deleted files could
311
196
# be usefully made into a much faster special case.
313
_raise_if_doubly_unversioned(specific_files, old_tree, new_tree)
315
198
if external_diff_options:
316
199
assert isinstance(external_diff_options, basestring)
317
200
opts = external_diff_options.split()
321
204
diff_file = internal_diff
323
207
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
324
208
specific_files=specific_files)
327
210
for path, file_id, kind in delta.removed:
329
print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
330
old_name = '%s%s\t%s' % (old_label, path,
331
_patch_header_date(old_tree, file_id, path))
332
new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
333
old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
334
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)
335
214
for path, file_id, kind in delta.added:
337
print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
338
old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
339
new_name = '%s%s\t%s' % (new_label, path,
340
_patch_header_date(new_tree, file_id, path))
341
new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
342
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,
344
219
for (old_path, new_path, file_id, kind,
345
220
text_modified, meta_modified) in delta.renamed:
347
221
prop_str = get_prop_change(meta_modified)
348
222
print >>to_file, '=== renamed %s %r => %r%s' % (
349
kind, old_path.encode('utf8'),
350
new_path.encode('utf8'), prop_str)
351
old_name = '%s%s\t%s' % (old_label, old_path,
352
_patch_header_date(old_tree, file_id,
354
new_name = '%s%s\t%s' % (new_label, new_path,
355
_patch_header_date(new_tree, file_id,
357
_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,
359
226
text_modified, kind, to_file, diff_file)
360
227
for path, file_id, kind, text_modified, meta_modified in delta.modified:
362
228
prop_str = get_prop_change(meta_modified)
363
print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
364
old_name = '%s%s\t%s' % (old_label, path,
365
_patch_header_date(old_tree, file_id, path))
366
new_name = '%s%s\t%s' % (new_label, path,
367
_patch_header_date(new_tree, file_id, path))
229
print >>to_file, '=== modified %s %r%s' % (kind, path, prop_str)
368
230
if text_modified:
369
_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,
371
233
True, kind, to_file, diff_file)
376
def _patch_header_date(tree, file_id, path):
377
"""Returns a timestamp suitable for use in a patch header."""
378
tm = time.gmtime(tree.get_file_mtime(file_id, path))
379
return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
382
def _raise_if_doubly_unversioned(specific_files, old_tree, new_tree):
383
"""Complain if paths are not versioned in either tree."""
384
if not specific_files:
386
old_unversioned = old_tree.filter_unversioned_files(specific_files)
387
new_unversioned = new_tree.filter_unversioned_files(specific_files)
388
unversioned = old_unversioned.intersection(new_unversioned)
390
raise errors.PathsNotVersionedError(sorted(unversioned))
393
def _raise_if_nonexistent(paths, old_tree, new_tree):
394
"""Complain if paths are not in either inventory or tree.
396
It's OK with the files exist in either tree's inventory, or
397
if they exist in the tree but are not versioned.
399
This can be used by operations such as bzr status that can accept
400
unknown or ignored files.
402
mutter("check paths: %r", paths)
405
s = old_tree.filter_unversioned_files(paths)
406
s = new_tree.filter_unversioned_files(s)
407
s = [path for path in s if not new_tree.has_filename(path)]
409
raise errors.PathsDoNotExist(sorted(s))
412
236
def get_prop_change(meta_modified):
413
237
if meta_modified: