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
41
43
from bzrlib.workingtree import WorkingTree
42
from bzrlib.i18n import gettext
45
from bzrlib.registry import (
46
from bzrlib.symbol_versioning import (
48
49
from bzrlib.trace import mutter, note, warning
94
95
if sequence_matcher is None:
95
96
sequence_matcher = patiencediff.PatienceSequenceMatcher
96
97
ud = patiencediff.unified_diff(oldlines, newlines,
97
fromfile=old_filename.encode(path_encoding, 'replace'),
98
tofile=new_filename.encode(path_encoding, 'replace'),
98
fromfile=old_filename.encode(path_encoding),
99
tofile=new_filename.encode(path_encoding),
99
100
sequencematcher=sequence_matcher)
288
def get_trees_and_branches_to_diff_locked(
289
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
289
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
290
291
"""Get the trees and specific files to diff given a list of paths.
292
293
This method works out the trees to be diff'ed and the files of
304
305
The url of the new branch or tree. If None, the tree to use is
305
306
taken from the first path, if any, or the current working tree.
307
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
308
will register cleanups that must be run to unlock the trees, etc.
309
307
:param apply_view:
310
308
if True and a view is set, apply the view or check that the paths
313
311
a tuple of (old_tree, new_tree, old_branch, new_branch,
314
312
specific_files, extra_trees) where extra_trees is a sequence of
315
additional trees to search in for file-ids. The trees and branches
316
will be read-locked until the cleanups registered via the add_cleanup
313
additional trees to search in for file-ids.
319
315
# Get the old and new revision specs
320
316
old_revision_spec = None
343
339
default_location = path_list[0]
344
340
other_paths = path_list[1:]
346
def lock_tree_or_branch(wt, br):
349
add_cleanup(wt.unlock)
352
add_cleanup(br.unlock)
354
342
# Get the old location
355
343
specific_files = []
356
344
if old_url is None:
357
345
old_url = default_location
358
346
working_tree, branch, relpath = \
359
347
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
360
lock_tree_or_branch(working_tree, branch)
361
348
if consider_relpath and relpath != '':
362
349
if working_tree is not None and apply_view:
363
350
views.check_path_in_view(working_tree, relpath)
371
358
if new_url != old_url:
372
359
working_tree, branch, relpath = \
373
360
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
374
lock_tree_or_branch(working_tree, branch)
375
361
if consider_relpath and relpath != '':
376
362
if working_tree is not None and apply_view:
377
363
views.check_path_in_view(working_tree, relpath)
383
369
# Get the specific files (all files is None, no files is [])
384
370
if make_paths_wt_relative and working_tree is not None:
385
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,
387
374
apply_view=apply_view)
375
except errors.FileInWrongBranch:
376
raise errors.BzrCommandError("Files are in different branches")
388
377
specific_files.extend(other_paths)
389
378
if len(specific_files) == 0:
390
379
specific_files = None
395
384
specific_files = view_files
396
385
view_str = views.view_display_str(view_files)
397
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
386
note("*** Ignoring files outside view. View is %s" % view_str)
399
388
# Get extra trees that ought to be searched for file-ids
400
389
extra_trees = None
401
390
if working_tree is not None and working_tree not in (old_tree, new_tree):
402
391
extra_trees = (working_tree,)
403
return (old_tree, new_tree, old_branch, new_branch,
404
specific_files, extra_trees)
392
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
407
395
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
423
411
old_label='a/', new_label='b/',
424
412
extra_trees=None,
425
413
path_encoding='utf8',
428
415
"""Show in text form the changes from one tree to another.
430
:param to_file: The output stream.
431
:param specific_files: Include only changes to these files - None for all
433
:param external_diff_options: If set, use an external GNU diff and pass
435
:param extra_trees: If set, more Trees to use for looking up file ids
436
:param path_encoding: If set, the path will be encoded as specified,
437
otherwise is supposed to be utf8
438
: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
440
if format_cls is None:
441
format_cls = DiffTree
442
433
old_tree.lock_read()
444
435
if extra_trees is not None:
447
438
new_tree.lock_read()
449
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
451
external_diff_options,
452
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)
453
444
return differ.show_diff(specific_files, extra_trees)
455
446
new_tree.unlock()
667
658
def _get_text(tree, file_id, path):
668
659
if file_id is not None:
669
return tree.get_file_lines(file_id, path)
660
return tree.get_file(file_id, path).readlines()
673
664
from_text = _get_text(self.old_tree, from_file_id, from_path)
674
665
to_text = _get_text(self.new_tree, to_file_id, to_path)
675
666
self.text_differ(from_label, from_text, to_label, to_text,
676
self.to_file, path_encoding=self.path_encoding)
677
668
except errors.BinaryFile:
678
669
self.to_file.write(
679
670
("Binary files %s and %s differ\n" %
680
(from_label, to_label)).encode(self.path_encoding,'replace'))
671
(from_label, to_label)).encode(self.path_encoding))
681
672
return self.CHANGED
702
def make_from_diff_tree(klass, command_string, external_diff_options=None):
693
def make_from_diff_tree(klass, command_string):
703
694
def from_diff_tree(diff_tree):
704
full_command_string = [command_string]
705
if external_diff_options is not None:
706
full_command_string += ' ' + external_diff_options
707
return klass.from_string(full_command_string, diff_tree.old_tree,
695
return klass.from_string(command_string, diff_tree.old_tree,
708
696
diff_tree.new_tree, diff_tree.to_file)
709
697
return from_diff_tree
711
699
def _get_command(self, old_path, new_path):
712
700
my_map = {'old_path': old_path, 'new_path': new_path}
713
command = [AtTemplate(t).substitute(my_map) for t in
714
self.command_template]
715
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
718
if isinstance(c, unicode):
719
command_encoded.append(c.encode('mbcs'))
721
command_encoded.append(c)
722
return command_encoded
701
return [AtTemplate(t).substitute(my_map) for t in
702
self.command_template]
726
704
def _execute(self, old_path, new_path):
727
705
command = self._get_command(old_path, new_path)
752
"""Returns safe encoding for passing file path to diff tool"""
753
if sys.platform == 'win32':
756
# Don't fallback to 'utf-8' because subprocess may not be able to
757
# handle utf-8 correctly when locale is not utf-8.
758
return sys.getfilesystemencoding() or 'ascii'
760
def _is_safepath(self, path):
761
"""Return true if `path` may be able to pass to subprocess."""
764
return path == path.encode(fenc).decode(fenc)
768
def _safe_filename(self, prefix, relpath):
769
"""Replace unsafe character in `relpath` then join `self._root`,
770
`prefix` and `relpath`."""
772
# encoded_str.replace('?', '_') may break multibyte char.
773
# So we should encode, decode, then replace(u'?', u'_')
774
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
775
relpath_tmp = relpath_tmp.replace(u'?', u'_')
776
return osutils.pathjoin(self._root, prefix, relpath_tmp)
778
728
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
729
allow_write=False):
780
730
if not force_temp and isinstance(tree, WorkingTree):
781
full_path = tree.abspath(tree.id2path(file_id))
782
if self._is_safepath(full_path):
785
full_path = self._safe_filename(prefix, relpath)
731
return tree.abspath(tree.id2path(file_id))
733
full_path = osutils.pathjoin(self._root, prefix, relpath)
786
734
if not force_temp and self._try_symlink_root(tree, prefix):
788
736
parent_dir = osutils.dirname(full_path)
752
osutils.make_readonly(full_path)
804
754
mtime = tree.get_file_mtime(file_id)
805
755
except errors.FileTimestampUnavailable:
808
os.utime(full_path, (mtime, mtime))
810
osutils.make_readonly(full_path)
757
os.utime(full_path, (mtime, mtime))
813
760
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
846
793
old_path = self.old_tree.id2path(file_id)
847
794
new_path = self.new_tree.id2path(file_id)
848
old_abs_path, new_abs_path = self._prepare_files(
849
file_id, old_path, new_path,
850
allow_write_new=True,
852
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))
853
800
subprocess.call(command, cwd=self._root)
854
new_file = open(new_abs_path, 'rb')
801
new_file = open(new_abs_path, 'r')
856
803
return new_file.read()
907
854
"""Factory for producing a DiffTree.
909
856
Designed to accept options used by show_diff_trees.
911
857
:param old_tree: The tree to show as old in the comparison
912
858
:param new_tree: The tree to show as new in the comparison
913
859
:param to_file: File to write comparisons to
919
865
:param using: Commandline to use to invoke an external diff tool
921
867
if using is not None:
922
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
868
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
924
870
extra_factories = []
925
871
if external_diff_options:
926
872
opts = external_diff_options.split()
927
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
928
""":param path_encoding: not used but required
929
to match the signature of internal_diff.
873
def diff_file(olab, olines, nlab, nlines, to_file):
931
874
external_diff(olab, olines, nlab, nlines, to_file, opts)
933
876
diff_file = internal_diff
939
882
def show_diff(self, specific_files, extra_trees=None):
940
883
"""Write tree diff to self.to_file
942
:param specific_files: the specific files to compare (recursive)
885
:param sepecific_files: the specific files to compare (recursive)
943
886
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
