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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23
23
from bzrlib.lazy_import import lazy_import
29
30
from bzrlib import (
31
branch as _mod_branch,
41
from bzrlib.workingtree import WorkingTree
44
from bzrlib.registry import (
47
from bzrlib.trace import mutter, note, warning
50
class AtTemplate(string.Template):
51
"""Templating class that uses @ instead of $."""
42
from bzrlib.symbol_versioning import (
46
from bzrlib.trace import mutter, warning
56
49
# TODO: Rather than building a changeset object, we should probably
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):
278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
289
279
"""Get the trees and specific files to diff given a list of paths.
291
281
This method works out the trees to be diff'ed and the files of
303
293
The url of the new branch or tree. If None, the tree to use is
304
294
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.
309
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
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
318
300
# Get the old and new revision specs
319
301
old_revision_spec = None
342
324
default_location = path_list[0]
343
325
other_paths = path_list[1:]
345
def lock_tree_or_branch(wt, br):
348
add_cleanup(wt.unlock)
351
add_cleanup(br.unlock)
353
327
# Get the old location
354
328
specific_files = []
355
329
if old_url is None:
356
330
old_url = default_location
357
331
working_tree, branch, relpath = \
358
332
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
359
lock_tree_or_branch(working_tree, branch)
360
333
if consider_relpath and relpath != '':
361
if working_tree is not None and apply_view:
362
views.check_path_in_view(working_tree, relpath)
363
334
specific_files.append(relpath)
364
335
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
367
337
# Get the new location
368
338
if new_url is None:
370
340
if new_url != old_url:
371
341
working_tree, branch, relpath = \
372
342
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
373
lock_tree_or_branch(working_tree, branch)
374
343
if consider_relpath and relpath != '':
375
if working_tree is not None and apply_view:
376
views.check_path_in_view(working_tree, relpath)
377
344
specific_files.append(relpath)
378
345
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
379
346
basis_is_default=working_tree is None)
382
348
# Get the specific files (all files is None, no files is [])
383
349
if make_paths_wt_relative and working_tree is not None:
384
other_paths = working_tree.safe_relpath_files(
386
apply_view=apply_view)
350
other_paths = _relative_paths_in_tree(working_tree, other_paths)
387
351
specific_files.extend(other_paths)
388
352
if len(specific_files) == 0:
389
353
specific_files = None
390
if (working_tree is not None and working_tree.supports_views()
392
view_files = working_tree.views.lookup_view()
394
specific_files = view_files
395
view_str = views.view_display_str(view_files)
396
note("*** Ignoring files outside view. View is %s" % view_str)
398
355
# Get extra trees that ought to be searched for file-ids
399
356
extra_trees = None
400
357
if working_tree is not None and working_tree not in (old_tree, new_tree):
401
358
extra_trees = (working_tree,)
402
return (old_tree, new_tree, old_branch, new_branch,
403
specific_files, extra_trees)
359
return old_tree, new_tree, specific_files, extra_trees
406
362
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
414
370
return branch.basis_tree()
417
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)
379
def _relative_paths_in_tree(tree, paths):
380
"""Get the relative paths within a working tree.
382
Each path may be either an absolute path or a path relative to the
383
current working directory.
386
for filename in paths:
388
result.append(tree.relpath(osutils.dereference_path(filename)))
389
except errors.PathNotChild:
390
raise errors.BzrCommandError("Files are in different branches")
420
394
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
422
396
old_label='a/', new_label='b/',
423
397
extra_trees=None,
424
398
path_encoding='utf8',
427
400
"""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)
406
Include only changes to these files - None for all changes.
408
external_diff_options
409
If set, use an external GNU diff and pass these options.
412
If set, more Trees to use for looking up file ids
415
If set, the path will be encoded as specified, otherwise is supposed
439
if format_cls is None:
440
format_cls = DiffTree
441
418
old_tree.lock_read()
443
420
if extra_trees is not None:
446
423
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)
425
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
427
external_diff_options,
428
old_label, new_label, using)
452
429
return differ.show_diff(specific_files, extra_trees)
454
431
new_tree.unlock()
462
439
def _patch_header_date(tree, file_id, path):
463
440
"""Returns a timestamp suitable for use in a patch header."""
465
mtime = tree.get_file_mtime(file_id, path)
466
except errors.FileTimestampUnavailable:
441
mtime = tree.get_file_mtime(file_id, path)
468
442
return timestamp.format_patch_date(mtime)
445
def _raise_if_nonexistent(paths, old_tree, new_tree):
446
"""Complain if paths are not in either inventory or tree.
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.
451
This can be used by operations such as bzr status that can accept
452
unknown or ignored files.
454
mutter("check paths: %r", paths)
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)]
461
raise errors.PathsDoNotExist(sorted(s))
464
@deprecated_function(one_three)
465
def get_prop_change(meta_modified):
467
return " (properties changed)"
471
471
def get_executable_change(old_is_x, new_is_x):
472
472
descr = { True:"+x", False:"-x", None:"??" }
473
473
if old_is_x != new_is_x:
648
648
return self.CANNOT_DIFF
649
649
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
650
650
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
651
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
651
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
654
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
655
from_path=None, to_path=None):
653
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
656
654
"""Diff the content of given files in two trees
658
656
:param from_file_id: The id of the file in the from tree. If None,
660
658
:param to_file_id: The id of the file in the to tree. This may refer
661
659
to a different file from from_file_id. If None,
662
660
the file is not present in the to tree.
663
:param from_path: The path in the from tree or None if unknown.
664
:param to_path: The path in the to tree or None if unknown.
666
def _get_text(tree, file_id, path):
662
def _get_text(tree, file_id):
667
663
if file_id is not None:
668
return tree.get_file_lines(file_id, path)
664
return tree.get_file(file_id).readlines()
672
from_text = _get_text(self.old_tree, from_file_id, from_path)
673
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)
674
670
self.text_differ(from_label, from_text, to_label, to_text,
675
self.to_file, path_encoding=self.path_encoding)
676
672
except errors.BinaryFile:
677
673
self.to_file.write(
678
674
("Binary files %s and %s differ\n" %
679
(from_label, to_label)).encode(self.path_encoding,'replace'))
675
(from_label, to_label)).encode(self.path_encoding))
680
676
return self.CHANGED
686
682
path_encoding='utf-8'):
687
683
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
688
684
self.command_template = command_template
689
self._root = osutils.mkdtemp(prefix='bzr-diff-')
685
self._root = tempfile.mkdtemp(prefix='bzr-diff-')
692
688
def from_string(klass, command_string, old_tree, new_tree, to_file,
693
689
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'])
690
command_template = commands.shlex_split_unicode(command_string)
691
command_template.extend(['%(old_path)s', '%(new_path)s'])
697
692
return klass(command_template, old_tree, new_tree, to_file,
701
def make_from_diff_tree(klass, command_string, external_diff_options=None):
696
def make_from_diff_tree(klass, command_string):
702
697
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,
698
return klass.from_string(command_string, diff_tree.old_tree,
707
699
diff_tree.new_tree, diff_tree.to_file)
708
700
return from_diff_tree
710
702
def _get_command(self, old_path, new_path):
711
703
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
704
return [t % my_map for t in self.command_template]
725
706
def _execute(self, old_path, new_path):
726
707
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):
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):
787
734
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)
749
osutils.make_readonly(full_path)
750
mtime = tree.get_file_mtime(file_id)
751
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):
754
def _prepare_files(self, file_id, old_path, new_path):
814
755
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
815
old_path, force_temp)
816
757
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
817
new_path, force_temp,
818
allow_write=allow_write_new)
819
759
return old_disk_path, new_disk_path
821
761
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))
762
osutils.rmtree(self._root)
829
764
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
830
765
if (old_kind, new_kind) != ('file', 'file'):
831
766
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()
767
self._prepare_files(file_id, old_path, new_path)
768
self._execute(osutils.pathjoin('old', old_path),
769
osutils.pathjoin('new', new_path))
860
772
class DiffTree(object):
918
829
:param using: Commandline to use to invoke an external diff tool
920
831
if using is not None:
921
extra_factories = [DiffFromTool.make_from_diff_tree(using, external_diff_options)]
832
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
923
834
extra_factories = []
924
835
if external_diff_options:
925
836
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.
837
def diff_file(olab, olines, nlab, nlines, to_file):
930
838
external_diff(olab, olines, nlab, nlines, to_file, opts)
932
840
diff_file = internal_diff
1023
931
new_kind = self.new_tree.kind(file_id)
1024
932
except (errors.NoSuchId, errors.NoSuchFile):
1026
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1029
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
1030
935
result = DiffPath._diff_many(self.differs, file_id, old_path,
1031
936
new_path, old_kind, new_kind)
1032
937
if result is DiffPath.CANNOT_DIFF: