← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2009-03-03 03:27:51 UTC
  • mto: (4070.2.5 integration)
  • mto: This revision was merged to the branch mainline in revision 4075.
  • Revision ID: robertc@robertcollins.net-20090303032751-ubyfhezgjul6y5ic
Get BzrDir.cloning_metadir working.

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
19
 
from bzrlib.errors import BzrError
20
 
from bzrlib.delta import compare_trees
 
17
import difflib
 
18
import os
 
19
import re
 
20
import shutil
 
21
import sys
 
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
import errno
 
26
import subprocess
 
27
import tempfile
 
28
import time
 
29
 
 
30
from bzrlib import (
 
31
    branch as _mod_branch,
 
32
    bzrdir,
 
33
    commands,
 
34
    errors,
 
35
    osutils,
 
36
    patiencediff,
 
37
    textfile,
 
38
    timestamp,
 
39
    views,
 
40
    )
 
41
""")
 
42
 
 
43
from bzrlib.symbol_versioning import (
 
44
        deprecated_function,
 
45
        one_three
 
46
        )
 
47
from bzrlib.trace import mutter, note, warning
 
48
 
21
49
 
22
50
# TODO: Rather than building a changeset object, we should probably
23
51
# invoke callbacks on an object.  That object can either accumulate a
24
52
# list, write them out directly, etc etc.
25
53
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
 
54
 
 
55
class _PrematchedMatcher(difflib.SequenceMatcher):
 
56
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
57
 
 
58
    def __init__(self, matching_blocks):
 
59
        difflib.SequenceMatcher(self, None, None)
 
60
        self.matching_blocks = matching_blocks
 
61
        self.opcodes = None
 
62
 
 
63
 
 
64
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
65
                  allow_binary=False, sequence_matcher=None,
 
66
                  path_encoding='utf8'):
29
67
    # FIXME: difflib is wrong if there is no trailing newline.
30
68
    # The syntax used by patch seems to be "\ No newline at
31
69
    # end of file" following the last diff line from that
42
80
    if not oldlines and not newlines:
43
81
        return
44
82
 
45
 
    ud = difflib.unified_diff(oldlines, newlines,
46
 
                              fromfile=old_label, tofile=new_label)
47
 
 
 
83
    if allow_binary is False:
 
84
        textfile.check_text_lines(oldlines)
 
85
        textfile.check_text_lines(newlines)
 
86
 
 
87
    if sequence_matcher is None:
 
88
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
89
    ud = patiencediff.unified_diff(oldlines, newlines,
 
90
                      fromfile=old_filename.encode(path_encoding),
 
91
                      tofile=new_filename.encode(path_encoding),
 
92
                      sequencematcher=sequence_matcher)
 
93
 
 
94
    ud = list(ud)
 
95
    if len(ud) == 0: # Identical contents, nothing to do
 
96
        return
48
97
    # work-around for difflib being too smart for its own good
49
98
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
50
99
    if not oldlines:
51
 
        ud = list(ud)
52
100
        ud[2] = ud[2].replace('-1,0', '-0,0')
53
101
    elif not newlines:
54
 
        ud = list(ud)
55
102
        ud[2] = ud[2].replace('+1,0', '+0,0')
56
103
 
57
104
    for line in ud:
58
105
        to_file.write(line)
59
106
        if not line.endswith('\n'):
60
107
            to_file.write("\n\\ No newline at end of file\n")
61
 
    print >>to_file
62
 
 
63
 
 
64
 
 
65
 
 
66
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
108
    to_file.write('\n')
 
109
 
 
110
 
 
111
def _spawn_external_diff(diffcmd, capture_errors=True):
 
112
    """Spawn the externall diff process, and return the child handle.
 
113
 
 
114
    :param diffcmd: The command list to spawn
 
115
    :param capture_errors: Capture stderr as well as setting LANG=C
 
116
        and LC_ALL=C. This lets us read and understand the output of diff,
 
117
        and respond to any errors.
 
118
    :return: A Popen object.
 
119
    """
 
120
    if capture_errors:
 
121
        # construct minimal environment
 
122
        env = {}
 
123
        path = os.environ.get('PATH')
 
124
        if path is not None:
 
125
            env['PATH'] = path
 
126
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
127
        env['LANG'] = 'C'
 
128
        env['LC_ALL'] = 'C'
 
129
        stderr = subprocess.PIPE
 
130
    else:
 
131
        env = None
 
132
        stderr = None
 
133
 
 
134
    try:
 
135
        pipe = subprocess.Popen(diffcmd,
 
136
                                stdin=subprocess.PIPE,
 
137
                                stdout=subprocess.PIPE,
 
138
                                stderr=stderr,
 
139
                                env=env)
 
140
    except OSError, e:
 
141
        if e.errno == errno.ENOENT:
 
142
            raise errors.NoDiff(str(e))
 
143
        raise
 
144
 
 
145
    return pipe
 
146
 
 
147
 
 
148
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
67
149
                  diff_opts):
68
150
    """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
151
    # make sure our own output is properly ordered before the diff
76
152
    to_file.flush()
77
153
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    import os
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
 
154
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
155
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
156
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
157
    newtmpf = os.fdopen(newtmp_fd, 'wb')
83
158
 
84
159
    try:
85
160
        # TODO: perhaps a special case for comparing to or from the empty
92
167
        oldtmpf.writelines(oldlines)
93
168
        newtmpf.writelines(newlines)
94
169
 
95
 
        oldtmpf.flush()
96
 
        newtmpf.flush()
 
170
        oldtmpf.close()
 
171
        newtmpf.close()
97
172
 
98
173
        if not diff_opts:
99
174
            diff_opts = []
100
175
        diffcmd = ['diff',
101
 
                   '--label', old_label,
102
 
                   oldtmpf.name,
103
 
                   '--label', new_label,
104
 
                   newtmpf.name]
 
176
                   '--label', old_filename,
 
177
                   old_abspath,
 
178
                   '--label', new_filename,
 
179
                   new_abspath,
 
180
                   '--binary',
 
181
                  ]
105
182
 
106
183
        # diff only allows one style to be specified; they don't override.
107
184
        # note that some of these take optargs, and the optargs can be
123
200
            break
124
201
        else:
125
202
            diffcmd.append('-u')
126
 
                  
 
203
 
127
204
        if diff_opts:
128
205
            diffcmd.extend(diff_opts)
129
206
 
130
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
131
 
        
132
 
        if rc != 0 and rc != 1:
 
207
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
208
        out,err = pipe.communicate()
 
209
        rc = pipe.returncode
 
210
 
 
211
        # internal_diff() adds a trailing newline, add one here for consistency
 
212
        out += '\n'
 
213
        if rc == 2:
 
214
            # 'diff' gives retcode == 2 for all sorts of errors
 
215
            # one of those is 'Binary files differ'.
 
216
            # Bad options could also be the problem.
 
217
            # 'Binary files' is not a real error, so we suppress that error.
 
218
            lang_c_out = out
 
219
 
 
220
            # Since we got here, we want to make sure to give an i18n error
 
221
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
222
            out, err = pipe.communicate()
 
223
 
 
224
            # Write out the new i18n diff response
 
225
            to_file.write(out+'\n')
 
226
            if pipe.returncode != 2:
 
227
                raise errors.BzrError(
 
228
                               'external diff failed with exit code 2'
 
229
                               ' when run with LANG=C and LC_ALL=C,'
 
230
                               ' but not when run natively: %r' % (diffcmd,))
 
231
 
 
232
            first_line = lang_c_out.split('\n', 1)[0]
 
233
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
234
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
235
            if m is None:
 
236
                raise errors.BzrError('external diff failed with exit code 2;'
 
237
                                      ' command: %r' % (diffcmd,))
 
238
            else:
 
239
                # Binary files differ, just return
 
240
                return
 
241
 
 
242
        # If we got to here, we haven't written out the output of diff
 
243
        # do so now
 
244
        to_file.write(out)
 
245
        if rc not in (0, 1):
133
246
            # returns 1 if files differ; that's OK
134
247
            if rc < 0:
135
248
                msg = 'signal %d' % (-rc)
136
249
            else:
137
250
                msg = 'exit code %d' % rc
138
 
                
139
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
251
 
 
252
            raise errors.BzrError('external diff failed with %s; command: %r'
 
253
                                  % (rc, diffcmd))
 
254
 
 
255
 
140
256
    finally:
141
257
        oldtmpf.close()                 # and delete
142
258
        newtmpf.close()
143
 
    
144
 
 
145
 
 
146
 
def show_diff(b, revision, specific_files, external_diff_options=None,
147
 
              revision2=None):
148
 
    """Shortcut for showing the diff to the working tree.
149
 
 
150
 
    b
151
 
        Branch.
152
 
 
153
 
    revision
154
 
        None for each, or otherwise the old revision to compare against.
155
 
    
156
 
    The more general form is show_diff_trees(), where the caller
157
 
    supplies any two trees.
 
259
        # Clean up. Warn in case the files couldn't be deleted
 
260
        # (in case windows still holds the file open, but not
 
261
        # if the files have already been deleted)
 
262
        try:
 
263
            os.remove(old_abspath)
 
264
        except OSError, e:
 
265
            if e.errno not in (errno.ENOENT,):
 
266
                warning('Failed to delete temporary file: %s %s',
 
267
                        old_abspath, e)
 
268
        try:
 
269
            os.remove(new_abspath)
 
270
        except OSError:
 
271
            if e.errno not in (errno.ENOENT,):
 
272
                warning('Failed to delete temporary file: %s %s',
 
273
                        new_abspath, e)
 
274
 
 
275
 
 
276
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
 
277
    apply_view=True):
 
278
    """Get the trees and specific files to diff given a list of paths.
 
279
 
 
280
    This method works out the trees to be diff'ed and the files of
 
281
    interest within those trees.
 
282
 
 
283
    :param path_list:
 
284
        the list of arguments passed to the diff command
 
285
    :param revision_specs:
 
286
        Zero, one or two RevisionSpecs from the diff command line,
 
287
        saying what revisions to compare.
 
288
    :param old_url:
 
289
        The url of the old branch or tree. If None, the tree to use is
 
290
        taken from the first path, if any, or the current working tree.
 
291
    :param new_url:
 
292
        The url of the new branch or tree. If None, the tree to use is
 
293
        taken from the first path, if any, or the current working tree.
 
294
    :param apply_view:
 
295
        if True and a view is set, apply the view or check that the paths
 
296
        are within it
 
297
    :returns:
 
298
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
299
        extra_trees is a sequence of additional trees to search in for
 
300
        file-ids.
158
301
    """
159
 
    import sys
160
 
 
161
 
    if revision == None:
162
 
        old_tree = b.basis_tree()
163
 
    else:
164
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
165
 
 
166
 
    if revision2 == None:
167
 
        new_tree = b.working_tree()
168
 
    else:
169
 
        new_tree = b.revision_tree(b.lookup_revision(revision2))
170
 
 
171
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
172
 
                    external_diff_options)
173
 
 
 
302
    # Get the old and new revision specs
 
303
    old_revision_spec = None
 
304
    new_revision_spec = None
 
305
    if revision_specs is not None:
 
306
        if len(revision_specs) > 0:
 
307
            old_revision_spec = revision_specs[0]
 
308
            if old_url is None:
 
309
                old_url = old_revision_spec.get_branch()
 
310
        if len(revision_specs) > 1:
 
311
            new_revision_spec = revision_specs[1]
 
312
            if new_url is None:
 
313
                new_url = new_revision_spec.get_branch()
 
314
 
 
315
    other_paths = []
 
316
    make_paths_wt_relative = True
 
317
    consider_relpath = True
 
318
    if path_list is None or len(path_list) == 0:
 
319
        # If no path is given, the current working tree is used
 
320
        default_location = u'.'
 
321
        consider_relpath = False
 
322
    elif old_url is not None and new_url is not None:
 
323
        other_paths = path_list
 
324
        make_paths_wt_relative = False
 
325
    else:
 
326
        default_location = path_list[0]
 
327
        other_paths = path_list[1:]
 
328
 
 
329
    # Get the old location
 
330
    specific_files = []
 
331
    if old_url is None:
 
332
        old_url = default_location
 
333
    working_tree, branch, relpath = \
 
334
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
335
    if consider_relpath and relpath != '':
 
336
        if working_tree is not None and apply_view:
 
337
            views.check_path_in_view(working_tree, relpath)
 
338
        specific_files.append(relpath)
 
339
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
340
 
 
341
    # Get the new location
 
342
    if new_url is None:
 
343
        new_url = default_location
 
344
    if new_url != old_url:
 
345
        working_tree, branch, relpath = \
 
346
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
347
        if consider_relpath and relpath != '':
 
348
            if working_tree is not None and apply_view:
 
349
                views.check_path_in_view(working_tree, relpath)
 
350
            specific_files.append(relpath)
 
351
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
 
352
        basis_is_default=working_tree is None)
 
353
 
 
354
    # Get the specific files (all files is None, no files is [])
 
355
    if make_paths_wt_relative and working_tree is not None:
 
356
        try:
 
357
            from bzrlib.builtins import safe_relpath_files
 
358
            other_paths = safe_relpath_files(working_tree, other_paths,
 
359
            apply_view=apply_view)
 
360
        except errors.FileInWrongBranch:
 
361
            raise errors.BzrCommandError("Files are in different branches")
 
362
    specific_files.extend(other_paths)
 
363
    if len(specific_files) == 0:
 
364
        specific_files = None
 
365
        if (working_tree is not None and working_tree.supports_views()
 
366
            and apply_view):
 
367
            view_files = working_tree.views.lookup_view()
 
368
            if view_files:
 
369
                specific_files = view_files
 
370
                view_str = views.view_display_str(view_files)
 
371
                note("*** ignoring files outside view: %s" % view_str)
 
372
 
 
373
    # Get extra trees that ought to be searched for file-ids
 
374
    extra_trees = None
 
375
    if working_tree is not None and working_tree not in (old_tree, new_tree):
 
376
        extra_trees = (working_tree,)
 
377
    return old_tree, new_tree, specific_files, extra_trees
 
378
 
 
379
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
 
380
    if branch is None and tree is not None:
 
381
        branch = tree.branch
 
382
    if spec is None or spec.spec is None:
 
383
        if basis_is_default:
 
384
            if tree is not None:
 
385
                return tree.basis_tree()
 
386
            else:
 
387
                return branch.basis_tree()
 
388
        else:
 
389
            return tree
 
390
    return spec.as_tree(branch)
174
391
 
175
392
 
176
393
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
177
 
                    external_diff_options=None):
 
394
                    external_diff_options=None,
 
395
                    old_label='a/', new_label='b/',
 
396
                    extra_trees=None,
 
397
                    path_encoding='utf8',
 
398
                    using=None):
178
399
    """Show in text form the changes from one tree to another.
179
400
 
180
 
    to_files
181
 
        If set, include only changes to these files.
 
401
    to_file
 
402
        The output stream.
 
403
 
 
404
    specific_files
 
405
        Include only changes to these files - None for all changes.
182
406
 
183
407
    external_diff_options
184
408
        If set, use an external GNU diff and pass these options.
185
 
    """
186
 
 
187
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
188
 
    old_label = ''
189
 
    new_label = ''
190
 
 
191
 
    DEVNULL = '/dev/null'
192
 
    # Windows users, don't panic about this filename -- it is a
193
 
    # special signal to GNU patch that the file should be created or
194
 
    # deleted respectively.
195
 
 
196
 
    # TODO: Generation of pseudo-diffs for added/deleted files could
197
 
    # be usefully made into a much faster special case.
198
 
 
199
 
    if external_diff_options:
200
 
        assert isinstance(external_diff_options, basestring)
201
 
        opts = external_diff_options.split()
202
 
        def diff_file(olab, olines, nlab, nlines, to_file):
203
 
            external_diff(olab, olines, nlab, nlines, to_file, opts)
204
 
    else:
205
 
        diff_file = internal_diff
206
 
    
207
 
 
208
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
209
 
                          specific_files=specific_files)
210
 
 
211
 
    for path, file_id, kind in delta.removed:
212
 
        print >>to_file, '*** removed %s %r' % (kind, path)
213
 
        if kind == 'file':
214
 
            diff_file(old_label + path,
215
 
                      old_tree.get_file(file_id).readlines(),
216
 
                      DEVNULL, 
217
 
                      [],
218
 
                      to_file)
219
 
 
220
 
    for path, file_id, kind in delta.added:
221
 
        print >>to_file, '*** added %s %r' % (kind, path)
222
 
        if kind == 'file':
223
 
            diff_file(DEVNULL,
224
 
                      [],
225
 
                      new_label + path,
226
 
                      new_tree.get_file(file_id).readlines(),
227
 
                      to_file)
228
 
 
229
 
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
230
 
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
231
 
        if text_modified:
232
 
            diff_file(old_label + old_path,
233
 
                      old_tree.get_file(file_id).readlines(),
234
 
                      new_label + new_path,
235
 
                      new_tree.get_file(file_id).readlines(),
236
 
                      to_file)
237
 
 
238
 
    for path, file_id, kind in delta.modified:
239
 
        print >>to_file, '*** modified %s %r' % (kind, path)
240
 
        if kind == 'file':
241
 
            diff_file(old_label + path,
242
 
                      old_tree.get_file(file_id).readlines(),
243
 
                      new_label + path,
244
 
                      new_tree.get_file(file_id).readlines(),
245
 
                      to_file)
246
 
 
247
 
 
248
 
 
249
 
 
250
 
 
 
409
 
 
410
    extra_trees
 
411
        If set, more Trees to use for looking up file ids
 
412
 
 
413
    path_encoding
 
414
        If set, the path will be encoded as specified, otherwise is supposed
 
415
        to be utf8
 
416
    """
 
417
    old_tree.lock_read()
 
418
    try:
 
419
        if extra_trees is not None:
 
420
            for tree in extra_trees:
 
421
                tree.lock_read()
 
422
        new_tree.lock_read()
 
423
        try:
 
424
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
425
                                                 path_encoding,
 
426
                                                 external_diff_options,
 
427
                                                 old_label, new_label, using)
 
428
            return differ.show_diff(specific_files, extra_trees)
 
429
        finally:
 
430
            new_tree.unlock()
 
431
            if extra_trees is not None:
 
432
                for tree in extra_trees:
 
433
                    tree.unlock()
 
434
    finally:
 
435
        old_tree.unlock()
 
436
 
 
437
 
 
438
def _patch_header_date(tree, file_id, path):
 
439
    """Returns a timestamp suitable for use in a patch header."""
 
440
    mtime = tree.get_file_mtime(file_id, path)
 
441
    return timestamp.format_patch_date(mtime)
 
442
 
 
443
 
 
444
@deprecated_function(one_three)
 
445
def get_prop_change(meta_modified):
 
446
    if meta_modified:
 
447
        return " (properties changed)"
 
448
    else:
 
449
        return  ""
 
450
 
 
451
def get_executable_change(old_is_x, new_is_x):
 
452
    descr = { True:"+x", False:"-x", None:"??" }
 
453
    if old_is_x != new_is_x:
 
454
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
455
    else:
 
456
        return []
 
457
 
 
458
 
 
459
class DiffPath(object):
 
460
    """Base type for command object that compare files"""
 
461
 
 
462
    # The type or contents of the file were unsuitable for diffing
 
463
    CANNOT_DIFF = 'CANNOT_DIFF'
 
464
    # The file has changed in a semantic way
 
465
    CHANGED = 'CHANGED'
 
466
    # The file content may have changed, but there is no semantic change
 
467
    UNCHANGED = 'UNCHANGED'
 
468
 
 
469
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
 
470
        """Constructor.
 
471
 
 
472
        :param old_tree: The tree to show as the old tree in the comparison
 
473
        :param new_tree: The tree to show as new in the comparison
 
474
        :param to_file: The file to write comparison data to
 
475
        :param path_encoding: The character encoding to write paths in
 
476
        """
 
477
        self.old_tree = old_tree
 
478
        self.new_tree = new_tree
 
479
        self.to_file = to_file
 
480
        self.path_encoding = path_encoding
 
481
 
 
482
    def finish(self):
 
483
        pass
 
484
 
 
485
    @classmethod
 
486
    def from_diff_tree(klass, diff_tree):
 
487
        return klass(diff_tree.old_tree, diff_tree.new_tree,
 
488
                     diff_tree.to_file, diff_tree.path_encoding)
 
489
 
 
490
    @staticmethod
 
491
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
 
492
        for file_differ in differs:
 
493
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
 
494
                                      new_kind)
 
495
            if result is not DiffPath.CANNOT_DIFF:
 
496
                return result
 
497
        else:
 
498
            return DiffPath.CANNOT_DIFF
 
499
 
 
500
 
 
501
class DiffKindChange(object):
 
502
    """Special differ for file kind changes.
 
503
 
 
504
    Represents kind change as deletion + creation.  Uses the other differs
 
505
    to do this.
 
506
    """
 
507
    def __init__(self, differs):
 
508
        self.differs = differs
 
509
 
 
510
    def finish(self):
 
511
        pass
 
512
 
 
513
    @classmethod
 
514
    def from_diff_tree(klass, diff_tree):
 
515
        return klass(diff_tree.differs)
 
516
 
 
517
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
518
        """Perform comparison
 
519
 
 
520
        :param file_id: The file_id of the file to compare
 
521
        :param old_path: Path of the file in the old tree
 
522
        :param new_path: Path of the file in the new tree
 
523
        :param old_kind: Old file-kind of the file
 
524
        :param new_kind: New file-kind of the file
 
525
        """
 
526
        if None in (old_kind, new_kind):
 
527
            return DiffPath.CANNOT_DIFF
 
528
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
529
                                       new_path, old_kind, None)
 
530
        if result is DiffPath.CANNOT_DIFF:
 
531
            return result
 
532
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
 
533
                                     None, new_kind)
 
534
 
 
535
 
 
536
class DiffDirectory(DiffPath):
 
537
 
 
538
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
539
        """Perform comparison between two directories.  (dummy)
 
540
 
 
541
        """
 
542
        if 'directory' not in (old_kind, new_kind):
 
543
            return self.CANNOT_DIFF
 
544
        if old_kind not in ('directory', None):
 
545
            return self.CANNOT_DIFF
 
546
        if new_kind not in ('directory', None):
 
547
            return self.CANNOT_DIFF
 
548
        return self.CHANGED
 
549
 
 
550
 
 
551
class DiffSymlink(DiffPath):
 
552
 
 
553
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
554
        """Perform comparison between two symlinks
 
555
 
 
556
        :param file_id: The file_id of the file to compare
 
557
        :param old_path: Path of the file in the old tree
 
558
        :param new_path: Path of the file in the new tree
 
559
        :param old_kind: Old file-kind of the file
 
560
        :param new_kind: New file-kind of the file
 
561
        """
 
562
        if 'symlink' not in (old_kind, new_kind):
 
563
            return self.CANNOT_DIFF
 
564
        if old_kind == 'symlink':
 
565
            old_target = self.old_tree.get_symlink_target(file_id)
 
566
        elif old_kind is None:
 
567
            old_target = None
 
568
        else:
 
569
            return self.CANNOT_DIFF
 
570
        if new_kind == 'symlink':
 
571
            new_target = self.new_tree.get_symlink_target(file_id)
 
572
        elif new_kind is None:
 
573
            new_target = None
 
574
        else:
 
575
            return self.CANNOT_DIFF
 
576
        return self.diff_symlink(old_target, new_target)
 
577
 
 
578
    def diff_symlink(self, old_target, new_target):
 
579
        if old_target is None:
 
580
            self.to_file.write('=== target is %r\n' % new_target)
 
581
        elif new_target is None:
 
582
            self.to_file.write('=== target was %r\n' % old_target)
 
583
        else:
 
584
            self.to_file.write('=== target changed %r => %r\n' %
 
585
                              (old_target, new_target))
 
586
        return self.CHANGED
 
587
 
 
588
 
 
589
class DiffText(DiffPath):
 
590
 
 
591
    # GNU Patch uses the epoch date to detect files that are being added
 
592
    # or removed in a diff.
 
593
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
594
 
 
595
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
596
                 old_label='', new_label='', text_differ=internal_diff):
 
597
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
598
        self.text_differ = text_differ
 
599
        self.old_label = old_label
 
600
        self.new_label = new_label
 
601
        self.path_encoding = path_encoding
 
602
 
 
603
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
604
        """Compare two files in unified diff format
 
605
 
 
606
        :param file_id: The file_id of the file to compare
 
607
        :param old_path: Path of the file in the old tree
 
608
        :param new_path: Path of the file in the new tree
 
609
        :param old_kind: Old file-kind of the file
 
610
        :param new_kind: New file-kind of the file
 
611
        """
 
612
        if 'file' not in (old_kind, new_kind):
 
613
            return self.CANNOT_DIFF
 
614
        from_file_id = to_file_id = file_id
 
615
        if old_kind == 'file':
 
616
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
 
617
        elif old_kind is None:
 
618
            old_date = self.EPOCH_DATE
 
619
            from_file_id = None
 
620
        else:
 
621
            return self.CANNOT_DIFF
 
622
        if new_kind == 'file':
 
623
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
 
624
        elif new_kind is None:
 
625
            new_date = self.EPOCH_DATE
 
626
            to_file_id = None
 
627
        else:
 
628
            return self.CANNOT_DIFF
 
629
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
630
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
631
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
632
 
 
633
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
634
        """Diff the content of given files in two trees
 
635
 
 
636
        :param from_file_id: The id of the file in the from tree.  If None,
 
637
            the file is not present in the from tree.
 
638
        :param to_file_id: The id of the file in the to tree.  This may refer
 
639
            to a different file from from_file_id.  If None,
 
640
            the file is not present in the to tree.
 
641
        """
 
642
        def _get_text(tree, file_id):
 
643
            if file_id is not None:
 
644
                return tree.get_file(file_id).readlines()
 
645
            else:
 
646
                return []
 
647
        try:
 
648
            from_text = _get_text(self.old_tree, from_file_id)
 
649
            to_text = _get_text(self.new_tree, to_file_id)
 
650
            self.text_differ(from_label, from_text, to_label, to_text,
 
651
                             self.to_file)
 
652
        except errors.BinaryFile:
 
653
            self.to_file.write(
 
654
                  ("Binary files %s and %s differ\n" %
 
655
                  (from_label, to_label)).encode(self.path_encoding))
 
656
        return self.CHANGED
 
657
 
 
658
 
 
659
class DiffFromTool(DiffPath):
 
660
 
 
661
    def __init__(self, command_template, old_tree, new_tree, to_file,
 
662
                 path_encoding='utf-8'):
 
663
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
664
        self.command_template = command_template
 
665
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
 
666
 
 
667
    @classmethod
 
668
    def from_string(klass, command_string, old_tree, new_tree, to_file,
 
669
                    path_encoding='utf-8'):
 
670
        command_template = commands.shlex_split_unicode(command_string)
 
671
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
672
        return klass(command_template, old_tree, new_tree, to_file,
 
673
                     path_encoding)
 
674
 
 
675
    @classmethod
 
676
    def make_from_diff_tree(klass, command_string):
 
677
        def from_diff_tree(diff_tree):
 
678
            return klass.from_string(command_string, diff_tree.old_tree,
 
679
                                     diff_tree.new_tree, diff_tree.to_file)
 
680
        return from_diff_tree
 
681
 
 
682
    def _get_command(self, old_path, new_path):
 
683
        my_map = {'old_path': old_path, 'new_path': new_path}
 
684
        return [t % my_map for t in self.command_template]
 
685
 
 
686
    def _execute(self, old_path, new_path):
 
687
        command = self._get_command(old_path, new_path)
 
688
        try:
 
689
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
 
690
                                    cwd=self._root)
 
691
        except OSError, e:
 
692
            if e.errno == errno.ENOENT:
 
693
                raise errors.ExecutableMissing(command[0])
 
694
            else:
 
695
                raise
 
696
        self.to_file.write(proc.stdout.read())
 
697
        return proc.wait()
 
698
 
 
699
    def _try_symlink_root(self, tree, prefix):
 
700
        if (getattr(tree, 'abspath', None) is None
 
701
            or not osutils.host_os_dereferences_symlinks()):
 
702
            return False
 
703
        try:
 
704
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
 
705
        except OSError, e:
 
706
            if e.errno != errno.EEXIST:
 
707
                raise
 
708
        return True
 
709
 
 
710
    def _write_file(self, file_id, tree, prefix, relpath):
 
711
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
712
        if self._try_symlink_root(tree, prefix):
 
713
            return full_path
 
714
        parent_dir = osutils.dirname(full_path)
 
715
        try:
 
716
            os.makedirs(parent_dir)
 
717
        except OSError, e:
 
718
            if e.errno != errno.EEXIST:
 
719
                raise
 
720
        source = tree.get_file(file_id, relpath)
 
721
        try:
 
722
            target = open(full_path, 'wb')
 
723
            try:
 
724
                osutils.pumpfile(source, target)
 
725
            finally:
 
726
                target.close()
 
727
        finally:
 
728
            source.close()
 
729
        osutils.make_readonly(full_path)
 
730
        mtime = tree.get_file_mtime(file_id)
 
731
        os.utime(full_path, (mtime, mtime))
 
732
        return full_path
 
733
 
 
734
    def _prepare_files(self, file_id, old_path, new_path):
 
735
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
736
                                         old_path)
 
737
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
738
                                         new_path)
 
739
        return old_disk_path, new_disk_path
 
740
 
 
741
    def finish(self):
 
742
        osutils.rmtree(self._root)
 
743
 
 
744
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
745
        if (old_kind, new_kind) != ('file', 'file'):
 
746
            return DiffPath.CANNOT_DIFF
 
747
        self._prepare_files(file_id, old_path, new_path)
 
748
        self._execute(osutils.pathjoin('old', old_path),
 
749
                      osutils.pathjoin('new', new_path))
 
750
 
 
751
 
 
752
class DiffTree(object):
 
753
    """Provides textual representations of the difference between two trees.
 
754
 
 
755
    A DiffTree examines two trees and where a file-id has altered
 
756
    between them, generates a textual representation of the difference.
 
757
    DiffTree uses a sequence of DiffPath objects which are each
 
758
    given the opportunity to handle a given altered fileid. The list
 
759
    of DiffPath objects can be extended globally by appending to
 
760
    DiffTree.diff_factories, or for a specific diff operation by
 
761
    supplying the extra_factories option to the appropriate method.
 
762
    """
 
763
 
 
764
    # list of factories that can provide instances of DiffPath objects
 
765
    # may be extended by plugins.
 
766
    diff_factories = [DiffSymlink.from_diff_tree,
 
767
                      DiffDirectory.from_diff_tree]
 
768
 
 
769
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
770
                 diff_text=None, extra_factories=None):
 
771
        """Constructor
 
772
 
 
773
        :param old_tree: Tree to show as old in the comparison
 
774
        :param new_tree: Tree to show as new in the comparison
 
775
        :param to_file: File to write comparision to
 
776
        :param path_encoding: Character encoding to write paths in
 
777
        :param diff_text: DiffPath-type object to use as a last resort for
 
778
            diffing text files.
 
779
        :param extra_factories: Factories of DiffPaths to try before any other
 
780
            DiffPaths"""
 
781
        if diff_text is None:
 
782
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
783
                                 '', '',  internal_diff)
 
784
        self.old_tree = old_tree
 
785
        self.new_tree = new_tree
 
786
        self.to_file = to_file
 
787
        self.path_encoding = path_encoding
 
788
        self.differs = []
 
789
        if extra_factories is not None:
 
790
            self.differs.extend(f(self) for f in extra_factories)
 
791
        self.differs.extend(f(self) for f in self.diff_factories)
 
792
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
 
793
 
 
794
    @classmethod
 
795
    def from_trees_options(klass, old_tree, new_tree, to_file,
 
796
                           path_encoding, external_diff_options, old_label,
 
797
                           new_label, using):
 
798
        """Factory for producing a DiffTree.
 
799
 
 
800
        Designed to accept options used by show_diff_trees.
 
801
        :param old_tree: The tree to show as old in the comparison
 
802
        :param new_tree: The tree to show as new in the comparison
 
803
        :param to_file: File to write comparisons to
 
804
        :param path_encoding: Character encoding to use for writing paths
 
805
        :param external_diff_options: If supplied, use the installed diff
 
806
            binary to perform file comparison, using supplied options.
 
807
        :param old_label: Prefix to use for old file labels
 
808
        :param new_label: Prefix to use for new file labels
 
809
        :param using: Commandline to use to invoke an external diff tool
 
810
        """
 
811
        if using is not None:
 
812
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
813
        else:
 
814
            extra_factories = []
 
815
        if external_diff_options:
 
816
            opts = external_diff_options.split()
 
817
            def diff_file(olab, olines, nlab, nlines, to_file):
 
818
                external_diff(olab, olines, nlab, nlines, to_file, opts)
 
819
        else:
 
820
            diff_file = internal_diff
 
821
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
822
                             old_label, new_label, diff_file)
 
823
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
 
824
                     extra_factories)
 
825
 
 
826
    def show_diff(self, specific_files, extra_trees=None):
 
827
        """Write tree diff to self.to_file
 
828
 
 
829
        :param sepecific_files: the specific files to compare (recursive)
 
830
        :param extra_trees: extra trees to use for mapping paths to file_ids
 
831
        """
 
832
        try:
 
833
            return self._show_diff(specific_files, extra_trees)
 
834
        finally:
 
835
            for differ in self.differs:
 
836
                differ.finish()
 
837
 
 
838
    def _show_diff(self, specific_files, extra_trees):
 
839
        # TODO: Generation of pseudo-diffs for added/deleted files could
 
840
        # be usefully made into a much faster special case.
 
841
        iterator = self.new_tree.iter_changes(self.old_tree,
 
842
                                               specific_files=specific_files,
 
843
                                               extra_trees=extra_trees,
 
844
                                               require_versioned=True)
 
845
        has_changes = 0
 
846
        def changes_key(change):
 
847
            old_path, new_path = change[1]
 
848
            path = new_path
 
849
            if path is None:
 
850
                path = old_path
 
851
            return path
 
852
        def get_encoded_path(path):
 
853
            if path is not None:
 
854
                return path.encode(self.path_encoding, "replace")
 
855
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
856
             executable) in sorted(iterator, key=changes_key):
 
857
            # The root does not get diffed, and items with no known kind (that
 
858
            # is, missing) in both trees are skipped as well.
 
859
            if parent == (None, None) or kind == (None, None):
 
860
                continue
 
861
            oldpath, newpath = paths
 
862
            oldpath_encoded = get_encoded_path(paths[0])
 
863
            newpath_encoded = get_encoded_path(paths[1])
 
864
            old_present = (kind[0] is not None and versioned[0])
 
865
            new_present = (kind[1] is not None and versioned[1])
 
866
            renamed = (parent[0], name[0]) != (parent[1], name[1])
 
867
 
 
868
            properties_changed = []
 
869
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
 
870
 
 
871
            if properties_changed:
 
872
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
 
873
            else:
 
874
                prop_str = ""
 
875
 
 
876
            if (old_present, new_present) == (True, False):
 
877
                self.to_file.write("=== removed %s '%s'\n" %
 
878
                                   (kind[0], oldpath_encoded))
 
879
                newpath = oldpath
 
880
            elif (old_present, new_present) == (False, True):
 
881
                self.to_file.write("=== added %s '%s'\n" %
 
882
                                   (kind[1], newpath_encoded))
 
883
                oldpath = newpath
 
884
            elif renamed:
 
885
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
886
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
 
887
            else:
 
888
                # if it was produced by iter_changes, it must be
 
889
                # modified *somehow*, either content or execute bit.
 
890
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
 
891
                                   newpath_encoded, prop_str))
 
892
            if changed_content:
 
893
                self.diff(file_id, oldpath, newpath)
 
894
                has_changes = 1
 
895
            if renamed:
 
896
                has_changes = 1
 
897
        return has_changes
 
898
 
 
899
    def diff(self, file_id, old_path, new_path):
 
900
        """Perform a diff of a single file
 
901
 
 
902
        :param file_id: file-id of the file
 
903
        :param old_path: The path of the file in the old tree
 
904
        :param new_path: The path of the file in the new tree
 
905
        """
 
906
        try:
 
907
            old_kind = self.old_tree.kind(file_id)
 
908
        except (errors.NoSuchId, errors.NoSuchFile):
 
909
            old_kind = None
 
910
        try:
 
911
            new_kind = self.new_tree.kind(file_id)
 
912
        except (errors.NoSuchId, errors.NoSuchFile):
 
913
            new_kind = None
 
914
 
 
915
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
916
                                       new_path, old_kind, new_kind)
 
917
        if result is DiffPath.CANNOT_DIFF:
 
918
            error_path = new_path
 
919
            if error_path is None:
 
920
                error_path = old_path
 
921
            raise errors.NoDiffFound(error_path)