/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Albisetti
  • Date: 2008-04-08 22:56:38 UTC
  • mto: (3350.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 3351.
  • Revision ID: argentina@gmail.com-20080408225638-ghmlbx6afr7fy0g1
 * Change to module imports to alphabetical order
 * Small tweak in indention

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
2
#
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
#
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
#
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
import difflib
 
18
import os
 
19
import re
 
20
import shutil
 
21
import sys
 
22
 
 
23
from bzrlib.lazy_import import lazy_import
 
24
lazy_import(globals(), """
 
25
import errno
 
26
import subprocess
 
27
import tempfile
 
28
import time
 
29
 
 
30
from bzrlib import (
 
31
    bzrdir,
 
32
    commands,
 
33
    errors,
 
34
    osutils,
 
35
    patiencediff,
 
36
    textfile,
 
37
    timestamp,
 
38
    )
 
39
""")
 
40
 
 
41
from bzrlib.symbol_versioning import (
 
42
        deprecated_function,
 
43
        one_zero,
 
44
        one_three
 
45
        )
 
46
from bzrlib.trace import mutter, warning
 
47
 
 
48
 
 
49
# TODO: Rather than building a changeset object, we should probably
 
50
# invoke callbacks on an object.  That object can either accumulate a
 
51
# list, write them out directly, etc etc.
 
52
 
 
53
 
 
54
class _PrematchedMatcher(difflib.SequenceMatcher):
 
55
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
56
 
 
57
    def __init__(self, matching_blocks):
 
58
        difflib.SequenceMatcher(self, None, None)
 
59
        self.matching_blocks = matching_blocks
 
60
        self.opcodes = None
 
61
 
 
62
 
 
63
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
64
                  allow_binary=False, sequence_matcher=None,
 
65
                  path_encoding='utf8'):
 
66
    # FIXME: difflib is wrong if there is no trailing newline.
 
67
    # The syntax used by patch seems to be "\ No newline at
 
68
    # end of file" following the last diff line from that
 
69
    # file.  This is not trivial to insert into the
 
70
    # unified_diff output and it might be better to just fix
 
71
    # or replace that function.
 
72
 
 
73
    # In the meantime we at least make sure the patch isn't
 
74
    # mangled.
 
75
 
 
76
 
 
77
    # Special workaround for Python2.3, where difflib fails if
 
78
    # both sequences are empty.
 
79
    if not oldlines and not newlines:
 
80
        return
 
81
    
 
82
    if allow_binary is False:
 
83
        textfile.check_text_lines(oldlines)
 
84
        textfile.check_text_lines(newlines)
 
85
 
 
86
    if sequence_matcher is None:
 
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
88
    ud = patiencediff.unified_diff(oldlines, newlines,
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
 
91
                      sequencematcher=sequence_matcher)
 
92
 
 
93
    ud = list(ud)
 
94
    if len(ud) == 0: # Identical contents, nothing to do
 
95
        return
 
96
    # work-around for difflib being too smart for its own good
 
97
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
98
    if not oldlines:
 
99
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
100
    elif not newlines:
 
101
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
102
    # work around for difflib emitting random spaces after the label
 
103
    ud[0] = ud[0][:-2] + '\n'
 
104
    ud[1] = ud[1][:-2] + '\n'
 
105
 
 
106
    for line in ud:
 
107
        to_file.write(line)
 
108
        if not line.endswith('\n'):
 
109
            to_file.write("\n\\ No newline at end of file\n")
 
110
    to_file.write('\n')
 
111
 
 
112
 
 
113
def _spawn_external_diff(diffcmd, capture_errors=True):
 
114
    """Spawn the externall diff process, and return the child handle.
 
115
 
 
116
    :param diffcmd: The command list to spawn
 
117
    :param capture_errors: Capture stderr as well as setting LANG=C
 
118
        and LC_ALL=C. This lets us read and understand the output of diff,
 
119
        and respond to any errors.
 
120
    :return: A Popen object.
 
121
    """
 
122
    if capture_errors:
 
123
        # construct minimal environment
 
124
        env = {}
 
125
        path = os.environ.get('PATH')
 
126
        if path is not None:
 
127
            env['PATH'] = path
 
128
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
129
        env['LANG'] = 'C'
 
130
        env['LC_ALL'] = 'C'
 
131
        stderr = subprocess.PIPE
 
132
    else:
 
133
        env = None
 
134
        stderr = None
 
135
 
 
136
    try:
 
137
        pipe = subprocess.Popen(diffcmd,
 
138
                                stdin=subprocess.PIPE,
 
139
                                stdout=subprocess.PIPE,
 
140
                                stderr=stderr,
 
141
                                env=env)
 
142
    except OSError, e:
 
143
        if e.errno == errno.ENOENT:
 
144
            raise errors.NoDiff(str(e))
 
145
        raise
 
146
 
 
147
    return pipe
 
148
 
 
149
 
 
150
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
151
                  diff_opts):
 
152
    """Display a diff by calling out to the external diff program."""
 
153
    # make sure our own output is properly ordered before the diff
 
154
    to_file.flush()
 
155
 
 
156
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
157
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
158
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
159
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
160
 
 
161
    try:
 
162
        # TODO: perhaps a special case for comparing to or from the empty
 
163
        # sequence; can just use /dev/null on Unix
 
164
 
 
165
        # TODO: if either of the files being compared already exists as a
 
166
        # regular named file (e.g. in the working directory) then we can
 
167
        # compare directly to that, rather than copying it.
 
168
 
 
169
        oldtmpf.writelines(oldlines)
 
170
        newtmpf.writelines(newlines)
 
171
 
 
172
        oldtmpf.close()
 
173
        newtmpf.close()
 
174
 
 
175
        if not diff_opts:
 
176
            diff_opts = []
 
177
        diffcmd = ['diff',
 
178
                   '--label', old_filename,
 
179
                   old_abspath,
 
180
                   '--label', new_filename,
 
181
                   new_abspath,
 
182
                   '--binary',
 
183
                  ]
 
184
 
 
185
        # diff only allows one style to be specified; they don't override.
 
186
        # note that some of these take optargs, and the optargs can be
 
187
        # directly appended to the options.
 
188
        # this is only an approximate parser; it doesn't properly understand
 
189
        # the grammar.
 
190
        for s in ['-c', '-u', '-C', '-U',
 
191
                  '-e', '--ed',
 
192
                  '-q', '--brief',
 
193
                  '--normal',
 
194
                  '-n', '--rcs',
 
195
                  '-y', '--side-by-side',
 
196
                  '-D', '--ifdef']:
 
197
            for j in diff_opts:
 
198
                if j.startswith(s):
 
199
                    break
 
200
            else:
 
201
                continue
 
202
            break
 
203
        else:
 
204
            diffcmd.append('-u')
 
205
                  
 
206
        if diff_opts:
 
207
            diffcmd.extend(diff_opts)
 
208
 
 
209
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
210
        out,err = pipe.communicate()
 
211
        rc = pipe.returncode
 
212
        
 
213
        # internal_diff() adds a trailing newline, add one here for consistency
 
214
        out += '\n'
 
215
        if rc == 2:
 
216
            # 'diff' gives retcode == 2 for all sorts of errors
 
217
            # one of those is 'Binary files differ'.
 
218
            # Bad options could also be the problem.
 
219
            # 'Binary files' is not a real error, so we suppress that error.
 
220
            lang_c_out = out
 
221
 
 
222
            # Since we got here, we want to make sure to give an i18n error
 
223
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
224
            out, err = pipe.communicate()
 
225
 
 
226
            # Write out the new i18n diff response
 
227
            to_file.write(out+'\n')
 
228
            if pipe.returncode != 2:
 
229
                raise errors.BzrError(
 
230
                               'external diff failed with exit code 2'
 
231
                               ' when run with LANG=C and LC_ALL=C,'
 
232
                               ' but not when run natively: %r' % (diffcmd,))
 
233
 
 
234
            first_line = lang_c_out.split('\n', 1)[0]
 
235
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
236
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
237
            if m is None:
 
238
                raise errors.BzrError('external diff failed with exit code 2;'
 
239
                                      ' command: %r' % (diffcmd,))
 
240
            else:
 
241
                # Binary files differ, just return
 
242
                return
 
243
 
 
244
        # If we got to here, we haven't written out the output of diff
 
245
        # do so now
 
246
        to_file.write(out)
 
247
        if rc not in (0, 1):
 
248
            # returns 1 if files differ; that's OK
 
249
            if rc < 0:
 
250
                msg = 'signal %d' % (-rc)
 
251
            else:
 
252
                msg = 'exit code %d' % rc
 
253
                
 
254
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
255
                                  % (rc, diffcmd))
 
256
 
 
257
 
 
258
    finally:
 
259
        oldtmpf.close()                 # and delete
 
260
        newtmpf.close()
 
261
        # Clean up. Warn in case the files couldn't be deleted
 
262
        # (in case windows still holds the file open, but not
 
263
        # if the files have already been deleted)
 
264
        try:
 
265
            os.remove(old_abspath)
 
266
        except OSError, e:
 
267
            if e.errno not in (errno.ENOENT,):
 
268
                warning('Failed to delete temporary file: %s %s',
 
269
                        old_abspath, e)
 
270
        try:
 
271
            os.remove(new_abspath)
 
272
        except OSError:
 
273
            if e.errno not in (errno.ENOENT,):
 
274
                warning('Failed to delete temporary file: %s %s',
 
275
                        new_abspath, e)
 
276
 
 
277
 
 
278
@deprecated_function(one_zero)
 
279
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
280
                    old_revision_spec=None, new_revision_spec=None,
 
281
                    revision_specs=None,
 
282
                    old_label='a/', new_label='b/'):
 
283
    """Helper for cmd_diff.
 
284
 
 
285
    :param tree:
 
286
        A WorkingTree
 
287
 
 
288
    :param specific_files:
 
289
        The specific files to compare, or None
 
290
 
 
291
    :param external_diff_options:
 
292
        If non-None, run an external diff, and pass it these options
 
293
 
 
294
    :param old_revision_spec:
 
295
        If None, use basis tree as old revision, otherwise use the tree for
 
296
        the specified revision. 
 
297
 
 
298
    :param new_revision_spec:
 
299
        If None, use working tree as new revision, otherwise use the tree for
 
300
        the specified revision.
 
301
    
 
302
    :param revision_specs: 
 
303
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
 
304
        to compare.  This can be passed as an alternative to the old_revision_spec 
 
305
        and new_revision_spec parameters.
 
306
 
 
307
    The more general form is show_diff_trees(), where the caller
 
308
    supplies any two trees.
 
309
    """
 
310
 
 
311
    # TODO: perhaps remove the old parameters old_revision_spec and
 
312
    # new_revision_spec, since this is only really for use from cmd_diff and
 
313
    # it now always passes through a sequence of revision_specs -- mbp
 
314
    # 20061221
 
315
 
 
316
    def spec_tree(spec):
 
317
        if tree:
 
318
            revision = spec.in_store(tree.branch)
 
319
        else:
 
320
            revision = spec.in_store(None)
 
321
        revision_id = revision.rev_id
 
322
        branch = revision.branch
 
323
        return branch.repository.revision_tree(revision_id)
 
324
 
 
325
    if revision_specs is not None:
 
326
        assert (old_revision_spec is None
 
327
                and new_revision_spec is None)
 
328
        if len(revision_specs) > 0:
 
329
            old_revision_spec = revision_specs[0]
 
330
        if len(revision_specs) > 1:
 
331
            new_revision_spec = revision_specs[1]
 
332
 
 
333
    if old_revision_spec is None:
 
334
        old_tree = tree.basis_tree()
 
335
    else:
 
336
        old_tree = spec_tree(old_revision_spec)
 
337
 
 
338
    if (new_revision_spec is None
 
339
        or new_revision_spec.spec is None):
 
340
        new_tree = tree
 
341
    else:
 
342
        new_tree = spec_tree(new_revision_spec)
 
343
 
 
344
    if new_tree is not tree:
 
345
        extra_trees = (tree,)
 
346
    else:
 
347
        extra_trees = None
 
348
 
 
349
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
350
                           external_diff_options,
 
351
                           old_label=old_label, new_label=new_label,
 
352
                           extra_trees=extra_trees)
 
353
 
 
354
 
 
355
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
 
356
    """Get the trees and specific files to diff given a list of paths.
 
357
 
 
358
    This method works out the trees to be diff'ed and the files of
 
359
    interest within those trees.
 
360
 
 
361
    :param path_list:
 
362
        the list of arguments passed to the diff command
 
363
    :param revision_specs:
 
364
        Zero, one or two RevisionSpecs from the diff command line,
 
365
        saying what revisions to compare.
 
366
    :param old_url:
 
367
        The url of the old branch or tree. If None, the tree to use is
 
368
        taken from the first path, if any, or the current working tree.
 
369
    :param new_url:
 
370
        The url of the new branch or tree. If None, the tree to use is
 
371
        taken from the first path, if any, or the current working tree.
 
372
    :returns:
 
373
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
374
        extra_trees is a sequence of additional trees to search in for
 
375
        file-ids.
 
376
    """
 
377
    # Get the old and new revision specs
 
378
    old_revision_spec = None
 
379
    new_revision_spec = None
 
380
    if revision_specs is not None:
 
381
        if len(revision_specs) > 0:
 
382
            old_revision_spec = revision_specs[0]
 
383
            if old_url is None:
 
384
                old_url = old_revision_spec.get_branch()
 
385
        if len(revision_specs) > 1:
 
386
            new_revision_spec = revision_specs[1]
 
387
            if new_url is None:
 
388
                new_url = new_revision_spec.get_branch()
 
389
 
 
390
    other_paths = []
 
391
    make_paths_wt_relative = True
 
392
    consider_relpath = True
 
393
    if path_list is None or len(path_list) == 0:
 
394
        # If no path is given, the current working tree is used
 
395
        default_location = u'.'
 
396
        consider_relpath = False
 
397
    elif old_url is not None and new_url is not None:
 
398
        other_paths = path_list
 
399
        make_paths_wt_relative = False
 
400
    else:
 
401
        default_location = path_list[0]
 
402
        other_paths = path_list[1:]
 
403
 
 
404
    # Get the old location
 
405
    specific_files = []
 
406
    if old_url is None:
 
407
        old_url = default_location
 
408
    working_tree, branch, relpath = \
 
409
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
410
    if consider_relpath and relpath != '':
 
411
        specific_files.append(relpath)
 
412
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
413
 
 
414
    # Get the new location
 
415
    if new_url is None:
 
416
        new_url = default_location
 
417
    if new_url != old_url:
 
418
        working_tree, branch, relpath = \
 
419
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
420
        if consider_relpath and relpath != '':
 
421
            specific_files.append(relpath)
 
422
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
 
423
        basis_is_default=working_tree is None)
 
424
 
 
425
    # Get the specific files (all files is None, no files is [])
 
426
    if make_paths_wt_relative and working_tree is not None:
 
427
        other_paths = _relative_paths_in_tree(working_tree, other_paths)
 
428
    specific_files.extend(other_paths)
 
429
    if len(specific_files) == 0:
 
430
        specific_files = None
 
431
 
 
432
    # Get extra trees that ought to be searched for file-ids
 
433
    extra_trees = None
 
434
    if working_tree is not None and working_tree not in (old_tree, new_tree):
 
435
        extra_trees = (working_tree,)
 
436
    return old_tree, new_tree, specific_files, extra_trees
 
437
 
 
438
 
 
439
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
 
440
    if branch is None and tree is not None:
 
441
        branch = tree.branch
 
442
    if spec is None or spec.spec is None:
 
443
        if basis_is_default:
 
444
            if tree is not None:
 
445
                return tree.basis_tree()
 
446
            else:
 
447
                return branch.basis_tree()
 
448
        else:
 
449
            return tree
 
450
    revision = spec.in_store(branch)
 
451
    revision_id = revision.rev_id
 
452
    rev_branch = revision.branch
 
453
    return rev_branch.repository.revision_tree(revision_id)
 
454
 
 
455
 
 
456
def _relative_paths_in_tree(tree, paths):
 
457
    """Get the relative paths within a working tree.
 
458
 
 
459
    Each path may be either an absolute path or a path relative to the
 
460
    current working directory.
 
461
    """
 
462
    result = []
 
463
    for filename in paths:
 
464
        try:
 
465
            result.append(tree.relpath(osutils.dereference_path(filename)))
 
466
        except errors.PathNotChild:
 
467
            raise errors.BzrCommandError("Files are in different branches")
 
468
    return result
 
469
 
 
470
 
 
471
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
472
                    external_diff_options=None,
 
473
                    old_label='a/', new_label='b/',
 
474
                    extra_trees=None,
 
475
                    path_encoding='utf8',
 
476
                    using=None):
 
477
    """Show in text form the changes from one tree to another.
 
478
 
 
479
    to_file
 
480
        The output stream.
 
481
 
 
482
    specific_files
 
483
        Include only changes to these files - None for all changes.
 
484
 
 
485
    external_diff_options
 
486
        If set, use an external GNU diff and pass these options.
 
487
 
 
488
    extra_trees
 
489
        If set, more Trees to use for looking up file ids
 
490
 
 
491
    path_encoding
 
492
        If set, the path will be encoded as specified, otherwise is supposed
 
493
        to be utf8
 
494
    """
 
495
    old_tree.lock_read()
 
496
    try:
 
497
        if extra_trees is not None:
 
498
            for tree in extra_trees:
 
499
                tree.lock_read()
 
500
        new_tree.lock_read()
 
501
        try:
 
502
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
503
                                                 path_encoding,
 
504
                                                 external_diff_options,
 
505
                                                 old_label, new_label, using)
 
506
            return differ.show_diff(specific_files, extra_trees)
 
507
        finally:
 
508
            new_tree.unlock()
 
509
            if extra_trees is not None:
 
510
                for tree in extra_trees:
 
511
                    tree.unlock()
 
512
    finally:
 
513
        old_tree.unlock()
 
514
 
 
515
 
 
516
def _patch_header_date(tree, file_id, path):
 
517
    """Returns a timestamp suitable for use in a patch header."""
 
518
    mtime = tree.get_file_mtime(file_id, path)
 
519
    assert mtime is not None, \
 
520
        "got an mtime of None for file-id %s, path %s in tree %s" % (
 
521
                file_id, path, tree)
 
522
    return timestamp.format_patch_date(mtime)
 
523
 
 
524
 
 
525
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
526
    """Complain if paths are not in either inventory or tree.
 
527
 
 
528
    It's OK with the files exist in either tree's inventory, or 
 
529
    if they exist in the tree but are not versioned.
 
530
    
 
531
    This can be used by operations such as bzr status that can accept
 
532
    unknown or ignored files.
 
533
    """
 
534
    mutter("check paths: %r", paths)
 
535
    if not paths:
 
536
        return
 
537
    s = old_tree.filter_unversioned_files(paths)
 
538
    s = new_tree.filter_unversioned_files(s)
 
539
    s = [path for path in s if not new_tree.has_filename(path)]
 
540
    if s:
 
541
        raise errors.PathsDoNotExist(sorted(s))
 
542
 
 
543
 
 
544
@deprecated_function(one_three)
 
545
def get_prop_change(meta_modified):
 
546
    if meta_modified:
 
547
        return " (properties changed)"
 
548
    else:
 
549
        return  ""
 
550
 
 
551
def get_executable_change(old_is_x, new_is_x):
 
552
    descr = { True:"+x", False:"-x", None:"??" }
 
553
    if old_is_x != new_is_x:
 
554
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
555
    else:
 
556
        return []
 
557
 
 
558
 
 
559
class DiffPath(object):
 
560
    """Base type for command object that compare files"""
 
561
 
 
562
    # The type or contents of the file were unsuitable for diffing
 
563
    CANNOT_DIFF = 'CANNOT_DIFF'
 
564
    # The file has changed in a semantic way
 
565
    CHANGED = 'CHANGED'
 
566
    # The file content may have changed, but there is no semantic change
 
567
    UNCHANGED = 'UNCHANGED'
 
568
 
 
569
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
 
570
        """Constructor.
 
571
 
 
572
        :param old_tree: The tree to show as the old tree in the comparison
 
573
        :param new_tree: The tree to show as new in the comparison
 
574
        :param to_file: The file to write comparison data to
 
575
        :param path_encoding: The character encoding to write paths in
 
576
        """
 
577
        self.old_tree = old_tree
 
578
        self.new_tree = new_tree
 
579
        self.to_file = to_file
 
580
        self.path_encoding = path_encoding
 
581
 
 
582
    def finish(self):
 
583
        pass
 
584
 
 
585
    @classmethod
 
586
    def from_diff_tree(klass, diff_tree):
 
587
        return klass(diff_tree.old_tree, diff_tree.new_tree,
 
588
                     diff_tree.to_file, diff_tree.path_encoding)
 
589
 
 
590
    @staticmethod
 
591
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
 
592
        for file_differ in differs:
 
593
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
 
594
                                      new_kind)
 
595
            if result is not DiffPath.CANNOT_DIFF:
 
596
                return result
 
597
        else:
 
598
            return DiffPath.CANNOT_DIFF
 
599
 
 
600
 
 
601
class DiffKindChange(object):
 
602
    """Special differ for file kind changes.
 
603
 
 
604
    Represents kind change as deletion + creation.  Uses the other differs
 
605
    to do this.
 
606
    """
 
607
    def __init__(self, differs):
 
608
        self.differs = differs
 
609
 
 
610
    def finish(self):
 
611
        pass
 
612
 
 
613
    @classmethod
 
614
    def from_diff_tree(klass, diff_tree):
 
615
        return klass(diff_tree.differs)
 
616
 
 
617
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
618
        """Perform comparison
 
619
 
 
620
        :param file_id: The file_id of the file to compare
 
621
        :param old_path: Path of the file in the old tree
 
622
        :param new_path: Path of the file in the new tree
 
623
        :param old_kind: Old file-kind of the file
 
624
        :param new_kind: New file-kind of the file
 
625
        """
 
626
        if None in (old_kind, new_kind):
 
627
            return DiffPath.CANNOT_DIFF
 
628
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
629
                                       new_path, old_kind, None)
 
630
        if result is DiffPath.CANNOT_DIFF:
 
631
            return result
 
632
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
 
633
                                     None, new_kind)
 
634
 
 
635
 
 
636
class DiffDirectory(DiffPath):
 
637
 
 
638
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
639
        """Perform comparison between two directories.  (dummy)
 
640
 
 
641
        """
 
642
        if 'directory' not in (old_kind, new_kind):
 
643
            return self.CANNOT_DIFF
 
644
        if old_kind not in ('directory', None):
 
645
            return self.CANNOT_DIFF
 
646
        if new_kind not in ('directory', None):
 
647
            return self.CANNOT_DIFF
 
648
        return self.CHANGED
 
649
 
 
650
 
 
651
class DiffSymlink(DiffPath):
 
652
 
 
653
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
654
        """Perform comparison between two symlinks
 
655
 
 
656
        :param file_id: The file_id of the file to compare
 
657
        :param old_path: Path of the file in the old tree
 
658
        :param new_path: Path of the file in the new tree
 
659
        :param old_kind: Old file-kind of the file
 
660
        :param new_kind: New file-kind of the file
 
661
        """
 
662
        if 'symlink' not in (old_kind, new_kind):
 
663
            return self.CANNOT_DIFF
 
664
        if old_kind == 'symlink':
 
665
            old_target = self.old_tree.get_symlink_target(file_id)
 
666
        elif old_kind is None:
 
667
            old_target = None
 
668
        else:
 
669
            return self.CANNOT_DIFF
 
670
        if new_kind == 'symlink':
 
671
            new_target = self.new_tree.get_symlink_target(file_id)
 
672
        elif new_kind is None:
 
673
            new_target = None
 
674
        else:
 
675
            return self.CANNOT_DIFF
 
676
        return self.diff_symlink(old_target, new_target)
 
677
 
 
678
    def diff_symlink(self, old_target, new_target):
 
679
        if old_target is None:
 
680
            self.to_file.write('=== target is %r\n' % new_target)
 
681
        elif new_target is None:
 
682
            self.to_file.write('=== target was %r\n' % old_target)
 
683
        else:
 
684
            self.to_file.write('=== target changed %r => %r\n' %
 
685
                              (old_target, new_target))
 
686
        return self.CHANGED
 
687
 
 
688
 
 
689
class DiffText(DiffPath):
 
690
 
 
691
    # GNU Patch uses the epoch date to detect files that are being added
 
692
    # or removed in a diff.
 
693
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
694
 
 
695
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
696
                 old_label='', new_label='', text_differ=internal_diff):
 
697
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
698
        self.text_differ = text_differ
 
699
        self.old_label = old_label
 
700
        self.new_label = new_label
 
701
        self.path_encoding = path_encoding
 
702
 
 
703
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
704
        """Compare two files in unified diff format
 
705
 
 
706
        :param file_id: The file_id of the file to compare
 
707
        :param old_path: Path of the file in the old tree
 
708
        :param new_path: Path of the file in the new tree
 
709
        :param old_kind: Old file-kind of the file
 
710
        :param new_kind: New file-kind of the file
 
711
        """
 
712
        if 'file' not in (old_kind, new_kind):
 
713
            return self.CANNOT_DIFF
 
714
        from_file_id = to_file_id = file_id
 
715
        if old_kind == 'file':
 
716
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
 
717
        elif old_kind is None:
 
718
            old_date = self.EPOCH_DATE
 
719
            from_file_id = None
 
720
        else:
 
721
            return self.CANNOT_DIFF
 
722
        if new_kind == 'file':
 
723
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
 
724
        elif new_kind is None:
 
725
            new_date = self.EPOCH_DATE
 
726
            to_file_id = None
 
727
        else:
 
728
            return self.CANNOT_DIFF
 
729
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
730
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
731
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
732
 
 
733
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
734
        """Diff the content of given files in two trees
 
735
 
 
736
        :param from_file_id: The id of the file in the from tree.  If None,
 
737
            the file is not present in the from tree.
 
738
        :param to_file_id: The id of the file in the to tree.  This may refer
 
739
            to a different file from from_file_id.  If None,
 
740
            the file is not present in the to tree.
 
741
        """
 
742
        def _get_text(tree, file_id):
 
743
            if file_id is not None:
 
744
                return tree.get_file(file_id).readlines()
 
745
            else:
 
746
                return []
 
747
        try:
 
748
            from_text = _get_text(self.old_tree, from_file_id)
 
749
            to_text = _get_text(self.new_tree, to_file_id)
 
750
            self.text_differ(from_label, from_text, to_label, to_text,
 
751
                             self.to_file)
 
752
        except errors.BinaryFile:
 
753
            self.to_file.write(
 
754
                  ("Binary files %s and %s differ\n" %
 
755
                  (from_label, to_label)).encode(self.path_encoding))
 
756
        return self.CHANGED
 
757
 
 
758
 
 
759
class DiffFromTool(DiffPath):
 
760
 
 
761
    def __init__(self, command_template, old_tree, new_tree, to_file,
 
762
                 path_encoding='utf-8'):
 
763
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
764
        self.command_template = command_template
 
765
        self._root = tempfile.mkdtemp(prefix='bzr-diff-')
 
766
 
 
767
    @classmethod
 
768
    def from_string(klass, command_string, old_tree, new_tree, to_file,
 
769
                    path_encoding='utf-8'):
 
770
        command_template = commands.shlex_split_unicode(command_string)
 
771
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
772
        return klass(command_template, old_tree, new_tree, to_file,
 
773
                     path_encoding)
 
774
 
 
775
    @classmethod
 
776
    def make_from_diff_tree(klass, command_string):
 
777
        def from_diff_tree(diff_tree):
 
778
            return klass.from_string(command_string, diff_tree.old_tree,
 
779
                                     diff_tree.new_tree, diff_tree.to_file)
 
780
        return from_diff_tree
 
781
 
 
782
    def _get_command(self, old_path, new_path):
 
783
        my_map = {'old_path': old_path, 'new_path': new_path}
 
784
        return [t % my_map for t in self.command_template]
 
785
 
 
786
    def _execute(self, old_path, new_path):
 
787
        command = self._get_command(old_path, new_path)
 
788
        try:
 
789
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
 
790
                                    cwd=self._root)
 
791
        except OSError, e:
 
792
            if e.errno == errno.ENOENT:
 
793
                raise errors.ExecutableMissing(command[0])
 
794
            else:
 
795
                raise
 
796
        self.to_file.write(proc.stdout.read())
 
797
        return proc.wait()
 
798
 
 
799
    def _try_symlink_root(self, tree, prefix):
 
800
        if not (getattr(tree, 'abspath', None) is not None
 
801
                and osutils.has_symlinks()):
 
802
            return False
 
803
        try:
 
804
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
 
805
        except OSError, e:
 
806
            if e.errno != errno.EEXIST:
 
807
                raise
 
808
        return True
 
809
 
 
810
    def _write_file(self, file_id, tree, prefix, relpath):
 
811
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
812
        if self._try_symlink_root(tree, prefix):
 
813
            return full_path
 
814
        parent_dir = osutils.dirname(full_path)
 
815
        try:
 
816
            os.makedirs(parent_dir)
 
817
        except OSError, e:
 
818
            if e.errno != errno.EEXIST:
 
819
                raise
 
820
        source = tree.get_file(file_id, relpath)
 
821
        try:
 
822
            target = open(full_path, 'wb')
 
823
            try:
 
824
                osutils.pumpfile(source, target)
 
825
            finally:
 
826
                target.close()
 
827
        finally:
 
828
            source.close()
 
829
        osutils.make_readonly(full_path)
 
830
        mtime = tree.get_file_mtime(file_id)
 
831
        os.utime(full_path, (mtime, mtime))
 
832
        return full_path
 
833
 
 
834
    def _prepare_files(self, file_id, old_path, new_path):
 
835
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
836
                                         old_path)
 
837
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
838
                                         new_path)
 
839
        return old_disk_path, new_disk_path
 
840
 
 
841
    def finish(self):
 
842
        osutils.rmtree(self._root)
 
843
 
 
844
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
845
        if (old_kind, new_kind) != ('file', 'file'):
 
846
            return DiffPath.CANNOT_DIFF
 
847
        self._prepare_files(file_id, old_path, new_path)
 
848
        self._execute(osutils.pathjoin('old', old_path),
 
849
                      osutils.pathjoin('new', new_path))
 
850
 
 
851
 
 
852
class DiffTree(object):
 
853
    """Provides textual representations of the difference between two trees.
 
854
 
 
855
    A DiffTree examines two trees and where a file-id has altered
 
856
    between them, generates a textual representation of the difference.
 
857
    DiffTree uses a sequence of DiffPath objects which are each
 
858
    given the opportunity to handle a given altered fileid. The list
 
859
    of DiffPath objects can be extended globally by appending to
 
860
    DiffTree.diff_factories, or for a specific diff operation by
 
861
    supplying the extra_factories option to the appropriate method.
 
862
    """
 
863
 
 
864
    # list of factories that can provide instances of DiffPath objects
 
865
    # may be extended by plugins.
 
866
    diff_factories = [DiffSymlink.from_diff_tree,
 
867
                      DiffDirectory.from_diff_tree]
 
868
 
 
869
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
870
                 diff_text=None, extra_factories=None):
 
871
        """Constructor
 
872
 
 
873
        :param old_tree: Tree to show as old in the comparison
 
874
        :param new_tree: Tree to show as new in the comparison
 
875
        :param to_file: File to write comparision to
 
876
        :param path_encoding: Character encoding to write paths in
 
877
        :param diff_text: DiffPath-type object to use as a last resort for
 
878
            diffing text files.
 
879
        :param extra_factories: Factories of DiffPaths to try before any other
 
880
            DiffPaths"""
 
881
        if diff_text is None:
 
882
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
883
                                 '', '',  internal_diff)
 
884
        self.old_tree = old_tree
 
885
        self.new_tree = new_tree
 
886
        self.to_file = to_file
 
887
        self.path_encoding = path_encoding
 
888
        self.differs = []
 
889
        if extra_factories is not None:
 
890
            self.differs.extend(f(self) for f in extra_factories)
 
891
        self.differs.extend(f(self) for f in self.diff_factories)
 
892
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
 
893
 
 
894
    @classmethod
 
895
    def from_trees_options(klass, old_tree, new_tree, to_file,
 
896
                           path_encoding, external_diff_options, old_label,
 
897
                           new_label, using):
 
898
        """Factory for producing a DiffTree.
 
899
 
 
900
        Designed to accept options used by show_diff_trees.
 
901
        :param old_tree: The tree to show as old in the comparison
 
902
        :param new_tree: The tree to show as new in the comparison
 
903
        :param to_file: File to write comparisons to
 
904
        :param path_encoding: Character encoding to use for writing paths
 
905
        :param external_diff_options: If supplied, use the installed diff
 
906
            binary to perform file comparison, using supplied options.
 
907
        :param old_label: Prefix to use for old file labels
 
908
        :param new_label: Prefix to use for new file labels
 
909
        :param using: Commandline to use to invoke an external diff tool
 
910
        """
 
911
        if using is not None:
 
912
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
913
        else:
 
914
            extra_factories = []
 
915
        if external_diff_options:
 
916
            assert isinstance(external_diff_options, basestring)
 
917
            opts = external_diff_options.split()
 
918
            def diff_file(olab, olines, nlab, nlines, to_file):
 
919
                external_diff(olab, olines, nlab, nlines, to_file, opts)
 
920
        else:
 
921
            diff_file = internal_diff
 
922
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
923
                             old_label, new_label, diff_file)
 
924
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
 
925
                     extra_factories)
 
926
 
 
927
    def show_diff(self, specific_files, extra_trees=None):
 
928
        """Write tree diff to self.to_file
 
929
 
 
930
        :param sepecific_files: the specific files to compare (recursive)
 
931
        :param extra_trees: extra trees to use for mapping paths to file_ids
 
932
        """
 
933
        try:
 
934
            return self._show_diff(specific_files, extra_trees)
 
935
        finally:
 
936
            for differ in self.differs:
 
937
                differ.finish()
 
938
 
 
939
    def _show_diff(self, specific_files, extra_trees):
 
940
        # TODO: Generation of pseudo-diffs for added/deleted files could
 
941
        # be usefully made into a much faster special case.
 
942
        iterator = self.new_tree.iter_changes(self.old_tree,
 
943
                                               specific_files=specific_files,
 
944
                                               extra_trees=extra_trees,
 
945
                                               require_versioned=True)
 
946
        has_changes = 0
 
947
        def changes_key(change):
 
948
            old_path, new_path = change[1]
 
949
            path = new_path
 
950
            if path is None:
 
951
                path = old_path
 
952
            return path
 
953
        def get_encoded_path(path):
 
954
            if path is not None:
 
955
                return path.encode(self.path_encoding, "replace")
 
956
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
957
             executable) in sorted(iterator, key=changes_key):
 
958
            if parent == (None, None):
 
959
                continue
 
960
            oldpath, newpath = paths
 
961
            oldpath_encoded = get_encoded_path(paths[0])
 
962
            newpath_encoded = get_encoded_path(paths[1])
 
963
            old_present = (kind[0] is not None and versioned[0])
 
964
            new_present = (kind[1] is not None and versioned[1])
 
965
            renamed = (parent[0], name[0]) != (parent[1], name[1])
 
966
 
 
967
            properties_changed = []
 
968
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
 
969
 
 
970
            if properties_changed:
 
971
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
 
972
            else:
 
973
                prop_str = ""
 
974
 
 
975
            if (old_present, new_present) == (True, False):
 
976
                self.to_file.write("=== removed %s '%s'\n" %
 
977
                                   (kind[0], oldpath_encoded))
 
978
                newpath = oldpath
 
979
            elif (old_present, new_present) == (False, True):
 
980
                self.to_file.write("=== added %s '%s'\n" %
 
981
                                   (kind[1], newpath_encoded))
 
982
                oldpath = newpath
 
983
            elif renamed:
 
984
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
985
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
 
986
            else:
 
987
                # if it was produced by iter_changes, it must be
 
988
                # modified *somehow*, either content or execute bit.
 
989
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
 
990
                                   newpath_encoded, prop_str))
 
991
            if changed_content:
 
992
                self.diff(file_id, oldpath, newpath)
 
993
                has_changes = 1
 
994
            if renamed:
 
995
                has_changes = 1
 
996
        return has_changes
 
997
 
 
998
    def diff(self, file_id, old_path, new_path):
 
999
        """Perform a diff of a single file
 
1000
 
 
1001
        :param file_id: file-id of the file
 
1002
        :param old_path: The path of the file in the old tree
 
1003
        :param new_path: The path of the file in the new tree
 
1004
        """
 
1005
        try:
 
1006
            old_kind = self.old_tree.kind(file_id)
 
1007
        except (errors.NoSuchId, errors.NoSuchFile):
 
1008
            old_kind = None
 
1009
        try:
 
1010
            new_kind = self.new_tree.kind(file_id)
 
1011
        except (errors.NoSuchId, errors.NoSuchFile):
 
1012
            new_kind = None
 
1013
 
 
1014
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
1015
                                       new_path, old_kind, new_kind)
 
1016
        if result is DiffPath.CANNOT_DIFF:
 
1017
            error_path = new_path
 
1018
            if error_path is None:
 
1019
                error_path = old_path
 
1020
            raise errors.NoDiffFound(error_path)