1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
 
3
# This program is free software; you can redistribute it and/or modify
 
 
4
# it under the terms of the GNU General Public License as published by
 
 
5
# the Free Software Foundation; either version 2 of the License, or
 
 
6
# (at your option) any later version.
 
 
8
# This program is distributed in the hope that it will be useful,
 
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
11
# GNU General Public License for more details.
 
 
13
# You should have received a copy of the GNU General Public License
 
 
14
# along with this program; if not, write to the Free Software
 
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
23
from bzrlib.lazy_import import lazy_import
 
 
24
lazy_import(globals(), """
 
 
31
    branch as _mod_branch,
 
 
42
from bzrlib.symbol_versioning import (
 
 
46
from bzrlib.trace import mutter, warning
 
 
49
# TODO: Rather than building a changeset object, we should probably
 
 
50
# invoke callbacks on an object.  That object can either accumulate a
 
 
51
# list, write them out directly, etc etc.
 
 
54
class _PrematchedMatcher(difflib.SequenceMatcher):
 
 
55
    """Allow SequenceMatcher operations to use predetermined blocks"""
 
 
57
    def __init__(self, matching_blocks):
 
 
58
        difflib.SequenceMatcher(self, None, None)
 
 
59
        self.matching_blocks = matching_blocks
 
 
63
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
 
64
                  allow_binary=False, sequence_matcher=None,
 
 
65
                  path_encoding='utf8'):
 
 
66
    # FIXME: difflib is wrong if there is no trailing newline.
 
 
67
    # The syntax used by patch seems to be "\ No newline at
 
 
68
    # end of file" following the last diff line from that
 
 
69
    # file.  This is not trivial to insert into the
 
 
70
    # unified_diff output and it might be better to just fix
 
 
71
    # or replace that function.
 
 
73
    # In the meantime we at least make sure the patch isn't
 
 
77
    # Special workaround for Python2.3, where difflib fails if
 
 
78
    # both sequences are empty.
 
 
79
    if not oldlines and not newlines:
 
 
82
    if allow_binary is False:
 
 
83
        textfile.check_text_lines(oldlines)
 
 
84
        textfile.check_text_lines(newlines)
 
 
86
    if sequence_matcher is None:
 
 
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
 
 
88
    ud = patiencediff.unified_diff(oldlines, newlines,
 
 
89
                      fromfile=old_filename.encode(path_encoding),
 
 
90
                      tofile=new_filename.encode(path_encoding),
 
 
91
                      sequencematcher=sequence_matcher)
 
 
94
    if len(ud) == 0: # Identical contents, nothing to do
 
 
96
    # work-around for difflib being too smart for its own good
 
 
97
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
 
99
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
 
101
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
 
102
    # work around for difflib emitting random spaces after the label
 
 
103
    ud[0] = ud[0][:-2] + '\n'
 
 
104
    ud[1] = ud[1][:-2] + '\n'
 
 
108
        if not line.endswith('\n'):
 
 
109
            to_file.write("\n\\ No newline at end of file\n")
 
 
113
def _spawn_external_diff(diffcmd, capture_errors=True):
 
 
114
    """Spawn the externall diff process, and return the child handle.
 
 
116
    :param diffcmd: The command list to spawn
 
 
117
    :param capture_errors: Capture stderr as well as setting LANG=C
 
 
118
        and LC_ALL=C. This lets us read and understand the output of diff,
 
 
119
        and respond to any errors.
 
 
120
    :return: A Popen object.
 
 
123
        # construct minimal environment
 
 
125
        path = os.environ.get('PATH')
 
 
128
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
 
 
131
        stderr = subprocess.PIPE
 
 
137
        pipe = subprocess.Popen(diffcmd,
 
 
138
                                stdin=subprocess.PIPE,
 
 
139
                                stdout=subprocess.PIPE,
 
 
143
        if e.errno == errno.ENOENT:
 
 
144
            raise errors.NoDiff(str(e))
 
 
150
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
 
 
152
    """Display a diff by calling out to the external diff program."""
 
 
153
    # make sure our own output is properly ordered before the diff
 
 
156
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
 
157
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
 
 
158
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
 
 
159
    newtmpf = os.fdopen(newtmp_fd, 'wb')
 
 
162
        # TODO: perhaps a special case for comparing to or from the empty
 
 
163
        # sequence; can just use /dev/null on Unix
 
 
165
        # TODO: if either of the files being compared already exists as a
 
 
166
        # regular named file (e.g. in the working directory) then we can
 
 
167
        # compare directly to that, rather than copying it.
 
 
169
        oldtmpf.writelines(oldlines)
 
 
170
        newtmpf.writelines(newlines)
 
 
178
                   '--label', old_filename,
 
 
180
                   '--label', new_filename,
 
 
185
        # diff only allows one style to be specified; they don't override.
 
 
186
        # note that some of these take optargs, and the optargs can be
 
 
187
        # directly appended to the options.
 
 
188
        # this is only an approximate parser; it doesn't properly understand
 
 
190
        for s in ['-c', '-u', '-C', '-U',
 
 
195
                  '-y', '--side-by-side',
 
 
207
            diffcmd.extend(diff_opts)
 
 
209
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
 
 
210
        out,err = pipe.communicate()
 
 
213
        # internal_diff() adds a trailing newline, add one here for consistency
 
 
216
            # 'diff' gives retcode == 2 for all sorts of errors
 
 
217
            # one of those is 'Binary files differ'.
 
 
218
            # Bad options could also be the problem.
 
 
219
            # 'Binary files' is not a real error, so we suppress that error.
 
 
222
            # Since we got here, we want to make sure to give an i18n error
 
 
223
            pipe = _spawn_external_diff(diffcmd, capture_errors=False)
 
 
224
            out, err = pipe.communicate()
 
 
226
            # Write out the new i18n diff response
 
 
227
            to_file.write(out+'\n')
 
 
228
            if pipe.returncode != 2:
 
 
229
                raise errors.BzrError(
 
 
230
                               'external diff failed with exit code 2'
 
 
231
                               ' when run with LANG=C and LC_ALL=C,'
 
 
232
                               ' but not when run natively: %r' % (diffcmd,))
 
 
234
            first_line = lang_c_out.split('\n', 1)[0]
 
 
235
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
 
 
236
            m = re.match('^(binary )?files.*differ$', first_line, re.I)
 
 
238
                raise errors.BzrError('external diff failed with exit code 2;'
 
 
239
                                      ' command: %r' % (diffcmd,))
 
 
241
                # Binary files differ, just return
 
 
244
        # If we got to here, we haven't written out the output of diff
 
 
248
            # returns 1 if files differ; that's OK
 
 
250
                msg = 'signal %d' % (-rc)
 
 
252
                msg = 'exit code %d' % rc
 
 
254
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
 
259
        oldtmpf.close()                 # and delete
 
 
261
        # Clean up. Warn in case the files couldn't be deleted
 
 
262
        # (in case windows still holds the file open, but not
 
 
263
        # if the files have already been deleted)
 
 
265
            os.remove(old_abspath)
 
 
267
            if e.errno not in (errno.ENOENT,):
 
 
268
                warning('Failed to delete temporary file: %s %s',
 
 
271
            os.remove(new_abspath)
 
 
273
            if e.errno not in (errno.ENOENT,):
 
 
274
                warning('Failed to delete temporary file: %s %s',
 
 
278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
 
 
279
    """Get the trees and specific files to diff given a list of paths.
 
 
281
    This method works out the trees to be diff'ed and the files of
 
 
282
    interest within those trees.
 
 
285
        the list of arguments passed to the diff command
 
 
286
    :param revision_specs:
 
 
287
        Zero, one or two RevisionSpecs from the diff command line,
 
 
288
        saying what revisions to compare.
 
 
290
        The url of the old branch or tree. If None, the tree to use is
 
 
291
        taken from the first path, if any, or the current working tree.
 
 
293
        The url of the new branch or tree. If None, the tree to use is
 
 
294
        taken from the first path, if any, or the current working tree.
 
 
296
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
 
297
        extra_trees is a sequence of additional trees to search in for
 
 
300
    # Get the old and new revision specs
 
 
301
    old_revision_spec = None
 
 
302
    new_revision_spec = None
 
 
303
    if revision_specs is not None:
 
 
304
        if len(revision_specs) > 0:
 
 
305
            old_revision_spec = revision_specs[0]
 
 
307
                old_url = old_revision_spec.get_branch()
 
 
308
        if len(revision_specs) > 1:
 
 
309
            new_revision_spec = revision_specs[1]
 
 
311
                new_url = new_revision_spec.get_branch()
 
 
314
    make_paths_wt_relative = True
 
 
315
    consider_relpath = True
 
 
316
    if path_list is None or len(path_list) == 0:
 
 
317
        # If no path is given, the current working tree is used
 
 
318
        default_location = u'.'
 
 
319
        consider_relpath = False
 
 
320
    elif old_url is not None and new_url is not None:
 
 
321
        other_paths = path_list
 
 
322
        make_paths_wt_relative = False
 
 
324
        default_location = path_list[0]
 
 
325
        other_paths = path_list[1:]
 
 
327
    # Get the old location
 
 
330
        old_url = default_location
 
 
331
    working_tree, branch, relpath = \
 
 
332
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
 
333
    if consider_relpath and relpath != '':
 
 
334
        specific_files.append(relpath)
 
 
335
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
 
337
    # Get the new location
 
 
339
        new_url = default_location
 
 
340
    if new_url != old_url:
 
 
341
        working_tree, branch, relpath = \
 
 
342
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
 
343
        if consider_relpath and relpath != '':
 
 
344
            specific_files.append(relpath)
 
 
345
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
 
 
346
        basis_is_default=working_tree is None)
 
 
348
    # Get the specific files (all files is None, no files is [])
 
 
349
    if make_paths_wt_relative and working_tree is not None:
 
 
350
        other_paths = _relative_paths_in_tree(working_tree, other_paths)
 
 
351
    specific_files.extend(other_paths)
 
 
352
    if len(specific_files) == 0:
 
 
353
        specific_files = None
 
 
355
    # Get extra trees that ought to be searched for file-ids
 
 
357
    if working_tree is not None and working_tree not in (old_tree, new_tree):
 
 
358
        extra_trees = (working_tree,)
 
 
359
    return old_tree, new_tree, specific_files, extra_trees
 
 
362
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
 
 
363
    if branch is None and tree is not None:
 
 
365
    if spec is None or spec.spec is None:
 
 
368
                return tree.basis_tree()
 
 
370
                return branch.basis_tree()
 
 
373
    return spec.as_tree(branch)
 
 
376
def _relative_paths_in_tree(tree, paths):
 
 
377
    """Get the relative paths within a working tree.
 
 
379
    Each path may be either an absolute path or a path relative to the
 
 
380
    current working directory.
 
 
383
    for filename in paths:
 
 
385
            result.append(tree.relpath(osutils.dereference_path(filename)))
 
 
386
        except errors.PathNotChild:
 
 
387
            raise errors.BzrCommandError("Files are in different branches")
 
 
391
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
392
                    external_diff_options=None,
 
 
393
                    old_label='a/', new_label='b/',
 
 
395
                    path_encoding='utf8',
 
 
397
    """Show in text form the changes from one tree to another.
 
 
403
        Include only changes to these files - None for all changes.
 
 
405
    external_diff_options
 
 
406
        If set, use an external GNU diff and pass these options.
 
 
409
        If set, more Trees to use for looking up file ids
 
 
412
        If set, the path will be encoded as specified, otherwise is supposed
 
 
417
        if extra_trees is not None:
 
 
418
            for tree in extra_trees:
 
 
422
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
 
424
                                                 external_diff_options,
 
 
425
                                                 old_label, new_label, using)
 
 
426
            return differ.show_diff(specific_files, extra_trees)
 
 
429
            if extra_trees is not None:
 
 
430
                for tree in extra_trees:
 
 
436
def _patch_header_date(tree, file_id, path):
 
 
437
    """Returns a timestamp suitable for use in a patch header."""
 
 
438
    mtime = tree.get_file_mtime(file_id, path)
 
 
439
    return timestamp.format_patch_date(mtime)
 
 
442
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
 
443
    """Complain if paths are not in either inventory or tree.
 
 
445
    It's OK with the files exist in either tree's inventory, or 
 
 
446
    if they exist in the tree but are not versioned.
 
 
448
    This can be used by operations such as bzr status that can accept
 
 
449
    unknown or ignored files.
 
 
451
    mutter("check paths: %r", paths)
 
 
454
    s = old_tree.filter_unversioned_files(paths)
 
 
455
    s = new_tree.filter_unversioned_files(s)
 
 
456
    s = [path for path in s if not new_tree.has_filename(path)]
 
 
458
        raise errors.PathsDoNotExist(sorted(s))
 
 
461
@deprecated_function(one_three)
 
 
462
def get_prop_change(meta_modified):
 
 
464
        return " (properties changed)"
 
 
468
def get_executable_change(old_is_x, new_is_x):
 
 
469
    descr = { True:"+x", False:"-x", None:"??" }
 
 
470
    if old_is_x != new_is_x:
 
 
471
        return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
 
 
476
class DiffPath(object):
 
 
477
    """Base type for command object that compare files"""
 
 
479
    # The type or contents of the file were unsuitable for diffing
 
 
480
    CANNOT_DIFF = 'CANNOT_DIFF'
 
 
481
    # The file has changed in a semantic way
 
 
483
    # The file content may have changed, but there is no semantic change
 
 
484
    UNCHANGED = 'UNCHANGED'
 
 
486
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
 
 
489
        :param old_tree: The tree to show as the old tree in the comparison
 
 
490
        :param new_tree: The tree to show as new in the comparison
 
 
491
        :param to_file: The file to write comparison data to
 
 
492
        :param path_encoding: The character encoding to write paths in
 
 
494
        self.old_tree = old_tree
 
 
495
        self.new_tree = new_tree
 
 
496
        self.to_file = to_file
 
 
497
        self.path_encoding = path_encoding
 
 
503
    def from_diff_tree(klass, diff_tree):
 
 
504
        return klass(diff_tree.old_tree, diff_tree.new_tree,
 
 
505
                     diff_tree.to_file, diff_tree.path_encoding)
 
 
508
    def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
 
 
509
        for file_differ in differs:
 
 
510
            result = file_differ.diff(file_id, old_path, new_path, old_kind,
 
 
512
            if result is not DiffPath.CANNOT_DIFF:
 
 
515
            return DiffPath.CANNOT_DIFF
 
 
518
class DiffKindChange(object):
 
 
519
    """Special differ for file kind changes.
 
 
521
    Represents kind change as deletion + creation.  Uses the other differs
 
 
524
    def __init__(self, differs):
 
 
525
        self.differs = differs
 
 
531
    def from_diff_tree(klass, diff_tree):
 
 
532
        return klass(diff_tree.differs)
 
 
534
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
 
535
        """Perform comparison
 
 
537
        :param file_id: The file_id of the file to compare
 
 
538
        :param old_path: Path of the file in the old tree
 
 
539
        :param new_path: Path of the file in the new tree
 
 
540
        :param old_kind: Old file-kind of the file
 
 
541
        :param new_kind: New file-kind of the file
 
 
543
        if None in (old_kind, new_kind):
 
 
544
            return DiffPath.CANNOT_DIFF
 
 
545
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
 
546
                                       new_path, old_kind, None)
 
 
547
        if result is DiffPath.CANNOT_DIFF:
 
 
549
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
 
 
553
class DiffDirectory(DiffPath):
 
 
555
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
 
556
        """Perform comparison between two directories.  (dummy)
 
 
559
        if 'directory' not in (old_kind, new_kind):
 
 
560
            return self.CANNOT_DIFF
 
 
561
        if old_kind not in ('directory', None):
 
 
562
            return self.CANNOT_DIFF
 
 
563
        if new_kind not in ('directory', None):
 
 
564
            return self.CANNOT_DIFF
 
 
568
class DiffSymlink(DiffPath):
 
 
570
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
 
571
        """Perform comparison between two symlinks
 
 
573
        :param file_id: The file_id of the file to compare
 
 
574
        :param old_path: Path of the file in the old tree
 
 
575
        :param new_path: Path of the file in the new tree
 
 
576
        :param old_kind: Old file-kind of the file
 
 
577
        :param new_kind: New file-kind of the file
 
 
579
        if 'symlink' not in (old_kind, new_kind):
 
 
580
            return self.CANNOT_DIFF
 
 
581
        if old_kind == 'symlink':
 
 
582
            old_target = self.old_tree.get_symlink_target(file_id)
 
 
583
        elif old_kind is None:
 
 
586
            return self.CANNOT_DIFF
 
 
587
        if new_kind == 'symlink':
 
 
588
            new_target = self.new_tree.get_symlink_target(file_id)
 
 
589
        elif new_kind is None:
 
 
592
            return self.CANNOT_DIFF
 
 
593
        return self.diff_symlink(old_target, new_target)
 
 
595
    def diff_symlink(self, old_target, new_target):
 
 
596
        if old_target is None:
 
 
597
            self.to_file.write('=== target is %r\n' % new_target)
 
 
598
        elif new_target is None:
 
 
599
            self.to_file.write('=== target was %r\n' % old_target)
 
 
601
            self.to_file.write('=== target changed %r => %r\n' %
 
 
602
                              (old_target, new_target))
 
 
606
class DiffText(DiffPath):
 
 
608
    # GNU Patch uses the epoch date to detect files that are being added
 
 
609
    # or removed in a diff.
 
 
610
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
 
 
612
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
 
613
                 old_label='', new_label='', text_differ=internal_diff):
 
 
614
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
 
615
        self.text_differ = text_differ
 
 
616
        self.old_label = old_label
 
 
617
        self.new_label = new_label
 
 
618
        self.path_encoding = path_encoding
 
 
620
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
 
621
        """Compare two files in unified diff format
 
 
623
        :param file_id: The file_id of the file to compare
 
 
624
        :param old_path: Path of the file in the old tree
 
 
625
        :param new_path: Path of the file in the new tree
 
 
626
        :param old_kind: Old file-kind of the file
 
 
627
        :param new_kind: New file-kind of the file
 
 
629
        if 'file' not in (old_kind, new_kind):
 
 
630
            return self.CANNOT_DIFF
 
 
631
        from_file_id = to_file_id = file_id
 
 
632
        if old_kind == 'file':
 
 
633
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
 
 
634
        elif old_kind is None:
 
 
635
            old_date = self.EPOCH_DATE
 
 
638
            return self.CANNOT_DIFF
 
 
639
        if new_kind == 'file':
 
 
640
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
 
 
641
        elif new_kind is None:
 
 
642
            new_date = self.EPOCH_DATE
 
 
645
            return self.CANNOT_DIFF
 
 
646
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
 
 
647
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
 
 
648
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
 
650
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
 
651
        """Diff the content of given files in two trees
 
 
653
        :param from_file_id: The id of the file in the from tree.  If None,
 
 
654
            the file is not present in the from tree.
 
 
655
        :param to_file_id: The id of the file in the to tree.  This may refer
 
 
656
            to a different file from from_file_id.  If None,
 
 
657
            the file is not present in the to tree.
 
 
659
        def _get_text(tree, file_id):
 
 
660
            if file_id is not None:
 
 
661
                return tree.get_file(file_id).readlines()
 
 
665
            from_text = _get_text(self.old_tree, from_file_id)
 
 
666
            to_text = _get_text(self.new_tree, to_file_id)
 
 
667
            self.text_differ(from_label, from_text, to_label, to_text,
 
 
669
        except errors.BinaryFile:
 
 
671
                  ("Binary files %s and %s differ\n" %
 
 
672
                  (from_label, to_label)).encode(self.path_encoding))
 
 
676
class DiffFromTool(DiffPath):
 
 
678
    def __init__(self, command_template, old_tree, new_tree, to_file,
 
 
679
                 path_encoding='utf-8'):
 
 
680
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
 
 
681
        self.command_template = command_template
 
 
682
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
 
 
685
    def from_string(klass, command_string, old_tree, new_tree, to_file,
 
 
686
                    path_encoding='utf-8'):
 
 
687
        command_template = commands.shlex_split_unicode(command_string)
 
 
688
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
 
689
        return klass(command_template, old_tree, new_tree, to_file,
 
 
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
 
 
699
    def _get_command(self, old_path, new_path):
 
 
700
        my_map = {'old_path': old_path, 'new_path': new_path}
 
 
701
        return [t % my_map for t in self.command_template]
 
 
703
    def _execute(self, old_path, new_path):
 
 
704
        command = self._get_command(old_path, new_path)
 
 
706
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
 
 
709
            if e.errno == errno.ENOENT:
 
 
710
                raise errors.ExecutableMissing(command[0])
 
 
713
        self.to_file.write(proc.stdout.read())
 
 
716
    def _try_symlink_root(self, tree, prefix):
 
 
717
        if (getattr(tree, 'abspath', None) is None
 
 
718
            or not osutils.host_os_dereferences_symlinks()):
 
 
721
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
 
 
723
            if e.errno != errno.EEXIST:
 
 
727
    def _write_file(self, file_id, tree, prefix, relpath):
 
 
728
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
 
729
        if self._try_symlink_root(tree, prefix):
 
 
731
        parent_dir = osutils.dirname(full_path)
 
 
733
            os.makedirs(parent_dir)
 
 
735
            if e.errno != errno.EEXIST:
 
 
737
        source = tree.get_file(file_id, relpath)
 
 
739
            target = open(full_path, 'wb')
 
 
741
                osutils.pumpfile(source, target)
 
 
746
        osutils.make_readonly(full_path)
 
 
747
        mtime = tree.get_file_mtime(file_id)
 
 
748
        os.utime(full_path, (mtime, mtime))
 
 
751
    def _prepare_files(self, file_id, old_path, new_path):
 
 
752
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
 
754
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
 
756
        return old_disk_path, new_disk_path
 
 
759
        osutils.rmtree(self._root)
 
 
761
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
 
 
762
        if (old_kind, new_kind) != ('file', 'file'):
 
 
763
            return DiffPath.CANNOT_DIFF
 
 
764
        self._prepare_files(file_id, old_path, new_path)
 
 
765
        self._execute(osutils.pathjoin('old', old_path),
 
 
766
                      osutils.pathjoin('new', new_path))
 
 
769
class DiffTree(object):
 
 
770
    """Provides textual representations of the difference between two trees.
 
 
772
    A DiffTree examines two trees and where a file-id has altered
 
 
773
    between them, generates a textual representation of the difference.
 
 
774
    DiffTree uses a sequence of DiffPath objects which are each
 
 
775
    given the opportunity to handle a given altered fileid. The list
 
 
776
    of DiffPath objects can be extended globally by appending to
 
 
777
    DiffTree.diff_factories, or for a specific diff operation by
 
 
778
    supplying the extra_factories option to the appropriate method.
 
 
781
    # list of factories that can provide instances of DiffPath objects
 
 
782
    # may be extended by plugins.
 
 
783
    diff_factories = [DiffSymlink.from_diff_tree,
 
 
784
                      DiffDirectory.from_diff_tree]
 
 
786
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
 
787
                 diff_text=None, extra_factories=None):
 
 
790
        :param old_tree: Tree to show as old in the comparison
 
 
791
        :param new_tree: Tree to show as new in the comparison
 
 
792
        :param to_file: File to write comparision to
 
 
793
        :param path_encoding: Character encoding to write paths in
 
 
794
        :param diff_text: DiffPath-type object to use as a last resort for
 
 
796
        :param extra_factories: Factories of DiffPaths to try before any other
 
 
798
        if diff_text is None:
 
 
799
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
 
800
                                 '', '',  internal_diff)
 
 
801
        self.old_tree = old_tree
 
 
802
        self.new_tree = new_tree
 
 
803
        self.to_file = to_file
 
 
804
        self.path_encoding = path_encoding
 
 
806
        if extra_factories is not None:
 
 
807
            self.differs.extend(f(self) for f in extra_factories)
 
 
808
        self.differs.extend(f(self) for f in self.diff_factories)
 
 
809
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
 
 
812
    def from_trees_options(klass, old_tree, new_tree, to_file,
 
 
813
                           path_encoding, external_diff_options, old_label,
 
 
815
        """Factory for producing a DiffTree.
 
 
817
        Designed to accept options used by show_diff_trees.
 
 
818
        :param old_tree: The tree to show as old in the comparison
 
 
819
        :param new_tree: The tree to show as new in the comparison
 
 
820
        :param to_file: File to write comparisons to
 
 
821
        :param path_encoding: Character encoding to use for writing paths
 
 
822
        :param external_diff_options: If supplied, use the installed diff
 
 
823
            binary to perform file comparison, using supplied options.
 
 
824
        :param old_label: Prefix to use for old file labels
 
 
825
        :param new_label: Prefix to use for new file labels
 
 
826
        :param using: Commandline to use to invoke an external diff tool
 
 
828
        if using is not None:
 
 
829
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
 
 
832
        if external_diff_options:
 
 
833
            opts = external_diff_options.split()
 
 
834
            def diff_file(olab, olines, nlab, nlines, to_file):
 
 
835
                external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
837
            diff_file = internal_diff
 
 
838
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
 
 
839
                             old_label, new_label, diff_file)
 
 
840
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
 
 
843
    def show_diff(self, specific_files, extra_trees=None):
 
 
844
        """Write tree diff to self.to_file
 
 
846
        :param sepecific_files: the specific files to compare (recursive)
 
 
847
        :param extra_trees: extra trees to use for mapping paths to file_ids
 
 
850
            return self._show_diff(specific_files, extra_trees)
 
 
852
            for differ in self.differs:
 
 
855
    def _show_diff(self, specific_files, extra_trees):
 
 
856
        # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
857
        # be usefully made into a much faster special case.
 
 
858
        iterator = self.new_tree.iter_changes(self.old_tree,
 
 
859
                                               specific_files=specific_files,
 
 
860
                                               extra_trees=extra_trees,
 
 
861
                                               require_versioned=True)
 
 
863
        def changes_key(change):
 
 
864
            old_path, new_path = change[1]
 
 
869
        def get_encoded_path(path):
 
 
871
                return path.encode(self.path_encoding, "replace")
 
 
872
        for (file_id, paths, changed_content, versioned, parent, name, kind,
 
 
873
             executable) in sorted(iterator, key=changes_key):
 
 
874
            # The root does not get diffed, and items with no known kind (that
 
 
875
            # is, missing) in both trees are skipped as well.
 
 
876
            if parent == (None, None) or kind == (None, None):
 
 
878
            oldpath, newpath = paths
 
 
879
            oldpath_encoded = get_encoded_path(paths[0])
 
 
880
            newpath_encoded = get_encoded_path(paths[1])
 
 
881
            old_present = (kind[0] is not None and versioned[0])
 
 
882
            new_present = (kind[1] is not None and versioned[1])
 
 
883
            renamed = (parent[0], name[0]) != (parent[1], name[1])
 
 
885
            properties_changed = []
 
 
886
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
 
 
888
            if properties_changed:
 
 
889
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
 
 
893
            if (old_present, new_present) == (True, False):
 
 
894
                self.to_file.write("=== removed %s '%s'\n" %
 
 
895
                                   (kind[0], oldpath_encoded))
 
 
897
            elif (old_present, new_present) == (False, True):
 
 
898
                self.to_file.write("=== added %s '%s'\n" %
 
 
899
                                   (kind[1], newpath_encoded))
 
 
902
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
 
903
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
 
 
905
                # if it was produced by iter_changes, it must be
 
 
906
                # modified *somehow*, either content or execute bit.
 
 
907
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
 
 
908
                                   newpath_encoded, prop_str))
 
 
910
                self.diff(file_id, oldpath, newpath)
 
 
916
    def diff(self, file_id, old_path, new_path):
 
 
917
        """Perform a diff of a single file
 
 
919
        :param file_id: file-id of the file
 
 
920
        :param old_path: The path of the file in the old tree
 
 
921
        :param new_path: The path of the file in the new tree
 
 
924
            old_kind = self.old_tree.kind(file_id)
 
 
925
        except (errors.NoSuchId, errors.NoSuchFile):
 
 
928
            new_kind = self.new_tree.kind(file_id)
 
 
929
        except (errors.NoSuchId, errors.NoSuchFile):
 
 
932
        result = DiffPath._diff_many(self.differs, file_id, old_path,
 
 
933
                                       new_path, old_kind, new_kind)
 
 
934
        if result is DiffPath.CANNOT_DIFF:
 
 
935
            error_path = new_path
 
 
936
            if error_path is None:
 
 
937
                error_path = old_path
 
 
938
            raise errors.NoDiffFound(error_path)