← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

Compare URLs in RemoteRepository.__eq__, rather than '_client' attributes.

Show diffs side-by-side

added added

removed removed

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