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
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
25
23
from bzrlib.lazy_import import lazy_import
43
from bzrlib.workingtree import WorkingTree
44
from bzrlib.i18n import gettext
47
from bzrlib.registry import (
43
from bzrlib.symbol_versioning import (
50
46
from bzrlib.trace import mutter, note, warning
53
class AtTemplate(string.Template):
54
"""Templating class that uses @ instead of $."""
59
49
# TODO: Rather than building a changeset object, we should probably
60
50
# invoke callbacks on an object. That object can either accumulate a
61
51
# list, write them out directly, etc etc.
96
86
if sequence_matcher is None:
97
87
sequence_matcher = patiencediff.PatienceSequenceMatcher
98
88
ud = patiencediff.unified_diff(oldlines, newlines,
99
fromfile=old_filename.encode(path_encoding, 'replace'),
100
tofile=new_filename.encode(path_encoding, 'replace'),
89
fromfile=old_filename.encode(path_encoding),
90
tofile=new_filename.encode(path_encoding),
101
91
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):
280
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
292
282
"""Get the trees and specific files to diff given a list of paths.
294
284
This method works out the trees to be diff'ed and the files of
306
296
The url of the new branch or tree. If None, the tree to use is
307
297
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
298
:param apply_view:
312
299
if True and a view is set, apply the view or check that the paths
315
a tuple of (old_tree, new_tree, old_branch, new_branch,
316
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
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
321
306
# Get the old and new revision specs
322
307
old_revision_spec = None
345
330
default_location = path_list[0]
346
331
other_paths = path_list[1:]
348
def lock_tree_or_branch(wt, br):
351
add_cleanup(wt.unlock)
354
add_cleanup(br.unlock)
356
333
# Get the old location
357
334
specific_files = []
358
335
if old_url is None:
359
336
old_url = default_location
360
337
working_tree, branch, relpath = \
361
controldir.ControlDir.open_containing_tree_or_branch(old_url)
362
lock_tree_or_branch(working_tree, branch)
338
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
363
339
if consider_relpath and relpath != '':
364
340
if working_tree is not None and apply_view:
365
341
views.check_path_in_view(working_tree, relpath)
366
342
specific_files.append(relpath)
367
343
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
370
345
# Get the new location
371
346
if new_url is None:
372
347
new_url = default_location
373
348
if new_url != old_url:
374
349
working_tree, branch, relpath = \
375
controldir.ControlDir.open_containing_tree_or_branch(new_url)
376
lock_tree_or_branch(working_tree, branch)
350
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
377
351
if consider_relpath and relpath != '':
378
352
if working_tree is not None and apply_view:
379
353
views.check_path_in_view(working_tree, relpath)
380
354
specific_files.append(relpath)
381
355
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
382
356
basis_is_default=working_tree is None)
385
358
# Get the specific files (all files is None, no files is [])
386
359
if make_paths_wt_relative and working_tree is not None:
387
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,
389
363
apply_view=apply_view)
364
except errors.FileInWrongBranch:
365
raise errors.BzrCommandError("Files are in different branches")
390
366
specific_files.extend(other_paths)
391
367
if len(specific_files) == 0:
392
368
specific_files = None
397
373
specific_files = view_files
398
374
view_str = views.view_display_str(view_files)
399
note(gettext("*** Ignoring files outside view. View is %s") % view_str)
375
note("*** Ignoring files outside view. View is %s" % view_str)
401
377
# Get extra trees that ought to be searched for file-ids
402
378
extra_trees = None
403
379
if working_tree is not None and working_tree not in (old_tree, new_tree):
404
380
extra_trees = (working_tree,)
405
return (old_tree, new_tree, old_branch, new_branch,
406
specific_files, extra_trees)
381
return old_tree, new_tree, specific_files, extra_trees
409
383
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
410
384
if branch is None and tree is not None:
425
399
old_label='a/', new_label='b/',
426
400
extra_trees=None,
427
401
path_encoding='utf8',
430
403
"""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)
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
442
if format_cls is None:
443
format_cls = DiffTree
444
421
old_tree.lock_read()
446
423
if extra_trees is not None:
449
426
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)
428
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
430
external_diff_options,
431
old_label, new_label, using)
455
432
return differ.show_diff(specific_files, extra_trees)
457
434
new_tree.unlock()
465
442
def _patch_header_date(tree, file_id, path):
466
443
"""Returns a timestamp suitable for use in a patch header."""
468
mtime = tree.get_file_mtime(file_id, path)
469
except errors.FileTimestampUnavailable:
444
mtime = tree.get_file_mtime(file_id, path)
471
445
return timestamp.format_patch_date(mtime)
669
643
def _get_text(tree, file_id, path):
670
644
if file_id is not None:
671
return tree.get_file_lines(file_id, path)
645
return tree.get_file(file_id, path).readlines()
675
649
from_text = _get_text(self.old_tree, from_file_id, from_path)
676
650
to_text = _get_text(self.new_tree, to_file_id, to_path)
677
651
self.text_differ(from_label, from_text, to_label, to_text,
678
self.to_file, path_encoding=self.path_encoding)
679
653
except errors.BinaryFile:
680
654
self.to_file.write(
681
655
("Binary files %s and %s differ\n" %
682
(from_label, to_label)).encode(self.path_encoding,'replace'))
656
(from_label, to_label)).encode(self.path_encoding))
683
657
return self.CHANGED
695
669
def from_string(klass, command_string, old_tree, new_tree, to_file,
696
670
path_encoding='utf-8'):
697
command_template = cmdline.split(command_string)
698
if '@' not in command_string:
699
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'])
700
673
return klass(command_template, old_tree, new_tree, to_file,
704
def make_from_diff_tree(klass, command_string, external_diff_options=None):
677
def make_from_diff_tree(klass, command_string):
705
678
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,
679
return klass.from_string(command_string, diff_tree.old_tree,
710
680
diff_tree.new_tree, diff_tree.to_file)
711
681
return from_diff_tree
713
683
def _get_command(self, old_path, new_path):
714
684
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
685
return [t % my_map for t in self.command_template]
728
687
def _execute(self, old_path, new_path):
729
688
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
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
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)
788
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):
790
715
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))
812
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))
815
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
816
allow_write_new=False):
735
def _prepare_files(self, file_id, old_path, new_path):
817
736
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
818
old_path, force_temp)
819
738
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
820
new_path, force_temp,
821
allow_write=allow_write_new)
822
740
return old_disk_path, new_disk_path
824
742
def finish(self):
832
750
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
833
751
if (old_kind, new_kind) != ('file', 'file'):
834
752
return DiffPath.CANNOT_DIFF
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)
839
def edit_file(self, file_id):
840
"""Use this tool to edit a file.
842
A temporary copy will be edited, and the new contents will be
845
:param file_id: The id of the file to edit.
846
:return: The new contents of the file.
848
old_path = self.old_tree.id2path(file_id)
849
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)
855
subprocess.call(command, cwd=self._root)
856
new_file = open(new_abs_path, 'rb')
858
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))
863
758
class DiffTree(object):
909
804
"""Factory for producing a DiffTree.
911
806
Designed to accept options used by show_diff_trees.
913
807
:param old_tree: The tree to show as old in the comparison
914
808
:param new_tree: The tree to show as new in the comparison
915
809
:param to_file: File to write comparisons to
921
815
:param using: Commandline to use to invoke an external diff tool
923
817
if using is not None:
924
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
818
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
926
820
extra_factories = []
927
821
if external_diff_options:
928
822
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.
823
def diff_file(olab, olines, nlab, nlines, to_file):
933
824
external_diff(olab, olines, nlab, nlines, to_file, opts)
935
826
diff_file = internal_diff
941
832
def show_diff(self, specific_files, extra_trees=None):
942
833
"""Write tree diff to self.to_file
944
:param specific_files: the specific files to compare (recursive)
835
:param sepecific_files: the specific files to compare (recursive)
945
836
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
