/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Ian Clatworthy
  • Date: 2008-06-06 11:55:58 UTC
  • mto: (3480.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3481.
  • Revision ID: ian.clatworthy@canonical.com-20080606115558-qw0kh7p3dl1o6o9s
tweaks requested by jam & poolie during review

Show diffs side-by-side

added added

removed removed

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