/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Andrew Bennetts
  • Date: 2010-01-18 07:00:11 UTC
  • mto: (4973.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4975.
  • Revision ID: andrew.bennetts@canonical.com-20100118070011-zu374wvd0lcgai5a
Move news_merge plugin from contrib to bzrlib/plugins, change it to be enabled via a 'news_merge_files' config option, move more code out of the __init__ to minimise overhead, and add lots of docstrings, add NEWS entry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2014 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
14
14
# along with this program; if not, write to the Free Software
15
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
 
from __future__ import absolute_import
18
 
 
19
17
import difflib
20
18
import os
21
19
import re
 
20
import shutil
22
21
import string
23
22
import sys
24
23
 
25
 
from .lazy_import import lazy_import
 
24
from bzrlib.lazy_import import lazy_import
26
25
lazy_import(globals(), """
27
26
import errno
28
27
import subprocess
29
28
import tempfile
 
29
import time
30
30
 
31
 
from breezy import (
32
 
    cleanup,
33
 
    cmdline,
34
 
    controldir,
 
31
from bzrlib import (
 
32
    branch as _mod_branch,
 
33
    bzrdir,
 
34
    commands,
35
35
    errors,
36
36
    osutils,
37
37
    patiencediff,
40
40
    views,
41
41
    )
42
42
 
43
 
from breezy.workingtree import WorkingTree
44
 
from breezy.i18n import gettext
 
43
from bzrlib.workingtree import WorkingTree
45
44
""")
46
45
 
47
 
from .registry import (
48
 
    Registry,
 
46
from bzrlib.symbol_versioning import (
 
47
    deprecated_function,
49
48
    )
50
 
from .trace import mutter, note, warning
51
 
from .tree import FileTimestampUnavailable
52
 
 
53
 
 
54
 
DEFAULT_CONTEXT_AMOUNT = 3
 
49
from bzrlib.trace import mutter, note, warning
 
50
 
55
51
 
56
52
class AtTemplate(string.Template):
57
53
    """Templating class that uses @ instead of $."""
75
71
 
76
72
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
73
                  allow_binary=False, sequence_matcher=None,
78
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
74
                  path_encoding='utf8'):
79
75
    # FIXME: difflib is wrong if there is no trailing newline.
80
76
    # The syntax used by patch seems to be "\ No newline at
81
77
    # end of file" following the last diff line from that
86
82
    # In the meantime we at least make sure the patch isn't
87
83
    # mangled.
88
84
 
 
85
 
 
86
    # Special workaround for Python2.3, where difflib fails if
 
87
    # both sequences are empty.
 
88
    if not oldlines and not newlines:
 
89
        return
 
90
 
89
91
    if allow_binary is False:
90
92
        textfile.check_text_lines(oldlines)
91
93
        textfile.check_text_lines(newlines)
93
95
    if sequence_matcher is None:
94
96
        sequence_matcher = patiencediff.PatienceSequenceMatcher
95
97
    ud = patiencediff.unified_diff(oldlines, newlines,
96
 
                      fromfile=old_filename.encode(path_encoding, 'replace'),
97
 
                      tofile=new_filename.encode(path_encoding, 'replace'),
98
 
                      n=context_lines, sequencematcher=sequence_matcher)
 
98
                      fromfile=old_filename.encode(path_encoding),
 
99
                      tofile=new_filename.encode(path_encoding),
 
100
                      sequencematcher=sequence_matcher)
99
101
 
100
102
    ud = list(ud)
101
103
    if len(ud) == 0: # Identical contents, nothing to do
115
117
 
116
118
 
117
119
def _spawn_external_diff(diffcmd, capture_errors=True):
118
 
    """Spawn the external diff process, and return the child handle.
 
120
    """Spawn the externall diff process, and return the child handle.
119
121
 
120
122
    :param diffcmd: The command list to spawn
121
123
    :param capture_errors: Capture stderr as well as setting LANG=C
143
145
                                stdout=subprocess.PIPE,
144
146
                                stderr=stderr,
145
147
                                env=env)
146
 
    except OSError as e:
 
148
    except OSError, e:
147
149
        if e.errno == errno.ENOENT:
148
150
            raise errors.NoDiff(str(e))
149
151
        raise
150
152
 
151
153
    return pipe
152
154
 
153
 
# diff style options as of GNU diff v3.2
154
 
style_option_list = ['-c', '-C', '--context',
155
 
                     '-e', '--ed',
156
 
                     '-f', '--forward-ed',
157
 
                     '-q', '--brief',
158
 
                     '--normal',
159
 
                     '-n', '--rcs',
160
 
                     '-u', '-U', '--unified',
161
 
                     '-y', '--side-by-side',
162
 
                     '-D', '--ifdef']
163
 
 
164
 
def default_style_unified(diff_opts):
165
 
    """Default to unified diff style if alternative not specified in diff_opts.
166
 
 
167
 
        diff only allows one style to be specified; they don't override.
168
 
        Note that some of these take optargs, and the optargs can be
169
 
        directly appended to the options.
170
 
        This is only an approximate parser; it doesn't properly understand
171
 
        the grammar.
172
 
 
173
 
    :param diff_opts: List of options for external (GNU) diff.
174
 
    :return: List of options with default style=='unified'.
175
 
    """
176
 
    for s in style_option_list:
177
 
        for j in diff_opts:
178
 
            if j.startswith(s):
179
 
                break
180
 
        else:
181
 
            continue
182
 
        break
183
 
    else:
184
 
        diff_opts.append('-u')
185
 
    return diff_opts
186
 
 
187
155
 
188
156
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
189
157
                  diff_opts):
191
159
    # make sure our own output is properly ordered before the diff
192
160
    to_file.flush()
193
161
 
194
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
195
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
162
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
163
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
196
164
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
197
165
    newtmpf = os.fdopen(newtmp_fd, 'wb')
198
166
 
225
193
                   '--binary',
226
194
                  ]
227
195
 
228
 
        diff_opts = default_style_unified(diff_opts)
 
196
        # diff only allows one style to be specified; they don't override.
 
197
        # note that some of these take optargs, and the optargs can be
 
198
        # directly appended to the options.
 
199
        # this is only an approximate parser; it doesn't properly understand
 
200
        # the grammar.
 
201
        for s in ['-c', '-u', '-C', '-U',
 
202
                  '-e', '--ed',
 
203
                  '-q', '--brief',
 
204
                  '--normal',
 
205
                  '-n', '--rcs',
 
206
                  '-y', '--side-by-side',
 
207
                  '-D', '--ifdef']:
 
208
            for j in diff_opts:
 
209
                if j.startswith(s):
 
210
                    break
 
211
            else:
 
212
                continue
 
213
            break
 
214
        else:
 
215
            diffcmd.append('-u')
229
216
 
230
217
        if diff_opts:
231
218
            diffcmd.extend(diff_opts)
232
219
 
233
220
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
234
 
        out, err = pipe.communicate()
 
221
        out,err = pipe.communicate()
235
222
        rc = pipe.returncode
236
223
 
237
224
        # internal_diff() adds a trailing newline, add one here for consistency
276
263
                msg = 'exit code %d' % rc
277
264
 
278
265
            raise errors.BzrError('external diff failed with %s; command: %r'
279
 
                                  % (msg, diffcmd))
 
266
                                  % (rc, diffcmd))
280
267
 
281
268
 
282
269
    finally:
283
270
        oldtmpf.close()                 # and delete
284
271
        newtmpf.close()
285
 
 
286
 
        def cleanup(path):
287
 
            # Warn in case the file couldn't be deleted (in case windows still
288
 
            # holds the file open, but not if the files have already been
289
 
            # deleted)
290
 
            try:
291
 
                os.remove(path)
292
 
            except OSError as e:
293
 
                if e.errno not in (errno.ENOENT,):
294
 
                    warning('Failed to delete temporary file: %s %s', path, e)
295
 
 
296
 
        cleanup(old_abspath)
297
 
        cleanup(new_abspath)
298
 
 
299
 
 
300
 
def get_trees_and_branches_to_diff_locked(
301
 
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
 
272
        # Clean up. Warn in case the files couldn't be deleted
 
273
        # (in case windows still holds the file open, but not
 
274
        # if the files have already been deleted)
 
275
        try:
 
276
            os.remove(old_abspath)
 
277
        except OSError, e:
 
278
            if e.errno not in (errno.ENOENT,):
 
279
                warning('Failed to delete temporary file: %s %s',
 
280
                        old_abspath, e)
 
281
        try:
 
282
            os.remove(new_abspath)
 
283
        except OSError:
 
284
            if e.errno not in (errno.ENOENT,):
 
285
                warning('Failed to delete temporary file: %s %s',
 
286
                        new_abspath, e)
 
287
 
 
288
 
 
289
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
 
290
                                   apply_view=True):
302
291
    """Get the trees and specific files to diff given a list of paths.
303
292
 
304
293
    This method works out the trees to be diff'ed and the files of
315
304
    :param new_url:
316
305
        The url of the new branch or tree. If None, the tree to use is
317
306
        taken from the first path, if any, or the current working tree.
318
 
    :param add_cleanup:
319
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
320
 
        will register cleanups that must be run to unlock the trees, etc.
321
307
    :param apply_view:
322
308
        if True and a view is set, apply the view or check that the paths
323
309
        are within it
324
310
    :returns:
325
311
        a tuple of (old_tree, new_tree, old_branch, new_branch,
326
312
        specific_files, extra_trees) where extra_trees is a sequence of
327
 
        additional trees to search in for file-ids.  The trees and branches
328
 
        will be read-locked until the cleanups registered via the add_cleanup
329
 
        param are run.
 
313
        additional trees to search in for file-ids.
330
314
    """
331
315
    # Get the old and new revision specs
332
316
    old_revision_spec = None
355
339
        default_location = path_list[0]
356
340
        other_paths = path_list[1:]
357
341
 
358
 
    def lock_tree_or_branch(wt, br):
359
 
        if wt is not None:
360
 
            wt.lock_read()
361
 
            add_cleanup(wt.unlock)
362
 
        elif br is not None:
363
 
            br.lock_read()
364
 
            add_cleanup(br.unlock)
365
 
 
366
342
    # Get the old location
367
343
    specific_files = []
368
344
    if old_url is None:
369
345
        old_url = default_location
370
346
    working_tree, branch, relpath = \
371
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
372
 
    lock_tree_or_branch(working_tree, branch)
 
347
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
373
348
    if consider_relpath and relpath != '':
374
349
        if working_tree is not None and apply_view:
375
350
            views.check_path_in_view(working_tree, relpath)
382
357
        new_url = default_location
383
358
    if new_url != old_url:
384
359
        working_tree, branch, relpath = \
385
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
386
 
        lock_tree_or_branch(working_tree, branch)
 
360
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
387
361
        if consider_relpath and relpath != '':
388
362
            if working_tree is not None and apply_view:
389
363
                views.check_path_in_view(working_tree, relpath)
394
368
 
395
369
    # Get the specific files (all files is None, no files is [])
396
370
    if make_paths_wt_relative and working_tree is not None:
397
 
        other_paths = working_tree.safe_relpath_files(
398
 
            other_paths,
 
371
        try:
 
372
            from bzrlib.builtins import safe_relpath_files
 
373
            other_paths = safe_relpath_files(working_tree, other_paths,
399
374
            apply_view=apply_view)
 
375
        except errors.FileInWrongBranch:
 
376
            raise errors.BzrCommandError("Files are in different branches")
400
377
    specific_files.extend(other_paths)
401
378
    if len(specific_files) == 0:
402
379
        specific_files = None
406
383
            if view_files:
407
384
                specific_files = view_files
408
385
                view_str = views.view_display_str(view_files)
409
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
386
                note("*** Ignoring files outside view. View is %s" % view_str)
410
387
 
411
388
    # Get extra trees that ought to be searched for file-ids
412
389
    extra_trees = None
413
390
    if working_tree is not None and working_tree not in (old_tree, new_tree):
414
391
        extra_trees = (working_tree,)
415
 
    return (old_tree, new_tree, old_branch, new_branch,
416
 
            specific_files, extra_trees)
 
392
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
417
393
 
418
394
 
419
395
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
435
411
                    old_label='a/', new_label='b/',
436
412
                    extra_trees=None,
437
413
                    path_encoding='utf8',
438
 
                    using=None,
439
 
                    format_cls=None,
440
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
414
                    using=None):
441
415
    """Show in text form the changes from one tree to another.
442
416
 
443
 
    :param to_file: The output stream.
444
 
    :param specific_files: Include only changes to these files - None for all
445
 
        changes.
446
 
    :param external_diff_options: If set, use an external GNU diff and pass 
447
 
        these options.
448
 
    :param extra_trees: If set, more Trees to use for looking up file ids
449
 
    :param path_encoding: If set, the path will be encoded as specified, 
450
 
        otherwise is supposed to be utf8
451
 
    :param format_cls: Formatter class (DiffTree subclass)
 
417
    to_file
 
418
        The output stream.
 
419
 
 
420
    specific_files
 
421
        Include only changes to these files - None for all changes.
 
422
 
 
423
    external_diff_options
 
424
        If set, use an external GNU diff and pass these options.
 
425
 
 
426
    extra_trees
 
427
        If set, more Trees to use for looking up file ids
 
428
 
 
429
    path_encoding
 
430
        If set, the path will be encoded as specified, otherwise is supposed
 
431
        to be utf8
452
432
    """
453
 
    if context is None:
454
 
        context = DEFAULT_CONTEXT_AMOUNT
455
 
    if format_cls is None:
456
 
        format_cls = DiffTree
457
 
    with old_tree.lock_read():
 
433
    old_tree.lock_read()
 
434
    try:
458
435
        if extra_trees is not None:
459
436
            for tree in extra_trees:
460
437
                tree.lock_read()
461
438
        new_tree.lock_read()
462
439
        try:
463
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
464
 
                                                   path_encoding,
465
 
                                                   external_diff_options,
466
 
                                                   old_label, new_label, using,
467
 
                                                   context_lines=context)
 
440
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
441
                                                 path_encoding,
 
442
                                                 external_diff_options,
 
443
                                                 old_label, new_label, using)
468
444
            return differ.show_diff(specific_files, extra_trees)
469
445
        finally:
470
446
            new_tree.unlock()
471
447
            if extra_trees is not None:
472
448
                for tree in extra_trees:
473
449
                    tree.unlock()
 
450
    finally:
 
451
        old_tree.unlock()
474
452
 
475
453
 
476
454
def _patch_header_date(tree, file_id, path):
477
455
    """Returns a timestamp suitable for use in a patch header."""
478
 
    try:
479
 
        mtime = tree.get_file_mtime(path, file_id)
480
 
    except FileTimestampUnavailable:
481
 
        mtime = 0
 
456
    mtime = tree.get_file_mtime(file_id, path)
482
457
    return timestamp.format_patch_date(mtime)
483
458
 
484
459
 
596
571
        if 'symlink' not in (old_kind, new_kind):
597
572
            return self.CANNOT_DIFF
598
573
        if old_kind == 'symlink':
599
 
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
 
574
            old_target = self.old_tree.get_symlink_target(file_id)
600
575
        elif old_kind is None:
601
576
            old_target = None
602
577
        else:
603
578
            return self.CANNOT_DIFF
604
579
        if new_kind == 'symlink':
605
 
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
 
580
            new_target = self.new_tree.get_symlink_target(file_id)
606
581
        elif new_kind is None:
607
582
            new_target = None
608
583
        else:
626
601
    # or removed in a diff.
627
602
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
628
603
 
629
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8', 
630
 
                 old_label='', new_label='', text_differ=internal_diff, 
631
 
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
 
604
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
605
                 old_label='', new_label='', text_differ=internal_diff):
632
606
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
633
607
        self.text_differ = text_differ
634
608
        self.old_label = old_label
635
609
        self.new_label = new_label
636
610
        self.path_encoding = path_encoding
637
 
        self.context_lines = context_lines
638
611
 
639
612
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
640
613
        """Compare two files in unified diff format
664
637
            return self.CANNOT_DIFF
665
638
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
666
639
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
667
 
        return self.diff_text(old_path, new_path, from_label, to_label,
668
 
            from_file_id, to_file_id)
 
640
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
641
            old_path, new_path)
669
642
 
670
 
    def diff_text(self, from_path, to_path, from_label, to_label,
671
 
        from_file_id=None, to_file_id=None):
 
643
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
644
        from_path=None, to_path=None):
672
645
        """Diff the content of given files in two trees
673
646
 
674
 
        :param from_path: The path in the from tree. If None,
 
647
        :param from_file_id: The id of the file in the from tree.  If None,
675
648
            the file is not present in the from tree.
676
 
        :param to_path: The path in the to tree. This may refer
677
 
            to a different file from from_path.  If None,
 
649
        :param to_file_id: The id of the file in the to tree.  This may refer
 
650
            to a different file from from_file_id.  If None,
678
651
            the file is not present in the to tree.
679
 
        :param from_file_id: The id of the file in the from tree or None if
680
 
            unknown.
681
 
        :param to_file_id: The id of the file in the to tree or None if
682
 
            unknown.
 
652
        :param from_path: The path in the from tree or None if unknown.
 
653
        :param to_path: The path in the to tree or None if unknown.
683
654
        """
684
655
        def _get_text(tree, file_id, path):
685
 
            if file_id is None:
 
656
            if file_id is not None:
 
657
                return tree.get_file(file_id, path).readlines()
 
658
            else:
686
659
                return []
687
 
            return tree.get_file_lines(path, file_id)
688
660
        try:
689
661
            from_text = _get_text(self.old_tree, from_file_id, from_path)
690
662
            to_text = _get_text(self.new_tree, to_file_id, to_path)
691
663
            self.text_differ(from_label, from_text, to_label, to_text,
692
 
                             self.to_file, path_encoding=self.path_encoding,
693
 
                             context_lines=self.context_lines)
 
664
                             self.to_file)
694
665
        except errors.BinaryFile:
695
666
            self.to_file.write(
696
667
                  ("Binary files %s and %s differ\n" %
697
 
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
 
668
                  (from_label, to_label)).encode(self.path_encoding))
698
669
        return self.CHANGED
699
670
 
700
671
 
704
675
                 path_encoding='utf-8'):
705
676
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
706
677
        self.command_template = command_template
707
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
678
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
708
679
 
709
680
    @classmethod
710
681
    def from_string(klass, command_string, old_tree, new_tree, to_file,
711
682
                    path_encoding='utf-8'):
712
 
        command_template = cmdline.split(command_string)
 
683
        command_template = commands.shlex_split_unicode(command_string)
713
684
        if '@' not in command_string:
714
685
            command_template.extend(['@old_path', '@new_path'])
715
686
        return klass(command_template, old_tree, new_tree, to_file,
716
687
                     path_encoding)
717
688
 
718
689
    @classmethod
719
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
690
    def make_from_diff_tree(klass, command_string):
720
691
        def from_diff_tree(diff_tree):
721
 
            full_command_string = [command_string]
722
 
            if external_diff_options is not None:
723
 
                full_command_string += ' ' + external_diff_options
724
 
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
692
            return klass.from_string(command_string, diff_tree.old_tree,
725
693
                                     diff_tree.new_tree, diff_tree.to_file)
726
694
        return from_diff_tree
727
695
 
728
696
    def _get_command(self, old_path, new_path):
729
697
        my_map = {'old_path': old_path, 'new_path': new_path}
730
 
        command = [AtTemplate(t).substitute(my_map) for t in
731
 
                   self.command_template]
732
 
        if sys.platform == 'win32': # Popen doesn't accept unicode on win32
733
 
            command_encoded = []
734
 
            for c in command:
735
 
                if isinstance(c, text_type):
736
 
                    command_encoded.append(c.encode('mbcs'))
737
 
                else:
738
 
                    command_encoded.append(c)
739
 
            return command_encoded
740
 
        else:
741
 
            return command
 
698
        return [AtTemplate(t).substitute(my_map) for t in
 
699
                self.command_template]
742
700
 
743
701
    def _execute(self, old_path, new_path):
744
702
        command = self._get_command(old_path, new_path)
745
703
        try:
746
704
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
747
705
                                    cwd=self._root)
748
 
        except OSError as e:
 
706
        except OSError, e:
749
707
            if e.errno == errno.ENOENT:
750
708
                raise errors.ExecutableMissing(command[0])
751
709
            else:
759
717
            return False
760
718
        try:
761
719
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
762
 
        except OSError as e:
 
720
        except OSError, e:
763
721
            if e.errno != errno.EEXIST:
764
722
                raise
765
723
        return True
766
724
 
767
 
    @staticmethod
768
 
    def _fenc():
769
 
        """Returns safe encoding for passing file path to diff tool"""
770
 
        if sys.platform == 'win32':
771
 
            return 'mbcs'
772
 
        else:
773
 
            # Don't fallback to 'utf-8' because subprocess may not be able to
774
 
            # handle utf-8 correctly when locale is not utf-8.
775
 
            return sys.getfilesystemencoding() or 'ascii'
776
 
 
777
 
    def _is_safepath(self, path):
778
 
        """Return true if `path` may be able to pass to subprocess."""
779
 
        fenc = self._fenc()
780
 
        try:
781
 
            return path == path.encode(fenc).decode(fenc)
782
 
        except UnicodeError:
783
 
            return False
784
 
 
785
 
    def _safe_filename(self, prefix, relpath):
786
 
        """Replace unsafe character in `relpath` then join `self._root`,
787
 
        `prefix` and `relpath`."""
788
 
        fenc = self._fenc()
789
 
        # encoded_str.replace('?', '_') may break multibyte char.
790
 
        # So we should encode, decode, then replace(u'?', u'_')
791
 
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
792
 
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
793
 
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
794
 
 
795
 
    def _write_file(self, relpath, tree, prefix, force_temp=False,
796
 
                    allow_write=False, file_id=None):
 
725
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
 
726
                    allow_write=False):
797
727
        if not force_temp and isinstance(tree, WorkingTree):
798
 
            full_path = tree.abspath(relpath)
799
 
            if self._is_safepath(full_path):
800
 
                return full_path
801
 
 
802
 
        full_path = self._safe_filename(prefix, relpath)
 
728
            return tree.abspath(tree.id2path(file_id))
 
729
        
 
730
        full_path = osutils.pathjoin(self._root, prefix, relpath)
803
731
        if not force_temp and self._try_symlink_root(tree, prefix):
804
732
            return full_path
805
733
        parent_dir = osutils.dirname(full_path)
806
734
        try:
807
735
            os.makedirs(parent_dir)
808
 
        except OSError as e:
 
736
        except OSError, e:
809
737
            if e.errno != errno.EEXIST:
810
738
                raise
811
 
        source = tree.get_file(relpath, file_id)
 
739
        source = tree.get_file(file_id, relpath)
812
740
        try:
813
 
            with open(full_path, 'wb') as target:
 
741
            target = open(full_path, 'wb')
 
742
            try:
814
743
                osutils.pumpfile(source, target)
 
744
            finally:
 
745
                target.close()
815
746
        finally:
816
747
            source.close()
817
 
        try:
818
 
            mtime = tree.get_file_mtime(relpath, file_id)
819
 
        except FileTimestampUnavailable:
820
 
            pass
821
 
        else:
822
 
            os.utime(full_path, (mtime, mtime))
823
748
        if not allow_write:
824
749
            osutils.make_readonly(full_path)
 
750
        mtime = tree.get_file_mtime(file_id)
 
751
        os.utime(full_path, (mtime, mtime))
825
752
        return full_path
826
753
 
827
 
    def _prepare_files(self, old_path, new_path, force_temp=False,
828
 
                       allow_write_new=False, file_id=None):
829
 
        old_disk_path = self._write_file(old_path, self.old_tree, 'old',
830
 
                                         force_temp, file_id=file_id)
831
 
        new_disk_path = self._write_file(new_path, self.new_tree, 'new',
832
 
                                         force_temp, file_id=file_id,
 
754
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
 
755
                       allow_write_new=False):
 
756
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
757
                                         old_path, force_temp)
 
758
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
759
                                         new_path, force_temp,
833
760
                                         allow_write=allow_write_new)
834
761
        return old_disk_path, new_disk_path
835
762
 
836
763
    def finish(self):
837
764
        try:
838
765
            osutils.rmtree(self._root)
839
 
        except OSError as e:
 
766
        except OSError, e:
840
767
            if e.errno != errno.ENOENT:
841
768
                mutter("The temporary directory \"%s\" was not "
842
769
                        "cleanly removed: %s." % (self._root, e))
845
772
        if (old_kind, new_kind) != ('file', 'file'):
846
773
            return DiffPath.CANNOT_DIFF
847
774
        (old_disk_path, new_disk_path) = self._prepare_files(
848
 
                old_path, new_path, file_id=file_id)
 
775
                                                file_id, old_path, new_path)
849
776
        self._execute(old_disk_path, new_disk_path)
850
777
 
851
 
    def edit_file(self, old_path, new_path, file_id=None):
 
778
    def edit_file(self, file_id):
852
779
        """Use this tool to edit a file.
853
780
 
854
781
        A temporary copy will be edited, and the new contents will be
857
784
        :param file_id: The id of the file to edit.
858
785
        :return: The new contents of the file.
859
786
        """
860
 
        old_abs_path, new_abs_path = self._prepare_files(
861
 
                old_path, new_path, allow_write_new=True, force_temp=True,
862
 
                file_id=file_id)
863
 
        command = self._get_command(old_abs_path, new_abs_path)
 
787
        old_path = self.old_tree.id2path(file_id)
 
788
        new_path = self.new_tree.id2path(file_id)
 
789
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
 
790
                                           allow_write_new=True,
 
791
                                           force_temp=True)[1]
 
792
        command = self._get_command(osutils.pathjoin('old', old_path),
 
793
                                    osutils.pathjoin('new', new_path))
864
794
        subprocess.call(command, cwd=self._root)
865
 
        with open(new_abs_path, 'rb') as new_file:
 
795
        new_file = open(new_abs_path, 'r')
 
796
        try:
866
797
            return new_file.read()
 
798
        finally:
 
799
            new_file.close()
867
800
 
868
801
 
869
802
class DiffTree(object):
911
844
    @classmethod
912
845
    def from_trees_options(klass, old_tree, new_tree, to_file,
913
846
                           path_encoding, external_diff_options, old_label,
914
 
                           new_label, using, context_lines):
 
847
                           new_label, using):
915
848
        """Factory for producing a DiffTree.
916
849
 
917
850
        Designed to accept options used by show_diff_trees.
918
 
 
919
851
        :param old_tree: The tree to show as old in the comparison
920
852
        :param new_tree: The tree to show as new in the comparison
921
853
        :param to_file: File to write comparisons to
927
859
        :param using: Commandline to use to invoke an external diff tool
928
860
        """
929
861
        if using is not None:
930
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
862
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
931
863
        else:
932
864
            extra_factories = []
933
865
        if external_diff_options:
934
866
            opts = external_diff_options.split()
935
 
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
936
 
                """:param path_encoding: not used but required
937
 
                        to match the signature of internal_diff.
938
 
                """
 
867
            def diff_file(olab, olines, nlab, nlines, to_file):
939
868
                external_diff(olab, olines, nlab, nlines, to_file, opts)
940
869
        else:
941
870
            diff_file = internal_diff
942
871
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
943
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
872
                             old_label, new_label, diff_file)
944
873
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
945
874
                     extra_factories)
946
875
 
947
876
    def show_diff(self, specific_files, extra_trees=None):
948
877
        """Write tree diff to self.to_file
949
878
 
950
 
        :param specific_files: the specific files to compare (recursive)
 
879
        :param sepecific_files: the specific files to compare (recursive)
951
880
        :param extra_trees: extra trees to use for mapping paths to file_ids
952
881
        """
953
882
        try:
990
919
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
991
920
 
992
921
            if properties_changed:
993
 
                prop_str = b" (properties changed: %s)" % (
994
 
                        b", ".join(properties_changed),)
 
922
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
995
923
            else:
996
 
                prop_str = b""
 
924
                prop_str = ""
997
925
 
998
926
            if (old_present, new_present) == (True, False):
999
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1000
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
927
                self.to_file.write("=== removed %s '%s'\n" %
 
928
                                   (kind[0], oldpath_encoded))
1001
929
                newpath = oldpath
1002
930
            elif (old_present, new_present) == (False, True):
1003
 
                self.to_file.write(b"=== added %s '%s'\n" %
1004
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
931
                self.to_file.write("=== added %s '%s'\n" %
 
932
                                   (kind[1], newpath_encoded))
1005
933
                oldpath = newpath
1006
934
            elif renamed:
1007
 
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
1008
 
                    (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
 
935
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
936
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1009
937
            else:
1010
938
                # if it was produced by iter_changes, it must be
1011
939
                # modified *somehow*, either content or execute bit.
1012
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
940
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1013
941
                                   newpath_encoded, prop_str))
1014
942
            if changed_content:
1015
 
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
 
943
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1016
944
                has_changes = 1
1017
945
            if renamed:
1018
946
                has_changes = 1
1025
953
        :param old_path: The path of the file in the old tree
1026
954
        :param new_path: The path of the file in the new tree
1027
955
        """
1028
 
        if old_path is None:
 
956
        try:
 
957
            old_kind = self.old_tree.kind(file_id)
 
958
        except (errors.NoSuchId, errors.NoSuchFile):
1029
959
            old_kind = None
1030
 
        else:
1031
 
            old_kind = self.old_tree.kind(old_path, file_id)
1032
 
        if new_path is None:
 
960
        try:
 
961
            new_kind = self.new_tree.kind(file_id)
 
962
        except (errors.NoSuchId, errors.NoSuchFile):
1033
963
            new_kind = None
1034
 
        else:
1035
 
            new_kind = self.new_tree.kind(new_path, file_id)
1036
 
        self._diff(old_path, new_path, old_kind, new_kind, file_id=file_id)
1037
 
 
1038
 
    def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
 
964
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
965
 
 
966
 
 
967
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1039
968
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1040
969
                                       new_path, old_kind, new_kind)
1041
970
        if result is DiffPath.CANNOT_DIFF:
1043
972
            if error_path is None:
1044
973
                error_path = old_path
1045
974
            raise errors.NoDiffFound(error_path)
1046
 
 
1047
 
 
1048
 
format_registry = Registry()
1049
 
format_registry.register('default', DiffTree)