/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

Merge bzr.dev

Show diffs side-by-side

added added

removed removed

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