1
# Copyright (C) 2005, 2006 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
from bzrlib.inventory import InventoryEntry
18
from bzrlib.trace import mutter
19
from bzrlib.symbol_versioning import deprecated_function, zero_nine
22
class TreeDelta(object):
23
"""Describes changes from one tree to another.
32
(oldpath, newpath, id, kind, text_modified, meta_modified)
34
(path, id, kind, text_modified, meta_modified)
38
Each id is listed only once.
40
Files that are both modified and renamed are listed only in
41
renamed, with the text_modified flag true. The text_modified
42
applies either to the the content of the file or the target of the
43
symbolic link, depending of the kind of file.
45
Files are only considered renamed if their name has changed or
46
their parent directory has changed. Renaming a directory
47
does not count as renaming all its contents.
49
The lists are normally sorted when the delta is created.
58
def __eq__(self, other):
59
if not isinstance(other, TreeDelta):
61
return self.added == other.added \
62
and self.removed == other.removed \
63
and self.renamed == other.renamed \
64
and self.modified == other.modified \
65
and self.unchanged == other.unchanged
67
def __ne__(self, other):
68
return not (self == other)
71
return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
72
" unchanged=%r)" % (self.added, self.removed, self.renamed,
73
self.modified, self.unchanged)
75
def has_changed(self):
76
return bool(self.modified
81
def touches_file_id(self, file_id):
82
"""Return True if file_id is modified by this delta."""
83
for l in self.added, self.removed, self.modified:
87
for v in self.renamed:
93
def show(self, to_file, show_ids=False, show_unchanged=False, short_status=False):
94
"""output this delta in status-like form to to_file."""
95
def show_list(files, short_status_letter=''):
97
path, fid, kind = item[:3]
99
if kind == 'directory':
101
elif kind == 'symlink':
104
if len(item) == 5 and item[4]:
108
print >>to_file, '%s %-30s %s' % (short_status_letter, path, fid)
110
print >>to_file, '%s %s' % (short_status_letter, path)
114
print >>to_file, 'removed:'
115
show_list(self.removed)
117
show_list(self.removed, 'D')
121
print >>to_file, 'added:'
122
show_list(self.added)
124
show_list(self.added, 'A')
129
short_status_letter = 'R'
131
print >>to_file, 'renamed:'
132
short_status_letter = ''
133
for (oldpath, newpath, fid, kind,
134
text_modified, meta_modified) in self.renamed:
135
if text_modified or meta_modified:
136
extra_modified.append((newpath, fid, kind,
137
text_modified, meta_modified))
141
print >>to_file, '%s %s => %s %s' % (short_status_letter,
142
oldpath, newpath, fid)
144
print >>to_file, '%s %s => %s' % (short_status_letter,
147
if self.modified or extra_modified:
148
short_status_letter = 'M'
150
print >>to_file, 'modified:'
151
short_status_letter = ''
152
show_list(self.modified, short_status_letter)
153
show_list(extra_modified, short_status_letter)
155
if show_unchanged and self.unchanged:
157
print >>to_file, 'unchanged:'
158
show_list(self.unchanged)
160
show_list(self.unchanged, 'S')
163
@deprecated_function(zero_nine)
164
def compare_trees(old_tree, new_tree, want_unchanged=False,
165
specific_files=None, extra_trees=None,
166
require_versioned=False):
167
"""compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
168
return new_tree.changes_from(old_tree,
169
want_unchanged=want_unchanged,
170
specific_files=specific_files,
171
extra_trees=extra_trees,
172
require_versioned=require_versioned,
176
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
179
from osutils import is_inside_any
180
old_inv = old_tree.inventory
181
new_inv = new_tree.inventory
183
# mutter('start compare_trees')
185
# TODO: Rather than iterating over the whole tree and then filtering, we
186
# could diff just the specified files (if any) and their subtrees.
188
old_files = old_tree.list_files(include_root)
189
new_files = new_tree.list_files(include_root)
200
except StopIteration:
201
return None, None, None, None, None
202
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
203
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
206
def check_matching(old_path, old_entry, new_path, new_entry):
207
"""We have matched up 2 file_ids, check for changes."""
208
assert old_entry.kind == new_entry.kind
210
if specific_file_ids:
211
if (old_entry.file_id not in specific_file_ids and
212
new_entry.file_id not in specific_file_ids):
215
# temporary hack until all entries are populated before clients
217
old_entry._read_tree_state(old_path, old_tree)
218
new_entry._read_tree_state(new_path, new_tree)
219
text_modified, meta_modified = new_entry.detect_changes(old_entry)
221
# If the name changes, or the parent_id changes, we have a rename
222
# (if we move a parent, that doesn't count as a rename for the file)
223
if (old_entry.name != new_entry.name
224
or old_entry.parent_id != new_entry.parent_id):
225
delta.renamed.append((old_path,
227
old_entry.file_id, old_entry.kind,
228
text_modified, meta_modified))
229
elif text_modified or meta_modified:
230
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
231
text_modified, meta_modified))
233
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
236
def handle_old(path, entry):
237
"""old entry without a new entry match
239
Check to see if a matching new entry was already seen as an
240
added file, and switch the pair into being a rename.
241
Otherwise just mark the old entry being removed.
243
if entry.file_id in added:
244
# Actually this is a rename, we found a new file_id earlier
245
# at a different location, so it is no-longer added
246
x_new_path, x_new_entry = added.pop(entry.file_id)
247
check_matching(path, entry, x_new_path, x_new_entry)
249
# We have an old_file_id which doesn't line up with a new_file_id
250
# So this file looks to be removed
251
assert entry.file_id not in removed
252
removed[entry.file_id] = path, entry
254
def handle_new(path, entry):
255
"""new entry without an old entry match
257
Check to see if a matching old entry was already seen as a
258
removal, and change the pair into a rename.
259
Otherwise just mark the new entry as an added file.
261
if entry.file_id in removed:
262
# We saw this file_id earlier at an old different location
263
# it is no longer removed, just renamed
264
x_old_path, x_old_entry = removed.pop(entry.file_id)
265
check_matching(x_old_path, x_old_entry, path, entry)
267
# We have a new file which does not match an old file
269
assert entry.file_id not in added
270
added[entry.file_id] = path, entry
272
while old_path is not None or new_path is not None:
273
# list_files() returns files in alphabetical path sorted order
274
if old_path == new_path:
275
if old_file_id == new_file_id:
276
# This is the common case, the files are in the same place
277
# check if there were any content changes
279
if old_file_id is None:
280
# We have 2 unversioned files, no deltas possible???
283
check_matching(old_path, old_entry, new_path, new_entry)
285
# The ids don't match, so we have to handle them both
287
if old_file_id is not None:
288
handle_old(old_path, old_entry)
290
if new_file_id is not None:
291
handle_new(new_path, new_entry)
293
# The two entries were at the same path, so increment both sides
294
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
295
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
296
elif new_path is None or (old_path is not None and old_path < new_path):
297
# Assume we don't match, only process old_path
298
if old_file_id is not None:
299
handle_old(old_path, old_entry)
300
# old_path came first, so increment it, trying to match up
301
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
302
elif new_path is not None:
303
# new_path came first, so increment it, trying to match up
304
if new_file_id is not None:
305
handle_new(new_path, new_entry)
306
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
308
# Now we have a set of added and removed files, mark them all
309
for old_path, old_entry in removed.itervalues():
310
if specific_file_ids:
311
if not old_entry.file_id in specific_file_ids:
313
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
314
for new_path, new_entry in added.itervalues():
315
if specific_file_ids:
316
if not new_entry.file_id in specific_file_ids:
318
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
323
# TODO: jam 20060529 These lists shouldn't need to be sorted
324
# since we added them in alphabetical order.
325
delta.modified.sort()
326
delta.unchanged.sort()
added
removed
bzrlib/delta.py
