/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-31 19:15:36 UTC
  • mto: (1900.2.1 bzr.merge.54651)
  • mto: This revision was merged to the branch mainline in revision 1903.
  • Revision ID: john@arbash-meinel.com-20060731191536-ca772e434471e8cf
internal_diff always adds a trailing \n, make sure external_diff does too

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 external_diff(old_filename, oldlines, new_filename, newlines, to_file,
67
92
                  diff_opts):
68
93
    """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
94
    # make sure our own output is properly ordered before the diff
76
95
    to_file.flush()
77
96
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    import os
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
 
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')
83
101
 
84
102
    try:
85
103
        # TODO: perhaps a special case for comparing to or from the empty
92
110
        oldtmpf.writelines(oldlines)
93
111
        newtmpf.writelines(newlines)
94
112
 
95
 
        oldtmpf.flush()
96
 
        newtmpf.flush()
 
113
        oldtmpf.close()
 
114
        newtmpf.close()
97
115
 
98
116
        if not diff_opts:
99
117
            diff_opts = []
100
118
        diffcmd = ['diff',
101
 
                   '--label', old_label,
102
 
                   oldtmpf.name,
103
 
                   '--label', new_label,
104
 
                   newtmpf.name]
 
119
                   '--label', old_filename,
 
120
                   old_abspath,
 
121
                   '--label', new_filename,
 
122
                   new_abspath,
 
123
                   '--binary',
 
124
                  ]
105
125
 
106
126
        # diff only allows one style to be specified; they don't override.
107
127
        # note that some of these take optargs, and the optargs can be
127
147
        if diff_opts:
128
148
            diffcmd.extend(diff_opts)
129
149
 
130
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
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()
131
164
        
132
 
        if rc != 0 and rc != 1:
 
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):
133
175
            # returns 1 if files differ; that's OK
134
176
            if rc < 0:
135
177
                msg = 'signal %d' % (-rc)
136
178
            else:
137
179
                msg = 'exit code %d' % rc
138
180
                
139
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
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
 
140
187
    finally:
141
188
        oldtmpf.close()                 # and delete
142
189
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None):
 
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)
 
208
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
209
              revision2=None, output=None, b2=None):
147
210
    """Shortcut for showing the diff to the working tree.
148
211
 
 
212
    Please use show_diff_trees instead.
 
213
 
149
214
    b
150
215
        Branch.
151
216
 
152
217
    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
 
 
 
218
        None for 'basis tree', or otherwise the old revision to compare against.
 
219
    
 
220
    The more general form is show_diff_trees(), where the caller
 
221
    supplies any two trees.
 
222
    """
 
223
    if output is None:
 
224
        output = sys.stdout
 
225
 
 
226
    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()
 
230
    else:
 
231
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
232
 
 
233
    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)
170
296
 
171
297
 
172
298
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
173
 
                    external_diff_options=None):
 
299
                    external_diff_options=None,
 
300
                    old_label='a/', new_label='b/',
 
301
                    extra_trees=None):
174
302
    """Show in text form the changes from one tree to another.
175
303
 
176
304
    to_files
178
306
 
179
307
    external_diff_options
180
308
        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
181
312
    """
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.
 
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'
191
334
 
192
335
    # TODO: Generation of pseudo-diffs for added/deleted files could
193
336
    # be usefully made into a much faster special case.
200
343
    else:
201
344
        diff_file = internal_diff
202
345
    
203
 
 
204
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
205
 
                          specific_files=specific_files)
206
 
 
 
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
207
351
    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
 
 
 
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)
216
359
    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)
 
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, 
 
367
                                         reverse=True)
 
368
    for (old_path, new_path, file_id, kind,
 
369
         text_modified, meta_modified) in delta.renamed:
 
370
        has_changes = 1
 
371
        prop_str = get_prop_change(meta_modified)
 
372
        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,
 
383
                                    text_modified, kind, to_file, diff_file)
 
384
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
385
        has_changes = 1
 
386
        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))
227
392
        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
 
 
 
393
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
394
                                        new_name, new_tree,
 
395
                                        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
    
 
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
 
 
425
def get_prop_change(meta_modified):
 
426
    if meta_modified:
 
427
        return " (properties changed)"
 
428
    else:
 
429
        return  ""
 
430
 
 
431
 
 
432
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
433
                                new_path, new_tree, text_modified,
 
434
                                kind, to_file, diff_file):
 
435
    if text_modified:
 
436
        new_entry = new_tree.inventory[file_id]
 
437
        old_tree.inventory[file_id].diff(diff_file,
 
438
                                         old_path, old_tree,
 
439
                                         new_path, new_entry, 
 
440
                                         new_tree, to_file)