1
# Copyright (C) 2005-2011 Canonical Ltd.
1
# Copyright (C) 2005-2010 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
44
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
47
47
from bzrlib.registry import (
50
from bzrlib.symbol_versioning import (
50
54
from bzrlib.trace import mutter, note, warning
96
100
if sequence_matcher is None:
97
101
sequence_matcher = patiencediff.PatienceSequenceMatcher
98
102
ud = patiencediff.unified_diff(oldlines, newlines,
99
fromfile=old_filename.encode(path_encoding, 'replace'),
100
tofile=new_filename.encode(path_encoding, 'replace'),
103
fromfile=old_filename.encode(path_encoding),
104
tofile=new_filename.encode(path_encoding),
101
105
sequencematcher=sequence_matcher)
294
@deprecated_function(deprecated_in((2, 2, 0)))
295
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
297
"""Get the trees and specific files to diff given a list of paths.
299
This method works out the trees to be diff'ed and the files of
300
interest within those trees.
303
the list of arguments passed to the diff command
304
:param revision_specs:
305
Zero, one or two RevisionSpecs from the diff command line,
306
saying what revisions to compare.
308
The url of the old branch or tree. If None, the tree to use is
309
taken from the first path, if any, or the current working tree.
311
The url of the new branch or tree. If None, the tree to use is
312
taken from the first path, if any, or the current working tree.
314
if True and a view is set, apply the view or check that the paths
317
a tuple of (old_tree, new_tree, old_branch, new_branch,
318
specific_files, extra_trees) where extra_trees is a sequence of
319
additional trees to search in for file-ids. The trees and branches
322
op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
323
return op.run_simple(path_list, revision_specs, old_url, new_url,
324
op.add_cleanup, apply_view=apply_view)
290
327
def get_trees_and_branches_to_diff_locked(
291
328
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
292
329
"""Get the trees and specific files to diff given a list of paths.
358
395
if old_url is None:
359
396
old_url = default_location
360
397
working_tree, branch, relpath = \
361
controldir.ControlDir.open_containing_tree_or_branch(old_url)
398
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
362
399
lock_tree_or_branch(working_tree, branch)
363
400
if consider_relpath and relpath != '':
364
401
if working_tree is not None and apply_view:
372
409
new_url = default_location
373
410
if new_url != old_url:
374
411
working_tree, branch, relpath = \
375
controldir.ControlDir.open_containing_tree_or_branch(new_url)
412
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
376
413
lock_tree_or_branch(working_tree, branch)
377
414
if consider_relpath and relpath != '':
378
415
if working_tree is not None and apply_view:
385
422
# Get the specific files (all files is None, no files is [])
386
423
if make_paths_wt_relative and working_tree is not None:
387
other_paths = working_tree.safe_relpath_files(
425
from bzrlib.builtins import safe_relpath_files
426
other_paths = safe_relpath_files(working_tree, other_paths,
389
427
apply_view=apply_view)
428
except errors.FileInWrongBranch:
429
raise errors.BzrCommandError("Files are in different branches")
390
430
specific_files.extend(other_paths)
391
431
if len(specific_files) == 0:
392
432
specific_files = None
397
437
specific_files = view_files
398
438
view_str = views.view_display_str(view_files)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
439
note("*** Ignoring files outside view. View is %s" % view_str)
401
441
# Get extra trees that ought to be searched for file-ids
402
442
extra_trees = None
403
443
if working_tree is not None and working_tree not in (old_tree, new_tree):
404
444
extra_trees = (working_tree,)
405
return (old_tree, new_tree, old_branch, new_branch,
406
specific_files, extra_trees)
445
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
409
448
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
430
469
"""Show in text form the changes from one tree to another.
432
471
:param to_file: The output stream.
433
:param specific_files: Include only changes to these files - None for all
472
:param specific_files:Include only changes to these files - None for all
435
474
:param external_diff_options: If set, use an external GNU diff and pass
669
708
def _get_text(tree, file_id, path):
670
709
if file_id is not None:
671
return tree.get_file_lines(file_id, path)
710
return tree.get_file(file_id, path).readlines()
675
714
from_text = _get_text(self.old_tree, from_file_id, from_path)
676
715
to_text = _get_text(self.new_tree, to_file_id, to_path)
677
716
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
679
718
except errors.BinaryFile:
680
719
self.to_file.write(
681
720
("Binary files %s and %s differ\n" %
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
721
(from_label, to_label)).encode(self.path_encoding))
683
722
return self.CHANGED
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
def make_from_diff_tree(klass, command_string):
705
744
def from_diff_tree(diff_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
return klass.from_string(command_string, diff_tree.old_tree,
710
746
diff_tree.new_tree, diff_tree.to_file)
711
747
return from_diff_tree
713
749
def _get_command(self, old_path, new_path):
714
750
my_map = {'old_path': old_path, 'new_path': new_path}
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
751
return [AtTemplate(t).substitute(my_map) for t in
752
self.command_template]
728
754
def _execute(self, old_path, new_path):
729
755
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)
780
778
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
781
779
allow_write=False):
782
780
if not force_temp and isinstance(tree, WorkingTree):
783
full_path = tree.abspath(tree.id2path(file_id))
784
if self._is_safepath(full_path):
787
full_path = self._safe_filename(prefix, relpath)
781
return tree.abspath(tree.id2path(file_id))
783
full_path = osutils.pathjoin(self._root, prefix, relpath)
788
784
if not force_temp and self._try_symlink_root(tree, prefix):
790
786
parent_dir = osutils.dirname(full_path)
848
844
old_path = self.old_tree.id2path(file_id)
849
845
new_path = self.new_tree.id2path(file_id)
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)
846
new_abs_path = self._prepare_files(file_id, old_path, new_path,
847
allow_write_new=True,
849
command = self._get_command(osutils.pathjoin('old', old_path),
850
osutils.pathjoin('new', new_path))
855
851
subprocess.call(command, cwd=self._root)
856
new_file = open(new_abs_path, 'rb')
852
new_file = open(new_abs_path, 'r')
858
854
return new_file.read()
909
905
"""Factory for producing a DiffTree.
911
907
Designed to accept options used by show_diff_trees.
913
908
:param old_tree: The tree to show as old in the comparison
914
909
:param new_tree: The tree to show as new in the comparison
915
910
:param to_file: File to write comparisons to
921
916
:param using: Commandline to use to invoke an external diff tool
923
918
if using is not None:
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
919
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
926
921
extra_factories = []
927
922
if external_diff_options:
928
923
opts = external_diff_options.split()
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
def diff_file(olab, olines, nlab, nlines, to_file):
933
925
external_diff(olab, olines, nlab, nlines, to_file, opts)
935
927
diff_file = internal_diff