291
@deprecated_function(deprecated_in((2, 2, 0)))
292
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
294
"""Get the trees and specific files to diff given a list of paths.
296
This method works out the trees to be diff'ed and the files of
297
interest within those trees.
300
the list of arguments passed to the diff command
301
:param revision_specs:
302
Zero, one or two RevisionSpecs from the diff command line,
303
saying what revisions to compare.
305
The url of the old branch or tree. If None, the tree to use is
306
taken from the first path, if any, or the current working tree.
308
The url of the new branch or tree. If None, the tree to use is
309
taken from the first path, if any, or the current working tree.
311
if True and a view is set, apply the view or check that the paths
314
a tuple of (old_tree, new_tree, old_branch, new_branch,
315
specific_files, extra_trees) where extra_trees is a sequence of
316
additional trees to search in for file-ids. The trees and branches
319
op = cleanup.OperationWithCleanups(get_trees_and_branches_to_diff_locked)
320
return op.run_simple(path_list, revision_specs, old_url, new_url,
321
op.add_cleanup, apply_view=apply_view)
324
def get_trees_and_branches_to_diff_locked(
325
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
326
"""Get the trees and specific files to diff given a list of paths.
328
This method works out the trees to be diff'ed and the files of
329
interest within those trees.
332
the list of arguments passed to the diff command
333
:param revision_specs:
334
Zero, one or two RevisionSpecs from the diff command line,
335
saying what revisions to compare.
337
The url of the old branch or tree. If None, the tree to use is
338
taken from the first path, if any, or the current working tree.
340
The url of the new branch or tree. If None, the tree to use is
341
taken from the first path, if any, or the current working tree.
343
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
344
will register cleanups that must be run to unlock the trees, etc.
346
if True and a view is set, apply the view or check that the paths
349
a tuple of (old_tree, new_tree, old_branch, new_branch,
350
specific_files, extra_trees) where extra_trees is a sequence of
351
additional trees to search in for file-ids. The trees and branches
352
will be read-locked until the cleanups registered via the add_cleanup
275
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
277
"""Get the trees and specific files to diff given a list of paths.
279
This method works out the trees to be diff'ed and the files of
280
interest within those trees.
283
the list of arguments passed to the diff command
284
:param revision_specs:
285
Zero, one or two RevisionSpecs from the diff command line,
286
saying what revisions to compare.
288
The url of the old branch or tree. If None, the tree to use is
289
taken from the first path, if any, or the current working tree.
291
The url of the new branch or tree. If None, the tree to use is
292
taken from the first path, if any, or the current working tree.
294
if True and a view is set, apply the view or check that the paths
297
a tuple of (old_tree, new_tree, specific_files, extra_trees) where
298
extra_trees is a sequence of additional trees to search in for
355
301
# Get the old and new revision specs
356
302
old_revision_spec = None
379
325
default_location = path_list[0]
380
326
other_paths = path_list[1:]
382
def lock_tree_or_branch(wt, br):
385
add_cleanup(wt.unlock)
388
add_cleanup(br.unlock)
390
328
# Get the old location
391
329
specific_files = []
392
330
if old_url is None:
393
331
old_url = default_location
394
332
working_tree, branch, relpath = \
395
333
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
396
lock_tree_or_branch(working_tree, branch)
397
334
if consider_relpath and relpath != '':
398
335
if working_tree is not None and apply_view:
399
336
views.check_path_in_view(working_tree, relpath)
400
337
specific_files.append(relpath)
401
338
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
404
340
# Get the new location
405
341
if new_url is None:
407
343
if new_url != old_url:
408
344
working_tree, branch, relpath = \
409
345
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
410
lock_tree_or_branch(working_tree, branch)
411
346
if consider_relpath and relpath != '':
412
347
if working_tree is not None and apply_view:
413
348
views.check_path_in_view(working_tree, relpath)
414
349
specific_files.append(relpath)
415
350
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
416
351
basis_is_default=working_tree is None)
419
353
# Get the specific files (all files is None, no files is [])
420
354
if make_paths_wt_relative and working_tree is not None:
421
other_paths = working_tree.safe_relpath_files(
356
from bzrlib.builtins import safe_relpath_files
357
other_paths = safe_relpath_files(working_tree, other_paths,
423
358
apply_view=apply_view)
359
except errors.FileInWrongBranch:
360
raise errors.BzrCommandError("Files are in different branches")
424
361
specific_files.extend(other_paths)
425
362
if len(specific_files) == 0:
426
363
specific_files = None
458
394
old_label='a/', new_label='b/',
459
395
extra_trees=None,
460
396
path_encoding='utf8',
463
398
"""Show in text form the changes from one tree to another.
465
:param to_file: The output stream.
466
:param specific_files: Include only changes to these files - None for all
468
:param external_diff_options: If set, use an external GNU diff and pass
470
:param extra_trees: If set, more Trees to use for looking up file ids
471
:param path_encoding: If set, the path will be encoded as specified,
472
otherwise is supposed to be utf8
473
:param format_cls: Formatter class (DiffTree subclass)
404
Include only changes to these files - None for all changes.
406
external_diff_options
407
If set, use an external GNU diff and pass these options.
410
If set, more Trees to use for looking up file ids
413
If set, the path will be encoded as specified, otherwise is supposed
475
if format_cls is None:
476
format_cls = DiffTree
477
416
old_tree.lock_read()
479
418
if extra_trees is not None:
684
620
return self.CANNOT_DIFF
685
621
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
686
622
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
687
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
623
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
690
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
691
from_path=None, to_path=None):
625
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
692
626
"""Diff the content of given files in two trees
694
628
:param from_file_id: The id of the file in the from tree. If None,
696
630
:param to_file_id: The id of the file in the to tree. This may refer
697
631
to a different file from from_file_id. If None,
698
632
the file is not present in the to tree.
699
:param from_path: The path in the from tree or None if unknown.
700
:param to_path: The path in the to tree or None if unknown.
702
def _get_text(tree, file_id, path):
634
def _get_text(tree, file_id):
703
635
if file_id is not None:
704
return tree.get_file_lines(file_id, path)
636
return tree.get_file(file_id).readlines()
708
from_text = _get_text(self.old_tree, from_file_id, from_path)
709
to_text = _get_text(self.new_tree, to_file_id, to_path)
640
from_text = _get_text(self.old_tree, from_file_id)
641
to_text = _get_text(self.new_tree, to_file_id)
710
642
self.text_differ(from_label, from_text, to_label, to_text,
711
self.to_file, path_encoding=self.path_encoding)
712
644
except errors.BinaryFile:
713
645
self.to_file.write(
714
646
("Binary files %s and %s differ\n" %
715
(from_label, to_label)).encode(self.path_encoding,'replace'))
647
(from_label, to_label)).encode(self.path_encoding))
716
648
return self.CHANGED
728
660
def from_string(klass, command_string, old_tree, new_tree, to_file,
729
661
path_encoding='utf-8'):
730
command_template = cmdline.split(command_string)
731
if '@' not in command_string:
732
command_template.extend(['@old_path', '@new_path'])
662
command_template = commands.shlex_split_unicode(command_string)
663
command_template.extend(['%(old_path)s', '%(new_path)s'])
733
664
return klass(command_template, old_tree, new_tree, to_file,
737
def make_from_diff_tree(klass, command_string, external_diff_options=None):
668
def make_from_diff_tree(klass, command_string):
738
669
def from_diff_tree(diff_tree):
739
full_command_string = [command_string]
740
if external_diff_options is not None:
741
full_command_string += ' ' + external_diff_options
742
return klass.from_string(full_command_string, diff_tree.old_tree,
670
return klass.from_string(command_string, diff_tree.old_tree,
743
671
diff_tree.new_tree, diff_tree.to_file)
744
672
return from_diff_tree
746
674
def _get_command(self, old_path, new_path):
747
675
my_map = {'old_path': old_path, 'new_path': new_path}
748
command = [AtTemplate(t).substitute(my_map) for t in
749
self.command_template]
750
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
753
if isinstance(c, unicode):
754
command_encoded.append(c.encode('mbcs'))
756
command_encoded.append(c)
757
return command_encoded
676
return [t % my_map for t in self.command_template]
761
678
def _execute(self, old_path, new_path):
762
679
command = self._get_command(old_path, new_path)
787
"""Returns safe encoding for passing file path to diff tool"""
788
if sys.platform == 'win32':
791
# Don't fallback to 'utf-8' because subprocess may not be able to
792
# handle utf-8 correctly when locale is not utf-8.
793
return sys.getfilesystemencoding() or 'ascii'
795
def _is_safepath(self, path):
796
"""Return true if `path` may be able to pass to subprocess."""
799
return path == path.encode(fenc).decode(fenc)
803
def _safe_filename(self, prefix, relpath):
804
"""Replace unsafe character in `relpath` then join `self._root`,
805
`prefix` and `relpath`."""
807
# encoded_str.replace('?', '_') may break multibyte char.
808
# So we should encode, decode, then replace(u'?', u'_')
809
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
810
relpath_tmp = relpath_tmp.replace(u'?', u'_')
811
return osutils.pathjoin(self._root, prefix, relpath_tmp)
813
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
815
if not force_temp and isinstance(tree, WorkingTree):
816
full_path = tree.abspath(tree.id2path(file_id))
817
if self._is_safepath(full_path):
820
full_path = self._safe_filename(prefix, relpath)
821
if not force_temp and self._try_symlink_root(tree, prefix):
702
def _write_file(self, file_id, tree, prefix, relpath):
703
full_path = osutils.pathjoin(self._root, prefix, relpath)
704
if self._try_symlink_root(tree, prefix):
823
706
parent_dir = osutils.dirname(full_path)
839
mtime = tree.get_file_mtime(file_id)
840
except errors.FileTimestampUnavailable:
843
os.utime(full_path, (mtime, mtime))
845
osutils.make_readonly(full_path)
721
osutils.make_readonly(full_path)
722
mtime = tree.get_file_mtime(file_id)
723
os.utime(full_path, (mtime, mtime))
848
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
849
allow_write_new=False):
726
def _prepare_files(self, file_id, old_path, new_path):
850
727
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
851
old_path, force_temp)
852
729
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
853
new_path, force_temp,
854
allow_write=allow_write_new)
855
731
return old_disk_path, new_disk_path
857
733
def finish(self):
859
osutils.rmtree(self._root)
861
if e.errno != errno.ENOENT:
862
mutter("The temporary directory \"%s\" was not "
863
"cleanly removed: %s." % (self._root, e))
734
osutils.rmtree(self._root)
865
736
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
866
737
if (old_kind, new_kind) != ('file', 'file'):
867
738
return DiffPath.CANNOT_DIFF
868
(old_disk_path, new_disk_path) = self._prepare_files(
869
file_id, old_path, new_path)
870
self._execute(old_disk_path, new_disk_path)
872
def edit_file(self, file_id):
873
"""Use this tool to edit a file.
875
A temporary copy will be edited, and the new contents will be
878
:param file_id: The id of the file to edit.
879
:return: The new contents of the file.
881
old_path = self.old_tree.id2path(file_id)
882
new_path = self.new_tree.id2path(file_id)
883
old_abs_path, new_abs_path = self._prepare_files(
884
file_id, old_path, new_path,
885
allow_write_new=True,
887
command = self._get_command(old_abs_path, new_abs_path)
888
subprocess.call(command, cwd=self._root)
889
new_file = open(new_abs_path, 'rb')
891
return new_file.read()
739
self._prepare_files(file_id, old_path, new_path)
740
self._execute(osutils.pathjoin('old', old_path),
741
osutils.pathjoin('new', new_path))
896
744
class DiffTree(object):
954
801
:param using: Commandline to use to invoke an external diff tool
956
803
if using is not None:
957
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
804
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
959
806
extra_factories = []
960
807
if external_diff_options:
961
808
opts = external_diff_options.split()
962
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
963
""":param path_encoding: not used but required
964
to match the signature of internal_diff.
809
def diff_file(olab, olines, nlab, nlines, to_file):
966
810
external_diff(olab, olines, nlab, nlines, to_file, opts)
968
812
diff_file = internal_diff
1059
903
new_kind = self.new_tree.kind(file_id)
1060
904
except (errors.NoSuchId, errors.NoSuchFile):
1062
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1065
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1066
907
result = DiffPath._diff_many(self.differs, file_id, old_path,
1067
908
new_path, old_kind, new_kind)
1068
909
if result is DiffPath.CANNOT_DIFF: