/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: Ian Clatworthy
  • Date: 2007-08-30 02:00:37 UTC
  • mto: (2772.2.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2774.
  • Revision ID: ian.clatworthy@internode.on.net-20070830020037-lvqrgnm7lbmmcl8y
Incorporate feedback from abentley

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
from bzrlib.trace import mutter
19
 
from bzrlib.errors import BzrError
20
 
from bzrlib.delta import compare_trees
 
17
import difflib
 
18
import os
 
19
import re
 
20
import sys
 
21
 
 
22
from bzrlib.lazy_import import lazy_import
 
23
lazy_import(globals(), """
 
24
import errno
 
25
import subprocess
 
26
import tempfile
 
27
import time
 
28
 
 
29
from bzrlib import (
 
30
    errors,
 
31
    osutils,
 
32
    patiencediff,
 
33
    textfile,
 
34
    timestamp,
 
35
    )
 
36
""")
 
37
 
 
38
from bzrlib.symbol_versioning import (
 
39
        deprecated_function,
 
40
        )
 
41
from bzrlib.trace import mutter, warning
 
42
 
21
43
 
22
44
# TODO: Rather than building a changeset object, we should probably
23
45
# invoke callbacks on an object.  That object can either accumulate a
24
46
# list, write them out directly, etc etc.
25
47
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
 
48
 
 
49
class _PrematchedMatcher(difflib.SequenceMatcher):
 
50
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
51
 
 
52
    def __init__(self, matching_blocks):
 
53
        difflib.SequenceMatcher(self, None, None)
 
54
        self.matching_blocks = matching_blocks
 
55
        self.opcodes = None
 
56
 
 
57
 
 
58
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
59
                  allow_binary=False, sequence_matcher=None,
 
60
                  path_encoding='utf8'):
29
61
    # FIXME: difflib is wrong if there is no trailing newline.
30
62
    # The syntax used by patch seems to be "\ No newline at
31
63
    # end of file" following the last diff line from that
41
73
    # both sequences are empty.
42
74
    if not oldlines and not newlines:
43
75
        return
44
 
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
47
 
 
 
76
    
 
77
    if allow_binary is False:
 
78
        textfile.check_text_lines(oldlines)
 
79
        textfile.check_text_lines(newlines)
 
80
 
 
81
    if sequence_matcher is None:
 
82
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
83
    ud = patiencediff.unified_diff(oldlines, newlines,
 
84
                      fromfile=old_filename.encode(path_encoding),
 
85
                      tofile=new_filename.encode(path_encoding),
 
86
                      sequencematcher=sequence_matcher)
 
87
 
 
88
    ud = list(ud)
48
89
    # work-around for difflib being too smart for its own good
49
90
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
91
    if not oldlines:
51
 
        ud = list(ud)
52
92
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
93
    elif not newlines:
54
 
        ud = list(ud)
55
94
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
95
    # work around for difflib emitting random spaces after the label
 
96
    ud[0] = ud[0][:-2] + '\n'
 
97
    ud[1] = ud[1][:-2] + '\n'
56
98
 
57
99
    for line in ud:
58
100
        to_file.write(line)
61
103
    print >>to_file
62
104
 
63
105
 
64
 
 
65
 
 
66
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
106
def _spawn_external_diff(diffcmd, capture_errors=True):
 
107
    """Spawn the externall diff process, and return the child handle.
 
108
 
 
109
    :param diffcmd: The command list to spawn
 
110
    :param capture_errors: Capture stderr as well as setting LANG=C
 
111
        and LC_ALL=C. This lets us read and understand the output of diff,
 
112
        and respond to any errors.
 
113
    :return: A Popen object.
 
114
    """
 
115
    if capture_errors:
 
116
        # construct minimal environment
 
117
        env = {}
 
118
        path = os.environ.get('PATH')
 
119
        if path is not None:
 
120
            env['PATH'] = path
 
121
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
122
        env['LANG'] = 'C'
 
123
        env['LC_ALL'] = 'C'
 
124
        stderr = subprocess.PIPE
 
125
    else:
 
126
        env = None
 
127
        stderr = None
 
128
 
 
129
    try:
 
130
        pipe = subprocess.Popen(diffcmd,
 
131
                                stdin=subprocess.PIPE,
 
132
                                stdout=subprocess.PIPE,
 
133
                                stderr=stderr,
 
134
                                env=env)
 
135
    except OSError, e:
 
136
        if e.errno == errno.ENOENT:
 
137
            raise errors.NoDiff(str(e))
 
138
        raise
 
139
 
 
140
    return pipe
 
141
 
 
142
 
 
143
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
67
144
                  diff_opts):
68
145
    """Display a diff by calling out to the external diff program."""
69
 
    import sys
70
 
    
71
 
    if to_file != sys.stdout:
72
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
73
 
                                  to_file)
74
 
 
75
146
    # make sure our own output is properly ordered before the diff
76
147
    to_file.flush()
77
148
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    import os
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
 
149
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
150
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
151
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
152
    newtmpf = os.fdopen(newtmp_fd, 'wb')
83
153
 
84
154
    try:
85
155
        # TODO: perhaps a special case for comparing to or from the empty
92
162
        oldtmpf.writelines(oldlines)
93
163
        newtmpf.writelines(newlines)
94
164
 
95
 
        oldtmpf.flush()
96
 
        newtmpf.flush()
 
165
        oldtmpf.close()
 
166
        newtmpf.close()
97
167
 
98
168
        if not diff_opts:
99
169
            diff_opts = []
100
170
        diffcmd = ['diff',
101
 
                   '--label', old_label,
102
 
                   oldtmpf.name,
103
 
                   '--label', new_label,
104
 
                   newtmpf.name]
 
171
                   '--label', old_filename,
 
172
                   old_abspath,
 
173
                   '--label', new_filename,
 
174
                   new_abspath,
 
175
                   '--binary',
 
176
                  ]
105
177
 
106
178
        # diff only allows one style to be specified; they don't override.
107
179
        # note that some of these take optargs, and the optargs can be
127
199
        if diff_opts:
128
200
            diffcmd.extend(diff_opts)
129
201
 
130
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
202
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
203
        out,err = pipe.communicate()
 
204
        rc = pipe.returncode
131
205
        
132
 
        if rc != 0 and rc != 1:
 
206
        # internal_diff() adds a trailing newline, add one here for consistency
 
207
        out += '\n'
 
208
        if rc == 2:
 
209
            # 'diff' gives retcode == 2 for all sorts of errors
 
210
            # one of those is 'Binary files differ'.
 
211
            # Bad options could also be the problem.
 
212
            # 'Binary files' is not a real error, so we suppress that error.
 
213
            lang_c_out = out
 
214
 
 
215
            # Since we got here, we want to make sure to give an i18n error
 
216
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
217
            out, err = pipe.communicate()
 
218
 
 
219
            # Write out the new i18n diff response
 
220
            to_file.write(out+'\n')
 
221
            if pipe.returncode != 2:
 
222
                raise errors.BzrError(
 
223
                               'external diff failed with exit code 2'
 
224
                               ' when run with LANG=C and LC_ALL=C,'
 
225
                               ' but not when run natively: %r' % (diffcmd,))
 
226
 
 
227
            first_line = lang_c_out.split('\n', 1)[0]
 
228
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
229
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
230
            if m is None:
 
231
                raise errors.BzrError('external diff failed with exit code 2;'
 
232
                                      ' command: %r' % (diffcmd,))
 
233
            else:
 
234
                # Binary files differ, just return
 
235
                return
 
236
 
 
237
        # If we got to here, we haven't written out the output of diff
 
238
        # do so now
 
239
        to_file.write(out)
 
240
        if rc not in (0, 1):
133
241
            # returns 1 if files differ; that's OK
134
242
            if rc < 0:
135
243
                msg = 'signal %d' % (-rc)
136
244
            else:
137
245
                msg = 'exit code %d' % rc
138
246
                
139
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
247
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
248
                                  % (rc, diffcmd))
 
249
 
 
250
 
140
251
    finally:
141
252
        oldtmpf.close()                 # and delete
142
253
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None):
147
 
    """Shortcut for showing the diff to the working tree.
148
 
 
149
 
    b
150
 
        Branch.
151
 
 
152
 
    revision
153
 
        None for each, or otherwise the old revision to compare against.
154
 
    
 
254
        # Clean up. Warn in case the files couldn't be deleted
 
255
        # (in case windows still holds the file open, but not
 
256
        # if the files have already been deleted)
 
257
        try:
 
258
            os.remove(old_abspath)
 
259
        except OSError, e:
 
260
            if e.errno not in (errno.ENOENT,):
 
261
                warning('Failed to delete temporary file: %s %s',
 
262
                        old_abspath, e)
 
263
        try:
 
264
            os.remove(new_abspath)
 
265
        except OSError:
 
266
            if e.errno not in (errno.ENOENT,):
 
267
                warning('Failed to delete temporary file: %s %s',
 
268
                        new_abspath, e)
 
269
 
 
270
 
 
271
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
272
                    old_revision_spec=None, new_revision_spec=None,
 
273
                    revision_specs=None,
 
274
                    old_label='a/', new_label='b/'):
 
275
    """Helper for cmd_diff.
 
276
 
 
277
    :param tree:
 
278
        A WorkingTree
 
279
 
 
280
    :param specific_files:
 
281
        The specific files to compare, or None
 
282
 
 
283
    :param external_diff_options:
 
284
        If non-None, run an external diff, and pass it these options
 
285
 
 
286
    :param old_revision_spec:
 
287
        If None, use basis tree as old revision, otherwise use the tree for
 
288
        the specified revision. 
 
289
 
 
290
    :param new_revision_spec:
 
291
        If None, use working tree as new revision, otherwise use the tree for
 
292
        the specified revision.
 
293
    
 
294
    :param revision_specs: 
 
295
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
 
296
        to compare.  This can be passed as an alternative to the old_revision_spec 
 
297
        and new_revision_spec parameters.
 
298
 
155
299
    The more general form is show_diff_trees(), where the caller
156
300
    supplies any two trees.
157
301
    """
158
 
    import sys
159
 
 
160
 
    if revision == None:
161
 
        old_tree = b.basis_tree()
162
 
    else:
163
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
164
 
        
165
 
    new_tree = b.working_tree()
166
 
 
167
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
168
 
                    external_diff_options)
169
 
 
 
302
 
 
303
    # TODO: perhaps remove the old parameters old_revision_spec and
 
304
    # new_revision_spec, since this is only really for use from cmd_diff and
 
305
    # it now always passes through a sequence of revision_specs -- mbp
 
306
    # 20061221
 
307
 
 
308
    def spec_tree(spec):
 
309
        if tree:
 
310
            revision = spec.in_store(tree.branch)
 
311
        else:
 
312
            revision = spec.in_store(None)
 
313
        revision_id = revision.rev_id
 
314
        branch = revision.branch
 
315
        return branch.repository.revision_tree(revision_id)
 
316
 
 
317
    if revision_specs is not None:
 
318
        assert (old_revision_spec is None
 
319
                and new_revision_spec is None)
 
320
        if len(revision_specs) > 0:
 
321
            old_revision_spec = revision_specs[0]
 
322
        if len(revision_specs) > 1:
 
323
            new_revision_spec = revision_specs[1]
 
324
 
 
325
    if old_revision_spec is None:
 
326
        old_tree = tree.basis_tree()
 
327
    else:
 
328
        old_tree = spec_tree(old_revision_spec)
 
329
 
 
330
    if (new_revision_spec is None
 
331
        or new_revision_spec.spec is None):
 
332
        new_tree = tree
 
333
    else:
 
334
        new_tree = spec_tree(new_revision_spec)
 
335
 
 
336
    if new_tree is not tree:
 
337
        extra_trees = (tree,)
 
338
    else:
 
339
        extra_trees = None
 
340
 
 
341
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
342
                           external_diff_options,
 
343
                           old_label=old_label, new_label=new_label,
 
344
                           extra_trees=extra_trees)
170
345
 
171
346
 
172
347
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
 
                    external_diff_options=None):
 
348
                    external_diff_options=None,
 
349
                    old_label='a/', new_label='b/',
 
350
                    extra_trees=None):
174
351
    """Show in text form the changes from one tree to another.
175
352
 
176
353
    to_files
178
355
 
179
356
    external_diff_options
180
357
        If set, use an external GNU diff and pass these options.
 
358
 
 
359
    extra_trees
 
360
        If set, more Trees to use for looking up file ids
181
361
    """
182
 
 
183
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
184
 
    old_label = ''
185
 
    new_label = ''
186
 
 
187
 
    DEVNULL = '/dev/null'
188
 
    # Windows users, don't panic about this filename -- it is a
189
 
    # special signal to GNU patch that the file should be created or
190
 
    # deleted respectively.
 
362
    old_tree.lock_read()
 
363
    try:
 
364
        if extra_trees is not None:
 
365
            for tree in extra_trees:
 
366
                tree.lock_read()
 
367
        new_tree.lock_read()
 
368
        try:
 
369
            return _show_diff_trees(old_tree, new_tree, to_file,
 
370
                                    specific_files, external_diff_options,
 
371
                                    old_label=old_label, new_label=new_label,
 
372
                                    extra_trees=extra_trees)
 
373
        finally:
 
374
            new_tree.unlock()
 
375
            if extra_trees is not None:
 
376
                for tree in extra_trees:
 
377
                    tree.unlock()
 
378
    finally:
 
379
        old_tree.unlock()
 
380
 
 
381
 
 
382
def _show_diff_trees(old_tree, new_tree, to_file,
 
383
                     specific_files, external_diff_options, 
 
384
                     old_label='a/', new_label='b/', extra_trees=None):
 
385
 
 
386
    # GNU Patch uses the epoch date to detect files that are being added
 
387
    # or removed in a diff.
 
388
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
191
389
 
192
390
    # TODO: Generation of pseudo-diffs for added/deleted files could
193
391
    # be usefully made into a much faster special case.
200
398
    else:
201
399
        diff_file = internal_diff
202
400
    
203
 
 
204
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
 
                          specific_files=specific_files)
206
 
 
 
401
    delta = new_tree.changes_from(old_tree,
 
402
        specific_files=specific_files,
 
403
        extra_trees=extra_trees, require_versioned=True)
 
404
 
 
405
    has_changes = 0
207
406
    for path, file_id, kind in delta.removed:
208
 
        print >>to_file, '*** removed %s %r' % (kind, path)
209
 
        if kind == 'file':
210
 
            diff_file(old_label + path,
211
 
                      old_tree.get_file(file_id).readlines(),
212
 
                      DEVNULL, 
213
 
                      [],
214
 
                      to_file)
215
 
 
 
407
        has_changes = 1
 
408
        print >>to_file, "=== removed %s '%s'" % (kind, path.encode('utf8'))
 
409
        old_name = '%s%s\t%s' % (old_label, path,
 
410
                                 _patch_header_date(old_tree, file_id, path))
 
411
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
412
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
413
                                         new_name, None, None, to_file)
216
414
    for path, file_id, kind in delta.added:
217
 
        print >>to_file, '*** added %s %r' % (kind, path)
218
 
        if kind == 'file':
219
 
            diff_file(DEVNULL,
220
 
                      [],
221
 
                      new_label + path,
222
 
                      new_tree.get_file(file_id).readlines(),
223
 
                      to_file)
224
 
 
225
 
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
226
 
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
415
        has_changes = 1
 
416
        print >>to_file, "=== added %s '%s'" % (kind, path.encode('utf8'))
 
417
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
418
        new_name = '%s%s\t%s' % (new_label, path,
 
419
                                 _patch_header_date(new_tree, file_id, path))
 
420
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
421
                                         old_name, None, None, to_file, 
 
422
                                         reverse=True)
 
423
    for (old_path, new_path, file_id, kind,
 
424
         text_modified, meta_modified) in delta.renamed:
 
425
        has_changes = 1
 
426
        prop_str = get_prop_change(meta_modified)
 
427
        print >>to_file, "=== renamed %s '%s' => '%s'%s" % (
 
428
                    kind, old_path.encode('utf8'),
 
429
                    new_path.encode('utf8'), prop_str)
 
430
        old_name = '%s%s\t%s' % (old_label, old_path,
 
431
                                 _patch_header_date(old_tree, file_id,
 
432
                                                    old_path))
 
433
        new_name = '%s%s\t%s' % (new_label, new_path,
 
434
                                 _patch_header_date(new_tree, file_id,
 
435
                                                    new_path))
 
436
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
437
                                    new_name, new_tree,
 
438
                                    text_modified, kind, to_file, diff_file)
 
439
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
440
        has_changes = 1
 
441
        prop_str = get_prop_change(meta_modified)
 
442
        print >>to_file, "=== modified %s '%s'%s" % (kind, path.encode('utf8'),
 
443
                                                     prop_str)
 
444
        # The file may be in a different location in the old tree (because
 
445
        # the containing dir was renamed, but the file itself was not)
 
446
        old_path = old_tree.id2path(file_id)
 
447
        old_name = '%s%s\t%s' % (old_label, old_path,
 
448
                                 _patch_header_date(old_tree, file_id, old_path))
 
449
        new_name = '%s%s\t%s' % (new_label, path,
 
450
                                 _patch_header_date(new_tree, file_id, path))
227
451
        if text_modified:
228
 
            diff_file(old_label + old_path,
229
 
                      old_tree.get_file(file_id).readlines(),
230
 
                      new_label + new_path,
231
 
                      new_tree.get_file(file_id).readlines(),
232
 
                      to_file)
233
 
 
234
 
    for path, file_id, kind in delta.modified:
235
 
        print >>to_file, '*** modified %s %r' % (kind, path)
236
 
        if kind == 'file':
237
 
            diff_file(old_label + path,
238
 
                      old_tree.get_file(file_id).readlines(),
239
 
                      new_label + path,
240
 
                      new_tree.get_file(file_id).readlines(),
241
 
                      to_file)
242
 
 
243
 
 
244
 
 
245
 
 
246
 
 
 
452
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
453
                                        new_name, new_tree,
 
454
                                        True, kind, to_file, diff_file)
 
455
 
 
456
    return has_changes
 
457
 
 
458
 
 
459
def _patch_header_date(tree, file_id, path):
 
460
    """Returns a timestamp suitable for use in a patch header."""
 
461
    mtime = tree.get_file_mtime(file_id, path)
 
462
    assert mtime is not None, \
 
463
        "got an mtime of None for file-id %s, path %s in tree %s" % (
 
464
                file_id, path, tree)
 
465
    return timestamp.format_patch_date(mtime)
 
466
 
 
467
 
 
468
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
469
    """Complain if paths are not in either inventory or tree.
 
470
 
 
471
    It's OK with the files exist in either tree's inventory, or 
 
472
    if they exist in the tree but are not versioned.
 
473
    
 
474
    This can be used by operations such as bzr status that can accept
 
475
    unknown or ignored files.
 
476
    """
 
477
    mutter("check paths: %r", paths)
 
478
    if not paths:
 
479
        return
 
480
    s = old_tree.filter_unversioned_files(paths)
 
481
    s = new_tree.filter_unversioned_files(s)
 
482
    s = [path for path in s if not new_tree.has_filename(path)]
 
483
    if s:
 
484
        raise errors.PathsDoNotExist(sorted(s))
 
485
 
 
486
 
 
487
def get_prop_change(meta_modified):
 
488
    if meta_modified:
 
489
        return " (properties changed)"
 
490
    else:
 
491
        return  ""
 
492
 
 
493
 
 
494
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
495
                                new_path, new_tree, text_modified,
 
496
                                kind, to_file, diff_file):
 
497
    if text_modified:
 
498
        new_entry = new_tree.inventory[file_id]
 
499
        old_tree.inventory[file_id].diff(diff_file,
 
500
                                         old_path, old_tree,
 
501
                                         new_path, new_entry, 
 
502
                                         new_tree, to_file)