← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2005-06-24 11:09:36 UTC
  • Revision ID: mbp@sourcefrog.net-20050624110935-87a3b29aed05ac19
- Branch.revert copies files to backups before reverting them

Show diffs side-by-side

added added

removed removed

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