← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Dmitry Vasiliev
  • Date: 2007-03-07 13:47:47 UTC
  • mto: (2327.1.1 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 2328.
  • Revision ID: dima@hlabs.spb.ru-20070307134747-clcmwlfck4g9yqh3
Updated note about registry.Registry

Show diffs side-by-side

added added

removed removed

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