14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
23
from bzrlib.lazy_import import lazy_import
25
from .lazy_import import lazy_import
24
26
lazy_import(globals(), """
31
branch as _mod_branch,
43
from bzrlib.workingtree import WorkingTree
43
from breezy.workingtree import WorkingTree
44
from breezy.i18n import gettext
46
from bzrlib.registry import (
47
from .registry import (
49
from bzrlib.symbol_versioning import (
53
from bzrlib.trace import mutter, note, warning
50
from .trace import mutter, note, warning
51
from .tree import FileTimestampUnavailable
54
DEFAULT_CONTEXT_AMOUNT = 3
56
56
class AtTemplate(string.Template):
57
57
"""Templating class that uses @ instead of $."""
76
76
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
77
allow_binary=False, sequence_matcher=None,
78
path_encoding='utf8'):
78
path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
79
79
# FIXME: difflib is wrong if there is no trailing newline.
80
80
# The syntax used by patch seems to be "\ No newline at
81
81
# end of file" following the last diff line from that
99
99
if sequence_matcher is None:
100
100
sequence_matcher = patiencediff.PatienceSequenceMatcher
101
101
ud = patiencediff.unified_diff(oldlines, newlines,
102
fromfile=old_filename.encode(path_encoding),
103
tofile=new_filename.encode(path_encoding),
104
sequencematcher=sequence_matcher)
102
fromfile=old_filename.encode(path_encoding, 'replace'),
103
tofile=new_filename.encode(path_encoding, 'replace'),
104
n=context_lines, sequencematcher=sequence_matcher)
107
107
if len(ud) == 0: # Identical contents, nothing to do
149
149
stdout=subprocess.PIPE,
153
153
if e.errno == errno.ENOENT:
154
154
raise errors.NoDiff(str(e))
159
# diff style options as of GNU diff v3.2
160
style_option_list = ['-c', '-C', '--context',
162
'-f', '--forward-ed',
166
'-u', '-U', '--unified',
167
'-y', '--side-by-side',
170
def default_style_unified(diff_opts):
171
"""Default to unified diff style if alternative not specified in diff_opts.
173
diff only allows one style to be specified; they don't override.
174
Note that some of these take optargs, and the optargs can be
175
directly appended to the options.
176
This is only an approximate parser; it doesn't properly understand
179
:param diff_opts: List of options for external (GNU) diff.
180
:return: List of options with default style=='unified'.
182
for s in style_option_list:
190
diff_opts.append('-u')
160
194
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
163
197
# make sure our own output is properly ordered before the diff
166
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
167
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
200
oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
201
newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
168
202
oldtmpf = os.fdopen(oldtmp_fd, 'wb')
169
203
newtmpf = os.fdopen(newtmp_fd, 'wb')
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',
234
diff_opts = default_style_unified(diff_opts)
222
237
diffcmd.extend(diff_opts)
224
239
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
225
out,err = pipe.communicate()
240
out, err = pipe.communicate()
226
241
rc = pipe.returncode
228
243
# internal_diff() adds a trailing newline, add one here for consistency
267
282
msg = 'exit code %d' % rc
269
284
raise errors.BzrError('external diff failed with %s; command: %r'
274
289
oldtmpf.close() # and delete
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)
293
# Warn in case the file couldn't be deleted (in case windows still
294
# holds the file open, but not if the files have already been
299
if e.errno not in (errno.ENOENT,):
300
warning('Failed to delete temporary file: %s %s', path, e)
326
306
def get_trees_and_branches_to_diff_locked(
327
307
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
394
374
if old_url is None:
395
375
old_url = default_location
396
376
working_tree, branch, relpath = \
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
377
controldir.ControlDir.open_containing_tree_or_branch(old_url)
398
378
lock_tree_or_branch(working_tree, branch)
399
379
if consider_relpath and relpath != '':
400
380
if working_tree is not None and apply_view:
408
388
new_url = default_location
409
389
if new_url != old_url:
410
390
working_tree, branch, relpath = \
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
391
controldir.ControlDir.open_containing_tree_or_branch(new_url)
412
392
lock_tree_or_branch(working_tree, branch)
413
393
if consider_relpath and relpath != '':
414
394
if working_tree is not None and apply_view:
421
401
# Get the specific files (all files is None, no files is [])
422
402
if make_paths_wt_relative and working_tree is not None:
424
from bzrlib.builtins import safe_relpath_files
425
other_paths = safe_relpath_files(working_tree, other_paths,
403
other_paths = working_tree.safe_relpath_files(
426
405
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
429
406
specific_files.extend(other_paths)
430
407
if len(specific_files) == 0:
431
408
specific_files = None
436
413
specific_files = view_files
437
414
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
415
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
440
417
# Get extra trees that ought to be searched for file-ids
441
418
extra_trees = None
442
419
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
420
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
421
return (old_tree, new_tree, old_branch, new_branch,
422
specific_files, extra_trees)
447
425
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
489
469
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
491
471
external_diff_options,
492
old_label, new_label, using)
472
old_label, new_label, using,
473
context_lines=context)
493
474
return differ.show_diff(specific_files, extra_trees)
495
476
new_tree.unlock()
496
477
if extra_trees is not None:
497
478
for tree in extra_trees:
503
482
def _patch_header_date(tree, file_id, path):
504
483
"""Returns a timestamp suitable for use in a patch header."""
506
mtime = tree.get_file_mtime(file_id, path)
507
except errors.FileTimestampUnavailable:
485
mtime = tree.get_file_mtime(path, file_id)
486
except FileTimestampUnavailable:
509
488
return timestamp.format_patch_date(mtime)
623
602
if 'symlink' not in (old_kind, new_kind):
624
603
return self.CANNOT_DIFF
625
604
if old_kind == 'symlink':
626
old_target = self.old_tree.get_symlink_target(file_id)
605
old_target = self.old_tree.get_symlink_target(old_path, file_id)
627
606
elif old_kind is None:
628
607
old_target = None
630
609
return self.CANNOT_DIFF
631
610
if new_kind == 'symlink':
632
new_target = self.new_tree.get_symlink_target(file_id)
611
new_target = self.new_tree.get_symlink_target(new_path, file_id)
633
612
elif new_kind is None:
634
613
new_target = None
653
632
# or removed in a diff.
654
633
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
656
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
657
old_label='', new_label='', text_differ=internal_diff):
635
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
636
old_label='', new_label='', text_differ=internal_diff,
637
context_lines=DEFAULT_CONTEXT_AMOUNT):
658
638
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
659
639
self.text_differ = text_differ
660
640
self.old_label = old_label
661
641
self.new_label = new_label
662
642
self.path_encoding = path_encoding
643
self.context_lines = context_lines
664
645
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
665
646
"""Compare two files in unified diff format
689
670
return self.CANNOT_DIFF
690
671
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
672
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
692
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
673
return self.diff_text(old_path, new_path, from_label, to_label,
674
from_file_id, to_file_id)
695
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
from_path=None, to_path=None):
676
def diff_text(self, from_path, to_path, from_label, to_label,
677
from_file_id=None, to_file_id=None):
697
678
"""Diff the content of given files in two trees
699
:param from_file_id: The id of the file in the from tree. If None,
680
:param from_path: The path in the from tree. If None,
700
681
the file is not present in the from tree.
701
:param to_file_id: The id of the file in the to tree. This may refer
702
to a different file from from_file_id. If None,
682
:param to_path: The path in the to tree. This may refer
683
to a different file from from_path. If None,
703
684
the file is not present in the to tree.
704
:param from_path: The path in the from tree or None if unknown.
705
:param to_path: The path in the to tree or None if unknown.
685
:param from_file_id: The id of the file in the from tree or None if
687
:param to_file_id: The id of the file in the to tree or None if
707
690
def _get_text(tree, file_id, path):
708
if file_id is not None:
709
return tree.get_file(file_id, path).readlines()
693
return tree.get_file_lines(path, file_id)
713
695
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
696
to_text = _get_text(self.new_tree, to_file_id, to_path)
715
697
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)
717
700
except errors.BinaryFile:
718
701
self.to_file.write(
719
702
("Binary files %s and %s differ\n" %
720
(from_label, to_label)).encode(self.path_encoding))
703
(from_label, to_label)).encode(self.path_encoding, 'replace'))
721
704
return self.CHANGED
727
710
path_encoding='utf-8'):
728
711
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
712
self.command_template = command_template
730
self._root = osutils.mkdtemp(prefix='bzr-diff-')
713
self._root = osutils.mkdtemp(prefix='brz-diff-')
733
716
def from_string(klass, command_string, old_tree, new_tree, to_file,
742
def make_from_diff_tree(klass, command_string):
725
def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
726
def from_diff_tree(diff_tree):
744
return klass.from_string(command_string, diff_tree.old_tree,
727
full_command_string = [command_string]
728
if external_diff_options is not None:
729
full_command_string += ' ' + external_diff_options
730
return klass.from_string(full_command_string, diff_tree.old_tree,
745
731
diff_tree.new_tree, diff_tree.to_file)
746
732
return from_diff_tree
748
734
def _get_command(self, old_path, new_path):
749
735
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
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
753
749
def _execute(self, old_path, new_path):
754
750
command = self._get_command(old_path, new_path)
756
752
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
759
755
if e.errno == errno.ENOENT:
760
756
raise errors.ExecutableMissing(command[0])
771
767
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
773
769
if e.errno != errno.EEXIST:
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
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
def _write_file(self, relpath, tree, prefix, force_temp=False,
802
allow_write=False, file_id=None):
779
803
if not force_temp and isinstance(tree, WorkingTree):
780
return tree.abspath(tree.id2path(file_id))
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
804
full_path = tree.abspath(relpath)
805
if self._is_safepath(full_path):
808
full_path = self._safe_filename(prefix, relpath)
783
809
if not force_temp and self._try_symlink_root(tree, prefix):
785
811
parent_dir = osutils.dirname(full_path)
787
813
os.makedirs(parent_dir)
789
815
if e.errno != errno.EEXIST:
791
source = tree.get_file(file_id, relpath)
817
source = tree.get_file(relpath, file_id)
793
target = open(full_path, 'wb')
819
with open(full_path, 'wb') as target:
795
820
osutils.pumpfile(source, target)
801
mtime = tree.get_file_mtime(file_id)
802
except errors.FileTimestampUnavailable:
824
mtime = tree.get_file_mtime(relpath, file_id)
825
except FileTimestampUnavailable:
805
828
os.utime(full_path, (mtime, mtime))
807
830
osutils.make_readonly(full_path)
810
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
allow_write_new=False):
812
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
814
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
833
def _prepare_files(self, old_path, new_path, force_temp=False,
834
allow_write_new=False, file_id=None):
835
old_disk_path = self._write_file(old_path, self.old_tree, 'old',
836
force_temp, file_id=file_id)
837
new_disk_path = self._write_file(new_path, self.new_tree, 'new',
838
force_temp, file_id=file_id,
816
839
allow_write=allow_write_new)
817
840
return old_disk_path, new_disk_path
819
842
def finish(self):
821
844
osutils.rmtree(self._root)
823
846
if e.errno != errno.ENOENT:
824
847
mutter("The temporary directory \"%s\" was not "
825
848
"cleanly removed: %s." % (self._root, e))
828
851
if (old_kind, new_kind) != ('file', 'file'):
829
852
return DiffPath.CANNOT_DIFF
830
853
(old_disk_path, new_disk_path) = self._prepare_files(
831
file_id, old_path, new_path)
854
old_path, new_path, file_id=file_id)
832
855
self._execute(old_disk_path, new_disk_path)
834
def edit_file(self, file_id):
857
def edit_file(self, old_path, new_path, file_id=None):
835
858
"""Use this tool to edit a file.
837
860
A temporary copy will be edited, and the new contents will be
840
863
:param file_id: The id of the file to edit.
841
864
:return: The new contents of the file.
843
old_path = self.old_tree.id2path(file_id)
844
new_path = self.new_tree.id2path(file_id)
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))
866
old_abs_path, new_abs_path = self._prepare_files(
867
old_path, new_path, allow_write_new=True, force_temp=True,
869
command = self._get_command(old_abs_path, new_abs_path)
850
870
subprocess.call(command, cwd=self._root)
851
new_file = open(new_abs_path, 'r')
871
with open(new_abs_path, 'rb') as new_file:
853
872
return new_file.read()
858
875
class DiffTree(object):
901
918
def from_trees_options(klass, old_tree, new_tree, to_file,
902
919
path_encoding, external_diff_options, old_label,
920
new_label, using, context_lines):
904
921
"""Factory for producing a DiffTree.
906
923
Designed to accept options used by show_diff_trees.
907
925
:param old_tree: The tree to show as old in the comparison
908
926
:param new_tree: The tree to show as new in the comparison
909
927
:param to_file: File to write comparisons to
915
933
:param using: Commandline to use to invoke an external diff tool
917
935
if using is not None:
918
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
936
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
920
938
extra_factories = []
921
939
if external_diff_options:
922
940
opts = external_diff_options.split()
923
def diff_file(olab, olines, nlab, nlines, to_file):
941
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
942
""":param path_encoding: not used but required
943
to match the signature of internal_diff.
924
945
external_diff(olab, olines, nlab, nlines, to_file, opts)
926
947
diff_file = internal_diff
927
948
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
928
old_label, new_label, diff_file)
949
old_label, new_label, diff_file, context_lines=context_lines)
929
950
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
996
1017
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
1018
newpath_encoded, prop_str))
998
1019
if changed_content:
999
self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1020
self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
1000
1021
has_changes = 1
1002
1023
has_changes = 1
1009
1030
:param old_path: The path of the file in the old tree
1010
1031
:param new_path: The path of the file in the new tree
1013
old_kind = self.old_tree.kind(file_id)
1014
except (errors.NoSuchId, errors.NoSuchFile):
1033
if old_path is None:
1015
1034
old_kind = None
1017
new_kind = self.new_tree.kind(file_id)
1018
except (errors.NoSuchId, errors.NoSuchFile):
1036
old_kind = self.old_tree.kind(old_path, file_id)
1037
if new_path is None:
1019
1038
new_kind = None
1020
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1023
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1040
new_kind = self.new_tree.kind(new_path, file_id)
1041
self._diff(old_path, new_path, old_kind, new_kind, file_id=file_id)
1043
def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
1024
1044
result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
1045
new_path, old_kind, new_kind)
1026
1046
if result is DiffPath.CANNOT_DIFF:
added
removed
breezy/diff.py
