← 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-20 04:33:23 UTC
  • Revision ID: mbp@sourcefrog.net-20050620043323-1f681c2b5b15d026
- write into store using AtomicFile

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 = '@'
60
 
 
61
 
 
62
 
# TODO: Rather than building a changeset object, we should probably
63
 
# invoke callbacks on an object.  That object can either accumulate a
64
 
# list, write them out directly, etc etc.
65
 
 
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'):
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
 
 
18
from trace import mutter
 
19
from errors import BzrError
 
20
 
 
21
 
 
22
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
23
    import difflib
 
24
    
79
25
    # FIXME: difflib is wrong if there is no trailing newline.
80
26
    # The syntax used by patch seems to be "\ No newline at
81
27
    # end of file" following the last diff line from that
92
38
    if not oldlines and not newlines:
93
39
        return
94
40
 
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),
103
 
                      tofile=new_filename.encode(path_encoding),
104
 
                      sequencematcher=sequence_matcher)
105
 
 
106
 
    ud = list(ud)
107
 
    if len(ud) == 0: # Identical contents, nothing to do
108
 
        return
 
41
    nonl = False
 
42
 
 
43
    if oldlines and (oldlines[-1][-1] != '\n'):
 
44
        oldlines[-1] += '\n'
 
45
        nonl = True
 
46
    if newlines and (newlines[-1][-1] != '\n'):
 
47
        newlines[-1] += '\n'
 
48
        nonl = True
 
49
 
 
50
    ud = difflib.unified_diff(oldlines, newlines,
 
51
                              fromfile=old_label, tofile=new_label)
 
52
 
109
53
    # work-around for difflib being too smart for its own good
110
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
111
55
    if not oldlines:
 
56
        ud = list(ud)
112
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
113
58
    elif not newlines:
 
59
        ud = list(ud)
114
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
115
61
 
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,
 
62
    to_file.writelines(ud)
 
63
    if nonl:
 
64
        print >>to_file, "\\ No newline at end of file"
 
65
    print >>to_file
 
66
 
 
67
 
 
68
 
 
69
 
 
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
161
71
                  diff_opts):
162
72
    """Display a diff by calling out to the external diff program."""
 
73
    import sys
 
74
    
 
75
    if to_file != sys.stdout:
 
76
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
77
                                  to_file)
 
78
 
163
79
    # make sure our own output is properly ordered before the diff
164
80
    to_file.flush()
165
81
 
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')
 
82
    from tempfile import NamedTemporaryFile
 
83
    import os
 
84
 
 
85
    oldtmpf = NamedTemporaryFile()
 
86
    newtmpf = NamedTemporaryFile()
170
87
 
171
88
    try:
172
89
        # TODO: perhaps a special case for comparing to or from the empty
179
96
        oldtmpf.writelines(oldlines)
180
97
        newtmpf.writelines(newlines)
181
98
 
182
 
        oldtmpf.close()
183
 
        newtmpf.close()
 
99
        oldtmpf.flush()
 
100
        newtmpf.flush()
184
101
 
185
102
        if not diff_opts:
186
103
            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
104
        diffcmd = ['diff',
193
 
                   '--label', old_filename,
194
 
                   old_abspath,
195
 
                   '--label', new_filename,
196
 
                   new_abspath,
197
 
                   '--binary',
198
 
                  ]
 
105
                   '--label', old_label,
 
106
                   oldtmpf.name,
 
107
                   '--label', new_label,
 
108
                   newtmpf.name]
199
109
 
200
110
        # diff only allows one style to be specified; they don't override.
201
111
        # note that some of these take optargs, and the optargs can be
217
127
            break
218
128
        else:
219
129
            diffcmd.append('-u')
220
 
 
 
130
                  
221
131
        if diff_opts:
222
132
            diffcmd.extend(diff_opts)
223
133
 
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):
 
134
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
135
        
 
136
        if rc != 0 and rc != 1:
263
137
            # returns 1 if files differ; that's OK
264
138
            if rc < 0:
265
139
                msg = 'signal %d' % (-rc)
266
140
            else:
267
141
                msg = 'exit code %d' % rc
268
 
 
269
 
            raise errors.BzrError('external diff failed with %s; command: %r'
270
 
                                  % (rc, diffcmd))
271
 
 
272
 
 
 
142
                
 
143
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
273
144
    finally:
274
145
        oldtmpf.close()                 # and delete
275
146
        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
 
147
    
 
148
 
 
149
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
 
151
    """Shortcut for showing the diff to the working tree.
 
152
 
 
153
    b
 
154
        Branch.
 
155
 
 
156
    revision
 
157
        None for each, or otherwise the old revision to compare against.
 
158
    
 
159
    The more general form is show_diff_trees(), where the caller
 
160
    supplies any two trees.
 
161
    """
 
162
    import sys
 
163
 
 
164
    if revision == None:
 
165
        old_tree = b.basis_tree()
380
166
    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
 
        try:
424
 
            from bzrlib.builtins import safe_relpath_files
425
 
            other_paths = safe_relpath_files(working_tree, other_paths,
426
 
            apply_view=apply_view)
427
 
        except errors.FileInWrongBranch:
428
 
            raise errors.BzrCommandError("Files are in different branches")
429
 
    specific_files.extend(other_paths)
430
 
    if len(specific_files) == 0:
431
 
        specific_files = None
432
 
        if (working_tree is not None and working_tree.supports_views()
433
 
            and apply_view):
434
 
            view_files = working_tree.views.lookup_view()
435
 
            if view_files:
436
 
                specific_files = view_files
437
 
                view_str = views.view_display_str(view_files)
438
 
                note("*** Ignoring files outside view. View is %s" % view_str)
439
 
 
440
 
    # Get extra trees that ought to be searched for file-ids
441
 
    extra_trees = None
442
 
    if working_tree is not None and working_tree not in (old_tree, new_tree):
443
 
        extra_trees = (working_tree,)
444
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
445
 
 
446
 
 
447
 
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
448
 
    if branch is None and tree is not None:
449
 
        branch = tree.branch
450
 
    if spec is None or spec.spec is None:
451
 
        if basis_is_default:
452
 
            if tree is not None:
453
 
                return tree.basis_tree()
454
 
            else:
455
 
                return branch.basis_tree()
456
 
        else:
457
 
            return tree
458
 
    return spec.as_tree(branch)
 
167
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
168
        
 
169
    new_tree = b.working_tree()
 
170
 
 
171
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
172
                    external_diff_options)
 
173
 
459
174
 
460
175
 
461
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
462
 
                    external_diff_options=None,
463
 
                    old_label='a/', new_label='b/',
464
 
                    extra_trees=None,
465
 
                    path_encoding='utf8',
466
 
                    using=None,
467
 
                    format_cls=None):
 
177
                    external_diff_options=None):
468
178
    """Show in text form the changes from one tree to another.
469
179
 
470
 
    :param to_file: The output stream.
471
 
    :param specific_files:Include only changes to these files - None for all
472
 
        changes.
473
 
    :param external_diff_options: If set, use an external GNU diff and pass 
474
 
        these options.
475
 
    :param extra_trees: If set, more Trees to use for looking up file ids
476
 
    :param path_encoding: If set, the path will be encoded as specified, 
477
 
        otherwise is supposed to be utf8
478
 
    :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.
479
185
    """
480
 
    if format_cls is None:
481
 
        format_cls = DiffTree
482
 
    old_tree.lock_read()
483
 
    try:
484
 
        if extra_trees is not None:
485
 
            for tree in extra_trees:
486
 
                tree.lock_read()
487
 
        new_tree.lock_read()
488
 
        try:
489
 
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
490
 
                                                   path_encoding,
491
 
                                                   external_diff_options,
492
 
                                                   old_label, new_label, using)
493
 
            return differ.show_diff(specific_files, extra_trees)
494
 
        finally:
495
 
            new_tree.unlock()
496
 
            if extra_trees is not None:
497
 
                for tree in extra_trees:
498
 
                    tree.unlock()
499
 
    finally:
500
 
        old_tree.unlock()
501
 
 
502
 
 
503
 
def _patch_header_date(tree, file_id, path):
504
 
    """Returns a timestamp suitable for use in a patch header."""
505
 
    try:
506
 
        mtime = tree.get_file_mtime(file_id, path)
507
 
    except errors.FileTimestampUnavailable:
508
 
        mtime = 0
509
 
    return timestamp.format_patch_date(mtime)
510
 
 
511
 
 
512
 
def get_executable_change(old_is_x, new_is_x):
513
 
    descr = { True:"+x", False:"-x", None:"??" }
514
 
    if old_is_x != new_is_x:
515
 
        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)
516
204
    else:
517
 
        return []
518
 
 
519
 
 
520
 
class DiffPath(object):
521
 
    """Base type for command object that compare files"""
522
 
 
523
 
    # The type or contents of the file were unsuitable for diffing
524
 
    CANNOT_DIFF = 'CANNOT_DIFF'
525
 
    # The file has changed in a semantic way
526
 
    CHANGED = 'CHANGED'
527
 
    # The file content may have changed, but there is no semantic change
528
 
    UNCHANGED = 'UNCHANGED'
529
 
 
530
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
531
 
        """Constructor.
532
 
 
533
 
        :param old_tree: The tree to show as the old tree in the comparison
534
 
        :param new_tree: The tree to show as new in the comparison
535
 
        :param to_file: The file to write comparison data to
536
 
        :param path_encoding: The character encoding to write paths in
537
 
        """
538
 
        self.old_tree = old_tree
539
 
        self.new_tree = new_tree
540
 
        self.to_file = to_file
541
 
        self.path_encoding = path_encoding
542
 
 
543
 
    def finish(self):
544
 
        pass
545
 
 
546
 
    @classmethod
547
 
    def from_diff_tree(klass, diff_tree):
548
 
        return klass(diff_tree.old_tree, diff_tree.new_tree,
549
 
                     diff_tree.to_file, diff_tree.path_encoding)
550
 
 
551
 
    @staticmethod
552
 
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
553
 
        for file_differ in differs:
554
 
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
555
 
                                      new_kind)
556
 
            if result is not DiffPath.CANNOT_DIFF:
557
 
                return result
558
 
        else:
559
 
            return DiffPath.CANNOT_DIFF
560
 
 
561
 
 
562
 
class DiffKindChange(object):
563
 
    """Special differ for file kind changes.
564
 
 
565
 
    Represents kind change as deletion + creation.  Uses the other differs
566
 
    to do this.
567
 
    """
568
 
    def __init__(self, differs):
569
 
        self.differs = differs
570
 
 
571
 
    def finish(self):
572
 
        pass
573
 
 
574
 
    @classmethod
575
 
    def from_diff_tree(klass, diff_tree):
576
 
        return klass(diff_tree.differs)
577
 
 
578
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
579
 
        """Perform comparison
580
 
 
581
 
        :param file_id: The file_id of the file to compare
582
 
        :param old_path: Path of the file in the old tree
583
 
        :param new_path: Path of the file in the new tree
584
 
        :param old_kind: Old file-kind of the file
585
 
        :param new_kind: New file-kind of the file
586
 
        """
587
 
        if None in (old_kind, new_kind):
588
 
            return DiffPath.CANNOT_DIFF
589
 
        result = DiffPath._diff_many(self.differs, file_id, old_path,
590
 
                                       new_path, old_kind, None)
591
 
        if result is DiffPath.CANNOT_DIFF:
592
 
            return result
593
 
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
594
 
                                     None, new_kind)
595
 
 
596
 
 
597
 
class DiffDirectory(DiffPath):
598
 
 
599
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
600
 
        """Perform comparison between two directories.  (dummy)
601
 
 
602
 
        """
603
 
        if 'directory' not in (old_kind, new_kind):
604
 
            return self.CANNOT_DIFF
605
 
        if old_kind not in ('directory', None):
606
 
            return self.CANNOT_DIFF
607
 
        if new_kind not in ('directory', None):
608
 
            return self.CANNOT_DIFF
609
 
        return self.CHANGED
610
 
 
611
 
 
612
 
class DiffSymlink(DiffPath):
613
 
 
614
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
615
 
        """Perform comparison between two symlinks
616
 
 
617
 
        :param file_id: The file_id of the file to compare
618
 
        :param old_path: Path of the file in the old tree
619
 
        :param new_path: Path of the file in the new tree
620
 
        :param old_kind: Old file-kind of the file
621
 
        :param new_kind: New file-kind of the file
622
 
        """
623
 
        if 'symlink' not in (old_kind, new_kind):
624
 
            return self.CANNOT_DIFF
625
 
        if old_kind == 'symlink':
626
 
            old_target = self.old_tree.get_symlink_target(file_id)
627
 
        elif old_kind is None:
628
 
            old_target = None
629
 
        else:
630
 
            return self.CANNOT_DIFF
631
 
        if new_kind == 'symlink':
632
 
            new_target = self.new_tree.get_symlink_target(file_id)
633
 
        elif new_kind is None:
634
 
            new_target = None
635
 
        else:
636
 
            return self.CANNOT_DIFF
637
 
        return self.diff_symlink(old_target, new_target)
638
 
 
639
 
    def diff_symlink(self, old_target, new_target):
640
 
        if old_target is None:
641
 
            self.to_file.write('=== target is %r\n' % new_target)
642
 
        elif new_target is None:
643
 
            self.to_file.write('=== target was %r\n' % old_target)
644
 
        else:
645
 
            self.to_file.write('=== target changed %r => %r\n' %
646
 
                              (old_target, new_target))
647
 
        return self.CHANGED
648
 
 
649
 
 
650
 
class DiffText(DiffPath):
651
 
 
652
 
    # GNU Patch uses the epoch date to detect files that are being added
653
 
    # or removed in a diff.
654
 
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
655
 
 
656
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
657
 
                 old_label='', new_label='', text_differ=internal_diff):
658
 
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
659
 
        self.text_differ = text_differ
660
 
        self.old_label = old_label
661
 
        self.new_label = new_label
662
 
        self.path_encoding = path_encoding
663
 
 
664
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
665
 
        """Compare two files in unified diff format
666
 
 
667
 
        :param file_id: The file_id of the file to compare
668
 
        :param old_path: Path of the file in the old tree
669
 
        :param new_path: Path of the file in the new tree
670
 
        :param old_kind: Old file-kind of the file
671
 
        :param new_kind: New file-kind of the file
672
 
        """
673
 
        if 'file' not in (old_kind, new_kind):
674
 
            return self.CANNOT_DIFF
675
 
        from_file_id = to_file_id = file_id
676
 
        if old_kind == 'file':
677
 
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
678
 
        elif old_kind is None:
679
 
            old_date = self.EPOCH_DATE
680
 
            from_file_id = None
681
 
        else:
682
 
            return self.CANNOT_DIFF
683
 
        if new_kind == 'file':
684
 
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
685
 
        elif new_kind is None:
686
 
            new_date = self.EPOCH_DATE
687
 
            to_file_id = None
688
 
        else:
689
 
            return self.CANNOT_DIFF
690
 
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
691
 
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
692
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
693
 
            old_path, new_path)
694
 
 
695
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
 
        from_path=None, to_path=None):
697
 
        """Diff the content of given files in two trees
698
 
 
699
 
        :param from_file_id: The id of the file in the from tree.  If None,
700
 
            the file is not present in the from tree.
701
 
        :param to_file_id: The id of the file in the to tree.  This may refer
702
 
            to a different file from from_file_id.  If None,
703
 
            the file is not present in the to tree.
704
 
        :param from_path: The path in the from tree or None if unknown.
705
 
        :param to_path: The path in the to tree or None if unknown.
706
 
        """
707
 
        def _get_text(tree, file_id, path):
708
 
            if file_id is not None:
709
 
                return tree.get_file(file_id, path).readlines()
710
 
            else:
711
 
                return []
712
 
        try:
713
 
            from_text = _get_text(self.old_tree, from_file_id, from_path)
714
 
            to_text = _get_text(self.new_tree, to_file_id, to_path)
715
 
            self.text_differ(from_label, from_text, to_label, to_text,
716
 
                             self.to_file)
717
 
        except errors.BinaryFile:
718
 
            self.to_file.write(
719
 
                  ("Binary files %s and %s differ\n" %
720
 
                  (from_label, to_label)).encode(self.path_encoding))
721
 
        return self.CHANGED
722
 
 
723
 
 
724
 
class DiffFromTool(DiffPath):
725
 
 
726
 
    def __init__(self, command_template, old_tree, new_tree, to_file,
727
 
                 path_encoding='utf-8'):
728
 
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
729
 
        self.command_template = command_template
730
 
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
731
 
 
732
 
    @classmethod
733
 
    def from_string(klass, command_string, old_tree, new_tree, to_file,
734
 
                    path_encoding='utf-8'):
735
 
        command_template = cmdline.split(command_string)
736
 
        if '@' not in command_string:
737
 
            command_template.extend(['@old_path', '@new_path'])
738
 
        return klass(command_template, old_tree, new_tree, to_file,
739
 
                     path_encoding)
740
 
 
741
 
    @classmethod
742
 
    def make_from_diff_tree(klass, command_string):
743
 
        def from_diff_tree(diff_tree):
744
 
            return klass.from_string(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()):
769
 
            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.
868
 
    """
869
 
 
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)]
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):
924
 
                external_diff(olab, olines, nlab, nlines, to_file, opts)
925
 
        else:
926
 
            diff_file = internal_diff
927
 
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
928
 
                             old_label, new_label, diff_file)
929
 
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
930
 
                     extra_factories)
931
 
 
932
 
    def show_diff(self, specific_files, extra_trees=None):
933
 
        """Write tree diff to self.to_file
934
 
 
935
 
        :param specific_files: the specific files to compare (recursive)
936
 
        :param extra_trees: extra trees to use for mapping paths to file_ids
937
 
        """
938
 
        try:
939
 
            return self._show_diff(specific_files, extra_trees)
940
 
        finally:
941
 
            for differ in self.differs:
942
 
                differ.finish()
943
 
 
944
 
    def _show_diff(self, specific_files, extra_trees):
945
 
        # TODO: Generation of pseudo-diffs for added/deleted files could
946
 
        # be usefully made into a much faster special case.
947
 
        iterator = self.new_tree.iter_changes(self.old_tree,
948
 
                                               specific_files=specific_files,
949
 
                                               extra_trees=extra_trees,
950
 
                                               require_versioned=True)
951
 
        has_changes = 0
952
 
        def changes_key(change):
953
 
            old_path, new_path = change[1]
954
 
            path = new_path
955
 
            if path is None:
956
 
                path = old_path
957
 
            return path
958
 
        def get_encoded_path(path):
959
 
            if path is not None:
960
 
                return path.encode(self.path_encoding, "replace")
961
 
        for (file_id, paths, changed_content, versioned, parent, name, kind,
962
 
             executable) in sorted(iterator, key=changes_key):
963
 
            # The root does not get diffed, and items with no known kind (that
964
 
            # is, missing) in both trees are skipped as well.
965
 
            if parent == (None, None) or kind == (None, None):
966
 
                continue
967
 
            oldpath, newpath = paths
968
 
            oldpath_encoded = get_encoded_path(paths[0])
969
 
            newpath_encoded = get_encoded_path(paths[1])
970
 
            old_present = (kind[0] is not None and versioned[0])
971
 
            new_present = (kind[1] is not None and versioned[1])
972
 
            renamed = (parent[0], name[0]) != (parent[1], name[1])
973
 
 
974
 
            properties_changed = []
975
 
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
976
 
 
977
 
            if properties_changed:
978
 
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
979
 
            else:
980
 
                prop_str = ""
981
 
 
982
 
            if (old_present, new_present) == (True, False):
983
 
                self.to_file.write("=== removed %s '%s'\n" %
984
 
                                   (kind[0], oldpath_encoded))
985
 
                newpath = oldpath
986
 
            elif (old_present, new_present) == (False, True):
987
 
                self.to_file.write("=== added %s '%s'\n" %
988
 
                                   (kind[1], newpath_encoded))
989
 
                oldpath = newpath
990
 
            elif renamed:
991
 
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
992
 
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
993
 
            else:
994
 
                # if it was produced by iter_changes, it must be
995
 
                # modified *somehow*, either content or execute bit.
996
 
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
997
 
                                   newpath_encoded, prop_str))
998
 
            if changed_content:
999
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
1000
 
                has_changes = 1
1001
 
            if renamed:
1002
 
                has_changes = 1
1003
 
        return has_changes
1004
 
 
1005
 
    def diff(self, file_id, old_path, new_path):
1006
 
        """Perform a diff of a single file
1007
 
 
1008
 
        :param file_id: file-id of the file
1009
 
        :param old_path: The path of the file in the old tree
1010
 
        :param new_path: The path of the file in the new tree
1011
 
        """
1012
 
        try:
1013
 
            old_kind = self.old_tree.kind(file_id)
1014
 
        except (errors.NoSuchId, errors.NoSuchFile):
1015
 
            old_kind = None
1016
 
        try:
1017
 
            new_kind = self.new_tree.kind(file_id)
1018
 
        except (errors.NoSuchId, errors.NoSuchFile):
1019
 
            new_kind = None
1020
 
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
1021
 
 
1022
 
 
1023
 
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1024
 
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1025
 
                                       new_path, old_kind, new_kind)
1026
 
        if result is DiffPath.CANNOT_DIFF:
1027
 
            error_path = new_path
1028
 
            if error_path is None:
1029
 
                error_path = old_path
1030
 
            raise errors.NoDiffFound(error_path)
1031
 
 
1032
 
 
1033
 
format_registry = Registry()
1034
 
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
class TreeDelta(object):
 
250
    """Describes changes from one tree to another.
 
251
 
 
252
    Contains four lists:
 
253
 
 
254
    added
 
255
        (path, id, kind)
 
256
    removed
 
257
        (path, id, kind)
 
258
    renamed
 
259
        (oldpath, newpath, id, kind, text_modified)
 
260
    modified
 
261
        (path, id, kind)
 
262
    unchanged
 
263
        (path, id, kind)
 
264
 
 
265
    Each id is listed only once.
 
266
 
 
267
    Files that are both modified and renamed are listed only in
 
268
    renamed, with the text_modified flag true.
 
269
 
 
270
    The lists are normally sorted when the delta is created.
 
271
    """
 
272
    def __init__(self):
 
273
        self.added = []
 
274
        self.removed = []
 
275
        self.renamed = []
 
276
        self.modified = []
 
277
        self.unchanged = []
 
278
 
 
279
    def __repr__(self):
 
280
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
281
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
282
            self.modified, self.unchanged)
 
283
 
 
284
    def has_changed(self):
 
285
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
286
        changes += len(self.modified) 
 
287
        return (changes != 0)
 
288
 
 
289
    def touches_file_id(self, file_id):
 
290
        """Return True if file_id is modified by this delta."""
 
291
        for l in self.added, self.removed, self.modified:
 
292
            for v in l:
 
293
                if v[1] == file_id:
 
294
                    return True
 
295
        for v in self.renamed:
 
296
            if v[2] == file_id:
 
297
                return True
 
298
        return False
 
299
            
 
300
 
 
301
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
302
        def show_list(files):
 
303
            for path, fid, kind in files:
 
304
                if kind == 'directory':
 
305
                    path += '/'
 
306
                elif kind == 'symlink':
 
307
                    path += '@'
 
308
                    
 
309
                if show_ids:
 
310
                    print >>to_file, '  %-30s %s' % (path, fid)
 
311
                else:
 
312
                    print >>to_file, ' ', path
 
313
            
 
314
        if self.removed:
 
315
            print >>to_file, 'removed:'
 
316
            show_list(self.removed)
 
317
                
 
318
        if self.added:
 
319
            print >>to_file, 'added:'
 
320
            show_list(self.added)
 
321
 
 
322
        if self.renamed:
 
323
            print >>to_file, 'renamed:'
 
324
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
325
                if show_ids:
 
326
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
327
                else:
 
328
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
329
                    
 
330
        if self.modified:
 
331
            print >>to_file, 'modified:'
 
332
            show_list(self.modified)
 
333
            
 
334
        if show_unchanged and self.unchanged:
 
335
            print >>to_file, 'unchanged:'
 
336
            show_list(self.unchanged)
 
337
 
 
338
 
 
339
 
 
340
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
341
    """Describe changes from one tree to another.
 
342
 
 
343
    Returns a TreeDelta with details of added, modified, renamed, and
 
344
    deleted entries.
 
345
 
 
346
    The root entry is specifically exempt.
 
347
 
 
348
    This only considers versioned files.
 
349
 
 
350
    want_unchanged
 
351
        If true, also list files unchanged from one version to
 
352
        the next.
 
353
 
 
354
    specific_files
 
355
        If true, only check for changes to specified names or
 
356
        files within them.
 
357
    """
 
358
 
 
359
    from osutils import is_inside_any
 
360
    
 
361
    old_inv = old_tree.inventory
 
362
    new_inv = new_tree.inventory
 
363
    delta = TreeDelta()
 
364
    mutter('start compare_trees')
 
365
 
 
366
    # TODO: match for specific files can be rather smarter by finding
 
367
    # the IDs of those files up front and then considering only that.
 
368
 
 
369
    for file_id in old_tree:
 
370
        if file_id in new_tree:
 
371
            kind = old_inv.get_file_kind(file_id)
 
372
            assert kind == new_inv.get_file_kind(file_id)
 
373
            
 
374
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
375
                   'invalid file kind %r' % kind
 
376
 
 
377
            if kind == 'root_directory':
 
378
                continue
 
379
            
 
380
            old_path = old_inv.id2path(file_id)
 
381
            new_path = new_inv.id2path(file_id)
 
382
 
 
383
            if specific_files:
 
384
                if (not is_inside_any(specific_files, old_path) 
 
385
                    and not is_inside_any(specific_files, new_path)):
 
386
                    continue
 
387
 
 
388
            if kind == 'file':
 
389
                old_sha1 = old_tree.get_file_sha1(file_id)
 
390
                new_sha1 = new_tree.get_file_sha1(file_id)
 
391
                text_modified = (old_sha1 != new_sha1)
 
392
            else:
 
393
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
394
                text_modified = False
 
395
 
 
396
            # TODO: Can possibly avoid calculating path strings if the
 
397
            # two files are unchanged and their names and parents are
 
398
            # the same and the parents are unchanged all the way up.
 
399
            # May not be worthwhile.
 
400
            
 
401
            if old_path != new_path:
 
402
                delta.renamed.append((old_path, new_path, file_id, kind,
 
403
                                      text_modified))
 
404
            elif text_modified:
 
405
                delta.modified.append((new_path, file_id, kind))
 
406
            elif want_unchanged:
 
407
                delta.unchanged.append((new_path, file_id, kind))
 
408
        else:
 
409
            kind = old_inv.get_file_kind(file_id)
 
410
            old_path = old_inv.id2path(file_id)
 
411
            if specific_files:
 
412
                if not is_inside_any(specific_files, old_path):
 
413
                    continue
 
414
            delta.removed.append((old_path, file_id, kind))
 
415
 
 
416
    mutter('start looking for new files')
 
417
    for file_id in new_inv:
 
418
        if file_id in old_inv:
 
419
            continue
 
420
        new_path = new_inv.id2path(file_id)
 
421
        if specific_files:
 
422
            if not is_inside_any(specific_files, new_path):
 
423
                continue
 
424
        kind = new_inv.get_file_kind(file_id)
 
425
        delta.added.append((new_path, file_id, kind))
 
426
            
 
427
    delta.removed.sort()
 
428
    delta.added.sort()
 
429
    delta.renamed.sort()
 
430
    delta.modified.sort()
 
431
    delta.unchanged.sort()
 
432
 
 
433
    return delta