/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/diff.py

  • Committer: John Arbash Meinel
  • Author(s): Mark Hammond
  • Date: 2008-09-09 17:02:21 UTC
  • mto: This revision was merged to the branch mainline in revision 3697.
  • Revision ID: john@arbash-meinel.com-20080909170221-svim3jw2mrz0amp3
An updated transparent icon for bzr.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2005-2014 Canonical Ltd.
 
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
2
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
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
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18
16
 
19
17
import difflib
20
18
import os
21
19
import re
22
 
import string
 
20
import shutil
23
21
import sys
24
22
 
25
 
from .lazy_import import lazy_import
 
23
from bzrlib.lazy_import import lazy_import
26
24
lazy_import(globals(), """
27
25
import errno
28
26
import subprocess
29
27
import tempfile
 
28
import time
30
29
 
31
 
from breezy import (
32
 
    cleanup,
33
 
    cmdline,
34
 
    controldir,
 
30
from bzrlib import (
 
31
    branch as _mod_branch,
 
32
    bzrdir,
 
33
    commands,
35
34
    errors,
36
35
    osutils,
37
36
    patiencediff,
38
37
    textfile,
39
38
    timestamp,
40
 
    views,
41
39
    )
42
 
 
43
 
from breezy.workingtree import WorkingTree
44
 
from breezy.i18n import gettext
45
40
""")
46
41
 
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 = '@'
 
42
from bzrlib.symbol_versioning import (
 
43
        deprecated_function,
 
44
        one_three
 
45
        )
 
46
from bzrlib.trace import mutter, warning
60
47
 
61
48
 
62
49
# TODO: Rather than building a changeset object, we should probably
75
62
 
76
63
def internal_diff(old_filename, oldlines, new_filename, newlines, to_file,
77
64
                  allow_binary=False, sequence_matcher=None,
78
 
                  path_encoding='utf8', context_lines=DEFAULT_CONTEXT_AMOUNT):
 
65
                  path_encoding='utf8'):
79
66
    # FIXME: difflib is wrong if there is no trailing newline.
80
67
    # The syntax used by patch seems to be "\ No newline at
81
68
    # end of file" following the last diff line from that
86
73
    # In the meantime we at least make sure the patch isn't
87
74
    # mangled.
88
75
 
 
76
 
 
77
    # Special workaround for Python2.3, where difflib fails if
 
78
    # both sequences are empty.
 
79
    if not oldlines and not newlines:
 
80
        return
 
81
    
89
82
    if allow_binary is False:
90
83
        textfile.check_text_lines(oldlines)
91
84
        textfile.check_text_lines(newlines)
93
86
    if sequence_matcher is None:
94
87
        sequence_matcher = patiencediff.PatienceSequenceMatcher
95
88
    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)
 
89
                      fromfile=old_filename.encode(path_encoding),
 
90
                      tofile=new_filename.encode(path_encoding),
 
91
                      sequencematcher=sequence_matcher)
99
92
 
100
93
    ud = list(ud)
101
94
    if len(ud) == 0: # Identical contents, nothing to do
106
99
        ud[2] = ud[2].replace('-1,0', '-0,0')
107
100
    elif not newlines:
108
101
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
102
    # work around for difflib emitting random spaces after the label
 
103
    ud[0] = ud[0][:-2] + '\n'
 
104
    ud[1] = ud[1][:-2] + '\n'
109
105
 
110
106
    for line in ud:
111
107
        to_file.write(line)
115
111
 
116
112
 
117
113
def _spawn_external_diff(diffcmd, capture_errors=True):
118
 
    """Spawn the external diff process, and return the child handle.
 
114
    """Spawn the externall diff process, and return the child handle.
119
115
 
120
116
    :param diffcmd: The command list to spawn
121
117
    :param capture_errors: Capture stderr as well as setting LANG=C
143
139
                                stdout=subprocess.PIPE,
144
140
                                stderr=stderr,
145
141
                                env=env)
146
 
    except OSError as e:
 
142
    except OSError, e:
147
143
        if e.errno == errno.ENOENT:
148
144
            raise errors.NoDiff(str(e))
149
145
        raise
150
146
 
151
147
    return pipe
152
148
 
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
186
 
 
187
149
 
188
150
def external_diff(old_filename, oldlines, new_filename, newlines, to_file,
189
151
                  diff_opts):
191
153
    # make sure our own output is properly ordered before the diff
192
154
    to_file.flush()
193
155
 
194
 
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='brz-diff-old-')
195
 
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='brz-diff-new-')
 
156
    oldtmp_fd, old_abspath = tempfile.mkstemp(prefix='bzr-diff-old-')
 
157
    newtmp_fd, new_abspath = tempfile.mkstemp(prefix='bzr-diff-new-')
196
158
    oldtmpf = os.fdopen(oldtmp_fd, 'wb')
197
159
    newtmpf = os.fdopen(newtmp_fd, 'wb')
198
160
 
212
174
 
213
175
        if not diff_opts:
214
176
            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
177
        diffcmd = ['diff',
221
178
                   '--label', old_filename,
222
179
                   old_abspath,
225
182
                   '--binary',
226
183
                  ]
227
184
 
228
 
        diff_opts = default_style_unified(diff_opts)
229
 
 
 
185
        # diff only allows one style to be specified; they don't override.
 
186
        # note that some of these take optargs, and the optargs can be
 
187
        # directly appended to the options.
 
188
        # this is only an approximate parser; it doesn't properly understand
 
189
        # the grammar.
 
190
        for s in ['-c', '-u', '-C', '-U',
 
191
                  '-e', '--ed',
 
192
                  '-q', '--brief',
 
193
                  '--normal',
 
194
                  '-n', '--rcs',
 
195
                  '-y', '--side-by-side',
 
196
                  '-D', '--ifdef']:
 
197
            for j in diff_opts:
 
198
                if j.startswith(s):
 
199
                    break
 
200
            else:
 
201
                continue
 
202
            break
 
203
        else:
 
204
            diffcmd.append('-u')
 
205
                  
230
206
        if diff_opts:
231
207
            diffcmd.extend(diff_opts)
232
208
 
233
209
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
234
 
        out, err = pipe.communicate()
 
210
        out,err = pipe.communicate()
235
211
        rc = pipe.returncode
236
 
 
 
212
        
237
213
        # internal_diff() adds a trailing newline, add one here for consistency
238
214
        out += '\n'
239
215
        if rc == 2:
274
250
                msg = 'signal %d' % (-rc)
275
251
            else:
276
252
                msg = 'exit code %d' % rc
277
 
 
278
 
            raise errors.BzrError('external diff failed with %s; command: %r'
279
 
                                  % (msg, diffcmd))
 
253
                
 
254
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
255
                                  % (rc, diffcmd))
280
256
 
281
257
 
282
258
    finally:
283
259
        oldtmpf.close()                 # and delete
284
260
        newtmpf.close()
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)
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):
 
261
        # Clean up. Warn in case the files couldn't be deleted
 
262
        # (in case windows still holds the file open, but not
 
263
        # if the files have already been deleted)
 
264
        try:
 
265
            os.remove(old_abspath)
 
266
        except OSError, e:
 
267
            if e.errno not in (errno.ENOENT,):
 
268
                warning('Failed to delete temporary file: %s %s',
 
269
                        old_abspath, e)
 
270
        try:
 
271
            os.remove(new_abspath)
 
272
        except OSError:
 
273
            if e.errno not in (errno.ENOENT,):
 
274
                warning('Failed to delete temporary file: %s %s',
 
275
                        new_abspath, e)
 
276
 
 
277
 
 
278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
302
279
    """Get the trees and specific files to diff given a list of paths.
303
280
 
304
281
    This method works out the trees to be diff'ed and the files of
315
292
    :param new_url:
316
293
        The url of the new branch or tree. If None, the tree to use is
317
294
        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
295
    :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.
 
296
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
 
297
        extra_trees is a sequence of additional trees to search in for
 
298
        file-ids.
330
299
    """
331
300
    # Get the old and new revision specs
332
301
    old_revision_spec = None
355
324
        default_location = path_list[0]
356
325
        other_paths = path_list[1:]
357
326
 
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
327
    # Get the old location
367
328
    specific_files = []
368
329
    if old_url is None:
369
330
        old_url = default_location
370
331
    working_tree, branch, relpath = \
371
 
        controldir.ControlDir.open_containing_tree_or_branch(old_url)
372
 
    lock_tree_or_branch(working_tree, branch)
 
332
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
373
333
    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
334
        specific_files.append(relpath)
377
335
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
378
 
    old_branch = branch
379
336
 
380
337
    # Get the new location
381
338
    if new_url is None:
382
339
        new_url = default_location
383
340
    if new_url != old_url:
384
341
        working_tree, branch, relpath = \
385
 
            controldir.ControlDir.open_containing_tree_or_branch(new_url)
386
 
        lock_tree_or_branch(working_tree, branch)
 
342
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
387
343
        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
344
            specific_files.append(relpath)
391
345
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
392
346
        basis_is_default=working_tree is None)
393
 
    new_branch = branch
394
347
 
395
348
    # Get the specific files (all files is None, no files is [])
396
349
    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)
 
350
        other_paths = _relative_paths_in_tree(working_tree, other_paths)
400
351
    specific_files.extend(other_paths)
401
352
    if len(specific_files) == 0:
402
353
        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
354
 
411
355
    # Get extra trees that ought to be searched for file-ids
412
356
    extra_trees = None
413
357
    if working_tree is not None and working_tree not in (old_tree, new_tree):
414
358
        extra_trees = (working_tree,)
415
 
    return (old_tree, new_tree, old_branch, new_branch,
416
 
            specific_files, extra_trees)
 
359
    return old_tree, new_tree, specific_files, extra_trees
417
360
 
418
361
 
419
362
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
427
370
                return branch.basis_tree()
428
371
        else:
429
372
            return tree
430
 
    return spec.as_tree(branch)
 
373
    if not spec.needs_branch():
 
374
        branch = _mod_branch.Branch.open(spec.get_branch())
 
375
    revision_id = spec.as_revision_id(branch)
 
376
    return branch.repository.revision_tree(revision_id)
 
377
 
 
378
 
 
379
def _relative_paths_in_tree(tree, paths):
 
380
    """Get the relative paths within a working tree.
 
381
 
 
382
    Each path may be either an absolute path or a path relative to the
 
383
    current working directory.
 
384
    """
 
385
    result = []
 
386
    for filename in paths:
 
387
        try:
 
388
            result.append(tree.relpath(osutils.dereference_path(filename)))
 
389
        except errors.PathNotChild:
 
390
            raise errors.BzrCommandError("Files are in different branches")
 
391
    return result
431
392
 
432
393
 
433
394
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
435
396
                    old_label='a/', new_label='b/',
436
397
                    extra_trees=None,
437
398
                    path_encoding='utf8',
438
 
                    using=None,
439
 
                    format_cls=None,
440
 
                    context=DEFAULT_CONTEXT_AMOUNT):
 
399
                    using=None):
441
400
    """Show in text form the changes from one tree to another.
442
401
 
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)
 
402
    to_file
 
403
        The output stream.
 
404
 
 
405
    specific_files
 
406
        Include only changes to these files - None for all changes.
 
407
 
 
408
    external_diff_options
 
409
        If set, use an external GNU diff and pass these options.
 
410
 
 
411
    extra_trees
 
412
        If set, more Trees to use for looking up file ids
 
413
 
 
414
    path_encoding
 
415
        If set, the path will be encoded as specified, otherwise is supposed
 
416
        to be utf8
452
417
    """
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():
 
418
    old_tree.lock_read()
 
419
    try:
458
420
        if extra_trees is not None:
459
421
            for tree in extra_trees:
460
422
                tree.lock_read()
461
423
        new_tree.lock_read()
462
424
        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)
 
425
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
 
426
                                                 path_encoding,
 
427
                                                 external_diff_options,
 
428
                                                 old_label, new_label, using)
468
429
            return differ.show_diff(specific_files, extra_trees)
469
430
        finally:
470
431
            new_tree.unlock()
471
432
            if extra_trees is not None:
472
433
                for tree in extra_trees:
473
434
                    tree.unlock()
 
435
    finally:
 
436
        old_tree.unlock()
474
437
 
475
438
 
476
439
def _patch_header_date(tree, file_id, path):
477
440
    """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
 
441
    mtime = tree.get_file_mtime(file_id, path)
482
442
    return timestamp.format_patch_date(mtime)
483
443
 
484
444
 
 
445
def _raise_if_nonexistent(paths, old_tree, new_tree):
 
446
    """Complain if paths are not in either inventory or tree.
 
447
 
 
448
    It's OK with the files exist in either tree's inventory, or 
 
449
    if they exist in the tree but are not versioned.
 
450
    
 
451
    This can be used by operations such as bzr status that can accept
 
452
    unknown or ignored files.
 
453
    """
 
454
    mutter("check paths: %r", paths)
 
455
    if not paths:
 
456
        return
 
457
    s = old_tree.filter_unversioned_files(paths)
 
458
    s = new_tree.filter_unversioned_files(s)
 
459
    s = [path for path in s if not new_tree.has_filename(path)]
 
460
    if s:
 
461
        raise errors.PathsDoNotExist(sorted(s))
 
462
 
 
463
 
 
464
@deprecated_function(one_three)
 
465
def get_prop_change(meta_modified):
 
466
    if meta_modified:
 
467
        return " (properties changed)"
 
468
    else:
 
469
        return  ""
 
470
 
485
471
def get_executable_change(old_is_x, new_is_x):
486
472
    descr = { True:"+x", False:"-x", None:"??" }
487
473
    if old_is_x != new_is_x:
596
582
        if 'symlink' not in (old_kind, new_kind):
597
583
            return self.CANNOT_DIFF
598
584
        if old_kind == 'symlink':
599
 
            old_target = self.old_tree.get_symlink_target(old_path, file_id)
 
585
            old_target = self.old_tree.get_symlink_target(file_id)
600
586
        elif old_kind is None:
601
587
            old_target = None
602
588
        else:
603
589
            return self.CANNOT_DIFF
604
590
        if new_kind == 'symlink':
605
 
            new_target = self.new_tree.get_symlink_target(new_path, file_id)
 
591
            new_target = self.new_tree.get_symlink_target(file_id)
606
592
        elif new_kind is None:
607
593
            new_target = None
608
594
        else:
626
612
    # or removed in a diff.
627
613
    EPOCH_DATE = '1970-01-01 00:00:00 +0000'
628
614
 
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):
 
615
    def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
 
616
                 old_label='', new_label='', text_differ=internal_diff):
632
617
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
633
618
        self.text_differ = text_differ
634
619
        self.old_label = old_label
635
620
        self.new_label = new_label
636
621
        self.path_encoding = path_encoding
637
 
        self.context_lines = context_lines
638
622
 
639
623
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
640
624
        """Compare two files in unified diff format
664
648
            return self.CANNOT_DIFF
665
649
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
666
650
        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)
 
651
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
669
652
 
670
 
    def diff_text(self, from_path, to_path, from_label, to_label,
671
 
        from_file_id=None, to_file_id=None):
 
653
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
672
654
        """Diff the content of given files in two trees
673
655
 
674
 
        :param from_path: The path in the from tree. If None,
 
656
        :param from_file_id: The id of the file in the from tree.  If None,
675
657
            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,
 
658
        :param to_file_id: The id of the file in the to tree.  This may refer
 
659
            to a different file from from_file_id.  If None,
678
660
            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
661
        """
684
 
        def _get_text(tree, file_id, path):
685
 
            if file_id is None:
 
662
        def _get_text(tree, file_id):
 
663
            if file_id is not None:
 
664
                return tree.get_file(file_id).readlines()
 
665
            else:
686
666
                return []
687
 
            return tree.get_file_lines(path, file_id)
688
667
        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)
 
668
            from_text = _get_text(self.old_tree, from_file_id)
 
669
            to_text = _get_text(self.new_tree, to_file_id)
691
670
            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)
 
671
                             self.to_file)
694
672
        except errors.BinaryFile:
695
673
            self.to_file.write(
696
674
                  ("Binary files %s and %s differ\n" %
697
 
                  (from_label, to_label)).encode(self.path_encoding, 'replace'))
 
675
                  (from_label, to_label)).encode(self.path_encoding))
698
676
        return self.CHANGED
699
677
 
700
678
 
704
682
                 path_encoding='utf-8'):
705
683
        DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
706
684
        self.command_template = command_template
707
 
        self._root = osutils.mkdtemp(prefix='brz-diff-')
 
685
        self._root = osutils.mkdtemp(prefix='bzr-diff-')
708
686
 
709
687
    @classmethod
710
688
    def from_string(klass, command_string, old_tree, new_tree, to_file,
711
689
                    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'])
 
690
        command_template = commands.shlex_split_unicode(command_string)
 
691
        command_template.extend(['%(old_path)s', '%(new_path)s'])
715
692
        return klass(command_template, old_tree, new_tree, to_file,
716
693
                     path_encoding)
717
694
 
718
695
    @classmethod
719
 
    def make_from_diff_tree(klass, command_string, external_diff_options=None):
 
696
    def make_from_diff_tree(klass, command_string):
720
697
        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,
 
698
            return klass.from_string(command_string, diff_tree.old_tree,
725
699
                                     diff_tree.new_tree, diff_tree.to_file)
726
700
        return from_diff_tree
727
701
 
728
702
    def _get_command(self, old_path, new_path):
729
703
        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
 
704
        return [t % my_map for t in self.command_template]
742
705
 
743
706
    def _execute(self, old_path, new_path):
744
707
        command = self._get_command(old_path, new_path)
745
708
        try:
746
709
            proc = subprocess.Popen(command, stdout=subprocess.PIPE,
747
710
                                    cwd=self._root)
748
 
        except OSError as e:
 
711
        except OSError, e:
749
712
            if e.errno == errno.ENOENT:
750
713
                raise errors.ExecutableMissing(command[0])
751
714
            else:
759
722
            return False
760
723
        try:
761
724
            os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
762
 
        except OSError as e:
 
725
        except OSError, e:
763
726
            if e.errno != errno.EEXIST:
764
727
                raise
765
728
        return True
766
729
 
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):
 
730
    def _write_file(self, file_id, tree, prefix, relpath):
 
731
        full_path = osutils.pathjoin(self._root, prefix, relpath)
 
732
        if self._try_symlink_root(tree, prefix):
804
733
            return full_path
805
734
        parent_dir = osutils.dirname(full_path)
806
735
        try:
807
736
            os.makedirs(parent_dir)
808
 
        except OSError as e:
 
737
        except OSError, e:
809
738
            if e.errno != errno.EEXIST:
810
739
                raise
811
 
        source = tree.get_file(relpath, file_id)
 
740
        source = tree.get_file(file_id, relpath)
812
741
        try:
813
 
            with open(full_path, 'wb') as target:
 
742
            target = open(full_path, 'wb')
 
743
            try:
814
744
                osutils.pumpfile(source, target)
 
745
            finally:
 
746
                target.close()
815
747
        finally:
816
748
            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)
 
749
        osutils.make_readonly(full_path)
 
750
        mtime = tree.get_file_mtime(file_id)
 
751
        os.utime(full_path, (mtime, mtime))
825
752
        return full_path
826
753
 
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)
 
754
    def _prepare_files(self, file_id, old_path, new_path):
 
755
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
 
756
                                         old_path)
 
757
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
 
758
                                         new_path)
834
759
        return old_disk_path, new_disk_path
835
760
 
836
761
    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))
 
762
        osutils.rmtree(self._root)
843
763
 
844
764
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
845
765
        if (old_kind, new_kind) != ('file', 'file'):
846
766
            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()
 
767
        self._prepare_files(file_id, old_path, new_path)
 
768
        self._execute(osutils.pathjoin('old', old_path),
 
769
                      osutils.pathjoin('new', new_path))
867
770
 
868
771
 
869
772
class DiffTree(object):
911
814
    @classmethod
912
815
    def from_trees_options(klass, old_tree, new_tree, to_file,
913
816
                           path_encoding, external_diff_options, old_label,
914
 
                           new_label, using, context_lines):
 
817
                           new_label, using):
915
818
        """Factory for producing a DiffTree.
916
819
 
917
820
        Designed to accept options used by show_diff_trees.
918
 
 
919
821
        :param old_tree: The tree to show as old in the comparison
920
822
        :param new_tree: The tree to show as new in the comparison
921
823
        :param to_file: File to write comparisons to
927
829
        :param using: Commandline to use to invoke an external diff tool
928
830
        """
929
831
        if using is not None:
930
 
            extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
 
832
            extra_factories = [DiffFromTool.make_from_diff_tree(using)]
931
833
        else:
932
834
            extra_factories = []
933
835
        if external_diff_options:
934
836
            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
 
                """
 
837
            def diff_file(olab, olines, nlab, nlines, to_file):
939
838
                external_diff(olab, olines, nlab, nlines, to_file, opts)
940
839
        else:
941
840
            diff_file = internal_diff
942
841
        diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
943
 
                             old_label, new_label, diff_file, context_lines=context_lines)
 
842
                             old_label, new_label, diff_file)
944
843
        return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
945
844
                     extra_factories)
946
845
 
947
846
    def show_diff(self, specific_files, extra_trees=None):
948
847
        """Write tree diff to self.to_file
949
848
 
950
 
        :param specific_files: the specific files to compare (recursive)
 
849
        :param sepecific_files: the specific files to compare (recursive)
951
850
        :param extra_trees: extra trees to use for mapping paths to file_ids
952
851
        """
953
852
        try:
990
889
            properties_changed.extend(get_executable_change(executable[0], executable[1]))
991
890
 
992
891
            if properties_changed:
993
 
                prop_str = b" (properties changed: %s)" % (
994
 
                        b", ".join(properties_changed),)
 
892
                prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
995
893
            else:
996
 
                prop_str = b""
 
894
                prop_str = ""
997
895
 
998
896
            if (old_present, new_present) == (True, False):
999
 
                self.to_file.write(b"=== removed %s '%s'\n" %
1000
 
                                   (kind[0].encode('ascii'), oldpath_encoded))
 
897
                self.to_file.write("=== removed %s '%s'\n" %
 
898
                                   (kind[0], oldpath_encoded))
1001
899
                newpath = oldpath
1002
900
            elif (old_present, new_present) == (False, True):
1003
 
                self.to_file.write(b"=== added %s '%s'\n" %
1004
 
                                   (kind[1].encode('ascii'), newpath_encoded))
 
901
                self.to_file.write("=== added %s '%s'\n" %
 
902
                                   (kind[1], newpath_encoded))
1005
903
                oldpath = newpath
1006
904
            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))
 
905
                self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
 
906
                    (kind[0], oldpath_encoded, newpath_encoded, prop_str))
1009
907
            else:
1010
908
                # if it was produced by iter_changes, it must be
1011
909
                # modified *somehow*, either content or execute bit.
1012
 
                self.to_file.write(b"=== modified %s '%s'%s\n" % (kind[0].encode('ascii'),
 
910
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
1013
911
                                   newpath_encoded, prop_str))
1014
912
            if changed_content:
1015
 
                self._diff(oldpath, newpath, kind[0], kind[1], file_id=file_id)
 
913
                self.diff(file_id, oldpath, newpath)
1016
914
                has_changes = 1
1017
915
            if renamed:
1018
916
                has_changes = 1
1025
923
        :param old_path: The path of the file in the old tree
1026
924
        :param new_path: The path of the file in the new tree
1027
925
        """
1028
 
        if old_path is None:
 
926
        try:
 
927
            old_kind = self.old_tree.kind(file_id)
 
928
        except (errors.NoSuchId, errors.NoSuchFile):
1029
929
            old_kind = None
1030
 
        else:
1031
 
            old_kind = self.old_tree.kind(old_path, file_id)
1032
 
        if new_path is None:
 
930
        try:
 
931
            new_kind = self.new_tree.kind(file_id)
 
932
        except (errors.NoSuchId, errors.NoSuchFile):
1033
933
            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
934
 
1038
 
    def _diff(self, old_path, new_path, old_kind, new_kind, file_id):
1039
935
        result = DiffPath._diff_many(self.differs, file_id, old_path,
1040
936
                                       new_path, old_kind, new_kind)
1041
937
        if result is DiffPath.CANNOT_DIFF:
1043
939
            if error_path is None:
1044
940
                error_path = old_path
1045
941
            raise errors.NoDiffFound(error_path)
1046
 
 
1047
 
 
1048
 
format_registry = Registry()
1049
 
format_registry.register('default', DiffTree)