1
# Copyright (C) 2005-2010 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
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
17
from __future__ import absolute_import
22
from bzrlib.trace import is_quiet
25
class TreeDelta(object):
26
"""Describes changes from one tree to another.
35
(oldpath, newpath, id, kind, text_modified, meta_modified)
37
(path, id, old_kind, new_kind)
39
(path, id, kind, text_modified, meta_modified)
45
Each id is listed only once.
47
Files that are both modified and renamed are listed only in
48
renamed, with the text_modified flag true. The text_modified
49
applies either to the content of the file or the target of the
50
symbolic link, depending of the kind of file.
52
Files are only considered renamed if their name has changed or
53
their parent directory has changed. Renaming a directory
54
does not count as renaming all its contents.
56
The lists are normally sorted when the delta is created.
62
self.kind_changed = []
68
def __eq__(self, other):
69
if not isinstance(other, TreeDelta):
71
return self.added == other.added \
72
and self.removed == other.removed \
73
and self.renamed == other.renamed \
74
and self.modified == other.modified \
75
and self.unchanged == other.unchanged \
76
and self.kind_changed == other.kind_changed \
77
and self.unversioned == other.unversioned
79
def __ne__(self, other):
80
return not (self == other)
83
return "TreeDelta(added=%r, removed=%r, renamed=%r," \
84
" kind_changed=%r, modified=%r, unchanged=%r," \
85
" unversioned=%r)" % (self.added,
86
self.removed, self.renamed, self.kind_changed, self.modified,
87
self.unchanged, self.unversioned)
89
def has_changed(self):
90
return bool(self.modified
96
def touches_file_id(self, file_id):
97
"""Return True if file_id is modified by this delta."""
98
for l in self.added, self.removed, self.modified:
102
for v in self.renamed:
105
for v in self.kind_changed:
110
def get_changes_as_text(self, show_ids=False, show_unchanged=False,
113
output = StringIO.StringIO()
114
report_delta(output, self, short_status, show_ids, show_unchanged)
115
return output.getvalue()
118
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
119
include_root, extra_trees=None,
120
require_versioned=False, want_unversioned=False):
121
"""Worker function that implements Tree.changes_from."""
123
# mutter('start compare_trees')
125
for (file_id, path, content_change, versioned, parent_id, name, kind,
126
executable) in new_tree.iter_changes(old_tree, want_unchanged,
127
specific_files, extra_trees=extra_trees,
128
require_versioned=require_versioned,
129
want_unversioned=want_unversioned):
130
if versioned == (False, False):
131
delta.unversioned.append((path[1], None, kind[1]))
133
if not include_root and (None, None) == parent_id:
135
fully_present = tuple((versioned[x] and kind[x] is not None) for
137
if fully_present[0] != fully_present[1]:
138
if fully_present[1] is True:
139
delta.added.append((path[1], file_id, kind[1]))
141
delta.removed.append((path[0], file_id, kind[0]))
142
elif fully_present[0] is False:
143
delta.missing.append((path[1], file_id, kind[1]))
144
elif name[0] != name[1] or parent_id[0] != parent_id[1]:
145
# If the name changes, or the parent_id changes, we have a rename
146
# (if we move a parent, that doesn't count as a rename for the
148
delta.renamed.append((path[0],
153
(executable[0] != executable[1])))
154
elif kind[0] != kind[1]:
155
delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
156
elif content_change or executable[0] != executable[1]:
157
delta.modified.append((path[1], file_id, kind[1],
159
(executable[0] != executable[1])))
161
delta.unchanged.append((path[1], file_id, kind[1]))
167
# TODO: jam 20060529 These lists shouldn't need to be sorted
168
# since we added them in alphabetical order.
169
delta.modified.sort()
170
delta.unchanged.sort()
175
class _ChangeReporter(object):
176
"""Report changes between two trees"""
178
def __init__(self, output=None, suppress_root_add=True,
179
output_file=None, unversioned_filter=None, view_info=None,
183
:param output: a function with the signature of trace.note, i.e.
184
accepts a format and parameters.
185
:param supress_root_add: If true, adding the root will be ignored
186
(i.e. when a tree has just been initted)
187
:param output_file: If supplied, a file-like object to write to.
188
Only one of output and output_file may be supplied.
189
:param unversioned_filter: A filter function to be called on
190
unversioned files. This should return True to ignore a path.
191
By default, no filtering takes place.
192
:param view_info: A tuple of view_name,view_files if only
193
items inside a view are to be reported on, or None for
195
:param classify: Add special symbols to indicate file kind.
197
if output_file is not None:
198
if output is not None:
199
raise BzrError('Cannot specify both output and output_file')
200
def output(fmt, *args):
201
output_file.write((fmt % args) + '\n')
203
if self.output is None:
204
from bzrlib import trace
205
self.output = trace.note
206
self.suppress_root_add = suppress_root_add
207
self.modified_map = {'kind changed': 'K',
214
self.versioned_map = {'added': '+', # versioned target
215
'unchanged': ' ', # versioned in both
216
'removed': '-', # versioned in source
217
'unversioned': '?', # versioned in neither
219
self.unversioned_filter = unversioned_filter
221
self.kind_marker = osutils.kind_marker
223
self.kind_marker = lambda kind: ''
224
if view_info is None:
225
self.view_name = None
228
self.view_name = view_info[0]
229
self.view_files = view_info[1]
230
self.output("Operating on whole tree but only reporting on "
231
"'%s' view." % (self.view_name,))
233
def report(self, file_id, paths, versioned, renamed, modified, exe_change,
235
"""Report one change to a file
237
:param file_id: The file_id of the file
238
:param path: The old and new paths as generated by Tree.iter_changes.
239
:param versioned: may be 'added', 'removed', 'unchanged', or
241
:param renamed: may be True or False
242
:param modified: may be 'created', 'deleted', 'kind changed',
243
'modified' or 'unchanged'.
244
:param exe_change: True if the execute bit has changed
245
:param kind: A pair of file kinds, as generated by Tree.iter_changes.
246
None indicates no file present.
250
if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
252
if self.view_files and not osutils.is_inside_any(self.view_files,
255
if versioned == 'unversioned':
256
# skip ignored unversioned files if needed.
257
if self.unversioned_filter is not None:
258
if self.unversioned_filter(paths[1]):
260
# dont show a content change in the output.
261
modified = 'unchanged'
262
# we show both paths in the following situations:
263
# the file versioning is unchanged AND
264
# ( the path is different OR
265
# the kind is different)
266
if (versioned == 'unchanged' and
267
(renamed or modified == 'kind changed')):
269
# on a rename, we show old and new
270
old_path, path = paths
272
# if it's not renamed, we're showing both for kind changes
273
# so only show the new path
274
old_path, path = paths[1], paths[1]
275
# if the file is not missing in the source, we show its kind
276
# when we show two paths.
277
if kind[0] is not None:
278
old_path += self.kind_marker(kind[0])
280
elif versioned == 'removed':
281
# not present in target
290
rename = self.versioned_map[versioned]
291
# we show the old kind on the new path when the content is deleted.
292
if modified == 'deleted':
293
path += self.kind_marker(kind[0])
294
# otherwise we always show the current kind when there is one
295
elif kind[1] is not None:
296
path += self.kind_marker(kind[1])
301
self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
304
def report_changes(change_iterator, reporter):
305
"""Report the changes from a change iterator.
307
This is essentially a translation from low-level to medium-level changes.
308
Further processing may be required to produce a human-readable output.
309
Unfortunately, some tree-changing operations are very complex
310
:change_iterator: an iterator or sequence of changes in the format
311
generated by Tree.iter_changes
312
:param reporter: The _ChangeReporter that will report the changes.
314
versioned_change_map = {
315
(True, True) : 'unchanged',
316
(True, False) : 'removed',
317
(False, True) : 'added',
318
(False, False): 'unversioned',
320
for (file_id, path, content_change, versioned, parent_id, name, kind,
321
executable) in change_iterator:
323
# files are "renamed" if they are moved or if name changes, as long
325
if None not in name and None not in parent_id and\
326
(name[0] != name[1] or parent_id[0] != parent_id[1]):
330
if kind[0] != kind[1]:
333
elif kind[1] is None:
336
modified = "kind changed"
339
modified = "modified"
340
elif kind[0] is None:
343
modified = "unchanged"
344
if kind[1] == "file":
345
exe_change = (executable[0] != executable[1])
346
versioned_change = versioned_change_map[versioned]
347
reporter.report(file_id, path, versioned_change, renamed, modified,
350
def report_delta(to_file, delta, short_status=False, show_ids=False,
351
show_unchanged=False, indent='', filter=None, classify=True):
352
"""Output this delta in status-like form to to_file.
354
:param to_file: A file-like object where the output is displayed.
356
:param delta: A TreeDelta containing the changes to be displayed
358
:param short_status: Single-line status if True.
360
:param show_ids: Output the file ids if True.
362
:param show_unchanged: Output the unchanged files if True.
364
:param indent: Added at the beginning of all output lines (for merged
367
:param filter: A callable receiving a path and a file id and
368
returning True if the path should be displayed.
370
:param classify: Add special symbols to indicate file kind.
373
def decorate_path(path, kind, meta_modified=None):
376
if kind == 'directory':
378
elif kind == 'symlink':
384
def show_more_renamed(item):
385
(oldpath, file_id, kind,
386
text_modified, meta_modified, newpath) = item
387
dec_new_path = decorate_path(newpath, kind, meta_modified)
388
to_file.write(' => %s' % dec_new_path)
389
if text_modified or meta_modified:
390
extra_modified.append((newpath, file_id, kind,
391
text_modified, meta_modified))
393
def show_more_kind_changed(item):
394
(path, file_id, old_kind, new_kind) = item
395
to_file.write(' (%s => %s)' % (old_kind, new_kind))
397
def show_path(path, file_id, kind, meta_modified,
398
default_format, with_file_id_format):
399
dec_path = decorate_path(path, kind, meta_modified)
401
to_file.write(with_file_id_format % dec_path)
403
to_file.write(default_format % dec_path)
405
def show_list(files, long_status_name, short_status_letter,
406
default_format='%s', with_file_id_format='%-30s',
411
prefix = short_status_letter
414
prefix = indent + prefix + ' '
417
path, file_id, kind = item[:3]
418
if (filter is not None and not filter(path, file_id)):
420
if not header_shown and not short_status:
421
to_file.write(indent + long_status_name + ':\n')
425
meta_modified = item[4]
427
to_file.write(prefix)
428
show_path(path, file_id, kind, meta_modified,
429
default_format, with_file_id_format)
430
if show_more is not None:
433
to_file.write(' %s' % file_id)
436
show_list(delta.removed, 'removed', 'D')
437
show_list(delta.added, 'added', 'A')
438
show_list(delta.missing, 'missing', '!')
440
# Reorder delta.renamed tuples so that all lists share the same
441
# order for their 3 first fields and that they also begin like
442
# the delta.modified tuples
443
renamed = [(p, i, k, tm, mm, np)
444
for p, np, i, k, tm, mm in delta.renamed]
445
show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
446
show_more=show_more_renamed)
447
show_list(delta.kind_changed, 'kind changed', 'K',
448
with_file_id_format='%s',
449
show_more=show_more_kind_changed)
450
show_list(delta.modified + extra_modified, 'modified', 'M')
452
show_list(delta.unchanged, 'unchanged', 'S')
454
show_list(delta.unversioned, 'unknown', ' ')
added
removed
bzrlib/delta.py
