← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Andrew Bennetts
  • Date: 2007-11-30 07:45:56 UTC
  • mto: (3053.3.2 integrate-1.0)
  • mto: This revision was merged to the branch mainline in revision 3059.
  • Revision ID: andrew.bennetts@canonical.com-20071130074556-ux7lnmgmx1ouiyi3
Address the rest of the review comments from John and myself.

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
21
20
import sys
22
21
 
23
22
from bzrlib.lazy_import import lazy_import
28
27
import time
29
28
 
30
29
from bzrlib import (
31
 
    branch as _mod_branch,
32
 
    bzrdir,
33
 
    cmdline,
34
 
    cleanup,
35
30
    errors,
36
31
    osutils,
37
32
    patiencediff,
38
33
    textfile,
39
34
    timestamp,
40
 
    views,
41
35
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
36
""")
45
37
 
46
 
from bzrlib.registry import (
47
 
    Registry,
48
 
    )
49
38
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 = '@'
 
39
        deprecated_function,
 
40
        )
 
41
from bzrlib.trace import mutter, warning
60
42
 
61
43
 
62
44
# TODO: Rather than building a changeset object, we should probably
91
73
    # both sequences are empty.
92
74
    if not oldlines and not newlines:
93
75
        return
94
 
 
 
76
    
95
77
    if allow_binary is False:
96
78
        textfile.check_text_lines(oldlines)
97
79
        textfile.check_text_lines(newlines)
104
86
                      sequencematcher=sequence_matcher)
105
87
 
106
88
    ud = list(ud)
107
 
    if len(ud) == 0: # Identical contents, nothing to do
108
 
        return
109
89
    # work-around for difflib being too smart for its own good
110
90
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
111
91
    if not oldlines:
112
92
        ud[2] = ud[2].replace('-1,0', '-0,0')
113
93
    elif not newlines:
114
94
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
95
    # work around for difflib emitting random spaces after the label
 
96
    ud[0] = ud[0][:-2] + '\n'
 
97
    ud[1] = ud[1][:-2] + '\n'
115
98
 
116
99
    for line in ud:
117
100
        to_file.write(line)
184
167
 
185
168
        if not diff_opts:
186
169
            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
170
        diffcmd = ['diff',
193
171
                   '--label', old_filename,
194
172
                   old_abspath,
217
195
            break
218
196
        else:
219
197
            diffcmd.append('-u')
220
 
 
 
198
                  
221
199
        if diff_opts:
222
200
            diffcmd.extend(diff_opts)
223
201
 
224
202
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
225
203
        out,err = pipe.communicate()
226
204
        rc = pipe.returncode
227
 
 
 
205
        
228
206
        # internal_diff() adds a trailing newline, add one here for consistency
229
207
        out += '\n'
230
208
        if rc == 2:
265
243
                msg = 'signal %d' % (-rc)
266
244
            else:
267
245
                msg = 'exit code %d' % rc
268
 
 
269
 
            raise errors.BzrError('external diff failed with %s; command: %r'
 
246
                
 
247
            raise errors.BzrError('external diff failed with %s; command: %r' 
270
248
                                  % (rc, diffcmd))
271
249
 
272
250
 
290
268
                        new_abspath, e)
291
269
 
292
270
 
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)
 
271
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
272
                    old_revision_spec=None, new_revision_spec=None,
 
273
                    revision_specs=None,
 
274
                    old_label='a/', new_label='b/'):
 
275
    """Helper for cmd_diff.
 
276
 
 
277
    :param tree:
 
278
        A WorkingTree
 
279
 
 
280
    :param specific_files:
 
281
        The specific files to compare, or None
 
282
 
 
283
    :param external_diff_options:
 
284
        If non-None, run an external diff, and pass it these options
 
285
 
 
286
    :param old_revision_spec:
 
287
        If None, use basis tree as old revision, otherwise use the tree for
 
288
        the specified revision. 
 
289
 
 
290
    :param new_revision_spec:
 
291
        If None, use working tree as new revision, otherwise use the tree for
 
292
        the specified revision.
324
293
    
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.
 
294
    :param revision_specs: 
 
295
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
 
296
        to compare.  This can be passed as an alternative to the old_revision_spec 
 
297
        and new_revision_spec parameters.
 
298
 
 
299
    The more general form is show_diff_trees(), where the caller
 
300
    supplies any two trees.
356
301
    """
357
 
    # Get the old and new revision specs
358
 
    old_revision_spec = None
359
 
    new_revision_spec = None
 
302
 
 
303
    # TODO: perhaps remove the old parameters old_revision_spec and
 
304
    # new_revision_spec, since this is only really for use from cmd_diff and
 
305
    # it now always passes through a sequence of revision_specs -- mbp
 
306
    # 20061221
 
307
 
 
308
    def spec_tree(spec):
 
309
        if tree:
 
310
            revision = spec.in_store(tree.branch)
 
311
        else:
 
312
            revision = spec.in_store(None)
 
313
        revision_id = revision.rev_id
 
314
        branch = revision.branch
 
315
        return branch.repository.revision_tree(revision_id)
 
316
 
360
317
    if revision_specs is not None:
 
318
        assert (old_revision_spec is None
 
319
                and new_revision_spec is None)
361
320
        if len(revision_specs) > 0:
362
321
            old_revision_spec = revision_specs[0]
363
 
            if old_url is None:
364
 
                old_url = old_revision_spec.get_branch()
365
322
        if len(revision_specs) > 1:
366
323
            new_revision_spec = revision_specs[1]
367
 
            if new_url is None:
368
 
                new_url = new_revision_spec.get_branch()
369
 
 
370
 
    other_paths = []
371
 
    make_paths_wt_relative = True
372
 
    consider_relpath = True
373
 
    if path_list is None or len(path_list) == 0:
374
 
        # If no path is given, the current working tree is used
375
 
        default_location = u'.'
376
 
        consider_relpath = False
377
 
    elif old_url is not None and new_url is not None:
378
 
        other_paths = path_list
379
 
        make_paths_wt_relative = False
380
 
    else:
381
 
        default_location = path_list[0]
382
 
        other_paths = path_list[1:]
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
 
 
392
 
    # Get the old location
393
 
    specific_files = []
394
 
    if old_url is None:
395
 
        old_url = default_location
396
 
    working_tree, branch, relpath = \
397
 
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
 
    lock_tree_or_branch(working_tree, branch)
399
 
    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
 
        specific_files.append(relpath)
403
 
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
404
 
    old_branch = branch
405
 
 
406
 
    # Get the new location
407
 
    if new_url is None:
408
 
        new_url = default_location
409
 
    if new_url != old_url:
410
 
        working_tree, branch, relpath = \
411
 
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
 
        lock_tree_or_branch(working_tree, branch)
413
 
        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
 
            specific_files.append(relpath)
417
 
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
418
 
        basis_is_default=working_tree is None)
419
 
    new_branch = branch
420
 
 
421
 
    # Get the specific files (all files is None, no files is [])
422
 
    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")
429
 
    specific_files.extend(other_paths)
430
 
    if len(specific_files) == 0:
431
 
        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
 
 
440
 
    # Get extra trees that ought to be searched for file-ids
441
 
    extra_trees = None
442
 
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
 
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
445
 
 
446
 
 
447
 
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
448
 
    if branch is None and tree is not None:
449
 
        branch = tree.branch
450
 
    if spec is None or spec.spec is None:
451
 
        if basis_is_default:
452
 
            if tree is not None:
453
 
                return tree.basis_tree()
454
 
            else:
455
 
                return branch.basis_tree()
456
 
        else:
457
 
            return tree
458
 
    return spec.as_tree(branch)
 
324
 
 
325
    if old_revision_spec is None:
 
326
        old_tree = tree.basis_tree()
 
327
    else:
 
328
        old_tree = spec_tree(old_revision_spec)
 
329
 
 
330
    if (new_revision_spec is None
 
331
        or new_revision_spec.spec is None):
 
332
        new_tree = tree
 
333
    else:
 
334
        new_tree = spec_tree(new_revision_spec)
 
335
 
 
336
    if new_tree is not tree:
 
337
        extra_trees = (tree,)
 
338
    else:
 
339
        extra_trees = None
 
340
 
 
341
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
342
                           external_diff_options,
 
343
                           old_label=old_label, new_label=new_label,
 
344
                           extra_trees=extra_trees)
459
345
 
460
346
 
461
347
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
462
348
                    external_diff_options=None,
463
349
                    old_label='a/', new_label='b/',
464
350
                    extra_trees=None,
465
 
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
351
                    path_encoding='utf8'):
468
352
    """Show in text form the changes from one tree to another.
469
353
 
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)
 
354
    to_files
 
355
        If set, include only changes to these files.
 
356
 
 
357
    external_diff_options
 
358
        If set, use an external GNU diff and pass these options.
 
359
 
 
360
    extra_trees
 
361
        If set, more Trees to use for looking up file ids
 
362
 
 
363
    path_encoding
 
364
        If set, the path will be encoded as specified, otherwise is supposed
 
365
        to be utf8
479
366
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
367
    old_tree.lock_read()
483
368
    try:
484
369
        if extra_trees is not None:
486
371
                tree.lock_read()
487
372
        new_tree.lock_read()
488
373
        try:
489
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
374
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
490
375
                                                   path_encoding,
491
376
                                                   external_diff_options,
492
 
                                                   old_label, new_label, using)
 
377
                                                   old_label, new_label)
493
378
            return differ.show_diff(specific_files, extra_trees)
494
379
        finally:
495
380
            new_tree.unlock()
502
387
 
503
388
def _patch_header_date(tree, file_id, path):
504
389
    """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
 
390
    mtime = tree.get_file_mtime(file_id, path)
 
391
    assert mtime is not None, \
 
392
        "got an mtime of None for file-id %s, path %s in tree %s" % (
 
393
                file_id, path, tree)
509
394
    return timestamp.format_patch_date(mtime)
510
395
 
511
396
 
512
 
def get_executable_change(old_is_x, new_is_x):
513
 
    descr = { True:"+x", False:"-x", None:"??" }
514
 
    if old_is_x != new_is_x:
515
 
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
397
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
398
    """Complain if paths are not in either inventory or tree.
 
399
 
 
400
    It's OK with the files exist in either tree's inventory, or 
 
401
    if they exist in the tree but are not versioned.
 
402
    
 
403
    This can be used by operations such as bzr status that can accept
 
404
    unknown or ignored files.
 
405
    """
 
406
    mutter("check paths: %r", paths)
 
407
    if not paths:
 
408
        return
 
409
    s = old_tree.filter_unversioned_files(paths)
 
410
    s = new_tree.filter_unversioned_files(s)
 
411
    s = [path for path in s if not new_tree.has_filename(path)]
 
412
    if s:
 
413
        raise errors.PathsDoNotExist(sorted(s))
 
414
 
 
415
 
 
416
def get_prop_change(meta_modified):
 
417
    if meta_modified:
 
418
        return " (properties changed)"
516
419
    else:
517
 
        return []
 
420
        return  ""
518
421
 
519
422
 
520
423
class DiffPath(object):
540
443
        self.to_file = to_file
541
444
        self.path_encoding = path_encoding
542
445
 
543
 
    def finish(self):
544
 
        pass
545
 
 
546
446
    @classmethod
547
447
    def from_diff_tree(klass, diff_tree):
548
448
        return klass(diff_tree.old_tree, diff_tree.new_tree,
568
468
    def __init__(self, differs):
569
469
        self.differs = differs
570
470
 
571
 
    def finish(self):
572
 
        pass
573
 
 
574
471
    @classmethod
575
472
    def from_diff_tree(klass, diff_tree):
576
473
        return klass(diff_tree.differs)
689
586
            return self.CANNOT_DIFF
690
587
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
588
        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)
 
589
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
694
590
 
695
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
 
        from_path=None, to_path=None):
 
591
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
697
592
        """Diff the content of given files in two trees
698
593
 
699
594
        :param from_file_id: The id of the file in the from tree.  If None,
701
596
        :param to_file_id: The id of the file in the to tree.  This may refer
702
597
            to a different file from from_file_id.  If None,
703
598
            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
599
        """
707
 
        def _get_text(tree, file_id, path):
 
600
        def _get_text(tree, file_id):
708
601
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
 
602
                return tree.get_file(file_id).readlines()
710
603
            else:
711
604
                return []
712
605
        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)
 
606
            from_text = _get_text(self.old_tree, from_file_id)
 
607
            to_text = _get_text(self.new_tree, to_file_id)
715
608
            self.text_differ(from_label, from_text, to_label, to_text,
716
609
                             self.to_file)
717
610
        except errors.BinaryFile:
721
614
        return self.CHANGED
722
615
 
723
616
 
724
 
class DiffFromTool(DiffPath):
725
 
 
726
 
    def __init__(self, command_template, old_tree, new_tree, to_file,
727
 
                 path_encoding='utf-8'):
728
 
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
 
        self.command_template = command_template
730
 
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
731
 
 
732
 
    @classmethod
733
 
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
 
                    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'])
738
 
        return klass(command_template, old_tree, new_tree, to_file,
739
 
                     path_encoding)
740
 
 
741
 
    @classmethod
742
 
    def make_from_diff_tree(klass, command_string):
743
 
        def from_diff_tree(diff_tree):
744
 
            return klass.from_string(command_string, diff_tree.old_tree,
745
 
                                     diff_tree.new_tree, diff_tree.to_file)
746
 
        return from_diff_tree
747
 
 
748
 
    def _get_command(self, old_path, new_path):
749
 
        my_map = {'old_path': old_path, 'new_path': new_path}
750
 
        return [AtTemplate(t).substitute(my_map) for t in
751
 
                self.command_template]
752
 
 
753
 
    def _execute(self, old_path, new_path):
754
 
        command = self._get_command(old_path, new_path)
755
 
        try:
756
 
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
757
 
                                    cwd=self._root)
758
 
        except OSError, e:
759
 
            if e.errno == errno.ENOENT:
760
 
                raise errors.ExecutableMissing(command[0])
761
 
            else:
762
 
                raise
763
 
        self.to_file.write(proc.stdout.read())
764
 
        return proc.wait()
765
 
 
766
 
    def _try_symlink_root(self, tree, prefix):
767
 
        if (getattr(tree, 'abspath', None) is None
768
 
            or not osutils.host_os_dereferences_symlinks()):
769
 
            return False
770
 
        try:
771
 
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
772
 
        except OSError, e:
773
 
            if e.errno != errno.EEXIST:
774
 
                raise
775
 
        return True
776
 
 
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
 
        
782
 
        full_path = osutils.pathjoin(self._root, prefix, relpath)
783
 
        if not force_temp and self._try_symlink_root(tree, prefix):
784
 
            return full_path
785
 
        parent_dir = osutils.dirname(full_path)
786
 
        try:
787
 
            os.makedirs(parent_dir)
788
 
        except OSError, e:
789
 
            if e.errno != errno.EEXIST:
790
 
                raise
791
 
        source = tree.get_file(file_id, relpath)
792
 
        try:
793
 
            target = open(full_path, 'wb')
794
 
            try:
795
 
                osutils.pumpfile(source, target)
796
 
            finally:
797
 
                target.close()
798
 
        finally:
799
 
            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)
808
 
        return full_path
809
 
 
810
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
 
                       allow_write_new=False):
812
 
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
 
                                         old_path, force_temp)
814
 
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
 
                                         new_path, force_temp,
816
 
                                         allow_write=allow_write_new)
817
 
        return old_disk_path, new_disk_path
818
 
 
819
 
    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))
826
 
 
827
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
 
        if (old_kind, new_kind) != ('file', 'file'):
829
 
            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()
856
 
 
857
 
 
858
617
class DiffTree(object):
859
618
    """Provides textual representations of the difference between two trees.
860
619
 
900
659
    @classmethod
901
660
    def from_trees_options(klass, old_tree, new_tree, to_file,
902
661
                           path_encoding, external_diff_options, old_label,
903
 
                           new_label, using):
 
662
                           new_label):
904
663
        """Factory for producing a DiffTree.
905
664
 
906
665
        Designed to accept options used by show_diff_trees.
912
671
            binary to perform file comparison, using supplied options.
913
672
        :param old_label: Prefix to use for old file labels
914
673
        :param new_label: Prefix to use for new file labels
915
 
        :param using: Commandline to use to invoke an external diff tool
916
674
        """
917
 
        if using is not None:
918
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
919
 
        else:
920
 
            extra_factories = []
921
675
        if external_diff_options:
 
676
            assert isinstance(external_diff_options, basestring)
922
677
            opts = external_diff_options.split()
923
678
            def diff_file(olab, olines, nlab, nlines, to_file):
924
679
                external_diff(olab, olines, nlab, nlines, to_file, opts)
926
681
            diff_file = internal_diff
927
682
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
928
683
                             old_label, new_label, diff_file)
929
 
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
930
 
                     extra_factories)
 
684
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text)
931
685
 
932
686
    def show_diff(self, specific_files, extra_trees=None):
933
687
        """Write tree diff to self.to_file
934
688
 
935
 
        :param specific_files: the specific files to compare (recursive)
 
689
        :param sepecific_files: the specific files to compare (recursive)
936
690
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
691
        """
938
 
        try:
939
 
            return self._show_diff(specific_files, extra_trees)
940
 
        finally:
941
 
            for differ in self.differs:
942
 
                differ.finish()
943
 
 
944
 
    def _show_diff(self, specific_files, extra_trees):
945
692
        # TODO: Generation of pseudo-diffs for added/deleted files could
946
693
        # be usefully made into a much faster special case.
947
 
        iterator = self.new_tree.iter_changes(self.old_tree,
948
 
                                               specific_files=specific_files,
949
 
                                               extra_trees=extra_trees,
950
 
                                               require_versioned=True)
 
694
 
 
695
        delta = self.new_tree.changes_from(self.old_tree,
 
696
            specific_files=specific_files,
 
697
            extra_trees=extra_trees, require_versioned=True)
 
698
 
951
699
        has_changes = 0
952
 
        def changes_key(change):
953
 
            old_path, new_path = change[1]
954
 
            path = new_path
955
 
            if path is None:
956
 
                path = old_path
957
 
            return path
958
 
        def get_encoded_path(path):
959
 
            if path is not None:
960
 
                return path.encode(self.path_encoding, "replace")
961
 
        for (file_id, paths, changed_content, versioned, parent, name, kind,
962
 
             executable) in sorted(iterator, key=changes_key):
963
 
            # The root does not get diffed, and items with no known kind (that
964
 
            # is, missing) in both trees are skipped as well.
965
 
            if parent == (None, None) or kind == (None, None):
966
 
                continue
967
 
            oldpath, newpath = paths
968
 
            oldpath_encoded = get_encoded_path(paths[0])
969
 
            newpath_encoded = get_encoded_path(paths[1])
970
 
            old_present = (kind[0] is not None and versioned[0])
971
 
            new_present = (kind[1] is not None and versioned[1])
972
 
            renamed = (parent[0], name[0]) != (parent[1], name[1])
973
 
 
974
 
            properties_changed = []
975
 
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
976
 
 
977
 
            if properties_changed:
978
 
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
979
 
            else:
980
 
                prop_str = ""
981
 
 
982
 
            if (old_present, new_present) == (True, False):
983
 
                self.to_file.write("=== removed %s '%s'\n" %
984
 
                                   (kind[0], oldpath_encoded))
985
 
                newpath = oldpath
986
 
            elif (old_present, new_present) == (False, True):
987
 
                self.to_file.write("=== added %s '%s'\n" %
988
 
                                   (kind[1], newpath_encoded))
989
 
                oldpath = newpath
990
 
            elif renamed:
991
 
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
992
 
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
993
 
            else:
994
 
                # if it was produced by iter_changes, it must be
995
 
                # modified *somehow*, either content or execute bit.
996
 
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
 
                                   newpath_encoded, prop_str))
998
 
            if changed_content:
999
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1000
 
                has_changes = 1
1001
 
            if renamed:
1002
 
                has_changes = 1
 
700
        for path, file_id, kind in delta.removed:
 
701
            has_changes = 1
 
702
            path_encoded = path.encode(self.path_encoding, "replace")
 
703
            self.to_file.write("=== removed %s '%s'\n" % (kind, path_encoded))
 
704
            self.diff(file_id, path, path)
 
705
 
 
706
        for path, file_id, kind in delta.added:
 
707
            has_changes = 1
 
708
            path_encoded = path.encode(self.path_encoding, "replace")
 
709
            self.to_file.write("=== added %s '%s'\n" % (kind, path_encoded))
 
710
            self.diff(file_id, path, path)
 
711
        for (old_path, new_path, file_id, kind,
 
712
             text_modified, meta_modified) in delta.renamed:
 
713
            has_changes = 1
 
714
            prop_str = get_prop_change(meta_modified)
 
715
            oldpath_encoded = old_path.encode(self.path_encoding, "replace")
 
716
            newpath_encoded = new_path.encode(self.path_encoding, "replace")
 
717
            self.to_file.write("=== renamed %s '%s' => '%s'%s\n" % (kind,
 
718
                                oldpath_encoded, newpath_encoded, prop_str))
 
719
            if text_modified:
 
720
                self.diff(file_id, old_path, new_path)
 
721
        for path, file_id, kind, text_modified, meta_modified in\
 
722
            delta.modified:
 
723
            has_changes = 1
 
724
            prop_str = get_prop_change(meta_modified)
 
725
            path_encoded = path.encode(self.path_encoding, "replace")
 
726
            self.to_file.write("=== modified %s '%s'%s\n" % (kind,
 
727
                                path_encoded, prop_str))
 
728
            # The file may be in a different location in the old tree (because
 
729
            # the containing dir was renamed, but the file itself was not)
 
730
            if text_modified:
 
731
                old_path = self.old_tree.id2path(file_id)
 
732
                self.diff(file_id, old_path, path)
1003
733
        return has_changes
1004
734
 
1005
735
    def diff(self, file_id, old_path, new_path):
1011
741
        """
1012
742
        try:
1013
743
            old_kind = self.old_tree.kind(file_id)
1014
 
        except (errors.NoSuchId, errors.NoSuchFile):
 
744
        except errors.NoSuchId:
1015
745
            old_kind = None
1016
746
        try:
1017
747
            new_kind = self.new_tree.kind(file_id)
1018
 
        except (errors.NoSuchId, errors.NoSuchFile):
 
748
        except errors.NoSuchId:
1019
749
            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):
 
750
 
1024
751
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
752
                                       new_path, old_kind, new_kind)
1026
753
        if result is DiffPath.CANNOT_DIFF:
1028
755
            if error_path is None:
1029
756
                error_path = old_path
1030
757
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
format_registry.register('default', DiffTree)