/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: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2014 Canonical Ltd.
 
1
# Copyright (C) 2005-2010 Canonical Ltd.
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
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
22
20
import string
23
21
import sys
24
22
 
25
 
from .lazy_import import lazy_import
 
23
from bzrlib.lazy_import import lazy_import
26
24
lazy_import(globals(), """
27
25
import errno
28
26
import subprocess
29
27
import tempfile
 
28
import time
30
29
 
31
 
from breezy import (
 
30
from bzrlib import (
 
31
    branch as _mod_branch,
 
32
    bzrdir,
 
33
    cmdline,
32
34
    cleanup,
33
 
    cmdline,
34
 
    controldir,
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 (
 
46
from bzrlib.registry import (
48
47
    Registry,
49
48
    )
50
 
from .trace import mutter, note, warning
51
 
from .tree import FileTimestampUnavailable
52
 
 
53
 
 
54
 
DEFAULT_CONTEXT_AMOUNT = 3
 
49
from bzrlib.symbol_versioning import (
 
50
    deprecated_function,
 
51
    deprecated_in,
 
52
    )
 
53
from bzrlib.trace import mutter, note, warning
 
54
 
55
55
 
56
56
class AtTemplate(string.Template):
57
57
    """Templating class that uses @ instead of $."""
75
75
 
76
76
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
77
                  allow_binary=False, sequence_matcher=None,
78
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
78
                  path_encoding='utf8'):
79
79
    # FIXME: difflib is wrong if there is no trailing newline.
80
80
    # The syntax used by patch seems to be "\ No newline at
81
81
    # end of file" following the last diff line from that
86
86
    # In the meantime we at least make sure the patch isn't
87
87
    # mangled.
88
88
 
 
89
 
 
90
    # Special workaround for Python2.3, where difflib fails if
 
91
    # both sequences are empty.
 
92
    if not oldlines and not newlines:
 
93
        return
 
94
 
89
95
    if allow_binary is False:
90
96
        textfile.check_text_lines(oldlines)
91
97
        textfile.check_text_lines(newlines)
93
99
    if sequence_matcher is None:
94
100
        sequence_matcher = patiencediff.PatienceSequenceMatcher
95
101
    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)
 
102
                      fromfile=old_filename.encode(path_encoding),
 
103
                      tofile=new_filename.encode(path_encoding),
 
104
                      sequencematcher=sequence_matcher)
99
105
 
100
106
    ud = list(ud)
101
107
    if len(ud) == 0: # Identical contents, nothing to do
115
121
 
116
122
 
117
123
def _spawn_external_diff(diffcmd, capture_errors=True):
118
 
    """Spawn the external diff process, and return the child handle.
 
124
    """Spawn the externall diff process, and return the child handle.
119
125
 
120
126
    :param diffcmd: The command list to spawn
121
127
    :param capture_errors: Capture stderr as well as setting LANG=C
143
149
                                stdout=subprocess.PIPE,
144
150
                                stderr=stderr,
145
151
                                env=env)
146
 
    except OSError as e:
 
152
    except OSError, e:
147
153
        if e.errno == errno.ENOENT:
148
154
            raise errors.NoDiff(str(e))
149
155
        raise
150
156
 
151
157
    return pipe
152
158
 
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
159
 
188
160
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
189
161
                  diff_opts):
191
163
    # make sure our own output is properly ordered before the diff
192
164
    to_file.flush()
193
165
 
194
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
195
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
166
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
167
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
196
168
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
197
169
    newtmpf = os.fdopen(newtmp_fd, 'wb')
198
170
 
225
197
                   '--binary',
226
198
                  ]
227
199
 
228
 
        diff_opts = default_style_unified(diff_opts)
 
200
        # diff only allows one style to be specified; they don't override.
 
201
        # note that some of these take optargs, and the optargs can be
 
202
        # directly appended to the options.
 
203
        # this is only an approximate parser; it doesn't properly understand
 
204
        # the grammar.
 
205
        for s in ['-c', '-u', '-C', '-U',
 
206
                  '-e', '--ed',
 
207
                  '-q', '--brief',
 
208
                  '--normal',
 
209
                  '-n', '--rcs',
 
210
                  '-y', '--side-by-side',
 
211
                  '-D', '--ifdef']:
 
212
            for j in diff_opts:
 
213
                if j.startswith(s):
 
214
                    break
 
215
            else:
 
216
                continue
 
217
            break
 
218
        else:
 
219
            diffcmd.append('-u')
229
220
 
230
221
        if diff_opts:
231
222
            diffcmd.extend(diff_opts)
232
223
 
233
224
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
234
 
        out, err = pipe.communicate()
 
225
        out,err = pipe.communicate()
235
226
        rc = pipe.returncode
236
227
 
237
228
        # internal_diff() adds a trailing newline, add one here for consistency
276
267
                msg = 'exit code %d' % rc
277
268
 
278
269
            raise errors.BzrError('external diff failed with %s; command: %r'
279
 
                                  % (msg, diffcmd))
 
270
                                  % (rc, diffcmd))
280
271
 
281
272
 
282
273
    finally:
283
274
        oldtmpf.close()                 # and delete
284
275
        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
 
 
 
276
        # Clean up. Warn in case the files couldn't be deleted
 
277
        # (in case windows still holds the file open, but not
 
278
        # if the files have already been deleted)
 
279
        try:
 
280
            os.remove(old_abspath)
 
281
        except OSError, e:
 
282
            if e.errno not in (errno.ENOENT,):
 
283
                warning('Failed to delete temporary file: %s %s',
 
284
                        old_abspath, e)
 
285
        try:
 
286
            os.remove(new_abspath)
 
287
        except OSError:
 
288
            if e.errno not in (errno.ENOENT,):
 
289
                warning('Failed to delete temporary file: %s %s',
 
290
                        new_abspath, e)
 
291
 
 
292
 
 
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
    
299
325
 
300
326
def get_trees_and_branches_to_diff_locked(
301
327
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
368
394
    if old_url is None:
369
395
        old_url = default_location
370
396
    working_tree, branch, relpath = \
371
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
 
397
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
372
398
    lock_tree_or_branch(working_tree, branch)
373
399
    if consider_relpath and relpath != '':
374
400
        if working_tree is not None and apply_view:
382
408
        new_url = default_location
383
409
    if new_url != old_url:
384
410
        working_tree, branch, relpath = \
385
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
 
411
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
386
412
        lock_tree_or_branch(working_tree, branch)
387
413
        if consider_relpath and relpath != '':
388
414
            if working_tree is not None and apply_view:
394
420
 
395
421
    # Get the specific files (all files is None, no files is [])
396
422
    if make_paths_wt_relative and working_tree is not None:
397
 
        other_paths = working_tree.safe_relpath_files(
398
 
            other_paths,
 
423
        try:
 
424
            from bzrlib.builtins import safe_relpath_files
 
425
            other_paths = safe_relpath_files(working_tree, other_paths,
399
426
            apply_view=apply_view)
 
427
        except errors.FileInWrongBranch:
 
428
            raise errors.BzrCommandError("Files are in different branches")
400
429
    specific_files.extend(other_paths)
401
430
    if len(specific_files) == 0:
402
431
        specific_files = None
406
435
            if view_files:
407
436
                specific_files = view_files
408
437
                view_str = views.view_display_str(view_files)
409
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
438
                note("*** Ignoring files outside view. View is %s" % view_str)
410
439
 
411
440
    # Get extra trees that ought to be searched for file-ids
412
441
    extra_trees = None
413
442
    if working_tree is not None and working_tree not in (old_tree, new_tree):
414
443
        extra_trees = (working_tree,)
415
 
    return (old_tree, new_tree, old_branch, new_branch,
416
 
            specific_files, extra_trees)
 
444
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
417
445
 
418
446
 
419
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
436
464
                    extra_trees=None,
437
465
                    path_encoding='utf8',
438
466
                    using=None,
439
 
                    format_cls=None,
440
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
467
                    format_cls=None):
441
468
    """Show in text form the changes from one tree to another.
442
469
 
443
470
    :param to_file: The output stream.
444
 
    :param specific_files: Include only changes to these files - None for all
 
471
    :param specific_files:Include only changes to these files - None for all
445
472
        changes.
446
473
    :param external_diff_options: If set, use an external GNU diff and pass 
447
474
        these options.
450
477
        otherwise is supposed to be utf8
451
478
    :param format_cls: Formatter class (DiffTree subclass)
452
479
    """
453
 
    if context is None:
454
 
        context = DEFAULT_CONTEXT_AMOUNT
455
480
    if format_cls is None:
456
481
        format_cls = DiffTree
457
 
    with old_tree.lock_read():
 
482
    old_tree.lock_read()
 
483
    try:
458
484
        if extra_trees is not None:
459
485
            for tree in extra_trees:
460
486
                tree.lock_read()
463
489
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
464
490
                                                   path_encoding,
465
491
                                                   external_diff_options,
466
 
                                                   old_label, new_label, using,
467
 
                                                   context_lines=context)
 
492
                                                   old_label, new_label, using)
468
493
            return differ.show_diff(specific_files, extra_trees)
469
494
        finally:
470
495
            new_tree.unlock()
471
496
            if extra_trees is not None:
472
497
                for tree in extra_trees:
473
498
                    tree.unlock()
 
499
    finally:
 
500
        old_tree.unlock()
474
501
 
475
502
 
476
503
def _patch_header_date(tree, file_id, path):
477
504
    """Returns a timestamp suitable for use in a patch header."""
478
505
    try:
479
 
        mtime = tree.get_file_mtime(path, file_id)
480
 
    except FileTimestampUnavailable:
 
506
        mtime = tree.get_file_mtime(file_id, path)
 
507
    except errors.FileTimestampUnavailable:
481
508
        mtime = 0
482
509
    return timestamp.format_patch_date(mtime)
483
510
 
596
623
        if 'symlink' not in (old_kind, new_kind):
597
624
            return self.CANNOT_DIFF
598
625
        if old_kind == 'symlink':
599
 
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
 
626
            old_target = self.old_tree.get_symlink_target(file_id)
600
627
        elif old_kind is None:
601
628
            old_target = None
602
629
        else:
603
630
            return self.CANNOT_DIFF
604
631
        if new_kind == 'symlink':
605
 
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
 
632
            new_target = self.new_tree.get_symlink_target(file_id)
606
633
        elif new_kind is None:
607
634
            new_target = None
608
635
        else:
626
653
    # or removed in a diff.
627
654
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
628
655
 
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):
 
656
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
657
                 old_label='', new_label='', text_differ=internal_diff):
632
658
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
633
659
        self.text_differ = text_differ
634
660
        self.old_label = old_label
635
661
        self.new_label = new_label
636
662
        self.path_encoding = path_encoding
637
 
        self.context_lines = context_lines
638
663
 
639
664
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
640
665
        """Compare two files in unified diff format
664
689
            return self.CANNOT_DIFF
665
690
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
666
691
        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)
 
692
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
693
            old_path, new_path)
669
694
 
670
 
    def diff_text(self, from_path, to_path, from_label, to_label,
671
 
        from_file_id=None, to_file_id=None):
 
695
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
696
        from_path=None, to_path=None):
672
697
        """Diff the content of given files in two trees
673
698
 
674
 
        :param from_path: The path in the from tree. If None,
 
699
        :param from_file_id: The id of the file in the from tree.  If None,
675
700
            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,
 
701
        :param to_file_id: The id of the file in the to tree.  This may refer
 
702
            to a different file from from_file_id.  If None,
678
703
            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.
 
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.
683
706
        """
684
707
        def _get_text(tree, file_id, path):
685
 
            if file_id is None:
 
708
            if file_id is not None:
 
709
                return tree.get_file(file_id, path).readlines()
 
710
            else:
686
711
                return []
687
 
            return tree.get_file_lines(path, file_id)
688
712
        try:
689
713
            from_text = _get_text(self.old_tree, from_file_id, from_path)
690
714
            to_text = _get_text(self.new_tree, to_file_id, to_path)
691
715
            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)
 
716
                             self.to_file)
694
717
        except errors.BinaryFile:
695
718
            self.to_file.write(
696
719
                  ("Binary files %s and %s differ\n" %
697
 
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
 
720
                  (from_label, to_label)).encode(self.path_encoding))
698
721
        return self.CHANGED
699
722
 
700
723
 
704
727
                 path_encoding='utf-8'):
705
728
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
706
729
        self.command_template = command_template
707
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
730
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
708
731
 
709
732
    @classmethod
710
733
    def from_string(klass, command_string, old_tree, new_tree, to_file,
716
739
                     path_encoding)
717
740
 
718
741
    @classmethod
719
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
742
    def make_from_diff_tree(klass, command_string):
720
743
        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,
 
744
            return klass.from_string(command_string, diff_tree.old_tree,
725
745
                                     diff_tree.new_tree, diff_tree.to_file)
726
746
        return from_diff_tree
727
747
 
728
748
    def _get_command(self, old_path, new_path):
729
749
        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
 
750
        return [AtTemplate(t).substitute(my_map) for t in
 
751
                self.command_template]
742
752
 
743
753
    def _execute(self, old_path, new_path):
744
754
        command = self._get_command(old_path, new_path)
745
755
        try:
746
756
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
747
757
                                    cwd=self._root)
748
 
        except OSError as e:
 
758
        except OSError, e:
749
759
            if e.errno == errno.ENOENT:
750
760
                raise errors.ExecutableMissing(command[0])
751
761
            else:
759
769
            return False
760
770
        try:
761
771
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
762
 
        except OSError as e:
 
772
        except OSError, e:
763
773
            if e.errno != errno.EEXIST:
764
774
                raise
765
775
        return True
766
776
 
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):
 
777
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
 
778
                    allow_write=False):
797
779
        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)
 
780
            return tree.abspath(tree.id2path(file_id))
 
781
        
 
782
        full_path = osutils.pathjoin(self._root, prefix, relpath)
803
783
        if not force_temp and self._try_symlink_root(tree, prefix):
804
784
            return full_path
805
785
        parent_dir = osutils.dirname(full_path)
806
786
        try:
807
787
            os.makedirs(parent_dir)
808
 
        except OSError as e:
 
788
        except OSError, e:
809
789
            if e.errno != errno.EEXIST:
810
790
                raise
811
 
        source = tree.get_file(relpath, file_id)
 
791
        source = tree.get_file(file_id, relpath)
812
792
        try:
813
 
            with open(full_path, 'wb') as target:
 
793
            target = open(full_path, 'wb')
 
794
            try:
814
795
                osutils.pumpfile(source, target)
 
796
            finally:
 
797
                target.close()
815
798
        finally:
816
799
            source.close()
817
800
        try:
818
 
            mtime = tree.get_file_mtime(relpath, file_id)
819
 
        except FileTimestampUnavailable:
 
801
            mtime = tree.get_file_mtime(file_id)
 
802
        except errors.FileTimestampUnavailable:
820
803
            pass
821
804
        else:
822
805
            os.utime(full_path, (mtime, mtime))
824
807
            osutils.make_readonly(full_path)
825
808
        return full_path
826
809
 
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,
 
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,
833
816
                                         allow_write=allow_write_new)
834
817
        return old_disk_path, new_disk_path
835
818
 
836
819
    def finish(self):
837
820
        try:
838
821
            osutils.rmtree(self._root)
839
 
        except OSError as e:
 
822
        except OSError, e:
840
823
            if e.errno != errno.ENOENT:
841
824
                mutter("The temporary directory \"%s\" was not "
842
825
                        "cleanly removed: %s." % (self._root, e))
845
828
        if (old_kind, new_kind) != ('file', 'file'):
846
829
            return DiffPath.CANNOT_DIFF
847
830
        (old_disk_path, new_disk_path) = self._prepare_files(
848
 
                old_path, new_path, file_id=file_id)
 
831
                                                file_id, old_path, new_path)
849
832
        self._execute(old_disk_path, new_disk_path)
850
833
 
851
 
    def edit_file(self, old_path, new_path, file_id=None):
 
834
    def edit_file(self, file_id):
852
835
        """Use this tool to edit a file.
853
836
 
854
837
        A temporary copy will be edited, and the new contents will be
857
840
        :param file_id: The id of the file to edit.
858
841
        :return: The new contents of the file.
859
842
        """
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)
 
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))
864
850
        subprocess.call(command, cwd=self._root)
865
 
        with open(new_abs_path, 'rb') as new_file:
 
851
        new_file = open(new_abs_path, 'r')
 
852
        try:
866
853
            return new_file.read()
 
854
        finally:
 
855
            new_file.close()
867
856
 
868
857
 
869
858
class DiffTree(object):
911
900
    @classmethod
912
901
    def from_trees_options(klass, old_tree, new_tree, to_file,
913
902
                           path_encoding, external_diff_options, old_label,
914
 
                           new_label, using, context_lines):
 
903
                           new_label, using):
915
904
        """Factory for producing a DiffTree.
916
905
 
917
906
        Designed to accept options used by show_diff_trees.
918
 
 
919
907
        :param old_tree: The tree to show as old in the comparison
920
908
        :param new_tree: The tree to show as new in the comparison
921
909
        :param to_file: File to write comparisons to
927
915
        :param using: Commandline to use to invoke an external diff tool
928
916
        """
929
917
        if using is not None:
930
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
918
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
931
919
        else:
932
920
            extra_factories = []
933
921
        if external_diff_options:
934
922
            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
 
                """
 
923
            def diff_file(olab, olines, nlab, nlines, to_file):
939
924
                external_diff(olab, olines, nlab, nlines, to_file, opts)
940
925
        else:
941
926
            diff_file = internal_diff
942
927
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
943
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
928
                             old_label, new_label, diff_file)
944
929
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
945
930
                     extra_factories)
946
931
 
990
975
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
991
976
 
992
977
            if properties_changed:
993
 
                prop_str = b" (properties changed: %s)" % (
994
 
                        b", ".join(properties_changed),)
 
978
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
995
979
            else:
996
 
                prop_str = b""
 
980
                prop_str = ""
997
981
 
998
982
            if (old_present, new_present) == (True, False):
999
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1000
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
983
                self.to_file.write("=== removed %s '%s'\n" %
 
984
                                   (kind[0], oldpath_encoded))
1001
985
                newpath = oldpath
1002
986
            elif (old_present, new_present) == (False, True):
1003
 
                self.to_file.write(b"=== added %s '%s'\n" %
1004
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
987
                self.to_file.write("=== added %s '%s'\n" %
 
988
                                   (kind[1], newpath_encoded))
1005
989
                oldpath = newpath
1006
990
            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))
 
991
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
992
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1009
993
            else:
1010
994
                # if it was produced by iter_changes, it must be
1011
995
                # modified *somehow*, either content or execute bit.
1012
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
996
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1013
997
                                   newpath_encoded, prop_str))
1014
998
            if changed_content:
1015
 
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
 
999
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1016
1000
                has_changes = 1
1017
1001
            if renamed:
1018
1002
                has_changes = 1
1025
1009
        :param old_path: The path of the file in the old tree
1026
1010
        :param new_path: The path of the file in the new tree
1027
1011
        """
1028
 
        if old_path is None:
 
1012
        try:
 
1013
            old_kind = self.old_tree.kind(file_id)
 
1014
        except (errors.NoSuchId, errors.NoSuchFile):
1029
1015
            old_kind = None
1030
 
        else:
1031
 
            old_kind = self.old_tree.kind(old_path, file_id)
1032
 
        if new_path is None:
 
1016
        try:
 
1017
            new_kind = self.new_tree.kind(file_id)
 
1018
        except (errors.NoSuchId, errors.NoSuchFile):
1033
1019
            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):
 
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):
1039
1024
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1040
1025
                                       new_path, old_kind, new_kind)
1041
1026
        if result is DiffPath.CANNOT_DIFF: