278
def _get_trees_to_diff(path_list, revision_specs, old_url, new_url):
279
"""Get the trees and specific files to diff given a list of paths.
281
This method works out the trees to be diff'ed and the files of
282
interest within those trees.
285
the list of arguments passed to the diff command
286
:param revision_specs:
287
Zero, one or two RevisionSpecs from the diff command line,
288
saying what revisions to compare.
290
The url of the old branch or tree. If None, the tree to use is
291
taken from the first path, if any, or the current working tree.
293
The url of the new branch or tree. If None, the tree to use is
294
taken from the first path, if any, or the current working tree.
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
293
@deprecated_function(deprecated_in((2, 2, 0)))
294
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
296
"""Get the trees and specific files to diff given a list of paths.
298
This method works out the trees to be diff'ed and the files of
299
interest within those trees.
302
the list of arguments passed to the diff command
303
:param revision_specs:
304
Zero, one or two RevisionSpecs from the diff command line,
305
saying what revisions to compare.
307
The url of the old branch or tree. If None, the tree to use is
308
taken from the first path, if any, or the current working tree.
310
The url of the new branch or tree. If None, the tree to use is
311
taken from the first path, if any, or the current working tree.
313
if True and a view is set, apply the view or check that the paths
316
a tuple of (old_tree, new_tree, old_branch, new_branch,
317
specific_files, extra_trees) where extra_trees is a sequence of
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
300
357
# Get the old and new revision specs
301
358
old_revision_spec = None
324
381
default_location = path_list[0]
325
382
other_paths = path_list[1:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
327
392
# Get the old location
328
393
specific_files = []
329
394
if old_url is None:
330
395
old_url = default_location
331
396
working_tree, branch, relpath = \
332
397
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
lock_tree_or_branch(working_tree, branch)
333
399
if consider_relpath and relpath != '':
400
if working_tree is not None and apply_view:
401
views.check_path_in_view(working_tree, relpath)
334
402
specific_files.append(relpath)
335
403
old_tree = _get_tree_to_diff(old_revision_spec, working_tree, branch)
337
406
# Get the new location
338
407
if new_url is None:
340
409
if new_url != old_url:
341
410
working_tree, branch, relpath = \
342
411
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
lock_tree_or_branch(working_tree, branch)
343
413
if consider_relpath and relpath != '':
414
if working_tree is not None and apply_view:
415
views.check_path_in_view(working_tree, relpath)
344
416
specific_files.append(relpath)
345
417
new_tree = _get_tree_to_diff(new_revision_spec, working_tree, branch,
346
418
basis_is_default=working_tree is None)
348
421
# Get the specific files (all files is None, no files is [])
349
422
if make_paths_wt_relative and working_tree is not None:
350
other_paths = _relative_paths_in_tree(working_tree, other_paths)
424
from bzrlib.builtins import safe_relpath_files
425
other_paths = safe_relpath_files(working_tree, other_paths,
426
apply_view=apply_view)
427
except errors.FileInWrongBranch:
428
raise errors.BzrCommandError("Files are in different branches")
351
429
specific_files.extend(other_paths)
352
430
if len(specific_files) == 0:
353
431
specific_files = None
432
if (working_tree is not None and working_tree.supports_views()
434
view_files = working_tree.views.lookup_view()
436
specific_files = view_files
437
view_str = views.view_display_str(view_files)
438
note("*** Ignoring files outside view. View is %s" % view_str)
355
440
# Get extra trees that ought to be searched for file-ids
356
441
extra_trees = None
357
442
if working_tree is not None and working_tree not in (old_tree, new_tree):
358
443
extra_trees = (working_tree,)
359
return old_tree, new_tree, specific_files, extra_trees
444
return old_tree, new_tree, old_branch, new_branch, specific_files, extra_trees
362
447
def _get_tree_to_diff(spec, tree=None, branch=None, basis_is_default=True):
370
455
return branch.basis_tree()
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")
458
return spec.as_tree(branch)
394
461
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
396
463
old_label='a/', new_label='b/',
397
464
extra_trees=None,
398
465
path_encoding='utf8',
400
468
"""Show in text form the changes from one tree to another.
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
470
:param to_file: The output stream.
471
:param specific_files:Include only changes to these files - None for all
473
:param external_diff_options: If set, use an external GNU diff and pass
475
:param extra_trees: If set, more Trees to use for looking up file ids
476
:param path_encoding: If set, the path will be encoded as specified,
477
otherwise is supposed to be utf8
478
:param format_cls: Formatter class (DiffTree subclass)
480
if format_cls is None:
481
format_cls = DiffTree
418
482
old_tree.lock_read()
420
484
if extra_trees is not None:
439
503
def _patch_header_date(tree, file_id, path):
440
504
"""Returns a timestamp suitable for use in a patch header."""
441
mtime = tree.get_file_mtime(file_id, path)
506
mtime = tree.get_file_mtime(file_id, path)
507
except errors.FileTimestampUnavailable:
442
509
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
512
def get_executable_change(old_is_x, new_is_x):
472
513
descr = { True:"+x", False:"-x", None:"??" }
473
514
if old_is_x != new_is_x:
648
689
return self.CANNOT_DIFF
649
690
from_label = '%s%s\t%s' % (self.old_label, old_path, old_date)
650
691
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)
692
return self.diff_text(from_file_id, to_file_id, from_label, to_label,
653
def diff_text(self, from_file_id, to_file_id, from_label, to_label):
695
def diff_text(self, from_file_id, to_file_id, from_label, to_label,
696
from_path=None, to_path=None):
654
697
"""Diff the content of given files in two trees
656
699
:param from_file_id: The id of the file in the from tree. If None,
658
701
:param to_file_id: The id of the file in the to tree. This may refer
659
702
to a different file from from_file_id. If None,
660
703
the file is not present in the to tree.
704
:param from_path: The path in the from tree or None if unknown.
705
:param to_path: The path in the to tree or None if unknown.
662
def _get_text(tree, file_id):
707
def _get_text(tree, file_id, path):
663
708
if file_id is not None:
664
return tree.get_file(file_id).readlines()
709
return tree.get_file(file_id, path).readlines()
668
from_text = _get_text(self.old_tree, from_file_id)
669
to_text = _get_text(self.new_tree, to_file_id)
713
from_text = _get_text(self.old_tree, from_file_id, from_path)
714
to_text = _get_text(self.new_tree, to_file_id, to_path)
670
715
self.text_differ(from_label, from_text, to_label, to_text,
672
717
except errors.BinaryFile:
682
727
path_encoding='utf-8'):
683
728
DiffPath.__init__(self, old_tree, new_tree, to_file, path_encoding)
684
729
self.command_template = command_template
685
self._root = tempfile.mkdtemp(prefix='bzr-diff-')
730
self._root = osutils.mkdtemp(prefix='bzr-diff-')
688
733
def from_string(klass, command_string, old_tree, new_tree, to_file,
689
734
path_encoding='utf-8'):
690
command_template = commands.shlex_split_unicode(command_string)
691
command_template.extend(['%(old_path)s', '%(new_path)s'])
735
command_template = cmdline.split(command_string)
736
if '@' not in command_string:
737
command_template.extend(['@old_path', '@new_path'])
692
738
return klass(command_template, old_tree, new_tree, to_file,
730
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))
731
782
full_path = osutils.pathjoin(self._root, prefix, relpath)
732
if self._try_symlink_root(tree, prefix):
783
if not force_temp and self._try_symlink_root(tree, prefix):
734
785
parent_dir = osutils.dirname(full_path)
749
osutils.make_readonly(full_path)
750
mtime = tree.get_file_mtime(file_id)
751
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)
754
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):
755
812
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
757
814
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
816
allow_write=allow_write_new)
759
817
return old_disk_path, new_disk_path
761
819
def finish(self):
762
osutils.rmtree(self._root)
821
osutils.rmtree(self._root)
823
if e.errno != errno.ENOENT:
824
mutter("The temporary directory \"%s\" was not "
825
"cleanly removed: %s." % (self._root, e))
764
827
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
765
828
if (old_kind, new_kind) != ('file', 'file'):
766
829
return DiffPath.CANNOT_DIFF
767
self._prepare_files(file_id, old_path, new_path)
768
self._execute(osutils.pathjoin('old', old_path),
769
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()
772
858
class DiffTree(object):
874
960
return path.encode(self.path_encoding, "replace")
875
961
for (file_id, paths, changed_content, versioned, parent, name, kind,
876
962
executable) in sorted(iterator, key=changes_key):
877
if parent == (None, None):
963
# The root does not get diffed, and items with no known kind (that
964
# is, missing) in both trees are skipped as well.
965
if parent == (None, None) or kind == (None, None):
879
967
oldpath, newpath = paths
880
968
oldpath_encoded = get_encoded_path(paths[0])
929
1017
new_kind = self.new_tree.kind(file_id)
930
1018
except (errors.NoSuchId, errors.NoSuchFile):
1020
self._diff(file_id, old_path, new_path, old_kind, new_kind)
1023
def _diff(self, file_id, old_path, new_path, old_kind, new_kind):
933
1024
result = DiffPath._diff_many(self.differs, file_id, old_path,
934
1025
new_path, old_kind, new_kind)
935
1026
if result is DiffPath.CANNOT_DIFF: