/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: Sabin Iacob
  • Date: 2009-03-23 14:59:43 UTC
  • mto: (4189.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4193.
  • Revision ID: iacobs@m0n5t3r.info-20090323145943-3s3p1px5q1rkh2e5
update FSF mailing address

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd.
 
1
# Copyright (C) 2004, 2005, 2006 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
17
17
import difflib
18
18
import os
19
19
import re
20
 
import string
 
20
import shutil
21
21
import sys
22
22
 
23
23
from bzrlib.lazy_import import lazy_import
25
25
import errno
26
26
import subprocess
27
27
import tempfile
 
28
import time
28
29
 
29
30
from bzrlib import (
 
31
    branch as _mod_branch,
30
32
    bzrdir,
31
 
    cmdline,
32
 
    cleanup,
 
33
    commands,
33
34
    errors,
34
35
    osutils,
35
36
    patiencediff,
37
38
    timestamp,
38
39
    views,
39
40
    )
40
 
 
41
 
from bzrlib.workingtree import WorkingTree
42
41
""")
43
42
 
44
 
from bzrlib.registry import (
45
 
    Registry,
46
 
    )
47
43
from bzrlib.symbol_versioning import (
48
 
    deprecated_function,
49
 
    deprecated_in,
50
 
    )
 
44
        deprecated_function,
 
45
        one_three
 
46
        )
51
47
from bzrlib.trace import mutter, note, warning
52
48
 
53
49
 
54
 
class AtTemplate(string.Template):
55
 
    """Templating class that uses @ instead of $."""
56
 
 
57
 
    delimiter = '@'
58
 
 
59
 
 
60
50
# TODO: Rather than building a changeset object, we should probably
61
51
# invoke callbacks on an object.  That object can either accumulate a
62
52
# list, write them out directly, etc etc.
97
87
    if sequence_matcher is None:
98
88
        sequence_matcher = patiencediff.PatienceSequenceMatcher
99
89
    ud = patiencediff.unified_diff(oldlines, newlines,
100
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
101
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
 
90
                      fromfile=old_filename.encode(path_encoding),
 
91
                      tofile=new_filename.encode(path_encoding),
102
92
                      sequencematcher=sequence_matcher)
103
93
 
104
94
    ud = list(ud)
182
172
 
183
173
        if not diff_opts:
184
174
            diff_opts = []
185
 
        if sys.platform == 'win32':
186
 
            # Popen doesn't do the proper encoding for external commands
187
 
            # Since we are dealing with an ANSI api, use mbcs encoding
188
 
            old_filename = old_filename.encode('mbcs')
189
 
            new_filename = new_filename.encode('mbcs')
190
175
        diffcmd = ['diff',
191
176
                   '--label', old_filename,
192
177
                   old_abspath,
288
273
                        new_abspath, e)
289
274
 
290
275
 
291
 
@deprecated_function(deprecated_in((2, 2, 0)))
292
 
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
293
 
                                   apply_view=True):
294
 
    """Get the trees and specific files to diff given a list of paths.
295
 
 
296
 
    This method works out the trees to be diff'ed and the files of
297
 
    interest within those trees.
298
 
 
299
 
    :param path_list:
300
 
        the list of arguments passed to the diff command
301
 
    :param revision_specs:
302
 
        Zero, one or two RevisionSpecs from the diff command line,
303
 
        saying what revisions to compare.
304
 
    :param old_url:
305
 
        The url of the old branch or tree. If None, the tree to use is
306
 
        taken from the first path, if any, or the current working tree.
307
 
    :param new_url:
308
 
        The url of the new branch or tree. If None, the tree to use is
309
 
        taken from the first path, if any, or the current working tree.
310
 
    :param apply_view:
311
 
        if True and a view is set, apply the view or check that the paths
312
 
        are within it
313
 
    :returns:
314
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
315
 
        specific_files, extra_trees) where extra_trees is a sequence of
316
 
        additional trees to search in for file-ids.  The trees and branches
317
 
        are not locked.
318
 
    """
319
 
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
320
 
    return op.run_simple(path_list, revision_specs, old_url, new_url,
321
 
            op.add_cleanup, apply_view=apply_view)
322
 
    
323
 
 
324
 
def get_trees_and_branches_to_diff_locked(
325
 
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
326
 
    """Get the trees and specific files to diff given a list of paths.
327
 
 
328
 
    This method works out the trees to be diff'ed and the files of
329
 
    interest within those trees.
330
 
 
331
 
    :param path_list:
332
 
        the list of arguments passed to the diff command
333
 
    :param revision_specs:
334
 
        Zero, one or two RevisionSpecs from the diff command line,
335
 
        saying what revisions to compare.
336
 
    :param old_url:
337
 
        The url of the old branch or tree. If None, the tree to use is
338
 
        taken from the first path, if any, or the current working tree.
339
 
    :param new_url:
340
 
        The url of the new branch or tree. If None, the tree to use is
341
 
        taken from the first path, if any, or the current working tree.
342
 
    :param add_cleanup:
343
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
344
 
        will register cleanups that must be run to unlock the trees, etc.
345
 
    :param apply_view:
346
 
        if True and a view is set, apply the view or check that the paths
347
 
        are within it
348
 
    :returns:
349
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
350
 
        specific_files, extra_trees) where extra_trees is a sequence of
351
 
        additional trees to search in for file-ids.  The trees and branches
352
 
        will be read-locked until the cleanups registered via the add_cleanup
353
 
        param are run.
 
276
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
 
277
    apply_view=True):
 
278
    """Get the trees and specific files to diff given a list of paths.
 
279
 
 
280
    This method works out the trees to be diff'ed and the files of
 
281
    interest within those trees.
 
282
 
 
283
    :param path_list:
 
284
        the list of arguments passed to the diff command
 
285
    :param revision_specs:
 
286
        Zero, one or two RevisionSpecs from the diff command line,
 
287
        saying what revisions to compare.
 
288
    :param old_url:
 
289
        The url of the old branch or tree. If None, the tree to use is
 
290
        taken from the first path, if any, or the current working tree.
 
291
    :param new_url:
 
292
        The url of the new branch or tree. If None, the tree to use is
 
293
        taken from the first path, if any, or the current working tree.
 
294
    :param apply_view:
 
295
        if True and a view is set, apply the view or check that the paths
 
296
        are within it
 
297
    :returns:
 
298
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
299
        extra_trees is a sequence of additional trees to search in for
 
300
        file-ids.
354
301
    """
355
302
    # Get the old and new revision specs
356
303
    old_revision_spec = None
379
326
        default_location = path_list[0]
380
327
        other_paths = path_list[1:]
381
328
 
382
 
    def lock_tree_or_branch(wt, br):
383
 
        if wt is not None:
384
 
            wt.lock_read()
385
 
            add_cleanup(wt.unlock)
386
 
        elif br is not None:
387
 
            br.lock_read()
388
 
            add_cleanup(br.unlock)
389
 
 
390
329
    # Get the old location
391
330
    specific_files = []
392
331
    if old_url is None:
393
332
        old_url = default_location
394
333
    working_tree, branch, relpath = \
395
334
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
396
 
    lock_tree_or_branch(working_tree, branch)
397
335
    if consider_relpath and relpath != '':
398
336
        if working_tree is not None and apply_view:
399
337
            views.check_path_in_view(working_tree, relpath)
400
338
        specific_files.append(relpath)
401
339
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
402
 
    old_branch = branch
403
340
 
404
341
    # Get the new location
405
342
    if new_url is None:
407
344
    if new_url != old_url:
408
345
        working_tree, branch, relpath = \
409
346
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
410
 
        lock_tree_or_branch(working_tree, branch)
411
347
        if consider_relpath and relpath != '':
412
348
            if working_tree is not None and apply_view:
413
349
                views.check_path_in_view(working_tree, relpath)
414
350
            specific_files.append(relpath)
415
351
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
416
352
        basis_is_default=working_tree is None)
417
 
    new_branch = branch
418
353
 
419
354
    # Get the specific files (all files is None, no files is [])
420
355
    if make_paths_wt_relative and working_tree is not None:
421
 
        other_paths = working_tree.safe_relpath_files(
422
 
            other_paths,
 
356
        try:
 
357
            from bzrlib.builtins import safe_relpath_files
 
358
            other_paths = safe_relpath_files(working_tree, other_paths,
423
359
            apply_view=apply_view)
 
360
        except errors.FileInWrongBranch:
 
361
            raise errors.BzrCommandError("Files are in different branches")
424
362
    specific_files.extend(other_paths)
425
363
    if len(specific_files) == 0:
426
364
        specific_files = None
430
368
            if view_files:
431
369
                specific_files = view_files
432
370
                view_str = views.view_display_str(view_files)
433
 
                note("*** Ignoring files outside view. View is %s" % view_str)
 
371
                note("*** ignoring files outside view: %s" % view_str)
434
372
 
435
373
    # Get extra trees that ought to be searched for file-ids
436
374
    extra_trees = None
437
375
    if working_tree is not None and working_tree not in (old_tree, new_tree):
438
376
        extra_trees = (working_tree,)
439
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
440
 
 
 
377
    return old_tree, new_tree, specific_files, extra_trees
441
378
 
442
379
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
443
380
    if branch is None and tree is not None:
458
395
                    old_label='a/', new_label='b/',
459
396
                    extra_trees=None,
460
397
                    path_encoding='utf8',
461
 
                    using=None,
462
 
                    format_cls=None):
 
398
                    using=None):
463
399
    """Show in text form the changes from one tree to another.
464
400
 
465
 
    :param to_file: The output stream.
466
 
    :param specific_files:Include only changes to these files - None for all
467
 
        changes.
468
 
    :param external_diff_options: If set, use an external GNU diff and pass 
469
 
        these options.
470
 
    :param extra_trees: If set, more Trees to use for looking up file ids
471
 
    :param path_encoding: If set, the path will be encoded as specified, 
472
 
        otherwise is supposed to be utf8
473
 
    :param format_cls: Formatter class (DiffTree subclass)
 
401
    to_file
 
402
        The output stream.
 
403
 
 
404
    specific_files
 
405
        Include only changes to these files - None for all changes.
 
406
 
 
407
    external_diff_options
 
408
        If set, use an external GNU diff and pass these options.
 
409
 
 
410
    extra_trees
 
411
        If set, more Trees to use for looking up file ids
 
412
 
 
413
    path_encoding
 
414
        If set, the path will be encoded as specified, otherwise is supposed
 
415
        to be utf8
474
416
    """
475
 
    if format_cls is None:
476
 
        format_cls = DiffTree
477
417
    old_tree.lock_read()
478
418
    try:
479
419
        if extra_trees is not None:
481
421
                tree.lock_read()
482
422
        new_tree.lock_read()
483
423
        try:
484
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
485
 
                                                   path_encoding,
486
 
                                                   external_diff_options,
487
 
                                                   old_label, new_label, using)
 
424
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
425
                                                 path_encoding,
 
426
                                                 external_diff_options,
 
427
                                                 old_label, new_label, using)
488
428
            return differ.show_diff(specific_files, extra_trees)
489
429
        finally:
490
430
            new_tree.unlock()
497
437
 
498
438
def _patch_header_date(tree, file_id, path):
499
439
    """Returns a timestamp suitable for use in a patch header."""
500
 
    try:
501
 
        mtime = tree.get_file_mtime(file_id, path)
502
 
    except errors.FileTimestampUnavailable:
503
 
        mtime = 0
 
440
    mtime = tree.get_file_mtime(file_id, path)
504
441
    return timestamp.format_patch_date(mtime)
505
442
 
506
443
 
 
444
@deprecated_function(one_three)
 
445
def get_prop_change(meta_modified):
 
446
    if meta_modified:
 
447
        return " (properties changed)"
 
448
    else:
 
449
        return  ""
 
450
 
507
451
def get_executable_change(old_is_x, new_is_x):
508
452
    descr = { True:"+x", False:"-x", None:"??" }
509
453
    if old_is_x != new_is_x:
684
628
            return self.CANNOT_DIFF
685
629
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
686
630
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
687
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
688
 
            old_path, new_path)
 
631
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
689
632
 
690
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
691
 
        from_path=None, to_path=None):
 
633
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
692
634
        """Diff the content of given files in two trees
693
635
 
694
636
        :param from_file_id: The id of the file in the from tree.  If None,
696
638
        :param to_file_id: The id of the file in the to tree.  This may refer
697
639
            to a different file from from_file_id.  If None,
698
640
            the file is not present in the to tree.
699
 
        :param from_path: The path in the from tree or None if unknown.
700
 
        :param to_path: The path in the to tree or None if unknown.
701
641
        """
702
 
        def _get_text(tree, file_id, path):
 
642
        def _get_text(tree, file_id):
703
643
            if file_id is not None:
704
 
                return tree.get_file_lines(file_id, path)
 
644
                return tree.get_file(file_id).readlines()
705
645
            else:
706
646
                return []
707
647
        try:
708
 
            from_text = _get_text(self.old_tree, from_file_id, from_path)
709
 
            to_text = _get_text(self.new_tree, to_file_id, to_path)
 
648
            from_text = _get_text(self.old_tree, from_file_id)
 
649
            to_text = _get_text(self.new_tree, to_file_id)
710
650
            self.text_differ(from_label, from_text, to_label, to_text,
711
 
                             self.to_file, path_encoding=self.path_encoding)
 
651
                             self.to_file)
712
652
        except errors.BinaryFile:
713
653
            self.to_file.write(
714
654
                  ("Binary files %s and %s differ\n" %
715
 
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
 
655
                  (from_label, to_label)).encode(self.path_encoding))
716
656
        return self.CHANGED
717
657
 
718
658
 
727
667
    @classmethod
728
668
    def from_string(klass, command_string, old_tree, new_tree, to_file,
729
669
                    path_encoding='utf-8'):
730
 
        command_template = cmdline.split(command_string)
731
 
        if '@' not in command_string:
732
 
            command_template.extend(['@old_path', '@new_path'])
 
670
        command_template = commands.shlex_split_unicode(command_string)
 
671
        command_template.extend(['%(old_path)s', '%(new_path)s'])
733
672
        return klass(command_template, old_tree, new_tree, to_file,
734
673
                     path_encoding)
735
674
 
736
675
    @classmethod
737
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
676
    def make_from_diff_tree(klass, command_string):
738
677
        def from_diff_tree(diff_tree):
739
 
            full_command_string = [command_string]
740
 
            if external_diff_options is not None:
741
 
                full_command_string += ' ' + external_diff_options
742
 
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
678
            return klass.from_string(command_string, diff_tree.old_tree,
743
679
                                     diff_tree.new_tree, diff_tree.to_file)
744
680
        return from_diff_tree
745
681
 
746
682
    def _get_command(self, old_path, new_path):
747
683
        my_map = {'old_path': old_path, 'new_path': new_path}
748
 
        return [AtTemplate(t).substitute(my_map) for t in
749
 
                self.command_template]
 
684
        return [t % my_map for t in self.command_template]
750
685
 
751
686
    def _execute(self, old_path, new_path):
752
687
        command = self._get_command(old_path, new_path)
772
707
                raise
773
708
        return True
774
709
 
775
 
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
776
 
                    allow_write=False):
777
 
        if not force_temp and isinstance(tree, WorkingTree):
778
 
            return tree.abspath(tree.id2path(file_id))
779
 
        
 
710
    def _write_file(self, file_id, tree, prefix, relpath):
780
711
        full_path = osutils.pathjoin(self._root, prefix, relpath)
781
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
712
        if self._try_symlink_root(tree, prefix):
782
713
            return full_path
783
714
        parent_dir = osutils.dirname(full_path)
784
715
        try:
795
726
                target.close()
796
727
        finally:
797
728
            source.close()
798
 
        try:
799
 
            mtime = tree.get_file_mtime(file_id)
800
 
        except errors.FileTimestampUnavailable:
801
 
            pass
802
 
        else:
803
 
            os.utime(full_path, (mtime, mtime))
804
 
        if not allow_write:
805
 
            osutils.make_readonly(full_path)
 
729
        osutils.make_readonly(full_path)
 
730
        mtime = tree.get_file_mtime(file_id)
 
731
        os.utime(full_path, (mtime, mtime))
806
732
        return full_path
807
733
 
808
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
809
 
                       allow_write_new=False):
 
734
    def _prepare_files(self, file_id, old_path, new_path):
810
735
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
811
 
                                         old_path, force_temp)
 
736
                                         old_path)
812
737
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
813
 
                                         new_path, force_temp,
814
 
                                         allow_write=allow_write_new)
 
738
                                         new_path)
815
739
        return old_disk_path, new_disk_path
816
740
 
817
741
    def finish(self):
818
 
        try:
819
 
            osutils.rmtree(self._root)
820
 
        except OSError, e:
821
 
            if e.errno != errno.ENOENT:
822
 
                mutter("The temporary directory \"%s\" was not "
823
 
                        "cleanly removed: %s." % (self._root, e))
 
742
        osutils.rmtree(self._root)
824
743
 
825
744
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
826
745
        if (old_kind, new_kind) != ('file', 'file'):
827
746
            return DiffPath.CANNOT_DIFF
828
 
        (old_disk_path, new_disk_path) = self._prepare_files(
829
 
                                                file_id, old_path, new_path)
830
 
        self._execute(old_disk_path, new_disk_path)
831
 
 
832
 
    def edit_file(self, file_id):
833
 
        """Use this tool to edit a file.
834
 
 
835
 
        A temporary copy will be edited, and the new contents will be
836
 
        returned.
837
 
 
838
 
        :param file_id: The id of the file to edit.
839
 
        :return: The new contents of the file.
840
 
        """
841
 
        old_path = self.old_tree.id2path(file_id)
842
 
        new_path = self.new_tree.id2path(file_id)
843
 
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
844
 
                                           allow_write_new=True,
845
 
                                           force_temp=True)[1]
846
 
        command = self._get_command(osutils.pathjoin('old', old_path),
847
 
                                    osutils.pathjoin('new', new_path))
848
 
        subprocess.call(command, cwd=self._root)
849
 
        new_file = open(new_abs_path, 'r')
850
 
        try:
851
 
            return new_file.read()
852
 
        finally:
853
 
            new_file.close()
 
747
        self._prepare_files(file_id, old_path, new_path)
 
748
        self._execute(osutils.pathjoin('old', old_path),
 
749
                      osutils.pathjoin('new', new_path))
854
750
 
855
751
 
856
752
class DiffTree(object):
913
809
        :param using: Commandline to use to invoke an external diff tool
914
810
        """
915
811
        if using is not None:
916
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
812
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
917
813
        else:
918
814
            extra_factories = []
919
815
        if external_diff_options:
920
816
            opts = external_diff_options.split()
921
 
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
922
 
                """:param path_encoding: not used but required
923
 
                        to match the signature of internal_diff.
924
 
                """
 
817
            def diff_file(olab, olines, nlab, nlines, to_file):
925
818
                external_diff(olab, olines, nlab, nlines, to_file, opts)
926
819
        else:
927
820
            diff_file = internal_diff
933
826
    def show_diff(self, specific_files, extra_trees=None):
934
827
        """Write tree diff to self.to_file
935
828
 
936
 
        :param specific_files: the specific files to compare (recursive)
 
829
        :param sepecific_files: the specific files to compare (recursive)
937
830
        :param extra_trees: extra trees to use for mapping paths to file_ids
938
831
        """
939
832
        try:
997
890
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
998
891
                                   newpath_encoded, prop_str))
999
892
            if changed_content:
1000
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
 
893
                self.diff(file_id, oldpath, newpath)
1001
894
                has_changes = 1
1002
895
            if renamed:
1003
896
                has_changes = 1
1018
911
            new_kind = self.new_tree.kind(file_id)
1019
912
        except (errors.NoSuchId, errors.NoSuchFile):
1020
913
            new_kind = None
1021
 
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
1022
 
 
1023
 
 
1024
 
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
914
 
1025
915
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1026
916
                                       new_path, old_kind, new_kind)
1027
917
        if result is DiffPath.CANNOT_DIFF:
1029
919
            if error_path is None:
1030
920
                error_path = old_path
1031
921
            raise errors.NoDiffFound(error_path)
1032
 
 
1033
 
 
1034
 
format_registry = Registry()
1035
 
format_registry.register('default', DiffTree)