201
126
diffcmd.append('-u')
204
129
diffcmd.extend(diff_opts)
206
pipe = _spawn_external_diff(diffcmd, capture_errors=True)
207
out,err = pipe.communicate()
210
# internal_diff() adds a trailing newline, add one here for consistency
213
# 'diff' gives retcode == 2 for all sorts of errors
214
# one of those is 'Binary files differ'.
215
# Bad options could also be the problem.
216
# 'Binary files' is not a real error, so we suppress that error.
219
# Since we got here, we want to make sure to give an i18n error
220
pipe = _spawn_external_diff(diffcmd, capture_errors=False)
221
out, err = pipe.communicate()
223
# Write out the new i18n diff response
224
to_file.write(out+'\n')
225
if pipe.returncode != 2:
226
raise errors.BzrError(
227
'external diff failed with exit code 2'
228
' when run with LANG=C and LC_ALL=C,'
229
' but not when run natively: %r' % (diffcmd,))
231
first_line = lang_c_out.split('\n', 1)[0]
232
# Starting with diffutils 2.8.4 the word "binary" was dropped.
233
m = re.match('^(binary )?files.*differ$', first_line, re.I)
235
raise errors.BzrError('external diff failed with exit code 2;'
236
' command: %r' % (diffcmd,))
238
# Binary files differ, just return
241
# If we got to here, we haven't written out the output of diff
131
rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
133
if rc != 0 and rc != 1:
245
134
# returns 1 if files differ; that's OK
247
136
msg = 'signal %d' % (-rc)
249
138
msg = 'exit code %d' % rc
251
raise errors.BzrError('external diff failed with %s; command: %r'
140
raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
256
142
oldtmpf.close() # and delete
258
# Clean up. Warn in case the files couldn't be deleted
259
# (in case windows still holds the file open, but not
260
# if the files have already been deleted)
262
os.remove(old_abspath)
264
if e.errno not in (errno.ENOENT,):
265
warning('Failed to delete temporary file: %s %s',
268
os.remove(new_abspath)
270
if e.errno not in (errno.ENOENT,):
271
warning('Failed to delete temporary file: %s %s',
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
147
def show_diff(b, revision, specific_files, external_diff_options=None,
148
revision2=None, output=None):
149
"""Shortcut for showing the diff to the working tree.
155
None for each, or otherwise the old revision to compare against.
157
The more general form is show_diff_trees(), where the caller
158
supplies any two trees.
301
# Get the old and new revision specs
302
old_revision_spec = None
303
new_revision_spec = None
304
if revision_specs is not None:
305
if len(revision_specs) > 0:
306
old_revision_spec = revision_specs[0]
308
old_url = old_revision_spec.get_branch()
309
if len(revision_specs) > 1:
310
new_revision_spec = revision_specs[1]
312
new_url = new_revision_spec.get_branch()
315
make_paths_wt_relative = True
316
consider_relpath = True
317
if path_list is None or len(path_list) == 0:
318
# If no path is given, the current working tree is used
319
default_location = u'.'
320
consider_relpath = False
321
elif old_url is not None and new_url is not None:
322
other_paths = path_list
323
make_paths_wt_relative = False
325
default_location = path_list[0]
326
other_paths = path_list[1:]
328
# Get the old location
331
old_url = default_location
332
working_tree, branch, relpath = \
333
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
334
if consider_relpath and relpath != '':
335
if working_tree is not None and apply_view:
336
views.check_path_in_view(working_tree, relpath)
337
specific_files.append(relpath)
338
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
340
# Get the new location
342
new_url = default_location
343
if new_url != old_url:
344
working_tree, branch, relpath = \
345
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
346
if consider_relpath and relpath != '':
347
if working_tree is not None and apply_view:
348
views.check_path_in_view(working_tree, relpath)
349
specific_files.append(relpath)
350
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
351
basis_is_default=working_tree is None)
353
# Get the specific files (all files is None, no files is [])
354
if make_paths_wt_relative and working_tree is not None:
356
from bzrlib.builtins import safe_relpath_files
357
other_paths = safe_relpath_files(working_tree, other_paths,
358
apply_view=apply_view)
359
except errors.FileInWrongBranch:
360
raise errors.BzrCommandError("Files are in different branches")
361
specific_files.extend(other_paths)
362
if len(specific_files) == 0:
363
specific_files = None
364
if (working_tree is not None and working_tree.supports_views()
366
view_files = working_tree.views.lookup_view()
368
specific_files = view_files
369
view_str = views.view_display_str(view_files)
370
note("*** ignoring files outside view: %s" % view_str)
372
# Get extra trees that ought to be searched for file-ids
374
if working_tree is not None and working_tree not in (old_tree, new_tree):
375
extra_trees = (working_tree,)
376
return old_tree, new_tree, specific_files, extra_trees
378
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
379
if branch is None and tree is not None:
381
if spec is None or spec.spec is None:
384
return tree.basis_tree()
386
return branch.basis_tree()
389
return spec.as_tree(branch)
165
old_tree = b.basis_tree()
167
old_tree = b.revision_tree(b.lookup_revision(revision))
169
if revision2 == None:
170
new_tree = b.working_tree()
172
new_tree = b.revision_tree(b.lookup_revision(revision2))
174
show_diff_trees(old_tree, new_tree, output, specific_files,
175
external_diff_options)
392
179
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
393
external_diff_options=None,
394
old_label='a/', new_label='b/',
396
path_encoding='utf8',
180
external_diff_options=None):
398
181
"""Show in text form the changes from one tree to another.
404
Include only changes to these files - None for all changes.
184
If set, include only changes to these files.
406
186
external_diff_options
407
187
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
418
if extra_trees is not None:
419
for tree in extra_trees:
423
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
425
external_diff_options,
426
old_label, new_label, using)
427
return differ.show_diff(specific_files, extra_trees)
430
if extra_trees is not None:
431
for tree in extra_trees:
437
def _patch_header_date(tree, file_id, path):
438
"""Returns a timestamp suitable for use in a patch header."""
439
mtime = tree.get_file_mtime(file_id, path)
440
return timestamp.format_patch_date(mtime)
443
def get_executable_change(old_is_x, new_is_x):
444
descr = { True:"+x", False:"-x", None:"??" }
445
if old_is_x != new_is_x:
446
return ["%s to %s" % (descr[old_is_x], descr[new_is_x],)]
190
# TODO: Options to control putting on a prefix or suffix, perhaps as a format string
194
DEVNULL = '/dev/null'
195
# Windows users, don't panic about this filename -- it is a
196
# special signal to GNU patch that the file should be created or
197
# deleted respectively.
199
# TODO: Generation of pseudo-diffs for added/deleted files could
200
# be usefully made into a much faster special case.
202
if external_diff_options:
203
assert isinstance(external_diff_options, basestring)
204
opts = external_diff_options.split()
205
def diff_file(olab, olines, nlab, nlines, to_file):
206
external_diff(olab, olines, nlab, nlines, to_file, opts)
451
class DiffPath(object):
452
"""Base type for command object that compare files"""
454
# The type or contents of the file were unsuitable for diffing
455
CANNOT_DIFF = 'CANNOT_DIFF'
456
# The file has changed in a semantic way
458
# The file content may have changed, but there is no semantic change
459
UNCHANGED = 'UNCHANGED'
461
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8'):
464
:param old_tree: The tree to show as the old tree in the comparison
465
:param new_tree: The tree to show as new in the comparison
466
:param to_file: The file to write comparison data to
467
:param path_encoding: The character encoding to write paths in
469
self.old_tree = old_tree
470
self.new_tree = new_tree
471
self.to_file = to_file
472
self.path_encoding = path_encoding
478
def from_diff_tree(klass, diff_tree):
479
return klass(diff_tree.old_tree, diff_tree.new_tree,
480
diff_tree.to_file, diff_tree.path_encoding)
483
def _diff_many(differs, file_id, old_path, new_path, old_kind, new_kind):
484
for file_differ in differs:
485
result = file_differ.diff(file_id, old_path, new_path, old_kind,
487
if result is not DiffPath.CANNOT_DIFF:
490
return DiffPath.CANNOT_DIFF
493
class DiffKindChange(object):
494
"""Special differ for file kind changes.
496
Represents kind change as deletion + creation. Uses the other differs
499
def __init__(self, differs):
500
self.differs = differs
506
def from_diff_tree(klass, diff_tree):
507
return klass(diff_tree.differs)
509
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
510
"""Perform comparison
512
:param file_id: The file_id of the file to compare
513
:param old_path: Path of the file in the old tree
514
:param new_path: Path of the file in the new tree
515
:param old_kind: Old file-kind of the file
516
:param new_kind: New file-kind of the file
518
if None in (old_kind, new_kind):
519
return DiffPath.CANNOT_DIFF
520
result = DiffPath._diff_many(self.differs, file_id, old_path,
521
new_path, old_kind, None)
522
if result is DiffPath.CANNOT_DIFF:
524
return DiffPath._diff_many(self.differs, file_id, old_path, new_path,
528
class DiffDirectory(DiffPath):
530
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
531
"""Perform comparison between two directories. (dummy)
534
if 'directory' not in (old_kind, new_kind):
535
return self.CANNOT_DIFF
536
if old_kind not in ('directory', None):
537
return self.CANNOT_DIFF
538
if new_kind not in ('directory', None):
539
return self.CANNOT_DIFF
543
class DiffSymlink(DiffPath):
545
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
546
"""Perform comparison between two symlinks
548
:param file_id: The file_id of the file to compare
549
:param old_path: Path of the file in the old tree
550
:param new_path: Path of the file in the new tree
551
:param old_kind: Old file-kind of the file
552
:param new_kind: New file-kind of the file
554
if 'symlink' not in (old_kind, new_kind):
555
return self.CANNOT_DIFF
556
if old_kind == 'symlink':
557
old_target = self.old_tree.get_symlink_target(file_id)
558
elif old_kind is None:
561
return self.CANNOT_DIFF
562
if new_kind == 'symlink':
563
new_target = self.new_tree.get_symlink_target(file_id)
564
elif new_kind is None:
567
return self.CANNOT_DIFF
568
return self.diff_symlink(old_target, new_target)
570
def diff_symlink(self, old_target, new_target):
571
if old_target is None:
572
self.to_file.write('=== target is %r\n' % new_target)
573
elif new_target is None:
574
self.to_file.write('=== target was %r\n' % old_target)
576
self.to_file.write('=== target changed %r => %r\n' %
577
(old_target, new_target))
581
class DiffText(DiffPath):
583
# GNU Patch uses the epoch date to detect files that are being added
584
# or removed in a diff.
585
EPOCH_DATE = '1970-01-01 00:00:00 +0000'
587
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
588
old_label='', new_label='', text_differ=internal_diff):
589
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
590
self.text_differ = text_differ
591
self.old_label = old_label
592
self.new_label = new_label
593
self.path_encoding = path_encoding
595
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
596
"""Compare two files in unified diff format
598
:param file_id: The file_id of the file to compare
599
:param old_path: Path of the file in the old tree
600
:param new_path: Path of the file in the new tree
601
:param old_kind: Old file-kind of the file
602
:param new_kind: New file-kind of the file
604
if 'file' not in (old_kind, new_kind):
605
return self.CANNOT_DIFF
606
from_file_id = to_file_id = file_id
607
if old_kind == 'file':
608
old_date = _patch_header_date(self.old_tree, file_id, old_path)
609
elif old_kind is None:
610
old_date = self.EPOCH_DATE
613
return self.CANNOT_DIFF
614
if new_kind == 'file':
615
new_date = _patch_header_date(self.new_tree, file_id, new_path)
616
elif new_kind is None:
617
new_date = self.EPOCH_DATE
620
return self.CANNOT_DIFF
621
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
622
to_label = '%s%s\t%s' % (self.new_label, new_path, new_date)
623
return self.diff_text(from_file_id, to_file_id, from_label, to_label)
625
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
626
"""Diff the content of given files in two trees
628
:param from_file_id: The id of the file in the from tree. If None,
629
the file is not present in the from tree.
630
:param to_file_id: The id of the file in the to tree. This may refer
631
to a different file from from_file_id. If None,
632
the file is not present in the to tree.
634
def _get_text(tree, file_id):
635
if file_id is not None:
636
return tree.get_file(file_id).readlines()
640
from_text = _get_text(self.old_tree, from_file_id)
641
to_text = _get_text(self.new_tree, to_file_id)
642
self.text_differ(from_label, from_text, to_label, to_text,
644
except errors.BinaryFile:
646
("Binary files %s and %s differ\n" %
647
(from_label, to_label)).encode(self.path_encoding))
651
class DiffFromTool(DiffPath):
653
def __init__(self, command_template, old_tree, new_tree, to_file,
654
path_encoding='utf-8'):
655
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
656
self.command_template = command_template
657
self._root = osutils.mkdtemp(prefix='bzr-diff-')
660
def from_string(klass, command_string, old_tree, new_tree, to_file,
661
path_encoding='utf-8'):
662
command_template = commands.shlex_split_unicode(command_string)
663
command_template.extend(['%(old_path)s', '%(new_path)s'])
664
return klass(command_template, old_tree, new_tree, to_file,
668
def make_from_diff_tree(klass, command_string):
669
def from_diff_tree(diff_tree):
670
return klass.from_string(command_string, diff_tree.old_tree,
671
diff_tree.new_tree, diff_tree.to_file)
672
return from_diff_tree
674
def _get_command(self, old_path, new_path):
675
my_map = {'old_path': old_path, 'new_path': new_path}
676
return [t % my_map for t in self.command_template]
678
def _execute(self, old_path, new_path):
679
command = self._get_command(old_path, new_path)
681
proc = subprocess.Popen(command, stdout=subprocess.PIPE,
684
if e.errno == errno.ENOENT:
685
raise errors.ExecutableMissing(command[0])
688
self.to_file.write(proc.stdout.read())
691
def _try_symlink_root(self, tree, prefix):
692
if (getattr(tree, 'abspath', None) is None
693
or not osutils.host_os_dereferences_symlinks()):
696
os.symlink(tree.abspath(''), osutils.pathjoin(self._root, prefix))
698
if e.errno != errno.EEXIST:
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):
706
parent_dir = osutils.dirname(full_path)
708
os.makedirs(parent_dir)
710
if e.errno != errno.EEXIST:
712
source = tree.get_file(file_id, relpath)
714
target = open(full_path, 'wb')
716
osutils.pumpfile(source, target)
721
osutils.make_readonly(full_path)
722
mtime = tree.get_file_mtime(file_id)
723
os.utime(full_path, (mtime, mtime))
726
def _prepare_files(self, file_id, old_path, new_path):
727
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
729
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
731
return old_disk_path, new_disk_path
734
osutils.rmtree(self._root)
736
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
737
if (old_kind, new_kind) != ('file', 'file'):
738
return DiffPath.CANNOT_DIFF
739
self._prepare_files(file_id, old_path, new_path)
740
self._execute(osutils.pathjoin('old', old_path),
741
osutils.pathjoin('new', new_path))
744
class DiffTree(object):
745
"""Provides textual representations of the difference between two trees.
747
A DiffTree examines two trees and where a file-id has altered
748
between them, generates a textual representation of the difference.
749
DiffTree uses a sequence of DiffPath objects which are each
750
given the opportunity to handle a given altered fileid. The list
751
of DiffPath objects can be extended globally by appending to
752
DiffTree.diff_factories, or for a specific diff operation by
753
supplying the extra_factories option to the appropriate method.
756
# list of factories that can provide instances of DiffPath objects
757
# may be extended by plugins.
758
diff_factories = [DiffSymlink.from_diff_tree,
759
DiffDirectory.from_diff_tree]
761
def __init__(self, old_tree, new_tree, to_file, path_encoding='utf-8',
762
diff_text=None, extra_factories=None):
765
:param old_tree: Tree to show as old in the comparison
766
:param new_tree: Tree to show as new in the comparison
767
:param to_file: File to write comparision to
768
:param path_encoding: Character encoding to write paths in
769
:param diff_text: DiffPath-type object to use as a last resort for
771
:param extra_factories: Factories of DiffPaths to try before any other
773
if diff_text is None:
774
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
775
'', '', internal_diff)
776
self.old_tree = old_tree
777
self.new_tree = new_tree
778
self.to_file = to_file
779
self.path_encoding = path_encoding
781
if extra_factories is not None:
782
self.differs.extend(f(self) for f in extra_factories)
783
self.differs.extend(f(self) for f in self.diff_factories)
784
self.differs.extend([diff_text, DiffKindChange.from_diff_tree(self)])
787
def from_trees_options(klass, old_tree, new_tree, to_file,
788
path_encoding, external_diff_options, old_label,
790
"""Factory for producing a DiffTree.
792
Designed to accept options used by show_diff_trees.
793
:param old_tree: The tree to show as old in the comparison
794
:param new_tree: The tree to show as new in the comparison
795
:param to_file: File to write comparisons to
796
:param path_encoding: Character encoding to use for writing paths
797
:param external_diff_options: If supplied, use the installed diff
798
binary to perform file comparison, using supplied options.
799
:param old_label: Prefix to use for old file labels
800
:param new_label: Prefix to use for new file labels
801
:param using: Commandline to use to invoke an external diff tool
803
if using is not None:
804
extra_factories = [DiffFromTool.make_from_diff_tree(using)]
807
if external_diff_options:
808
opts = external_diff_options.split()
809
def diff_file(olab, olines, nlab, nlines, to_file):
810
external_diff(olab, olines, nlab, nlines, to_file, opts)
812
diff_file = internal_diff
813
diff_text = DiffText(old_tree, new_tree, to_file, path_encoding,
814
old_label, new_label, diff_file)
815
return klass(old_tree, new_tree, to_file, path_encoding, diff_text,
818
def show_diff(self, specific_files, extra_trees=None):
819
"""Write tree diff to self.to_file
821
:param sepecific_files: the specific files to compare (recursive)
822
:param extra_trees: extra trees to use for mapping paths to file_ids
825
return self._show_diff(specific_files, extra_trees)
827
for differ in self.differs:
830
def _show_diff(self, specific_files, extra_trees):
831
# TODO: Generation of pseudo-diffs for added/deleted files could
832
# be usefully made into a much faster special case.
833
iterator = self.new_tree.iter_changes(self.old_tree,
834
specific_files=specific_files,
835
extra_trees=extra_trees,
836
require_versioned=True)
838
def changes_key(change):
839
old_path, new_path = change[1]
844
def get_encoded_path(path):
846
return path.encode(self.path_encoding, "replace")
847
for (file_id, paths, changed_content, versioned, parent, name, kind,
848
executable) in sorted(iterator, key=changes_key):
849
# The root does not get diffed, and items with no known kind (that
850
# is, missing) in both trees are skipped as well.
851
if parent == (None, None) or kind == (None, None):
853
oldpath, newpath = paths
854
oldpath_encoded = get_encoded_path(paths[0])
855
newpath_encoded = get_encoded_path(paths[1])
856
old_present = (kind[0] is not None and versioned[0])
857
new_present = (kind[1] is not None and versioned[1])
858
renamed = (parent[0], name[0]) != (parent[1], name[1])
860
properties_changed = []
861
properties_changed.extend(get_executable_change(executable[0], executable[1]))
863
if properties_changed:
864
prop_str = " (properties changed: %s)" % (", ".join(properties_changed),)
868
if (old_present, new_present) == (True, False):
869
self.to_file.write("=== removed %s '%s'\n" %
870
(kind[0], oldpath_encoded))
872
elif (old_present, new_present) == (False, True):
873
self.to_file.write("=== added %s '%s'\n" %
874
(kind[1], newpath_encoded))
877
self.to_file.write("=== renamed %s '%s' => '%s'%s\n" %
878
(kind[0], oldpath_encoded, newpath_encoded, prop_str))
880
# if it was produced by iter_changes, it must be
881
# modified *somehow*, either content or execute bit.
882
self.to_file.write("=== modified %s '%s'%s\n" % (kind[0],
883
newpath_encoded, prop_str))
885
self.diff(file_id, oldpath, newpath)
891
def diff(self, file_id, old_path, new_path):
892
"""Perform a diff of a single file
894
:param file_id: file-id of the file
895
:param old_path: The path of the file in the old tree
896
:param new_path: The path of the file in the new tree
899
old_kind = self.old_tree.kind(file_id)
900
except (errors.NoSuchId, errors.NoSuchFile):
903
new_kind = self.new_tree.kind(file_id)
904
except (errors.NoSuchId, errors.NoSuchFile):
907
result = DiffPath._diff_many(self.differs, file_id, old_path,
908
new_path, old_kind, new_kind)
909
if result is DiffPath.CANNOT_DIFF:
910
error_path = new_path
911
if error_path is None:
912
error_path = old_path
913
raise errors.NoDiffFound(error_path)
208
diff_file = internal_diff
211
delta = compare_trees(old_tree, new_tree, want_unchanged=False,
212
specific_files=specific_files)
214
for path, file_id, kind in delta.removed:
215
print >>to_file, '=== removed %s %r' % (kind, path)
217
diff_file(old_label + path,
218
old_tree.get_file(file_id).readlines(),
223
for path, file_id, kind in delta.added:
224
print >>to_file, '=== added %s %r' % (kind, path)
229
new_tree.get_file(file_id).readlines(),
232
for old_path, new_path, file_id, kind, text_modified in delta.renamed:
233
print >>to_file, '=== renamed %s %r => %r' % (kind, old_path, new_path)
235
diff_file(old_label + old_path,
236
old_tree.get_file(file_id).readlines(),
237
new_label + new_path,
238
new_tree.get_file(file_id).readlines(),
241
for path, file_id, kind in delta.modified:
242
print >>to_file, '=== modified %s %r' % (kind, path)
244
diff_file(old_label + path,
245
old_tree.get_file(file_id).readlines(),
247
new_tree.get_file(file_id).readlines(),
added
removed
bzrlib/diff.py
