/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-10 23:00:44 UTC
  • mto: This revision was merged to the branch mainline in revision 1854.
  • Revision ID: john@arbash-meinel.com-20060710230044-8bbfddd920940ffe
new env var 'BZR_PROGRESS_BAR' to select the exact progress type

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
    output = sys.stdout
 
260
    def spec_tree(spec):
 
261
        revision_id = spec.in_store(tree.branch).rev_id
 
262
        return tree.branch.repository.revision_tree(revision_id)
 
263
    if old_revision_spec is None:
 
264
        old_tree = tree.basis_tree()
 
265
    else:
 
266
        old_tree = spec_tree(old_revision_spec)
 
267
 
 
268
    if new_revision_spec is None:
 
269
        new_tree = tree
 
270
    else:
 
271
        new_tree = spec_tree(new_revision_spec)
 
272
    if new_tree is not tree:
 
273
        extra_trees = (tree,)
 
274
    else:
 
275
        extra_trees = None
 
276
 
 
277
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
278
                           external_diff_options,
 
279
                           old_label=old_label, new_label=new_label,
 
280
                           extra_trees=extra_trees)
 
281
 
 
282
 
 
283
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
284
                    external_diff_options=None,
 
285
                    old_label='a/', new_label='b/',
 
286
                    extra_trees=None):
 
287
    """Show in text form the changes from one tree to another.
 
288
 
 
289
    to_files
 
290
        If set, include only changes to these files.
 
291
 
 
292
    external_diff_options
 
293
        If set, use an external GNU diff and pass these options.
 
294
 
 
295
    extra_trees
 
296
        If set, more Trees to use for looking up file ids
 
297
    """
 
298
    old_tree.lock_read()
 
299
    try:
 
300
        new_tree.lock_read()
 
301
        try:
 
302
            return _show_diff_trees(old_tree, new_tree, to_file,
 
303
                                    specific_files, external_diff_options,
 
304
                                    old_label=old_label, new_label=new_label,
 
305
                                    extra_trees=extra_trees)
 
306
        finally:
 
307
            new_tree.unlock()
 
308
    finally:
 
309
        old_tree.unlock()
 
310
 
 
311
 
 
312
def _show_diff_trees(old_tree, new_tree, to_file,
 
313
                     specific_files, external_diff_options, 
 
314
                     old_label='a/', new_label='b/', extra_trees=None):
 
315
 
 
316
    # GNU Patch uses the epoch date to detect files that are being added
 
317
    # or removed in a diff.
 
318
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
319
 
 
320
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
321
    # be usefully made into a much faster special case.
 
322
 
 
323
    if external_diff_options:
 
324
        assert isinstance(external_diff_options, basestring)
 
325
        opts = external_diff_options.split()
 
326
        def diff_file(olab, olines, nlab, nlines, to_file):
 
327
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
328
    else:
 
329
        diff_file = internal_diff
 
330
    
 
331
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
332
                          specific_files=specific_files, 
 
333
                          extra_trees=extra_trees, require_versioned=True)
 
334
 
 
335
    has_changes = 0
 
336
    for path, file_id, kind in delta.removed:
 
337
        has_changes = 1
 
338
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
339
        old_name = '%s%s\t%s' % (old_label, path,
 
340
                                 _patch_header_date(old_tree, file_id, path))
 
341
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
342
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
343
                                         new_name, None, None, to_file)
 
344
    for path, file_id, kind in delta.added:
 
345
        has_changes = 1
 
346
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
347
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
348
        new_name = '%s%s\t%s' % (new_label, path,
 
349
                                 _patch_header_date(new_tree, file_id, path))
 
350
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
351
                                         old_name, None, None, to_file, 
 
352
                                         reverse=True)
 
353
    for (old_path, new_path, file_id, kind,
 
354
         text_modified, meta_modified) in delta.renamed:
 
355
        has_changes = 1
 
356
        prop_str = get_prop_change(meta_modified)
 
357
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
358
                    kind, old_path.encode('utf8'),
 
359
                    new_path.encode('utf8'), prop_str)
 
360
        old_name = '%s%s\t%s' % (old_label, old_path,
 
361
                                 _patch_header_date(old_tree, file_id,
 
362
                                                    old_path))
 
363
        new_name = '%s%s\t%s' % (new_label, new_path,
 
364
                                 _patch_header_date(new_tree, file_id,
 
365
                                                    new_path))
 
366
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
367
                                    new_name, new_tree,
 
368
                                    text_modified, kind, to_file, diff_file)
 
369
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
370
        has_changes = 1
 
371
        prop_str = get_prop_change(meta_modified)
 
372
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
373
        old_name = '%s%s\t%s' % (old_label, path,
 
374
                                 _patch_header_date(old_tree, file_id, path))
 
375
        new_name = '%s%s\t%s' % (new_label, path,
 
376
                                 _patch_header_date(new_tree, file_id, path))
 
377
        if text_modified:
 
378
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
379
                                        new_name, new_tree,
 
380
                                        True, kind, to_file, diff_file)
 
381
 
 
382
    return has_changes
 
383
 
 
384
 
 
385
def _patch_header_date(tree, file_id, path):
 
386
    """Returns a timestamp suitable for use in a patch header."""
 
387
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
 
388
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
 
389
 
 
390
 
 
391
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
392
    """Complain if paths are not in either inventory or tree.
 
393
 
 
394
    It's OK with the files exist in either tree's inventory, or 
 
395
    if they exist in the tree but are not versioned.
 
396
    
 
397
    This can be used by operations such as bzr status that can accept
 
398
    unknown or ignored files.
 
399
    """
 
400
    mutter("check paths: %r", paths)
 
401
    if not paths:
 
402
        return
 
403
    s = old_tree.filter_unversioned_files(paths)
 
404
    s = new_tree.filter_unversioned_files(s)
 
405
    s = [path for path in s if not new_tree.has_filename(path)]
 
406
    if s:
 
407
        raise errors.PathsDoNotExist(sorted(s))
 
408
 
 
409
 
 
410
def get_prop_change(meta_modified):
 
411
    if meta_modified:
 
412
        return " (properties changed)"
 
413
    else:
 
414
        return  ""
 
415
 
 
416
 
 
417
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
418
                                new_path, new_tree, text_modified,
 
419
                                kind, to_file, diff_file):
 
420
    if text_modified:
 
421
        new_entry = new_tree.inventory[file_id]
 
422
        old_tree.inventory[file_id].diff(diff_file,
 
423
                                         old_path, old_tree,
 
424
                                         new_path, new_entry, 
 
425
                                         new_tree, to_file)