/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
1
# Copyright (C) 2005-2014 Canonical Ltd.
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
2
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
7
#
1 by mbp at sourcefrog
import from baz patch-364
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.
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
12
#
1 by mbp at sourcefrog
import from baz patch-364
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
4183.7.1 by Sabin Iacob
update FSF mailing address
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
1 by mbp at sourcefrog
import from baz patch-364
16
6379.6.1 by Jelmer Vernooij
Import absolute_import in a few places.
17
from __future__ import absolute_import
18
2520.4.140 by Aaron Bentley
Use matching blocks from mpdiff for knit delta creation
19
import difflib
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
20
import os
1899.1.5 by John Arbash Meinel
Always buffer the output of diff, so we can check if retcode==2 is because of Binary files
21
import re
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
22
import string
1996.3.9 by John Arbash Meinel
lazy_import diff.py
23
import sys
24
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
25
from .lazy_import import lazy_import
1996.3.9 by John Arbash Meinel
lazy_import diff.py
26
lazy_import(globals(), """
27
import errno
1692.8.7 by James Henstridge
changes suggested by John Meinel
28
import subprocess
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
29
import tempfile
1740.2.5 by Aaron Bentley
Merge from bzr.dev
30
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
31
from breezy import (
4913.5.24 by Gordon Tyler
Added cmdline.split function, which replaces commands.shlex_split_unicode.
32
    cmdline,
6207.3.3 by jelmer at samba
Fix tests and the like.
33
    controldir,
1955.2.10 by John Arbash Meinel
Unset a few other LANG type variables when spawning diff
34
    errors,
35
    osutils,
1996.3.9 by John Arbash Meinel
lazy_import diff.py
36
    patiencediff,
37
    textfile,
1551.12.29 by Aaron Bentley
Copy and extend patch date formatting code, add patch-date parsing
38
    timestamp,
3586.1.21 by Ian Clatworthy
enhance diff to support views
39
    views,
1955.2.10 by John Arbash Meinel
Unset a few other LANG type variables when spawning diff
40
    )
4845.2.1 by Gary van der Merwe
When launching an external diff app, don't write temporary files for a working tree.
41
6622.1.34 by Jelmer Vernooij
Rename brzlib => breezy.
42
from breezy.workingtree import WorkingTree
43
from breezy.i18n import gettext
1996.3.9 by John Arbash Meinel
lazy_import diff.py
44
""")
45
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
46
from .registry import (
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
47
    Registry,
48
    )
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
49
from .sixish import text_type
6624 by Jelmer Vernooij
Merge Python3 porting work ('py3 pokes')
50
from .trace import mutter, note, warning
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
51
from .tree import FileTimestampUnavailable
52
1 by mbp at sourcefrog
import from baz patch-364
53
6524.5.8 by Paul Nixon
Changed "default_context_amount" to be "DEFAULT_CONTEXT_AMOUNT" to be
54
DEFAULT_CONTEXT_AMOUNT = 3
1711.2.24 by John Arbash Meinel
Late bind to PatienceSequenceMatcher to allow plugin to override.
55
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
56
class AtTemplate(string.Template):
57
    """Templating class that uses @ instead of $."""
58
59
    delimiter = '@'
60
61
767 by Martin Pool
- files are only reported as modified if their name or parent has changed,
62
# TODO: Rather than building a changeset object, we should probably
63
# invoke callbacks on an object.  That object can either accumulate a
64
# list, write them out directly, etc etc.
65
2520.4.140 by Aaron Bentley
Use matching blocks from mpdiff for knit delta creation
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
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
76
def internal_diff(old_label, oldlines, new_label, newlines, to_file,
1711.2.30 by John Arbash Meinel
Fix bug in internal_diff handling of unicode paths
77
                  allow_binary=False, sequence_matcher=None,
6524.5.8 by Paul Nixon
Changed "default_context_amount" to be "DEFAULT_CONTEXT_AMOUNT" to be
78
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
475 by Martin Pool
- rewrite diff using compare_trees()
79
    # FIXME: difflib is wrong if there is no trailing newline.
80
    # The syntax used by patch seems to be "\ No newline at
81
    # end of file" following the last diff line from that
82
    # file.  This is not trivial to insert into the
83
    # unified_diff output and it might be better to just fix
84
    # or replace that function.
85
86
    # In the meantime we at least make sure the patch isn't
87
    # mangled.
88
1558.15.11 by Aaron Bentley
Apply merge review suggestions
89
    if allow_binary is False:
1996.3.9 by John Arbash Meinel
lazy_import diff.py
90
        textfile.check_text_lines(oldlines)
91
        textfile.check_text_lines(newlines)
475 by Martin Pool
- rewrite diff using compare_trees()
92
1185.81.8 by John Arbash Meinel
Updating unified_diff to take a factory, using the new diff algorithm in the code.
93
    if sequence_matcher is None:
1996.3.9 by John Arbash Meinel
lazy_import diff.py
94
        sequence_matcher = patiencediff.PatienceSequenceMatcher
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
95
    ud = patiencediff.unified_diff_bytes(oldlines, newlines,
96
                      fromfile=old_label.encode(path_encoding, 'replace'),
97
                      tofile=new_label.encode(path_encoding, 'replace'),
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
98
                      n=context_lines, sequencematcher=sequence_matcher)
475 by Martin Pool
- rewrite diff using compare_trees()
99
1092.1.50 by Robert Collins
make diff lsdiff/filterdiff friendly
100
    ud = list(ud)
3085.1.1 by John Arbash Meinel
Fix internal_diff to not fail when the texts are identical.
101
    if len(ud) == 0: # Identical contents, nothing to do
102
        return
475 by Martin Pool
- rewrite diff using compare_trees()
103
    # work-around for difflib being too smart for its own good
104
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
105
    if not oldlines:
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
106
        ud[2] = ud[2].replace(b'-1,0', b'-0,0')
475 by Martin Pool
- rewrite diff using compare_trees()
107
    elif not newlines:
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
108
        ud[2] = ud[2].replace(b'+1,0', b'+0,0')
475 by Martin Pool
- rewrite diff using compare_trees()
109
804 by Martin Pool
Patch from John:
110
    for line in ud:
111
        to_file.write(line)
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
112
        if not line.endswith(b'\n'):
113
            to_file.write(b"\n\\ No newline at end of file\n")
114
    to_file.write(b'\n')
475 by Martin Pool
- rewrite diff using compare_trees()
115
116
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
117
def _spawn_external_diff(diffcmd, capture_errors=True):
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
118
    """Spawn the external diff process, and return the child handle.
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
119
120
    :param diffcmd: The command list to spawn
2138.1.1 by Wouter van Heyst
Robuster external diff output handling.
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.
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
124
    :return: A Popen object.
125
    """
126
    if capture_errors:
2321.2.2 by Alexander Belchenko
win32 fixes for test_external_diff_binary (gettext on win32 rely on $LANGUAGE)
127
        # construct minimal environment
128
        env = {}
129
        path = os.environ.get('PATH')
130
        if path is not None:
131
            env['PATH'] = path
2321.2.5 by Alexander Belchenko
external diff: no need for special code path for win32 (suggested by John Meinel)
132
        env['LANGUAGE'] = 'C'   # on win32 only LANGUAGE has effect
133
        env['LANG'] = 'C'
134
        env['LC_ALL'] = 'C'
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
135
        stderr = subprocess.PIPE
136
    else:
2321.2.2 by Alexander Belchenko
win32 fixes for test_external_diff_binary (gettext on win32 rely on $LANGUAGE)
137
        env = None
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
138
        stderr = None
139
140
    try:
141
        pipe = subprocess.Popen(diffcmd,
142
                                stdin=subprocess.PIPE,
143
                                stdout=subprocess.PIPE,
144
                                stderr=stderr,
2321.2.2 by Alexander Belchenko
win32 fixes for test_external_diff_binary (gettext on win32 rely on $LANGUAGE)
145
                                env=env)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
146
    except OSError as e:
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
147
        if e.errno == errno.ENOENT:
148
            raise errors.NoDiff(str(e))
149
        raise
150
151
    return pipe
152
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
153
# diff style options as of GNU diff v3.2
154
style_option_list = ['-c', '-C', '--context',
155
                     '-e', '--ed',
6597.2.4 by Vincent Ladeuil
Doh, this is *still* supported by diff 3.3 (just not documented in the man page nor the online help anymore).
156
                     '-f', '--forward-ed',
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
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
186
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
187
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
188
def external_diff(old_label, oldlines, new_label, newlines, to_file,
571 by Martin Pool
- new --diff-options to pass options through to external
189
                  diff_opts):
568 by Martin Pool
- start adding support for showing diffs by calling out to
190
    """Display a diff by calling out to the external diff program."""
581 by Martin Pool
- make sure any bzr output is flushed before
191
    # make sure our own output is properly ordered before the diff
192
    to_file.flush()
193
6681.2.4 by Jelmer Vernooij
More renames.
194
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
195
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
196
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
197
    newtmpf = os.fdopen(newtmp_fd, 'wb')
568 by Martin Pool
- start adding support for showing diffs by calling out to
198
199
    try:
200
        # TODO: perhaps a special case for comparing to or from the empty
201
        # sequence; can just use /dev/null on Unix
202
203
        # TODO: if either of the files being compared already exists as a
204
        # regular named file (e.g. in the working directory) then we can
205
        # compare directly to that, rather than copying it.
206
207
        oldtmpf.writelines(oldlines)
208
        newtmpf.writelines(newlines)
209
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
210
        oldtmpf.close()
211
        newtmpf.close()
568 by Martin Pool
- start adding support for showing diffs by calling out to
212
571 by Martin Pool
- new --diff-options to pass options through to external
213
        if not diff_opts:
214
            diff_opts = []
4422.1.1 by John Arbash Meinel
Possibly fix for bug #382709 handling non-ascii external filenames.
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
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
218
            old_label = old_label.encode('mbcs')
219
            new_label = new_label.encode('mbcs')
571 by Martin Pool
- new --diff-options to pass options through to external
220
        diffcmd = ['diff',
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
221
                   '--label', old_label,
1711.2.54 by John Arbash Meinel
Use mkstemp instead of NamedTemporary file for external diff.
222
                   old_abspath,
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
223
                   '--label', new_label,
1711.2.56 by John Arbash Meinel
Raise NoDiff if 'diff' not present.
224
                   new_abspath,
225
                   '--binary',
226
                  ]
571 by Martin Pool
- new --diff-options to pass options through to external
227
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
228
        diff_opts = default_style_unified(diff_opts)
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
229
571 by Martin Pool
- new --diff-options to pass options through to external
230
        if diff_opts:
231
            diffcmd.extend(diff_opts)
232
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
233
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
6809.1.1 by Martin
Apply 2to3 ws_comma fixer
234
        out, err = pipe.communicate()
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
235
        rc = pipe.returncode
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
236
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
237
        # internal_diff() adds a trailing newline, add one here for consistency
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
238
        out += b'\n'
1899.1.5 by John Arbash Meinel
Always buffer the output of diff, so we can check if retcode==2 is because of Binary files
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.
1904.1.4 by Marien Zwart
Make external diff in binary mode work with recent versions of diffutils.
243
            # 'Binary files' is not a real error, so we suppress that error.
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
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
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
251
            to_file.write(out+b'\n')
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
252
            if pipe.returncode != 2:
1996.3.9 by John Arbash Meinel
lazy_import diff.py
253
                raise errors.BzrError(
254
                               'external diff failed with exit code 2'
2138.1.1 by Wouter van Heyst
Robuster external diff output handling.
255
                               ' when run with LANG=C and LC_ALL=C,'
256
                               ' but not when run natively: %r' % (diffcmd,))
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
257
7031.1.4 by Jelmer Vernooij
Fix tests.
258
            first_line = lang_c_out.split(b'\n', 1)[0]
1904.1.4 by Marien Zwart
Make external diff in binary mode work with recent versions of diffutils.
259
            # Starting with diffutils 2.8.4 the word "binary" was dropped.
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
260
            m = re.match(b'^(binary )?files.*differ$', first_line, re.I)
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
261
            if m is None:
1996.3.9 by John Arbash Meinel
lazy_import diff.py
262
                raise errors.BzrError('external diff failed with exit code 2;'
263
                                      ' command: %r' % (diffcmd,))
1920.1.1 by John Arbash Meinel
fix bug #56307, handle binary files even when LANG is not english
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):
571 by Martin Pool
- new --diff-options to pass options through to external
272
            # returns 1 if files differ; that's OK
273
            if rc < 0:
274
                msg = 'signal %d' % (-rc)
275
            else:
276
                msg = 'exit code %d' % rc
3943.8.1 by Marius Kruger
remove all trailing whitespace from bzr source
277
278
            raise errors.BzrError('external diff failed with %s; command: %r'
6597.2.1 by Richard Wilbur
Split diff format option parser into a separate function, update to include all format options for GNU diff v3.2, and test parser.
279
                                  % (msg, diffcmd))
1899.1.6 by John Arbash Meinel
internal_diff always adds a trailing \n, make sure external_diff does too
280
281
568 by Martin Pool
- start adding support for showing diffs by calling out to
282
    finally:
283
        oldtmpf.close()                 # and delete
284
        newtmpf.close()
6597.2.3 by Vincent Ladeuil
Remove duplication in cleanups. Note that --forward-ed is not in diff 3.3 and may need to be removed from the supported options.
285
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)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
292
            except OSError as e:
6597.2.3 by Vincent Ladeuil
Remove duplication in cleanups. Note that --forward-ed is not in diff 3.3 and may need to be removed from the supported options.
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)
568 by Martin Pool
- start adding support for showing diffs by calling out to
298
1551.2.13 by Aaron Bentley
Got diff working properly with checkouts
299
5147.3.3 by Andrew Bennetts
Add get_trees_and_branches_to_diff_locked, leave get_trees_and_branches_to_diff unchanged for qbzr.
300
def get_trees_and_branches_to_diff_locked(
301
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
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.
5147.3.1 by Andrew Bennetts
Avoid 6 branch/repo relocks in cmd_diff.
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.
3586.1.21 by Ian Clatworthy
enhance diff to support views
321
    :param apply_view:
322
        if True and a view is set, apply the view or check that the paths
323
        are within it
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
324
    :returns:
4739.3.1 by Jonathan Lange
Fix the docstring for get_trees_and_branches_to_diff.
325
        a tuple of (old_tree, new_tree, old_branch, new_branch,
326
        specific_files, extra_trees) where extra_trees is a sequence of
5147.3.1 by Andrew Bennetts
Avoid 6 branch/repo relocks in cmd_diff.
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.
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
330
    """
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]
3072.1.5 by Ian Clatworthy
more good ideas from abentley
337
            if old_url is None:
338
                old_url = old_revision_spec.get_branch()
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
339
        if len(revision_specs) > 1:
340
            new_revision_spec = revision_specs[1]
3072.1.5 by Ian Clatworthy
more good ideas from abentley
341
            if new_url is None:
342
                new_url = new_revision_spec.get_branch()
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
343
3072.1.5 by Ian Clatworthy
more good ideas from abentley
344
    other_paths = []
345
    make_paths_wt_relative = True
3164.1.1 by Ian Clatworthy
diff without arguments means the current tree, not the current directory
346
    consider_relpath = True
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
347
    if path_list is None or len(path_list) == 0:
3164.1.1 by Ian Clatworthy
diff without arguments means the current tree, not the current directory
348
        # If no path is given, the current working tree is used
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
349
        default_location = u'.'
3164.1.1 by Ian Clatworthy
diff without arguments means the current tree, not the current directory
350
        consider_relpath = False
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
351
    elif old_url is not None and new_url is not None:
352
        other_paths = path_list
3072.1.5 by Ian Clatworthy
more good ideas from abentley
353
        make_paths_wt_relative = False
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
354
    else:
355
        default_location = path_list[0]
356
        other_paths = path_list[1:]
357
5147.3.1 by Andrew Bennetts
Avoid 6 branch/repo relocks in cmd_diff.
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
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
366
    # Get the old location
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
367
    specific_files = []
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
368
    if old_url is None:
369
        old_url = default_location
370
    working_tree, branch, relpath = \
6207.3.3 by jelmer at samba
Fix tests and the like.
371
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
5147.3.1 by Andrew Bennetts
Avoid 6 branch/repo relocks in cmd_diff.
372
    lock_tree_or_branch(working_tree, branch)
3164.1.1 by Ian Clatworthy
diff without arguments means the current tree, not the current directory
373
    if consider_relpath and relpath != '':
3586.1.21 by Ian Clatworthy
enhance diff to support views
374
        if working_tree is not None and apply_view:
4032.4.1 by Eduardo Padoan
Moved diff._check_path_in_view() to views.check_path_in_view()
375
            views.check_path_in_view(working_tree, relpath)
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
376
        specific_files.append(relpath)
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
377
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
4705.1.1 by Gary van der Merwe
Change _get_trees_to_diff to get_trees_and_branches_to_diff.
378
    old_branch = branch
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
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 = \
6207.3.3 by jelmer at samba
Fix tests and the like.
385
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
5147.3.1 by Andrew Bennetts
Avoid 6 branch/repo relocks in cmd_diff.
386
        lock_tree_or_branch(working_tree, branch)
3164.1.1 by Ian Clatworthy
diff without arguments means the current tree, not the current directory
387
        if consider_relpath and relpath != '':
3586.1.21 by Ian Clatworthy
enhance diff to support views
388
            if working_tree is not None and apply_view:
4032.4.1 by Eduardo Padoan
Moved diff._check_path_in_view() to views.check_path_in_view()
389
                views.check_path_in_view(working_tree, relpath)
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
390
            specific_files.append(relpath)
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
391
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
392
        basis_is_default=working_tree is None)
4705.1.1 by Gary van der Merwe
Change _get_trees_to_diff to get_trees_and_branches_to_diff.
393
    new_branch = branch
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
394
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
395
    # Get the specific files (all files is None, no files is [])
3072.1.5 by Ian Clatworthy
more good ideas from abentley
396
    if make_paths_wt_relative and working_tree is not None:
5346.4.3 by Martin Pool
PathNotChild should not give a traceback.
397
        other_paths = working_tree.safe_relpath_files(
398
            other_paths,
399
            apply_view=apply_view)
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
400
    specific_files.extend(other_paths)
401
    if len(specific_files) == 0:
402
        specific_files = None
3586.1.21 by Ian Clatworthy
enhance diff to support views
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)
6138.3.4 by Jonathan Riddell
add gettext() to uses of trace.note()
409
                note(gettext("*** Ignoring files outside view. View is %s") % view_str)
3072.1.2 by Ian Clatworthy
Test various --old and --new combinations
410
411
    # Get extra trees that ought to be searched for file-ids
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
412
    extra_trees = None
3072.1.5 by Ian Clatworthy
more good ideas from abentley
413
    if working_tree is not None and working_tree not in (old_tree, new_tree):
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
414
        extra_trees = (working_tree,)
6027.1.4 by Vincent Ladeuil
Remove ``diff.get_trees_and_branches_to_diff`` deprecated in 2.2.0 and the corrsponding tests.
415
    return (old_tree, new_tree, old_branch, new_branch,
416
            specific_files, extra_trees)
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
417
4739.3.1 by Jonathan Lange
Fix the docstring for get_trees_and_branches_to_diff.
418
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
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:
3072.1.5 by Ian Clatworthy
more good ideas from abentley
424
            if tree is not None:
425
                return tree.basis_tree()
426
            else:
427
                return branch.basis_tree()
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
428
        else:
429
            return tree
3655.3.1 by Lukáš Lalinský
Fix `bzr st -rbranch:PATH_TO_BRANCH`
430
    return spec.as_tree(branch)
3072.1.1 by Ian Clatworthy
Improved diff based on feedback from abentley
431
432
571 by Martin Pool
- new --diff-options to pass options through to external
433
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
1684.1.6 by Martin Pool
(patch) --diff-prefix option (goffredo, alexander)
434
                    external_diff_options=None,
1551.7.17 by Aaron Bentley
Switch to PathsNotVersioned, accept extra_trees
435
                    old_label='a/', new_label='b/',
2598.6.12 by ghigo
Move the encoding of the commit message at the command line level
436
                    extra_trees=None,
3123.6.2 by Aaron Bentley
Implement diff --using natively
437
                    path_encoding='utf8',
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
438
                    using=None,
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
439
                    format_cls=None,
6524.5.8 by Paul Nixon
Changed "default_context_amount" to be "DEFAULT_CONTEXT_AMOUNT" to be
440
                    context=DEFAULT_CONTEXT_AMOUNT):
550 by Martin Pool
- Refactor diff code into one that works purely on
441
    """Show in text form the changes from one tree to another.
442
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
443
    :param to_file: The output stream.
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
444
    :param specific_files: Include only changes to these files - None for all
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
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)
550 by Martin Pool
- Refactor diff code into one that works purely on
452
    """
6524.5.4 by Paul Nixon
Clearing up default context options
453
    if context is None:
6524.5.8 by Paul Nixon
Changed "default_context_amount" to be "DEFAULT_CONTEXT_AMOUNT" to be
454
        context = DEFAULT_CONTEXT_AMOUNT
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
455
    if format_cls is None:
456
        format_cls = DiffTree
6754.8.4 by Jelmer Vernooij
Use new context stuff.
457
    with old_tree.lock_read():
2255.7.38 by John Arbash Meinel
show_diff_trees() should lock any extra trees it is passed.
458
        if extra_trees is not None:
459
            for tree in extra_trees:
460
                tree.lock_read()
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
461
        new_tree.lock_read()
462
        try:
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
463
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
464
                                                   path_encoding,
465
                                                   external_diff_options,
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
466
                                                   old_label, new_label, using,
467
                                                   context_lines=context)
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
468
            return differ.show_diff(specific_files, extra_trees)
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
469
        finally:
470
            new_tree.unlock()
2255.7.38 by John Arbash Meinel
show_diff_trees() should lock any extra trees it is passed.
471
            if extra_trees is not None:
472
                for tree in extra_trees:
473
                    tree.unlock()
1543.1.1 by Denys Duchier
lock operations for trees - use them for diff
474
475
1740.2.5 by Aaron Bentley
Merge from bzr.dev
476
def _patch_header_date(tree, file_id, path):
477
    """Returns a timestamp suitable for use in a patch header."""
4976.1.3 by Jelmer Vernooij
Cope with ghosts in 'bzr diff'
478
    try:
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
479
        mtime = tree.get_file_mtime(path, file_id)
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
480
    except FileTimestampUnavailable:
4976.1.3 by Jelmer Vernooij
Cope with ghosts in 'bzr diff'
481
        mtime = 0
2405.1.2 by John Arbash Meinel
Fix bug #103870 by passing None instead of a (sometimes wrong) path
482
    return timestamp.format_patch_date(mtime)
1740.2.5 by Aaron Bentley
Merge from bzr.dev
483
484
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
485
def get_executable_change(old_is_x, new_is_x):
7029.4.2 by Jelmer Vernooij
Fix more merge tests.
486
    descr = { True:b"+x", False:b"-x", None:b"??" }
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
487
    if old_is_x != new_is_x:
7029.4.2 by Jelmer Vernooij
Fix more merge tests.
488
        return [b"%s to %s" % (descr[old_is_x], descr[new_is_x],)]
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
489
    else:
490
        return []
491
1398 by Robert Collins
integrate in Gustavos x-bit patch
492
3009.2.22 by Aaron Bentley
Update names & docstring
493
class DiffPath(object):
3009.2.14 by Aaron Bentley
Update return type handling
494
    """Base type for command object that compare files"""
3009.2.17 by Aaron Bentley
Update docs
495
3009.2.14 by Aaron Bentley
Update return type handling
496
    # The type or contents of the file were unsuitable for diffing
3009.2.29 by Aaron Bentley
Change constants to strings
497
    CANNOT_DIFF = 'CANNOT_DIFF'
3009.2.14 by Aaron Bentley
Update return type handling
498
    # The file has changed in a semantic way
3009.2.29 by Aaron Bentley
Change constants to strings
499
    CHANGED = 'CHANGED'
500
    # The file content may have changed, but there is no semantic change
501
    UNCHANGED = 'UNCHANGED'
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
502
3009.2.13 by Aaron Bentley
Refactor differ to support registering differ factories
503
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
3009.2.17 by Aaron Bentley
Update docs
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
        """
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
511
        self.old_tree = old_tree
512
        self.new_tree = new_tree
513
        self.to_file = to_file
3009.2.13 by Aaron Bentley
Refactor differ to support registering differ factories
514
        self.path_encoding = path_encoding
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
515
3123.6.2 by Aaron Bentley
Implement diff --using natively
516
    def finish(self):
517
        pass
518
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
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
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
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)
3009.2.22 by Aaron Bentley
Update names & docstring
529
            if result is not DiffPath.CANNOT_DIFF:
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
530
                return result
531
        else:
3009.2.22 by Aaron Bentley
Update names & docstring
532
            return DiffPath.CANNOT_DIFF
533
534
535
class DiffKindChange(object):
3009.2.17 by Aaron Bentley
Update docs
536
    """Special differ for file kind changes.
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
537
3009.2.17 by Aaron Bentley
Update docs
538
    Represents kind change as deletion + creation.  Uses the other differs
539
    to do this.
540
    """
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
541
    def __init__(self, differs):
542
        self.differs = differs
543
3123.6.2 by Aaron Bentley
Implement diff --using natively
544
    def finish(self):
545
        pass
546
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
547
    @classmethod
548
    def from_diff_tree(klass, diff_tree):
549
        return klass(diff_tree.differs)
550
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
551
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
3009.2.17 by Aaron Bentley
Update docs
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
        """
3009.2.18 by Aaron Bentley
Change KindChangeDiffer's anti-recursion to avoid kind pairs with None
560
        if None in (old_kind, new_kind):
3009.2.22 by Aaron Bentley
Update names & docstring
561
            return DiffPath.CANNOT_DIFF
562
        result = DiffPath._diff_many(self.differs, file_id, old_path,
3009.2.18 by Aaron Bentley
Change KindChangeDiffer's anti-recursion to avoid kind pairs with None
563
                                       new_path, old_kind, None)
3009.2.22 by Aaron Bentley
Update names & docstring
564
        if result is DiffPath.CANNOT_DIFF:
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
565
            return result
3009.2.22 by Aaron Bentley
Update names & docstring
566
        return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
567
                                     None, new_kind)
568
569
3009.2.22 by Aaron Bentley
Update names & docstring
570
class DiffDirectory(DiffPath):
3009.2.19 by Aaron Bentley
Implement directory diffing
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
3009.2.20 by Aaron Bentley
PEP8
584
3009.2.22 by Aaron Bentley
Update names & docstring
585
class DiffSymlink(DiffPath):
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
586
587
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
3009.2.17 by Aaron Bentley
Update docs
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
        """
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
596
        if 'symlink' not in (old_kind, new_kind):
3009.2.14 by Aaron Bentley
Update return type handling
597
            return self.CANNOT_DIFF
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
598
        if old_kind == 'symlink':
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
599
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
600
        elif old_kind is None:
601
            old_target = None
602
        else:
3009.2.14 by Aaron Bentley
Update return type handling
603
            return self.CANNOT_DIFF
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
604
        if new_kind == 'symlink':
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
605
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
606
        elif new_kind is None:
607
            new_target = None
608
        else:
3009.2.14 by Aaron Bentley
Update return type handling
609
            return self.CANNOT_DIFF
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
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:
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
614
            self.to_file.write(b'=== target is \'%s\'\n' %
615
                new_target.encode(self.path_encoding, 'replace'))
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
616
        elif new_target is None:
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
617
            self.to_file.write(b'=== target was \'%s\'\n' %
618
                old_target.encode(self.path_encoding, 'replace'))
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
619
        else:
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
620
            self.to_file.write(b'=== target changed \'%s\' => \'%s\'\n' %
621
                              (old_target.encode(self.path_encoding, 'replace'),
622
                               new_target.encode(self.path_encoding, 'replace')))
3009.2.14 by Aaron Bentley
Update return type handling
623
        return self.CHANGED
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
624
625
3009.2.22 by Aaron Bentley
Update names & docstring
626
class DiffText(DiffPath):
3009.2.2 by Aaron Bentley
Implement Differ object for abstracting diffing
627
3009.2.7 by Aaron Bentley
Move responsibility for generating diff labels into Differ.diff
628
    # GNU Patch uses the epoch date to detect files that are being added
629
    # or removed in a diff.
630
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
631
6524.5.5 by Paul Nixon
Added tests of configurable context
632
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8', 
633
                 old_label='', new_label='', text_differ=internal_diff, 
6524.5.8 by Paul Nixon
Changed "default_context_amount" to be "DEFAULT_CONTEXT_AMOUNT" to be
634
                 context_lines=DEFAULT_CONTEXT_AMOUNT):
3009.2.22 by Aaron Bentley
Update names & docstring
635
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
636
        self.text_differ = text_differ
637
        self.old_label = old_label
638
        self.new_label = new_label
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
639
        self.path_encoding = path_encoding
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
640
        self.context_lines = context_lines
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
641
642
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
3009.2.17 by Aaron Bentley
Update docs
643
        """Compare two files in unified diff format
644
645
        :param file_id: The file_id of the file to compare
646
        :param old_path: Path of the file in the old tree
647
        :param new_path: Path of the file in the new tree
648
        :param old_kind: Old file-kind of the file
649
        :param new_kind: New file-kind of the file
650
        """
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
651
        if 'file' not in (old_kind, new_kind):
3009.2.14 by Aaron Bentley
Update return type handling
652
            return self.CANNOT_DIFF
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
653
        from_file_id = to_file_id = file_id
654
        if old_kind == 'file':
655
            old_date = _patch_header_date(self.old_tree, file_id, old_path)
656
        elif old_kind is None:
657
            old_date = self.EPOCH_DATE
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
658
            from_file_id = None
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
659
        else:
3009.2.14 by Aaron Bentley
Update return type handling
660
            return self.CANNOT_DIFF
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
661
        if new_kind == 'file':
662
            new_date = _patch_header_date(self.new_tree, file_id, new_path)
663
        elif new_kind is None:
664
            new_date = self.EPOCH_DATE
665
            to_file_id = None
666
        else:
3009.2.14 by Aaron Bentley
Update return type handling
667
            return self.CANNOT_DIFF
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
668
        from_label = '%s%s\t%s' % (self.old_label, old_path,
669
                old_date)
670
        to_label = '%s%s\t%s' % (self.new_label, new_path,
671
                new_date)
6809.4.9 by Jelmer Vernooij
Fix some more tests.
672
        return self.diff_text(old_path, new_path, from_label, to_label,
673
            from_file_id, to_file_id)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
674
6809.4.9 by Jelmer Vernooij
Fix some more tests.
675
    def diff_text(self, from_path, to_path, from_label, to_label,
676
        from_file_id=None, to_file_id=None):
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
677
        """Diff the content of given files in two trees
678
6809.4.9 by Jelmer Vernooij
Fix some more tests.
679
        :param from_path: The path in the from tree. If None,
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
680
            the file is not present in the from tree.
6809.4.9 by Jelmer Vernooij
Fix some more tests.
681
        :param to_path: The path in the to tree. This may refer
682
            to a different file from from_path.  If None,
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
683
            the file is not present in the to tree.
6809.4.9 by Jelmer Vernooij
Fix some more tests.
684
        :param from_file_id: The id of the file in the from tree or None if
685
            unknown.
686
        :param to_file_id: The id of the file in the to tree or None if
687
            unknown.
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
688
        """
4377.3.3 by Ian Clatworthy
avoid unnecessary id2path calculation when diffing
689
        def _get_text(tree, file_id, path):
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
690
            if file_id is None:
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
691
                return []
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
692
            return tree.get_file_lines(path, file_id)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
693
        try:
4377.3.3 by Ian Clatworthy
avoid unnecessary id2path calculation when diffing
694
            from_text = _get_text(self.old_tree, from_file_id, from_path)
695
            to_text = _get_text(self.new_tree, to_file_id, to_path)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
696
            self.text_differ(from_label, from_text, to_label, to_text,
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
697
                             self.to_file, path_encoding=self.path_encoding,
698
                             context_lines=self.context_lines)
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
699
        except errors.BinaryFile:
700
            self.to_file.write(
701
                  ("Binary files %s and %s differ\n" %
6809.1.1 by Martin
Apply 2to3 ws_comma fixer
702
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
3009.2.14 by Aaron Bentley
Update return type handling
703
        return self.CHANGED
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
704
705
3123.6.2 by Aaron Bentley
Implement diff --using natively
706
class DiffFromTool(DiffPath):
707
708
    def __init__(self, command_template, old_tree, new_tree, to_file,
709
                 path_encoding='utf-8'):
710
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
711
        self.command_template = command_template
6681.2.4 by Jelmer Vernooij
More renames.
712
        self._root = osutils.mkdtemp(prefix='brz-diff-')
3123.6.2 by Aaron Bentley
Implement diff --using natively
713
714
    @classmethod
715
    def from_string(klass, command_string, old_tree, new_tree, to_file,
716
                    path_encoding='utf-8'):
4913.5.24 by Gordon Tyler
Added cmdline.split function, which replaces commands.shlex_split_unicode.
717
        command_template = cmdline.split(command_string)
4603.1.20 by Aaron Bentley
Use string.Template substitution with @ as delimiter.
718
        if '@' not in command_string:
719
            command_template.extend(['@old_path', '@new_path'])
3123.6.2 by Aaron Bentley
Implement diff --using natively
720
        return klass(command_template, old_tree, new_tree, to_file,
721
                     path_encoding)
722
723
    @classmethod
5349.1.4 by Matthäus G. Chajdas
Allow both --using and --diff-options.
724
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
3123.6.2 by Aaron Bentley
Implement diff --using natively
725
        def from_diff_tree(diff_tree):
5349.1.4 by Matthäus G. Chajdas
Allow both --using and --diff-options.
726
            full_command_string = [command_string]
727
            if external_diff_options is not None:
728
                full_command_string += ' ' + external_diff_options
729
            return klass.from_string(full_command_string, diff_tree.old_tree,
3123.6.2 by Aaron Bentley
Implement diff --using natively
730
                                     diff_tree.new_tree, diff_tree.to_file)
731
        return from_diff_tree
732
733
    def _get_command(self, old_path, new_path):
734
        my_map = {'old_path': old_path, 'new_path': new_path}
5074.5.1 by INADA Naoki
merge #523746 fix from lp:~songofacandy/bzr/fix-523746-2
735
        command = [AtTemplate(t).substitute(my_map) for t in
736
                   self.command_template]
4634.171.2 by INADA Naoki
Make temporary filename more friendly for non ascii filename.
737
        if sys.platform == 'win32': # Popen doesn't accept unicode on win32
738
            command_encoded = []
739
            for c in command:
6973.6.2 by Jelmer Vernooij
Fix more tests.
740
                if isinstance(c, text_type):
4634.171.2 by INADA Naoki
Make temporary filename more friendly for non ascii filename.
741
                    command_encoded.append(c.encode('mbcs'))
742
                else:
743
                    command_encoded.append(c)
744
            return command_encoded
745
        else:
746
            return command
3123.6.2 by Aaron Bentley
Implement diff --using natively
747
748
    def _execute(self, old_path, new_path):
3145.1.1 by Aaron Bentley
Handle missing tools gracefully in diff --using
749
        command = self._get_command(old_path, new_path)
750
        try:
751
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
752
                                    cwd=self._root)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
753
        except OSError as e:
3145.1.1 by Aaron Bentley
Handle missing tools gracefully in diff --using
754
            if e.errno == errno.ENOENT:
755
                raise errors.ExecutableMissing(command[0])
3145.1.2 by Aaron Bentley
Don't swallow other OSErrors
756
            else:
757
                raise
3123.6.2 by Aaron Bentley
Implement diff --using natively
758
        self.to_file.write(proc.stdout.read())
7027.4.11 by Jelmer Vernooij
Fix some tests that fail with -Werror.
759
        proc.stdout.close()
3123.6.2 by Aaron Bentley
Implement diff --using natively
760
        return proc.wait()
761
3123.6.5 by Aaron Bentley
Symlink to real files if possible
762
    def _try_symlink_root(self, tree, prefix):
3287.18.3 by Matt McClure
Toward a more acceptable patch for bug 209281.
763
        if (getattr(tree, 'abspath', None) is None
3287.18.14 by Matt McClure
Extracted a host_os_dereferences_symlinks method.
764
            or not osutils.host_os_dereferences_symlinks()):
3123.6.5 by Aaron Bentley
Symlink to real files if possible
765
            return False
766
        try:
767
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
768
        except OSError as e:
3123.6.5 by Aaron Bentley
Symlink to real files if possible
769
            if e.errno != errno.EEXIST:
770
                raise
771
        return True
772
5074.5.8 by INADA Naoki
Use tempfile when filepath in tree is not be able to encode with fsencoding.
773
    @staticmethod
774
    def _fenc():
5074.5.9 by INADA Naoki
Make additional comments to clarify
775
        """Returns safe encoding for passing file path to diff tool"""
5074.5.8 by INADA Naoki
Use tempfile when filepath in tree is not be able to encode with fsencoding.
776
        if sys.platform == 'win32':
777
            return 'mbcs'
778
        else:
779
            # Don't fallback to 'utf-8' because subprocess may not be able to
780
            # handle utf-8 correctly when locale is not utf-8.
781
            return sys.getfilesystemencoding() or 'ascii'
782
783
    def _is_safepath(self, path):
784
        """Return true if `path` may be able to pass to subprocess."""
785
        fenc = self._fenc()
786
        try:
787
            return path == path.encode(fenc).decode(fenc)
788
        except UnicodeError:
789
            return False
790
5074.5.7 by INADA Naoki
Test for filename encoding can't test subprocess execution because
791
    def _safe_filename(self, prefix, relpath):
5074.5.8 by INADA Naoki
Use tempfile when filepath in tree is not be able to encode with fsencoding.
792
        """Replace unsafe character in `relpath` then join `self._root`,
793
        `prefix` and `relpath`."""
794
        fenc = self._fenc()
4634.171.4 by INADA Naoki
Append comment for why decode() needed before replace().
795
        # encoded_str.replace('?', '_') may break multibyte char.
796
        # So we should encode, decode, then replace(u'?', u'_')
4634.171.2 by INADA Naoki
Make temporary filename more friendly for non ascii filename.
797
        relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
4634.171.3 by INADA Naoki
Fix easy miss.
798
        relpath_tmp = relpath_tmp.replace(u'?', u'_')
5074.5.7 by INADA Naoki
Test for filename encoding can't test subprocess execution because
799
        return osutils.pathjoin(self._root, prefix, relpath_tmp)
800
6809.4.15 by Jelmer Vernooij
Fix some more tests.
801
    def _write_file(self, relpath, tree, prefix, force_temp=False,
802
                    allow_write=False, file_id=None):
5074.5.7 by INADA Naoki
Test for filename encoding can't test subprocess execution because
803
        if not force_temp and isinstance(tree, WorkingTree):
6809.4.15 by Jelmer Vernooij
Fix some more tests.
804
            full_path = tree.abspath(relpath)
5074.5.8 by INADA Naoki
Use tempfile when filepath in tree is not be able to encode with fsencoding.
805
            if self._is_safepath(full_path):
806
                return full_path
5074.5.7 by INADA Naoki
Test for filename encoding can't test subprocess execution because
807
808
        full_path = self._safe_filename(prefix, relpath)
4603.1.4 by Aaron Bentley
Implement DiffFromTool.edit_file
809
        if not force_temp and self._try_symlink_root(tree, prefix):
3123.6.5 by Aaron Bentley
Symlink to real files if possible
810
            return full_path
3123.6.4 by Aaron Bentley
Set mtime (and atime) on files for --using
811
        parent_dir = osutils.dirname(full_path)
3123.6.2 by Aaron Bentley
Implement diff --using natively
812
        try:
813
            os.makedirs(parent_dir)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
814
        except OSError as e:
3123.6.2 by Aaron Bentley
Implement diff --using natively
815
            if e.errno != errno.EEXIST:
816
                raise
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
817
        source = tree.get_file(relpath, file_id)
3123.6.2 by Aaron Bentley
Implement diff --using natively
818
        try:
6855.4.5 by Jelmer Vernooij
Fix more bees, use with rather than try/finally for some files.
819
            with open(full_path, 'wb') as target:
3123.6.2 by Aaron Bentley
Implement diff --using natively
820
                osutils.pumpfile(source, target)
821
        finally:
822
            source.close()
4976.1.3 by Jelmer Vernooij
Cope with ghosts in 'bzr diff'
823
        try:
6809.4.5 by Jelmer Vernooij
Swap arguments for get_file_*.
824
            mtime = tree.get_file_mtime(relpath, file_id)
6731.1.1 by Jelmer Vernooij
Move FileTimestampUnavailable to breezy.tree.
825
        except FileTimestampUnavailable:
5151.3.2 by Martin
Don't try and warp files back to the 70s if no timestamp is available
826
            pass
827
        else:
828
            os.utime(full_path, (mtime, mtime))
5151.3.1 by Martin
Fix os.utime test failures, three on FAT filesystems and one with readonly files
829
        if not allow_write:
830
            osutils.make_readonly(full_path)
3123.6.4 by Aaron Bentley
Set mtime (and atime) on files for --using
831
        return full_path
3123.6.2 by Aaron Bentley
Implement diff --using natively
832
6809.4.15 by Jelmer Vernooij
Fix some more tests.
833
    def _prepare_files(self, old_path, new_path, force_temp=False,
834
                       allow_write_new=False, file_id=None):
835
        old_disk_path = self._write_file(old_path, self.old_tree, 'old',
836
                                         force_temp, file_id=file_id)
837
        new_disk_path = self._write_file(new_path, self.new_tree, 'new',
838
                                         force_temp, file_id=file_id,
4603.1.4 by Aaron Bentley
Implement DiffFromTool.edit_file
839
                                         allow_write=allow_write_new)
3123.6.2 by Aaron Bentley
Implement diff --using natively
840
        return old_disk_path, new_disk_path
841
842
    def finish(self):
4354.6.1 by Martitza Mendez
Fix 363837 : catch OSError from osutils.rmtree and mutter to trace file.
843
        try:
844
            osutils.rmtree(self._root)
6619.3.2 by Jelmer Vernooij
Apply 2to3 except fix.
845
        except OSError as e:
4354.6.1 by Martitza Mendez
Fix 363837 : catch OSError from osutils.rmtree and mutter to trace file.
846
            if e.errno != errno.ENOENT:
4399.1.1 by Ian Clatworthy
(igc) address temp file issue with diff --using on Windows (Martitza Mendez)
847
                mutter("The temporary directory \"%s\" was not "
848
                        "cleanly removed: %s." % (self._root, e))
3123.6.2 by Aaron Bentley
Implement diff --using natively
849
850
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
851
        if (old_kind, new_kind) != ('file', 'file'):
852
            return DiffPath.CANNOT_DIFF
4845.2.1 by Gary van der Merwe
When launching an external diff app, don't write temporary files for a working tree.
853
        (old_disk_path, new_disk_path) = self._prepare_files(
6809.4.15 by Jelmer Vernooij
Fix some more tests.
854
                old_path, new_path, file_id=file_id)
4845.2.1 by Gary van der Merwe
When launching an external diff app, don't write temporary files for a working tree.
855
        self._execute(old_disk_path, new_disk_path)
4603.1.1 by Aaron Bentley
Initial pass at shelve-via-editor.
856
6809.4.20 by Jelmer Vernooij
Fix tests.
857
    def edit_file(self, old_path, new_path, file_id=None):
4603.1.4 by Aaron Bentley
Implement DiffFromTool.edit_file
858
        """Use this tool to edit a file.
859
860
        A temporary copy will be edited, and the new contents will be
861
        returned.
862
863
        :param file_id: The id of the file to edit.
864
        :return: The new contents of the file.
865
        """
5074.5.1 by INADA Naoki
merge #523746 fix from lp:~songofacandy/bzr/fix-523746-2
866
        old_abs_path, new_abs_path = self._prepare_files(
6809.4.20 by Jelmer Vernooij
Fix tests.
867
                old_path, new_path, allow_write_new=True, force_temp=True,
868
                file_id=file_id)
5074.5.1 by INADA Naoki
merge #523746 fix from lp:~songofacandy/bzr/fix-523746-2
869
        command = self._get_command(old_abs_path, new_abs_path)
4603.1.24 by Aaron Bentley
Fix call import/invocation.
870
        subprocess.call(command, cwd=self._root)
6855.4.5 by Jelmer Vernooij
Fix more bees, use with rather than try/finally for some files.
871
        with open(new_abs_path, 'rb') as new_file:
4603.1.4 by Aaron Bentley
Implement DiffFromTool.edit_file
872
            return new_file.read()
873
3123.6.2 by Aaron Bentley
Implement diff --using natively
874
3009.2.22 by Aaron Bentley
Update names & docstring
875
class DiffTree(object):
876
    """Provides textual representations of the difference between two trees.
877
878
    A DiffTree examines two trees and where a file-id has altered
879
    between them, generates a textual representation of the difference.
880
    DiffTree uses a sequence of DiffPath objects which are each
881
    given the opportunity to handle a given altered fileid. The list
882
    of DiffPath objects can be extended globally by appending to
883
    DiffTree.diff_factories, or for a specific diff operation by
3009.2.27 by Aaron Bentley
Use extra_factories instead of extra_diffs
884
    supplying the extra_factories option to the appropriate method.
3009.2.22 by Aaron Bentley
Update names & docstring
885
    """
886
887
    # list of factories that can provide instances of DiffPath objects
3009.2.17 by Aaron Bentley
Update docs
888
    # may be extended by plugins.
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
889
    diff_factories = [DiffSymlink.from_diff_tree,
890
                      DiffDirectory.from_diff_tree]
3009.2.13 by Aaron Bentley
Refactor differ to support registering differ factories
891
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
892
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
893
                 diff_text=None, extra_factories=None):
3009.2.17 by Aaron Bentley
Update docs
894
        """Constructor
895
896
        :param old_tree: Tree to show as old in the comparison
897
        :param new_tree: Tree to show as new in the comparison
898
        :param to_file: File to write comparision to
899
        :param path_encoding: Character encoding to write paths in
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
900
        :param diff_text: DiffPath-type object to use as a last resort for
3009.2.17 by Aaron Bentley
Update docs
901
            diffing text files.
3009.2.27 by Aaron Bentley
Use extra_factories instead of extra_diffs
902
        :param extra_factories: Factories of DiffPaths to try before any other
903
            DiffPaths"""
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
904
        if diff_text is None:
905
            diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
906
                                 '', '',  internal_diff)
3009.2.4 by Aaron Bentley
Make old_tree/new_tree construction parameters of Differ
907
        self.old_tree = old_tree
908
        self.new_tree = new_tree
3009.2.2 by Aaron Bentley
Implement Differ object for abstracting diffing
909
        self.to_file = to_file
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
910
        self.path_encoding = path_encoding
3009.2.13 by Aaron Bentley
Refactor differ to support registering differ factories
911
        self.differs = []
3009.2.27 by Aaron Bentley
Use extra_factories instead of extra_diffs
912
        if extra_factories is not None:
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
913
            self.differs.extend(f(self) for f in extra_factories)
914
        self.differs.extend(f(self) for f in self.diff_factories)
915
        self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
916
917
    @classmethod
918
    def from_trees_options(klass, old_tree, new_tree, to_file,
3009.2.17 by Aaron Bentley
Update docs
919
                           path_encoding, external_diff_options, old_label,
6524.5.4 by Paul Nixon
Clearing up default context options
920
                           new_label, using, context_lines):
3009.2.22 by Aaron Bentley
Update names & docstring
921
        """Factory for producing a DiffTree.
3009.2.17 by Aaron Bentley
Update docs
922
923
        Designed to accept options used by show_diff_trees.
5891.1.3 by Andrew Bennetts
Move docstring formatting fixes.
924
3009.2.17 by Aaron Bentley
Update docs
925
        :param old_tree: The tree to show as old in the comparison
926
        :param new_tree: The tree to show as new in the comparison
927
        :param to_file: File to write comparisons to
928
        :param path_encoding: Character encoding to use for writing paths
929
        :param external_diff_options: If supplied, use the installed diff
930
            binary to perform file comparison, using supplied options.
931
        :param old_label: Prefix to use for old file labels
932
        :param new_label: Prefix to use for new file labels
3123.6.2 by Aaron Bentley
Implement diff --using natively
933
        :param using: Commandline to use to invoke an external diff tool
3009.2.17 by Aaron Bentley
Update docs
934
        """
3123.6.2 by Aaron Bentley
Implement diff --using natively
935
        if using is not None:
5349.1.4 by Matthäus G. Chajdas
Allow both --using and --diff-options.
936
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
3123.6.2 by Aaron Bentley
Implement diff --using natively
937
        else:
938
            extra_factories = []
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
939
        if external_diff_options:
940
            opts = external_diff_options.split()
6524.5.5 by Paul Nixon
Added tests of configurable context
941
            def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None, context_lines=None):
4797.57.2 by Alexander Belchenko
fixing test with external_diff
942
                """:param path_encoding: not used but required
943
                        to match the signature of internal_diff.
944
                """
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
945
                external_diff(olab, olines, nlab, nlines, to_file, opts)
946
        else:
947
            diff_file = internal_diff
3009.2.28 by Aaron Bentley
Add from_diff_tree factories
948
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
6524.5.1 by pauljnixon at gmail
Made diffs more configurable
949
                             old_label, new_label, diff_file, context_lines=context_lines)
3123.6.2 by Aaron Bentley
Implement diff --using natively
950
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
951
                     extra_factories)
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
952
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
953
    def show_diff(self, specific_files, extra_trees=None):
3009.2.17 by Aaron Bentley
Update docs
954
        """Write tree diff to self.to_file
955
5131.1.4 by Jelmer Vernooij
Add test for custom diff format.
956
        :param specific_files: the specific files to compare (recursive)
3009.2.17 by Aaron Bentley
Update docs
957
        :param extra_trees: extra trees to use for mapping paths to file_ids
958
        """
3123.6.2 by Aaron Bentley
Implement diff --using natively
959
        try:
960
            return self._show_diff(specific_files, extra_trees)
961
        finally:
962
            for differ in self.differs:
963
                differ.finish()
964
965
    def _show_diff(self, specific_files, extra_trees):
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
966
        # TODO: Generation of pseudo-diffs for added/deleted files could
967
        # be usefully made into a much faster special case.
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
968
        iterator = self.new_tree.iter_changes(self.old_tree,
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
969
                                               specific_files=specific_files,
970
                                               extra_trees=extra_trees,
971
                                               require_versioned=True)
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
972
        has_changes = 0
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
973
        def changes_key(change):
974
            old_path, new_path = change[1]
975
            path = new_path
976
            if path is None:
977
                path = old_path
978
            return path
979
        def get_encoded_path(path):
980
            if path is not None:
981
                return path.encode(self.path_encoding, "replace")
982
        for (file_id, paths, changed_content, versioned, parent, name, kind,
983
             executable) in sorted(iterator, key=changes_key):
3619.4.2 by Robert Collins
Change bzrlib.diff.DiffTree.show_diff to skip entries missing in both trees.
984
            # The root does not get diffed, and items with no known kind (that
985
            # is, missing) in both trees are skipped as well.
986
            if parent == (None, None) or kind == (None, None):
3123.4.3 by Aaron Bentley
Tweak path handling
987
                continue
988
            oldpath, newpath = paths
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
989
            oldpath_encoded = get_encoded_path(paths[0])
990
            newpath_encoded = get_encoded_path(paths[1])
991
            old_present = (kind[0] is not None and versioned[0])
992
            new_present = (kind[1] is not None and versioned[1])
993
            renamed = (parent[0], name[0]) != (parent[1], name[1])
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
994
995
            properties_changed = []
996
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
997
998
            if properties_changed:
6973.11.9 by Jelmer Vernooij
Fix tests.
999
                prop_str = b" (properties changed: %s)" % (
1000
                        b", ".join(properties_changed),)
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
1001
            else:
6973.10.1 by Jelmer Vernooij
Fix some tests.
1002
                prop_str = b""
3268.1.1 by C Miller
Describe the property changes in diffs. Currently, this is the executable-bit
1003
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
1004
            if (old_present, new_present) == (True, False):
6973.10.1 by Jelmer Vernooij
Fix some tests.
1005
                self.to_file.write(b"=== removed %s '%s'\n" %
1006
                                   (kind[0].encode('ascii'), oldpath_encoded))
3123.4.3 by Aaron Bentley
Tweak path handling
1007
                newpath = oldpath
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
1008
            elif (old_present, new_present) == (False, True):
6973.10.1 by Jelmer Vernooij
Fix some tests.
1009
                self.to_file.write(b"=== added %s '%s'\n" %
1010
                                   (kind[1].encode('ascii'), newpath_encoded))
3123.4.3 by Aaron Bentley
Tweak path handling
1011
                oldpath = newpath
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
1012
            elif renamed:
6973.10.1 by Jelmer Vernooij
Fix some tests.
1013
                self.to_file.write(b"=== renamed %s '%s' => '%s'%s\n" %
1014
                    (kind[0].encode('ascii'), oldpath_encoded, newpath_encoded, prop_str))
3123.4.2 by Aaron Bentley
Handle diff with property change correctly
1015
            else:
3254.1.1 by Aaron Bentley
Make Tree.iter_changes a public method
1016
                # if it was produced by iter_changes, it must be
3123.4.2 by Aaron Bentley
Handle diff with property change correctly
1017
                # modified *somehow*, either content or execute bit.
6973.10.1 by Jelmer Vernooij
Fix some tests.
1018
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
1019
                                   newpath_encoded, prop_str))
1020
            if changed_content:
6809.4.15 by Jelmer Vernooij
Fix some more tests.
1021
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
3123.4.1 by Aaron Bentley
Diff sorts files in alphabetical order
1022
                has_changes = 1
1023
            if renamed:
1024
                has_changes = 1
3009.2.6 by Aaron Bentley
Convert show_diff_trees into a Differ method
1025
        return has_changes
3009.2.2 by Aaron Bentley
Implement Differ object for abstracting diffing
1026
3009.2.12 by Aaron Bentley
Associate labels with text diffing only
1027
    def diff(self, file_id, old_path, new_path):
3009.2.17 by Aaron Bentley
Update docs
1028
        """Perform a diff of a single file
1029
1030
        :param file_id: file-id of the file
1031
        :param old_path: The path of the file in the old tree
1032
        :param new_path: The path of the file in the new tree
1033
        """
6809.4.11 by Jelmer Vernooij
Fix diff tests.
1034
        if old_path is None:
1035
            old_kind = None
1036
        else:
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
1037
            old_kind = self.old_tree.kind(old_path, file_id)
6809.4.11 by Jelmer Vernooij
Fix diff tests.
1038
        if new_path is None:
1039
            new_kind = None
1040
        else:
6809.4.7 by Jelmer Vernooij
Swap arguments for get_symlink_target and kind/stored_kind.
1041
            new_kind = self.new_tree.kind(new_path, file_id)
6809.4.15 by Jelmer Vernooij
Fix some more tests.
1042
        self._diff(old_path, new_path, old_kind, new_kind, file_id=file_id)
4377.3.1 by Ian Clatworthy
faster diff on large trees
1043
6809.4.15 by Jelmer Vernooij
Fix some more tests.
1044
    def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
3009.2.22 by Aaron Bentley
Update names & docstring
1045
        result = DiffPath._diff_many(self.differs, file_id, old_path,
7031.1.1 by Jelmer Vernooij
Fix breezy.tests.test_diff.
1046
                                     new_path, old_kind, new_kind)
3009.2.22 by Aaron Bentley
Update names & docstring
1047
        if result is DiffPath.CANNOT_DIFF:
3009.2.11 by Aaron Bentley
Refactor diff to be more pluggable
1048
            error_path = new_path
1049
            if error_path is None:
1050
                error_path = old_path
3009.2.22 by Aaron Bentley
Update names & docstring
1051
            raise errors.NoDiffFound(error_path)
5131.1.1 by Jelmer Vernooij
Add --format option to 'bzr diff'.
1052
1053
1054
format_registry = Registry()
1055
format_registry.register('default', DiffTree)