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
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
43
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
46
47
from bzrlib.registry import (
49
from bzrlib.symbol_versioning import (
53
50
from bzrlib.trace import mutter, note, warning
99
96
if sequence_matcher is None:
100
97
sequence_matcher = patiencediff.PatienceSequenceMatcher
101
98
ud = patiencediff.unified_diff(oldlines, newlines,
102
fromfile=old_filename.encode(path_encoding),
103
tofile=new_filename.encode(path_encoding),
99
fromfile=old_filename.encode(path_encoding, 'replace'),
100
tofile=new_filename.encode(path_encoding, 'replace'),
104
101
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
290
def get_trees_and_branches_to_diff_locked(
327
291
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
292
"""Get the trees and specific files to diff given a list of paths.
394
358
if old_url is None:
395
359
old_url = default_location
396
360
working_tree, branch, relpath = \
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
361
controldir.ControlDir.open_containing_tree_or_branch(old_url)
398
362
lock_tree_or_branch(working_tree, branch)
399
363
if consider_relpath and relpath != '':
400
364
if working_tree is not None and apply_view:
408
372
new_url = default_location
409
373
if new_url != old_url:
410
374
working_tree, branch, relpath = \
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
375
controldir.ControlDir.open_containing_tree_or_branch(new_url)
412
376
lock_tree_or_branch(working_tree, branch)
413
377
if consider_relpath and relpath != '':
414
378
if working_tree is not None and apply_view:
421
385
# Get the specific files (all files is None, no files is [])
422
386
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,
387
other_paths = working_tree.safe_relpath_files(
426
389
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
429
390
specific_files.extend(other_paths)
430
391
if len(specific_files) == 0:
431
392
specific_files = None
436
397
specific_files = view_files
437
398
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
440
401
# Get extra trees that ought to be searched for file-ids
441
402
extra_trees = None
442
403
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
404
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
405
return (old_tree, new_tree, old_branch, new_branch,
406
specific_files, extra_trees)
447
409
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
468
430
"""Show in text form the changes from one tree to another.
470
432
:param to_file: The output stream.
471
:param specific_files:Include only changes to these files - None for all
433
:param specific_files: Include only changes to these files - None for all
473
435
:param external_diff_options: If set, use an external GNU diff and pass
707
669
def _get_text(tree, file_id, path):
708
670
if file_id is not None:
709
return tree.get_file(file_id, path).readlines()
671
return tree.get_file_lines(file_id, path)
713
675
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
676
to_text = _get_text(self.new_tree, to_file_id, to_path)
715
677
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
717
679
except errors.BinaryFile:
718
680
self.to_file.write(
719
681
("Binary files %s and %s differ\n" %
720
(from_label, to_label)).encode(self.path_encoding))
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
721
683
return self.CHANGED
742
def make_from_diff_tree(klass, command_string):
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
705
def from_diff_tree(diff_tree):
744
return klass.from_string(command_string, diff_tree.old_tree,
706
full_command_string = [command_string]
707
if external_diff_options is not None:
708
full_command_string += ' ' + external_diff_options
709
return klass.from_string(full_command_string, diff_tree.old_tree,
745
710
diff_tree.new_tree, diff_tree.to_file)
746
711
return from_diff_tree
748
713
def _get_command(self, old_path, new_path):
749
714
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
715
command = [AtTemplate(t).substitute(my_map) for t in
716
self.command_template]
717
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
720
if isinstance(c, unicode):
721
command_encoded.append(c.encode('mbcs'))
723
command_encoded.append(c)
724
return command_encoded
753
728
def _execute(self, old_path, new_path):
754
729
command = self._get_command(old_path, new_path)
754
"""Returns safe encoding for passing file path to diff tool"""
755
if sys.platform == 'win32':
758
# Don't fallback to 'utf-8' because subprocess may not be able to
759
# handle utf-8 correctly when locale is not utf-8.
760
return sys.getfilesystemencoding() or 'ascii'
762
def _is_safepath(self, path):
763
"""Return true if `path` may be able to pass to subprocess."""
766
return path == path.encode(fenc).decode(fenc)
770
def _safe_filename(self, prefix, relpath):
771
"""Replace unsafe character in `relpath` then join `self._root`,
772
`prefix` and `relpath`."""
774
# encoded_str.replace('?', '_') may break multibyte char.
775
# So we should encode, decode, then replace(u'?', u'_')
776
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
777
relpath_tmp = relpath_tmp.replace(u'?', u'_')
778
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
780
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
781
allow_write=False):
779
782
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)
783
full_path = tree.abspath(tree.id2path(file_id))
784
if self._is_safepath(full_path):
787
full_path = self._safe_filename(prefix, relpath)
783
788
if not force_temp and self._try_symlink_root(tree, prefix):
785
790
parent_dir = osutils.dirname(full_path)
843
848
old_path = self.old_tree.id2path(file_id)
844
849
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))
850
old_abs_path, new_abs_path = self._prepare_files(
851
file_id, old_path, new_path,
852
allow_write_new=True,
854
command = self._get_command(old_abs_path, new_abs_path)
850
855
subprocess.call(command, cwd=self._root)
851
new_file = open(new_abs_path, 'r')
856
new_file = open(new_abs_path, 'rb')
853
858
return new_file.read()
904
909
"""Factory for producing a DiffTree.
906
911
Designed to accept options used by show_diff_trees.
907
913
:param old_tree: The tree to show as old in the comparison
908
914
:param new_tree: The tree to show as new in the comparison
909
915
:param to_file: File to write comparisons to
915
921
:param using: Commandline to use to invoke an external diff tool
917
923
if using is not None:
918
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
920
926
extra_factories = []
921
927
if external_diff_options:
922
928
opts = external_diff_options.split()
923
def diff_file(olab, olines, nlab, nlines, to_file):
929
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
930
""":param path_encoding: not used but required
931
to match the signature of internal_diff.
924
933
external_diff(olab, olines, nlab, nlines, to_file, opts)
926
935
diff_file = internal_diff