1
# Copyright (C) 2005-2010 Canonical Ltd.
1
# Copyright (C) 2005-2011 Canonical Ltd.
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
43
41
from bzrlib.workingtree import WorkingTree
42
from bzrlib.i18n import gettext
46
45
from bzrlib.registry import (
49
from bzrlib.symbol_versioning import (
53
48
from bzrlib.trace import mutter, note, warning
99
94
if sequence_matcher is None:
100
95
sequence_matcher = patiencediff.PatienceSequenceMatcher
101
96
ud = patiencediff.unified_diff(oldlines, newlines,
102
fromfile=old_filename.encode(path_encoding),
103
tofile=new_filename.encode(path_encoding),
97
fromfile=old_filename.encode(path_encoding, 'replace'),
98
tofile=new_filename.encode(path_encoding, 'replace'),
104
99
sequencematcher=sequence_matcher)
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)
326
288
def get_trees_and_branches_to_diff_locked(
327
289
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
290
"""Get the trees and specific files to diff given a list of paths.
421
383
# Get the specific files (all files is None, no files is [])
422
384
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,
385
other_paths = working_tree.safe_relpath_files(
426
387
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
429
388
specific_files.extend(other_paths)
430
389
if len(specific_files) == 0:
431
390
specific_files = None
436
395
specific_files = view_files
437
396
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
397
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
440
399
# Get extra trees that ought to be searched for file-ids
441
400
extra_trees = None
442
401
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
402
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
403
return (old_tree, new_tree, old_branch, new_branch,
404
specific_files, extra_trees)
447
407
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
468
428
"""Show in text form the changes from one tree to another.
470
430
:param to_file: The output stream.
471
:param specific_files:Include only changes to these files - None for all
431
:param specific_files: Include only changes to these files - None for all
473
433
:param external_diff_options: If set, use an external GNU diff and pass
707
667
def _get_text(tree, file_id, path):
708
668
if file_id is not None:
709
return tree.get_file(file_id, path).readlines()
669
return tree.get_file_lines(file_id, path)
713
673
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
674
to_text = _get_text(self.new_tree, to_file_id, to_path)
715
675
self.text_differ(from_label, from_text, to_label, to_text,
676
self.to_file, path_encoding=self.path_encoding)
717
677
except errors.BinaryFile:
718
678
self.to_file.write(
719
679
("Binary files %s and %s differ\n" %
720
(from_label, to_label)).encode(self.path_encoding))
680
(from_label, to_label)).encode(self.path_encoding,'replace'))
721
681
return self.CHANGED
742
def make_from_diff_tree(klass, command_string):
702
def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
703
def from_diff_tree(diff_tree):
744
return klass.from_string(command_string, diff_tree.old_tree,
704
full_command_string = [command_string]
705
if external_diff_options is not None:
706
full_command_string += ' ' + external_diff_options
707
return klass.from_string(full_command_string, diff_tree.old_tree,
745
708
diff_tree.new_tree, diff_tree.to_file)
746
709
return from_diff_tree
748
711
def _get_command(self, old_path, new_path):
749
712
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
713
command = [AtTemplate(t).substitute(my_map) for t in
714
self.command_template]
715
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
718
if isinstance(c, unicode):
719
command_encoded.append(c.encode('mbcs'))
721
command_encoded.append(c)
722
return command_encoded
753
726
def _execute(self, old_path, new_path):
754
727
command = self._get_command(old_path, new_path)
752
"""Returns safe encoding for passing file path to diff tool"""
753
if sys.platform == 'win32':
756
# Don't fallback to 'utf-8' because subprocess may not be able to
757
# handle utf-8 correctly when locale is not utf-8.
758
return sys.getfilesystemencoding() or 'ascii'
760
def _is_safepath(self, path):
761
"""Return true if `path` may be able to pass to subprocess."""
764
return path == path.encode(fenc).decode(fenc)
768
def _safe_filename(self, prefix, relpath):
769
"""Replace unsafe character in `relpath` then join `self._root`,
770
`prefix` and `relpath`."""
772
# encoded_str.replace('?', '_') may break multibyte char.
773
# So we should encode, decode, then replace(u'?', u'_')
774
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
775
relpath_tmp = relpath_tmp.replace(u'?', u'_')
776
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
778
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
779
allow_write=False):
779
780
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)
781
full_path = tree.abspath(tree.id2path(file_id))
782
if self._is_safepath(full_path):
785
full_path = self._safe_filename(prefix, relpath)
783
786
if not force_temp and self._try_symlink_root(tree, prefix):
785
788
parent_dir = osutils.dirname(full_path)
843
846
old_path = self.old_tree.id2path(file_id)
844
847
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))
848
old_abs_path, new_abs_path = self._prepare_files(
849
file_id, old_path, new_path,
850
allow_write_new=True,
852
command = self._get_command(old_abs_path, new_abs_path)
850
853
subprocess.call(command, cwd=self._root)
851
new_file = open(new_abs_path, 'r')
854
new_file = open(new_abs_path, 'rb')
853
856
return new_file.read()
904
907
"""Factory for producing a DiffTree.
906
909
Designed to accept options used by show_diff_trees.
907
911
:param old_tree: The tree to show as old in the comparison
908
912
:param new_tree: The tree to show as new in the comparison
909
913
:param to_file: File to write comparisons to
915
919
:param using: Commandline to use to invoke an external diff tool
917
921
if using is not None:
918
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
922
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
920
924
extra_factories = []
921
925
if external_diff_options:
922
926
opts = external_diff_options.split()
923
def diff_file(olab, olines, nlab, nlines, to_file):
927
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
928
""":param path_encoding: not used but required
929
to match the signature of internal_diff.
924
931
external_diff(olab, olines, nlab, nlines, to_file, opts)
926
933
diff_file = internal_diff