~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Benji York
  • Date: 2011-08-19 18:02:37 UTC
  • mto: This revision was merged to the branch mainline in revision 6101.
  • Revision ID: benji@benjiyork.com-20110819180237-2n0sdcfs5v7bxksi
fix bug 702914

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd.
 
1
# Copyright (C) 2005-2011 Canonical Ltd.
2
2
#
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
25
25
import errno
26
26
import subprocess
27
27
import tempfile
28
 
import time
29
28
 
30
29
from bzrlib import (
31
 
    branch as _mod_branch,
32
30
    bzrdir,
33
31
    cmdline,
34
32
    cleanup,
46
44
from bzrlib.registry import (
47
45
    Registry,
48
46
    )
49
 
from bzrlib.symbol_versioning import (
50
 
    deprecated_function,
51
 
    deprecated_in,
52
 
    )
53
47
from bzrlib.trace import mutter, note, warning
54
48
 
55
49
 
99
93
    if sequence_matcher is None:
100
94
        sequence_matcher = patiencediff.PatienceSequenceMatcher
101
95
    ud = patiencediff.unified_diff(oldlines, newlines,
102
 
                      fromfile=old_filename.encode(path_encoding),
103
 
                      tofile=new_filename.encode(path_encoding),
 
96
                      fromfile=old_filename.encode(path_encoding, 'replace'),
 
97
                      tofile=new_filename.encode(path_encoding, 'replace'),
104
98
                      sequencematcher=sequence_matcher)
105
99
 
106
100
    ud = list(ud)
290
284
                        new_abspath, e)
291
285
 
292
286
 
293
 
@deprecated_function(deprecated_in((2, 2, 0)))
294
 
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
295
 
                                   apply_view=True):
296
 
    """Get the trees and specific files to diff given a list of paths.
297
 
 
298
 
    This method works out the trees to be diff'ed and the files of
299
 
    interest within those trees.
300
 
 
301
 
    :param path_list:
302
 
        the list of arguments passed to the diff command
303
 
    :param revision_specs:
304
 
        Zero, one or two RevisionSpecs from the diff command line,
305
 
        saying what revisions to compare.
306
 
    :param old_url:
307
 
        The url of the old branch or tree. If None, the tree to use is
308
 
        taken from the first path, if any, or the current working tree.
309
 
    :param new_url:
310
 
        The url of the new branch or tree. If None, the tree to use is
311
 
        taken from the first path, if any, or the current working tree.
312
 
    :param apply_view:
313
 
        if True and a view is set, apply the view or check that the paths
314
 
        are within it
315
 
    :returns:
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
 
        are not locked.
320
 
    """
321
 
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
322
 
    return op.run_simple(path_list, revision_specs, old_url, new_url,
323
 
            op.add_cleanup, apply_view=apply_view)
324
 
    
325
 
 
326
287
def get_trees_and_branches_to_diff_locked(
327
288
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
289
    """Get the trees and specific files to diff given a list of paths.
420
381
 
421
382
    # Get the specific files (all files is None, no files is [])
422
383
    if make_paths_wt_relative and working_tree is not None:
423
 
        try:
424
 
            from bzrlib.builtins import safe_relpath_files
425
 
            other_paths = safe_relpath_files(working_tree, other_paths,
 
384
        other_paths = working_tree.safe_relpath_files(
 
385
            other_paths,
426
386
            apply_view=apply_view)
427
 
        except errors.FileInWrongBranch:
428
 
            raise errors.BzrCommandError("Files are in different branches")
429
387
    specific_files.extend(other_paths)
430
388
    if len(specific_files) == 0:
431
389
        specific_files = None
441
399
    extra_trees = None
442
400
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
401
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
 
402
    return (old_tree, new_tree, old_branch, new_branch,
 
403
            specific_files, extra_trees)
445
404
 
446
405
 
447
406
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
468
427
    """Show in text form the changes from one tree to another.
469
428
 
470
429
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
 
430
    :param specific_files: Include only changes to these files - None for all
472
431
        changes.
473
432
    :param external_diff_options: If set, use an external GNU diff and pass 
474
433
        these options.
706
665
        """
707
666
        def _get_text(tree, file_id, path):
708
667
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
 
668
                return tree.get_file_lines(file_id, path)
710
669
            else:
711
670
                return []
712
671
        try:
713
672
            from_text = _get_text(self.old_tree, from_file_id, from_path)
714
673
            to_text = _get_text(self.new_tree, to_file_id, to_path)
715
674
            self.text_differ(from_label, from_text, to_label, to_text,
716
 
                             self.to_file)
 
675
                             self.to_file, path_encoding=self.path_encoding)
717
676
        except errors.BinaryFile:
718
677
            self.to_file.write(
719
678
                  ("Binary files %s and %s differ\n" %
720
 
                  (from_label, to_label)).encode(self.path_encoding))
 
679
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
721
680
        return self.CHANGED
722
681
 
723
682
 
739
698
                     path_encoding)
740
699
 
741
700
    @classmethod
742
 
    def make_from_diff_tree(klass, command_string):
 
701
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
743
702
        def from_diff_tree(diff_tree):
744
 
            return klass.from_string(command_string, diff_tree.old_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,
745
707
                                     diff_tree.new_tree, diff_tree.to_file)
746
708
        return from_diff_tree
747
709
 
748
710
    def _get_command(self, old_path, new_path):
749
711
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
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
 
715
            command_encoded = []
 
716
            for c in command:
 
717
                if isinstance(c, unicode):
 
718
                    command_encoded.append(c.encode('mbcs'))
 
719
                else:
 
720
                    command_encoded.append(c)
 
721
            return command_encoded
 
722
        else:
 
723
            return command
752
724
 
753
725
    def _execute(self, old_path, new_path):
754
726
        command = self._get_command(old_path, new_path)
774
746
                raise
775
747
        return True
776
748
 
 
749
    @staticmethod
 
750
    def _fenc():
 
751
        """Returns safe encoding for passing file path to diff tool"""
 
752
        if sys.platform == 'win32':
 
753
            return 'mbcs'
 
754
        else:
 
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'
 
758
 
 
759
    def _is_safepath(self, path):
 
760
        """Return true if `path` may be able to pass to subprocess."""
 
761
        fenc = self._fenc()
 
762
        try:
 
763
            return path == path.encode(fenc).decode(fenc)
 
764
        except UnicodeError:
 
765
            return False
 
766
 
 
767
    def _safe_filename(self, prefix, relpath):
 
768
        """Replace unsafe character in `relpath` then join `self._root`,
 
769
        `prefix` and `relpath`."""
 
770
        fenc = self._fenc()
 
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)
 
776
 
777
777
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
778
                    allow_write=False):
779
779
        if not force_temp and isinstance(tree, WorkingTree):
780
 
            return tree.abspath(tree.id2path(file_id))
781
 
        
782
 
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
780
            full_path = tree.abspath(tree.id2path(file_id))
 
781
            if self._is_safepath(full_path):
 
782
                return full_path
 
783
 
 
784
        full_path = self._safe_filename(prefix, relpath)
783
785
        if not force_temp and self._try_symlink_root(tree, prefix):
784
786
            return full_path
785
787
        parent_dir = osutils.dirname(full_path)
842
844
        """
843
845
        old_path = self.old_tree.id2path(file_id)
844
846
        new_path = self.new_tree.id2path(file_id)
845
 
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
846
 
                                           allow_write_new=True,
847
 
                                           force_temp=True)[1]
848
 
        command = self._get_command(osutils.pathjoin('old', old_path),
849
 
                                    osutils.pathjoin('new', new_path))
 
847
        old_abs_path, new_abs_path = self._prepare_files(
 
848
                                            file_id, old_path, new_path,
 
849
                                            allow_write_new=True,
 
850
                                            force_temp=True)
 
851
        command = self._get_command(old_abs_path, new_abs_path)
850
852
        subprocess.call(command, cwd=self._root)
851
 
        new_file = open(new_abs_path, 'r')
 
853
        new_file = open(new_abs_path, 'rb')
852
854
        try:
853
855
            return new_file.read()
854
856
        finally:
904
906
        """Factory for producing a DiffTree.
905
907
 
906
908
        Designed to accept options used by show_diff_trees.
 
909
 
907
910
        :param old_tree: The tree to show as old in the comparison
908
911
        :param new_tree: The tree to show as new in the comparison
909
912
        :param to_file: File to write comparisons to
915
918
        :param using: Commandline to use to invoke an external diff tool
916
919
        """
917
920
        if using is not None:
918
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
921
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
919
922
        else:
920
923
            extra_factories = []
921
924
        if external_diff_options:
922
925
            opts = external_diff_options.split()
923
 
            def diff_file(olab, olines, nlab, nlines, to_file):
 
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.
 
929
                """
924
930
                external_diff(olab, olines, nlab, nlines, to_file, opts)
925
931
        else:
926
932
            diff_file = internal_diff