13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
from __future__ import absolute_import
23
25
from bzrlib.lazy_import import lazy_import
30
31
from bzrlib import (
31
branch as _mod_branch,
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
42
from bzrlib.symbol_versioning import (
46
from bzrlib.trace import mutter, warning
47
from bzrlib.registry import (
50
from bzrlib.trace import mutter, note, warning
52
DEFAULT_CONTEXT_AMOUNT = 3
54
class AtTemplate(string.Template):
55
"""Templating class that uses @ instead of $."""
49
60
# TODO: Rather than building a changeset object, we should probably
63
74
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
64
75
allow_binary=False, sequence_matcher=None,
65
path_encoding='utf8'):
76
path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
66
77
# FIXME: difflib is wrong if there is no trailing newline.
67
78
# The syntax used by patch seems to be "\ No newline at
68
79
# end of file" following the last diff line from that
86
97
if sequence_matcher is None:
87
98
sequence_matcher = patiencediff.PatienceSequenceMatcher
88
99
ud = patiencediff.unified_diff(oldlines, newlines,
89
fromfile=old_filename.encode(path_encoding),
90
tofile=new_filename.encode(path_encoding),
91
sequencematcher=sequence_matcher)
100
fromfile=old_filename.encode(path_encoding, 'replace'),
101
tofile=new_filename.encode(path_encoding, 'replace'),
102
n=context_lines, sequencematcher=sequence_matcher)
94
105
if len(ud) == 0: # Identical contents, nothing to do
278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
291
def get_trees_and_branches_to_diff_locked(
292
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
279
293
"""Get the trees and specific files to diff given a list of paths.
281
295
This method works out the trees to be diff'ed and the files of
293
307
The url of the new branch or tree. If None, the tree to use is
294
308
taken from the first path, if any, or the current working tree.
310
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
311
will register cleanups that must be run to unlock the trees, etc.
313
if True and a view is set, apply the view or check that the paths
296
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
297
extra_trees is a sequence of additional trees to search in for
316
a tuple of (old_tree, new_tree, old_branch, new_branch,
317
specific_files, extra_trees) where extra_trees is a sequence of
318
additional trees to search in for file-ids. The trees and branches
319
will be read-locked until the cleanups registered via the add_cleanup
300
322
# Get the old and new revision specs
301
323
old_revision_spec = None
324
346
default_location = path_list[0]
325
347
other_paths = path_list[1:]
349
def lock_tree_or_branch(wt, br):
352
add_cleanup(wt.unlock)
355
add_cleanup(br.unlock)
327
357
# Get the old location
328
358
specific_files = []
329
359
if old_url is None:
330
360
old_url = default_location
331
361
working_tree, branch, relpath = \
332
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
362
controldir.ControlDir.open_containing_tree_or_branch(old_url)
363
lock_tree_or_branch(working_tree, branch)
333
364
if consider_relpath and relpath != '':
365
if working_tree is not None and apply_view:
366
views.check_path_in_view(working_tree, relpath)
334
367
specific_files.append(relpath)
335
368
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
337
371
# Get the new location
338
372
if new_url is None:
339
373
new_url = default_location
340
374
if new_url != old_url:
341
375
working_tree, branch, relpath = \
342
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
376
controldir.ControlDir.open_containing_tree_or_branch(new_url)
377
lock_tree_or_branch(working_tree, branch)
343
378
if consider_relpath and relpath != '':
379
if working_tree is not None and apply_view:
380
views.check_path_in_view(working_tree, relpath)
344
381
specific_files.append(relpath)
345
382
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
346
383
basis_is_default=working_tree is None)
348
386
# Get the specific files (all files is None, no files is [])
349
387
if make_paths_wt_relative and working_tree is not None:
350
other_paths = _relative_paths_in_tree(working_tree, other_paths)
388
other_paths = working_tree.safe_relpath_files(
390
apply_view=apply_view)
351
391
specific_files.extend(other_paths)
352
392
if len(specific_files) == 0:
353
393
specific_files = None
394
if (working_tree is not None and working_tree.supports_views()
396
view_files = working_tree.views.lookup_view()
398
specific_files = view_files
399
view_str = views.view_display_str(view_files)
400
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
355
402
# Get extra trees that ought to be searched for file-ids
356
403
extra_trees = None
357
404
if working_tree is not None and working_tree not in (old_tree, new_tree):
358
405
extra_trees = (working_tree,)
359
return old_tree, new_tree, specific_files, extra_trees
406
return (old_tree, new_tree, old_branch, new_branch,
407
specific_files, extra_trees)
362
410
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
370
418
return branch.basis_tree()
373
if not spec.needs_branch():
374
branch = _mod_branch.Branch.open(spec.get_branch())
375
revision_id = spec.as_revision_id(branch)
376
return branch.repository.revision_tree(revision_id)
379
def _relative_paths_in_tree(tree, paths):
380
"""Get the relative paths within a working tree.
382
Each path may be either an absolute path or a path relative to the
383
current working directory.
386
for filename in paths:
388
result.append(tree.relpath(osutils.dereference_path(filename)))
389
except errors.PathNotChild:
390
raise errors.BzrCommandError("Files are in different branches")
421
return spec.as_tree(branch)
394
424
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
396
426
old_label='a/', new_label='b/',
397
427
extra_trees=None,
398
428
path_encoding='utf8',
431
context=DEFAULT_CONTEXT_AMOUNT):
400
432
"""Show in text form the changes from one tree to another.
406
Include only changes to these files - None for all changes.
408
external_diff_options
409
If set, use an external GNU diff and pass these options.
412
If set, more Trees to use for looking up file ids
415
If set, the path will be encoded as specified, otherwise is supposed
434
:param to_file: The output stream.
435
:param specific_files: Include only changes to these files - None for all
437
:param external_diff_options: If set, use an external GNU diff and pass
439
:param extra_trees: If set, more Trees to use for looking up file ids
440
:param path_encoding: If set, the path will be encoded as specified,
441
otherwise is supposed to be utf8
442
:param format_cls: Formatter class (DiffTree subclass)
445
context = DEFAULT_CONTEXT_AMOUNT
446
if format_cls is None:
447
format_cls = DiffTree
418
448
old_tree.lock_read()
420
450
if extra_trees is not None:
423
453
new_tree.lock_read()
425
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
427
external_diff_options,
428
old_label, new_label, using)
455
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
457
external_diff_options,
458
old_label, new_label, using,
459
context_lines=context)
429
460
return differ.show_diff(specific_files, extra_trees)
431
462
new_tree.unlock()
439
470
def _patch_header_date(tree, file_id, path):
440
471
"""Returns a timestamp suitable for use in a patch header."""
441
mtime = tree.get_file_mtime(file_id, path)
473
mtime = tree.get_file_mtime(file_id, path)
474
except errors.FileTimestampUnavailable:
442
476
return timestamp.format_patch_date(mtime)
445
def _raise_if_nonexistent(paths, old_tree, new_tree):
446
"""Complain if paths are not in either inventory or tree.
448
It's OK with the files exist in either tree's inventory, or
449
if they exist in the tree but are not versioned.
451
This can be used by operations such as bzr status that can accept
452
unknown or ignored files.
454
mutter("check paths: %r", paths)
457
s = old_tree.filter_unversioned_files(paths)
458
s = new_tree.filter_unversioned_files(s)
459
s = [path for path in s if not new_tree.has_filename(path)]
461
raise errors.PathsDoNotExist(sorted(s))
464
@deprecated_function(one_three)
465
def get_prop_change(meta_modified):
467
return " (properties changed)"
471
479
def get_executable_change(old_is_x, new_is_x):
472
480
descr = { True:"+x", False:"-x", None:"??" }
473
481
if old_is_x != new_is_x:
612
620
# or removed in a diff.
613
621
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
615
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
616
old_label='', new_label='', text_differ=internal_diff):
623
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
624
old_label='', new_label='', text_differ=internal_diff,
625
context_lines=DEFAULT_CONTEXT_AMOUNT):
617
626
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
618
627
self.text_differ = text_differ
619
628
self.old_label = old_label
620
629
self.new_label = new_label
621
630
self.path_encoding = path_encoding
631
self.context_lines = context_lines
623
633
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
624
634
"""Compare two files in unified diff format
648
658
return self.CANNOT_DIFF
649
659
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
650
660
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
651
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
661
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
653
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
664
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
665
from_path=None, to_path=None):
654
666
"""Diff the content of given files in two trees
656
668
:param from_file_id: The id of the file in the from tree. If None,
658
670
:param to_file_id: The id of the file in the to tree. This may refer
659
671
to a different file from from_file_id. If None,
660
672
the file is not present in the to tree.
673
:param from_path: The path in the from tree or None if unknown.
674
:param to_path: The path in the to tree or None if unknown.
662
def _get_text(tree, file_id):
676
def _get_text(tree, file_id, path):
663
677
if file_id is not None:
664
return tree.get_file(file_id).readlines()
678
return tree.get_file_lines(file_id, path)
668
from_text = _get_text(self.old_tree, from_file_id)
669
to_text = _get_text(self.new_tree, to_file_id)
682
from_text = _get_text(self.old_tree, from_file_id, from_path)
683
to_text = _get_text(self.new_tree, to_file_id, to_path)
670
684
self.text_differ(from_label, from_text, to_label, to_text,
685
self.to_file, path_encoding=self.path_encoding,
686
context_lines=self.context_lines)
672
687
except errors.BinaryFile:
673
688
self.to_file.write(
674
689
("Binary files %s and %s differ\n" %
675
(from_label, to_label)).encode(self.path_encoding))
690
(from_label, to_label)).encode(self.path_encoding,'replace'))
676
691
return self.CHANGED
688
703
def from_string(klass, command_string, old_tree, new_tree, to_file,
689
704
path_encoding='utf-8'):
690
command_template = commands.shlex_split_unicode(command_string)
691
command_template.extend(['%(old_path)s', '%(new_path)s'])
705
command_template = cmdline.split(command_string)
706
if '@' not in command_string:
707
command_template.extend(['@old_path', '@new_path'])
692
708
return klass(command_template, old_tree, new_tree, to_file,
696
def make_from_diff_tree(klass, command_string):
712
def make_from_diff_tree(klass, command_string, external_diff_options=None):
697
713
def from_diff_tree(diff_tree):
698
return klass.from_string(command_string, diff_tree.old_tree,
714
full_command_string = [command_string]
715
if external_diff_options is not None:
716
full_command_string += ' ' + external_diff_options
717
return klass.from_string(full_command_string, diff_tree.old_tree,
699
718
diff_tree.new_tree, diff_tree.to_file)
700
719
return from_diff_tree
702
721
def _get_command(self, old_path, new_path):
703
722
my_map = {'old_path': old_path, 'new_path': new_path}
704
return [t % my_map for t in self.command_template]
723
command = [AtTemplate(t).substitute(my_map) for t in
724
self.command_template]
725
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
728
if isinstance(c, unicode):
729
command_encoded.append(c.encode('mbcs'))
731
command_encoded.append(c)
732
return command_encoded
706
736
def _execute(self, old_path, new_path):
707
737
command = self._get_command(old_path, new_path)
730
def _write_file(self, file_id, tree, prefix, relpath):
731
full_path = osutils.pathjoin(self._root, prefix, relpath)
732
if self._try_symlink_root(tree, prefix):
762
"""Returns safe encoding for passing file path to diff tool"""
763
if sys.platform == 'win32':
766
# Don't fallback to 'utf-8' because subprocess may not be able to
767
# handle utf-8 correctly when locale is not utf-8.
768
return sys.getfilesystemencoding() or 'ascii'
770
def _is_safepath(self, path):
771
"""Return true if `path` may be able to pass to subprocess."""
774
return path == path.encode(fenc).decode(fenc)
778
def _safe_filename(self, prefix, relpath):
779
"""Replace unsafe character in `relpath` then join `self._root`,
780
`prefix` and `relpath`."""
782
# encoded_str.replace('?', '_') may break multibyte char.
783
# So we should encode, decode, then replace(u'?', u'_')
784
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
785
relpath_tmp = relpath_tmp.replace(u'?', u'_')
786
return osutils.pathjoin(self._root, prefix, relpath_tmp)
788
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
790
if not force_temp and isinstance(tree, WorkingTree):
791
full_path = tree.abspath(tree.id2path(file_id))
792
if self._is_safepath(full_path):
795
full_path = self._safe_filename(prefix, relpath)
796
if not force_temp and self._try_symlink_root(tree, prefix):
734
798
parent_dir = osutils.dirname(full_path)
749
osutils.make_readonly(full_path)
750
mtime = tree.get_file_mtime(file_id)
751
os.utime(full_path, (mtime, mtime))
814
mtime = tree.get_file_mtime(file_id)
815
except errors.FileTimestampUnavailable:
818
os.utime(full_path, (mtime, mtime))
820
osutils.make_readonly(full_path)
754
def _prepare_files(self, file_id, old_path, new_path):
823
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
824
allow_write_new=False):
755
825
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
826
old_path, force_temp)
757
827
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
828
new_path, force_temp,
829
allow_write=allow_write_new)
759
830
return old_disk_path, new_disk_path
761
832
def finish(self):
762
osutils.rmtree(self._root)
834
osutils.rmtree(self._root)
836
if e.errno != errno.ENOENT:
837
mutter("The temporary directory \"%s\" was not "
838
"cleanly removed: %s." % (self._root, e))
764
840
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
765
841
if (old_kind, new_kind) != ('file', 'file'):
766
842
return DiffPath.CANNOT_DIFF
767
self._prepare_files(file_id, old_path, new_path)
768
self._execute(osutils.pathjoin('old', old_path),
769
osutils.pathjoin('new', new_path))
843
(old_disk_path, new_disk_path) = self._prepare_files(
844
file_id, old_path, new_path)
845
self._execute(old_disk_path, new_disk_path)
847
def edit_file(self, file_id):
848
"""Use this tool to edit a file.
850
A temporary copy will be edited, and the new contents will be
853
:param file_id: The id of the file to edit.
854
:return: The new contents of the file.
856
old_path = self.old_tree.id2path(file_id)
857
new_path = self.new_tree.id2path(file_id)
858
old_abs_path, new_abs_path = self._prepare_files(
859
file_id, old_path, new_path,
860
allow_write_new=True,
862
command = self._get_command(old_abs_path, new_abs_path)
863
subprocess.call(command, cwd=self._root)
864
new_file = open(new_abs_path, 'rb')
866
return new_file.read()
772
871
class DiffTree(object):
815
914
def from_trees_options(klass, old_tree, new_tree, to_file,
816
915
path_encoding, external_diff_options, old_label,
916
new_label, using, context_lines):
818
917
"""Factory for producing a DiffTree.
820
919
Designed to accept options used by show_diff_trees.
821
921
:param old_tree: The tree to show as old in the comparison
822
922
:param new_tree: The tree to show as new in the comparison
823
923
:param to_file: File to write comparisons to
829
929
:param using: Commandline to use to invoke an external diff tool
831
931
if using is not None:
832
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
932
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
834
934
extra_factories = []
835
935
if external_diff_options:
836
936
opts = external_diff_options.split()
837
def diff_file(olab, olines, nlab, nlines, to_file):
937
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
938
""":param path_encoding: not used but required
939
to match the signature of internal_diff.
838
941
external_diff(olab, olines, nlab, nlines, to_file, opts)
840
943
diff_file = internal_diff
841
944
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
842
old_label, new_label, diff_file)
945
old_label, new_label, diff_file, context_lines=context_lines)
843
946
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
846
949
def show_diff(self, specific_files, extra_trees=None):
847
950
"""Write tree diff to self.to_file
849
:param sepecific_files: the specific files to compare (recursive)
952
:param specific_files: the specific files to compare (recursive)
850
953
:param extra_trees: extra trees to use for mapping paths to file_ids
931
1034
new_kind = self.new_tree.kind(file_id)
932
1035
except (errors.NoSuchId, errors.NoSuchFile):
1037
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1040
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
935
1041
result = DiffPath._diff_many(self.differs, file_id, old_path,
936
1042
new_path, old_kind, new_kind)
937
1043
if result is DiffPath.CANNOT_DIFF:
added
removed
bzrlib/diff.py
