1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
1
# Copyright (C) 2005-2010 Canonical Ltd.
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
43
from bzrlib.workingtree import WorkingTree
46
from bzrlib.registry import (
43
49
from bzrlib.symbol_versioning import (
44
50
deprecated_function,
46
53
from bzrlib.trace import mutter, note, warning
56
class AtTemplate(string.Template):
57
"""Templating class that uses @ instead of $."""
49
62
# TODO: Rather than building a changeset object, we should probably
50
63
# invoke callbacks on an object. That object can either accumulate a
51
64
# list, write them out directly, etc etc.
86
99
if sequence_matcher is None:
87
100
sequence_matcher = patiencediff.PatienceSequenceMatcher
88
101
ud = patiencediff.unified_diff(oldlines, newlines,
89
fromfile=old_filename.encode(path_encoding),
90
tofile=new_filename.encode(path_encoding),
102
fromfile=old_filename.encode(path_encoding, 'replace'),
103
tofile=new_filename.encode(path_encoding, 'replace'),
91
104
sequencematcher=sequence_matcher)
293
@deprecated_function(deprecated_in((2, 2, 0)))
280
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
281
295
apply_view=True):
282
296
"""Get the trees and specific files to diff given a list of paths.
302
316
a tuple of (old_tree, new_tree, old_branch, new_branch,
303
317
specific_files, extra_trees) where extra_trees is a sequence of
304
additional trees to search in for file-ids.
318
additional trees to search in for file-ids. The trees and branches
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)
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.
330
This method works out the trees to be diff'ed and the files of
331
interest within those trees.
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.
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.
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.
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.
348
if True and a view is set, apply the view or check that the paths
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
306
357
# Get the old and new revision specs
307
358
old_revision_spec = None
330
381
default_location = path_list[0]
331
382
other_paths = path_list[1:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
333
392
# Get the old location
334
393
specific_files = []
335
394
if old_url is None:
336
395
old_url = default_location
337
396
working_tree, branch, relpath = \
338
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
lock_tree_or_branch(working_tree, branch)
339
399
if consider_relpath and relpath != '':
340
400
if working_tree is not None and apply_view:
341
401
views.check_path_in_view(working_tree, relpath)
349
409
if new_url != old_url:
350
410
working_tree, branch, relpath = \
351
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
lock_tree_or_branch(working_tree, branch)
352
413
if consider_relpath and relpath != '':
353
414
if working_tree is not None and apply_view:
354
415
views.check_path_in_view(working_tree, relpath)
360
421
# Get the specific files (all files is None, no files is [])
361
422
if make_paths_wt_relative and working_tree is not None:
363
from bzrlib.builtins import safe_relpath_files
364
other_paths = safe_relpath_files(working_tree, other_paths,
423
other_paths = working_tree.safe_relpath_files(
365
425
apply_view=apply_view)
366
except errors.FileInWrongBranch:
367
raise errors.BzrCommandError("Files are in different branches")
368
426
specific_files.extend(other_paths)
369
427
if len(specific_files) == 0:
370
428
specific_files = None
402
460
old_label='a/', new_label='b/',
403
461
extra_trees=None,
404
462
path_encoding='utf8',
406
465
"""Show in text form the changes from one tree to another.
412
Include only changes to these files - None for all changes.
414
external_diff_options
415
If set, use an external GNU diff and pass these options.
418
If set, more Trees to use for looking up file ids
421
If set, the path will be encoded as specified, otherwise is supposed
467
:param to_file: The output stream.
468
:param specific_files:Include only changes to these files - None for all
470
:param external_diff_options: If set, use an external GNU diff and pass
472
:param extra_trees: If set, more Trees to use for looking up file ids
473
:param path_encoding: If set, the path will be encoded as specified,
474
otherwise is supposed to be utf8
475
:param format_cls: Formatter class (DiffTree subclass)
477
if format_cls is None:
478
format_cls = DiffTree
424
479
old_tree.lock_read()
426
481
if extra_trees is not None:
429
484
new_tree.lock_read()
431
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
433
external_diff_options,
434
old_label, new_label, using)
486
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
488
external_diff_options,
489
old_label, new_label, using)
435
490
return differ.show_diff(specific_files, extra_trees)
437
492
new_tree.unlock()
445
500
def _patch_header_date(tree, file_id, path):
446
501
"""Returns a timestamp suitable for use in a patch header."""
447
mtime = tree.get_file_mtime(file_id, path)
503
mtime = tree.get_file_mtime(file_id, path)
504
except errors.FileTimestampUnavailable:
448
506
return timestamp.format_patch_date(mtime)
646
704
def _get_text(tree, file_id, path):
647
705
if file_id is not None:
648
return tree.get_file(file_id, path).readlines()
706
return tree.get_file_lines(file_id, path)
652
710
from_text = _get_text(self.old_tree, from_file_id, from_path)
653
711
to_text = _get_text(self.new_tree, to_file_id, to_path)
654
712
self.text_differ(from_label, from_text, to_label, to_text,
713
self.to_file, path_encoding=self.path_encoding)
656
714
except errors.BinaryFile:
657
715
self.to_file.write(
658
716
("Binary files %s and %s differ\n" %
659
(from_label, to_label)).encode(self.path_encoding))
717
(from_label, to_label)).encode(self.path_encoding,'replace'))
660
718
return self.CHANGED
672
730
def from_string(klass, command_string, old_tree, new_tree, to_file,
673
731
path_encoding='utf-8'):
674
command_template = commands.shlex_split_unicode(command_string)
675
command_template.extend(['%(old_path)s', '%(new_path)s'])
732
command_template = cmdline.split(command_string)
733
if '@' not in command_string:
734
command_template.extend(['@old_path', '@new_path'])
676
735
return klass(command_template, old_tree, new_tree, to_file,
680
def make_from_diff_tree(klass, command_string):
739
def make_from_diff_tree(klass, command_string, external_diff_options=None):
681
740
def from_diff_tree(diff_tree):
682
return klass.from_string(command_string, diff_tree.old_tree,
741
full_command_string = [command_string]
742
if external_diff_options is not None:
743
full_command_string += ' ' + external_diff_options
744
return klass.from_string(full_command_string, diff_tree.old_tree,
683
745
diff_tree.new_tree, diff_tree.to_file)
684
746
return from_diff_tree
686
748
def _get_command(self, old_path, new_path):
687
749
my_map = {'old_path': old_path, 'new_path': new_path}
688
return [t % my_map for t in self.command_template]
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
690
753
def _execute(self, old_path, new_path):
691
754
command = self._get_command(old_path, new_path)
714
def _write_file(self, file_id, tree, prefix, relpath):
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
if not force_temp and isinstance(tree, WorkingTree):
780
return tree.abspath(tree.id2path(file_id))
715
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
716
if self._try_symlink_root(tree, prefix):
783
if not force_temp and self._try_symlink_root(tree, prefix):
718
785
parent_dir = osutils.dirname(full_path)
733
osutils.make_readonly(full_path)
734
mtime = tree.get_file_mtime(file_id)
735
os.utime(full_path, (mtime, mtime))
801
mtime = tree.get_file_mtime(file_id)
802
except errors.FileTimestampUnavailable:
805
os.utime(full_path, (mtime, mtime))
807
osutils.make_readonly(full_path)
738
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):
739
812
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
741
814
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
816
allow_write=allow_write_new)
743
817
return old_disk_path, new_disk_path
745
819
def finish(self):
753
827
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
754
828
if (old_kind, new_kind) != ('file', 'file'):
755
829
return DiffPath.CANNOT_DIFF
756
self._prepare_files(file_id, old_path, new_path)
757
self._execute(osutils.pathjoin('old', old_path),
758
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)
834
def edit_file(self, file_id):
835
"""Use this tool to edit a file.
837
A temporary copy will be edited, and the new contents will be
840
:param file_id: The id of the file to edit.
841
:return: The new contents of the file.
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,
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')
853
return new_file.read()
761
858
class DiffTree(object):
818
915
:param using: Commandline to use to invoke an external diff tool
820
917
if using is not None:
821
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
918
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
823
920
extra_factories = []
824
921
if external_diff_options:
825
922
opts = external_diff_options.split()
826
def diff_file(olab, olines, nlab, nlines, to_file):
923
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
924
""":param path_encoding: not used but required
925
to match the signature of internal_diff.
827
927
external_diff(olab, olines, nlab, nlines, to_file, opts)
829
929
diff_file = internal_diff
835
935
def show_diff(self, specific_files, extra_trees=None):
836
936
"""Write tree diff to self.to_file
838
:param sepecific_files: the specific files to compare (recursive)
938
:param specific_files: the specific files to compare (recursive)
839
939
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
