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
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
47
46
from bzrlib.registry import (
49
from bzrlib.symbol_versioning import (
50
53
from bzrlib.trace import mutter, note, warning
52
DEFAULT_CONTEXT_AMOUNT = 3
54
56
class AtTemplate(string.Template):
55
57
"""Templating class that uses @ instead of $."""
74
76
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
75
77
allow_binary=False, sequence_matcher=None,
76
path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
78
path_encoding='utf8'):
77
79
# FIXME: difflib is wrong if there is no trailing newline.
78
80
# The syntax used by patch seems to be "\ No newline at
79
81
# end of file" following the last diff line from that
97
99
if sequence_matcher is None:
98
100
sequence_matcher = patiencediff.PatienceSequenceMatcher
99
101
ud = patiencediff.unified_diff(oldlines, newlines,
100
fromfile=old_filename.encode(path_encoding, 'replace'),
101
tofile=new_filename.encode(path_encoding, 'replace'),
102
n=context_lines, sequencematcher=sequence_matcher)
102
fromfile=old_filename.encode(path_encoding),
103
tofile=new_filename.encode(path_encoding),
104
sequencematcher=sequence_matcher)
105
107
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)
291
326
def get_trees_and_branches_to_diff_locked(
292
327
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
293
328
"""Get the trees and specific files to diff given a list of paths.
359
394
if old_url is None:
360
395
old_url = default_location
361
396
working_tree, branch, relpath = \
362
controldir.ControlDir.open_containing_tree_or_branch(old_url)
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
363
398
lock_tree_or_branch(working_tree, branch)
364
399
if consider_relpath and relpath != '':
365
400
if working_tree is not None and apply_view:
373
408
new_url = default_location
374
409
if new_url != old_url:
375
410
working_tree, branch, relpath = \
376
controldir.ControlDir.open_containing_tree_or_branch(new_url)
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
377
412
lock_tree_or_branch(working_tree, branch)
378
413
if consider_relpath and relpath != '':
379
414
if working_tree is not None and apply_view:
386
421
# Get the specific files (all files is None, no files is [])
387
422
if make_paths_wt_relative and working_tree is not None:
388
other_paths = working_tree.safe_relpath_files(
424
from bzrlib.builtins import safe_relpath_files
425
other_paths = safe_relpath_files(working_tree, other_paths,
390
426
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
391
429
specific_files.extend(other_paths)
392
430
if len(specific_files) == 0:
393
431
specific_files = None
398
436
specific_files = view_files
399
437
view_str = views.view_display_str(view_files)
400
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
438
note("*** Ignoring files outside view. View is %s" % view_str)
402
440
# Get extra trees that ought to be searched for file-ids
403
441
extra_trees = None
404
442
if working_tree is not None and working_tree not in (old_tree, new_tree):
405
443
extra_trees = (working_tree,)
406
return (old_tree, new_tree, old_branch, new_branch,
407
specific_files, extra_trees)
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
410
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
427
464
extra_trees=None,
428
465
path_encoding='utf8',
431
context=DEFAULT_CONTEXT_AMOUNT):
432
468
"""Show in text form the changes from one tree to another.
434
470
:param to_file: The output stream.
435
:param specific_files: Include only changes to these files - None for all
471
:param specific_files:Include only changes to these files - None for all
437
473
:param external_diff_options: If set, use an external GNU diff and pass
455
489
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
457
491
external_diff_options,
458
old_label, new_label, using,
459
context_lines=context)
492
old_label, new_label, using)
460
493
return differ.show_diff(specific_files, extra_trees)
462
495
new_tree.unlock()
620
653
# or removed in a diff.
621
654
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
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):
656
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
657
old_label='', new_label='', text_differ=internal_diff):
626
658
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
627
659
self.text_differ = text_differ
628
660
self.old_label = old_label
629
661
self.new_label = new_label
630
662
self.path_encoding = path_encoding
631
self.context_lines = context_lines
633
664
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
634
665
"""Compare two files in unified diff format
676
707
def _get_text(tree, file_id, path):
677
708
if file_id is not None:
678
return tree.get_file_lines(file_id, path)
709
return tree.get_file(file_id, path).readlines()
682
713
from_text = _get_text(self.old_tree, from_file_id, from_path)
683
714
to_text = _get_text(self.new_tree, to_file_id, to_path)
684
715
self.text_differ(from_label, from_text, to_label, to_text,
685
self.to_file, path_encoding=self.path_encoding,
686
context_lines=self.context_lines)
687
717
except errors.BinaryFile:
688
718
self.to_file.write(
689
719
("Binary files %s and %s differ\n" %
690
(from_label, to_label)).encode(self.path_encoding,'replace'))
720
(from_label, to_label)).encode(self.path_encoding))
691
721
return self.CHANGED
712
def make_from_diff_tree(klass, command_string, external_diff_options=None):
742
def make_from_diff_tree(klass, command_string):
713
743
def from_diff_tree(diff_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,
744
return klass.from_string(command_string, diff_tree.old_tree,
718
745
diff_tree.new_tree, diff_tree.to_file)
719
746
return from_diff_tree
721
748
def _get_command(self, old_path, new_path):
722
749
my_map = {'old_path': old_path, 'new_path': new_path}
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
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
736
753
def _execute(self, old_path, new_path):
737
754
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)
788
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
789
778
allow_write=False):
790
779
if not force_temp and isinstance(tree, WorkingTree):
791
full_path = tree.abspath(tree.id2path(file_id))
792
if self._is_safepath(full_path):
795
full_path = self._safe_filename(prefix, relpath)
780
return tree.abspath(tree.id2path(file_id))
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
796
783
if not force_temp and self._try_symlink_root(tree, prefix):
798
785
parent_dir = osutils.dirname(full_path)
856
843
old_path = self.old_tree.id2path(file_id)
857
844
new_path = self.new_tree.id2path(file_id)
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)
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))
863
850
subprocess.call(command, cwd=self._root)
864
new_file = open(new_abs_path, 'rb')
851
new_file = open(new_abs_path, 'r')
866
853
return new_file.read()
914
901
def from_trees_options(klass, old_tree, new_tree, to_file,
915
902
path_encoding, external_diff_options, old_label,
916
new_label, using, context_lines):
917
904
"""Factory for producing a DiffTree.
919
906
Designed to accept options used by show_diff_trees.
921
907
:param old_tree: The tree to show as old in the comparison
922
908
:param new_tree: The tree to show as new in the comparison
923
909
:param to_file: File to write comparisons to
929
915
:param using: Commandline to use to invoke an external diff tool
931
917
if using is not None:
932
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
918
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
934
920
extra_factories = []
935
921
if external_diff_options:
936
922
opts = external_diff_options.split()
937
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
938
""":param path_encoding: not used but required
939
to match the signature of internal_diff.
923
def diff_file(olab, olines, nlab, nlines, to_file):
941
924
external_diff(olab, olines, nlab, nlines, to_file, opts)
943
926
diff_file = internal_diff
944
927
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
945
old_label, new_label, diff_file, context_lines=context_lines)
928
old_label, new_label, diff_file)
946
929
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
added
removed
bzrlib/diff.py
