← Back to branch summary

~bzr/ubuntu/lucid/bzr/beta-ppa

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: Martin Pool
  • Date: 2010-07-02 07:29:40 UTC
  • mfrom: (129.1.7 packaging-karmic)
  • Revision ID: mbp@sourcefrog.net-20100702072940-hpzq5elg8wjve8rh
http://bugs.debian.org/452024
http://bugs.debian.org/464688
http://bugs.debian.org/523595
http://bugs.debian.org/526233
http://bugs.debian.org/537708
http://bugs.debian.org/555336
http://bugs.debian.org/555343
https://launchpad.net/bugs/249452
https://launchpad.net/bugs/385074
* PPA rebuild.
* PPA rebuild for Karmic.
* PPA rebuild for Jaunty.
* PPA rebuild for Hardy.
* From postinst, actually remove the example bash completion scripts.
  (LP: #249452)
* New upstream release.
* New upstream release.
* New upstream release.
* Revert change to Build-depends: Dapper does not have python-central.
  Should be python-support..
* Target ppa..
* Target ppa..
* Target ppa..
* Target ppa..
* New upstream release.
* Switch to dpkg-source 3.0 (quilt) format.
* Bump standards version to 3.8.4.
* Remove embedded copy of python-configobj. Closes: #555336
* Remove embedded copy of python-elementtree. Closes: #555343
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* Change section from 'Devel' to 'Vcs'..
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* debian/control: Fix obsolete-relation-form-in-source
  lintian warning. 
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split out docs into bzr-doc package.
* New upstream release.
* Added John Francesco Ferlito to Uploaders.
* Fix install path to quick-reference guide
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to doc paths changing
* New upstream release.
* Fix FTBFS due to path changes, again, again.
* Fix FTBFS due to path changes, again.
* Fix FTBFS due to path changes.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Bump standards version to 3.8.3.
* Remove unused patch system.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix copy and paste tab error in .install file
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
 + Fixes compatibility with Python 2.4. Closes: #537708
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream version.
* Bump standards version to 3.8.2.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add python-pyrex to build-deps to ensure C extensions are always build.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* Split documentation into bzr-doc package. ((LP: #385074)
* Multiple packaging changes to make us more linitan clean.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Fix API compatibility version. (Closes: #526233)
* New upstream release.
  + Fixes default format for upgrade command. (Closes: #464688)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add missing dependency on zlib development library. (Closes:
  #523595)
* Add zlib build-depends.
* Add zlib build-depends.
* Add zlib build-depends.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Move to section vcs.
* Bump standards version to 3.8.1.
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* New upstream release.
* Remove temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* Add temporary patch for missing .c files from distribution
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Recommend ca-certificates. (Closes: #452024)
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Update watch file. bazaar now uses launchpad to host its sources.
* Remove patch for inventory root revision copy, applied upstream.
* New upstream release.
* New upstream release.
* New upstream release
* Force removal of files installed in error to /etc/bash_completion.d/
  (LP: #249452)
* New upstream release.
* New upstream release
* New upstream release.
* Bump standards version.
* Include patch for inventory root revision copy, required for bzr-svn.
* New upstream release.
* Remove unused lintian overrides.
* Correct the package version not to be native.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* New upstream release.
* Final 1.5 release.
* New upstream release.
* New upstream release.
* New upstream release.
* Add myself as a co-maintainer.
* Add a Dm-Upload-Allowed: yes header.
* New upstream bugfix release.
* New upstream release.
* Final 1.3 release.
* New upstream release.
* First release candidate of the upcoming 1.3 release.
* Rebuild to fix the problem caused by a build with a broken python-central.
* New upstream release.
* Rebuild for dapper PPA.
* Apply Lamont's patches to fix build-dependencies on dapper.
  (See: https://bugs.launchpad.net/bzr/+bug/189915)

Show diffs side-by-side

added added

removed removed

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