/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: 2009-10-21 11:13:40 UTC
  • mto: This revision was merged to the branch mainline in revision 4762.
  • Revision ID: andrew.bennetts@canonical.com-20091021111340-w7x4d5yf83qwjncc
Add test that WSGI glue allows request handlers to access paths above that request's. backing transport, so long as it is within the WSGI app's backing transport.

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
22
 
import string
 
20
import shutil
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 (
32
 
    cleanup,
33
 
    cmdline,
34
 
    controldir,
 
30
from bzrlib import (
 
31
    branch as _mod_branch,
 
32
    bzrdir,
 
33
    commands,
35
34
    errors,
36
35
    osutils,
37
36
    patiencediff,
39
38
    timestamp,
40
39
    views,
41
40
    )
42
 
 
43
 
from breezy.workingtree import WorkingTree
44
 
from breezy.i18n import gettext
45
41
""")
46
42
 
47
 
from .registry import (
48
 
    Registry,
 
43
from bzrlib.symbol_versioning import (
 
44
    deprecated_function,
49
45
    )
50
 
from .trace import mutter, note, warning
51
 
from .tree import FileTimestampUnavailable
52
 
 
53
 
 
54
 
DEFAULT_CONTEXT_AMOUNT = 3
55
 
 
56
 
class AtTemplate(string.Template):
57
 
    """Templating class that uses @ instead of $."""
58
 
 
59
 
    delimiter = '@'
 
46
from bzrlib.trace import mutter, note, warning
60
47
 
61
48
 
62
49
# TODO: Rather than building a changeset object, we should probably
75
62
 
76
63
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
64
                  allow_binary=False, sequence_matcher=None,
78
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
65
                  path_encoding='utf8'):
79
66
    # FIXME: difflib is wrong if there is no trailing newline.
80
67
    # The syntax used by patch seems to be "\ No newline at
81
68
    # end of file" following the last diff line from that
86
73
    # In the meantime we at least make sure the patch isn't
87
74
    # mangled.
88
75
 
 
76
 
 
77
    # Special workaround for Python2.3, where difflib fails if
 
78
    # both sequences are empty.
 
79
    if not oldlines and not newlines:
 
80
        return
 
81
 
89
82
    if allow_binary is False:
90
83
        textfile.check_text_lines(oldlines)
91
84
        textfile.check_text_lines(newlines)
93
86
    if sequence_matcher is None:
94
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
95
88
    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)
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
 
91
                      sequencematcher=sequence_matcher)
99
92
 
100
93
    ud = list(ud)
101
94
    if len(ud) == 0: # Identical contents, nothing to do
115
108
 
116
109
 
117
110
def _spawn_external_diff(diffcmd, capture_errors=True):
118
 
    """Spawn the external diff process, and return the child handle.
 
111
    """Spawn the externall diff process, and return the child handle.
119
112
 
120
113
    :param diffcmd: The command list to spawn
121
114
    :param capture_errors: Capture stderr as well as setting LANG=C
143
136
                                stdout=subprocess.PIPE,
144
137
                                stderr=stderr,
145
138
                                env=env)
146
 
    except OSError as e:
 
139
    except OSError, e:
147
140
        if e.errno == errno.ENOENT:
148
141
            raise errors.NoDiff(str(e))
149
142
        raise
150
143
 
151
144
    return pipe
152
145
 
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
146
 
188
147
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
189
148
                  diff_opts):
191
150
    # make sure our own output is properly ordered before the diff
192
151
    to_file.flush()
193
152
 
194
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
195
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
153
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
154
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
196
155
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
197
156
    newtmpf = os.fdopen(newtmp_fd, 'wb')
198
157
 
225
184
                   '--binary',
226
185
                  ]
227
186
 
228
 
        diff_opts = default_style_unified(diff_opts)
 
187
        # diff only allows one style to be specified; they don't override.
 
188
        # note that some of these take optargs, and the optargs can be
 
189
        # directly appended to the options.
 
190
        # this is only an approximate parser; it doesn't properly understand
 
191
        # the grammar.
 
192
        for s in ['-c', '-u', '-C', '-U',
 
193
                  '-e', '--ed',
 
194
                  '-q', '--brief',
 
195
                  '--normal',
 
196
                  '-n', '--rcs',
 
197
                  '-y', '--side-by-side',
 
198
                  '-D', '--ifdef']:
 
199
            for j in diff_opts:
 
200
                if j.startswith(s):
 
201
                    break
 
202
            else:
 
203
                continue
 
204
            break
 
205
        else:
 
206
            diffcmd.append('-u')
229
207
 
230
208
        if diff_opts:
231
209
            diffcmd.extend(diff_opts)
232
210
 
233
211
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
234
 
        out, err = pipe.communicate()
 
212
        out,err = pipe.communicate()
235
213
        rc = pipe.returncode
236
214
 
237
215
        # internal_diff() adds a trailing newline, add one here for consistency
276
254
                msg = 'exit code %d' % rc
277
255
 
278
256
            raise errors.BzrError('external diff failed with %s; command: %r'
279
 
                                  % (msg, diffcmd))
 
257
                                  % (rc, diffcmd))
280
258
 
281
259
 
282
260
    finally:
283
261
        oldtmpf.close()                 # and delete
284
262
        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):
 
263
        # Clean up. Warn in case the files couldn't be deleted
 
264
        # (in case windows still holds the file open, but not
 
265
        # if the files have already been deleted)
 
266
        try:
 
267
            os.remove(old_abspath)
 
268
        except OSError, e:
 
269
            if e.errno not in (errno.ENOENT,):
 
270
                warning('Failed to delete temporary file: %s %s',
 
271
                        old_abspath, e)
 
272
        try:
 
273
            os.remove(new_abspath)
 
274
        except OSError:
 
275
            if e.errno not in (errno.ENOENT,):
 
276
                warning('Failed to delete temporary file: %s %s',
 
277
                        new_abspath, e)
 
278
 
 
279
 
 
280
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
 
281
                                   apply_view=True):
302
282
    """Get the trees and specific files to diff given a list of paths.
303
283
 
304
284
    This method works out the trees to be diff'ed and the files of
315
295
    :param new_url:
316
296
        The url of the new branch or tree. If None, the tree to use is
317
297
        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
298
    :param apply_view:
322
299
        if True and a view is set, apply the view or check that the paths
323
300
        are within it
324
301
    :returns:
325
302
        a tuple of (old_tree, new_tree, old_branch, new_branch,
326
303
        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.
 
304
        additional trees to search in for file-ids.
330
305
    """
331
306
    # Get the old and new revision specs
332
307
    old_revision_spec = None
355
330
        default_location = path_list[0]
356
331
        other_paths = path_list[1:]
357
332
 
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
333
    # Get the old location
367
334
    specific_files = []
368
335
    if old_url is None:
369
336
        old_url = default_location
370
337
    working_tree, branch, relpath = \
371
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
372
 
    lock_tree_or_branch(working_tree, branch)
 
338
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
373
339
    if consider_relpath and relpath != '':
374
340
        if working_tree is not None and apply_view:
375
341
            views.check_path_in_view(working_tree, relpath)
382
348
        new_url = default_location
383
349
    if new_url != old_url:
384
350
        working_tree, branch, relpath = \
385
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
386
 
        lock_tree_or_branch(working_tree, branch)
 
351
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
387
352
        if consider_relpath and relpath != '':
388
353
            if working_tree is not None and apply_view:
389
354
                views.check_path_in_view(working_tree, relpath)
394
359
 
395
360
    # Get the specific files (all files is None, no files is [])
396
361
    if make_paths_wt_relative and working_tree is not None:
397
 
        other_paths = working_tree.safe_relpath_files(
398
 
            other_paths,
 
362
        try:
 
363
            from bzrlib.builtins import safe_relpath_files
 
364
            other_paths = safe_relpath_files(working_tree, other_paths,
399
365
            apply_view=apply_view)
 
366
        except errors.FileInWrongBranch:
 
367
            raise errors.BzrCommandError("Files are in different branches")
400
368
    specific_files.extend(other_paths)
401
369
    if len(specific_files) == 0:
402
370
        specific_files = None
406
374
            if view_files:
407
375
                specific_files = view_files
408
376
                view_str = views.view_display_str(view_files)
409
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
377
                note("*** Ignoring files outside view. View is %s" % view_str)
410
378
 
411
379
    # Get extra trees that ought to be searched for file-ids
412
380
    extra_trees = None
413
381
    if working_tree is not None and working_tree not in (old_tree, new_tree):
414
382
        extra_trees = (working_tree,)
415
 
    return (old_tree, new_tree, old_branch, new_branch,
416
 
            specific_files, extra_trees)
 
383
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
417
384
 
418
385
 
419
386
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
435
402
                    old_label='a/', new_label='b/',
436
403
                    extra_trees=None,
437
404
                    path_encoding='utf8',
438
 
                    using=None,
439
 
                    format_cls=None,
440
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
405
                    using=None):
441
406
    """Show in text form the changes from one tree to another.
442
407
 
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)
 
408
    to_file
 
409
        The output stream.
 
410
 
 
411
    specific_files
 
412
        Include only changes to these files - None for all changes.
 
413
 
 
414
    external_diff_options
 
415
        If set, use an external GNU diff and pass these options.
 
416
 
 
417
    extra_trees
 
418
        If set, more Trees to use for looking up file ids
 
419
 
 
420
    path_encoding
 
421
        If set, the path will be encoded as specified, otherwise is supposed
 
422
        to be utf8
452
423
    """
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():
 
424
    old_tree.lock_read()
 
425
    try:
458
426
        if extra_trees is not None:
459
427
            for tree in extra_trees:
460
428
                tree.lock_read()
461
429
        new_tree.lock_read()
462
430
        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)
 
431
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
432
                                                 path_encoding,
 
433
                                                 external_diff_options,
 
434
                                                 old_label, new_label, using)
468
435
            return differ.show_diff(specific_files, extra_trees)
469
436
        finally:
470
437
            new_tree.unlock()
471
438
            if extra_trees is not None:
472
439
                for tree in extra_trees:
473
440
                    tree.unlock()
 
441
    finally:
 
442
        old_tree.unlock()
474
443
 
475
444
 
476
445
def _patch_header_date(tree, file_id, path):
477
446
    """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
 
447
    mtime = tree.get_file_mtime(file_id, path)
482
448
    return timestamp.format_patch_date(mtime)
483
449
 
484
450
 
596
562
        if 'symlink' not in (old_kind, new_kind):
597
563
            return self.CANNOT_DIFF
598
564
        if old_kind == 'symlink':
599
 
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
 
565
            old_target = self.old_tree.get_symlink_target(file_id)
600
566
        elif old_kind is None:
601
567
            old_target = None
602
568
        else:
603
569
            return self.CANNOT_DIFF
604
570
        if new_kind == 'symlink':
605
 
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
 
571
            new_target = self.new_tree.get_symlink_target(file_id)
606
572
        elif new_kind is None:
607
573
            new_target = None
608
574
        else:
626
592
    # or removed in a diff.
627
593
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
628
594
 
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):
 
595
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
596
                 old_label='', new_label='', text_differ=internal_diff):
632
597
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
633
598
        self.text_differ = text_differ
634
599
        self.old_label = old_label
635
600
        self.new_label = new_label
636
601
        self.path_encoding = path_encoding
637
 
        self.context_lines = context_lines
638
602
 
639
603
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
640
604
        """Compare two files in unified diff format
664
628
            return self.CANNOT_DIFF
665
629
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
666
630
        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)
 
631
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
632
            old_path, new_path)
669
633
 
670
 
    def diff_text(self, from_path, to_path, from_label, to_label,
671
 
        from_file_id=None, to_file_id=None):
 
634
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
635
        from_path=None, to_path=None):
672
636
        """Diff the content of given files in two trees
673
637
 
674
 
        :param from_path: The path in the from tree. If None,
 
638
        :param from_file_id: The id of the file in the from tree.  If None,
675
639
            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,
 
640
        :param to_file_id: The id of the file in the to tree.  This may refer
 
641
            to a different file from from_file_id.  If None,
678
642
            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.
 
643
        :param from_path: The path in the from tree or None if unknown.
 
644
        :param to_path: The path in the to tree or None if unknown.
683
645
        """
684
646
        def _get_text(tree, file_id, path):
685
 
            if file_id is None:
 
647
            if file_id is not None:
 
648
                return tree.get_file(file_id, path).readlines()
 
649
            else:
686
650
                return []
687
 
            return tree.get_file_lines(path, file_id)
688
651
        try:
689
652
            from_text = _get_text(self.old_tree, from_file_id, from_path)
690
653
            to_text = _get_text(self.new_tree, to_file_id, to_path)
691
654
            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)
 
655
                             self.to_file)
694
656
        except errors.BinaryFile:
695
657
            self.to_file.write(
696
658
                  ("Binary files %s and %s differ\n" %
697
 
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
 
659
                  (from_label, to_label)).encode(self.path_encoding))
698
660
        return self.CHANGED
699
661
 
700
662
 
704
666
                 path_encoding='utf-8'):
705
667
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
706
668
        self.command_template = command_template
707
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
669
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
708
670
 
709
671
    @classmethod
710
672
    def from_string(klass, command_string, old_tree, new_tree, to_file,
711
673
                    path_encoding='utf-8'):
712
 
        command_template = cmdline.split(command_string)
713
 
        if '@' not in command_string:
714
 
            command_template.extend(['@old_path', '@new_path'])
 
674
        command_template = commands.shlex_split_unicode(command_string)
 
675
        command_template.extend(['%(old_path)s', '%(new_path)s'])
715
676
        return klass(command_template, old_tree, new_tree, to_file,
716
677
                     path_encoding)
717
678
 
718
679
    @classmethod
719
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
680
    def make_from_diff_tree(klass, command_string):
720
681
        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,
 
682
            return klass.from_string(command_string, diff_tree.old_tree,
725
683
                                     diff_tree.new_tree, diff_tree.to_file)
726
684
        return from_diff_tree
727
685
 
728
686
    def _get_command(self, old_path, new_path):
729
687
        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
 
688
        return [t % my_map for t in self.command_template]
742
689
 
743
690
    def _execute(self, old_path, new_path):
744
691
        command = self._get_command(old_path, new_path)
745
692
        try:
746
693
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
747
694
                                    cwd=self._root)
748
 
        except OSError as e:
 
695
        except OSError, e:
749
696
            if e.errno == errno.ENOENT:
750
697
                raise errors.ExecutableMissing(command[0])
751
698
            else:
759
706
            return False
760
707
        try:
761
708
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
762
 
        except OSError as e:
 
709
        except OSError, e:
763
710
            if e.errno != errno.EEXIST:
764
711
                raise
765
712
        return True
766
713
 
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):
797
 
        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)
803
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
714
    def _write_file(self, file_id, tree, prefix, relpath):
 
715
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
716
        if self._try_symlink_root(tree, prefix):
804
717
            return full_path
805
718
        parent_dir = osutils.dirname(full_path)
806
719
        try:
807
720
            os.makedirs(parent_dir)
808
 
        except OSError as e:
 
721
        except OSError, e:
809
722
            if e.errno != errno.EEXIST:
810
723
                raise
811
 
        source = tree.get_file(relpath, file_id)
 
724
        source = tree.get_file(file_id, relpath)
812
725
        try:
813
 
            with open(full_path, 'wb') as target:
 
726
            target = open(full_path, 'wb')
 
727
            try:
814
728
                osutils.pumpfile(source, target)
 
729
            finally:
 
730
                target.close()
815
731
        finally:
816
732
            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
 
        if not allow_write:
824
 
            osutils.make_readonly(full_path)
 
733
        osutils.make_readonly(full_path)
 
734
        mtime = tree.get_file_mtime(file_id)
 
735
        os.utime(full_path, (mtime, mtime))
825
736
        return full_path
826
737
 
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,
833
 
                                         allow_write=allow_write_new)
 
738
    def _prepare_files(self, file_id, old_path, new_path):
 
739
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
740
                                         old_path)
 
741
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
742
                                         new_path)
834
743
        return old_disk_path, new_disk_path
835
744
 
836
745
    def finish(self):
837
746
        try:
838
747
            osutils.rmtree(self._root)
839
 
        except OSError as e:
 
748
        except OSError, e:
840
749
            if e.errno != errno.ENOENT:
841
750
                mutter("The temporary directory \"%s\" was not "
842
751
                        "cleanly removed: %s." % (self._root, e))
844
753
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
845
754
        if (old_kind, new_kind) != ('file', 'file'):
846
755
            return DiffPath.CANNOT_DIFF
847
 
        (old_disk_path, new_disk_path) = self._prepare_files(
848
 
                old_path, new_path, file_id=file_id)
849
 
        self._execute(old_disk_path, new_disk_path)
850
 
 
851
 
    def edit_file(self, old_path, new_path, file_id=None):
852
 
        """Use this tool to edit a file.
853
 
 
854
 
        A temporary copy will be edited, and the new contents will be
855
 
        returned.
856
 
 
857
 
        :param file_id: The id of the file to edit.
858
 
        :return: The new contents of the file.
859
 
        """
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)
864
 
        subprocess.call(command, cwd=self._root)
865
 
        with open(new_abs_path, 'rb') as new_file:
866
 
            return new_file.read()
 
756
        self._prepare_files(file_id, old_path, new_path)
 
757
        self._execute(osutils.pathjoin('old', old_path),
 
758
                      osutils.pathjoin('new', new_path))
867
759
 
868
760
 
869
761
class DiffTree(object):
911
803
    @classmethod
912
804
    def from_trees_options(klass, old_tree, new_tree, to_file,
913
805
                           path_encoding, external_diff_options, old_label,
914
 
                           new_label, using, context_lines):
 
806
                           new_label, using):
915
807
        """Factory for producing a DiffTree.
916
808
 
917
809
        Designed to accept options used by show_diff_trees.
918
 
 
919
810
        :param old_tree: The tree to show as old in the comparison
920
811
        :param new_tree: The tree to show as new in the comparison
921
812
        :param to_file: File to write comparisons to
927
818
        :param using: Commandline to use to invoke an external diff tool
928
819
        """
929
820
        if using is not None:
930
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
821
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
931
822
        else:
932
823
            extra_factories = []
933
824
        if external_diff_options:
934
825
            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
 
                """
 
826
            def diff_file(olab, olines, nlab, nlines, to_file):
939
827
                external_diff(olab, olines, nlab, nlines, to_file, opts)
940
828
        else:
941
829
            diff_file = internal_diff
942
830
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
943
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
831
                             old_label, new_label, diff_file)
944
832
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
945
833
                     extra_factories)
946
834
 
947
835
    def show_diff(self, specific_files, extra_trees=None):
948
836
        """Write tree diff to self.to_file
949
837
 
950
 
        :param specific_files: the specific files to compare (recursive)
 
838
        :param sepecific_files: the specific files to compare (recursive)
951
839
        :param extra_trees: extra trees to use for mapping paths to file_ids
952
840
        """
953
841
        try:
990
878
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
991
879
 
992
880
            if properties_changed:
993
 
                prop_str = b" (properties changed: %s)" % (
994
 
                        b", ".join(properties_changed),)
 
881
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
995
882
            else:
996
 
                prop_str = b""
 
883
                prop_str = ""
997
884
 
998
885
            if (old_present, new_present) == (True, False):
999
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1000
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
886
                self.to_file.write("=== removed %s '%s'\n" %
 
887
                                   (kind[0], oldpath_encoded))
1001
888
                newpath = oldpath
1002
889
            elif (old_present, new_present) == (False, True):
1003
 
                self.to_file.write(b"=== added %s '%s'\n" %
1004
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
890
                self.to_file.write("=== added %s '%s'\n" %
 
891
                                   (kind[1], newpath_encoded))
1005
892
                oldpath = newpath
1006
893
            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))
 
894
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
895
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1009
896
            else:
1010
897
                # if it was produced by iter_changes, it must be
1011
898
                # modified *somehow*, either content or execute bit.
1012
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
899
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1013
900
                                   newpath_encoded, prop_str))
1014
901
            if changed_content:
1015
 
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
 
902
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1016
903
                has_changes = 1
1017
904
            if renamed:
1018
905
                has_changes = 1
1025
912
        :param old_path: The path of the file in the old tree
1026
913
        :param new_path: The path of the file in the new tree
1027
914
        """
1028
 
        if old_path is None:
 
915
        try:
 
916
            old_kind = self.old_tree.kind(file_id)
 
917
        except (errors.NoSuchId, errors.NoSuchFile):
1029
918
            old_kind = None
1030
 
        else:
1031
 
            old_kind = self.old_tree.kind(old_path, file_id)
1032
 
        if new_path is None:
 
919
        try:
 
920
            new_kind = self.new_tree.kind(file_id)
 
921
        except (errors.NoSuchId, errors.NoSuchFile):
1033
922
            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):
 
923
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
924
 
 
925
 
 
926
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1039
927
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1040
928
                                       new_path, old_kind, new_kind)
1041
929
        if result is DiffPath.CANNOT_DIFF:
1043
931
            if error_path is None:
1044
932
                error_path = old_path
1045
933
            raise errors.NoDiffFound(error_path)
1046
 
 
1047
 
 
1048
 
format_registry = Registry()
1049
 
format_registry.register('default', DiffTree)