1
# Copyright (C) 2005-2010 Canonical Ltd.
1
# Copyright (C) 2004, 2005, 2006 Canonical Ltd.
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
43
from bzrlib.workingtree import WorkingTree
46
from bzrlib.registry import (
49
43
from bzrlib.symbol_versioning import (
50
44
deprecated_function,
53
46
from bzrlib.trace import mutter, note, warning
56
class AtTemplate(string.Template):
57
"""Templating class that uses @ instead of $."""
62
49
# TODO: Rather than building a changeset object, we should probably
63
50
# invoke callbacks on an object. That object can either accumulate a
64
51
# list, write them out directly, etc etc.
293
@deprecated_function(deprecated_in((2, 2, 0)))
294
280
def get_trees_and_branches_to_diff(path_list, revision_specs, old_url, new_url,
295
281
apply_view=True):
296
282
"""Get the trees and specific files to diff given a list of paths.
316
302
a tuple of (old_tree, new_tree, old_branch, new_branch,
317
303
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
304
additional trees to search in for file-ids.
357
306
# Get the old and new revision specs
358
307
old_revision_spec = None
381
330
default_location = path_list[0]
382
331
other_paths = path_list[1:]
384
def lock_tree_or_branch(wt, br):
387
add_cleanup(wt.unlock)
390
add_cleanup(br.unlock)
392
333
# Get the old location
393
334
specific_files = []
394
335
if old_url is None:
395
336
old_url = default_location
396
337
working_tree, branch, relpath = \
397
338
bzrdir.BzrDir.open_containing_tree_or_branch(old_url)
398
lock_tree_or_branch(working_tree, branch)
399
339
if consider_relpath and relpath != '':
400
340
if working_tree is not None and apply_view:
401
341
views.check_path_in_view(working_tree, relpath)
409
349
if new_url != old_url:
410
350
working_tree, branch, relpath = \
411
351
bzrdir.BzrDir.open_containing_tree_or_branch(new_url)
412
lock_tree_or_branch(working_tree, branch)
413
352
if consider_relpath and relpath != '':
414
353
if working_tree is not None and apply_view:
415
354
views.check_path_in_view(working_tree, relpath)
463
402
old_label='a/', new_label='b/',
464
403
extra_trees=None,
465
404
path_encoding='utf8',
468
406
"""Show in text form the changes from one tree to another.
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)
412
Include only changes to these files - None for all changes.
414
external_diff_options
415
If set, use an external GNU diff and pass these options.
418
If set, more Trees to use for looking up file ids
421
If set, the path will be encoded as specified, otherwise is supposed
480
if format_cls is None:
481
format_cls = DiffTree
482
424
old_tree.lock_read()
484
426
if extra_trees is not None:
487
429
new_tree.lock_read()
489
differ = format_cls.from_trees_options(old_tree, new_tree, to_file,
491
external_diff_options,
492
old_label, new_label, using)
431
differ = DiffTree.from_trees_options(old_tree, new_tree, to_file,
433
external_diff_options,
434
old_label, new_label, using)
493
435
return differ.show_diff(specific_files, extra_trees)
495
437
new_tree.unlock()
503
445
def _patch_header_date(tree, file_id, path):
504
446
"""Returns a timestamp suitable for use in a patch header."""
506
mtime = tree.get_file_mtime(file_id, path)
507
except errors.FileTimestampUnavailable:
447
mtime = tree.get_file_mtime(file_id, path)
509
448
return timestamp.format_patch_date(mtime)
733
672
def from_string(klass, command_string, old_tree, new_tree, to_file,
734
673
path_encoding='utf-8'):
735
command_template = cmdline.split(command_string)
736
if '@' not in command_string:
737
command_template.extend(['@old_path', '@new_path'])
674
command_template = commands.shlex_split_unicode(command_string)
675
command_template.extend(['%(old_path)s', '%(new_path)s'])
738
676
return klass(command_template, old_tree, new_tree, to_file,
748
686
def _get_command(self, old_path, new_path):
749
687
my_map = {'old_path': old_path, 'new_path': new_path}
750
return [AtTemplate(t).substitute(my_map) for t in
751
self.command_template]
688
return [t % my_map for t in self.command_template]
753
690
def _execute(self, old_path, new_path):
754
691
command = self._get_command(old_path, new_path)
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))
714
def _write_file(self, file_id, tree, prefix, relpath):
782
715
full_path = osutils.pathjoin(self._root, prefix, relpath)
783
if not force_temp and self._try_symlink_root(tree, prefix):
716
if self._try_symlink_root(tree, prefix):
785
718
parent_dir = osutils.dirname(full_path)
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)
733
osutils.make_readonly(full_path)
734
mtime = tree.get_file_mtime(file_id)
735
os.utime(full_path, (mtime, mtime))
810
def _prepare_files(self, file_id, old_path, new_path, force_temp=False,
811
allow_write_new=False):
738
def _prepare_files(self, file_id, old_path, new_path):
812
739
old_disk_path = self._write_file(file_id, self.old_tree, 'old',
813
old_path, force_temp)
814
741
new_disk_path = self._write_file(file_id, self.new_tree, 'new',
815
new_path, force_temp,
816
allow_write=allow_write_new)
817
743
return old_disk_path, new_disk_path
819
745
def finish(self):
827
753
def diff(self, file_id, old_path, new_path, old_kind, new_kind):
828
754
if (old_kind, new_kind) != ('file', 'file'):
829
755
return DiffPath.CANNOT_DIFF
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()
756
self._prepare_files(file_id, old_path, new_path)
757
self._execute(osutils.pathjoin('old', old_path),
758
osutils.pathjoin('new', new_path))
858
761
class DiffTree(object):
932
835
def show_diff(self, specific_files, extra_trees=None):
933
836
"""Write tree diff to self.to_file
935
:param specific_files: the specific files to compare (recursive)
838
:param sepecific_files: the specific files to compare (recursive)
936
839
:param extra_trees: extra trees to use for mapping paths to file_ids
added
removed
bzrlib/diff.py
