43
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
47
46
from bzrlib.registry import (
49
from bzrlib.symbol_versioning import (
50
53
from bzrlib.trace import mutter, note, warning
52
DEFAULT_CONTEXT_AMOUNT = 3
54
56
class AtTemplate(string.Template):
55
57
"""Templating class that uses @ instead of $."""
74
76
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
75
77
allow_binary=False, sequence_matcher=None,
76
path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
78
path_encoding='utf8'):
77
79
# FIXME: difflib is wrong if there is no trailing newline.
78
80
# The syntax used by patch seems to be "\ No newline at
79
81
# end of file" following the last diff line from that
99
101
ud = patiencediff.unified_diff(oldlines, newlines,
100
102
fromfile=old_filename.encode(path_encoding, 'replace'),
101
103
tofile=new_filename.encode(path_encoding, 'replace'),
102
n=context_lines, sequencematcher=sequence_matcher)
104
sequencematcher=sequence_matcher)
105
107
if len(ud) == 0: # Identical contents, nothing to do
157
# diff style options as of GNU diff v3.2
158
style_option_list = ['-c', '-C', '--context',
160
'-f', '--forward-ed',
164
'-u', '-U', '--unified',
165
'-y', '--side-by-side',
168
def default_style_unified(diff_opts):
169
"""Default to unified diff style if alternative not specified in diff_opts.
171
diff only allows one style to be specified; they don't override.
172
Note that some of these take optargs, and the optargs can be
173
directly appended to the options.
174
This is only an approximate parser; it doesn't properly understand
177
:param diff_opts: List of options for external (GNU) diff.
178
:return: List of options with default style=='unified'.
180
for s in style_option_list:
188
diff_opts.append('-u')
192
160
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
232
diff_opts = default_style_unified(diff_opts)
200
# diff only allows one style to be specified; they don't override.
201
# note that some of these take optargs, and the optargs can be
202
# directly appended to the options.
203
# this is only an approximate parser; it doesn't properly understand
205
for s in ['-c', '-u', '-C', '-U',
210
'-y', '--side-by-side',
235
222
diffcmd.extend(diff_opts)
280
267
msg = 'exit code %d' % rc
282
269
raise errors.BzrError('external diff failed with %s; command: %r'
287
274
oldtmpf.close() # and delete
291
# Warn in case the file couldn't be deleted (in case windows still
292
# holds the file open, but not if the files have already been
297
if e.errno not in (errno.ENOENT,):
298
warning('Failed to delete temporary file: %s %s', path, e)
276
# Clean up. Warn in case the files couldn't be deleted
277
# (in case windows still holds the file open, but not
278
# if the files have already been deleted)
280
os.remove(old_abspath)
282
if e.errno not in (errno.ENOENT,):
283
warning('Failed to delete temporary file: %s %s',
286
os.remove(new_abspath)
288
if e.errno not in (errno.ENOENT,):
289
warning('Failed to delete temporary file: %s %s',
293
@deprecated_function(deprecated_in((2, 2, 0)))
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
296
"""Get the trees and specific files to diff given a list of paths.
298
This method works out the trees to be diff'ed and the files of
299
interest within those trees.
302
the list of arguments passed to the diff command
303
:param revision_specs:
304
Zero, one or two RevisionSpecs from the diff command line,
305
saying what revisions to compare.
307
The url of the old branch or tree. If None, the tree to use is
308
taken from the first path, if any, or the current working tree.
310
The url of the new branch or tree. If None, the tree to use is
311
taken from the first path, if any, or the current working tree.
313
if True and a view is set, apply the view or check that the paths
316
a tuple of (old_tree, new_tree, old_branch, new_branch,
317
specific_files, extra_trees) where extra_trees is a sequence of
318
additional trees to search in for file-ids. The trees and branches
321
op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
322
return op.run_simple(path_list, revision_specs, old_url, new_url,
323
op.add_cleanup, apply_view=apply_view)
304
326
def get_trees_and_branches_to_diff_locked(
305
327
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
372
394
if old_url is None:
373
395
old_url = default_location
374
396
working_tree, branch, relpath = \
375
controldir.ControlDir.open_containing_tree_or_branch(old_url)
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
376
398
lock_tree_or_branch(working_tree, branch)
377
399
if consider_relpath and relpath != '':
378
400
if working_tree is not None and apply_view:
386
408
new_url = default_location
387
409
if new_url != old_url:
388
410
working_tree, branch, relpath = \
389
controldir.ControlDir.open_containing_tree_or_branch(new_url)
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
390
412
lock_tree_or_branch(working_tree, branch)
391
413
if consider_relpath and relpath != '':
392
414
if working_tree is not None and apply_view:
411
433
specific_files = view_files
412
434
view_str = views.view_display_str(view_files)
413
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
435
note("*** Ignoring files outside view. View is %s" % view_str)
415
437
# Get extra trees that ought to be searched for file-ids
416
438
extra_trees = None
417
439
if working_tree is not None and working_tree not in (old_tree, new_tree):
418
440
extra_trees = (working_tree,)
419
return (old_tree, new_tree, old_branch, new_branch,
420
specific_files, extra_trees)
441
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
423
444
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
468
486
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
470
488
external_diff_options,
471
old_label, new_label, using,
472
context_lines=context)
489
old_label, new_label, using)
473
490
return differ.show_diff(specific_files, extra_trees)
475
492
new_tree.unlock()
633
650
# or removed in a diff.
634
651
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
636
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
637
old_label='', new_label='', text_differ=internal_diff,
638
context_lines=DEFAULT_CONTEXT_AMOUNT):
653
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
654
old_label='', new_label='', text_differ=internal_diff):
639
655
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
640
656
self.text_differ = text_differ
641
657
self.old_label = old_label
642
658
self.new_label = new_label
643
659
self.path_encoding = path_encoding
644
self.context_lines = context_lines
646
661
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
647
662
"""Compare two files in unified diff format
695
710
from_text = _get_text(self.old_tree, from_file_id, from_path)
696
711
to_text = _get_text(self.new_tree, to_file_id, to_path)
697
712
self.text_differ(from_label, from_text, to_label, to_text,
698
self.to_file, path_encoding=self.path_encoding,
699
context_lines=self.context_lines)
713
self.to_file, path_encoding=self.path_encoding)
700
714
except errors.BinaryFile:
701
715
self.to_file.write(
702
716
("Binary files %s and %s differ\n" %
734
748
def _get_command(self, old_path, new_path):
735
749
my_map = {'old_path': old_path, 'new_path': new_path}
736
command = [AtTemplate(t).substitute(my_map) for t in
737
self.command_template]
738
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
741
if isinstance(c, unicode):
742
command_encoded.append(c.encode('mbcs'))
744
command_encoded.append(c)
745
return command_encoded
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
749
753
def _execute(self, old_path, new_path):
750
754
command = self._get_command(old_path, new_path)
775
"""Returns safe encoding for passing file path to diff tool"""
776
if sys.platform == 'win32':
779
# Don't fallback to 'utf-8' because subprocess may not be able to
780
# handle utf-8 correctly when locale is not utf-8.
781
return sys.getfilesystemencoding() or 'ascii'
783
def _is_safepath(self, path):
784
"""Return true if `path` may be able to pass to subprocess."""
787
return path == path.encode(fenc).decode(fenc)
791
def _safe_filename(self, prefix, relpath):
792
"""Replace unsafe character in `relpath` then join `self._root`,
793
`prefix` and `relpath`."""
795
# encoded_str.replace('?', '_') may break multibyte char.
796
# So we should encode, decode, then replace(u'?', u'_')
797
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
798
relpath_tmp = relpath_tmp.replace(u'?', u'_')
799
return osutils.pathjoin(self._root, prefix, relpath_tmp)
801
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
802
778
allow_write=False):
803
779
if not force_temp and isinstance(tree, WorkingTree):
804
full_path = tree.abspath(tree.id2path(file_id))
805
if self._is_safepath(full_path):
808
full_path = self._safe_filename(prefix, relpath)
780
return tree.abspath(tree.id2path(file_id))
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
809
783
if not force_temp and self._try_symlink_root(tree, prefix):
811
785
parent_dir = osutils.dirname(full_path)
869
843
old_path = self.old_tree.id2path(file_id)
870
844
new_path = self.new_tree.id2path(file_id)
871
old_abs_path, new_abs_path = self._prepare_files(
872
file_id, old_path, new_path,
873
allow_write_new=True,
875
command = self._get_command(old_abs_path, new_abs_path)
845
new_abs_path = self._prepare_files(file_id, old_path, new_path,
846
allow_write_new=True,
848
command = self._get_command(osutils.pathjoin('old', old_path),
849
osutils.pathjoin('new', new_path))
876
850
subprocess.call(command, cwd=self._root)
877
new_file = open(new_abs_path, 'rb')
851
new_file = open(new_abs_path, 'r')
879
853
return new_file.read()
927
901
def from_trees_options(klass, old_tree, new_tree, to_file,
928
902
path_encoding, external_diff_options, old_label,
929
new_label, using, context_lines):
930
904
"""Factory for producing a DiffTree.
932
906
Designed to accept options used by show_diff_trees.
934
907
:param old_tree: The tree to show as old in the comparison
935
908
:param new_tree: The tree to show as new in the comparison
936
909
:param to_file: File to write comparisons to
947
920
extra_factories = []
948
921
if external_diff_options:
949
922
opts = external_diff_options.split()
950
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
923
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
951
924
""":param path_encoding: not used but required
952
925
to match the signature of internal_diff.
956
929
diff_file = internal_diff
957
930
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
958
old_label, new_label, diff_file, context_lines=context_lines)
931
old_label, new_label, diff_file)
959
932
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,