← 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-07-04 12:26:02 UTC
  • Revision ID: mbp@sourcefrog.net-20050704122602-69901910521e62c3
- check command checks that all inventory-ids are the same as in the revision.

Show diffs side-by-side

added added

removed removed

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