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
41
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.registry import (
46
from bzrlib.symbol_versioning import (
47
49
from bzrlib.trace import mutter, note, warning
93
95
if sequence_matcher is None:
94
96
sequence_matcher = patiencediff.PatienceSequenceMatcher
95
97
ud = patiencediff.unified_diff(oldlines, newlines,
96
fromfile=old_filename.encode(path_encoding, 'replace'),
97
tofile=new_filename.encode(path_encoding, 'replace'),
98
fromfile=old_filename.encode(path_encoding),
99
tofile=new_filename.encode(path_encoding),
98
100
sequencematcher=sequence_matcher)
287
def get_trees_and_branches_to_diff_locked(
288
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,
289
291
"""Get the trees and specific files to diff given a list of paths.
291
293
This method works out the trees to be diff'ed and the files of
303
305
The url of the new branch or tree. If None, the tree to use is
304
306
taken from the first path, if any, or the current working tree.
306
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
307
will register cleanups that must be run to unlock the trees, etc.
308
307
:param apply_view:
309
308
if True and a view is set, apply the view or check that the paths
312
311
a tuple of (old_tree, new_tree, old_branch, new_branch,
313
312
specific_files, extra_trees) where extra_trees is a sequence of
314
additional trees to search in for file-ids. The trees and branches
315
will be read-locked until the cleanups registered via the add_cleanup
313
additional trees to search in for file-ids.
318
315
# Get the old and new revision specs
319
316
old_revision_spec = None
342
339
default_location = path_list[0]
343
340
other_paths = path_list[1:]
345
def lock_tree_or_branch(wt, br):
348
add_cleanup(wt.unlock)
351
add_cleanup(br.unlock)
353
342
# Get the old location
354
343
specific_files = []
355
344
if old_url is None:
356
345
old_url = default_location
357
346
working_tree, branch, relpath = \
358
347
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
359
lock_tree_or_branch(working_tree, branch)
360
348
if consider_relpath and relpath != '':
361
349
if working_tree is not None and apply_view:
362
350
views.check_path_in_view(working_tree, relpath)
370
358
if new_url != old_url:
371
359
working_tree, branch, relpath = \
372
360
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
373
lock_tree_or_branch(working_tree, branch)
374
361
if consider_relpath and relpath != '':
375
362
if working_tree is not None and apply_view:
376
363
views.check_path_in_view(working_tree, relpath)
382
369
# Get the specific files (all files is None, no files is [])
383
370
if make_paths_wt_relative and working_tree is not None:
384
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,
386
374
apply_view=apply_view)
375
except errors.FileInWrongBranch:
376
raise errors.BzrCommandError("Files are in different branches")
387
377
specific_files.extend(other_paths)
388
378
if len(specific_files) == 0:
389
379
specific_files = None
399
389
extra_trees = None
400
390
if working_tree is not None and working_tree not in (old_tree, new_tree):
401
391
extra_trees = (working_tree,)
402
return (old_tree, new_tree, old_branch, new_branch,
403
specific_files, extra_trees)
392
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
406
395
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
422
411
old_label='a/', new_label='b/',
423
412
extra_trees=None,
424
413
path_encoding='utf8',
427
415
"""Show in text form the changes from one tree to another.
429
:param to_file: The output stream.
430
:param specific_files: Include only changes to these files - None for all
432
:param external_diff_options: If set, use an external GNU diff and pass
434
:param extra_trees: If set, more Trees to use for looking up file ids
435
:param path_encoding: If set, the path will be encoded as specified,
436
otherwise is supposed to be utf8
437
: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
439
if format_cls is None:
440
format_cls = DiffTree
441
433
old_tree.lock_read()
443
435
if extra_trees is not None:
446
438
new_tree.lock_read()
448
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
450
external_diff_options,
451
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)
452
444
return differ.show_diff(specific_files, extra_trees)
454
446
new_tree.unlock()
462
454
def _patch_header_date(tree, file_id, path):
463
455
"""Returns a timestamp suitable for use in a patch header."""
465
mtime = tree.get_file_mtime(file_id, path)
466
except errors.FileTimestampUnavailable:
456
mtime = tree.get_file_mtime(file_id, path)
468
457
return timestamp.format_patch_date(mtime)
666
655
def _get_text(tree, file_id, path):
667
656
if file_id is not None:
668
return tree.get_file_lines(file_id, path)
657
return tree.get_file(file_id, path).readlines()
672
661
from_text = _get_text(self.old_tree, from_file_id, from_path)
673
662
to_text = _get_text(self.new_tree, to_file_id, to_path)
674
663
self.text_differ(from_label, from_text, to_label, to_text,
675
self.to_file, path_encoding=self.path_encoding)
676
665
except errors.BinaryFile:
677
666
self.to_file.write(
678
667
("Binary files %s and %s differ\n" %
679
(from_label, to_label)).encode(self.path_encoding,'replace'))
668
(from_label, to_label)).encode(self.path_encoding))
680
669
return self.CHANGED
692
681
def from_string(klass, command_string, old_tree, new_tree, to_file,
693
682
path_encoding='utf-8'):
694
command_template = cmdline.split(command_string)
683
command_template = commands.shlex_split_unicode(command_string)
695
684
if '@' not in command_string:
696
685
command_template.extend(['@old_path', '@new_path'])
697
686
return klass(command_template, old_tree, new_tree, to_file,
701
def make_from_diff_tree(klass, command_string, external_diff_options=None):
690
def make_from_diff_tree(klass, command_string):
702
691
def from_diff_tree(diff_tree):
703
full_command_string = [command_string]
704
if external_diff_options is not None:
705
full_command_string += ' ' + external_diff_options
706
return klass.from_string(full_command_string, diff_tree.old_tree,
692
return klass.from_string(command_string, diff_tree.old_tree,
707
693
diff_tree.new_tree, diff_tree.to_file)
708
694
return from_diff_tree
710
696
def _get_command(self, old_path, new_path):
711
697
my_map = {'old_path': old_path, 'new_path': new_path}
712
command = [AtTemplate(t).substitute(my_map) for t in
713
self.command_template]
714
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
717
if isinstance(c, unicode):
718
command_encoded.append(c.encode('mbcs'))
720
command_encoded.append(c)
721
return command_encoded
698
return [AtTemplate(t).substitute(my_map) for t in
699
self.command_template]
725
701
def _execute(self, old_path, new_path):
726
702
command = self._get_command(old_path, new_path)
751
"""Returns safe encoding for passing file path to diff tool"""
752
if sys.platform == 'win32':
755
# Don't fallback to 'utf-8' because subprocess may not be able to
756
# handle utf-8 correctly when locale is not utf-8.
757
return sys.getfilesystemencoding() or 'ascii'
759
def _is_safepath(self, path):
760
"""Return true if `path` may be able to pass to subprocess."""
763
return path == path.encode(fenc).decode(fenc)
767
def _safe_filename(self, prefix, relpath):
768
"""Replace unsafe character in `relpath` then join `self._root`,
769
`prefix` and `relpath`."""
771
# encoded_str.replace('?', '_') may break multibyte char.
772
# So we should encode, decode, then replace(u'?', u'_')
773
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
774
relpath_tmp = relpath_tmp.replace(u'?', u'_')
775
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
725
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
726
allow_write=False):
779
727
if not force_temp and isinstance(tree, WorkingTree):
780
full_path = tree.abspath(tree.id2path(file_id))
781
if self._is_safepath(full_path):
784
full_path = self._safe_filename(prefix, relpath)
728
return tree.abspath(tree.id2path(file_id))
730
full_path = osutils.pathjoin(self._root, prefix, relpath)
785
731
if not force_temp and self._try_symlink_root(tree, prefix):
787
733
parent_dir = osutils.dirname(full_path)
803
mtime = tree.get_file_mtime(file_id)
804
except errors.FileTimestampUnavailable:
807
os.utime(full_path, (mtime, mtime))
808
748
if not allow_write:
809
749
osutils.make_readonly(full_path)
750
mtime = tree.get_file_mtime(file_id)
751
os.utime(full_path, (mtime, mtime))
812
754
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
845
787
old_path = self.old_tree.id2path(file_id)
846
788
new_path = self.new_tree.id2path(file_id)
847
old_abs_path, new_abs_path = self._prepare_files(
848
file_id, old_path, new_path,
849
allow_write_new=True,
851
command = self._get_command(old_abs_path, new_abs_path)
789
new_abs_path = self._prepare_files(file_id, old_path, new_path,
790
allow_write_new=True,
792
command = self._get_command(osutils.pathjoin('old', old_path),
793
osutils.pathjoin('new', new_path))
852
794
subprocess.call(command, cwd=self._root)
853
new_file = open(new_abs_path, 'rb')
795
new_file = open(new_abs_path, 'r')
855
797
return new_file.read()
906
848
"""Factory for producing a DiffTree.
908
850
Designed to accept options used by show_diff_trees.
910
851
:param old_tree: The tree to show as old in the comparison
911
852
:param new_tree: The tree to show as new in the comparison
912
853
:param to_file: File to write comparisons to
918
859
:param using: Commandline to use to invoke an external diff tool
920
861
if using is not None:
921
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
862
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
923
864
extra_factories = []
924
865
if external_diff_options:
925
866
opts = external_diff_options.split()
926
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
927
""":param path_encoding: not used but required
928
to match the signature of internal_diff.
867
def diff_file(olab, olines, nlab, nlines, to_file):
930
868
external_diff(olab, olines, nlab, nlines, to_file, opts)
932
870
diff_file = internal_diff
938
876
def show_diff(self, specific_files, extra_trees=None):
939
877
"""Write tree diff to self.to_file
941
:param specific_files: the specific files to compare (recursive)
879
:param sepecific_files: the specific files to compare (recursive)
942
880
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
