← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 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
17
17
import difflib
18
18
import os
19
19
import re
20
 
import shutil
 
20
import string
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
 
    commands,
 
33
    cmdline,
 
34
    cleanup,
34
35
    errors,
35
36
    osutils,
36
37
    patiencediff,
38
39
    timestamp,
39
40
    views,
40
41
    )
 
42
 
 
43
from bzrlib.workingtree import WorkingTree
41
44
""")
42
45
 
 
46
from bzrlib.registry import (
 
47
    Registry,
 
48
    )
43
49
from bzrlib.symbol_versioning import (
44
50
    deprecated_function,
 
51
    deprecated_in,
45
52
    )
46
53
from bzrlib.trace import mutter, note, warning
47
54
 
48
55
 
 
56
class AtTemplate(string.Template):
 
57
    """Templating class that uses @ instead of $."""
 
58
 
 
59
    delimiter = '@'
 
60
 
 
61
 
49
62
# TODO: Rather than building a changeset object, we should probably
50
63
# invoke callbacks on an object.  That object can either accumulate a
51
64
# list, write them out directly, etc etc.
86
99
    if sequence_matcher is None:
87
100
        sequence_matcher = patiencediff.PatienceSequenceMatcher
88
101
    ud = patiencediff.unified_diff(oldlines, newlines,
89
 
                      fromfile=old_filename.encode(path_encoding),
90
 
                      tofile=new_filename.encode(path_encoding),
 
102
                      fromfile=old_filename.encode(path_encoding, 'replace'),
 
103
                      tofile=new_filename.encode(path_encoding, 'replace'),
91
104
                      sequencematcher=sequence_matcher)
92
105
 
93
106
    ud = list(ud)
171
184
 
172
185
        if not diff_opts:
173
186
            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')
174
192
        diffcmd = ['diff',
175
193
                   '--label', old_filename,
176
194
                   old_abspath,
272
290
                        new_abspath, e)
273
291
 
274
292
 
275
 
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
276
 
    apply_view=True):
277
 
    """Get the trees and specific files to diff given a list of paths.
278
 
 
279
 
    This method works out the trees to be diff'ed and the files of
280
 
    interest within those trees.
281
 
 
282
 
    :param path_list:
283
 
        the list of arguments passed to the diff command
284
 
    :param revision_specs:
285
 
        Zero, one or two RevisionSpecs from the diff command line,
286
 
        saying what revisions to compare.
287
 
    :param old_url:
288
 
        The url of the old branch or tree. If None, the tree to use is
289
 
        taken from the first path, if any, or the current working tree.
290
 
    :param new_url:
291
 
        The url of the new branch or tree. If None, the tree to use is
292
 
        taken from the first path, if any, or the current working tree.
293
 
    :param apply_view:
294
 
        if True and a view is set, apply the view or check that the paths
295
 
        are within it
296
 
    :returns:
297
 
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
298
 
        extra_trees is a sequence of additional trees to search in for
299
 
        file-ids.
 
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.
300
356
    """
301
357
    # Get the old and new revision specs
302
358
    old_revision_spec = None
325
381
        default_location = path_list[0]
326
382
        other_paths = path_list[1:]
327
383
 
 
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
 
328
392
    # Get the old location
329
393
    specific_files = []
330
394
    if old_url is None:
331
395
        old_url = default_location
332
396
    working_tree, branch, relpath = \
333
397
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
398
    lock_tree_or_branch(working_tree, branch)
334
399
    if consider_relpath and relpath != '':
335
400
        if working_tree is not None and apply_view:
336
401
            views.check_path_in_view(working_tree, relpath)
337
402
        specific_files.append(relpath)
338
403
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
404
    old_branch = branch
339
405
 
340
406
    # Get the new location
341
407
    if new_url is None:
343
409
    if new_url != old_url:
344
410
        working_tree, branch, relpath = \
345
411
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
412
        lock_tree_or_branch(working_tree, branch)
346
413
        if consider_relpath and relpath != '':
347
414
            if working_tree is not None and apply_view:
348
415
                views.check_path_in_view(working_tree, relpath)
349
416
            specific_files.append(relpath)
350
417
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
351
418
        basis_is_default=working_tree is None)
 
419
    new_branch = branch
352
420
 
353
421
    # Get the specific files (all files is None, no files is [])
354
422
    if make_paths_wt_relative and working_tree is not None:
355
 
        try:
356
 
            from bzrlib.builtins import safe_relpath_files
357
 
            other_paths = safe_relpath_files(working_tree, other_paths,
 
423
        other_paths = working_tree.safe_relpath_files(
 
424
            other_paths,
358
425
            apply_view=apply_view)
359
 
        except errors.FileInWrongBranch:
360
 
            raise errors.BzrCommandError("Files are in different branches")
361
426
    specific_files.extend(other_paths)
362
427
    if len(specific_files) == 0:
363
428
        specific_files = None
367
432
            if view_files:
368
433
                specific_files = view_files
369
434
                view_str = views.view_display_str(view_files)
370
 
                note("*** ignoring files outside view: %s" % view_str)
 
435
                note("*** Ignoring files outside view. View is %s" % view_str)
371
436
 
372
437
    # Get extra trees that ought to be searched for file-ids
373
438
    extra_trees = None
374
439
    if working_tree is not None and working_tree not in (old_tree, new_tree):
375
440
        extra_trees = (working_tree,)
376
 
    return old_tree, new_tree, specific_files, extra_trees
 
441
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
 
442
 
377
443
 
378
444
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
379
445
    if branch is None and tree is not None:
394
460
                    old_label='a/', new_label='b/',
395
461
                    extra_trees=None,
396
462
                    path_encoding='utf8',
397
 
                    using=None):
 
463
                    using=None,
 
464
                    format_cls=None):
398
465
    """Show in text form the changes from one tree to another.
399
466
 
400
 
    to_file
401
 
        The output stream.
402
 
 
403
 
    specific_files
404
 
        Include only changes to these files - None for all changes.
405
 
 
406
 
    external_diff_options
407
 
        If set, use an external GNU diff and pass these options.
408
 
 
409
 
    extra_trees
410
 
        If set, more Trees to use for looking up file ids
411
 
 
412
 
    path_encoding
413
 
        If set, the path will be encoded as specified, otherwise is supposed
414
 
        to be utf8
 
467
    :param to_file: The output stream.
 
468
    :param specific_files:Include only changes to these files - None for all
 
469
        changes.
 
470
    :param external_diff_options: If set, use an external GNU diff and pass 
 
471
        these options.
 
472
    :param extra_trees: If set, more Trees to use for looking up file ids
 
473
    :param path_encoding: If set, the path will be encoded as specified, 
 
474
        otherwise is supposed to be utf8
 
475
    :param format_cls: Formatter class (DiffTree subclass)
415
476
    """
 
477
    if format_cls is None:
 
478
        format_cls = DiffTree
416
479
    old_tree.lock_read()
417
480
    try:
418
481
        if extra_trees is not None:
420
483
                tree.lock_read()
421
484
        new_tree.lock_read()
422
485
        try:
423
 
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
424
 
                                                 path_encoding,
425
 
                                                 external_diff_options,
426
 
                                                 old_label, new_label, using)
 
486
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
487
                                                   path_encoding,
 
488
                                                   external_diff_options,
 
489
                                                   old_label, new_label, using)
427
490
            return differ.show_diff(specific_files, extra_trees)
428
491
        finally:
429
492
            new_tree.unlock()
436
499
 
437
500
def _patch_header_date(tree, file_id, path):
438
501
    """Returns a timestamp suitable for use in a patch header."""
439
 
    mtime = tree.get_file_mtime(file_id, path)
 
502
    try:
 
503
        mtime = tree.get_file_mtime(file_id, path)
 
504
    except errors.FileTimestampUnavailable:
 
505
        mtime = 0
440
506
    return timestamp.format_patch_date(mtime)
441
507
 
442
508
 
620
686
            return self.CANNOT_DIFF
621
687
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
622
688
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
623
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
689
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
690
            old_path, new_path)
624
691
 
625
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
692
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
693
        from_path=None, to_path=None):
626
694
        """Diff the content of given files in two trees
627
695
 
628
696
        :param from_file_id: The id of the file in the from tree.  If None,
630
698
        :param to_file_id: The id of the file in the to tree.  This may refer
631
699
            to a different file from from_file_id.  If None,
632
700
            the file is not present in the to tree.
 
701
        :param from_path: The path in the from tree or None if unknown.
 
702
        :param to_path: The path in the to tree or None if unknown.
633
703
        """
634
 
        def _get_text(tree, file_id):
 
704
        def _get_text(tree, file_id, path):
635
705
            if file_id is not None:
636
 
                return tree.get_file(file_id).readlines()
 
706
                return tree.get_file_lines(file_id, path)
637
707
            else:
638
708
                return []
639
709
        try:
640
 
            from_text = _get_text(self.old_tree, from_file_id)
641
 
            to_text = _get_text(self.new_tree, to_file_id)
 
710
            from_text = _get_text(self.old_tree, from_file_id, from_path)
 
711
            to_text = _get_text(self.new_tree, to_file_id, to_path)
642
712
            self.text_differ(from_label, from_text, to_label, to_text,
643
 
                             self.to_file)
 
713
                             self.to_file, path_encoding=self.path_encoding)
644
714
        except errors.BinaryFile:
645
715
            self.to_file.write(
646
716
                  ("Binary files %s and %s differ\n" %
647
 
                  (from_label, to_label)).encode(self.path_encoding))
 
717
                  (from_label, to_label)).encode(self.path_encoding,'replace'))
648
718
        return self.CHANGED
649
719
 
650
720
 
659
729
    @classmethod
660
730
    def from_string(klass, command_string, old_tree, new_tree, to_file,
661
731
                    path_encoding='utf-8'):
662
 
        command_template = commands.shlex_split_unicode(command_string)
663
 
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
732
        command_template = cmdline.split(command_string)
 
733
        if '@' not in command_string:
 
734
            command_template.extend(['@old_path', '@new_path'])
664
735
        return klass(command_template, old_tree, new_tree, to_file,
665
736
                     path_encoding)
666
737
 
667
738
    @classmethod
668
 
    def make_from_diff_tree(klass, command_string):
 
739
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
669
740
        def from_diff_tree(diff_tree):
670
 
            return klass.from_string(command_string, diff_tree.old_tree,
 
741
            full_command_string = [command_string]
 
742
            if external_diff_options is not None:
 
743
                full_command_string += ' ' + external_diff_options
 
744
            return klass.from_string(full_command_string, diff_tree.old_tree,
671
745
                                     diff_tree.new_tree, diff_tree.to_file)
672
746
        return from_diff_tree
673
747
 
674
748
    def _get_command(self, old_path, new_path):
675
749
        my_map = {'old_path': old_path, 'new_path': new_path}
676
 
        return [t % my_map for t in self.command_template]
 
750
        return [AtTemplate(t).substitute(my_map) for t in
 
751
                self.command_template]
677
752
 
678
753
    def _execute(self, old_path, new_path):
679
754
        command = self._get_command(old_path, new_path)
699
774
                raise
700
775
        return True
701
776
 
702
 
    def _write_file(self, file_id, tree, prefix, relpath):
 
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
        
703
782
        full_path = osutils.pathjoin(self._root, prefix, relpath)
704
 
        if self._try_symlink_root(tree, prefix):
 
783
        if not force_temp and self._try_symlink_root(tree, prefix):
705
784
            return full_path
706
785
        parent_dir = osutils.dirname(full_path)
707
786
        try:
718
797
                target.close()
719
798
        finally:
720
799
            source.close()
721
 
        osutils.make_readonly(full_path)
722
 
        mtime = tree.get_file_mtime(file_id)
723
 
        os.utime(full_path, (mtime, mtime))
 
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)
724
808
        return full_path
725
809
 
726
 
    def _prepare_files(self, file_id, old_path, new_path):
 
810
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
 
811
                       allow_write_new=False):
727
812
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
728
 
                                         old_path)
 
813
                                         old_path, force_temp)
729
814
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
730
 
                                         new_path)
 
815
                                         new_path, force_temp,
 
816
                                         allow_write=allow_write_new)
731
817
        return old_disk_path, new_disk_path
732
818
 
733
819
    def finish(self):
734
 
        osutils.rmtree(self._root)
 
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))
735
826
 
736
827
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
737
828
        if (old_kind, new_kind) != ('file', 'file'):
738
829
            return DiffPath.CANNOT_DIFF
739
 
        self._prepare_files(file_id, old_path, new_path)
740
 
        self._execute(osutils.pathjoin('old', old_path),
741
 
                      osutils.pathjoin('new', new_path))
 
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()
742
856
 
743
857
 
744
858
class DiffTree(object):
801
915
        :param using: Commandline to use to invoke an external diff tool
802
916
        """
803
917
        if using is not None:
804
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
918
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
805
919
        else:
806
920
            extra_factories = []
807
921
        if external_diff_options:
808
922
            opts = external_diff_options.split()
809
 
            def diff_file(olab, olines, nlab, nlines, to_file):
 
923
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
 
924
                """:param path_encoding: not used but required
 
925
                        to match the signature of internal_diff.
 
926
                """
810
927
                external_diff(olab, olines, nlab, nlines, to_file, opts)
811
928
        else:
812
929
            diff_file = internal_diff
818
935
    def show_diff(self, specific_files, extra_trees=None):
819
936
        """Write tree diff to self.to_file
820
937
 
821
 
        :param sepecific_files: the specific files to compare (recursive)
 
938
        :param specific_files: the specific files to compare (recursive)
822
939
        :param extra_trees: extra trees to use for mapping paths to file_ids
823
940
        """
824
941
        try:
882
999
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
883
1000
                                   newpath_encoded, prop_str))
884
1001
            if changed_content:
885
 
                self.diff(file_id, oldpath, newpath)
 
1002
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
886
1003
                has_changes = 1
887
1004
            if renamed:
888
1005
                has_changes = 1
903
1020
            new_kind = self.new_tree.kind(file_id)
904
1021
        except (errors.NoSuchId, errors.NoSuchFile):
905
1022
            new_kind = None
906
 
 
 
1023
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
1024
 
 
1025
 
 
1026
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
907
1027
        result = DiffPath._diff_many(self.differs, file_id, old_path,
908
1028
                                       new_path, old_kind, new_kind)
909
1029
        if result is DiffPath.CANNOT_DIFF:
911
1031
            if error_path is None:
912
1032
                error_path = old_path
913
1033
            raise errors.NoDiffFound(error_path)
 
1034
 
 
1035
 
 
1036
format_registry = Registry()
 
1037
format_registry.register('default', DiffTree)