~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-09-01 06:32:52 UTC
  • Revision ID: mbp@sourcefrog.net-20050901063252-00fc761bf1076759
- make target to build emacs TAGS file

Show diffs side-by-side

added added

removed removed

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