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
from bzrlib.symbol_versioning import (
47
from bzrlib.registry import (
49
50
from bzrlib.trace import mutter, note, warning
95
96
if sequence_matcher is None:
96
97
sequence_matcher = patiencediff.PatienceSequenceMatcher
97
98
ud = patiencediff.unified_diff(oldlines, newlines,
98
fromfile=old_filename.encode(path_encoding),
99
tofile=new_filename.encode(path_encoding),
99
fromfile=old_filename.encode(path_encoding, 'replace'),
100
tofile=new_filename.encode(path_encoding, 'replace'),
100
101
sequencematcher=sequence_matcher)
289
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
290
def get_trees_and_branches_to_diff_locked(
291
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
291
292
"""Get the trees and specific files to diff given a list of paths.
293
294
This method works out the trees to be diff'ed and the files of
305
306
The url of the new branch or tree. If None, the tree to use is
306
307
taken from the first path, if any, or the current working tree.
309
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
310
will register cleanups that must be run to unlock the trees, etc.
307
311
:param apply_view:
308
312
if True and a view is set, apply the view or check that the paths
311
315
a tuple of (old_tree, new_tree, old_branch, new_branch,
312
316
specific_files, extra_trees) where extra_trees is a sequence of
313
additional trees to search in for file-ids.
317
additional trees to search in for file-ids. The trees and branches
318
will be read-locked until the cleanups registered via the add_cleanup
315
321
# Get the old and new revision specs
316
322
old_revision_spec = None
339
345
default_location = path_list[0]
340
346
other_paths = path_list[1:]
348
def lock_tree_or_branch(wt, br):
351
add_cleanup(wt.unlock)
354
add_cleanup(br.unlock)
342
356
# Get the old location
343
357
specific_files = []
344
358
if old_url is None:
345
359
old_url = default_location
346
360
working_tree, branch, relpath = \
347
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
361
controldir.ControlDir.open_containing_tree_or_branch(old_url)
362
lock_tree_or_branch(working_tree, branch)
348
363
if consider_relpath and relpath != '':
349
364
if working_tree is not None and apply_view:
350
365
views.check_path_in_view(working_tree, relpath)
357
372
new_url = default_location
358
373
if new_url != old_url:
359
374
working_tree, branch, relpath = \
360
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
375
controldir.ControlDir.open_containing_tree_or_branch(new_url)
376
lock_tree_or_branch(working_tree, branch)
361
377
if consider_relpath and relpath != '':
362
378
if working_tree is not None and apply_view:
363
379
views.check_path_in_view(working_tree, relpath)
369
385
# Get the specific files (all files is None, no files is [])
370
386
if make_paths_wt_relative and working_tree is not None:
372
from bzrlib.builtins import safe_relpath_files
373
other_paths = safe_relpath_files(working_tree, other_paths,
387
other_paths = working_tree.safe_relpath_files(
374
389
apply_view=apply_view)
375
except errors.FileInWrongBranch:
376
raise errors.BzrCommandError("Files are in different branches")
377
390
specific_files.extend(other_paths)
378
391
if len(specific_files) == 0:
379
392
specific_files = None
384
397
specific_files = view_files
385
398
view_str = views.view_display_str(view_files)
386
note("*** Ignoring files outside view. View is %s" % view_str)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
388
401
# Get extra trees that ought to be searched for file-ids
389
402
extra_trees = None
390
403
if working_tree is not None and working_tree not in (old_tree, new_tree):
391
404
extra_trees = (working_tree,)
392
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
405
return (old_tree, new_tree, old_branch, new_branch,
406
specific_files, extra_trees)
395
409
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
411
425
old_label='a/', new_label='b/',
412
426
extra_trees=None,
413
427
path_encoding='utf8',
415
430
"""Show in text form the changes from one tree to another.
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
432
:param to_file: The output stream.
433
:param specific_files: Include only changes to these files - None for all
435
:param external_diff_options: If set, use an external GNU diff and pass
437
:param extra_trees: If set, more Trees to use for looking up file ids
438
:param path_encoding: If set, the path will be encoded as specified,
439
otherwise is supposed to be utf8
440
:param format_cls: Formatter class (DiffTree subclass)
442
if format_cls is None:
443
format_cls = DiffTree
433
444
old_tree.lock_read()
435
446
if extra_trees is not None:
438
449
new_tree.lock_read()
440
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
442
external_diff_options,
443
old_label, new_label, using)
451
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
453
external_diff_options,
454
old_label, new_label, using)
444
455
return differ.show_diff(specific_files, extra_trees)
446
457
new_tree.unlock()
658
669
def _get_text(tree, file_id, path):
659
670
if file_id is not None:
660
return tree.get_file(file_id, path).readlines()
671
return tree.get_file_lines(file_id, path)
664
675
from_text = _get_text(self.old_tree, from_file_id, from_path)
665
676
to_text = _get_text(self.new_tree, to_file_id, to_path)
666
677
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
668
679
except errors.BinaryFile:
669
680
self.to_file.write(
670
681
("Binary files %s and %s differ\n" %
671
(from_label, to_label)).encode(self.path_encoding))
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
672
683
return self.CHANGED
693
def make_from_diff_tree(klass, command_string):
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
694
705
def from_diff_tree(diff_tree):
695
return klass.from_string(command_string, diff_tree.old_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,
696
710
diff_tree.new_tree, diff_tree.to_file)
697
711
return from_diff_tree
699
713
def _get_command(self, old_path, new_path):
700
714
my_map = {'old_path': old_path, 'new_path': new_path}
701
return [AtTemplate(t).substitute(my_map) for t in
702
self.command_template]
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
704
728
def _execute(self, old_path, new_path):
705
729
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)
728
780
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
729
781
allow_write=False):
730
782
if not force_temp and isinstance(tree, WorkingTree):
731
return tree.abspath(tree.id2path(file_id))
733
full_path = osutils.pathjoin(self._root, prefix, relpath)
783
full_path = tree.abspath(tree.id2path(file_id))
784
if self._is_safepath(full_path):
787
full_path = self._safe_filename(prefix, relpath)
734
788
if not force_temp and self._try_symlink_root(tree, prefix):
736
790
parent_dir = osutils.dirname(full_path)
806
mtime = tree.get_file_mtime(file_id)
807
except errors.FileTimestampUnavailable:
810
os.utime(full_path, (mtime, mtime))
751
811
if not allow_write:
752
812
osutils.make_readonly(full_path)
754
mtime = tree.get_file_mtime(file_id)
755
except errors.FileTimestampUnavailable:
757
os.utime(full_path, (mtime, mtime))
760
815
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
793
848
old_path = self.old_tree.id2path(file_id)
794
849
new_path = self.new_tree.id2path(file_id)
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))
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)
800
855
subprocess.call(command, cwd=self._root)
801
new_file = open(new_abs_path, 'r')
856
new_file = open(new_abs_path, 'rb')
803
858
return new_file.read()
854
909
"""Factory for producing a DiffTree.
856
911
Designed to accept options used by show_diff_trees.
857
913
:param old_tree: The tree to show as old in the comparison
858
914
:param new_tree: The tree to show as new in the comparison
859
915
:param to_file: File to write comparisons to
865
921
:param using: Commandline to use to invoke an external diff tool
867
923
if using is not None:
868
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
870
926
extra_factories = []
871
927
if external_diff_options:
872
928
opts = external_diff_options.split()
873
def diff_file(olab, olines, nlab, nlines, to_file):
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.
874
933
external_diff(olab, olines, nlab, nlines, to_file, opts)
876
935
diff_file = internal_diff
882
941
def show_diff(self, specific_files, extra_trees=None):
883
942
"""Write tree diff to self.to_file
885
:param sepecific_files: the specific files to compare (recursive)
944
:param specific_files: the specific files to compare (recursive)
886
945
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
