1
# Copyright (C) 2005-2011 Canonical Ltd.
1
# Copyright (C) 2004, 2005, 2006 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
97
95
if sequence_matcher is None:
98
96
sequence_matcher = patiencediff.PatienceSequenceMatcher
99
97
ud = patiencediff.unified_diff(oldlines, newlines,
100
fromfile=old_filename.encode(path_encoding, 'replace'),
101
tofile=new_filename.encode(path_encoding, 'replace'),
98
fromfile=old_filename.encode(path_encoding),
99
tofile=new_filename.encode(path_encoding),
102
100
sequencematcher=sequence_matcher)
291
@deprecated_function(deprecated_in((2, 2, 0)))
292
289
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
293
290
apply_view=True):
294
291
"""Get the trees and specific files to diff given a list of paths.
314
311
a tuple of (old_tree, new_tree, old_branch, new_branch,
315
312
specific_files, extra_trees) where extra_trees is a sequence of
316
additional trees to search in for file-ids. The trees and branches
319
op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
320
return op.run_simple(path_list, revision_specs, old_url, new_url,
321
op.add_cleanup, apply_view=apply_view)
324
def get_trees_and_branches_to_diff_locked(
325
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
326
"""Get the trees and specific files to diff given a list of paths.
328
This method works out the trees to be diff'ed and the files of
329
interest within those trees.
332
the list of arguments passed to the diff command
333
:param revision_specs:
334
Zero, one or two RevisionSpecs from the diff command line,
335
saying what revisions to compare.
337
The url of the old branch or tree. If None, the tree to use is
338
taken from the first path, if any, or the current working tree.
340
The url of the new branch or tree. If None, the tree to use is
341
taken from the first path, if any, or the current working tree.
343
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
344
will register cleanups that must be run to unlock the trees, etc.
346
if True and a view is set, apply the view or check that the paths
349
a tuple of (old_tree, new_tree, old_branch, new_branch,
350
specific_files, extra_trees) where extra_trees is a sequence of
351
additional trees to search in for file-ids. The trees and branches
352
will be read-locked until the cleanups registered via the add_cleanup
313
additional trees to search in for file-ids.
355
315
# Get the old and new revision specs
356
316
old_revision_spec = None
379
339
default_location = path_list[0]
380
340
other_paths = path_list[1:]
382
def lock_tree_or_branch(wt, br):
385
add_cleanup(wt.unlock)
388
add_cleanup(br.unlock)
390
342
# Get the old location
391
343
specific_files = []
392
344
if old_url is None:
393
345
old_url = default_location
394
346
working_tree, branch, relpath = \
395
347
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
396
lock_tree_or_branch(working_tree, branch)
397
348
if consider_relpath and relpath != '':
398
349
if working_tree is not None and apply_view:
399
350
views.check_path_in_view(working_tree, relpath)
407
358
if new_url != old_url:
408
359
working_tree, branch, relpath = \
409
360
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
410
lock_tree_or_branch(working_tree, branch)
411
361
if consider_relpath and relpath != '':
412
362
if working_tree is not None and apply_view:
413
363
views.check_path_in_view(working_tree, relpath)
419
369
# Get the specific files (all files is None, no files is [])
420
370
if make_paths_wt_relative and working_tree is not None:
421
other_paths = working_tree.safe_relpath_files(
372
from bzrlib.builtins import safe_relpath_files
373
other_paths = safe_relpath_files(working_tree, other_paths,
423
374
apply_view=apply_view)
375
except errors.FileInWrongBranch:
376
raise errors.BzrCommandError("Files are in different branches")
424
377
specific_files.extend(other_paths)
425
378
if len(specific_files) == 0:
426
379
specific_files = None
458
411
old_label='a/', new_label='b/',
459
412
extra_trees=None,
460
413
path_encoding='utf8',
463
415
"""Show in text form the changes from one tree to another.
465
:param to_file: The output stream.
466
:param specific_files: Include only changes to these files - None for all
468
:param external_diff_options: If set, use an external GNU diff and pass
470
:param extra_trees: If set, more Trees to use for looking up file ids
471
:param path_encoding: If set, the path will be encoded as specified,
472
otherwise is supposed to be utf8
473
:param format_cls: Formatter class (DiffTree subclass)
421
Include only changes to these files - None for all changes.
423
external_diff_options
424
If set, use an external GNU diff and pass these options.
427
If set, more Trees to use for looking up file ids
430
If set, the path will be encoded as specified, otherwise is supposed
475
if format_cls is None:
476
format_cls = DiffTree
477
433
old_tree.lock_read()
479
435
if extra_trees is not None:
482
438
new_tree.lock_read()
484
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
486
external_diff_options,
487
old_label, new_label, using)
440
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
442
external_diff_options,
443
old_label, new_label, using)
488
444
return differ.show_diff(specific_files, extra_trees)
490
446
new_tree.unlock()
702
658
def _get_text(tree, file_id, path):
703
659
if file_id is not None:
704
return tree.get_file_lines(file_id, path)
660
return tree.get_file(file_id, path).readlines()
708
664
from_text = _get_text(self.old_tree, from_file_id, from_path)
709
665
to_text = _get_text(self.new_tree, to_file_id, to_path)
710
666
self.text_differ(from_label, from_text, to_label, to_text,
711
self.to_file, path_encoding=self.path_encoding)
712
668
except errors.BinaryFile:
713
669
self.to_file.write(
714
670
("Binary files %s and %s differ\n" %
715
(from_label, to_label)).encode(self.path_encoding,'replace'))
671
(from_label, to_label)).encode(self.path_encoding))
716
672
return self.CHANGED
728
684
def from_string(klass, command_string, old_tree, new_tree, to_file,
729
685
path_encoding='utf-8'):
730
command_template = cmdline.split(command_string)
686
command_template = commands.shlex_split_unicode(command_string)
731
687
if '@' not in command_string:
732
688
command_template.extend(['@old_path', '@new_path'])
733
689
return klass(command_template, old_tree, new_tree, to_file,
737
def make_from_diff_tree(klass, command_string, external_diff_options=None):
693
def make_from_diff_tree(klass, command_string):
738
694
def from_diff_tree(diff_tree):
739
full_command_string = [command_string]
740
if external_diff_options is not None:
741
full_command_string += ' ' + external_diff_options
742
return klass.from_string(full_command_string, diff_tree.old_tree,
695
return klass.from_string(command_string, diff_tree.old_tree,
743
696
diff_tree.new_tree, diff_tree.to_file)
744
697
return from_diff_tree
746
699
def _get_command(self, old_path, new_path):
747
700
my_map = {'old_path': old_path, 'new_path': new_path}
748
command = [AtTemplate(t).substitute(my_map) for t in
749
self.command_template]
750
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
753
if isinstance(c, unicode):
754
command_encoded.append(c.encode('mbcs'))
756
command_encoded.append(c)
757
return command_encoded
701
return [AtTemplate(t).substitute(my_map) for t in
702
self.command_template]
761
704
def _execute(self, old_path, new_path):
762
705
command = self._get_command(old_path, new_path)
787
"""Returns safe encoding for passing file path to diff tool"""
788
if sys.platform == 'win32':
791
# Don't fallback to 'utf-8' because subprocess may not be able to
792
# handle utf-8 correctly when locale is not utf-8.
793
return sys.getfilesystemencoding() or 'ascii'
795
def _is_safepath(self, path):
796
"""Return true if `path` may be able to pass to subprocess."""
799
return path == path.encode(fenc).decode(fenc)
803
def _safe_filename(self, prefix, relpath):
804
"""Replace unsafe character in `relpath` then join `self._root`,
805
`prefix` and `relpath`."""
807
# encoded_str.replace('?', '_') may break multibyte char.
808
# So we should encode, decode, then replace(u'?', u'_')
809
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
810
relpath_tmp = relpath_tmp.replace(u'?', u'_')
811
return osutils.pathjoin(self._root, prefix, relpath_tmp)
813
728
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
814
729
allow_write=False):
815
730
if not force_temp and isinstance(tree, WorkingTree):
816
full_path = tree.abspath(tree.id2path(file_id))
817
if self._is_safepath(full_path):
820
full_path = self._safe_filename(prefix, relpath)
731
return tree.abspath(tree.id2path(file_id))
733
full_path = osutils.pathjoin(self._root, prefix, relpath)
821
734
if not force_temp and self._try_symlink_root(tree, prefix):
823
736
parent_dir = osutils.dirname(full_path)
752
osutils.make_readonly(full_path)
839
754
mtime = tree.get_file_mtime(file_id)
840
755
except errors.FileTimestampUnavailable:
843
os.utime(full_path, (mtime, mtime))
845
osutils.make_readonly(full_path)
757
os.utime(full_path, (mtime, mtime))
848
760
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
881
793
old_path = self.old_tree.id2path(file_id)
882
794
new_path = self.new_tree.id2path(file_id)
883
old_abs_path, new_abs_path = self._prepare_files(
884
file_id, old_path, new_path,
885
allow_write_new=True,
887
command = self._get_command(old_abs_path, new_abs_path)
795
new_abs_path = self._prepare_files(file_id, old_path, new_path,
796
allow_write_new=True,
798
command = self._get_command(osutils.pathjoin('old', old_path),
799
osutils.pathjoin('new', new_path))
888
800
subprocess.call(command, cwd=self._root)
889
new_file = open(new_abs_path, 'rb')
801
new_file = open(new_abs_path, 'r')
891
803
return new_file.read()
942
854
"""Factory for producing a DiffTree.
944
856
Designed to accept options used by show_diff_trees.
946
857
:param old_tree: The tree to show as old in the comparison
947
858
:param new_tree: The tree to show as new in the comparison
948
859
:param to_file: File to write comparisons to
954
865
:param using: Commandline to use to invoke an external diff tool
956
867
if using is not None:
957
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
868
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
959
870
extra_factories = []
960
871
if external_diff_options:
961
872
opts = external_diff_options.split()
962
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
963
""":param path_encoding: not used but required
964
to match the signature of internal_diff.
873
def diff_file(olab, olines, nlab, nlines, to_file):
966
874
external_diff(olab, olines, nlab, nlines, to_file, opts)
968
876
diff_file = internal_diff
974
882
def show_diff(self, specific_files, extra_trees=None):
975
883
"""Write tree diff to self.to_file
977
:param specific_files: the specific files to compare (recursive)
885
:param sepecific_files: the specific files to compare (recursive)
978
886
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
