1
# Copyright (C) 2005, 2006 Canonical
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 import tree
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):
94
"""output this delta in status-like form to to_file."""
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, ' %-30s %s' % (path, fid)
110
print >>to_file, ' ', path
113
print >>to_file, 'removed:'
114
show_list(self.removed)
117
print >>to_file, 'added:'
118
show_list(self.added)
123
print >>to_file, 'renamed:'
124
for (oldpath, newpath, fid, kind,
125
text_modified, meta_modified) in self.renamed:
126
if text_modified or meta_modified:
127
extra_modified.append((newpath, fid, kind,
128
text_modified, meta_modified))
132
print >>to_file, ' %s => %s %s' % (oldpath, newpath, fid)
134
print >>to_file, ' %s => %s' % (oldpath, newpath)
136
if self.modified or extra_modified:
137
print >>to_file, 'modified:'
138
show_list(self.modified)
139
show_list(extra_modified)
141
if show_unchanged and self.unchanged:
142
print >>to_file, 'unchanged:'
143
show_list(self.unchanged)
146
def compare_trees(old_tree, new_tree, want_unchanged=False,
147
specific_files=None, extra_trees=None,
148
require_versioned=False):
149
"""Describe changes from one tree to another.
151
Returns a TreeDelta with details of added, modified, renamed, and
154
The root entry is specifically exempt.
156
This only considers versioned files.
159
If true, also list files unchanged from one version to
163
If supplied, only check for changes to specified names or
164
files within them. When mapping filenames to ids, all matches in all
165
trees (including optional extra_trees) are used, and all children of
166
matched directories are included.
169
If non-None, a list of more trees to use for looking up file_ids from
173
If true, an all files are required to be versioned, and
174
PathsNotVersionedError will be thrown if they are not.
176
# NB: show_status depends on being able to pass in non-versioned files and
177
# report them as unknown
182
trees = (new_tree, old_tree)
183
if extra_trees is not None:
184
trees = trees + tuple(extra_trees)
185
specific_file_ids = tree.find_ids_across_trees(specific_files,
186
trees, require_versioned=require_versioned)
187
if specific_files and not specific_file_ids:
188
# All files are unversioned, so just return an empty delta
189
# _compare_trees would think we want a complete delta
191
return _compare_trees(old_tree, new_tree, want_unchanged,
199
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids):
201
from osutils import is_inside_any
203
old_inv = old_tree.inventory
204
new_inv = new_tree.inventory
206
mutter('start compare_trees')
208
# TODO: Rather than iterating over the whole tree and then filtering, we
209
# could diff just the specified files (if any) and their subtrees.
211
old_files = old_tree.list_files()
212
new_files = new_tree.list_files()
223
except StopIteration:
224
return None, None, None, None, None
225
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
226
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
229
def check_matching(old_path, old_entry, new_path, new_entry):
230
"""We have matched up 2 file_ids, check for changes."""
231
assert old_entry.kind == new_entry.kind
233
if old_entry.kind == 'root_directory':
236
if specific_file_ids:
237
if (old_entry.file_id not in specific_file_ids and
238
new_entry.file_id not in specific_file_ids):
241
# temporary hack until all entries are populated before clients
243
old_entry._read_tree_state(old_path, old_tree)
244
new_entry._read_tree_state(new_path, new_tree)
245
text_modified, meta_modified = new_entry.detect_changes(old_entry)
247
# If the name changes, or the parent_id changes, we have a rename
248
# (if we move a parent, that doesn't count as a rename for the file)
249
if (old_entry.name != new_entry.name
250
or old_entry.parent_id != new_entry.parent_id):
251
delta.renamed.append((old_path,
253
old_entry.file_id, old_entry.kind,
254
text_modified, meta_modified))
255
elif text_modified or meta_modified:
256
delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
257
text_modified, meta_modified))
259
delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
262
def handle_old(path, entry):
263
"""old entry without a new entry match
265
Check to see if a matching new entry was already seen as an
266
added file, and switch the pair into being a rename.
267
Otherwise just mark the old entry being removed.
269
if entry.file_id in added:
270
# Actually this is a rename, we found a new file_id earlier
271
# at a different location, so it is no-longer added
272
x_new_path, x_new_entry = added.pop(entry.file_id)
273
check_matching(path, entry, x_new_path, x_new_entry)
275
# We have an old_file_id which doesn't line up with a new_file_id
276
# So this file looks to be removed
277
assert entry.file_id not in removed
278
removed[entry.file_id] = path, entry
280
def handle_new(path, entry):
281
"""new entry without an old entry match
283
Check to see if a matching old entry was already seen as a
284
removal, and change the pair into a rename.
285
Otherwise just mark the new entry as an added file.
287
if entry.file_id in removed:
288
# We saw this file_id earlier at an old different location
289
# it is no longer removed, just renamed
290
x_old_path, x_old_entry = removed.pop(entry.file_id)
291
check_matching(x_old_path, x_old_entry, path, entry)
293
# We have a new file which does not match an old file
295
assert entry.file_id not in added
296
added[entry.file_id] = path, entry
298
while old_path or new_path:
299
# list_files() returns files in alphabetical path sorted order
300
if old_path == new_path:
301
if old_file_id == new_file_id:
302
# This is the common case, the files are in the same place
303
# check if there were any content changes
305
if old_file_id is None:
306
# We have 2 unversioned files, no deltas possible???
309
check_matching(old_path, old_entry, new_path, new_entry)
311
# The ids don't match, so we have to handle them both
313
if old_file_id is not None:
314
handle_old(old_path, old_entry)
316
if new_file_id is not None:
317
handle_new(new_path, new_entry)
319
# The two entries were at the same path, so increment both sides
320
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
321
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
322
elif new_path is None or (old_path is not None and old_path < new_path):
323
# Assume we don't match, only process old_path
324
if old_file_id is not None:
325
handle_old(old_path, old_entry)
326
# old_path came first, so increment it, trying to match up
327
old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
328
elif new_path is not None:
329
# new_path came first, so increment it, trying to match up
330
if new_file_id is not None:
331
handle_new(new_path, new_entry)
332
new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
334
# Now we have a set of added and removed files, mark them all
335
for old_path, old_entry in removed.itervalues():
336
if specific_file_ids:
337
if not old_entry.file_id in specific_file_ids:
339
delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
340
for new_path, new_entry in added.itervalues():
341
if specific_file_ids:
342
if not new_entry.file_id in specific_file_ids:
344
delta.added.append((new_path, new_entry.file_id, new_entry.kind))
349
# TODO: jam 20060529 These lists shouldn't need to be sorted
350
# since we added them in alphabetical order.
351
delta.modified.sort()
352
delta.unchanged.sort()
added
removed
bzrlib/delta.py
