← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2009-03-16 07:44:05 UTC
  • mto: This revision was merged to the branch mainline in revision 4149.
  • Revision ID: robertc@robertcollins.net-20090316074405-t9guvf13rj4mlhuk
More test fallout, but all caught now.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2010 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
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
30
30
from bzrlib import (
31
31
    branch as _mod_branch,
32
32
    bzrdir,
33
 
    cmdline,
34
 
    cleanup,
 
33
    commands,
35
34
    errors,
36
35
    osutils,
37
36
    patiencediff,
39
38
    timestamp,
40
39
    views,
41
40
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
41
""")
45
42
 
46
 
from bzrlib.registry import (
47
 
    Registry,
48
 
    )
49
43
from bzrlib.symbol_versioning import (
50
 
    deprecated_function,
51
 
    deprecated_in,
52
 
    )
 
44
        deprecated_function,
 
45
        one_three
 
46
        )
53
47
from bzrlib.trace import mutter, note, warning
54
48
 
55
49
 
56
 
class AtTemplate(string.Template):
57
 
    """Templating class that uses @ instead of $."""
58
 
 
59
 
    delimiter = '@'
60
 
 
61
 
 
62
50
# TODO: Rather than building a changeset object, we should probably
63
51
# invoke callbacks on an object.  That object can either accumulate a
64
52
# list, write them out directly, etc etc.
184
172
 
185
173
        if not diff_opts:
186
174
            diff_opts = []
187
 
        if sys.platform == 'win32':
188
 
            # Popen doesn't do the proper encoding for external commands
189
 
            # Since we are dealing with an ANSI api, use mbcs encoding
190
 
            old_filename = old_filename.encode('mbcs')
191
 
            new_filename = new_filename.encode('mbcs')
192
175
        diffcmd = ['diff',
193
176
                   '--label', old_filename,
194
177
                   old_abspath,
290
273
                        new_abspath, e)
291
274
 
292
275
 
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
 
def get_trees_and_branches_to_diff_locked(
327
 
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
328
 
    """Get the trees and specific files to diff given a list of paths.
329
 
 
330
 
    This method works out the trees to be diff'ed and the files of
331
 
    interest within those trees.
332
 
 
333
 
    :param path_list:
334
 
        the list of arguments passed to the diff command
335
 
    :param revision_specs:
336
 
        Zero, one or two RevisionSpecs from the diff command line,
337
 
        saying what revisions to compare.
338
 
    :param old_url:
339
 
        The url of the old branch or tree. If None, the tree to use is
340
 
        taken from the first path, if any, or the current working tree.
341
 
    :param new_url:
342
 
        The url of the new branch or tree. If None, the tree to use is
343
 
        taken from the first path, if any, or the current working tree.
344
 
    :param add_cleanup:
345
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
346
 
        will register cleanups that must be run to unlock the trees, etc.
347
 
    :param apply_view:
348
 
        if True and a view is set, apply the view or check that the paths
349
 
        are within it
350
 
    :returns:
351
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
352
 
        specific_files, extra_trees) where extra_trees is a sequence of
353
 
        additional trees to search in for file-ids.  The trees and branches
354
 
        will be read-locked until the cleanups registered via the add_cleanup
355
 
        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.
356
301
    """
357
302
    # Get the old and new revision specs
358
303
    old_revision_spec = None
381
326
        default_location = path_list[0]
382
327
        other_paths = path_list[1:]
383
328
 
384
 
    def lock_tree_or_branch(wt, br):
385
 
        if wt is not None:
386
 
            wt.lock_read()
387
 
            add_cleanup(wt.unlock)
388
 
        elif br is not None:
389
 
            br.lock_read()
390
 
            add_cleanup(br.unlock)
391
 
 
392
329
    # Get the old location
393
330
    specific_files = []
394
331
    if old_url is None:
395
332
        old_url = default_location
396
333
    working_tree, branch, relpath = \
397
334
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
 
    lock_tree_or_branch(working_tree, branch)
399
335
    if consider_relpath and relpath != '':
400
336
        if working_tree is not None and apply_view:
401
337
            views.check_path_in_view(working_tree, relpath)
402
338
        specific_files.append(relpath)
403
339
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
404
 
    old_branch = branch
405
340
 
406
341
    # Get the new location
407
342
    if new_url is None:
409
344
    if new_url != old_url:
410
345
        working_tree, branch, relpath = \
411
346
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
347
        if consider_relpath and relpath != '':
414
348
            if working_tree is not None and apply_view:
415
349
                views.check_path_in_view(working_tree, relpath)
416
350
            specific_files.append(relpath)
417
351
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
352
        basis_is_default=working_tree is None)
419
 
    new_branch = branch
420
353
 
421
354
    # Get the specific files (all files is None, no files is [])
422
355
    if make_paths_wt_relative and working_tree is not None:
435
368
            if view_files:
436
369
                specific_files = view_files
437
370
                view_str = views.view_display_str(view_files)
438
 
                note("*** Ignoring files outside view. View is %s" % view_str)
 
371
                note("*** ignoring files outside view: %s" % view_str)
439
372
 
440
373
    # Get extra trees that ought to be searched for file-ids
441
374
    extra_trees = None
442
375
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
376
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
445
 
 
 
377
    return old_tree, new_tree, specific_files, extra_trees
446
378
 
447
379
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
448
380
    if branch is None and tree is not None:
463
395
                    old_label='a/', new_label='b/',
464
396
                    extra_trees=None,
465
397
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
398
                    using=None):
468
399
    """Show in text form the changes from one tree to another.
469
400
 
470
 
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
472
 
        changes.
473
 
    :param external_diff_options: If set, use an external GNU diff and pass 
474
 
        these options.
475
 
    :param extra_trees: If set, more Trees to use for looking up file ids
476
 
    :param path_encoding: If set, the path will be encoded as specified, 
477
 
        otherwise is supposed to be utf8
478
 
    :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
479
416
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
417
    old_tree.lock_read()
483
418
    try:
484
419
        if extra_trees is not None:
486
421
                tree.lock_read()
487
422
        new_tree.lock_read()
488
423
        try:
489
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
490
 
                                                   path_encoding,
491
 
                                                   external_diff_options,
492
 
                                                   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)
493
428
            return differ.show_diff(specific_files, extra_trees)
494
429
        finally:
495
430
            new_tree.unlock()
502
437
 
503
438
def _patch_header_date(tree, file_id, path):
504
439
    """Returns a timestamp suitable for use in a patch header."""
505
 
    try:
506
 
        mtime = tree.get_file_mtime(file_id, path)
507
 
    except errors.FileTimestampUnavailable:
508
 
        mtime = 0
 
440
    mtime = tree.get_file_mtime(file_id, path)
509
441
    return timestamp.format_patch_date(mtime)
510
442
 
511
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
 
512
451
def get_executable_change(old_is_x, new_is_x):
513
452
    descr = { True:"+x", False:"-x", None:"??" }
514
453
    if old_is_x != new_is_x:
689
628
            return self.CANNOT_DIFF
690
629
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
630
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
692
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
693
 
            old_path, new_path)
 
631
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
694
632
 
695
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
 
        from_path=None, to_path=None):
 
633
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
697
634
        """Diff the content of given files in two trees
698
635
 
699
636
        :param from_file_id: The id of the file in the from tree.  If None,
701
638
        :param to_file_id: The id of the file in the to tree.  This may refer
702
639
            to a different file from from_file_id.  If None,
703
640
            the file is not present in the to tree.
704
 
        :param from_path: The path in the from tree or None if unknown.
705
 
        :param to_path: The path in the to tree or None if unknown.
706
641
        """
707
 
        def _get_text(tree, file_id, path):
 
642
        def _get_text(tree, file_id):
708
643
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
 
644
                return tree.get_file(file_id).readlines()
710
645
            else:
711
646
                return []
712
647
        try:
713
 
            from_text = _get_text(self.old_tree, from_file_id, from_path)
714
 
            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)
715
650
            self.text_differ(from_label, from_text, to_label, to_text,
716
651
                             self.to_file)
717
652
        except errors.BinaryFile:
732
667
    @classmethod
733
668
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
669
                    path_encoding='utf-8'):
735
 
        command_template = cmdline.split(command_string)
736
 
        if '@' not in command_string:
737
 
            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'])
738
672
        return klass(command_template, old_tree, new_tree, to_file,
739
673
                     path_encoding)
740
674
 
747
681
 
748
682
    def _get_command(self, old_path, new_path):
749
683
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
684
        return [t % my_map for t in self.command_template]
752
685
 
753
686
    def _execute(self, old_path, new_path):
754
687
        command = self._get_command(old_path, new_path)
774
707
                raise
775
708
        return True
776
709
 
777
 
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
778
 
                    allow_write=False):
779
 
        if not force_temp and isinstance(tree, WorkingTree):
780
 
            return tree.abspath(tree.id2path(file_id))
781
 
        
 
710
    def _write_file(self, file_id, tree, prefix, relpath):
782
711
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
712
        if self._try_symlink_root(tree, prefix):
784
713
            return full_path
785
714
        parent_dir = osutils.dirname(full_path)
786
715
        try:
797
726
                target.close()
798
727
        finally:
799
728
            source.close()
800
 
        try:
801
 
            mtime = tree.get_file_mtime(file_id)
802
 
        except errors.FileTimestampUnavailable:
803
 
            pass
804
 
        else:
805
 
            os.utime(full_path, (mtime, mtime))
806
 
        if not allow_write:
807
 
            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))
808
732
        return full_path
809
733
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
 
734
    def _prepare_files(self, file_id, old_path, new_path):
812
735
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
 
                                         old_path, force_temp)
 
736
                                         old_path)
814
737
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
 
                                         new_path, force_temp,
816
 
                                         allow_write=allow_write_new)
 
738
                                         new_path)
817
739
        return old_disk_path, new_disk_path
818
740
 
819
741
    def finish(self):
820
 
        try:
821
 
            osutils.rmtree(self._root)
822
 
        except OSError, e:
823
 
            if e.errno != errno.ENOENT:
824
 
                mutter("The temporary directory \"%s\" was not "
825
 
                        "cleanly removed: %s." % (self._root, e))
 
742
        osutils.rmtree(self._root)
826
743
 
827
744
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
745
        if (old_kind, new_kind) != ('file', 'file'):
829
746
            return DiffPath.CANNOT_DIFF
830
 
        (old_disk_path, new_disk_path) = self._prepare_files(
831
 
                                                file_id, old_path, new_path)
832
 
        self._execute(old_disk_path, new_disk_path)
833
 
 
834
 
    def edit_file(self, file_id):
835
 
        """Use this tool to edit a file.
836
 
 
837
 
        A temporary copy will be edited, and the new contents will be
838
 
        returned.
839
 
 
840
 
        :param file_id: The id of the file to edit.
841
 
        :return: The new contents of the file.
842
 
        """
843
 
        old_path = self.old_tree.id2path(file_id)
844
 
        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))
850
 
        subprocess.call(command, cwd=self._root)
851
 
        new_file = open(new_abs_path, 'r')
852
 
        try:
853
 
            return new_file.read()
854
 
        finally:
855
 
            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))
856
750
 
857
751
 
858
752
class DiffTree(object):
932
826
    def show_diff(self, specific_files, extra_trees=None):
933
827
        """Write tree diff to self.to_file
934
828
 
935
 
        :param specific_files: the specific files to compare (recursive)
 
829
        :param sepecific_files: the specific files to compare (recursive)
936
830
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
831
        """
938
832
        try:
996
890
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
891
                                   newpath_encoded, prop_str))
998
892
            if changed_content:
999
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
 
893
                self.diff(file_id, oldpath, newpath)
1000
894
                has_changes = 1
1001
895
            if renamed:
1002
896
                has_changes = 1
1017
911
            new_kind = self.new_tree.kind(file_id)
1018
912
        except (errors.NoSuchId, errors.NoSuchFile):
1019
913
            new_kind = None
1020
 
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
1021
 
 
1022
 
 
1023
 
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
914
 
1024
915
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
916
                                       new_path, old_kind, new_kind)
1026
917
        if result is DiffPath.CANNOT_DIFF:
1028
919
            if error_path is None:
1029
920
                error_path = old_path
1030
921
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
format_registry.register('default', DiffTree)