← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Robert Collins
  • Date: 2007-03-01 02:35:47 UTC
  • mto: (2255.11.3 dirstate)
  • mto: This revision was merged to the branch mainline in revision 2322.
  • Revision ID: robertc@robertcollins.net-20070301023547-g7w3o81gwczes50y
Lock the working tree while pulling to work around _iter_changes not supplying the old path, and dirstate not allowing unlocked inventory access.

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
20
 
 
21
 
 
22
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
23
 
    import difflib
24
 
    
 
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
 
44
 
 
45
 
 
46
# TODO: Rather than building a changeset object, we should probably
 
47
# invoke callbacks on an object.  That object can either accumulate a
 
48
# list, write them out directly, etc etc.
 
49
 
 
50
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
51
                  allow_binary=False, sequence_matcher=None,
 
52
                  path_encoding='utf8'):
25
53
    # FIXME: difflib is wrong if there is no trailing newline.
26
54
    # The syntax used by patch seems to be "\ No newline at
27
55
    # end of file" following the last diff line from that
37
65
    # both sequences are empty.
38
66
    if not oldlines and not newlines:
39
67
        return
40
 
 
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
 
 
 
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)
53
81
    # work-around for difflib being too smart for its own good
54
82
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
55
83
    if not oldlines:
56
 
        ud = list(ud)
57
84
        ud[2] = ud[2].replace('-1,0', '-0,0')
58
85
    elif not newlines:
59
 
        ud = list(ud)
60
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'
61
90
 
62
 
    to_file.writelines(ud)
63
 
    if nonl:
64
 
        print >>to_file, "\\ No newline at end of file"
 
91
    for line in ud:
 
92
        to_file.write(line)
 
93
        if not line.endswith('\n'):
 
94
            to_file.write("\n\\ No newline at end of file\n")
65
95
    print >>to_file
66
96
 
67
97
 
68
 
 
69
 
 
70
 
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,
 
142
                  diff_opts):
71
143
    """Display a diff by calling out to the external diff program."""
72
 
    import sys
73
 
    
74
 
    if to_file != sys.stdout:
75
 
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
76
 
                                  to_file)
77
 
 
78
 
    from tempfile import NamedTemporaryFile
79
 
    from os import system
80
 
 
81
 
    oldtmpf = NamedTemporaryFile()
82
 
    newtmpf = NamedTemporaryFile()
 
144
    # make sure our own output is properly ordered before the diff
 
145
    to_file.flush()
 
146
 
 
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')
83
151
 
84
152
    try:
85
153
        # TODO: perhaps a special case for comparing to or from the empty
89
157
        # regular named file (e.g. in the working directory) then we can
90
158
        # compare directly to that, rather than copying it.
91
159
 
92
 
        # TODO: Set the labels appropriately
93
 
 
94
160
        oldtmpf.writelines(oldlines)
95
161
        newtmpf.writelines(newlines)
96
162
 
97
 
        oldtmpf.flush()
98
 
        newtmpf.flush()
99
 
 
100
 
        system('diff -u --label %s %s --label %s %s' % (old_label, oldtmpf.name, new_label, newtmpf.name))
 
163
        oldtmpf.close()
 
164
        newtmpf.close()
 
165
 
 
166
        if not diff_opts:
 
167
            diff_opts = []
 
168
        diffcmd = ['diff',
 
169
                   '--label', old_filename,
 
170
                   old_abspath,
 
171
                   '--label', new_filename,
 
172
                   new_abspath,
 
173
                   '--binary',
 
174
                  ]
 
175
 
 
176
        # diff only allows one style to be specified; they don't override.
 
177
        # note that some of these take optargs, and the optargs can be
 
178
        # directly appended to the options.
 
179
        # this is only an approximate parser; it doesn't properly understand
 
180
        # the grammar.
 
181
        for s in ['-c', '-u', '-C', '-U',
 
182
                  '-e', '--ed',
 
183
                  '-q', '--brief',
 
184
                  '--normal',
 
185
                  '-n', '--rcs',
 
186
                  '-y', '--side-by-side',
 
187
                  '-D', '--ifdef']:
 
188
            for j in diff_opts:
 
189
                if j.startswith(s):
 
190
                    break
 
191
            else:
 
192
                continue
 
193
            break
 
194
        else:
 
195
            diffcmd.append('-u')
 
196
                  
 
197
        if diff_opts:
 
198
            diffcmd.extend(diff_opts)
 
199
 
 
200
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
201
        out,err = pipe.communicate()
 
202
        rc = pipe.returncode
 
203
        
 
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):
 
239
            # returns 1 if files differ; that's OK
 
240
            if rc < 0:
 
241
                msg = 'signal %d' % (-rc)
 
242
            else:
 
243
                msg = 'exit code %d' % rc
 
244
                
 
245
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
246
                                  % (rc, diffcmd))
 
247
 
 
248
 
101
249
    finally:
102
250
        oldtmpf.close()                 # and delete
103
251
        newtmpf.close()
104
 
    
105
 
 
106
 
 
107
 
def diff_file(old_label, oldlines, new_label, newlines, to_file):
108
 
    if False:
109
 
        differ = external_diff
110
 
    else:
111
 
        differ = internal_diff
112
 
 
113
 
    differ(old_label, oldlines, new_label, newlines, to_file)
114
 
 
115
 
 
116
 
 
117
 
def show_diff(b, revision, specific_files):
118
 
    import sys
119
 
 
120
 
    if revision == None:
121
 
        old_tree = b.basis_tree()
122
 
    else:
123
 
        old_tree = b.revision_tree(b.lookup_revision(revision))
124
 
        
125
 
    new_tree = b.working_tree()
126
 
 
127
 
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files)
128
 
 
129
 
 
130
 
 
131
 
def show_diff_trees(old_tree, new_tree, to_file, specific_files=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):
 
272
    """Shortcut for showing the diff to the working tree.
 
273
 
 
274
    Please use show_diff_trees instead.
 
275
 
 
276
    b
 
277
        Branch.
 
278
 
 
279
    revision
 
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)
 
381
 
 
382
 
 
383
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
384
                    external_diff_options=None,
 
385
                    old_label='a/', new_label='b/',
 
386
                    extra_trees=None):
132
387
    """Show in text form the changes from one tree to another.
133
388
 
134
389
    to_files
135
390
        If set, include only changes to these files.
 
391
 
 
392
    external_diff_options
 
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
136
397
    """
137
 
 
138
 
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
139
 
    old_label = ''
140
 
    new_label = ''
141
 
 
142
 
    DEVNULL = '/dev/null'
143
 
    # Windows users, don't panic about this filename -- it is a
144
 
    # special signal to GNU patch that the file should be created or
145
 
    # 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'
146
425
 
147
426
    # TODO: Generation of pseudo-diffs for added/deleted files could
148
427
    # be usefully made into a much faster special case.
149
428
 
150
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
151
 
                          specific_files=specific_files)
 
429
    if external_diff_options:
 
430
        assert isinstance(external_diff_options, basestring)
 
431
        opts = external_diff_options.split()
 
432
        def diff_file(olab, olines, nlab, nlines, to_file):
 
433
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
434
    else:
 
435
        diff_file = internal_diff
 
436
    
 
437
    delta = new_tree.changes_from(old_tree,
 
438
        specific_files=specific_files,
 
439
        extra_trees=extra_trees, require_versioned=True)
152
440
 
 
441
    has_changes = 0
153
442
    for path, file_id, kind in delta.removed:
154
 
        print '*** removed %s %r' % (kind, path)
155
 
        if kind == 'file':
156
 
            diff_file(old_label + path,
157
 
                      old_tree.get_file(file_id).readlines(),
158
 
                      DEVNULL, 
159
 
                      [],
160
 
                      to_file)
161
 
 
 
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)
162
450
    for path, file_id, kind in delta.added:
163
 
        print '*** added %s %r' % (kind, path)
164
 
        if kind == 'file':
165
 
            diff_file(DEVNULL,
166
 
                      [],
167
 
                      new_label + path,
168
 
                      new_tree.get_file(file_id).readlines(),
169
 
                      to_file)
170
 
 
171
 
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
172
 
        print '*** 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))
173
483
        if text_modified:
174
 
            diff_file(old_label + old_path,
175
 
                      old_tree.get_file(file_id).readlines(),
176
 
                      new_label + new_path,
177
 
                      new_tree.get_file(file_id).readlines(),
178
 
                      to_file)
179
 
 
180
 
    for path, file_id, kind in delta.modified:
181
 
        print '*** modified %s %r' % (kind, path)
182
 
        if kind == 'file':
183
 
            diff_file(old_label + path,
184
 
                      old_tree.get_file(file_id).readlines(),
185
 
                      new_label + path,
186
 
                      new_tree.get_file(file_id).readlines(),
187
 
                      to_file)
188
 
 
189
 
 
190
 
 
191
 
class TreeDelta(object):
192
 
    """Describes changes from one tree to another.
193
 
 
194
 
    Contains four lists:
195
 
 
196
 
    added
197
 
        (path, id, kind)
198
 
    removed
199
 
        (path, id, kind)
200
 
    renamed
201
 
        (oldpath, newpath, id, kind, text_modified)
202
 
    modified
203
 
        (path, id, kind)
204
 
    unchanged
205
 
        (path, id, kind)
206
 
 
207
 
    Each id is listed only once.
208
 
 
209
 
    Files that are both modified and renamed are listed only in
210
 
    renamed, with the text_modified flag true.
211
 
 
212
 
    The lists are normally sorted when the delta is created.
213
 
    """
214
 
    def __init__(self):
215
 
        self.added = []
216
 
        self.removed = []
217
 
        self.renamed = []
218
 
        self.modified = []
219
 
        self.unchanged = []
220
 
 
221
 
 
222
 
    def touches_file_id(self, file_id):
223
 
        """Return True if file_id is modified by this delta."""
224
 
        for l in self.added, self.removed, self.modified:
225
 
            for v in l:
226
 
                if v[1] == file_id:
227
 
                    return True
228
 
        for v in self.renamed:
229
 
            if v[2] == file_id:
230
 
                return True
231
 
        return False
232
 
            
233
 
 
234
 
    def show(self, to_file, show_ids=False, show_unchanged=False):
235
 
        def show_list(files):
236
 
            for path, fid, kind in files:
237
 
                if kind == 'directory':
238
 
                    path += '/'
239
 
                elif kind == 'symlink':
240
 
                    path += '@'
241
 
                    
242
 
                if show_ids:
243
 
                    print >>to_file, '  %-30s %s' % (path, fid)
244
 
                else:
245
 
                    print >>to_file, ' ', path
246
 
            
247
 
        if self.removed:
248
 
            print >>to_file, 'removed:'
249
 
            show_list(self.removed)
250
 
                
251
 
        if self.added:
252
 
            print >>to_file, 'added:'
253
 
            show_list(self.added)
254
 
 
255
 
        if self.renamed:
256
 
            print >>to_file, 'renamed:'
257
 
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
258
 
                if show_ids:
259
 
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
260
 
                else:
261
 
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
262
 
                    
263
 
        if self.modified:
264
 
            print >>to_file, 'modified:'
265
 
            show_list(self.modified)
266
 
            
267
 
        if show_unchanged and self.unchanged:
268
 
            print >>to_file, 'unchanged:'
269
 
            show_list(self.unchanged)
270
 
 
271
 
 
272
 
 
273
 
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
274
 
    """Describe changes from one tree to another.
275
 
 
276
 
    Returns a TreeDelta with details of added, modified, renamed, and
277
 
    deleted entries.
278
 
 
279
 
    The root entry is specifically exempt.
280
 
 
281
 
    This only considers versioned files.
282
 
 
283
 
    want_unchanged
284
 
        If true, also list files unchanged from one version to
285
 
        the next.
286
 
 
287
 
    specific_files
288
 
        If true, only check for changes to specified names or
289
 
        files within them.
290
 
    """
291
 
 
292
 
    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.
293
502
    
294
 
    old_inv = old_tree.inventory
295
 
    new_inv = new_tree.inventory
296
 
    delta = TreeDelta()
297
 
    mutter('start compare_trees')
298
 
 
299
 
    # TODO: match for specific files can be rather smarter by finding
300
 
    # the IDs of those files up front and then considering only that.
301
 
 
302
 
    for file_id in old_tree:
303
 
        if file_id in new_tree:
304
 
            kind = old_inv.get_file_kind(file_id)
305
 
            assert kind == new_inv.get_file_kind(file_id)
306
 
            
307
 
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
308
 
                   'invalid file kind %r' % kind
309
 
 
310
 
            if kind == 'root_directory':
311
 
                continue
312
 
            
313
 
            old_path = old_inv.id2path(file_id)
314
 
            new_path = new_inv.id2path(file_id)
315
 
 
316
 
            if specific_files:
317
 
                if (not is_inside_any(specific_files, old_path) 
318
 
                    and not is_inside_any(specific_files, new_path)):
319
 
                    continue
320
 
 
321
 
            if kind == 'file':
322
 
                old_sha1 = old_tree.get_file_sha1(file_id)
323
 
                new_sha1 = new_tree.get_file_sha1(file_id)
324
 
                text_modified = (old_sha1 != new_sha1)
325
 
            else:
326
 
                ## mutter("no text to check for %r %r" % (file_id, kind))
327
 
                text_modified = False
328
 
 
329
 
            # TODO: Can possibly avoid calculating path strings if the
330
 
            # two files are unchanged and their names and parents are
331
 
            # the same and the parents are unchanged all the way up.
332
 
            # May not be worthwhile.
333
 
            
334
 
            if old_path != new_path:
335
 
                delta.renamed.append((old_path, new_path, file_id, kind,
336
 
                                      text_modified))
337
 
            elif text_modified:
338
 
                delta.modified.append((new_path, file_id, kind))
339
 
            elif want_unchanged:
340
 
                delta.unchanged.append((new_path, file_id, kind))
341
 
        else:
342
 
            kind = old_inv.get_file_kind(file_id)
343
 
            old_path = old_inv.id2path(file_id)
344
 
            if specific_files:
345
 
                if not is_inside_any(specific_files, old_path):
346
 
                    continue
347
 
            delta.removed.append((old_path, file_id, kind))
348
 
 
349
 
    mutter('start looking for new files')
350
 
    for file_id in new_inv:
351
 
        if file_id in old_inv:
352
 
            continue
353
 
        new_path = new_inv.id2path(file_id)
354
 
        if specific_files:
355
 
            if not is_inside_any(specific_files, new_path):
356
 
                continue
357
 
        kind = new_inv.get_file_kind(file_id)
358
 
        delta.added.append((new_path, file_id, kind))
359
 
            
360
 
    delta.removed.sort()
361
 
    delta.added.sort()
362
 
    delta.renamed.sort()
363
 
    delta.modified.sort()
364
 
    delta.unchanged.sort()
365
 
 
366
 
    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)