← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Jelmer Vernooij
  • Date: 2010-12-20 11:57:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5577.
  • Revision ID: jelmer@samba.org-20101220115714-2ru3hfappjweeg7q
Don't use no-plugins.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
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
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
from bzrlib import (
18
 
    errors,
19
18
    osutils,
20
19
    )
21
 
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter
23
 
from bzrlib.symbol_versioning import deprecated_function, zero_nine
 
20
from bzrlib.trace import is_quiet
24
21
 
25
22
 
26
23
class TreeDelta(object):
27
24
    """Describes changes from one tree to another.
28
25
 
29
 
    Contains four lists:
 
26
    Contains seven lists:
30
27
 
31
28
    added
32
29
        (path, id, kind)
34
31
        (path, id, kind)
35
32
    renamed
36
33
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
34
    kind_changed
 
35
        (path, id, old_kind, new_kind)
37
36
    modified
38
37
        (path, id, kind, text_modified, meta_modified)
39
38
    unchanged
40
39
        (path, id, kind)
 
40
    unversioned
 
41
        (path, None, kind)
41
42
 
42
43
    Each id is listed only once.
43
44
 
44
45
    Files that are both modified and renamed are listed only in
45
46
    renamed, with the text_modified flag true. The text_modified
46
 
    applies either to the the content of the file or the target of the
 
47
    applies either to the content of the file or the target of the
47
48
    symbolic link, depending of the kind of file.
48
49
 
49
50
    Files are only considered renamed if their name has changed or
59
60
        self.kind_changed = []
60
61
        self.modified = []
61
62
        self.unchanged = []
 
63
        self.unversioned = []
 
64
        self.missing = []
62
65
 
63
66
    def __eq__(self, other):
64
67
        if not isinstance(other, TreeDelta):
68
71
               and self.renamed == other.renamed \
69
72
               and self.modified == other.modified \
70
73
               and self.unchanged == other.unchanged \
71
 
               and self.kind_changed == other.kind_changed
 
74
               and self.kind_changed == other.kind_changed \
 
75
               and self.unversioned == other.unversioned
72
76
 
73
77
    def __ne__(self, other):
74
78
        return not (self == other)
75
79
 
76
80
    def __repr__(self):
77
81
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
78
 
            " kind_changed=%r, modified=%r, unchanged=%r)" % (self.added,
 
82
            " kind_changed=%r, modified=%r, unchanged=%r," \
 
83
            " unversioned=%r)" % (self.added,
79
84
            self.removed, self.renamed, self.kind_changed, self.modified,
80
 
            self.unchanged)
 
85
            self.unchanged, self.unversioned)
81
86
 
82
87
    def has_changed(self):
83
88
        return bool(self.modified
99
104
            if v[1] == file_id:
100
105
                return True
101
106
        return False
102
 
            
103
 
 
104
 
    def show(self, to_file, show_ids=False, show_unchanged=False,
105
 
             short_status=False):
106
 
        """output this delta in status-like form to to_file."""
107
 
        def show_list(files, short_status_letter=''):
108
 
            for item in files:
109
 
                path, fid, kind = item[:3]
110
 
 
111
 
                if kind == 'directory':
112
 
                    path += '/'
113
 
                elif kind == 'symlink':
114
 
                    path += '@'
115
 
 
116
 
                if len(item) == 5 and item[4]:
117
 
                    path += '*'
118
 
 
119
 
                if show_ids:
120
 
                    print >>to_file, '%s  %-30s %s' % (short_status_letter,
121
 
                        path, fid)
122
 
                else:
123
 
                    print >>to_file, '%s  %s' % (short_status_letter, path)
124
 
            
125
 
        if self.removed:
126
 
            if not short_status:
127
 
                print >>to_file, 'removed:'
128
 
                show_list(self.removed)
129
 
            else:
130
 
                show_list(self.removed, 'D')
131
 
                
132
 
        if self.added:
133
 
            if not short_status:
134
 
                print >>to_file, 'added:'
135
 
                show_list(self.added)
136
 
            else:
137
 
                show_list(self.added, 'A')
138
 
 
139
 
        extra_modified = []
140
 
 
141
 
        if self.renamed:
142
 
            short_status_letter = 'R'
143
 
            if not short_status:
144
 
                print >>to_file, 'renamed:'
145
 
                short_status_letter = ''
146
 
            for (oldpath, newpath, fid, kind,
147
 
                 text_modified, meta_modified) in self.renamed:
148
 
                if text_modified or meta_modified:
149
 
                    extra_modified.append((newpath, fid, kind,
150
 
                                           text_modified, meta_modified))
151
 
                if meta_modified:
152
 
                    newpath += '*'
153
 
                if show_ids:
154
 
                    print >>to_file, '%s  %s => %s %s' % (
155
 
                        short_status_letter, oldpath, newpath, fid)
156
 
                else:
157
 
                    print >>to_file, '%s  %s => %s' % (
158
 
                        short_status_letter, oldpath, newpath)
159
 
 
160
 
        if self.kind_changed:
161
 
            if short_status:
162
 
                short_status_letter = 'K'
163
 
            else:
164
 
                print >>to_file, 'kind changed:'
165
 
                short_status_letter = ''
166
 
            for (path, fid, old_kind, new_kind) in self.kind_changed:
167
 
                if show_ids:
168
 
                    suffix = ' '+fid
169
 
                else:
170
 
                    suffix = ''
171
 
                print >>to_file, '%s  %s (%s => %s)%s' % (
172
 
                    short_status_letter, path, old_kind, new_kind, suffix)
173
 
 
174
 
        if self.modified or extra_modified:
175
 
            short_status_letter = 'M'
176
 
            if not short_status:
177
 
                print >>to_file, 'modified:'
178
 
                short_status_letter = ''
179
 
            show_list(self.modified, short_status_letter)
180
 
            show_list(extra_modified, short_status_letter)
181
 
            
182
 
        if show_unchanged and self.unchanged:
183
 
            if not short_status:
184
 
                print >>to_file, 'unchanged:'
185
 
                show_list(self.unchanged)
186
 
            else:
187
 
                show_list(self.unchanged, 'S')
188
 
 
189
 
 
190
 
@deprecated_function(zero_nine)
191
 
def compare_trees(old_tree, new_tree, want_unchanged=False,
192
 
                  specific_files=None, extra_trees=None,
193
 
                  require_versioned=False):
194
 
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
195
 
    return new_tree.changes_from(old_tree,
196
 
        want_unchanged=want_unchanged,
197
 
        specific_files=specific_files,
198
 
        extra_trees=extra_trees,
199
 
        require_versioned=require_versioned,
200
 
        include_root=False)
 
107
 
 
108
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
 
109
                            short_status=False):
 
110
        import StringIO
 
111
        output = StringIO.StringIO()
 
112
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
113
        return output.getvalue()
201
114
 
202
115
 
203
116
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
204
 
                   include_root, extra_trees=None):
 
117
                   include_root, extra_trees=None,
 
118
                   require_versioned=False, want_unversioned=False):
 
119
    """Worker function that implements Tree.changes_from."""
205
120
    delta = TreeDelta()
206
121
    # mutter('start compare_trees')
207
122
 
208
123
    for (file_id, path, content_change, versioned, parent_id, name, kind,
209
 
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
210
 
            specific_files, extra_trees=extra_trees):
 
124
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
 
125
            specific_files, extra_trees=extra_trees,
 
126
            require_versioned=require_versioned,
 
127
            want_unversioned=want_unversioned):
 
128
        if versioned == (False, False):
 
129
            delta.unversioned.append((path[1], None, kind[1]))
 
130
            continue
211
131
        if not include_root and (None, None) == parent_id:
212
132
            continue
213
133
        fully_present = tuple((versioned[x] and kind[x] is not None) for
214
134
                              x in range(2))
215
135
        if fully_present[0] != fully_present[1]:
216
136
            if fully_present[1] is True:
217
 
                delta.added.append((path, file_id, kind[1]))
 
137
                delta.added.append((path[1], file_id, kind[1]))
218
138
            else:
219
 
                assert fully_present[0] is True
220
 
                old_path = old_tree.id2path(file_id)
221
 
                delta.removed.append((old_path, file_id, kind[0]))
 
139
                delta.removed.append((path[0], file_id, kind[0]))
222
140
        elif fully_present[0] is False:
223
 
            continue
 
141
            delta.missing.append((path[1], file_id, kind[1]))
224
142
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
225
143
            # If the name changes, or the parent_id changes, we have a rename
226
144
            # (if we move a parent, that doesn't count as a rename for the
227
145
            # file)
228
 
            old_path = old_tree.id2path(file_id)
229
 
            delta.renamed.append((old_path,
230
 
                                  path,
231
 
                                  file_id, 
 
146
            delta.renamed.append((path[0],
 
147
                                  path[1],
 
148
                                  file_id,
232
149
                                  kind[1],
233
 
                                  content_change, 
 
150
                                  content_change,
234
151
                                  (executable[0] != executable[1])))
235
152
        elif kind[0] != kind[1]:
236
 
            delta.kind_changed.append((path, file_id, kind[0], kind[1]))
237
 
        elif content_change is True or executable[0] != executable[1]:
238
 
            delta.modified.append((path, file_id, kind[1],
239
 
                                   content_change, 
 
153
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
 
154
        elif content_change or executable[0] != executable[1]:
 
155
            delta.modified.append((path[1], file_id, kind[1],
 
156
                                   content_change,
240
157
                                   (executable[0] != executable[1])))
241
158
        else:
242
 
            delta.unchanged.append((path, file_id, kind[1]))
 
159
            delta.unchanged.append((path[1], file_id, kind[1]))
243
160
 
244
161
    delta.removed.sort()
245
162
    delta.added.sort()
246
163
    delta.renamed.sort()
 
164
    delta.missing.sort()
247
165
    # TODO: jam 20060529 These lists shouldn't need to be sorted
248
166
    #       since we added them in alphabetical order.
249
167
    delta.modified.sort()
252
170
    return delta
253
171
 
254
172
 
255
 
class ChangeReporter(object):
 
173
class _ChangeReporter(object):
256
174
    """Report changes between two trees"""
257
175
 
258
 
    def __init__(self, old_inventory, output=None, suppress_root_add=True,
259
 
                 output_file=None):
 
176
    def __init__(self, output=None, suppress_root_add=True,
 
177
                 output_file=None, unversioned_filter=None, view_info=None):
260
178
        """Constructor
261
179
 
262
 
        :param old_inventory: The inventory of the old tree
263
180
        :param output: a function with the signature of trace.note, i.e.
264
181
            accepts a format and parameters.
265
182
        :param supress_root_add: If true, adding the root will be ignored
266
183
            (i.e. when a tree has just been initted)
267
184
        :param output_file: If supplied, a file-like object to write to.
268
185
            Only one of output and output_file may be supplied.
 
186
        :param unversioned_filter: A filter function to be called on
 
187
            unversioned files. This should return True to ignore a path.
 
188
            By default, no filtering takes place.
 
189
        :param view_info: A tuple of view_name,view_files if only
 
190
            items inside a view are to be reported on, or None for
 
191
            no view filtering.
269
192
        """
270
 
        self.old_inventory = old_inventory
271
193
        if output_file is not None:
272
194
            if output is not None:
273
195
                raise BzrError('Cannot specify both output and output_file')
278
200
            from bzrlib import trace
279
201
            self.output = trace.note
280
202
        self.suppress_root_add = suppress_root_add
 
203
        self.modified_map = {'kind changed': 'K',
 
204
                             'unchanged': ' ',
 
205
                             'created': 'N',
 
206
                             'modified': 'M',
 
207
                             'deleted': 'D',
 
208
                             'missing': '!',
 
209
                             }
 
210
        self.versioned_map = {'added': '+', # versioned target
 
211
                              'unchanged': ' ', # versioned in both
 
212
                              'removed': '-', # versioned in source
 
213
                              'unversioned': '?', # versioned in neither
 
214
                              }
 
215
        self.unversioned_filter = unversioned_filter
 
216
        if view_info is None:
 
217
            self.view_name = None
 
218
            self.view_files = []
 
219
        else:
 
220
            self.view_name = view_info[0]
 
221
            self.view_files = view_info[1]
 
222
            self.output("Operating on whole tree but only reporting on "
 
223
                        "'%s' view." % (self.view_name,))
281
224
 
282
 
    def report(self, file_id, path, versioned, renamed, modified, exe_change,
 
225
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
283
226
               kind):
284
227
        """Report one change to a file
285
228
 
286
229
        :param file_id: The file_id of the file
287
 
        :param path: The path the file has (or would have) in the tree (as
288
 
            generated by Tree._iter_changes)
289
 
        :param versioned: may be 'added', 'removed', or 'unchanged'
 
230
        :param path: The old and new paths as generated by Tree.iter_changes.
 
231
        :param versioned: may be 'added', 'removed', 'unchanged', or
 
232
            'unversioned.
290
233
        :param renamed: may be True or False
291
234
        :param modified: may be 'created', 'deleted', 'kind changed',
292
235
            'modified' or 'unchanged'.
293
236
        :param exe_change: True if the execute bit has changed
294
 
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
 
237
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
295
238
            None indicates no file present.
296
239
        """
297
 
        if path == '' and versioned == 'added' and self.suppress_root_add:
298
 
            return
299
 
        modified_map = {'kind changed': 'K',
300
 
                        'unchanged': ' ',
301
 
                        'created': 'N',
302
 
                        'modified': 'M',
303
 
                        'deleted': 'D'}
304
 
        versioned_map = {'added': '+',
305
 
                         'unchanged': ' ',
306
 
                         'removed': '-'}
307
 
        old_path = ""
 
240
        if is_quiet():
 
241
            return
 
242
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
 
243
            return
 
244
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
245
            paths[1]):
 
246
            return
 
247
        if versioned == 'unversioned':
 
248
            # skip ignored unversioned files if needed.
 
249
            if self.unversioned_filter is not None:
 
250
                if self.unversioned_filter(paths[1]):
 
251
                    return
 
252
            # dont show a content change in the output.
 
253
            modified = 'unchanged'
 
254
        # we show both paths in the following situations:
 
255
        # the file versioning is unchanged AND
 
256
        # ( the path is different OR
 
257
        #   the kind is different)
 
258
        if (versioned == 'unchanged' and
 
259
            (renamed or modified == 'kind changed')):
 
260
            if renamed:
 
261
                # on a rename, we show old and new
 
262
                old_path, path = paths
 
263
            else:
 
264
                # if it's not renamed, we're showing both for kind changes
 
265
                # so only show the new path
 
266
                old_path, path = paths[1], paths[1]
 
267
            # if the file is not missing in the source, we show its kind
 
268
            # when we show two paths.
 
269
            if kind[0] is not None:
 
270
                old_path += osutils.kind_marker(kind[0])
 
271
            old_path += " => "
 
272
        elif versioned == 'removed':
 
273
            # not present in target
 
274
            old_path = ""
 
275
            path = paths[0]
 
276
        else:
 
277
            old_path = ""
 
278
            path = paths[1]
308
279
        if renamed:
309
 
            old_path = self.old_inventory.id2path(file_id)
310
280
            rename = "R"
311
281
        else:
312
 
            rename = versioned_map[versioned]
313
 
        if modified == 'kind changed':
314
 
            if old_path == "":
315
 
                old_path = path
 
282
            rename = self.versioned_map[versioned]
 
283
        # we show the old kind on the new path when the content is deleted.
316
284
        if modified == 'deleted':
317
285
            path += osutils.kind_marker(kind[0])
 
286
        # otherwise we always show the current kind when there is one
318
287
        elif kind[1] is not None:
319
288
            path += osutils.kind_marker(kind[1])
320
 
        if old_path != "":
321
 
            if kind[0] is not None:
322
 
                old_path += osutils.kind_marker(kind[0])
323
 
            old_path += " => "
324
289
        if exe_change:
325
290
            exe = '*'
326
291
        else:
327
292
            exe = ' '
328
 
        self.output("%s%s%s %s%s", rename, modified_map[modified], exe,
 
293
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
329
294
                    old_path, path)
330
295
 
331
 
 
332
296
def report_changes(change_iterator, reporter):
333
297
    """Report the changes from a change iterator.
334
298
 
336
300
    Further processing may be required to produce a human-readable output.
337
301
    Unfortunately, some tree-changing operations are very complex
338
302
    :change_iterator: an iterator or sequence of changes in the format
339
 
        generated by Tree._iter_changes
340
 
    :param reporter: The ChangeReporter that will report the changes.
 
303
        generated by Tree.iter_changes
 
304
    :param reporter: The _ChangeReporter that will report the changes.
341
305
    """
 
306
    versioned_change_map = {
 
307
        (True, True)  : 'unchanged',
 
308
        (True, False) : 'removed',
 
309
        (False, True) : 'added',
 
310
        (False, False): 'unversioned',
 
311
        }
342
312
    for (file_id, path, content_change, versioned, parent_id, name, kind,
343
313
         executable) in change_iterator:
344
314
        exe_change = False
359
329
        else:
360
330
            if content_change:
361
331
                modified = "modified"
 
332
            elif kind[0] is None:
 
333
                modified = "missing"
362
334
            else:
363
335
                modified = "unchanged"
364
336
            if kind[1] == "file":
365
337
                exe_change = (executable[0] != executable[1])
366
 
        if versioned[0] != versioned[1]:
367
 
            if versioned[0]:
368
 
                versioned_change = "removed"
369
 
            else:
370
 
                versioned_change = "added"
371
 
        else:
372
 
            versioned_change = "unchanged"
 
338
        versioned_change = versioned_change_map[versioned]
373
339
        reporter.report(file_id, path, versioned_change, renamed, modified,
374
340
                        exe_change, kind)
 
341
 
 
342
def report_delta(to_file, delta, short_status=False, show_ids=False, 
 
343
         show_unchanged=False, indent='', filter=None):
 
344
    """Output this delta in status-like form to to_file.
 
345
 
 
346
    :param to_file: A file-like object where the output is displayed.
 
347
 
 
348
    :param delta: A TreeDelta containing the changes to be displayed
 
349
 
 
350
    :param short_status: Single-line status if True.
 
351
 
 
352
    :param show_ids: Output the file ids if True.
 
353
 
 
354
    :param show_unchanged: Output the unchanged files if True.
 
355
 
 
356
    :param indent: Added at the beginning of all output lines (for merged
 
357
        revisions).
 
358
 
 
359
    :param filter: A callable receiving a path and a file id and
 
360
        returning True if the path should be displayed.
 
361
    """
 
362
 
 
363
    def decorate_path(path, kind, meta_modified=None):
 
364
        if kind == 'directory':
 
365
            path += '/'
 
366
        elif kind == 'symlink':
 
367
            path += '@'
 
368
        if meta_modified:
 
369
            path += '*'
 
370
        return path
 
371
 
 
372
    def show_more_renamed(item):
 
373
        (oldpath, file_id, kind,
 
374
         text_modified, meta_modified, newpath) = item
 
375
        dec_new_path = decorate_path(newpath, kind, meta_modified)
 
376
        to_file.write(' => %s' % dec_new_path)
 
377
        if text_modified or meta_modified:
 
378
            extra_modified.append((newpath, file_id, kind,
 
379
                                   text_modified, meta_modified))
 
380
 
 
381
    def show_more_kind_changed(item):
 
382
        (path, file_id, old_kind, new_kind) = item
 
383
        to_file.write(' (%s => %s)' % (old_kind, new_kind))
 
384
 
 
385
    def show_path(path, file_id, kind, meta_modified,
 
386
                  default_format, with_file_id_format):
 
387
        dec_path = decorate_path(path, kind, meta_modified)
 
388
        if show_ids:
 
389
            to_file.write(with_file_id_format % dec_path)
 
390
        else:
 
391
            to_file.write(default_format % dec_path)
 
392
 
 
393
    def show_list(files, long_status_name, short_status_letter,
 
394
                  default_format='%s', with_file_id_format='%-30s',
 
395
                  show_more=None):
 
396
        if files:
 
397
            header_shown = False
 
398
            if short_status:
 
399
                prefix = short_status_letter
 
400
            else:
 
401
                prefix = ''
 
402
            prefix = indent + prefix + '  '
 
403
 
 
404
            for item in files:
 
405
                path, file_id, kind = item[:3]
 
406
                if (filter is not None and not filter(path, file_id)):
 
407
                    continue
 
408
                if not header_shown and not short_status:
 
409
                    to_file.write(indent + long_status_name + ':\n')
 
410
                    header_shown = True
 
411
                meta_modified = None
 
412
                if len(item) == 5:
 
413
                    meta_modified = item[4]
 
414
 
 
415
                to_file.write(prefix)
 
416
                show_path(path, file_id, kind, meta_modified,
 
417
                          default_format, with_file_id_format)
 
418
                if show_more is not None:
 
419
                    show_more(item)
 
420
                if show_ids:
 
421
                    to_file.write(' %s' % file_id)
 
422
                to_file.write('\n')
 
423
 
 
424
    show_list(delta.removed, 'removed', 'D')
 
425
    show_list(delta.added, 'added', 'A')
 
426
    show_list(delta.missing, 'missing', '!')
 
427
    extra_modified = []
 
428
    # Reorder delta.renamed tuples so that all lists share the same
 
429
    # order for their 3 first fields and that they also begin like
 
430
    # the delta.modified tuples
 
431
    renamed = [(p, i, k, tm, mm, np)
 
432
               for  p, np, i, k, tm, mm  in delta.renamed]
 
433
    show_list(renamed, 'renamed', 'R', with_file_id_format='%s',
 
434
              show_more=show_more_renamed)
 
435
    show_list(delta.kind_changed, 'kind changed', 'K',
 
436
              with_file_id_format='%s',
 
437
              show_more=show_more_kind_changed)
 
438
    show_list(delta.modified + extra_modified, 'modified', 'M')
 
439
    if show_unchanged:
 
440
        show_list(delta.unchanged, 'unchanged', 'S')
 
441
 
 
442
    show_list(delta.unversioned, 'unknown', ' ')
 
443