~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2005-10-11 04:32:38 UTC
  • mto: This revision was merged to the branch mainline in revision 1443.
  • Revision ID: robertc@robertcollins.net-20051011043238-104295a8eb7eba91
move config_dir into bzrlib.config

Show diffs side-by-side

added added

removed removed

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