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
from bzrlib.workingtree import WorkingTree
44
from bzrlib.registry import (
43
from bzrlib.symbol_versioning import (
47
46
from bzrlib.trace import mutter, note, warning
50
class AtTemplate(string.Template):
51
"""Templating class that uses @ instead of $."""
56
49
# TODO: Rather than building a changeset object, we should probably
57
50
# invoke callbacks on an object. That object can either accumulate a
58
51
# list, write them out directly, etc etc.
93
86
if sequence_matcher is None:
94
87
sequence_matcher = patiencediff.PatienceSequenceMatcher
95
88
ud = patiencediff.unified_diff(oldlines, newlines,
96
fromfile=old_filename.encode(path_encoding, 'replace'),
97
tofile=new_filename.encode(path_encoding, 'replace'),
89
fromfile=old_filename.encode(path_encoding),
90
tofile=new_filename.encode(path_encoding),
98
91
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):
280
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
289
282
"""Get the trees and specific files to diff given a list of paths.
291
284
This method works out the trees to be diff'ed and the files of
303
296
The url of the new branch or tree. If None, the tree to use is
304
297
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
298
:param apply_view:
309
299
if True and a view is set, apply the view or check that the paths
312
a tuple of (old_tree, new_tree, old_branch, new_branch,
313
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
302
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
303
extra_trees is a sequence of additional trees to search in for
318
306
# Get the old and new revision specs
319
307
old_revision_spec = None
342
330
default_location = path_list[0]
343
331
other_paths = path_list[1:]
345
def lock_tree_or_branch(wt, br):
348
add_cleanup(wt.unlock)
351
add_cleanup(br.unlock)
353
333
# Get the old location
354
334
specific_files = []
355
335
if old_url is None:
356
336
old_url = default_location
357
337
working_tree, branch, relpath = \
358
338
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
359
lock_tree_or_branch(working_tree, branch)
360
339
if consider_relpath and relpath != '':
361
340
if working_tree is not None and apply_view:
362
341
views.check_path_in_view(working_tree, relpath)
363
342
specific_files.append(relpath)
364
343
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
367
345
# Get the new location
368
346
if new_url is None:
370
348
if new_url != old_url:
371
349
working_tree, branch, relpath = \
372
350
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
373
lock_tree_or_branch(working_tree, branch)
374
351
if consider_relpath and relpath != '':
375
352
if working_tree is not None and apply_view:
376
353
views.check_path_in_view(working_tree, relpath)
377
354
specific_files.append(relpath)
378
355
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
379
356
basis_is_default=working_tree is None)
382
358
# Get the specific files (all files is None, no files is [])
383
359
if make_paths_wt_relative and working_tree is not None:
384
other_paths = working_tree.safe_relpath_files(
361
from bzrlib.builtins import safe_relpath_files
362
other_paths = safe_relpath_files(working_tree, other_paths,
386
363
apply_view=apply_view)
364
except errors.FileInWrongBranch:
365
raise errors.BzrCommandError("Files are in different branches")
387
366
specific_files.extend(other_paths)
388
367
if len(specific_files) == 0:
389
368
specific_files = None
399
378
extra_trees = None
400
379
if working_tree is not None and working_tree not in (old_tree, new_tree):
401
380
extra_trees = (working_tree,)
402
return (old_tree, new_tree, old_branch, new_branch,
403
specific_files, extra_trees)
381
return old_tree, new_tree, specific_files, extra_trees
406
383
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
407
384
if branch is None and tree is not None:
422
399
old_label='a/', new_label='b/',
423
400
extra_trees=None,
424
401
path_encoding='utf8',
427
403
"""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)
409
Include only changes to these files - None for all changes.
411
external_diff_options
412
If set, use an external GNU diff and pass these options.
415
If set, more Trees to use for looking up file ids
418
If set, the path will be encoded as specified, otherwise is supposed
439
if format_cls is None:
440
format_cls = DiffTree
441
421
old_tree.lock_read()
443
423
if extra_trees is not None:
446
426
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)
428
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
430
external_diff_options,
431
old_label, new_label, using)
452
432
return differ.show_diff(specific_files, extra_trees)
454
434
new_tree.unlock()
462
442
def _patch_header_date(tree, file_id, path):
463
443
"""Returns a timestamp suitable for use in a patch header."""
465
mtime = tree.get_file_mtime(file_id, path)
466
except errors.FileTimestampUnavailable:
444
mtime = tree.get_file_mtime(file_id, path)
468
445
return timestamp.format_patch_date(mtime)
666
643
def _get_text(tree, file_id, path):
667
644
if file_id is not None:
668
return tree.get_file_lines(file_id, path)
645
return tree.get_file(file_id, path).readlines()
672
649
from_text = _get_text(self.old_tree, from_file_id, from_path)
673
650
to_text = _get_text(self.new_tree, to_file_id, to_path)
674
651
self.text_differ(from_label, from_text, to_label, to_text,
675
self.to_file, path_encoding=self.path_encoding)
676
653
except errors.BinaryFile:
677
654
self.to_file.write(
678
655
("Binary files %s and %s differ\n" %
679
(from_label, to_label)).encode(self.path_encoding,'replace'))
656
(from_label, to_label)).encode(self.path_encoding))
680
657
return self.CHANGED
692
669
def from_string(klass, command_string, old_tree, new_tree, to_file,
693
670
path_encoding='utf-8'):
694
command_template = cmdline.split(command_string)
695
if '@' not in command_string:
696
command_template.extend(['@old_path', '@new_path'])
671
command_template = commands.shlex_split_unicode(command_string)
672
command_template.extend(['%(old_path)s', '%(new_path)s'])
697
673
return klass(command_template, old_tree, new_tree, to_file,
701
def make_from_diff_tree(klass, command_string, external_diff_options=None):
677
def make_from_diff_tree(klass, command_string):
702
678
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,
679
return klass.from_string(command_string, diff_tree.old_tree,
707
680
diff_tree.new_tree, diff_tree.to_file)
708
681
return from_diff_tree
710
683
def _get_command(self, old_path, new_path):
711
684
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
685
return [t % my_map for t in self.command_template]
725
687
def _execute(self, old_path, new_path):
726
688
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
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
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)
785
if not force_temp and self._try_symlink_root(tree, prefix):
711
def _write_file(self, file_id, tree, prefix, relpath):
712
full_path = osutils.pathjoin(self._root, prefix, relpath)
713
if self._try_symlink_root(tree, prefix):
787
715
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))
809
osutils.make_readonly(full_path)
730
osutils.make_readonly(full_path)
731
mtime = tree.get_file_mtime(file_id)
732
os.utime(full_path, (mtime, mtime))
812
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
813
allow_write_new=False):
735
def _prepare_files(self, file_id, old_path, new_path):
814
736
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
815
old_path, force_temp)
816
738
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
817
new_path, force_temp,
818
allow_write=allow_write_new)
819
740
return old_disk_path, new_disk_path
821
742
def finish(self):
829
750
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
830
751
if (old_kind, new_kind) != ('file', 'file'):
831
752
return DiffPath.CANNOT_DIFF
832
(old_disk_path, new_disk_path) = self._prepare_files(
833
file_id, old_path, new_path)
834
self._execute(old_disk_path, new_disk_path)
836
def edit_file(self, file_id):
837
"""Use this tool to edit a file.
839
A temporary copy will be edited, and the new contents will be
842
:param file_id: The id of the file to edit.
843
:return: The new contents of the file.
845
old_path = self.old_tree.id2path(file_id)
846
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)
852
subprocess.call(command, cwd=self._root)
853
new_file = open(new_abs_path, 'rb')
855
return new_file.read()
753
self._prepare_files(file_id, old_path, new_path)
754
self._execute(osutils.pathjoin('old', old_path),
755
osutils.pathjoin('new', new_path))
860
758
class DiffTree(object):
906
804
"""Factory for producing a DiffTree.
908
806
Designed to accept options used by show_diff_trees.
910
807
:param old_tree: The tree to show as old in the comparison
911
808
:param new_tree: The tree to show as new in the comparison
912
809
:param to_file: File to write comparisons to
918
815
:param using: Commandline to use to invoke an external diff tool
920
817
if using is not None:
921
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
818
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
923
820
extra_factories = []
924
821
if external_diff_options:
925
822
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.
823
def diff_file(olab, olines, nlab, nlines, to_file):
930
824
external_diff(olab, olines, nlab, nlines, to_file, opts)
932
826
diff_file = internal_diff
938
832
def show_diff(self, specific_files, extra_trees=None):
939
833
"""Write tree diff to self.to_file
941
:param specific_files: the specific files to compare (recursive)
835
:param sepecific_files: the specific files to compare (recursive)
942
836
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
