~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-06-25 17:46:47 UTC
  • mfrom: (2547.2.1 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070625174647-pocypsjmp861qgv7
(Vincent Ladeuil) Fix bug #121889 by working around urllib2 limitation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
 
import difflib
18
17
import os
19
18
import re
20
 
import shutil
21
 
import string
22
19
import sys
23
20
 
24
21
from bzrlib.lazy_import import lazy_import
29
26
import time
30
27
 
31
28
from bzrlib import (
32
 
    branch as _mod_branch,
33
 
    bzrdir,
34
 
    commands,
35
29
    errors,
36
30
    osutils,
37
31
    patiencediff,
38
32
    textfile,
39
33
    timestamp,
40
 
    views,
41
34
    )
42
 
 
43
 
from bzrlib.workingtree import WorkingTree
44
35
""")
45
36
 
 
37
# compatability - plugins import compare_trees from diff!!!
 
38
# deprecated as of 0.10
 
39
from bzrlib.delta import compare_trees
46
40
from bzrlib.symbol_versioning import (
47
 
    deprecated_function,
48
 
    )
49
 
from bzrlib.trace import mutter, note, warning
50
 
 
51
 
 
52
 
class AtTemplate(string.Template):
53
 
    """Templating class that uses @ instead of $."""
54
 
 
55
 
    delimiter = '@'
 
41
        deprecated_function,
 
42
        zero_eight,
 
43
        )
 
44
from bzrlib.trace import mutter, warning
56
45
 
57
46
 
58
47
# TODO: Rather than building a changeset object, we should probably
59
48
# invoke callbacks on an object.  That object can either accumulate a
60
49
# list, write them out directly, etc etc.
61
50
 
62
 
 
63
 
class _PrematchedMatcher(difflib.SequenceMatcher):
64
 
    """Allow SequenceMatcher operations to use predetermined blocks"""
65
 
 
66
 
    def __init__(self, matching_blocks):
67
 
        difflib.SequenceMatcher(self, None, None)
68
 
        self.matching_blocks = matching_blocks
69
 
        self.opcodes = None
70
 
 
71
 
 
72
51
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
73
52
                  allow_binary=False, sequence_matcher=None,
74
53
                  path_encoding='utf8'):
87
66
    # both sequences are empty.
88
67
    if not oldlines and not newlines:
89
68
        return
90
 
 
 
69
    
91
70
    if allow_binary is False:
92
71
        textfile.check_text_lines(oldlines)
93
72
        textfile.check_text_lines(newlines)
100
79
                      sequencematcher=sequence_matcher)
101
80
 
102
81
    ud = list(ud)
103
 
    if len(ud) == 0: # Identical contents, nothing to do
104
 
        return
105
82
    # work-around for difflib being too smart for its own good
106
83
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
107
84
    if not oldlines:
108
85
        ud[2] = ud[2].replace('-1,0', '-0,0')
109
86
    elif not newlines:
110
87
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
88
    # work around for difflib emitting random spaces after the label
 
89
    ud[0] = ud[0][:-2] + '\n'
 
90
    ud[1] = ud[1][:-2] + '\n'
111
91
 
112
92
    for line in ud:
113
93
        to_file.write(line)
114
94
        if not line.endswith('\n'):
115
95
            to_file.write("\n\\ No newline at end of file\n")
116
 
    to_file.write('\n')
 
96
    print >>to_file
117
97
 
118
98
 
119
99
def _spawn_external_diff(diffcmd, capture_errors=True):
180
160
 
181
161
        if not diff_opts:
182
162
            diff_opts = []
183
 
        if sys.platform == 'win32':
184
 
            # Popen doesn't do the proper encoding for external commands
185
 
            # Since we are dealing with an ANSI api, use mbcs encoding
186
 
            old_filename = old_filename.encode('mbcs')
187
 
            new_filename = new_filename.encode('mbcs')
188
163
        diffcmd = ['diff',
189
164
                   '--label', old_filename,
190
165
                   old_abspath,
213
188
            break
214
189
        else:
215
190
            diffcmd.append('-u')
216
 
 
 
191
                  
217
192
        if diff_opts:
218
193
            diffcmd.extend(diff_opts)
219
194
 
220
195
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
221
196
        out,err = pipe.communicate()
222
197
        rc = pipe.returncode
223
 
 
 
198
        
224
199
        # internal_diff() adds a trailing newline, add one here for consistency
225
200
        out += '\n'
226
201
        if rc == 2:
261
236
                msg = 'signal %d' % (-rc)
262
237
            else:
263
238
                msg = 'exit code %d' % rc
264
 
 
265
 
            raise errors.BzrError('external diff failed with %s; command: %r'
 
239
                
 
240
            raise errors.BzrError('external diff failed with %s; command: %r' 
266
241
                                  % (rc, diffcmd))
267
242
 
268
243
 
286
261
                        new_abspath, e)
287
262
 
288
263
 
289
 
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
290
 
                                   apply_view=True):
291
 
    """Get the trees and specific files to diff given a list of paths.
292
 
 
293
 
    This method works out the trees to be diff'ed and the files of
294
 
    interest within those trees.
295
 
 
296
 
    :param path_list:
297
 
        the list of arguments passed to the diff command
298
 
    :param revision_specs:
299
 
        Zero, one or two RevisionSpecs from the diff command line,
300
 
        saying what revisions to compare.
301
 
    :param old_url:
302
 
        The url of the old branch or tree. If None, the tree to use is
303
 
        taken from the first path, if any, or the current working tree.
304
 
    :param new_url:
305
 
        The url of the new branch or tree. If None, the tree to use is
306
 
        taken from the first path, if any, or the current working tree.
307
 
    :param apply_view:
308
 
        if True and a view is set, apply the view or check that the paths
309
 
        are within it
310
 
    :returns:
311
 
        a tuple of (old_tree, new_tree, old_branch, new_branch,
312
 
        specific_files, extra_trees) where extra_trees is a sequence of
313
 
        additional trees to search in for file-ids.
314
 
    """
315
 
    # Get the old and new revision specs
316
 
    old_revision_spec = None
317
 
    new_revision_spec = None
 
264
@deprecated_function(zero_eight)
 
265
def show_diff(b, from_spec, specific_files, external_diff_options=None,
 
266
              revision2=None, output=None, b2=None):
 
267
    """Shortcut for showing the diff to the working tree.
 
268
 
 
269
    Please use show_diff_trees instead.
 
270
 
 
271
    b
 
272
        Branch.
 
273
 
 
274
    revision
 
275
        None for 'basis tree', or otherwise the old revision to compare against.
 
276
    
 
277
    The more general form is show_diff_trees(), where the caller
 
278
    supplies any two trees.
 
279
    """
 
280
    if output is None:
 
281
        output = sys.stdout
 
282
 
 
283
    if from_spec is None:
 
284
        old_tree = b.bzrdir.open_workingtree()
 
285
        if b2 is None:
 
286
            old_tree = old_tree = old_tree.basis_tree()
 
287
    else:
 
288
        old_tree = b.repository.revision_tree(from_spec.in_history(b).rev_id)
 
289
 
 
290
    if revision2 is None:
 
291
        if b2 is None:
 
292
            new_tree = b.bzrdir.open_workingtree()
 
293
        else:
 
294
            new_tree = b2.bzrdir.open_workingtree()
 
295
    else:
 
296
        new_tree = b.repository.revision_tree(revision2.in_history(b).rev_id)
 
297
 
 
298
    return show_diff_trees(old_tree, new_tree, output, specific_files,
 
299
                           external_diff_options)
 
300
 
 
301
 
 
302
def diff_cmd_helper(tree, specific_files, external_diff_options, 
 
303
                    old_revision_spec=None, new_revision_spec=None,
 
304
                    revision_specs=None,
 
305
                    old_label='a/', new_label='b/'):
 
306
    """Helper for cmd_diff.
 
307
 
 
308
    :param tree:
 
309
        A WorkingTree
 
310
 
 
311
    :param specific_files:
 
312
        The specific files to compare, or None
 
313
 
 
314
    :param external_diff_options:
 
315
        If non-None, run an external diff, and pass it these options
 
316
 
 
317
    :param old_revision_spec:
 
318
        If None, use basis tree as old revision, otherwise use the tree for
 
319
        the specified revision. 
 
320
 
 
321
    :param new_revision_spec:
 
322
        If None, use working tree as new revision, otherwise use the tree for
 
323
        the specified revision.
 
324
    
 
325
    :param revision_specs: 
 
326
        Zero, one or two RevisionSpecs from the command line, saying what revisions 
 
327
        to compare.  This can be passed as an alternative to the old_revision_spec 
 
328
        and new_revision_spec parameters.
 
329
 
 
330
    The more general form is show_diff_trees(), where the caller
 
331
    supplies any two trees.
 
332
    """
 
333
 
 
334
    # TODO: perhaps remove the old parameters old_revision_spec and
 
335
    # new_revision_spec, since this is only really for use from cmd_diff and
 
336
    # it now always passes through a sequence of revision_specs -- mbp
 
337
    # 20061221
 
338
 
 
339
    def spec_tree(spec):
 
340
        if tree:
 
341
            revision = spec.in_store(tree.branch)
 
342
        else:
 
343
            revision = spec.in_store(None)
 
344
        revision_id = revision.rev_id
 
345
        branch = revision.branch
 
346
        return branch.repository.revision_tree(revision_id)
 
347
 
318
348
    if revision_specs is not None:
 
349
        assert (old_revision_spec is None
 
350
                and new_revision_spec is None)
319
351
        if len(revision_specs) > 0:
320
352
            old_revision_spec = revision_specs[0]
321
 
            if old_url is None:
322
 
                old_url = old_revision_spec.get_branch()
323
353
        if len(revision_specs) > 1:
324
354
            new_revision_spec = revision_specs[1]
325
 
            if new_url is None:
326
 
                new_url = new_revision_spec.get_branch()
327
 
 
328
 
    other_paths = []
329
 
    make_paths_wt_relative = True
330
 
    consider_relpath = True
331
 
    if path_list is None or len(path_list) == 0:
332
 
        # If no path is given, the current working tree is used
333
 
        default_location = u'.'
334
 
        consider_relpath = False
335
 
    elif old_url is not None and new_url is not None:
336
 
        other_paths = path_list
337
 
        make_paths_wt_relative = False
338
 
    else:
339
 
        default_location = path_list[0]
340
 
        other_paths = path_list[1:]
341
 
 
342
 
    # Get the old location
343
 
    specific_files = []
344
 
    if old_url is None:
345
 
        old_url = default_location
346
 
    working_tree, branch, relpath = \
347
 
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
348
 
    if consider_relpath and relpath != '':
349
 
        if working_tree is not None and apply_view:
350
 
            views.check_path_in_view(working_tree, relpath)
351
 
        specific_files.append(relpath)
352
 
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
353
 
    old_branch = branch
354
 
 
355
 
    # Get the new location
356
 
    if new_url is None:
357
 
        new_url = default_location
358
 
    if new_url != old_url:
359
 
        working_tree, branch, relpath = \
360
 
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
361
 
        if consider_relpath and relpath != '':
362
 
            if working_tree is not None and apply_view:
363
 
                views.check_path_in_view(working_tree, relpath)
364
 
            specific_files.append(relpath)
365
 
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
366
 
        basis_is_default=working_tree is None)
367
 
    new_branch = branch
368
 
 
369
 
    # Get the specific files (all files is None, no files is [])
370
 
    if make_paths_wt_relative and working_tree is not None:
371
 
        try:
372
 
            from bzrlib.builtins import safe_relpath_files
373
 
            other_paths = safe_relpath_files(working_tree, other_paths,
374
 
            apply_view=apply_view)
375
 
        except errors.FileInWrongBranch:
376
 
            raise errors.BzrCommandError("Files are in different branches")
377
 
    specific_files.extend(other_paths)
378
 
    if len(specific_files) == 0:
379
 
        specific_files = None
380
 
        if (working_tree is not None and working_tree.supports_views()
381
 
            and apply_view):
382
 
            view_files = working_tree.views.lookup_view()
383
 
            if view_files:
384
 
                specific_files = view_files
385
 
                view_str = views.view_display_str(view_files)
386
 
                note("*** Ignoring files outside view. View is %s" % view_str)
387
 
 
388
 
    # Get extra trees that ought to be searched for file-ids
389
 
    extra_trees = None
390
 
    if working_tree is not None and working_tree not in (old_tree, new_tree):
391
 
        extra_trees = (working_tree,)
392
 
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
393
 
 
394
 
 
395
 
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
396
 
    if branch is None and tree is not None:
397
 
        branch = tree.branch
398
 
    if spec is None or spec.spec is None:
399
 
        if basis_is_default:
400
 
            if tree is not None:
401
 
                return tree.basis_tree()
402
 
            else:
403
 
                return branch.basis_tree()
404
 
        else:
405
 
            return tree
406
 
    return spec.as_tree(branch)
 
355
 
 
356
    if old_revision_spec is None:
 
357
        old_tree = tree.basis_tree()
 
358
    else:
 
359
        old_tree = spec_tree(old_revision_spec)
 
360
 
 
361
    if (new_revision_spec is None
 
362
        or new_revision_spec.spec is None):
 
363
        new_tree = tree
 
364
    else:
 
365
        new_tree = spec_tree(new_revision_spec)
 
366
 
 
367
    if new_tree is not tree:
 
368
        extra_trees = (tree,)
 
369
    else:
 
370
        extra_trees = None
 
371
 
 
372
    return show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
373
                           external_diff_options,
 
374
                           old_label=old_label, new_label=new_label,
 
375
                           extra_trees=extra_trees)
407
376
 
408
377
 
409
378
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
410
379
                    external_diff_options=None,
411
380
                    old_label='a/', new_label='b/',
412
 
                    extra_trees=None,
413
 
                    path_encoding='utf8',
414
 
                    using=None):
 
381
                    extra_trees=None):
415
382
    """Show in text form the changes from one tree to another.
416
383
 
417
 
    to_file
418
 
        The output stream.
419
 
 
420
 
    specific_files
421
 
        Include only changes to these files - None for all changes.
 
384
    to_files
 
385
        If set, include only changes to these files.
422
386
 
423
387
    external_diff_options
424
388
        If set, use an external GNU diff and pass these options.
425
389
 
426
390
    extra_trees
427
391
        If set, more Trees to use for looking up file ids
428
 
 
429
 
    path_encoding
430
 
        If set, the path will be encoded as specified, otherwise is supposed
431
 
        to be utf8
432
392
    """
433
393
    old_tree.lock_read()
434
394
    try:
437
397
                tree.lock_read()
438
398
        new_tree.lock_read()
439
399
        try:
440
 
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
441
 
                                                 path_encoding,
442
 
                                                 external_diff_options,
443
 
                                                 old_label, new_label, using)
444
 
            return differ.show_diff(specific_files, extra_trees)
 
400
            return _show_diff_trees(old_tree, new_tree, to_file,
 
401
                                    specific_files, external_diff_options,
 
402
                                    old_label=old_label, new_label=new_label,
 
403
                                    extra_trees=extra_trees)
445
404
        finally:
446
405
            new_tree.unlock()
447
406
            if extra_trees is not None:
451
410
        old_tree.unlock()
452
411
 
453
412
 
 
413
def _show_diff_trees(old_tree, new_tree, to_file,
 
414
                     specific_files, external_diff_options, 
 
415
                     old_label='a/', new_label='b/', extra_trees=None):
 
416
 
 
417
    # GNU Patch uses the epoch date to detect files that are being added
 
418
    # or removed in a diff.
 
419
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
420
 
 
421
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
422
    # be usefully made into a much faster special case.
 
423
 
 
424
    if external_diff_options:
 
425
        assert isinstance(external_diff_options, basestring)
 
426
        opts = external_diff_options.split()
 
427
        def diff_file(olab, olines, nlab, nlines, to_file):
 
428
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
429
    else:
 
430
        diff_file = internal_diff
 
431
    
 
432
    delta = new_tree.changes_from(old_tree,
 
433
        specific_files=specific_files,
 
434
        extra_trees=extra_trees, require_versioned=True)
 
435
 
 
436
    has_changes = 0
 
437
    for path, file_id, kind in delta.removed:
 
438
        has_changes = 1
 
439
        print >>to_file, '=== removed %s %r' % (kind, path.encode('utf8'))
 
440
        old_name = '%s%s\t%s' % (old_label, path,
 
441
                                 _patch_header_date(old_tree, file_id, path))
 
442
        new_name = '%s%s\t%s' % (new_label, path, EPOCH_DATE)
 
443
        old_tree.inventory[file_id].diff(diff_file, old_name, old_tree,
 
444
                                         new_name, None, None, to_file)
 
445
    for path, file_id, kind in delta.added:
 
446
        has_changes = 1
 
447
        print >>to_file, '=== added %s %r' % (kind, path.encode('utf8'))
 
448
        old_name = '%s%s\t%s' % (old_label, path, EPOCH_DATE)
 
449
        new_name = '%s%s\t%s' % (new_label, path,
 
450
                                 _patch_header_date(new_tree, file_id, path))
 
451
        new_tree.inventory[file_id].diff(diff_file, new_name, new_tree,
 
452
                                         old_name, None, None, to_file, 
 
453
                                         reverse=True)
 
454
    for (old_path, new_path, file_id, kind,
 
455
         text_modified, meta_modified) in delta.renamed:
 
456
        has_changes = 1
 
457
        prop_str = get_prop_change(meta_modified)
 
458
        print >>to_file, '=== renamed %s %r => %r%s' % (
 
459
                    kind, old_path.encode('utf8'),
 
460
                    new_path.encode('utf8'), prop_str)
 
461
        old_name = '%s%s\t%s' % (old_label, old_path,
 
462
                                 _patch_header_date(old_tree, file_id,
 
463
                                                    old_path))
 
464
        new_name = '%s%s\t%s' % (new_label, new_path,
 
465
                                 _patch_header_date(new_tree, file_id,
 
466
                                                    new_path))
 
467
        _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
468
                                    new_name, new_tree,
 
469
                                    text_modified, kind, to_file, diff_file)
 
470
    for path, file_id, kind, text_modified, meta_modified in delta.modified:
 
471
        has_changes = 1
 
472
        prop_str = get_prop_change(meta_modified)
 
473
        print >>to_file, '=== modified %s %r%s' % (kind, path.encode('utf8'), prop_str)
 
474
        # The file may be in a different location in the old tree (because
 
475
        # the containing dir was renamed, but the file itself was not)
 
476
        old_path = old_tree.id2path(file_id)
 
477
        old_name = '%s%s\t%s' % (old_label, old_path,
 
478
                                 _patch_header_date(old_tree, file_id, old_path))
 
479
        new_name = '%s%s\t%s' % (new_label, path,
 
480
                                 _patch_header_date(new_tree, file_id, path))
 
481
        if text_modified:
 
482
            _maybe_diff_file_or_symlink(old_name, old_tree, file_id,
 
483
                                        new_name, new_tree,
 
484
                                        True, kind, to_file, diff_file)
 
485
 
 
486
    return has_changes
 
487
 
 
488
 
454
489
def _patch_header_date(tree, file_id, path):
455
490
    """Returns a timestamp suitable for use in a patch header."""
456
 
    try:
457
 
        mtime = tree.get_file_mtime(file_id, path)
458
 
    except errors.FileTimestampUnavailable:
459
 
        mtime = 0
 
491
    mtime = tree.get_file_mtime(file_id, path)
 
492
    assert mtime is not None, \
 
493
        "got an mtime of None for file-id %s, path %s in tree %s" % (
 
494
                file_id, path, tree)
460
495
    return timestamp.format_patch_date(mtime)
461
496
 
462
497
 
463
 
def get_executable_change(old_is_x, new_is_x):
464
 
    descr = { True:"+x", False:"-x", None:"??" }
465
 
    if old_is_x != new_is_x:
466
 
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
498
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
499
    """Complain if paths are not in either inventory or tree.
 
500
 
 
501
    It's OK with the files exist in either tree's inventory, or 
 
502
    if they exist in the tree but are not versioned.
 
503
    
 
504
    This can be used by operations such as bzr status that can accept
 
505
    unknown or ignored files.
 
506
    """
 
507
    mutter("check paths: %r", paths)
 
508
    if not paths:
 
509
        return
 
510
    s = old_tree.filter_unversioned_files(paths)
 
511
    s = new_tree.filter_unversioned_files(s)
 
512
    s = [path for path in s if not new_tree.has_filename(path)]
 
513
    if s:
 
514
        raise errors.PathsDoNotExist(sorted(s))
 
515
 
 
516
 
 
517
def get_prop_change(meta_modified):
 
518
    if meta_modified:
 
519
        return " (properties changed)"
467
520
    else:
468
 
        return []
469
 
 
470
 
 
471
 
class DiffPath(object):
472
 
    """Base type for command object that compare files"""
473
 
 
474
 
    # The type or contents of the file were unsuitable for diffing
475
 
    CANNOT_DIFF = 'CANNOT_DIFF'
476
 
    # The file has changed in a semantic way
477
 
    CHANGED = 'CHANGED'
478
 
    # The file content may have changed, but there is no semantic change
479
 
    UNCHANGED = 'UNCHANGED'
480
 
 
481
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
482
 
        """Constructor.
483
 
 
484
 
        :param old_tree: The tree to show as the old tree in the comparison
485
 
        :param new_tree: The tree to show as new in the comparison
486
 
        :param to_file: The file to write comparison data to
487
 
        :param path_encoding: The character encoding to write paths in
488
 
        """
489
 
        self.old_tree = old_tree
490
 
        self.new_tree = new_tree
491
 
        self.to_file = to_file
492
 
        self.path_encoding = path_encoding
493
 
 
494
 
    def finish(self):
495
 
        pass
496
 
 
497
 
    @classmethod
498
 
    def from_diff_tree(klass, diff_tree):
499
 
        return klass(diff_tree.old_tree, diff_tree.new_tree,
500
 
                     diff_tree.to_file, diff_tree.path_encoding)
501
 
 
502
 
    @staticmethod
503
 
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
504
 
        for file_differ in differs:
505
 
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
506
 
                                      new_kind)
507
 
            if result is not DiffPath.CANNOT_DIFF:
508
 
                return result
509
 
        else:
510
 
            return DiffPath.CANNOT_DIFF
511
 
 
512
 
 
513
 
class DiffKindChange(object):
514
 
    """Special differ for file kind changes.
515
 
 
516
 
    Represents kind change as deletion + creation.  Uses the other differs
517
 
    to do this.
518
 
    """
519
 
    def __init__(self, differs):
520
 
        self.differs = differs
521
 
 
522
 
    def finish(self):
523
 
        pass
524
 
 
525
 
    @classmethod
526
 
    def from_diff_tree(klass, diff_tree):
527
 
        return klass(diff_tree.differs)
528
 
 
529
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
530
 
        """Perform comparison
531
 
 
532
 
        :param file_id: The file_id of the file to compare
533
 
        :param old_path: Path of the file in the old tree
534
 
        :param new_path: Path of the file in the new tree
535
 
        :param old_kind: Old file-kind of the file
536
 
        :param new_kind: New file-kind of the file
537
 
        """
538
 
        if None in (old_kind, new_kind):
539
 
            return DiffPath.CANNOT_DIFF
540
 
        result = DiffPath._diff_many(self.differs, file_id, old_path,
541
 
                                       new_path, old_kind, None)
542
 
        if result is DiffPath.CANNOT_DIFF:
543
 
            return result
544
 
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
545
 
                                     None, new_kind)
546
 
 
547
 
 
548
 
class DiffDirectory(DiffPath):
549
 
 
550
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
551
 
        """Perform comparison between two directories.  (dummy)
552
 
 
553
 
        """
554
 
        if 'directory' not in (old_kind, new_kind):
555
 
            return self.CANNOT_DIFF
556
 
        if old_kind not in ('directory', None):
557
 
            return self.CANNOT_DIFF
558
 
        if new_kind not in ('directory', None):
559
 
            return self.CANNOT_DIFF
560
 
        return self.CHANGED
561
 
 
562
 
 
563
 
class DiffSymlink(DiffPath):
564
 
 
565
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
566
 
        """Perform comparison between two symlinks
567
 
 
568
 
        :param file_id: The file_id of the file to compare
569
 
        :param old_path: Path of the file in the old tree
570
 
        :param new_path: Path of the file in the new tree
571
 
        :param old_kind: Old file-kind of the file
572
 
        :param new_kind: New file-kind of the file
573
 
        """
574
 
        if 'symlink' not in (old_kind, new_kind):
575
 
            return self.CANNOT_DIFF
576
 
        if old_kind == 'symlink':
577
 
            old_target = self.old_tree.get_symlink_target(file_id)
578
 
        elif old_kind is None:
579
 
            old_target = None
580
 
        else:
581
 
            return self.CANNOT_DIFF
582
 
        if new_kind == 'symlink':
583
 
            new_target = self.new_tree.get_symlink_target(file_id)
584
 
        elif new_kind is None:
585
 
            new_target = None
586
 
        else:
587
 
            return self.CANNOT_DIFF
588
 
        return self.diff_symlink(old_target, new_target)
589
 
 
590
 
    def diff_symlink(self, old_target, new_target):
591
 
        if old_target is None:
592
 
            self.to_file.write('=== target is %r\n' % new_target)
593
 
        elif new_target is None:
594
 
            self.to_file.write('=== target was %r\n' % old_target)
595
 
        else:
596
 
            self.to_file.write('=== target changed %r => %r\n' %
597
 
                              (old_target, new_target))
598
 
        return self.CHANGED
599
 
 
600
 
 
601
 
class DiffText(DiffPath):
602
 
 
603
 
    # GNU Patch uses the epoch date to detect files that are being added
604
 
    # or removed in a diff.
605
 
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
606
 
 
607
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
608
 
                 old_label='', new_label='', text_differ=internal_diff):
609
 
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
610
 
        self.text_differ = text_differ
611
 
        self.old_label = old_label
612
 
        self.new_label = new_label
613
 
        self.path_encoding = path_encoding
614
 
 
615
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
616
 
        """Compare two files in unified diff format
617
 
 
618
 
        :param file_id: The file_id of the file to compare
619
 
        :param old_path: Path of the file in the old tree
620
 
        :param new_path: Path of the file in the new tree
621
 
        :param old_kind: Old file-kind of the file
622
 
        :param new_kind: New file-kind of the file
623
 
        """
624
 
        if 'file' not in (old_kind, new_kind):
625
 
            return self.CANNOT_DIFF
626
 
        from_file_id = to_file_id = file_id
627
 
        if old_kind == 'file':
628
 
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
629
 
        elif old_kind is None:
630
 
            old_date = self.EPOCH_DATE
631
 
            from_file_id = None
632
 
        else:
633
 
            return self.CANNOT_DIFF
634
 
        if new_kind == 'file':
635
 
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
636
 
        elif new_kind is None:
637
 
            new_date = self.EPOCH_DATE
638
 
            to_file_id = None
639
 
        else:
640
 
            return self.CANNOT_DIFF
641
 
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
642
 
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
643
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
644
 
            old_path, new_path)
645
 
 
646
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
647
 
        from_path=None, to_path=None):
648
 
        """Diff the content of given files in two trees
649
 
 
650
 
        :param from_file_id: The id of the file in the from tree.  If None,
651
 
            the file is not present in the from tree.
652
 
        :param to_file_id: The id of the file in the to tree.  This may refer
653
 
            to a different file from from_file_id.  If None,
654
 
            the file is not present in the to tree.
655
 
        :param from_path: The path in the from tree or None if unknown.
656
 
        :param to_path: The path in the to tree or None if unknown.
657
 
        """
658
 
        def _get_text(tree, file_id, path):
659
 
            if file_id is not None:
660
 
                return tree.get_file(file_id, path).readlines()
661
 
            else:
662
 
                return []
663
 
        try:
664
 
            from_text = _get_text(self.old_tree, from_file_id, from_path)
665
 
            to_text = _get_text(self.new_tree, to_file_id, to_path)
666
 
            self.text_differ(from_label, from_text, to_label, to_text,
667
 
                             self.to_file)
668
 
        except errors.BinaryFile:
669
 
            self.to_file.write(
670
 
                  ("Binary files %s and %s differ\n" %
671
 
                  (from_label, to_label)).encode(self.path_encoding))
672
 
        return self.CHANGED
673
 
 
674
 
 
675
 
class DiffFromTool(DiffPath):
676
 
 
677
 
    def __init__(self, command_template, old_tree, new_tree, to_file,
678
 
                 path_encoding='utf-8'):
679
 
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
680
 
        self.command_template = command_template
681
 
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
682
 
 
683
 
    @classmethod
684
 
    def from_string(klass, command_string, old_tree, new_tree, to_file,
685
 
                    path_encoding='utf-8'):
686
 
        command_template = commands.shlex_split_unicode(command_string)
687
 
        if '@' not in command_string:
688
 
            command_template.extend(['@old_path', '@new_path'])
689
 
        return klass(command_template, old_tree, new_tree, to_file,
690
 
                     path_encoding)
691
 
 
692
 
    @classmethod
693
 
    def make_from_diff_tree(klass, command_string):
694
 
        def from_diff_tree(diff_tree):
695
 
            return klass.from_string(command_string, diff_tree.old_tree,
696
 
                                     diff_tree.new_tree, diff_tree.to_file)
697
 
        return from_diff_tree
698
 
 
699
 
    def _get_command(self, old_path, new_path):
700
 
        my_map = {'old_path': old_path, 'new_path': new_path}
701
 
        return [AtTemplate(t).substitute(my_map) for t in
702
 
                self.command_template]
703
 
 
704
 
    def _execute(self, old_path, new_path):
705
 
        command = self._get_command(old_path, new_path)
706
 
        try:
707
 
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
708
 
                                    cwd=self._root)
709
 
        except OSError, e:
710
 
            if e.errno == errno.ENOENT:
711
 
                raise errors.ExecutableMissing(command[0])
712
 
            else:
713
 
                raise
714
 
        self.to_file.write(proc.stdout.read())
715
 
        return proc.wait()
716
 
 
717
 
    def _try_symlink_root(self, tree, prefix):
718
 
        if (getattr(tree, 'abspath', None) is None
719
 
            or not osutils.host_os_dereferences_symlinks()):
720
 
            return False
721
 
        try:
722
 
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
723
 
        except OSError, e:
724
 
            if e.errno != errno.EEXIST:
725
 
                raise
726
 
        return True
727
 
 
728
 
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
729
 
                    allow_write=False):
730
 
        if not force_temp and isinstance(tree, WorkingTree):
731
 
            return tree.abspath(tree.id2path(file_id))
732
 
        
733
 
        full_path = osutils.pathjoin(self._root, prefix, relpath)
734
 
        if not force_temp and self._try_symlink_root(tree, prefix):
735
 
            return full_path
736
 
        parent_dir = osutils.dirname(full_path)
737
 
        try:
738
 
            os.makedirs(parent_dir)
739
 
        except OSError, e:
740
 
            if e.errno != errno.EEXIST:
741
 
                raise
742
 
        source = tree.get_file(file_id, relpath)
743
 
        try:
744
 
            target = open(full_path, 'wb')
745
 
            try:
746
 
                osutils.pumpfile(source, target)
747
 
            finally:
748
 
                target.close()
749
 
        finally:
750
 
            source.close()
751
 
        if not allow_write:
752
 
            osutils.make_readonly(full_path)
753
 
        try:
754
 
            mtime = tree.get_file_mtime(file_id)
755
 
        except errors.FileTimestampUnavailable:
756
 
            mtime = 0
757
 
        os.utime(full_path, (mtime, mtime))
758
 
        return full_path
759
 
 
760
 
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
761
 
                       allow_write_new=False):
762
 
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
763
 
                                         old_path, force_temp)
764
 
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
765
 
                                         new_path, force_temp,
766
 
                                         allow_write=allow_write_new)
767
 
        return old_disk_path, new_disk_path
768
 
 
769
 
    def finish(self):
770
 
        try:
771
 
            osutils.rmtree(self._root)
772
 
        except OSError, e:
773
 
            if e.errno != errno.ENOENT:
774
 
                mutter("The temporary directory \"%s\" was not "
775
 
                        "cleanly removed: %s." % (self._root, e))
776
 
 
777
 
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
778
 
        if (old_kind, new_kind) != ('file', 'file'):
779
 
            return DiffPath.CANNOT_DIFF
780
 
        (old_disk_path, new_disk_path) = self._prepare_files(
781
 
                                                file_id, old_path, new_path)
782
 
        self._execute(old_disk_path, new_disk_path)
783
 
 
784
 
    def edit_file(self, file_id):
785
 
        """Use this tool to edit a file.
786
 
 
787
 
        A temporary copy will be edited, and the new contents will be
788
 
        returned.
789
 
 
790
 
        :param file_id: The id of the file to edit.
791
 
        :return: The new contents of the file.
792
 
        """
793
 
        old_path = self.old_tree.id2path(file_id)
794
 
        new_path = self.new_tree.id2path(file_id)
795
 
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
796
 
                                           allow_write_new=True,
797
 
                                           force_temp=True)[1]
798
 
        command = self._get_command(osutils.pathjoin('old', old_path),
799
 
                                    osutils.pathjoin('new', new_path))
800
 
        subprocess.call(command, cwd=self._root)
801
 
        new_file = open(new_abs_path, 'r')
802
 
        try:
803
 
            return new_file.read()
804
 
        finally:
805
 
            new_file.close()
806
 
 
807
 
 
808
 
class DiffTree(object):
809
 
    """Provides textual representations of the difference between two trees.
810
 
 
811
 
    A DiffTree examines two trees and where a file-id has altered
812
 
    between them, generates a textual representation of the difference.
813
 
    DiffTree uses a sequence of DiffPath objects which are each
814
 
    given the opportunity to handle a given altered fileid. The list
815
 
    of DiffPath objects can be extended globally by appending to
816
 
    DiffTree.diff_factories, or for a specific diff operation by
817
 
    supplying the extra_factories option to the appropriate method.
818
 
    """
819
 
 
820
 
    # list of factories that can provide instances of DiffPath objects
821
 
    # may be extended by plugins.
822
 
    diff_factories = [DiffSymlink.from_diff_tree,
823
 
                      DiffDirectory.from_diff_tree]
824
 
 
825
 
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
826
 
                 diff_text=None, extra_factories=None):
827
 
        """Constructor
828
 
 
829
 
        :param old_tree: Tree to show as old in the comparison
830
 
        :param new_tree: Tree to show as new in the comparison
831
 
        :param to_file: File to write comparision to
832
 
        :param path_encoding: Character encoding to write paths in
833
 
        :param diff_text: DiffPath-type object to use as a last resort for
834
 
            diffing text files.
835
 
        :param extra_factories: Factories of DiffPaths to try before any other
836
 
            DiffPaths"""
837
 
        if diff_text is None:
838
 
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
839
 
                                 '', '',  internal_diff)
840
 
        self.old_tree = old_tree
841
 
        self.new_tree = new_tree
842
 
        self.to_file = to_file
843
 
        self.path_encoding = path_encoding
844
 
        self.differs = []
845
 
        if extra_factories is not None:
846
 
            self.differs.extend(f(self) for f in extra_factories)
847
 
        self.differs.extend(f(self) for f in self.diff_factories)
848
 
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
849
 
 
850
 
    @classmethod
851
 
    def from_trees_options(klass, old_tree, new_tree, to_file,
852
 
                           path_encoding, external_diff_options, old_label,
853
 
                           new_label, using):
854
 
        """Factory for producing a DiffTree.
855
 
 
856
 
        Designed to accept options used by show_diff_trees.
857
 
        :param old_tree: The tree to show as old in the comparison
858
 
        :param new_tree: The tree to show as new in the comparison
859
 
        :param to_file: File to write comparisons to
860
 
        :param path_encoding: Character encoding to use for writing paths
861
 
        :param external_diff_options: If supplied, use the installed diff
862
 
            binary to perform file comparison, using supplied options.
863
 
        :param old_label: Prefix to use for old file labels
864
 
        :param new_label: Prefix to use for new file labels
865
 
        :param using: Commandline to use to invoke an external diff tool
866
 
        """
867
 
        if using is not None:
868
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
869
 
        else:
870
 
            extra_factories = []
871
 
        if external_diff_options:
872
 
            opts = external_diff_options.split()
873
 
            def diff_file(olab, olines, nlab, nlines, to_file):
874
 
                external_diff(olab, olines, nlab, nlines, to_file, opts)
875
 
        else:
876
 
            diff_file = internal_diff
877
 
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
878
 
                             old_label, new_label, diff_file)
879
 
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
880
 
                     extra_factories)
881
 
 
882
 
    def show_diff(self, specific_files, extra_trees=None):
883
 
        """Write tree diff to self.to_file
884
 
 
885
 
        :param sepecific_files: the specific files to compare (recursive)
886
 
        :param extra_trees: extra trees to use for mapping paths to file_ids
887
 
        """
888
 
        try:
889
 
            return self._show_diff(specific_files, extra_trees)
890
 
        finally:
891
 
            for differ in self.differs:
892
 
                differ.finish()
893
 
 
894
 
    def _show_diff(self, specific_files, extra_trees):
895
 
        # TODO: Generation of pseudo-diffs for added/deleted files could
896
 
        # be usefully made into a much faster special case.
897
 
        iterator = self.new_tree.iter_changes(self.old_tree,
898
 
                                               specific_files=specific_files,
899
 
                                               extra_trees=extra_trees,
900
 
                                               require_versioned=True)
901
 
        has_changes = 0
902
 
        def changes_key(change):
903
 
            old_path, new_path = change[1]
904
 
            path = new_path
905
 
            if path is None:
906
 
                path = old_path
907
 
            return path
908
 
        def get_encoded_path(path):
909
 
            if path is not None:
910
 
                return path.encode(self.path_encoding, "replace")
911
 
        for (file_id, paths, changed_content, versioned, parent, name, kind,
912
 
             executable) in sorted(iterator, key=changes_key):
913
 
            # The root does not get diffed, and items with no known kind (that
914
 
            # is, missing) in both trees are skipped as well.
915
 
            if parent == (None, None) or kind == (None, None):
916
 
                continue
917
 
            oldpath, newpath = paths
918
 
            oldpath_encoded = get_encoded_path(paths[0])
919
 
            newpath_encoded = get_encoded_path(paths[1])
920
 
            old_present = (kind[0] is not None and versioned[0])
921
 
            new_present = (kind[1] is not None and versioned[1])
922
 
            renamed = (parent[0], name[0]) != (parent[1], name[1])
923
 
 
924
 
            properties_changed = []
925
 
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
926
 
 
927
 
            if properties_changed:
928
 
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
929
 
            else:
930
 
                prop_str = ""
931
 
 
932
 
            if (old_present, new_present) == (True, False):
933
 
                self.to_file.write("=== removed %s '%s'\n" %
934
 
                                   (kind[0], oldpath_encoded))
935
 
                newpath = oldpath
936
 
            elif (old_present, new_present) == (False, True):
937
 
                self.to_file.write("=== added %s '%s'\n" %
938
 
                                   (kind[1], newpath_encoded))
939
 
                oldpath = newpath
940
 
            elif renamed:
941
 
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
942
 
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
943
 
            else:
944
 
                # if it was produced by iter_changes, it must be
945
 
                # modified *somehow*, either content or execute bit.
946
 
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
947
 
                                   newpath_encoded, prop_str))
948
 
            if changed_content:
949
 
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
950
 
                has_changes = 1
951
 
            if renamed:
952
 
                has_changes = 1
953
 
        return has_changes
954
 
 
955
 
    def diff(self, file_id, old_path, new_path):
956
 
        """Perform a diff of a single file
957
 
 
958
 
        :param file_id: file-id of the file
959
 
        :param old_path: The path of the file in the old tree
960
 
        :param new_path: The path of the file in the new tree
961
 
        """
962
 
        try:
963
 
            old_kind = self.old_tree.kind(file_id)
964
 
        except (errors.NoSuchId, errors.NoSuchFile):
965
 
            old_kind = None
966
 
        try:
967
 
            new_kind = self.new_tree.kind(file_id)
968
 
        except (errors.NoSuchId, errors.NoSuchFile):
969
 
            new_kind = None
970
 
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
971
 
 
972
 
 
973
 
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
974
 
        result = DiffPath._diff_many(self.differs, file_id, old_path,
975
 
                                       new_path, old_kind, new_kind)
976
 
        if result is DiffPath.CANNOT_DIFF:
977
 
            error_path = new_path
978
 
            if error_path is None:
979
 
                error_path = old_path
980
 
            raise errors.NoDiffFound(error_path)
 
521
        return  ""
 
522
 
 
523
 
 
524
def _maybe_diff_file_or_symlink(old_path, old_tree, file_id,
 
525
                                new_path, new_tree, text_modified,
 
526
                                kind, to_file, diff_file):
 
527
    if text_modified:
 
528
        new_entry = new_tree.inventory[file_id]
 
529
        old_tree.inventory[file_id].diff(diff_file,
 
530
                                         old_path, old_tree,
 
531
                                         new_path, new_entry, 
 
532
                                         new_tree, to_file)