/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: 2006-07-12 02:49:48 UTC
  • mto: (1946.2.6 reduce-knit-churn)
  • mto: This revision was merged to the branch mainline in revision 1855.
  • Revision ID: john@arbash-meinel.com-20060712024948-162ebe6b4b9985bf
Restore logging of full traceback. Helps with debugging tests.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import errno
 
18
import os
 
19
import subprocess
 
20
import sys
 
21
import tempfile
 
22
import time
 
23
 
 
24
from bzrlib.delta import compare_trees
 
25
from bzrlib.errors import BzrError
 
26
import bzrlib.errors as errors
 
27
import bzrlib.osutils
 
28
from bzrlib.patiencediff import unified_diff
 
29
import bzrlib.patiencediff
 
30
from bzrlib.symbol_versioning import (deprecated_function,
 
31
        zero_eight)
 
32
from bzrlib.textfile import check_text_lines
 
33
from bzrlib.trace import mutter, warning
 
34
 
 
35
 
 
36
# TODO: Rather than building a changeset object, we should probably
 
37
# invoke callbacks on an object.  That object can either accumulate a
 
38
# list, write them out directly, etc etc.
 
39
 
 
40
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
41
                  allow_binary=False, sequence_matcher=None,
 
42
                  path_encoding='utf8'):
 
43
    # FIXME: difflib is wrong if there is no trailing newline.
 
44
    # The syntax used by patch seems to be "\ No newline at
 
45
    # end of file" following the last diff line from that
 
46
    # file.  This is not trivial to insert into the
 
47
    # unified_diff output and it might be better to just fix
 
48
    # or replace that function.
 
49
 
 
50
    # In the meantime we at least make sure the patch isn't
 
51
    # mangled.
 
52
 
 
53
 
 
54
    # Special workaround for Python2.3, where difflib fails if
 
55
    # both sequences are empty.
 
56
    if not oldlines and not newlines:
 
57
        return
 
58
    
 
59
    if allow_binary is False:
 
60
        check_text_lines(oldlines)
 
61
        check_text_lines(newlines)
 
62
 
 
63
    if sequence_matcher is None:
 
64
        sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
65
    ud = unified_diff(oldlines, newlines,
 
66
                      fromfile=old_filename.encode(path_encoding),
 
67
                      tofile=new_filename.encode(path_encoding),
 
68
                      sequencematcher=sequence_matcher)
 
69
 
 
70
    ud = list(ud)
 
71
    # work-around for difflib being too smart for its own good
 
72
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
73
    if not oldlines:
 
74
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
75
    elif not newlines:
 
76
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
77
    # work around for difflib emitting random spaces after the label
 
78
    ud[0] = ud[0][:-2] + '\n'
 
79
    ud[1] = ud[1][:-2] + '\n'
 
80
 
 
81
    for line in ud:
 
82
        to_file.write(line)
 
83
        if not line.endswith('\n'):
 
84
            to_file.write("\n\\ No newline at end of file\n")
 
85
    print >>to_file
 
86
 
 
87
 
 
88
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
89
                  diff_opts):
 
90
    """Display a diff by calling out to the external diff program."""
 
91
    if hasattr(to_file, 'fileno'):
 
92
        out_file = to_file
 
93
        have_fileno = True
 
94
    else:
 
95
        out_file = subprocess.PIPE
 
96
        have_fileno = False
 
97
    
 
98
    # make sure our own output is properly ordered before the diff
 
99
    to_file.flush()
 
100
 
 
101
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
102
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
103
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
104
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
105
 
 
106
    try:
 
107
        # TODO: perhaps a special case for comparing to or from the empty
 
108
        # sequence; can just use /dev/null on Unix
 
109
 
 
110
        # TODO: if either of the files being compared already exists as a
 
111
        # regular named file (e.g. in the working directory) then we can
 
112
        # compare directly to that, rather than copying it.
 
113
 
 
114
        oldtmpf.writelines(oldlines)
 
115
        newtmpf.writelines(newlines)
 
116
 
 
117
        oldtmpf.close()
 
118
        newtmpf.close()
 
119
 
 
120
        if not diff_opts:
 
121
            diff_opts = []
 
122
        diffcmd = ['diff',
 
123
                   '--label', old_filename,
 
124
                   old_abspath,
 
125
                   '--label', new_filename,
 
126
                   new_abspath,
 
127
                   '--binary',
 
128
                  ]
 
129
 
 
130
        # diff only allows one style to be specified; they don't override.
 
131
        # note that some of these take optargs, and the optargs can be
 
132
        # directly appended to the options.
 
133
        # this is only an approximate parser; it doesn't properly understand
 
134
        # the grammar.
 
135
        for s in ['-c', '-u', '-C', '-U',
 
136
                  '-e', '--ed',
 
137
                  '-q', '--brief',
 
138
                  '--normal',
 
139
                  '-n', '--rcs',
 
140
                  '-y', '--side-by-side',
 
141
                  '-D', '--ifdef']:
 
142
            for j in diff_opts:
 
143
                if j.startswith(s):
 
144
                    break
 
145
            else:
 
146
                continue
 
147
            break
 
148
        else:
 
149
            diffcmd.append('-u')
 
150
                  
 
151
        if diff_opts:
 
152
            diffcmd.extend(diff_opts)
 
153
 
 
154
        try:
 
155
            pipe = subprocess.Popen(diffcmd,
 
156
                                    stdin=subprocess.PIPE,
 
157
                                    stdout=out_file)
 
158
        except OSError, e:
 
159
            if e.errno == errno.ENOENT:
 
160
                raise errors.NoDiff(str(e))
 
161
            raise
 
162
        pipe.stdin.close()
 
163
 
 
164
        if not have_fileno:
 
165
            bzrlib.osutils.pumpfile(pipe.stdout, to_file)
 
166
        rc = pipe.wait()
 
167
        
 
168
        if rc != 0 and rc != 1:
 
169
            # returns 1 if files differ; that's OK
 
170
            if rc < 0:
 
171
                msg = 'signal %d' % (-rc)
 
172
            else:
 
173
                msg = 'exit code %d' % rc
 
174
                
 
175
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
176
    finally:
 
177
        oldtmpf.close()                 # and delete
 
178
        newtmpf.close()
 
179
        # Clean up. Warn in case the files couldn't be deleted
 
180
        # (in case windows still holds the file open, but not
 
181
        # if the files have already been deleted)
 
182
        try:
 
183
            os.remove(old_abspath)
 
184
        except OSError, e:
 
185
            if e.errno not in (errno.ENOENT,):
 
186
                warning('Failed to delete temporary file: %s %s',
 
187
                        old_abspath, e)
 
188
        try:
 
189
            os.remove(new_abspath)
 
190
        except OSError:
 
191
            if e.errno not in (errno.ENOENT,):
 
192
                warning('Failed to delete temporary file: %s %s',
 
193
                        new_abspath, e)
 
194
 
 
195
 
 
196
@deprecated_function(zero_eight)
 
197
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
198
              revision2=None, output=None, b2=None):
 
199
    """Shortcut for showing the diff to the working tree.
 
200
 
 
201
    Please use show_diff_trees instead.
 
202
 
 
203
    b
 
204
        Branch.
 
205
 
 
206
    revision
 
207
        None for 'basis tree', or otherwise the old revision to compare against.
 
208
    
 
209
    The more general form is show_diff_trees(), where the caller
 
210
    supplies any two trees.
 
211
    """
 
212
    if output is None:
 
213
        output = sys.stdout
 
214
 
 
215
    if from_spec is None:
 
216
        old_tree = b.bzrdir.open_workingtree()
 
217
        if b2 is None:
 
218
            old_tree = old_tree = old_tree.basis_tree()
 
219
    else:
 
220
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
221
 
 
222
    if revision2 is None:
 
223
        if b2 is None:
 
224
            new_tree = b.bzrdir.open_workingtree()
 
225
        else:
 
226
            new_tree = b2.bzrdir.open_workingtree()
 
227
    else:
 
228
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
229
 
 
230
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
231
                           external_diff_options)
 
232
 
 
233
 
 
234
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
235
                    old_revision_spec=None, new_revision_spec=None,
 
236
                    old_label='a/', new_label='b/'):
 
237
    """Helper for cmd_diff.
 
238
 
 
239
   tree 
 
240
        A WorkingTree
 
241
 
 
242
    specific_files
 
243
        The specific files to compare, or None
 
244
 
 
245
    external_diff_options
 
246
        If non-None, run an external diff, and pass it these options
 
247
 
 
248
    old_revision_spec
 
249
        If None, use basis tree as old revision, otherwise use the tree for
 
250
        the specified revision. 
 
251
 
 
252
    new_revision_spec
 
253
        If None, use working tree as new revision, otherwise use the tree for
 
254
        the specified revision.
 
255
    
 
256
    The more general form is show_diff_trees(), where the caller
 
257
    supplies any two trees.
 
258
    """
 
259
    def spec_tree(spec):
 
260
        revision_id = spec.in_store(tree.branch).rev_id
 
261
        return tree.branch.repository.revision_tree(revision_id)
 
262
    if old_revision_spec is None:
 
263
        old_tree = tree.basis_tree()
 
264
    else:
 
265
        old_tree = spec_tree(old_revision_spec)
 
266
 
 
267
    if new_revision_spec is None:
 
268
        new_tree = tree
 
269
    else:
 
270
        new_tree = spec_tree(new_revision_spec)
 
271
    if new_tree is not tree:
 
272
        extra_trees = (tree,)
 
273
    else:
 
274
        extra_trees = None
 
275
 
 
276
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
277
                           external_diff_options,
 
278
                           old_label=old_label, new_label=new_label,
 
279
                           extra_trees=extra_trees)
 
280
 
 
281
 
 
282
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
283
                    external_diff_options=None,
 
284
                    old_label='a/', new_label='b/',
 
285
                    extra_trees=None):
 
286
    """Show in text form the changes from one tree to another.
 
287
 
 
288
    to_files
 
289
        If set, include only changes to these files.
 
290
 
 
291
    external_diff_options
 
292
        If set, use an external GNU diff and pass these options.
 
293
 
 
294
    extra_trees
 
295
        If set, more Trees to use for looking up file ids
 
296
    """
 
297
    old_tree.lock_read()
 
298
    try:
 
299
        new_tree.lock_read()
 
300
        try:
 
301
            return _show_diff_trees(old_tree, new_tree, to_file,
 
302
                                    specific_files, external_diff_options,
 
303
                                    old_label=old_label, new_label=new_label,
 
304
                                    extra_trees=extra_trees)
 
305
        finally:
 
306
            new_tree.unlock()
 
307
    finally:
 
308
        old_tree.unlock()
 
309
 
 
310
 
 
311
def _show_diff_trees(old_tree, new_tree, to_file,
 
312
                     specific_files, external_diff_options, 
 
313
                     old_label='a/', new_label='b/', extra_trees=None):
 
314
 
 
315
    # GNU Patch uses the epoch date to detect files that are being added
 
316
    # or removed in a diff.
 
317
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
318
 
 
319
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
320
    # be usefully made into a much faster special case.
 
321
 
 
322
    if external_diff_options:
 
323
        assert isinstance(external_diff_options, basestring)
 
324
        opts = external_diff_options.split()
 
325
        def diff_file(olab, olines, nlab, nlines, to_file):
 
326
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
327
    else:
 
328
        diff_file = internal_diff
 
329
    
 
330
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
331
                          specific_files=specific_files, 
 
332
                          extra_trees=extra_trees, require_versioned=True)
 
333
 
 
334
    has_changes = 0
 
335
    for path, file_id, kind in delta.removed:
 
336
        has_changes = 1
 
337
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
338
        old_name = '%s%s\t%s' % (old_label, path,
 
339
                                 _patch_header_date(old_tree, file_id, path))
 
340
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
341
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
342
                                         new_name, None, None, to_file)
 
343
    for path, file_id, kind in delta.added:
 
344
        has_changes = 1
 
345
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
346
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
347
        new_name = '%s%s\t%s' % (new_label, path,
 
348
                                 _patch_header_date(new_tree, file_id, path))
 
349
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
350
                                         old_name, None, None, to_file, 
 
351
                                         reverse=True)
 
352
    for (old_path, new_path, file_id, kind,
 
353
         text_modified, meta_modified) in delta.renamed:
 
354
        has_changes = 1
 
355
        prop_str = get_prop_change(meta_modified)
 
356
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
357
                    kind, old_path.encode('utf8'),
 
358
                    new_path.encode('utf8'), prop_str)
 
359
        old_name = '%s%s\t%s' % (old_label, old_path,
 
360
                                 _patch_header_date(old_tree, file_id,
 
361
                                                    old_path))
 
362
        new_name = '%s%s\t%s' % (new_label, new_path,
 
363
                                 _patch_header_date(new_tree, file_id,
 
364
                                                    new_path))
 
365
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
366
                                    new_name, new_tree,
 
367
                                    text_modified, kind, to_file, diff_file)
 
368
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
369
        has_changes = 1
 
370
        prop_str = get_prop_change(meta_modified)
 
371
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
372
        old_name = '%s%s\t%s' % (old_label, path,
 
373
                                 _patch_header_date(old_tree, file_id, path))
 
374
        new_name = '%s%s\t%s' % (new_label, path,
 
375
                                 _patch_header_date(new_tree, file_id, path))
 
376
        if text_modified:
 
377
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
378
                                        new_name, new_tree,
 
379
                                        True, kind, to_file, diff_file)
 
380
 
 
381
    return has_changes
 
382
 
 
383
 
 
384
def _patch_header_date(tree, file_id, path):
 
385
    """Returns a timestamp suitable for use in a patch header."""
 
386
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
 
387
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
 
388
 
 
389
 
 
390
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
391
    """Complain if paths are not in either inventory or tree.
 
392
 
 
393
    It's OK with the files exist in either tree's inventory, or 
 
394
    if they exist in the tree but are not versioned.
 
395
    
 
396
    This can be used by operations such as bzr status that can accept
 
397
    unknown or ignored files.
 
398
    """
 
399
    mutter("check paths: %r", paths)
 
400
    if not paths:
 
401
        return
 
402
    s = old_tree.filter_unversioned_files(paths)
 
403
    s = new_tree.filter_unversioned_files(s)
 
404
    s = [path for path in s if not new_tree.has_filename(path)]
 
405
    if s:
 
406
        raise errors.PathsDoNotExist(sorted(s))
 
407
 
 
408
 
 
409
def get_prop_change(meta_modified):
 
410
    if meta_modified:
 
411
        return " (properties changed)"
 
412
    else:
 
413
        return  ""
 
414
 
 
415
 
 
416
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
417
                                new_path, new_tree, text_modified,
 
418
                                kind, to_file, diff_file):
 
419
    if text_modified:
 
420
        new_entry = new_tree.inventory[file_id]
 
421
        old_tree.inventory[file_id].diff(diff_file,
 
422
                                         old_path, old_tree,
 
423
                                         new_path, new_entry, 
 
424
                                         new_tree, to_file)