← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: John Arbash Meinel
  • Date: 2008-09-09 15:09:12 UTC
  • mto: This revision was merged to the branch mainline in revision 3699.
  • Revision ID: john@arbash-meinel.com-20080909150912-wyttm8he1zsls2ck
Use the right timing function on win32

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,
38
37
    textfile,
39
38
    timestamp,
40
 
    views,
41
39
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
40
""")
45
41
 
46
 
from bzrlib.registry import (
47
 
    Registry,
48
 
    )
49
42
from bzrlib.symbol_versioning import (
50
 
    deprecated_function,
51
 
    deprecated_in,
52
 
    )
53
 
from bzrlib.trace import mutter, note, warning
54
 
 
55
 
 
56
 
class AtTemplate(string.Template):
57
 
    """Templating class that uses @ instead of $."""
58
 
 
59
 
    delimiter = '@'
 
43
        deprecated_function,
 
44
        one_three
 
45
        )
 
46
from bzrlib.trace import mutter, warning
60
47
 
61
48
 
62
49
# TODO: Rather than building a changeset object, we should probably
91
78
    # both sequences are empty.
92
79
    if not oldlines and not newlines:
93
80
        return
94
 
 
 
81
    
95
82
    if allow_binary is False:
96
83
        textfile.check_text_lines(oldlines)
97
84
        textfile.check_text_lines(newlines)
112
99
        ud[2] = ud[2].replace('-1,0', '-0,0')
113
100
    elif not newlines:
114
101
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
102
    # work around for difflib emitting random spaces after the label
 
103
    ud[0] = ud[0][:-2] + '\n'
 
104
    ud[1] = ud[1][:-2] + '\n'
115
105
 
116
106
    for line in ud:
117
107
        to_file.write(line)
184
174
 
185
175
        if not diff_opts:
186
176
            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
177
        diffcmd = ['diff',
193
178
                   '--label', old_filename,
194
179
                   old_abspath,
217
202
            break
218
203
        else:
219
204
            diffcmd.append('-u')
220
 
 
 
205
                  
221
206
        if diff_opts:
222
207
            diffcmd.extend(diff_opts)
223
208
 
224
209
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
225
210
        out,err = pipe.communicate()
226
211
        rc = pipe.returncode
227
 
 
 
212
        
228
213
        # internal_diff() adds a trailing newline, add one here for consistency
229
214
        out += '\n'
230
215
        if rc == 2:
265
250
                msg = 'signal %d' % (-rc)
266
251
            else:
267
252
                msg = 'exit code %d' % rc
268
 
 
269
 
            raise errors.BzrError('external diff failed with %s; command: %r'
 
253
                
 
254
            raise errors.BzrError('external diff failed with %s; command: %r' 
270
255
                                  % (rc, diffcmd))
271
256
 
272
257
 
290
275
                        new_abspath, e)
291
276
 
292
277
 
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.
 
278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
 
279
    """Get the trees and specific files to diff given a list of paths.
 
280
 
 
281
    This method works out the trees to be diff'ed and the files of
 
282
    interest within those trees.
 
283
 
 
284
    :param path_list:
 
285
        the list of arguments passed to the diff command
 
286
    :param revision_specs:
 
287
        Zero, one or two RevisionSpecs from the diff command line,
 
288
        saying what revisions to compare.
 
289
    :param old_url:
 
290
        The url of the old branch or tree. If None, the tree to use is
 
291
        taken from the first path, if any, or the current working tree.
 
292
    :param new_url:
 
293
        The url of the new branch or tree. If None, the tree to use is
 
294
        taken from the first path, if any, or the current working tree.
 
295
    :returns:
 
296
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
297
        extra_trees is a sequence of additional trees to search in for
 
298
        file-ids.
356
299
    """
357
300
    # Get the old and new revision specs
358
301
    old_revision_spec = None
381
324
        default_location = path_list[0]
382
325
        other_paths = path_list[1:]
383
326
 
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
327
    # Get the old location
393
328
    specific_files = []
394
329
    if old_url is None:
395
330
        old_url = default_location
396
331
    working_tree, branch, relpath = \
397
332
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
 
    lock_tree_or_branch(working_tree, branch)
399
333
    if consider_relpath and relpath != '':
400
 
        if working_tree is not None and apply_view:
401
 
            views.check_path_in_view(working_tree, relpath)
402
334
        specific_files.append(relpath)
403
335
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
404
 
    old_branch = branch
405
336
 
406
337
    # Get the new location
407
338
    if new_url is None:
409
340
    if new_url != old_url:
410
341
        working_tree, branch, relpath = \
411
342
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
343
        if consider_relpath and relpath != '':
414
 
            if working_tree is not None and apply_view:
415
 
                views.check_path_in_view(working_tree, relpath)
416
344
            specific_files.append(relpath)
417
345
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
346
        basis_is_default=working_tree is None)
419
 
    new_branch = branch
420
347
 
421
348
    # Get the specific files (all files is None, no files is [])
422
349
    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,
426
 
            apply_view=apply_view)
427
 
        except errors.FileInWrongBranch:
428
 
            raise errors.BzrCommandError("Files are in different branches")
 
350
        other_paths = _relative_paths_in_tree(working_tree, other_paths)
429
351
    specific_files.extend(other_paths)
430
352
    if len(specific_files) == 0:
431
353
        specific_files = None
432
 
        if (working_tree is not None and working_tree.supports_views()
433
 
            and apply_view):
434
 
            view_files = working_tree.views.lookup_view()
435
 
            if view_files:
436
 
                specific_files = view_files
437
 
                view_str = views.view_display_str(view_files)
438
 
                note("*** Ignoring files outside view. View is %s" % view_str)
439
354
 
440
355
    # Get extra trees that ought to be searched for file-ids
441
356
    extra_trees = None
442
357
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
358
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
 
359
    return old_tree, new_tree, specific_files, extra_trees
445
360
 
446
361
 
447
362
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
455
370
                return branch.basis_tree()
456
371
        else:
457
372
            return tree
458
 
    return spec.as_tree(branch)
 
373
    if not spec.needs_branch():
 
374
        branch = _mod_branch.Branch.open(spec.get_branch())
 
375
    revision_id = spec.as_revision_id(branch)
 
376
    return branch.repository.revision_tree(revision_id)
 
377
 
 
378
 
 
379
def _relative_paths_in_tree(tree, paths):
 
380
    """Get the relative paths within a working tree.
 
381
 
 
382
    Each path may be either an absolute path or a path relative to the
 
383
    current working directory.
 
384
    """
 
385
    result = []
 
386
    for filename in paths:
 
387
        try:
 
388
            result.append(tree.relpath(osutils.dereference_path(filename)))
 
389
        except errors.PathNotChild:
 
390
            raise errors.BzrCommandError("Files are in different branches")
 
391
    return result
459
392
 
460
393
 
461
394
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
463
396
                    old_label='a/', new_label='b/',
464
397
                    extra_trees=None,
465
398
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
399
                    using=None):
468
400
    """Show in text form the changes from one tree to another.
469
401
 
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)
 
402
    to_file
 
403
        The output stream.
 
404
 
 
405
    specific_files
 
406
        Include only changes to these files - None for all changes.
 
407
 
 
408
    external_diff_options
 
409
        If set, use an external GNU diff and pass these options.
 
410
 
 
411
    extra_trees
 
412
        If set, more Trees to use for looking up file ids
 
413
 
 
414
    path_encoding
 
415
        If set, the path will be encoded as specified, otherwise is supposed
 
416
        to be utf8
479
417
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
418
    old_tree.lock_read()
483
419
    try:
484
420
        if extra_trees is not None:
486
422
                tree.lock_read()
487
423
        new_tree.lock_read()
488
424
        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)
 
425
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
426
                                                 path_encoding,
 
427
                                                 external_diff_options,
 
428
                                                 old_label, new_label, using)
493
429
            return differ.show_diff(specific_files, extra_trees)
494
430
        finally:
495
431
            new_tree.unlock()
502
438
 
503
439
def _patch_header_date(tree, file_id, path):
504
440
    """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
 
441
    mtime = tree.get_file_mtime(file_id, path)
509
442
    return timestamp.format_patch_date(mtime)
510
443
 
511
444
 
 
445
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
446
    """Complain if paths are not in either inventory or tree.
 
447
 
 
448
    It's OK with the files exist in either tree's inventory, or 
 
449
    if they exist in the tree but are not versioned.
 
450
    
 
451
    This can be used by operations such as bzr status that can accept
 
452
    unknown or ignored files.
 
453
    """
 
454
    mutter("check paths: %r", paths)
 
455
    if not paths:
 
456
        return
 
457
    s = old_tree.filter_unversioned_files(paths)
 
458
    s = new_tree.filter_unversioned_files(s)
 
459
    s = [path for path in s if not new_tree.has_filename(path)]
 
460
    if s:
 
461
        raise errors.PathsDoNotExist(sorted(s))
 
462
 
 
463
 
 
464
@deprecated_function(one_three)
 
465
def get_prop_change(meta_modified):
 
466
    if meta_modified:
 
467
        return " (properties changed)"
 
468
    else:
 
469
        return  ""
 
470
 
512
471
def get_executable_change(old_is_x, new_is_x):
513
472
    descr = { True:"+x", False:"-x", None:"??" }
514
473
    if old_is_x != new_is_x:
689
648
            return self.CANNOT_DIFF
690
649
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
650
        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)
 
651
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
694
652
 
695
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
 
        from_path=None, to_path=None):
 
653
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
697
654
        """Diff the content of given files in two trees
698
655
 
699
656
        :param from_file_id: The id of the file in the from tree.  If None,
701
658
        :param to_file_id: The id of the file in the to tree.  This may refer
702
659
            to a different file from from_file_id.  If None,
703
660
            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
661
        """
707
 
        def _get_text(tree, file_id, path):
 
662
        def _get_text(tree, file_id):
708
663
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
 
664
                return tree.get_file(file_id).readlines()
710
665
            else:
711
666
                return []
712
667
        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)
 
668
            from_text = _get_text(self.old_tree, from_file_id)
 
669
            to_text = _get_text(self.new_tree, to_file_id)
715
670
            self.text_differ(from_label, from_text, to_label, to_text,
716
671
                             self.to_file)
717
672
        except errors.BinaryFile:
732
687
    @classmethod
733
688
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
689
                    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'])
 
690
        command_template = commands.shlex_split_unicode(command_string)
 
691
        command_template.extend(['%(old_path)s', '%(new_path)s'])
738
692
        return klass(command_template, old_tree, new_tree, to_file,
739
693
                     path_encoding)
740
694
 
747
701
 
748
702
    def _get_command(self, old_path, new_path):
749
703
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
 
704
        return [t % my_map for t in self.command_template]
752
705
 
753
706
    def _execute(self, old_path, new_path):
754
707
        command = self._get_command(old_path, new_path)
774
727
                raise
775
728
        return True
776
729
 
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
 
        
 
730
    def _write_file(self, file_id, tree, prefix, relpath):
782
731
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
732
        if self._try_symlink_root(tree, prefix):
784
733
            return full_path
785
734
        parent_dir = osutils.dirname(full_path)
786
735
        try:
797
746
                target.close()
798
747
        finally:
799
748
            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)
 
749
        osutils.make_readonly(full_path)
 
750
        mtime = tree.get_file_mtime(file_id)
 
751
        os.utime(full_path, (mtime, mtime))
808
752
        return full_path
809
753
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
 
754
    def _prepare_files(self, file_id, old_path, new_path):
812
755
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
 
                                         old_path, force_temp)
 
756
                                         old_path)
814
757
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
 
                                         new_path, force_temp,
816
 
                                         allow_write=allow_write_new)
 
758
                                         new_path)
817
759
        return old_disk_path, new_disk_path
818
760
 
819
761
    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))
 
762
        osutils.rmtree(self._root)
826
763
 
827
764
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
765
        if (old_kind, new_kind) != ('file', 'file'):
829
766
            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()
 
767
        self._prepare_files(file_id, old_path, new_path)
 
768
        self._execute(osutils.pathjoin('old', old_path),
 
769
                      osutils.pathjoin('new', new_path))
856
770
 
857
771
 
858
772
class DiffTree(object):
932
846
    def show_diff(self, specific_files, extra_trees=None):
933
847
        """Write tree diff to self.to_file
934
848
 
935
 
        :param specific_files: the specific files to compare (recursive)
 
849
        :param sepecific_files: the specific files to compare (recursive)
936
850
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
851
        """
938
852
        try:
996
910
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
911
                                   newpath_encoded, prop_str))
998
912
            if changed_content:
999
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
 
913
                self.diff(file_id, oldpath, newpath)
1000
914
                has_changes = 1
1001
915
            if renamed:
1002
916
                has_changes = 1
1017
931
            new_kind = self.new_tree.kind(file_id)
1018
932
        except (errors.NoSuchId, errors.NoSuchFile):
1019
933
            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):
 
934
 
1024
935
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
936
                                       new_path, old_kind, new_kind)
1026
937
        if result is DiffPath.CANNOT_DIFF:
1028
939
            if error_path is None:
1029
940
                error_path = old_path
1030
941
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
format_registry.register('default', DiffTree)