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