/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: Martin
  • Date: 2010-05-03 20:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 5204.
  • Revision ID: gzlist@googlemail.com-20100503205739-n326zdvevv0rmruh
Retain original stack and error message when translating to ValueError in bencode

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/diff.py
1
 
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
 
1
# Copyright (C) 2005-2010 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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
import difflib
18
18
import os
19
19
import re
20
 
import shutil
 
20
import string
21
21
import sys
22
22
 
23
23
from bzrlib.lazy_import import lazy_import
30
30
from bzrlib import (
31
31
    branch as _mod_branch,
32
32
    bzrdir,
33
 
    commands,
 
33
    cmdline,
 
34
    cleanup,
34
35
    errors,
35
36
    osutils,
36
37
    patiencediff,
37
38
    textfile,
38
39
    timestamp,
 
40
    views,
39
41
    )
 
42
 
 
43
from bzrlib.workingtree import WorkingTree
40
44
""")
41
45
 
 
46
from bzrlib.registry import (
 
47
    Registry,
 
48
    )
42
49
from bzrlib.symbol_versioning import (
43
 
        deprecated_function,
44
 
        one_three
45
 
        )
46
 
from bzrlib.trace import warning
 
50
    deprecated_function,
 
51
    deprecated_in,
 
52
    )
 
53
from bzrlib.trace import mutter, note, warning
 
54
 
 
55
 
 
56
class AtTemplate(string.Template):
 
57
    """Templating class that uses @ instead of $."""
 
58
 
 
59
    delimiter = '@'
47
60
 
48
61
 
49
62
# TODO: Rather than building a changeset object, we should probably
78
91
    # both sequences are empty.
79
92
    if not oldlines and not newlines:
80
93
        return
81
 
    
 
94
 
82
95
    if allow_binary is False:
83
96
        textfile.check_text_lines(oldlines)
84
97
        textfile.check_text_lines(newlines)
171
184
 
172
185
        if not diff_opts:
173
186
            diff_opts = []
 
187
        if sys.platform == 'win32':
 
188
            # Popen doesn't do the proper encoding for external commands
 
189
            # Since we are dealing with an ANSI api, use mbcs encoding
 
190
            old_filename = old_filename.encode('mbcs')
 
191
            new_filename = new_filename.encode('mbcs')
174
192
        diffcmd = ['diff',
175
193
                   '--label', old_filename,
176
194
                   old_abspath,
199
217
            break
200
218
        else:
201
219
            diffcmd.append('-u')
202
 
                  
 
220
 
203
221
        if diff_opts:
204
222
            diffcmd.extend(diff_opts)
205
223
 
206
224
        pipe = _spawn_external_diff(diffcmd, capture_errors=True)
207
225
        out,err = pipe.communicate()
208
226
        rc = pipe.returncode
209
 
        
 
227
 
210
228
        # internal_diff() adds a trailing newline, add one here for consistency
211
229
        out += '\n'
212
230
        if rc == 2:
247
265
                msg = 'signal %d' % (-rc)
248
266
            else:
249
267
                msg = 'exit code %d' % rc
250
 
                
251
 
            raise errors.BzrError('external diff failed with %s; command: %r' 
 
268
 
 
269
            raise errors.BzrError('external diff failed with %s; command: %r'
252
270
                                  % (rc, diffcmd))
253
271
 
254
272
 
272
290
                        new_abspath, e)
273
291
 
274
292
 
275
 
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
276
 
    """Get the trees and specific files to diff given a list of paths.
277
 
 
278
 
    This method works out the trees to be diff'ed and the files of
279
 
    interest within those trees.
280
 
 
281
 
    :param path_list:
282
 
        the list of arguments passed to the diff command
283
 
    :param revision_specs:
284
 
        Zero, one or two RevisionSpecs from the diff command line,
285
 
        saying what revisions to compare.
286
 
    :param old_url:
287
 
        The url of the old branch or tree. If None, the tree to use is
288
 
        taken from the first path, if any, or the current working tree.
289
 
    :param new_url:
290
 
        The url of the new branch or tree. If None, the tree to use is
291
 
        taken from the first path, if any, or the current working tree.
292
 
    :returns:
293
 
        a tuple of (old_tree, new_tree, specific_files, extra_trees) where
294
 
        extra_trees is a sequence of additional trees to search in for
295
 
        file-ids.
 
293
@deprecated_function(deprecated_in((2, 2, 0)))
 
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
 
295
                                   apply_view=True):
 
296
    """Get the trees and specific files to diff given a list of paths.
 
297
 
 
298
    This method works out the trees to be diff'ed and the files of
 
299
    interest within those trees.
 
300
 
 
301
    :param path_list:
 
302
        the list of arguments passed to the diff command
 
303
    :param revision_specs:
 
304
        Zero, one or two RevisionSpecs from the diff command line,
 
305
        saying what revisions to compare.
 
306
    :param old_url:
 
307
        The url of the old branch or tree. If None, the tree to use is
 
308
        taken from the first path, if any, or the current working tree.
 
309
    :param new_url:
 
310
        The url of the new branch or tree. If None, the tree to use is
 
311
        taken from the first path, if any, or the current working tree.
 
312
    :param apply_view:
 
313
        if True and a view is set, apply the view or check that the paths
 
314
        are within it
 
315
    :returns:
 
316
        a tuple of (old_tree, new_tree, old_branch, new_branch,
 
317
        specific_files, extra_trees) where extra_trees is a sequence of
 
318
        additional trees to search in for file-ids.  The trees and branches
 
319
        are not locked.
 
320
    """
 
321
    op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
 
322
    return op.run_simple(path_list, revision_specs, old_url, new_url,
 
323
            op.add_cleanup, apply_view=apply_view)
 
324
    
 
325
 
 
326
def get_trees_and_branches_to_diff_locked(
 
327
    path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
 
328
    """Get the trees and specific files to diff given a list of paths.
 
329
 
 
330
    This method works out the trees to be diff'ed and the files of
 
331
    interest within those trees.
 
332
 
 
333
    :param path_list:
 
334
        the list of arguments passed to the diff command
 
335
    :param revision_specs:
 
336
        Zero, one or two RevisionSpecs from the diff command line,
 
337
        saying what revisions to compare.
 
338
    :param old_url:
 
339
        The url of the old branch or tree. If None, the tree to use is
 
340
        taken from the first path, if any, or the current working tree.
 
341
    :param new_url:
 
342
        The url of the new branch or tree. If None, the tree to use is
 
343
        taken from the first path, if any, or the current working tree.
 
344
    :param add_cleanup:
 
345
        a callable like Command.add_cleanup.  get_trees_and_branches_to_diff
 
346
        will register cleanups that must be run to unlock the trees, etc.
 
347
    :param apply_view:
 
348
        if True and a view is set, apply the view or check that the paths
 
349
        are within it
 
350
    :returns:
 
351
        a tuple of (old_tree, new_tree, old_branch, new_branch,
 
352
        specific_files, extra_trees) where extra_trees is a sequence of
 
353
        additional trees to search in for file-ids.  The trees and branches
 
354
        will be read-locked until the cleanups registered via the add_cleanup
 
355
        param are run.
296
356
    """
297
357
    # Get the old and new revision specs
298
358
    old_revision_spec = None
321
381
        default_location = path_list[0]
322
382
        other_paths = path_list[1:]
323
383
 
 
384
    def lock_tree_or_branch(wt, br):
 
385
        if wt is not None:
 
386
            wt.lock_read()
 
387
            add_cleanup(wt.unlock)
 
388
        elif br is not None:
 
389
            br.lock_read()
 
390
            add_cleanup(br.unlock)
 
391
 
324
392
    # Get the old location
325
393
    specific_files = []
326
394
    if old_url is None:
327
395
        old_url = default_location
328
396
    working_tree, branch, relpath = \
329
397
        bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
 
398
    lock_tree_or_branch(working_tree, branch)
330
399
    if consider_relpath and relpath != '':
 
400
        if working_tree is not None and apply_view:
 
401
            views.check_path_in_view(working_tree, relpath)
331
402
        specific_files.append(relpath)
332
403
    old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
 
404
    old_branch = branch
333
405
 
334
406
    # Get the new location
335
407
    if new_url is None:
337
409
    if new_url != old_url:
338
410
        working_tree, branch, relpath = \
339
411
            bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
 
412
        lock_tree_or_branch(working_tree, branch)
340
413
        if consider_relpath and relpath != '':
 
414
            if working_tree is not None and apply_view:
 
415
                views.check_path_in_view(working_tree, relpath)
341
416
            specific_files.append(relpath)
342
417
    new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
343
418
        basis_is_default=working_tree is None)
 
419
    new_branch = branch
344
420
 
345
421
    # Get the specific files (all files is None, no files is [])
346
422
    if make_paths_wt_relative and working_tree is not None:
347
 
        other_paths = _relative_paths_in_tree(working_tree, other_paths)
 
423
        try:
 
424
            from bzrlib.builtins import safe_relpath_files
 
425
            other_paths = safe_relpath_files(working_tree, other_paths,
 
426
            apply_view=apply_view)
 
427
        except errors.FileInWrongBranch:
 
428
            raise errors.BzrCommandError("Files are in different branches")
348
429
    specific_files.extend(other_paths)
349
430
    if len(specific_files) == 0:
350
431
        specific_files = None
 
432
        if (working_tree is not None and working_tree.supports_views()
 
433
            and apply_view):
 
434
            view_files = working_tree.views.lookup_view()
 
435
            if view_files:
 
436
                specific_files = view_files
 
437
                view_str = views.view_display_str(view_files)
 
438
                note("*** Ignoring files outside view. View is %s" % view_str)
351
439
 
352
440
    # Get extra trees that ought to be searched for file-ids
353
441
    extra_trees = None
354
442
    if working_tree is not None and working_tree not in (old_tree, new_tree):
355
443
        extra_trees = (working_tree,)
356
 
    return old_tree, new_tree, specific_files, extra_trees
 
444
    return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
357
445
 
358
446
 
359
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
370
458
    return spec.as_tree(branch)
371
459
 
372
460
 
373
 
def _relative_paths_in_tree(tree, paths):
374
 
    """Get the relative paths within a working tree.
375
 
 
376
 
    Each path may be either an absolute path or a path relative to the
377
 
    current working directory.
378
 
    """
379
 
    result = []
380
 
    for filename in paths:
381
 
        try:
382
 
            result.append(tree.relpath(osutils.dereference_path(filename)))
383
 
        except errors.PathNotChild:
384
 
            raise errors.BzrCommandError("Files are in different branches")
385
 
    return result
386
 
 
387
 
 
388
461
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
389
462
                    external_diff_options=None,
390
463
                    old_label='a/', new_label='b/',
391
464
                    extra_trees=None,
392
465
                    path_encoding='utf8',
393
 
                    using=None):
 
466
                    using=None,
 
467
                    format_cls=None):
394
468
    """Show in text form the changes from one tree to another.
395
469
 
396
 
    to_file
397
 
        The output stream.
398
 
 
399
 
    specific_files
400
 
        Include only changes to these files - None for all changes.
401
 
 
402
 
    external_diff_options
403
 
        If set, use an external GNU diff and pass these options.
404
 
 
405
 
    extra_trees
406
 
        If set, more Trees to use for looking up file ids
407
 
 
408
 
    path_encoding
409
 
        If set, the path will be encoded as specified, otherwise is supposed
410
 
        to be utf8
 
470
    :param to_file: The output stream.
 
471
    :param specific_files:Include only changes to these files - None for all
 
472
        changes.
 
473
    :param external_diff_options: If set, use an external GNU diff and pass 
 
474
        these options.
 
475
    :param extra_trees: If set, more Trees to use for looking up file ids
 
476
    :param path_encoding: If set, the path will be encoded as specified, 
 
477
        otherwise is supposed to be utf8
 
478
    :param format_cls: Formatter class (DiffTree subclass)
411
479
    """
 
480
    if format_cls is None:
 
481
        format_cls = DiffTree
412
482
    old_tree.lock_read()
413
483
    try:
414
484
        if extra_trees is not None:
416
486
                tree.lock_read()
417
487
        new_tree.lock_read()
418
488
        try:
419
 
            differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
420
 
                                                 path_encoding,
421
 
                                                 external_diff_options,
422
 
                                                 old_label, new_label, using)
 
489
            differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
 
490
                                                   path_encoding,
 
491
                                                   external_diff_options,
 
492
                                                   old_label, new_label, using)
423
493
            return differ.show_diff(specific_files, extra_trees)
424
494
        finally:
425
495
            new_tree.unlock()
432
502
 
433
503
def _patch_header_date(tree, file_id, path):
434
504
    """Returns a timestamp suitable for use in a patch header."""
435
 
    mtime = tree.get_file_mtime(file_id, path)
 
505
    try:
 
506
        mtime = tree.get_file_mtime(file_id, path)
 
507
    except errors.FileTimestampUnavailable:
 
508
        mtime = 0
436
509
    return timestamp.format_patch_date(mtime)
437
510
 
438
511
 
439
 
@deprecated_function(one_three)
440
 
def get_prop_change(meta_modified):
441
 
    if meta_modified:
442
 
        return " (properties changed)"
443
 
    else:
444
 
        return  ""
445
 
 
446
512
def get_executable_change(old_is_x, new_is_x):
447
513
    descr = { True:"+x", False:"-x", None:"??" }
448
514
    if old_is_x != new_is_x:
623
689
            return self.CANNOT_DIFF
624
690
        from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
625
691
        to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
626
 
        return self.diff_text(from_file_id, to_file_id, from_label, to_label)
 
692
        return self.diff_text(from_file_id, to_file_id, from_label, to_label,
 
693
            old_path, new_path)
627
694
 
628
 
    def diff_text(self, from_file_id, to_file_id, from_label, to_label):
 
695
    def diff_text(self, from_file_id, to_file_id, from_label, to_label,
 
696
        from_path=None, to_path=None):
629
697
        """Diff the content of given files in two trees
630
698
 
631
699
        :param from_file_id: The id of the file in the from tree.  If None,
633
701
        :param to_file_id: The id of the file in the to tree.  This may refer
634
702
            to a different file from from_file_id.  If None,
635
703
            the file is not present in the to tree.
 
704
        :param from_path: The path in the from tree or None if unknown.
 
705
        :param to_path: The path in the to tree or None if unknown.
636
706
        """
637
 
        def _get_text(tree, file_id):
 
707
        def _get_text(tree, file_id, path):
638
708
            if file_id is not None:
639
 
                return tree.get_file(file_id).readlines()
 
709
                return tree.get_file(file_id, path).readlines()
640
710
            else:
641
711
                return []
642
712
        try:
643
 
            from_text = _get_text(self.old_tree, from_file_id)
644
 
            to_text = _get_text(self.new_tree, to_file_id)
 
713
            from_text = _get_text(self.old_tree, from_file_id, from_path)
 
714
            to_text = _get_text(self.new_tree, to_file_id, to_path)
645
715
            self.text_differ(from_label, from_text, to_label, to_text,
646
716
                             self.to_file)
647
717
        except errors.BinaryFile:
662
732
    @classmethod
663
733
    def from_string(klass, command_string, old_tree, new_tree, to_file,
664
734
                    path_encoding='utf-8'):
665
 
        command_template = commands.shlex_split_unicode(command_string)
666
 
        command_template.extend(['%(old_path)s', '%(new_path)s'])
 
735
        command_template = cmdline.split(command_string)
 
736
        if '@' not in command_string:
 
737
            command_template.extend(['@old_path', '@new_path'])
667
738
        return klass(command_template, old_tree, new_tree, to_file,
668
739
                     path_encoding)
669
740
 
676
747
 
677
748
    def _get_command(self, old_path, new_path):
678
749
        my_map = {'old_path': old_path, 'new_path': new_path}
679
 
        return [t % my_map for t in self.command_template]
 
750
        return [AtTemplate(t).substitute(my_map) for t in
 
751
                self.command_template]
680
752
 
681
753
    def _execute(self, old_path, new_path):
682
754
        command = self._get_command(old_path, new_path)
702
774
                raise
703
775
        return True
704
776
 
705
 
    def _write_file(self, file_id, tree, prefix, relpath):
 
777
    def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
 
778
                    allow_write=False):
 
779
        if not force_temp and isinstance(tree, WorkingTree):
 
780
            return tree.abspath(tree.id2path(file_id))
 
781
        
706
782
        full_path = osutils.pathjoin(self._root, prefix, relpath)
707
 
        if self._try_symlink_root(tree, prefix):
 
783
        if not force_temp and self._try_symlink_root(tree, prefix):
708
784
            return full_path
709
785
        parent_dir = osutils.dirname(full_path)
710
786
        try:
721
797
                target.close()
722
798
        finally:
723
799
            source.close()
724
 
        osutils.make_readonly(full_path)
725
 
        mtime = tree.get_file_mtime(file_id)
726
 
        os.utime(full_path, (mtime, mtime))
 
800
        try:
 
801
            mtime = tree.get_file_mtime(file_id)
 
802
        except errors.FileTimestampUnavailable:
 
803
            pass
 
804
        else:
 
805
            os.utime(full_path, (mtime, mtime))
 
806
        if not allow_write:
 
807
            osutils.make_readonly(full_path)
727
808
        return full_path
728
809
 
729
 
    def _prepare_files(self, file_id, old_path, new_path):
 
810
    def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
 
811
                       allow_write_new=False):
730
812
        old_disk_path = self._write_file(file_id, self.old_tree, 'old',
731
 
                                         old_path)
 
813
                                         old_path, force_temp)
732
814
        new_disk_path = self._write_file(file_id, self.new_tree, 'new',
733
 
                                         new_path)
 
815
                                         new_path, force_temp,
 
816
                                         allow_write=allow_write_new)
734
817
        return old_disk_path, new_disk_path
735
818
 
736
819
    def finish(self):
737
 
        osutils.rmtree(self._root)
 
820
        try:
 
821
            osutils.rmtree(self._root)
 
822
        except OSError, e:
 
823
            if e.errno != errno.ENOENT:
 
824
                mutter("The temporary directory \"%s\" was not "
 
825
                        "cleanly removed: %s." % (self._root, e))
738
826
 
739
827
    def diff(self, file_id, old_path, new_path, old_kind, new_kind):
740
828
        if (old_kind, new_kind) != ('file', 'file'):
741
829
            return DiffPath.CANNOT_DIFF
742
 
        self._prepare_files(file_id, old_path, new_path)
743
 
        self._execute(osutils.pathjoin('old', old_path),
744
 
                      osutils.pathjoin('new', new_path))
 
830
        (old_disk_path, new_disk_path) = self._prepare_files(
 
831
                                                file_id, old_path, new_path)
 
832
        self._execute(old_disk_path, new_disk_path)
 
833
 
 
834
    def edit_file(self, file_id):
 
835
        """Use this tool to edit a file.
 
836
 
 
837
        A temporary copy will be edited, and the new contents will be
 
838
        returned.
 
839
 
 
840
        :param file_id: The id of the file to edit.
 
841
        :return: The new contents of the file.
 
842
        """
 
843
        old_path = self.old_tree.id2path(file_id)
 
844
        new_path = self.new_tree.id2path(file_id)
 
845
        new_abs_path = self._prepare_files(file_id, old_path, new_path,
 
846
                                           allow_write_new=True,
 
847
                                           force_temp=True)[1]
 
848
        command = self._get_command(osutils.pathjoin('old', old_path),
 
849
                                    osutils.pathjoin('new', new_path))
 
850
        subprocess.call(command, cwd=self._root)
 
851
        new_file = open(new_abs_path, 'r')
 
852
        try:
 
853
            return new_file.read()
 
854
        finally:
 
855
            new_file.close()
745
856
 
746
857
 
747
858
class DiffTree(object):
821
932
    def show_diff(self, specific_files, extra_trees=None):
822
933
        """Write tree diff to self.to_file
823
934
 
824
 
        :param sepecific_files: the specific files to compare (recursive)
 
935
        :param specific_files: the specific files to compare (recursive)
825
936
        :param extra_trees: extra trees to use for mapping paths to file_ids
826
937
        """
827
938
        try:
885
996
                self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
886
997
                                   newpath_encoded, prop_str))
887
998
            if changed_content:
888
 
                self.diff(file_id, oldpath, newpath)
 
999
                self._diff(file_id, oldpath, newpath, kind[0], kind[1])
889
1000
                has_changes = 1
890
1001
            if renamed:
891
1002
                has_changes = 1
906
1017
            new_kind = self.new_tree.kind(file_id)
907
1018
        except (errors.NoSuchId, errors.NoSuchFile):
908
1019
            new_kind = None
909
 
 
 
1020
        self._diff(file_id, old_path, new_path, old_kind, new_kind)
 
1021
 
 
1022
 
 
1023
    def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
910
1024
        result = DiffPath._diff_many(self.differs, file_id, old_path,
911
1025
                                       new_path, old_kind, new_kind)
912
1026
        if result is DiffPath.CANNOT_DIFF:
914
1028
            if error_path is None:
915
1029
                error_path = old_path
916
1030
            raise errors.NoDiffFound(error_path)
 
1031
 
 
1032
 
 
1033
format_registry = Registry()
 
1034
format_registry.register('default', DiffTree)