1
# Copyright (C) 2004, 2005, 2006 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
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
44
from bzrlib.symbol_versioning import (
47
from bzrlib.registry import (
47
50
from bzrlib.trace import mutter, note, warning
93
96
if sequence_matcher is None:
94
97
sequence_matcher = patiencediff.PatienceSequenceMatcher
95
98
ud = patiencediff.unified_diff(oldlines, newlines,
96
fromfile=old_filename.encode(path_encoding),
97
tofile=new_filename.encode(path_encoding),
99
fromfile=old_filename.encode(path_encoding, 'replace'),
100
tofile=new_filename.encode(path_encoding, 'replace'),
98
101
sequencematcher=sequence_matcher)
287
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):
289
292
"""Get the trees and specific files to diff given a list of paths.
291
294
This method works out the trees to be diff'ed and the files of
303
306
The url of the new branch or tree. If None, the tree to use is
304
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.
305
311
:param apply_view:
306
312
if True and a view is set, apply the view or check that the paths
309
315
a tuple of (old_tree, new_tree, old_branch, new_branch,
310
316
specific_files, extra_trees) where extra_trees is a sequence of
311
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
313
321
# Get the old and new revision specs
314
322
old_revision_spec = None
337
345
default_location = path_list[0]
338
346
other_paths = path_list[1:]
348
def lock_tree_or_branch(wt, br):
351
add_cleanup(wt.unlock)
354
add_cleanup(br.unlock)
340
356
# Get the old location
341
357
specific_files = []
342
358
if old_url is None:
343
359
old_url = default_location
344
360
working_tree, branch, relpath = \
345
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)
346
363
if consider_relpath and relpath != '':
347
364
if working_tree is not None and apply_view:
348
365
views.check_path_in_view(working_tree, relpath)
355
372
new_url = default_location
356
373
if new_url != old_url:
357
374
working_tree, branch, relpath = \
358
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)
359
377
if consider_relpath and relpath != '':
360
378
if working_tree is not None and apply_view:
361
379
views.check_path_in_view(working_tree, relpath)
367
385
# Get the specific files (all files is None, no files is [])
368
386
if make_paths_wt_relative and working_tree is not None:
370
from bzrlib.builtins import safe_relpath_files
371
other_paths = safe_relpath_files(working_tree, other_paths,
387
other_paths = working_tree.safe_relpath_files(
372
389
apply_view=apply_view)
373
except errors.FileInWrongBranch:
374
raise errors.BzrCommandError("Files are in different branches")
375
390
specific_files.extend(other_paths)
376
391
if len(specific_files) == 0:
377
392
specific_files = None
382
397
specific_files = view_files
383
398
view_str = views.view_display_str(view_files)
384
note("*** Ignoring files outside view. View is %s" % view_str)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
386
401
# Get extra trees that ought to be searched for file-ids
387
402
extra_trees = None
388
403
if working_tree is not None and working_tree not in (old_tree, new_tree):
389
404
extra_trees = (working_tree,)
390
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)
393
409
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
409
425
old_label='a/', new_label='b/',
410
426
extra_trees=None,
411
427
path_encoding='utf8',
413
430
"""Show in text form the changes from one tree to another.
419
Include only changes to these files - None for all changes.
421
external_diff_options
422
If set, use an external GNU diff and pass these options.
425
If set, more Trees to use for looking up file ids
428
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
431
444
old_tree.lock_read()
433
446
if extra_trees is not None:
436
449
new_tree.lock_read()
438
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
440
external_diff_options,
441
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)
442
455
return differ.show_diff(specific_files, extra_trees)
444
457
new_tree.unlock()
452
465
def _patch_header_date(tree, file_id, path):
453
466
"""Returns a timestamp suitable for use in a patch header."""
454
mtime = tree.get_file_mtime(file_id, path)
468
mtime = tree.get_file_mtime(file_id, path)
469
except errors.FileTimestampUnavailable:
455
471
return timestamp.format_patch_date(mtime)
653
669
def _get_text(tree, file_id, path):
654
670
if file_id is not None:
655
return tree.get_file(file_id, path).readlines()
671
return tree.get_file_lines(file_id, path)
659
675
from_text = _get_text(self.old_tree, from_file_id, from_path)
660
676
to_text = _get_text(self.new_tree, to_file_id, to_path)
661
677
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
663
679
except errors.BinaryFile:
664
680
self.to_file.write(
665
681
("Binary files %s and %s differ\n" %
666
(from_label, to_label)).encode(self.path_encoding))
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
667
683
return self.CHANGED
679
695
def from_string(klass, command_string, old_tree, new_tree, to_file,
680
696
path_encoding='utf-8'):
681
command_template = commands.shlex_split_unicode(command_string)
697
command_template = cmdline.split(command_string)
682
698
if '@' not in command_string:
683
699
command_template.extend(['@old_path', '@new_path'])
684
700
return klass(command_template, old_tree, new_tree, to_file,
688
def make_from_diff_tree(klass, command_string):
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
689
705
def from_diff_tree(diff_tree):
690
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,
691
710
diff_tree.new_tree, diff_tree.to_file)
692
711
return from_diff_tree
694
713
def _get_command(self, old_path, new_path):
695
714
my_map = {'old_path': old_path, 'new_path': new_path}
696
return [AtTemplate(t).substitute(my_map) for t in
697
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
699
728
def _execute(self, old_path, new_path):
700
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)
723
780
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
724
781
allow_write=False):
725
full_path = osutils.pathjoin(self._root, prefix, relpath)
782
if not force_temp and isinstance(tree, WorkingTree):
783
full_path = tree.abspath(tree.id2path(file_id))
784
if self._is_safepath(full_path):
787
full_path = self._safe_filename(prefix, relpath)
726
788
if not force_temp and self._try_symlink_root(tree, prefix):
728
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))
743
811
if not allow_write:
744
812
osutils.make_readonly(full_path)
745
mtime = tree.get_file_mtime(file_id)
746
os.utime(full_path, (mtime, mtime))
749
815
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
766
832
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
767
833
if (old_kind, new_kind) != ('file', 'file'):
768
834
return DiffPath.CANNOT_DIFF
769
self._prepare_files(file_id, old_path, new_path)
770
self._execute(osutils.pathjoin('old', old_path),
771
osutils.pathjoin('new', new_path))
835
(old_disk_path, new_disk_path) = self._prepare_files(
836
file_id, old_path, new_path)
837
self._execute(old_disk_path, new_disk_path)
773
839
def edit_file(self, file_id):
774
840
"""Use this tool to edit a file.
782
848
old_path = self.old_tree.id2path(file_id)
783
849
new_path = self.new_tree.id2path(file_id)
784
new_abs_path = self._prepare_files(file_id, old_path, new_path,
785
allow_write_new=True,
787
command = self._get_command(osutils.pathjoin('old', old_path),
788
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)
789
855
subprocess.call(command, cwd=self._root)
790
new_file = open(new_abs_path, 'r')
856
new_file = open(new_abs_path, 'rb')
792
858
return new_file.read()
843
909
"""Factory for producing a DiffTree.
845
911
Designed to accept options used by show_diff_trees.
846
913
:param old_tree: The tree to show as old in the comparison
847
914
:param new_tree: The tree to show as new in the comparison
848
915
:param to_file: File to write comparisons to
854
921
:param using: Commandline to use to invoke an external diff tool
856
923
if using is not None:
857
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
859
926
extra_factories = []
860
927
if external_diff_options:
861
928
opts = external_diff_options.split()
862
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.
863
933
external_diff(olab, olines, nlab, nlines, to_file, opts)
865
935
diff_file = internal_diff
871
941
def show_diff(self, specific_files, extra_trees=None):
872
942
"""Write tree diff to self.to_file
874
:param sepecific_files: the specific files to compare (recursive)
944
:param specific_files: the specific files to compare (recursive)
875
945
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
