~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Alexander Belchenko
  • Date: 2007-10-26 21:49:15 UTC
  • mto: (2947.4.2 0.92)
  • mto: This revision was merged to the branch mainline in revision 2971.
  • Revision ID: bialix@ukr.net-20071026214915-5eacqh9k2ps6jagj
windows python-based installer: shortcut for uninstall action

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