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
52
DEFAULT_CONTEXT_AMOUNT = 3
56
54
class AtTemplate(string.Template):
57
55
"""Templating class that uses @ instead of $."""
76
74
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
75
allow_binary=False, sequence_matcher=None,
78
path_encoding='utf8'):
76
path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
79
77
# FIXME: difflib is wrong if there is no trailing newline.
80
78
# The syntax used by patch seems to be "\ No newline at
81
79
# end of file" following the last diff line from that
101
99
ud = patiencediff.unified_diff(oldlines, newlines,
102
100
fromfile=old_filename.encode(path_encoding, 'replace'),
103
101
tofile=new_filename.encode(path_encoding, 'replace'),
104
sequencematcher=sequence_matcher)
102
n=context_lines, sequencematcher=sequence_matcher)
107
105
if len(ud) == 0: # Identical contents, nothing to do
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
291
def get_trees_and_branches_to_diff_locked(
327
292
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
293
"""Get the trees and specific files to diff given a list of paths.
394
359
if old_url is None:
395
360
old_url = default_location
396
361
working_tree, branch, relpath = \
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
362
controldir.ControlDir.open_containing_tree_or_branch(old_url)
398
363
lock_tree_or_branch(working_tree, branch)
399
364
if consider_relpath and relpath != '':
400
365
if working_tree is not None and apply_view:
408
373
new_url = default_location
409
374
if new_url != old_url:
410
375
working_tree, branch, relpath = \
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
376
controldir.ControlDir.open_containing_tree_or_branch(new_url)
412
377
lock_tree_or_branch(working_tree, branch)
413
378
if consider_relpath and relpath != '':
414
379
if working_tree is not None and apply_view:
421
386
# Get the specific files (all files is None, no files is [])
422
387
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,
388
other_paths = working_tree.safe_relpath_files(
426
390
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
429
391
specific_files.extend(other_paths)
430
392
if len(specific_files) == 0:
431
393
specific_files = None
436
398
specific_files = view_files
437
399
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
400
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
440
402
# Get extra trees that ought to be searched for file-ids
441
403
extra_trees = None
442
404
if working_tree is not None and working_tree not in (old_tree, new_tree):
443
405
extra_trees = (working_tree,)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
406
return (old_tree, new_tree, old_branch, new_branch,
407
specific_files, extra_trees)
447
410
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
464
427
extra_trees=None,
465
428
path_encoding='utf8',
431
context=DEFAULT_CONTEXT_AMOUNT):
468
432
"""Show in text form the changes from one tree to another.
470
434
:param to_file: The output stream.
471
:param specific_files:Include only changes to these files - None for all
435
:param specific_files: Include only changes to these files - None for all
473
437
:param external_diff_options: If set, use an external GNU diff and pass
489
455
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
491
457
external_diff_options,
492
old_label, new_label, using)
458
old_label, new_label, using,
459
context_lines=context)
493
460
return differ.show_diff(specific_files, extra_trees)
495
462
new_tree.unlock()
653
620
# or removed in a diff.
654
621
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):
623
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
624
old_label='', new_label='', text_differ=internal_diff,
625
context_lines=DEFAULT_CONTEXT_AMOUNT):
658
626
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
659
627
self.text_differ = text_differ
660
628
self.old_label = old_label
661
629
self.new_label = new_label
662
630
self.path_encoding = path_encoding
631
self.context_lines = context_lines
664
633
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
665
634
"""Compare two files in unified diff format
713
682
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
683
to_text = _get_text(self.new_tree, to_file_id, to_path)
715
684
self.text_differ(from_label, from_text, to_label, to_text,
716
self.to_file, path_encoding=self.path_encoding)
685
self.to_file, path_encoding=self.path_encoding,
686
context_lines=self.context_lines)
717
687
except errors.BinaryFile:
718
688
self.to_file.write(
719
689
("Binary files %s and %s differ\n" %
742
def make_from_diff_tree(klass, command_string):
712
def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
713
def from_diff_tree(diff_tree):
744
return klass.from_string(command_string, diff_tree.old_tree,
714
full_command_string = [command_string]
715
if external_diff_options is not None:
716
full_command_string += ' ' + external_diff_options
717
return klass.from_string(full_command_string, diff_tree.old_tree,
745
718
diff_tree.new_tree, diff_tree.to_file)
746
719
return from_diff_tree
748
721
def _get_command(self, old_path, new_path):
749
722
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
723
command = [AtTemplate(t).substitute(my_map) for t in
724
self.command_template]
725
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
728
if isinstance(c, unicode):
729
command_encoded.append(c.encode('mbcs'))
731
command_encoded.append(c)
732
return command_encoded
753
736
def _execute(self, old_path, new_path):
754
737
command = self._get_command(old_path, new_path)
762
"""Returns safe encoding for passing file path to diff tool"""
763
if sys.platform == 'win32':
766
# Don't fallback to 'utf-8' because subprocess may not be able to
767
# handle utf-8 correctly when locale is not utf-8.
768
return sys.getfilesystemencoding() or 'ascii'
770
def _is_safepath(self, path):
771
"""Return true if `path` may be able to pass to subprocess."""
774
return path == path.encode(fenc).decode(fenc)
778
def _safe_filename(self, prefix, relpath):
779
"""Replace unsafe character in `relpath` then join `self._root`,
780
`prefix` and `relpath`."""
782
# encoded_str.replace('?', '_') may break multibyte char.
783
# So we should encode, decode, then replace(u'?', u'_')
784
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
785
relpath_tmp = relpath_tmp.replace(u'?', u'_')
786
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
788
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
789
allow_write=False):
779
790
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)
791
full_path = tree.abspath(tree.id2path(file_id))
792
if self._is_safepath(full_path):
795
full_path = self._safe_filename(prefix, relpath)
783
796
if not force_temp and self._try_symlink_root(tree, prefix):
785
798
parent_dir = osutils.dirname(full_path)
843
856
old_path = self.old_tree.id2path(file_id)
844
857
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))
858
old_abs_path, new_abs_path = self._prepare_files(
859
file_id, old_path, new_path,
860
allow_write_new=True,
862
command = self._get_command(old_abs_path, new_abs_path)
850
863
subprocess.call(command, cwd=self._root)
851
new_file = open(new_abs_path, 'r')
864
new_file = open(new_abs_path, 'rb')
853
866
return new_file.read()
901
914
def from_trees_options(klass, old_tree, new_tree, to_file,
902
915
path_encoding, external_diff_options, old_label,
916
new_label, using, context_lines):
904
917
"""Factory for producing a DiffTree.
906
919
Designed to accept options used by show_diff_trees.
907
921
:param old_tree: The tree to show as old in the comparison
908
922
:param new_tree: The tree to show as new in the comparison
909
923
:param to_file: File to write comparisons to
915
929
:param using: Commandline to use to invoke an external diff tool
917
931
if using is not None:
918
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
932
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
920
934
extra_factories = []
921
935
if external_diff_options:
922
936
opts = external_diff_options.split()
923
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
937
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
924
938
""":param path_encoding: not used but required
925
939
to match the signature of internal_diff.
929
943
diff_file = internal_diff
930
944
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
931
old_label, new_label, diff_file)
945
old_label, new_label, diff_file, context_lines=context_lines)
932
946
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
added
removed
bzrlib/diff.py
