/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: Robey Pointer
  • Date: 2006-09-08 18:52:17 UTC
  • mfrom: (1993 +trunk)
  • mto: This revision was merged to the branch mainline in revision 1996.
  • Revision ID: robey@lag.net-20060908185217-6a4406e1d41753f5
merge from bzr.dev

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