/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: John Arbash Meinel
  • Date: 2009-10-12 21:44:27 UTC
  • mto: This revision was merged to the branch mainline in revision 4737.
  • Revision ID: john@arbash-meinel.com-20091012214427-zddi1kmc2jlf7v31
Py_ssize_t and its associated function typedefs are not available w/ python 2.4

So we define them in python-compat.h
Even further, gcc issued a warning for:
static int
_workaround_pyrex_096()
So we changed it to:
_workaround_pyrex_096(void)

Also, some python api funcs were incorrectly defined as 'char *' when they meant
'const char *'. Work around that with a (char *) cast, to avoid compiler warnings.

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 .sixish import text_type
51
 
from .trace import mutter, note, warning
52
 
from .tree import FileTimestampUnavailable
53
 
 
54
 
 
55
 
DEFAULT_CONTEXT_AMOUNT = 3
56
 
 
57
 
class AtTemplate(string.Template):
58
 
    """Templating class that uses @ instead of $."""
59
 
 
60
 
    delimiter = '@'
 
46
from bzrlib.trace import mutter, note, warning
61
47
 
62
48
 
63
49
# TODO: Rather than building a changeset object, we should probably
74
60
        self.opcodes = None
75
61
 
76
62
 
77
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file,
 
63
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
78
64
                  allow_binary=False, sequence_matcher=None,
79
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
65
                  path_encoding='utf8'):
80
66
    # FIXME: difflib is wrong if there is no trailing newline.
81
67
    # The syntax used by patch seems to be "\ No newline at
82
68
    # end of file" following the last diff line from that
87
73
    # In the meantime we at least make sure the patch isn't
88
74
    # mangled.
89
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
 
90
82
    if allow_binary is False:
91
83
        textfile.check_text_lines(oldlines)
92
84
        textfile.check_text_lines(newlines)
93
85
 
94
86
    if sequence_matcher is None:
95
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
96
 
    ud = patiencediff.unified_diff_bytes(oldlines, newlines,
97
 
                      fromfile=old_label.encode(path_encoding, 'replace'),
98
 
                      tofile=new_label.encode(path_encoding, 'replace'),
99
 
                      n=context_lines, sequencematcher=sequence_matcher)
 
88
    ud = patiencediff.unified_diff(oldlines, newlines,
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
 
91
                      sequencematcher=sequence_matcher)
100
92
 
101
93
    ud = list(ud)
102
94
    if len(ud) == 0: # Identical contents, nothing to do
104
96
    # work-around for difflib being too smart for its own good
105
97
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
106
98
    if not oldlines:
107
 
        ud[2] = ud[2].replace(b'-1,0', b'-0,0')
 
99
        ud[2] = ud[2].replace('-1,0', '-0,0')
108
100
    elif not newlines:
109
 
        ud[2] = ud[2].replace(b'+1,0', b'+0,0')
 
101
        ud[2] = ud[2].replace('+1,0', '+0,0')
110
102
 
111
103
    for line in ud:
112
104
        to_file.write(line)
113
 
        if not line.endswith(b'\n'):
114
 
            to_file.write(b"\n\\ No newline at end of file\n")
115
 
    to_file.write(b'\n')
 
105
        if not line.endswith('\n'):
 
106
            to_file.write("\n\\ No newline at end of file\n")
 
107
    to_file.write('\n')
116
108
 
117
109
 
118
110
def _spawn_external_diff(diffcmd, capture_errors=True):
119
 
    """Spawn the external diff process, and return the child handle.
 
111
    """Spawn the externall diff process, and return the child handle.
120
112
 
121
113
    :param diffcmd: The command list to spawn
122
114
    :param capture_errors: Capture stderr as well as setting LANG=C
144
136
                                stdout=subprocess.PIPE,
145
137
                                stderr=stderr,
146
138
                                env=env)
147
 
    except OSError as e:
 
139
    except OSError, e:
148
140
        if e.errno == errno.ENOENT:
149
141
            raise errors.NoDiff(str(e))
150
142
        raise
151
143
 
152
144
    return pipe
153
145
 
154
 
# diff style options as of GNU diff v3.2
155
 
style_option_list = ['-c', '-C', '--context',
156
 
                     '-e', '--ed',
157
 
                     '-f', '--forward-ed',
158
 
                     '-q', '--brief',
159
 
                     '--normal',
160
 
                     '-n', '--rcs',
161
 
                     '-u', '-U', '--unified',
162
 
                     '-y', '--side-by-side',
163
 
                     '-D', '--ifdef']
164
 
 
165
 
def default_style_unified(diff_opts):
166
 
    """Default to unified diff style if alternative not specified in diff_opts.
167
 
 
168
 
        diff only allows one style to be specified; they don't override.
169
 
        Note that some of these take optargs, and the optargs can be
170
 
        directly appended to the options.
171
 
        This is only an approximate parser; it doesn't properly understand
172
 
        the grammar.
173
 
 
174
 
    :param diff_opts: List of options for external (GNU) diff.
175
 
    :return: List of options with default style=='unified'.
176
 
    """
177
 
    for s in style_option_list:
178
 
        for j in diff_opts:
179
 
            if j.startswith(s):
180
 
                break
181
 
        else:
182
 
            continue
183
 
        break
184
 
    else:
185
 
        diff_opts.append('-u')
186
 
    return diff_opts
187
 
 
188
 
 
189
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
146
 
 
147
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
190
148
                  diff_opts):
191
149
    """Display a diff by calling out to the external diff program."""
192
150
    # make sure our own output is properly ordered before the diff
193
151
    to_file.flush()
194
152
 
195
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
196
 
    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-')
197
155
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
198
156
    newtmpf = os.fdopen(newtmp_fd, 'wb')
199
157
 
216
174
        if sys.platform == 'win32':
217
175
            # Popen doesn't do the proper encoding for external commands
218
176
            # Since we are dealing with an ANSI api, use mbcs encoding
219
 
            old_label = old_label.encode('mbcs')
220
 
            new_label = new_label.encode('mbcs')
 
177
            old_filename = old_filename.encode('mbcs')
 
178
            new_filename = new_filename.encode('mbcs')
221
179
        diffcmd = ['diff',
222
 
                   '--label', old_label,
 
180
                   '--label', old_filename,
223
181
                   old_abspath,
224
 
                   '--label', new_label,
 
182
                   '--label', new_filename,
225
183
                   new_abspath,
226
184
                   '--binary',
227
185
                  ]
228
186
 
229
 
        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')
230
207
 
231
208
        if diff_opts:
232
209
            diffcmd.extend(diff_opts)
233
210
 
234
211
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
235
 
        out, err = pipe.communicate()
 
212
        out,err = pipe.communicate()
236
213
        rc = pipe.returncode
237
214
 
238
215
        # internal_diff() adds a trailing newline, add one here for consistency
239
 
        out += b'\n'
 
216
        out += '\n'
240
217
        if rc == 2:
241
218
            # 'diff' gives retcode == 2 for all sorts of errors
242
219
            # one of those is 'Binary files differ'.
249
226
            out, err = pipe.communicate()
250
227
 
251
228
            # Write out the new i18n diff response
252
 
            to_file.write(out+b'\n')
 
229
            to_file.write(out+'\n')
253
230
            if pipe.returncode != 2:
254
231
                raise errors.BzrError(
255
232
                               'external diff failed with exit code 2'
256
233
                               ' when run with LANG=C and LC_ALL=C,'
257
234
                               ' but not when run natively: %r' % (diffcmd,))
258
235
 
259
 
            first_line = lang_c_out.split(b'\n', 1)[0]
 
236
            first_line = lang_c_out.split('\n', 1)[0]
260
237
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
261
 
            m = re.match(b'^(binary )?files.*differ$', first_line, re.I)
 
238
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
262
239
            if m is None:
263
240
                raise errors.BzrError('external diff failed with exit code 2;'
264
241
                                      ' command: %r' % (diffcmd,))
277
254
                msg = 'exit code %d' % rc
278
255
 
279
256
            raise errors.BzrError('external diff failed with %s; command: %r'
280
 
                                  % (msg, diffcmd))
 
257
                                  % (rc, diffcmd))
281
258
 
282
259
 
283
260
    finally:
284
261
        oldtmpf.close()                 # and delete
285
262
        newtmpf.close()
286
 
 
287
 
        def cleanup(path):
288
 
            # Warn in case the file couldn't be deleted (in case windows still
289
 
            # holds the file open, but not if the files have already been
290
 
            # deleted)
291
 
            try:
292
 
                os.remove(path)
293
 
            except OSError as e:
294
 
                if e.errno not in (errno.ENOENT,):
295
 
                    warning('Failed to delete temporary file: %s %s', path, e)
296
 
 
297
 
        cleanup(old_abspath)
298
 
        cleanup(new_abspath)
299
 
 
300
 
 
301
 
def get_trees_and_branches_to_diff_locked(
302
 
    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):
303
282
    """Get the trees and specific files to diff given a list of paths.
304
283
 
305
284
    This method works out the trees to be diff'ed and the files of
316
295
    :param new_url:
317
296
        The url of the new branch or tree. If None, the tree to use is
318
297
        taken from the first path, if any, or the current working tree.
319
 
    :param add_cleanup:
320
 
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
321
 
        will register cleanups that must be run to unlock the trees, etc.
322
298
    :param apply_view:
323
299
        if True and a view is set, apply the view or check that the paths
324
300
        are within it
325
301
    :returns:
326
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
327
 
        specific_files, extra_trees) where extra_trees is a sequence of
328
 
        additional trees to search in for file-ids.  The trees and branches
329
 
        will be read-locked until the cleanups registered via the add_cleanup
330
 
        param are run.
 
302
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
303
        extra_trees is a sequence of additional trees to search in for
 
304
        file-ids.
331
305
    """
332
306
    # Get the old and new revision specs
333
307
    old_revision_spec = None
356
330
        default_location = path_list[0]
357
331
        other_paths = path_list[1:]
358
332
 
359
 
    def lock_tree_or_branch(wt, br):
360
 
        if wt is not None:
361
 
            wt.lock_read()
362
 
            add_cleanup(wt.unlock)
363
 
        elif br is not None:
364
 
            br.lock_read()
365
 
            add_cleanup(br.unlock)
366
 
 
367
333
    # Get the old location
368
334
    specific_files = []
369
335
    if old_url is None:
370
336
        old_url = default_location
371
337
    working_tree, branch, relpath = \
372
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
373
 
    lock_tree_or_branch(working_tree, branch)
 
338
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
374
339
    if consider_relpath and relpath != '':
375
340
        if working_tree is not None and apply_view:
376
341
            views.check_path_in_view(working_tree, relpath)
383
348
        new_url = default_location
384
349
    if new_url != old_url:
385
350
        working_tree, branch, relpath = \
386
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
387
 
        lock_tree_or_branch(working_tree, branch)
 
351
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
388
352
        if consider_relpath and relpath != '':
389
353
            if working_tree is not None and apply_view:
390
354
                views.check_path_in_view(working_tree, relpath)
395
359
 
396
360
    # Get the specific files (all files is None, no files is [])
397
361
    if make_paths_wt_relative and working_tree is not None:
398
 
        other_paths = working_tree.safe_relpath_files(
399
 
            other_paths,
 
362
        try:
 
363
            from bzrlib.builtins import safe_relpath_files
 
364
            other_paths = safe_relpath_files(working_tree, other_paths,
400
365
            apply_view=apply_view)
 
366
        except errors.FileInWrongBranch:
 
367
            raise errors.BzrCommandError("Files are in different branches")
401
368
    specific_files.extend(other_paths)
402
369
    if len(specific_files) == 0:
403
370
        specific_files = None
407
374
            if view_files:
408
375
                specific_files = view_files
409
376
                view_str = views.view_display_str(view_files)
410
 
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
 
377
                note("*** Ignoring files outside view. View is %s" % view_str)
411
378
 
412
379
    # Get extra trees that ought to be searched for file-ids
413
380
    extra_trees = None
414
381
    if working_tree is not None and working_tree not in (old_tree, new_tree):
415
382
        extra_trees = (working_tree,)
416
 
    return (old_tree, new_tree, old_branch, new_branch,
417
 
            specific_files, extra_trees)
418
 
 
 
383
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
419
384
 
420
385
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
421
386
    if branch is None and tree is not None:
436
401
                    old_label='a/', new_label='b/',
437
402
                    extra_trees=None,
438
403
                    path_encoding='utf8',
439
 
                    using=None,
440
 
                    format_cls=None,
441
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
404
                    using=None):
442
405
    """Show in text form the changes from one tree to another.
443
406
 
444
 
    :param to_file: The output stream.
445
 
    :param specific_files: Include only changes to these files - None for all
446
 
        changes.
447
 
    :param external_diff_options: If set, use an external GNU diff and pass 
448
 
        these options.
449
 
    :param extra_trees: If set, more Trees to use for looking up file ids
450
 
    :param path_encoding: If set, the path will be encoded as specified, 
451
 
        otherwise is supposed to be utf8
452
 
    :param format_cls: Formatter class (DiffTree subclass)
 
407
    to_file
 
408
        The output stream.
 
409
 
 
410
    specific_files
 
411
        Include only changes to these files - None for all changes.
 
412
 
 
413
    external_diff_options
 
414
        If set, use an external GNU diff and pass these options.
 
415
 
 
416
    extra_trees
 
417
        If set, more Trees to use for looking up file ids
 
418
 
 
419
    path_encoding
 
420
        If set, the path will be encoded as specified, otherwise is supposed
 
421
        to be utf8
453
422
    """
454
 
    if context is None:
455
 
        context = DEFAULT_CONTEXT_AMOUNT
456
 
    if format_cls is None:
457
 
        format_cls = DiffTree
458
 
    with old_tree.lock_read():
 
423
    old_tree.lock_read()
 
424
    try:
459
425
        if extra_trees is not None:
460
426
            for tree in extra_trees:
461
427
                tree.lock_read()
462
428
        new_tree.lock_read()
463
429
        try:
464
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
465
 
                                                   path_encoding,
466
 
                                                   external_diff_options,
467
 
                                                   old_label, new_label, using,
468
 
                                                   context_lines=context)
 
430
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
431
                                                 path_encoding,
 
432
                                                 external_diff_options,
 
433
                                                 old_label, new_label, using)
469
434
            return differ.show_diff(specific_files, extra_trees)
470
435
        finally:
471
436
            new_tree.unlock()
472
437
            if extra_trees is not None:
473
438
                for tree in extra_trees:
474
439
                    tree.unlock()
 
440
    finally:
 
441
        old_tree.unlock()
475
442
 
476
443
 
477
444
def _patch_header_date(tree, file_id, path):
478
445
    """Returns a timestamp suitable for use in a patch header."""
479
 
    try:
480
 
        mtime = tree.get_file_mtime(path, file_id)
481
 
    except FileTimestampUnavailable:
482
 
        mtime = 0
 
446
    mtime = tree.get_file_mtime(file_id, path)
483
447
    return timestamp.format_patch_date(mtime)
484
448
 
485
449
 
486
450
def get_executable_change(old_is_x, new_is_x):
487
 
    descr = { True:b"+x", False:b"-x", None:b"??" }
 
451
    descr = { True:"+x", False:"-x", None:"??" }
488
452
    if old_is_x != new_is_x:
489
 
        return [b"%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
453
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
490
454
    else:
491
455
        return []
492
456
 
597
561
        if 'symlink' not in (old_kind, new_kind):
598
562
            return self.CANNOT_DIFF
599
563
        if old_kind == 'symlink':
600
 
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
 
564
            old_target = self.old_tree.get_symlink_target(file_id)
601
565
        elif old_kind is None:
602
566
            old_target = None
603
567
        else:
604
568
            return self.CANNOT_DIFF
605
569
        if new_kind == 'symlink':
606
 
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
 
570
            new_target = self.new_tree.get_symlink_target(file_id)
607
571
        elif new_kind is None:
608
572
            new_target = None
609
573
        else:
612
576
 
613
577
    def diff_symlink(self, old_target, new_target):
614
578
        if old_target is None:
615
 
            self.to_file.write(b'=== target is \'%s\'\n' %
616
 
                new_target.encode(self.path_encoding, 'replace'))
 
579
            self.to_file.write('=== target is %r\n' % new_target)
617
580
        elif new_target is None:
618
 
            self.to_file.write(b'=== target was \'%s\'\n' %
619
 
                old_target.encode(self.path_encoding, 'replace'))
 
581
            self.to_file.write('=== target was %r\n' % old_target)
620
582
        else:
621
 
            self.to_file.write(b'=== target changed \'%s\' => \'%s\'\n' %
622
 
                              (old_target.encode(self.path_encoding, 'replace'),
623
 
                               new_target.encode(self.path_encoding, 'replace')))
 
583
            self.to_file.write('=== target changed %r => %r\n' %
 
584
                              (old_target, new_target))
624
585
        return self.CHANGED
625
586
 
626
587
 
630
591
    # or removed in a diff.
631
592
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
632
593
 
633
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8', 
634
 
                 old_label='', new_label='', text_differ=internal_diff, 
635
 
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
 
594
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
595
                 old_label='', new_label='', text_differ=internal_diff):
636
596
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
637
597
        self.text_differ = text_differ
638
598
        self.old_label = old_label
639
599
        self.new_label = new_label
640
600
        self.path_encoding = path_encoding
641
 
        self.context_lines = context_lines
642
601
 
643
602
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
644
603
        """Compare two files in unified diff format
666
625
            to_file_id = None
667
626
        else:
668
627
            return self.CANNOT_DIFF
669
 
        from_label = '%s%s\t%s' % (self.old_label, old_path,
670
 
                old_date)
671
 
        to_label = '%s%s\t%s' % (self.new_label, new_path,
672
 
                new_date)
673
 
        return self.diff_text(old_path, new_path, from_label, to_label,
674
 
            from_file_id, to_file_id)
 
628
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
629
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
630
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
631
            old_path, new_path)
675
632
 
676
 
    def diff_text(self, from_path, to_path, from_label, to_label,
677
 
        from_file_id=None, to_file_id=None):
 
633
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
634
        from_path=None, to_path=None):
678
635
        """Diff the content of given files in two trees
679
636
 
680
 
        :param from_path: The path in the from tree. If None,
 
637
        :param from_file_id: The id of the file in the from tree.  If None,
681
638
            the file is not present in the from tree.
682
 
        :param to_path: The path in the to tree. This may refer
683
 
            to a different file from from_path.  If None,
 
639
        :param to_file_id: The id of the file in the to tree.  This may refer
 
640
            to a different file from from_file_id.  If None,
684
641
            the file is not present in the to tree.
685
 
        :param from_file_id: The id of the file in the from tree or None if
686
 
            unknown.
687
 
        :param to_file_id: The id of the file in the to tree or None if
688
 
            unknown.
 
642
        :param from_path: The path in the from tree or None if unknown.
 
643
        :param to_path: The path in the to tree or None if unknown.
689
644
        """
690
645
        def _get_text(tree, file_id, path):
691
 
            if file_id is None:
 
646
            if file_id is not None:
 
647
                return tree.get_file(file_id, path).readlines()
 
648
            else:
692
649
                return []
693
 
            return tree.get_file_lines(path, file_id)
694
650
        try:
695
651
            from_text = _get_text(self.old_tree, from_file_id, from_path)
696
652
            to_text = _get_text(self.new_tree, to_file_id, to_path)
697
653
            self.text_differ(from_label, from_text, to_label, to_text,
698
 
                             self.to_file, path_encoding=self.path_encoding,
699
 
                             context_lines=self.context_lines)
 
654
                             self.to_file)
700
655
        except errors.BinaryFile:
701
656
            self.to_file.write(
702
657
                  ("Binary files %s and %s differ\n" %
703
 
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
 
658
                  (from_label, to_label)).encode(self.path_encoding))
704
659
        return self.CHANGED
705
660
 
706
661
 
710
665
                 path_encoding='utf-8'):
711
666
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
712
667
        self.command_template = command_template
713
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
668
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
714
669
 
715
670
    @classmethod
716
671
    def from_string(klass, command_string, old_tree, new_tree, to_file,
717
672
                    path_encoding='utf-8'):
718
 
        command_template = cmdline.split(command_string)
719
 
        if '@' not in command_string:
720
 
            command_template.extend(['@old_path', '@new_path'])
 
673
        command_template = commands.shlex_split_unicode(command_string)
 
674
        command_template.extend(['%(old_path)s', '%(new_path)s'])
721
675
        return klass(command_template, old_tree, new_tree, to_file,
722
676
                     path_encoding)
723
677
 
724
678
    @classmethod
725
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
679
    def make_from_diff_tree(klass, command_string):
726
680
        def from_diff_tree(diff_tree):
727
 
            full_command_string = [command_string]
728
 
            if external_diff_options is not None:
729
 
                full_command_string += ' ' + external_diff_options
730
 
            return klass.from_string(full_command_string, diff_tree.old_tree,
 
681
            return klass.from_string(command_string, diff_tree.old_tree,
731
682
                                     diff_tree.new_tree, diff_tree.to_file)
732
683
        return from_diff_tree
733
684
 
734
685
    def _get_command(self, old_path, new_path):
735
686
        my_map = {'old_path': old_path, 'new_path': new_path}
736
 
        command = [AtTemplate(t).substitute(my_map) for t in
737
 
                   self.command_template]
738
 
        if sys.platform == 'win32': # Popen doesn't accept unicode on win32
739
 
            command_encoded = []
740
 
            for c in command:
741
 
                if isinstance(c, text_type):
742
 
                    command_encoded.append(c.encode('mbcs'))
743
 
                else:
744
 
                    command_encoded.append(c)
745
 
            return command_encoded
746
 
        else:
747
 
            return command
 
687
        return [t % my_map for t in self.command_template]
748
688
 
749
689
    def _execute(self, old_path, new_path):
750
690
        command = self._get_command(old_path, new_path)
751
691
        try:
752
692
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
753
693
                                    cwd=self._root)
754
 
        except OSError as e:
 
694
        except OSError, e:
755
695
            if e.errno == errno.ENOENT:
756
696
                raise errors.ExecutableMissing(command[0])
757
697
            else:
758
698
                raise
759
699
        self.to_file.write(proc.stdout.read())
760
 
        proc.stdout.close()
761
700
        return proc.wait()
762
701
 
763
702
    def _try_symlink_root(self, tree, prefix):
766
705
            return False
767
706
        try:
768
707
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
769
 
        except OSError as e:
 
708
        except OSError, e:
770
709
            if e.errno != errno.EEXIST:
771
710
                raise
772
711
        return True
773
712
 
774
 
    @staticmethod
775
 
    def _fenc():
776
 
        """Returns safe encoding for passing file path to diff tool"""
777
 
        if sys.platform == 'win32':
778
 
            return 'mbcs'
779
 
        else:
780
 
            # Don't fallback to 'utf-8' because subprocess may not be able to
781
 
            # handle utf-8 correctly when locale is not utf-8.
782
 
            return sys.getfilesystemencoding() or 'ascii'
783
 
 
784
 
    def _is_safepath(self, path):
785
 
        """Return true if `path` may be able to pass to subprocess."""
786
 
        fenc = self._fenc()
787
 
        try:
788
 
            return path == path.encode(fenc).decode(fenc)
789
 
        except UnicodeError:
790
 
            return False
791
 
 
792
 
    def _safe_filename(self, prefix, relpath):
793
 
        """Replace unsafe character in `relpath` then join `self._root`,
794
 
        `prefix` and `relpath`."""
795
 
        fenc = self._fenc()
796
 
        # encoded_str.replace('?', '_') may break multibyte char.
797
 
        # So we should encode, decode, then replace(u'?', u'_')
798
 
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
799
 
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
800
 
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
801
 
 
802
 
    def _write_file(self, relpath, tree, prefix, force_temp=False,
803
 
                    allow_write=False, file_id=None):
804
 
        if not force_temp and isinstance(tree, WorkingTree):
805
 
            full_path = tree.abspath(relpath)
806
 
            if self._is_safepath(full_path):
807
 
                return full_path
808
 
 
809
 
        full_path = self._safe_filename(prefix, relpath)
810
 
        if not force_temp and self._try_symlink_root(tree, prefix):
 
713
    def _write_file(self, file_id, tree, prefix, relpath):
 
714
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
715
        if self._try_symlink_root(tree, prefix):
811
716
            return full_path
812
717
        parent_dir = osutils.dirname(full_path)
813
718
        try:
814
719
            os.makedirs(parent_dir)
815
 
        except OSError as e:
 
720
        except OSError, e:
816
721
            if e.errno != errno.EEXIST:
817
722
                raise
818
 
        source = tree.get_file(relpath, file_id)
 
723
        source = tree.get_file(file_id, relpath)
819
724
        try:
820
 
            with open(full_path, 'wb') as target:
 
725
            target = open(full_path, 'wb')
 
726
            try:
821
727
                osutils.pumpfile(source, target)
 
728
            finally:
 
729
                target.close()
822
730
        finally:
823
731
            source.close()
824
 
        try:
825
 
            mtime = tree.get_file_mtime(relpath, file_id)
826
 
        except FileTimestampUnavailable:
827
 
            pass
828
 
        else:
829
 
            os.utime(full_path, (mtime, mtime))
830
 
        if not allow_write:
831
 
            osutils.make_readonly(full_path)
 
732
        osutils.make_readonly(full_path)
 
733
        mtime = tree.get_file_mtime(file_id)
 
734
        os.utime(full_path, (mtime, mtime))
832
735
        return full_path
833
736
 
834
 
    def _prepare_files(self, old_path, new_path, force_temp=False,
835
 
                       allow_write_new=False, file_id=None):
836
 
        old_disk_path = self._write_file(old_path, self.old_tree, 'old',
837
 
                                         force_temp, file_id=file_id)
838
 
        new_disk_path = self._write_file(new_path, self.new_tree, 'new',
839
 
                                         force_temp, file_id=file_id,
840
 
                                         allow_write=allow_write_new)
 
737
    def _prepare_files(self, file_id, old_path, new_path):
 
738
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
739
                                         old_path)
 
740
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
741
                                         new_path)
841
742
        return old_disk_path, new_disk_path
842
743
 
843
744
    def finish(self):
844
745
        try:
845
746
            osutils.rmtree(self._root)
846
 
        except OSError as e:
 
747
        except OSError, e:
847
748
            if e.errno != errno.ENOENT:
848
749
                mutter("The temporary directory \"%s\" was not "
849
750
                        "cleanly removed: %s." % (self._root, e))
851
752
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
852
753
        if (old_kind, new_kind) != ('file', 'file'):
853
754
            return DiffPath.CANNOT_DIFF
854
 
        (old_disk_path, new_disk_path) = self._prepare_files(
855
 
                old_path, new_path, file_id=file_id)
856
 
        self._execute(old_disk_path, new_disk_path)
857
 
 
858
 
    def edit_file(self, old_path, new_path, file_id=None):
859
 
        """Use this tool to edit a file.
860
 
 
861
 
        A temporary copy will be edited, and the new contents will be
862
 
        returned.
863
 
 
864
 
        :param file_id: The id of the file to edit.
865
 
        :return: The new contents of the file.
866
 
        """
867
 
        old_abs_path, new_abs_path = self._prepare_files(
868
 
                old_path, new_path, allow_write_new=True, force_temp=True,
869
 
                file_id=file_id)
870
 
        command = self._get_command(old_abs_path, new_abs_path)
871
 
        subprocess.call(command, cwd=self._root)
872
 
        with open(new_abs_path, 'rb') as new_file:
873
 
            return new_file.read()
 
755
        self._prepare_files(file_id, old_path, new_path)
 
756
        self._execute(osutils.pathjoin('old', old_path),
 
757
                      osutils.pathjoin('new', new_path))
874
758
 
875
759
 
876
760
class DiffTree(object):
918
802
    @classmethod
919
803
    def from_trees_options(klass, old_tree, new_tree, to_file,
920
804
                           path_encoding, external_diff_options, old_label,
921
 
                           new_label, using, context_lines):
 
805
                           new_label, using):
922
806
        """Factory for producing a DiffTree.
923
807
 
924
808
        Designed to accept options used by show_diff_trees.
925
 
 
926
809
        :param old_tree: The tree to show as old in the comparison
927
810
        :param new_tree: The tree to show as new in the comparison
928
811
        :param to_file: File to write comparisons to
934
817
        :param using: Commandline to use to invoke an external diff tool
935
818
        """
936
819
        if using is not None:
937
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
820
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
938
821
        else:
939
822
            extra_factories = []
940
823
        if external_diff_options:
941
824
            opts = external_diff_options.split()
942
 
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
943
 
                """:param path_encoding: not used but required
944
 
                        to match the signature of internal_diff.
945
 
                """
 
825
            def diff_file(olab, olines, nlab, nlines, to_file):
946
826
                external_diff(olab, olines, nlab, nlines, to_file, opts)
947
827
        else:
948
828
            diff_file = internal_diff
949
829
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
950
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
830
                             old_label, new_label, diff_file)
951
831
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
952
832
                     extra_factories)
953
833
 
954
834
    def show_diff(self, specific_files, extra_trees=None):
955
835
        """Write tree diff to self.to_file
956
836
 
957
 
        :param specific_files: the specific files to compare (recursive)
 
837
        :param sepecific_files: the specific files to compare (recursive)
958
838
        :param extra_trees: extra trees to use for mapping paths to file_ids
959
839
        """
960
840
        try:
997
877
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
998
878
 
999
879
            if properties_changed:
1000
 
                prop_str = b" (properties changed: %s)" % (
1001
 
                        b", ".join(properties_changed),)
 
880
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
1002
881
            else:
1003
 
                prop_str = b""
 
882
                prop_str = ""
1004
883
 
1005
884
            if (old_present, new_present) == (True, False):
1006
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1007
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
885
                self.to_file.write("=== removed %s '%s'\n" %
 
886
                                   (kind[0], oldpath_encoded))
1008
887
                newpath = oldpath
1009
888
            elif (old_present, new_present) == (False, True):
1010
 
                self.to_file.write(b"=== added %s '%s'\n" %
1011
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
889
                self.to_file.write("=== added %s '%s'\n" %
 
890
                                   (kind[1], newpath_encoded))
1012
891
                oldpath = newpath
1013
892
            elif renamed:
1014
 
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
1015
 
                    (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
 
893
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
894
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1016
895
            else:
1017
896
                # if it was produced by iter_changes, it must be
1018
897
                # modified *somehow*, either content or execute bit.
1019
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
898
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1020
899
                                   newpath_encoded, prop_str))
1021
900
            if changed_content:
1022
 
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
 
901
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1023
902
                has_changes = 1
1024
903
            if renamed:
1025
904
                has_changes = 1
1032
911
        :param old_path: The path of the file in the old tree
1033
912
        :param new_path: The path of the file in the new tree
1034
913
        """
1035
 
        if old_path is None:
 
914
        try:
 
915
            old_kind = self.old_tree.kind(file_id)
 
916
        except (errors.NoSuchId, errors.NoSuchFile):
1036
917
            old_kind = None
1037
 
        else:
1038
 
            old_kind = self.old_tree.kind(old_path, file_id)
1039
 
        if new_path is None:
 
918
        try:
 
919
            new_kind = self.new_tree.kind(file_id)
 
920
        except (errors.NoSuchId, errors.NoSuchFile):
1040
921
            new_kind = None
1041
 
        else:
1042
 
            new_kind = self.new_tree.kind(new_path, file_id)
1043
 
        self._diff(old_path, new_path, old_kind, new_kind, file_id=file_id)
1044
 
 
1045
 
    def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
 
922
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
923
 
 
924
 
 
925
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1046
926
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1047
 
                                     new_path, old_kind, new_kind)
 
927
                                       new_path, old_kind, new_kind)
1048
928
        if result is DiffPath.CANNOT_DIFF:
1049
929
            error_path = new_path
1050
930
            if error_path is None:
1051
931
                error_path = old_path
1052
932
            raise errors.NoDiffFound(error_path)
1053
 
 
1054
 
 
1055
 
format_registry = Registry()
1056
 
format_registry.register('default', DiffTree)