41
from bzrlib.workingtree import WorkingTree
44
from bzrlib.registry import (
43
from bzrlib.symbol_versioning import (
47
46
from bzrlib.trace import mutter, note, warning
50
class AtTemplate(string.Template):
51
"""Templating class that uses @ instead of $."""
56
49
# TODO: Rather than building a changeset object, we should probably
57
50
# invoke callbacks on an object. That object can either accumulate a
58
51
# list, write them out directly, etc etc.
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'),
89
fromfile=old_filename.encode(path_encoding),
90
tofile=new_filename.encode(path_encoding),
98
91
sequencematcher=sequence_matcher)
287
def get_trees_and_branches_to_diff_locked(
288
path_list, revision_specs, old_url, new_url, add_cleanup, apply_view=True):
275
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url,
289
277
"""Get the trees and specific files to diff given a list of paths.
291
279
This method works out the trees to be diff'ed and the files of
303
291
The url of the new branch or tree. If None, the tree to use is
304
292
taken from the first path, if any, or the current working tree.
306
a callable like Command.add_cleanup. get_trees_and_branches_to_diff
307
will register cleanups that must be run to unlock the trees, etc.
308
293
:param apply_view:
309
294
if True and a view is set, apply the view or check that the paths
312
a tuple of (old_tree, new_tree, old_branch, new_branch,
313
specific_files, extra_trees) where extra_trees is a sequence of
314
additional trees to search in for file-ids. The trees and branches
315
will be read-locked until the cleanups registered via the add_cleanup
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
318
301
# Get the old and new revision specs
319
302
old_revision_spec = None
342
325
default_location = path_list[0]
343
326
other_paths = path_list[1:]
345
def lock_tree_or_branch(wt, br):
348
add_cleanup(wt.unlock)
351
add_cleanup(br.unlock)
353
328
# Get the old location
354
329
specific_files = []
355
330
if old_url is None:
356
331
old_url = default_location
357
332
working_tree, branch, relpath = \
358
333
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
359
lock_tree_or_branch(working_tree, branch)
360
334
if consider_relpath and relpath != '':
361
335
if working_tree is not None and apply_view:
362
336
views.check_path_in_view(working_tree, relpath)
363
337
specific_files.append(relpath)
364
338
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
367
340
# Get the new location
368
341
if new_url is None:
370
343
if new_url != old_url:
371
344
working_tree, branch, relpath = \
372
345
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
373
lock_tree_or_branch(working_tree, branch)
374
346
if consider_relpath and relpath != '':
375
347
if working_tree is not None and apply_view:
376
348
views.check_path_in_view(working_tree, relpath)
377
349
specific_files.append(relpath)
378
350
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
379
351
basis_is_default=working_tree is None)
382
353
# Get the specific files (all files is None, no files is [])
383
354
if make_paths_wt_relative and working_tree is not None:
384
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,
386
358
apply_view=apply_view)
359
except errors.FileInWrongBranch:
360
raise errors.BzrCommandError("Files are in different branches")
387
361
specific_files.extend(other_paths)
388
362
if len(specific_files) == 0:
389
363
specific_files = None
399
373
extra_trees = None
400
374
if working_tree is not None and working_tree not in (old_tree, new_tree):
401
375
extra_trees = (working_tree,)
402
return (old_tree, new_tree, old_branch, new_branch,
403
specific_files, extra_trees)
376
return old_tree, new_tree, specific_files, extra_trees
406
378
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
407
379
if branch is None and tree is not None:
422
394
old_label='a/', new_label='b/',
423
395
extra_trees=None,
424
396
path_encoding='utf8',
427
398
"""Show in text form the changes from one tree to another.
429
:param to_file: The output stream.
430
:param specific_files: Include only changes to these files - None for all
432
:param external_diff_options: If set, use an external GNU diff and pass
434
:param extra_trees: If set, more Trees to use for looking up file ids
435
:param path_encoding: If set, the path will be encoded as specified,
436
otherwise is supposed to be utf8
437
: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
439
if format_cls is None:
440
format_cls = DiffTree
441
416
old_tree.lock_read()
443
418
if extra_trees is not None:
446
421
new_tree.lock_read()
448
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
450
external_diff_options,
451
old_label, new_label, using)
423
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
425
external_diff_options,
426
old_label, new_label, using)
452
427
return differ.show_diff(specific_files, extra_trees)
454
429
new_tree.unlock()
666
638
def _get_text(tree, file_id, path):
667
639
if file_id is not None:
668
return tree.get_file_lines(file_id, path)
640
return tree.get_file(file_id, path).readlines()
672
644
from_text = _get_text(self.old_tree, from_file_id, from_path)
673
645
to_text = _get_text(self.new_tree, to_file_id, to_path)
674
646
self.text_differ(from_label, from_text, to_label, to_text,
675
self.to_file, path_encoding=self.path_encoding)
676
648
except errors.BinaryFile:
677
649
self.to_file.write(
678
650
("Binary files %s and %s differ\n" %
679
(from_label, to_label)).encode(self.path_encoding,'replace'))
651
(from_label, to_label)).encode(self.path_encoding))
680
652
return self.CHANGED
692
664
def from_string(klass, command_string, old_tree, new_tree, to_file,
693
665
path_encoding='utf-8'):
694
command_template = cmdline.split(command_string)
695
if '@' not in command_string:
696
command_template.extend(['@old_path', '@new_path'])
666
command_template = commands.shlex_split_unicode(command_string)
667
command_template.extend(['%(old_path)s', '%(new_path)s'])
697
668
return klass(command_template, old_tree, new_tree, to_file,
701
def make_from_diff_tree(klass, command_string, external_diff_options=None):
672
def make_from_diff_tree(klass, command_string):
702
673
def from_diff_tree(diff_tree):
703
full_command_string = [command_string]
704
if external_diff_options is not None:
705
full_command_string += ' ' + external_diff_options
706
return klass.from_string(full_command_string, diff_tree.old_tree,
674
return klass.from_string(command_string, diff_tree.old_tree,
707
675
diff_tree.new_tree, diff_tree.to_file)
708
676
return from_diff_tree
710
678
def _get_command(self, old_path, new_path):
711
679
my_map = {'old_path': old_path, 'new_path': new_path}
712
command = [AtTemplate(t).substitute(my_map) for t in
713
self.command_template]
714
if sys.platform == 'win32': # Popen doesn't accept unicode on win32
717
if isinstance(c, unicode):
718
command_encoded.append(c.encode('mbcs'))
720
command_encoded.append(c)
721
return command_encoded
680
return [t % my_map for t in self.command_template]
725
682
def _execute(self, old_path, new_path):
726
683
command = self._get_command(old_path, new_path)
751
"""Returns safe encoding for passing file path to diff tool"""
752
if sys.platform == 'win32':
755
# Don't fallback to 'utf-8' because subprocess may not be able to
756
# handle utf-8 correctly when locale is not utf-8.
757
return sys.getfilesystemencoding() or 'ascii'
759
def _is_safepath(self, path):
760
"""Return true if `path` may be able to pass to subprocess."""
763
return path == path.encode(fenc).decode(fenc)
767
def _safe_filename(self, prefix, relpath):
768
"""Replace unsafe character in `relpath` then join `self._root`,
769
`prefix` and `relpath`."""
771
# encoded_str.replace('?', '_') may break multibyte char.
772
# So we should encode, decode, then replace(u'?', u'_')
773
relpath_tmp = relpath.encode(fenc, 'replace').decode(fenc, 'replace')
774
relpath_tmp = relpath_tmp.replace(u'?', u'_')
775
return osutils.pathjoin(self._root, prefix, relpath_tmp)
777
def _write_file(self, file_id, tree, prefix, relpath, force_temp=False,
779
if not force_temp and isinstance(tree, WorkingTree):
780
full_path = tree.abspath(tree.id2path(file_id))
781
if self._is_safepath(full_path):
784
full_path = self._safe_filename(prefix, relpath)
785
if not force_temp and self._try_symlink_root(tree, prefix):
706
def _write_file(self, file_id, tree, prefix, relpath):
707
full_path = osutils.pathjoin(self._root, prefix, relpath)
708
if self._try_symlink_root(tree, prefix):
787
710
parent_dir = osutils.dirname(full_path)
803
mtime = tree.get_file_mtime(file_id)
804
except errors.FileTimestampUnavailable:
807
os.utime(full_path, (mtime, mtime))
809
osutils.make_readonly(full_path)
725
osutils.make_readonly(full_path)
726
mtime = tree.get_file_mtime(file_id)
727
os.utime(full_path, (mtime, mtime))
812
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
813
allow_write_new=False):
730
def _prepare_files(self, file_id, old_path, new_path):
814
731
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
815
old_path, force_temp)
816
733
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
817
new_path, force_temp,
818
allow_write=allow_write_new)
819
735
return old_disk_path, new_disk_path
821
737
def finish(self):
823
osutils.rmtree(self._root)
825
if e.errno != errno.ENOENT:
826
mutter("The temporary directory \"%s\" was not "
827
"cleanly removed: %s." % (self._root, e))
738
osutils.rmtree(self._root)
829
740
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
830
741
if (old_kind, new_kind) != ('file', 'file'):
831
742
return DiffPath.CANNOT_DIFF
832
(old_disk_path, new_disk_path) = self._prepare_files(
833
file_id, old_path, new_path)
834
self._execute(old_disk_path, new_disk_path)
836
def edit_file(self, file_id):
837
"""Use this tool to edit a file.
839
A temporary copy will be edited, and the new contents will be
842
:param file_id: The id of the file to edit.
843
:return: The new contents of the file.
845
old_path = self.old_tree.id2path(file_id)
846
new_path = self.new_tree.id2path(file_id)
847
old_abs_path, new_abs_path = self._prepare_files(
848
file_id, old_path, new_path,
849
allow_write_new=True,
851
command = self._get_command(old_abs_path, new_abs_path)
852
subprocess.call(command, cwd=self._root)
853
new_file = open(new_abs_path, 'rb')
855
return new_file.read()
743
self._prepare_files(file_id, old_path, new_path)
744
self._execute(osutils.pathjoin('old', old_path),
745
osutils.pathjoin('new', new_path))
860
748
class DiffTree(object):
918
805
:param using: Commandline to use to invoke an external diff tool
920
807
if using is not None:
921
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
808
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
923
810
extra_factories = []
924
811
if external_diff_options:
925
812
opts = external_diff_options.split()
926
def diff_file(olab, olines, nlab, nlines, to_file, path_encoding=None):
927
""":param path_encoding: not used but required
928
to match the signature of internal_diff.
813
def diff_file(olab, olines, nlab, nlines, to_file):
930
814
external_diff(olab, olines, nlab, nlines, to_file, opts)
932
816
diff_file = internal_diff
added
removed
bzrlib/diff.py
