/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 Canonical Ltd.
 
1
# Copyright (C) 2005-2010 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
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
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import difflib
20
18
import os
21
19
import re
27
25
import errno
28
26
import subprocess
29
27
import tempfile
 
28
import time
30
29
 
31
30
from bzrlib import (
 
31
    branch as _mod_branch,
 
32
    bzrdir,
 
33
    cmdline,
32
34
    cleanup,
33
 
    cmdline,
34
 
    controldir,
35
35
    errors,
36
36
    osutils,
37
37
    patiencediff,
41
41
    )
42
42
 
43
43
from bzrlib.workingtree import WorkingTree
44
 
from bzrlib.i18n import gettext
45
44
""")
46
45
 
47
46
from bzrlib.registry import (
48
47
    Registry,
49
48
    )
 
49
from bzrlib.symbol_versioning import (
 
50
    deprecated_function,
 
51
    deprecated_in,
 
52
    )
50
53
from bzrlib.trace import mutter, note, warning
51
54
 
52
55
 
96
99
    if sequence_matcher is None:
97
100
        sequence_matcher = patiencediff.PatienceSequenceMatcher
98
101
    ud = patiencediff.unified_diff(oldlines, newlines,
99
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
100
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
 
102
                      fromfile=old_filename.encode(path_encoding),
 
103
                      tofile=new_filename.encode(path_encoding),
101
104
                      sequencematcher=sequence_matcher)
102
105
 
103
106
    ud = list(ud)
287
290
                        new_abspath, e)
288
291
 
289
292
 
 
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
 
290
326
def get_trees_and_branches_to_diff_locked(
291
327
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
292
328
    """Get the trees and specific files to diff given a list of paths.
358
394
    if old_url is None:
359
395
        old_url = default_location
360
396
    working_tree, branch, relpath = \
361
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
 
397
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
362
398
    lock_tree_or_branch(working_tree, branch)
363
399
    if consider_relpath and relpath != '':
364
400
        if working_tree is not None and apply_view:
372
408
        new_url = default_location
373
409
    if new_url != old_url:
374
410
        working_tree, branch, relpath = \
375
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
 
411
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
376
412
        lock_tree_or_branch(working_tree, branch)
377
413
        if consider_relpath and relpath != '':
378
414
            if working_tree is not None and apply_view:
384
420
 
385
421
    # Get the specific files (all files is None, no files is [])
386
422
    if make_paths_wt_relative and working_tree is not None:
387
 
        other_paths = working_tree.safe_relpath_files(
388
 
            other_paths,
 
423
        try:
 
424
            from bzrlib.builtins import safe_relpath_files
 
425
            other_paths = safe_relpath_files(working_tree, other_paths,
389
426
            apply_view=apply_view)
 
427
        except errors.FileInWrongBranch:
 
428
            raise errors.BzrCommandError("Files are in different branches")
390
429
    specific_files.extend(other_paths)
391
430
    if len(specific_files) == 0:
392
431
        specific_files = None
396
435
            if view_files:
397
436
                specific_files = view_files
398
437
                view_str = views.view_display_str(view_files)
399
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
438
                note("*** Ignoring files outside view. View is %s" % view_str)
400
439
 
401
440
    # Get extra trees that ought to be searched for file-ids
402
441
    extra_trees = None
403
442
    if working_tree is not None and working_tree not in (old_tree, new_tree):
404
443
        extra_trees = (working_tree,)
405
 
    return (old_tree, new_tree, old_branch, new_branch,
406
 
            specific_files, extra_trees)
 
444
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
407
445
 
408
446
 
409
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
430
468
    """Show in text form the changes from one tree to another.
431
469
 
432
470
    :param to_file: The output stream.
433
 
    :param specific_files: Include only changes to these files - None for all
 
471
    :param specific_files:Include only changes to these files - None for all
434
472
        changes.
435
473
    :param external_diff_options: If set, use an external GNU diff and pass 
436
474
        these options.
668
706
        """
669
707
        def _get_text(tree, file_id, path):
670
708
            if file_id is not None:
671
 
                return tree.get_file_lines(file_id, path)
 
709
                return tree.get_file(file_id, path).readlines()
672
710
            else:
673
711
                return []
674
712
        try:
675
713
            from_text = _get_text(self.old_tree, from_file_id, from_path)
676
714
            to_text = _get_text(self.new_tree, to_file_id, to_path)
677
715
            self.text_differ(from_label, from_text, to_label, to_text,
678
 
                             self.to_file, path_encoding=self.path_encoding)
 
716
                             self.to_file)
679
717
        except errors.BinaryFile:
680
718
            self.to_file.write(
681
719
                  ("Binary files %s and %s differ\n" %
682
 
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
 
720
                  (from_label, to_label)).encode(self.path_encoding))
683
721
        return self.CHANGED
684
722
 
685
723
 
701
739
                     path_encoding)
702
740
 
703
741
    @classmethod
704
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
742
    def make_from_diff_tree(klass, command_string):
705
743
        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,
 
744
            return klass.from_string(command_string, diff_tree.old_tree,
710
745
                                     diff_tree.new_tree, diff_tree.to_file)
711
746
        return from_diff_tree
712
747
 
713
748
    def _get_command(self, old_path, new_path):
714
749
        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
718
 
            command_encoded = []
719
 
            for c in command:
720
 
                if isinstance(c, unicode):
721
 
                    command_encoded.append(c.encode('mbcs'))
722
 
                else:
723
 
                    command_encoded.append(c)
724
 
            return command_encoded
725
 
        else:
726
 
            return command
 
750
        return [AtTemplate(t).substitute(my_map) for t in
 
751
                self.command_template]
727
752
 
728
753
    def _execute(self, old_path, new_path):
729
754
        command = self._get_command(old_path, new_path)
749
774
                raise
750
775
        return True
751
776
 
752
 
    @staticmethod
753
 
    def _fenc():
754
 
        """Returns safe encoding for passing file path to diff tool"""
755
 
        if sys.platform == 'win32':
756
 
            return 'mbcs'
757
 
        else:
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'
761
 
 
762
 
    def _is_safepath(self, path):
763
 
        """Return true if `path` may be able to pass to subprocess."""
764
 
        fenc = self._fenc()
765
 
        try:
766
 
            return path == path.encode(fenc).decode(fenc)
767
 
        except UnicodeError:
768
 
            return False
769
 
 
770
 
    def _safe_filename(self, prefix, relpath):
771
 
        """Replace unsafe character in `relpath` then join `self._root`,
772
 
        `prefix` and `relpath`."""
773
 
        fenc = self._fenc()
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)
779
 
 
780
777
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
781
778
                    allow_write=False):
782
779
        if not force_temp and isinstance(tree, WorkingTree):
783
 
            full_path = tree.abspath(tree.id2path(file_id))
784
 
            if self._is_safepath(full_path):
785
 
                return full_path
786
 
 
787
 
        full_path = self._safe_filename(prefix, relpath)
 
780
            return tree.abspath(tree.id2path(file_id))
 
781
        
 
782
        full_path = osutils.pathjoin(self._root, prefix, relpath)
788
783
        if not force_temp and self._try_symlink_root(tree, prefix):
789
784
            return full_path
790
785
        parent_dir = osutils.dirname(full_path)
847
842
        """
848
843
        old_path = self.old_tree.id2path(file_id)
849
844
        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,
853
 
                                            force_temp=True)
854
 
        command = self._get_command(old_abs_path, new_abs_path)
 
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))
855
850
        subprocess.call(command, cwd=self._root)
856
 
        new_file = open(new_abs_path, 'rb')
 
851
        new_file = open(new_abs_path, 'r')
857
852
        try:
858
853
            return new_file.read()
859
854
        finally:
909
904
        """Factory for producing a DiffTree.
910
905
 
911
906
        Designed to accept options used by show_diff_trees.
912
 
 
913
907
        :param old_tree: The tree to show as old in the comparison
914
908
        :param new_tree: The tree to show as new in the comparison
915
909
        :param to_file: File to write comparisons to
921
915
        :param using: Commandline to use to invoke an external diff tool
922
916
        """
923
917
        if using is not None:
924
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
918
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
925
919
        else:
926
920
            extra_factories = []
927
921
        if external_diff_options:
928
922
            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.
932
 
                """
 
923
            def diff_file(olab, olines, nlab, nlines, to_file):
933
924
                external_diff(olab, olines, nlab, nlines, to_file, opts)
934
925
        else:
935
926
            diff_file = internal_diff