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 trace import mutter
19
from errors import BzrError
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
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'):
25
43
# FIXME: difflib is wrong if there is no trailing newline.
26
44
# The syntax used by patch seems to be "\ No newline at
27
45
# end of file" following the last diff line from that
37
55
# both sequences are empty.
38
56
if not oldlines and not newlines:
43
if oldlines and (oldlines[-1][-1] != '\n'):
46
if newlines and (newlines[-1][-1] != '\n'):
50
ud = difflib.unified_diff(oldlines, newlines,
51
fromfile=old_label, tofile=new_label)
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)
53
71
# work-around for difflib being too smart for its own good
54
72
# if /dev/null is "1,0", patch won't recognize it as /dev/null
57
74
ud[2] = ud[2].replace('-1,0', '-0,0')
60
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'
62
to_file.writelines(ud)
64
print >>to_file, "\\ No newline at end of file"
83
if not line.endswith('\n'):
84
to_file.write("\n\\ No newline at end of file\n")
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
88
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
72
90
"""Display a diff by calling out to the external diff program."""
91
if hasattr(to_file, 'fileno'):
95
out_file = subprocess.PIPE
75
if to_file != sys.stdout:
76
raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
79
98
# make sure our own output is properly ordered before the diff
82
from tempfile import NamedTemporaryFile
85
oldtmpf = NamedTemporaryFile()
86
newtmpf = NamedTemporaryFile()
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')
89
107
# TODO: perhaps a special case for comparing to or from the empty
145
177
oldtmpf.close() # and delete
150
def show_diff(b, revision, specific_files, external_diff_options=None):
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):
151
199
"""Shortcut for showing the diff to the working tree.
201
Please use show_diff_trees instead.
157
None for each, or otherwise the old revision to compare against.
159
The more general form is show_diff_trees(), where the caller
160
supplies any two trees.
165
old_tree = b.basis_tree()
167
old_tree = b.revision_tree(b.lookup_revision(revision))
169
new_tree = b.working_tree()
171
show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
172
external_diff_options)
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_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)
176
278
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
177
external_diff_options=None):
279
external_diff_options=None,
280
old_label='a/', new_label='b/'):
178
281
"""Show in text form the changes from one tree to another.
205
321
diff_file = internal_diff
208
323
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
209
324
specific_files=specific_files)
211
327
for path, file_id, kind in delta.removed:
212
print '*** removed %s %r' % (kind, path)
214
diff_file(old_label + path,
215
old_tree.get_file(file_id).readlines(),
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)
220
335
for path, file_id, kind in delta.added:
221
print '*** added %s %r' % (kind, path)
226
new_tree.get_file(file_id).readlines(),
229
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
230
print '*** renamed %s %r => %r' % (kind, old_path, new_path)
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,
344
for (old_path, new_path, file_id, kind,
345
text_modified, meta_modified) in delta.renamed:
347
prop_str = get_prop_change(meta_modified)
348
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,
359
text_modified, kind, to_file, diff_file)
360
for path, file_id, kind, text_modified, meta_modified in delta.modified:
362
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))
231
368
if text_modified:
232
diff_file(old_label + old_path,
233
old_tree.get_file(file_id).readlines(),
234
new_label + new_path,
235
new_tree.get_file(file_id).readlines(),
238
for path, file_id, kind in delta.modified:
239
print '*** modified %s %r' % (kind, path)
241
diff_file(old_label + path,
242
old_tree.get_file(file_id).readlines(),
244
new_tree.get_file(file_id).readlines(),
249
class TreeDelta(object):
250
"""Describes changes from one tree to another.
259
(oldpath, newpath, id, kind, text_modified)
265
Each id is listed only once.
267
Files that are both modified and renamed are listed only in
268
renamed, with the text_modified flag true.
270
The lists are normally sorted when the delta is created.
279
def has_changed(self):
280
changes = len(self.added) + len(self.removed) + len(self.renamed)
281
changes += len(self.modified)
282
return (changes != 0)
284
def touches_file_id(self, file_id):
285
"""Return True if file_id is modified by this delta."""
286
for l in self.added, self.removed, self.modified:
290
for v in self.renamed:
296
def show(self, to_file, show_ids=False, show_unchanged=False):
297
def show_list(files):
298
for path, fid, kind in files:
299
if kind == 'directory':
301
elif kind == 'symlink':
305
print >>to_file, ' %-30s %s' % (path, fid)
307
print >>to_file, ' ', path
310
print >>to_file, 'removed:'
311
show_list(self.removed)
314
print >>to_file, 'added:'
315
show_list(self.added)
318
print >>to_file, 'renamed:'
319
for oldpath, newpath, fid, kind, text_modified in self.renamed:
321
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
323
print >>to_file, ' %s => %s' % (oldpath, newpath)
326
print >>to_file, 'modified:'
327
show_list(self.modified)
329
if show_unchanged and self.unchanged:
330
print >>to_file, 'unchanged:'
331
show_list(self.unchanged)
335
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
336
"""Describe changes from one tree to another.
338
Returns a TreeDelta with details of added, modified, renamed, and
341
The root entry is specifically exempt.
343
This only considers versioned files.
346
If true, also list files unchanged from one version to
350
If true, only check for changes to specified names or
354
from osutils import is_inside_any
356
old_inv = old_tree.inventory
357
new_inv = new_tree.inventory
359
mutter('start compare_trees')
361
# TODO: match for specific files can be rather smarter by finding
362
# the IDs of those files up front and then considering only that.
364
for file_id in old_tree:
365
if file_id in new_tree:
366
kind = old_inv.get_file_kind(file_id)
367
assert kind == new_inv.get_file_kind(file_id)
369
assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
370
'invalid file kind %r' % kind
372
if kind == 'root_directory':
375
old_path = old_inv.id2path(file_id)
376
new_path = new_inv.id2path(file_id)
379
if (not is_inside_any(specific_files, old_path)
380
and not is_inside_any(specific_files, new_path)):
384
old_sha1 = old_tree.get_file_sha1(file_id)
385
new_sha1 = new_tree.get_file_sha1(file_id)
386
text_modified = (old_sha1 != new_sha1)
388
## mutter("no text to check for %r %r" % (file_id, kind))
389
text_modified = False
391
# TODO: Can possibly avoid calculating path strings if the
392
# two files are unchanged and their names and parents are
393
# the same and the parents are unchanged all the way up.
394
# May not be worthwhile.
396
if old_path != new_path:
397
delta.renamed.append((old_path, new_path, file_id, kind,
400
delta.modified.append((new_path, file_id, kind))
402
delta.unchanged.append((new_path, file_id, kind))
404
kind = old_inv.get_file_kind(file_id)
405
old_path = old_inv.id2path(file_id)
407
if not is_inside_any(specific_files, old_path):
409
delta.removed.append((old_path, file_id, kind))
411
mutter('start looking for new files')
412
for file_id in new_inv:
413
if file_id in old_inv:
415
new_path = new_inv.id2path(file_id)
417
if not is_inside_any(specific_files, new_path):
419
kind = new_inv.get_file_kind(file_id)
420
delta.added.append((new_path, file_id, kind))
425
delta.modified.sort()
426
delta.unchanged.sort()
369
_maybe_diff_file_or_symlink(old_name, old_tree, file_id,
371
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
def get_prop_change(meta_modified):
414
return " (properties changed)"
419
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
420
new_path, new_tree, text_modified,
421
kind, to_file, diff_file):
423
new_entry = new_tree.inventory[file_id]
424
old_tree.inventory[file_id].diff(diff_file,