← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: John Arbash Meinel
  • Date: 2006-08-21 18:43:38 UTC
  • mto: This revision was merged to the branch mainline in revision 1953.
  • Revision ID: john@arbash-meinel.com-20060821184338-cb3b014ad7281e08
Update test_never_fails, to cover one of the failure points

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 errno
 
18
import os
 
19
import re
 
20
import subprocess
 
21
import sys
 
22
import tempfile
 
23
import time
 
24
 
 
25
# compatability - plugins import compare_trees from diff!!!
 
26
# deprecated as of 0.10
 
27
from bzrlib.delta import compare_trees
 
28
from bzrlib.errors import BzrError
 
29
import bzrlib.errors as errors
 
30
import bzrlib.osutils
 
31
from bzrlib.patiencediff import unified_diff
 
32
import bzrlib.patiencediff
 
33
from bzrlib.symbol_versioning import (deprecated_function,
 
34
        zero_eight)
 
35
from bzrlib.textfile import check_text_lines
 
36
from bzrlib.trace import mutter, warning
20
37
 
21
38
 
22
39
# TODO: Rather than building a changeset object, we should probably
23
40
# invoke callbacks on an object.  That object can either accumulate a
24
41
# list, write them out directly, etc etc.
25
42
 
26
 
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
27
 
    import difflib
28
 
    
 
43
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
44
                  allow_binary=False, sequence_matcher=None,
 
45
                  path_encoding='utf8'):
29
46
    # FIXME: difflib is wrong if there is no trailing newline.
30
47
    # The syntax used by patch seems to be "\ No newline at
31
48
    # end of file" following the last diff line from that
41
58
    # both sequences are empty.
42
59
    if not oldlines and not newlines:
43
60
        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
 
 
 
61
    
 
62
    if allow_binary is False:
 
63
        check_text_lines(oldlines)
 
64
        check_text_lines(newlines)
 
65
 
 
66
    if sequence_matcher is None:
 
67
        sequence_matcher = bzrlib.patiencediff.PatienceSequenceMatcher
 
68
    ud = unified_diff(oldlines, newlines,
 
69
                      fromfile=old_filename.encode(path_encoding),
 
70
                      tofile=new_filename.encode(path_encoding),
 
71
                      sequencematcher=sequence_matcher)
 
72
 
 
73
    ud = list(ud)
57
74
    # work-around for difflib being too smart for its own good
58
75
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
59
76
    if not oldlines:
60
 
        ud = list(ud)
61
77
        ud[2] = ud[2].replace('-1,0', '-0,0')
62
78
    elif not newlines:
63
 
        ud = list(ud)
64
79
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
80
    # work around for difflib emitting random spaces after the label
 
81
    ud[0] = ud[0][:-2] + '\n'
 
82
    ud[1] = ud[1][:-2] + '\n'
65
83
 
66
84
    for line in ud:
67
85
        to_file.write(line)
68
 
    if nonl:
69
 
        print >>to_file, "\\ No newline at end of file"
 
86
        if not line.endswith('\n'):
 
87
            to_file.write("\n\\ No newline at end of file\n")
70
88
    print >>to_file
71
89
 
72
90
 
73
 
 
74
 
 
75
 
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
91
def _set_lang_C():
 
92
    """Set the env var LANG=C"""
 
93
    os.environ['LANG'] = 'C'
 
94
 
 
95
 
 
96
def _spawn_external_diff(diffcmd, capture_errors=True):
 
97
    """Spawn the externall diff process, and return the child handle.
 
98
 
 
99
    :param diffcmd: The command list to spawn
 
100
    :param capture_errors: Capture stderr as well as setting LANG=C.
 
101
        This lets us read and understand the output of diff, and respond 
 
102
        to any errors.
 
103
    :return: A Popen object.
 
104
    """
 
105
    if capture_errors:
 
106
        preexec_fn = _set_lang_C
 
107
        stderr = subprocess.PIPE
 
108
    else:
 
109
        preexec_fn = None
 
110
        stderr = None
 
111
 
 
112
    try:
 
113
        pipe = subprocess.Popen(diffcmd,
 
114
                                stdin=subprocess.PIPE,
 
115
                                stdout=subprocess.PIPE,
 
116
                                stderr=stderr,
 
117
                                preexec_fn=preexec_fn)
 
118
    except OSError, e:
 
119
        if e.errno == errno.ENOENT:
 
120
            raise errors.NoDiff(str(e))
 
121
        raise
 
122
 
 
123
    return pipe
 
124
 
 
125
 
 
126
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
76
127
                  diff_opts):
77
128
    """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
129
    # make sure our own output is properly ordered before the diff
85
130
    to_file.flush()
86
131
 
87
 
    from tempfile import NamedTemporaryFile
88
 
    import os
89
 
 
90
 
    oldtmpf = NamedTemporaryFile()
91
 
    newtmpf = NamedTemporaryFile()
 
132
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
133
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
134
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
135
    newtmpf = os.fdopen(newtmp_fd, 'wb')
92
136
 
93
137
    try:
94
138
        # TODO: perhaps a special case for comparing to or from the empty
101
145
        oldtmpf.writelines(oldlines)
102
146
        newtmpf.writelines(newlines)
103
147
 
104
 
        oldtmpf.flush()
105
 
        newtmpf.flush()
 
148
        oldtmpf.close()
 
149
        newtmpf.close()
106
150
 
107
151
        if not diff_opts:
108
152
            diff_opts = []
109
153
        diffcmd = ['diff',
110
 
                   '--label', old_label,
111
 
                   oldtmpf.name,
112
 
                   '--label', new_label,
113
 
                   newtmpf.name]
 
154
                   '--label', old_filename,
 
155
                   old_abspath,
 
156
                   '--label', new_filename,
 
157
                   new_abspath,
 
158
                   '--binary',
 
159
                  ]
114
160
 
115
161
        # diff only allows one style to be specified; they don't override.
116
162
        # note that some of these take optargs, and the optargs can be
136
182
        if diff_opts:
137
183
            diffcmd.extend(diff_opts)
138
184
 
139
 
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
185
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
186
        out,err = pipe.communicate()
 
187
        rc = pipe.returncode
140
188
        
141
 
        if rc != 0 and rc != 1:
 
189
        # internal_diff() adds a trailing newline, add one here for consistency
 
190
        out += '\n'
 
191
        if rc == 2:
 
192
            # 'diff' gives retcode == 2 for all sorts of errors
 
193
            # one of those is 'Binary files differ'.
 
194
            # Bad options could also be the problem.
 
195
            # 'Binary files' is not a real error, so we suppress that error
 
196
            lang_c_out = out
 
197
 
 
198
            # Since we got here, we want to make sure to give an i18n error
 
199
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
200
            out, err = pipe.communicate()
 
201
 
 
202
            # Write out the new i18n diff response
 
203
            to_file.write(out+'\n')
 
204
            if pipe.returncode != 2:
 
205
                raise BzrError('external diff failed with exit code 2'
 
206
                               ' when run with LANG=C, but not when run'
 
207
                               ' natively: %r' % (diffcmd,))
 
208
 
 
209
            first_line = lang_c_out.split('\n', 1)[0]
 
210
            m = re.match('^binary files.*differ$', first_line, re.I)
 
211
            if m is None:
 
212
                raise BzrError('external diff failed with exit code 2;'
 
213
                               ' command: %r' % (diffcmd,))
 
214
            else:
 
215
                # Binary files differ, just return
 
216
                return
 
217
 
 
218
        # If we got to here, we haven't written out the output of diff
 
219
        # do so now
 
220
        to_file.write(out)
 
221
        if rc not in (0, 1):
142
222
            # returns 1 if files differ; that's OK
143
223
            if rc < 0:
144
224
                msg = 'signal %d' % (-rc)
145
225
            else:
146
226
                msg = 'exit code %d' % rc
147
227
                
148
 
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
228
            raise BzrError('external diff failed with %s; command: %r' 
 
229
                           % (rc, diffcmd))
 
230
 
 
231
 
149
232
    finally:
150
233
        oldtmpf.close()                 # and delete
151
234
        newtmpf.close()
152
 
    
153
 
 
154
 
 
155
 
def show_diff(b, revision, specific_files, external_diff_options=None):
 
235
        # Clean up. Warn in case the files couldn't be deleted
 
236
        # (in case windows still holds the file open, but not
 
237
        # if the files have already been deleted)
 
238
        try:
 
239
            os.remove(old_abspath)
 
240
        except OSError, e:
 
241
            if e.errno not in (errno.ENOENT,):
 
242
                warning('Failed to delete temporary file: %s %s',
 
243
                        old_abspath, e)
 
244
        try:
 
245
            os.remove(new_abspath)
 
246
        except OSError:
 
247
            if e.errno not in (errno.ENOENT,):
 
248
                warning('Failed to delete temporary file: %s %s',
 
249
                        new_abspath, e)
 
250
 
 
251
 
 
252
@deprecated_function(zero_eight)
 
253
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
254
              revision2=None, output=None, b2=None):
156
255
    """Shortcut for showing the diff to the working tree.
157
256
 
 
257
    Please use show_diff_trees instead.
 
258
 
158
259
    b
159
260
        Branch.
160
261
 
161
262
    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
 
 
 
263
        None for 'basis tree', or otherwise the old revision to compare against.
 
264
    
 
265
    The more general form is show_diff_trees(), where the caller
 
266
    supplies any two trees.
 
267
    """
 
268
    if output is None:
 
269
        output = sys.stdout
 
270
 
 
271
    if from_spec is None:
 
272
        old_tree = b.bzrdir.open_workingtree()
 
273
        if b2 is None:
 
274
            old_tree = old_tree = old_tree.basis_tree()
 
275
    else:
 
276
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
277
 
 
278
    if revision2 is None:
 
279
        if b2 is None:
 
280
            new_tree = b.bzrdir.open_workingtree()
 
281
        else:
 
282
            new_tree = b2.bzrdir.open_workingtree()
 
283
    else:
 
284
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
285
 
 
286
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
287
                           external_diff_options)
 
288
 
 
289
 
 
290
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
291
                    old_revision_spec=None, new_revision_spec=None,
 
292
                    old_label='a/', new_label='b/'):
 
293
    """Helper for cmd_diff.
 
294
 
 
295
   tree 
 
296
        A WorkingTree
 
297
 
 
298
    specific_files
 
299
        The specific files to compare, or None
 
300
 
 
301
    external_diff_options
 
302
        If non-None, run an external diff, and pass it these options
 
303
 
 
304
    old_revision_spec
 
305
        If None, use basis tree as old revision, otherwise use the tree for
 
306
        the specified revision. 
 
307
 
 
308
    new_revision_spec
 
309
        If None, use working tree as new revision, otherwise use the tree for
 
310
        the specified revision.
 
311
    
 
312
    The more general form is show_diff_trees(), where the caller
 
313
    supplies any two trees.
 
314
    """
 
315
    def spec_tree(spec):
 
316
        if tree:
 
317
            revision = spec.in_store(tree.branch)
 
318
        else:
 
319
            revision = spec.in_store(None)
 
320
        revision_id = revision.rev_id
 
321
        branch = revision.branch
 
322
        return branch.repository.revision_tree(revision_id)
 
323
    if old_revision_spec is None:
 
324
        old_tree = tree.basis_tree()
 
325
    else:
 
326
        old_tree = spec_tree(old_revision_spec)
 
327
 
 
328
    if new_revision_spec is None:
 
329
        new_tree = tree
 
330
    else:
 
331
        new_tree = spec_tree(new_revision_spec)
 
332
    if new_tree is not tree:
 
333
        extra_trees = (tree,)
 
334
    else:
 
335
        extra_trees = None
 
336
 
 
337
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
338
                           external_diff_options,
 
339
                           old_label=old_label, new_label=new_label,
 
340
                           extra_trees=extra_trees)
179
341
 
180
342
 
181
343
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
182
 
                    external_diff_options=None):
 
344
                    external_diff_options=None,
 
345
                    old_label='a/', new_label='b/',
 
346
                    extra_trees=None):
183
347
    """Show in text form the changes from one tree to another.
184
348
 
185
349
    to_files
187
351
 
188
352
    external_diff_options
189
353
        If set, use an external GNU diff and pass these options.
 
354
 
 
355
    extra_trees
 
356
        If set, more Trees to use for looking up file ids
190
357
    """
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.
 
358
    old_tree.lock_read()
 
359
    try:
 
360
        new_tree.lock_read()
 
361
        try:
 
362
            return _show_diff_trees(old_tree, new_tree, to_file,
 
363
                                    specific_files, external_diff_options,
 
364
                                    old_label=old_label, new_label=new_label,
 
365
                                    extra_trees=extra_trees)
 
366
        finally:
 
367
            new_tree.unlock()
 
368
    finally:
 
369
        old_tree.unlock()
 
370
 
 
371
 
 
372
def _show_diff_trees(old_tree, new_tree, to_file,
 
373
                     specific_files, external_diff_options, 
 
374
                     old_label='a/', new_label='b/', extra_trees=None):
 
375
 
 
376
    # GNU Patch uses the epoch date to detect files that are being added
 
377
    # or removed in a diff.
 
378
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
200
379
 
201
380
    # TODO: Generation of pseudo-diffs for added/deleted files could
202
381
    # be usefully made into a much faster special case.
209
388
    else:
210
389
        diff_file = internal_diff
211
390
    
212
 
 
213
 
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
214
 
                          specific_files=specific_files)
215
 
 
 
391
    delta = new_tree.changes_from(old_tree,
 
392
        specific_files=specific_files,
 
393
        extra_trees=extra_trees, require_versioned=True)
 
394
 
 
395
    has_changes = 0
216
396
    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
 
 
 
397
        has_changes = 1
 
398
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
399
        old_name = '%s%s\t%s' % (old_label, path,
 
400
                                 _patch_header_date(old_tree, file_id, path))
 
401
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
402
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
403
                                         new_name, None, None, to_file)
225
404
    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)
 
405
        has_changes = 1
 
406
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
407
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
408
        new_name = '%s%s\t%s' % (new_label, path,
 
409
                                 _patch_header_date(new_tree, file_id, path))
 
410
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
411
                                         old_name, None, None, to_file, 
 
412
                                         reverse=True)
 
413
    for (old_path, new_path, file_id, kind,
 
414
         text_modified, meta_modified) in delta.renamed:
 
415
        has_changes = 1
 
416
        prop_str = get_prop_change(meta_modified)
 
417
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
418
                    kind, old_path.encode('utf8'),
 
419
                    new_path.encode('utf8'), prop_str)
 
420
        old_name = '%s%s\t%s' % (old_label, old_path,
 
421
                                 _patch_header_date(old_tree, file_id,
 
422
                                                    old_path))
 
423
        new_name = '%s%s\t%s' % (new_label, new_path,
 
424
                                 _patch_header_date(new_tree, file_id,
 
425
                                                    new_path))
 
426
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
427
                                    new_name, new_tree,
 
428
                                    text_modified, kind, to_file, diff_file)
 
429
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
430
        has_changes = 1
 
431
        prop_str = get_prop_change(meta_modified)
 
432
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
433
        old_name = '%s%s\t%s' % (old_label, path,
 
434
                                 _patch_header_date(old_tree, file_id, path))
 
435
        new_name = '%s%s\t%s' % (new_label, path,
 
436
                                 _patch_header_date(new_tree, file_id, path))
236
437
        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
 
438
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
439
                                        new_name, new_tree,
 
440
                                        True, kind, to_file, diff_file)
 
441
 
 
442
    return has_changes
 
443
 
 
444
 
 
445
def _patch_header_date(tree, file_id, path):
 
446
    """Returns a timestamp suitable for use in a patch header."""
 
447
    tm = time.gmtime(tree.get_file_mtime(file_id, path))
 
448
    return time.strftime('%Y-%m-%d %H:%M:%S +0000', tm)
 
449
 
 
450
 
 
451
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
452
    """Complain if paths are not in either inventory or tree.
 
453
 
 
454
    It's OK with the files exist in either tree's inventory, or 
 
455
    if they exist in the tree but are not versioned.
381
456
    
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
 
457
    This can be used by operations such as bzr status that can accept
 
458
    unknown or ignored files.
 
459
    """
 
460
    mutter("check paths: %r", paths)
 
461
    if not paths:
 
462
        return
 
463
    s = old_tree.filter_unversioned_files(paths)
 
464
    s = new_tree.filter_unversioned_files(s)
 
465
    s = [path for path in s if not new_tree.has_filename(path)]
 
466
    if s:
 
467
        raise errors.PathsDoNotExist(sorted(s))
 
468
 
 
469
 
 
470
def get_prop_change(meta_modified):
 
471
    if meta_modified:
 
472
        return " (properties changed)"
 
473
    else:
 
474
        return  ""
 
475
 
 
476
 
 
477
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
478
                                new_path, new_tree, text_modified,
 
479
                                kind, to_file, diff_file):
 
480
    if text_modified:
 
481
        new_entry = new_tree.inventory[file_id]
 
482
        old_tree.inventory[file_id].diff(diff_file,
 
483
                                         old_path, old_tree,
 
484
                                         new_path, new_entry, 
 
485
                                         new_tree, to_file)