← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Vincent Ladeuil
  • Date: 2013-10-04 09:56:23 UTC
  • mto: (6588.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6589.
  • Revision ID: v.ladeuil+lp@free.fr-20131004095623-xlan34vg0y51gdb5
https://launchpad.net/bugs/1235099
Stricter checks on configuration option names

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
 
 
17
from __future__ import absolute_import
16
18
 
17
19
from bzrlib import (
18
 
    errors,
19
20
    osutils,
20
21
    )
21
 
from bzrlib.inventory import InventoryEntry
22
 
from bzrlib.trace import mutter
23
 
from bzrlib.symbol_versioning import deprecated_function, zero_nine
 
22
from bzrlib.trace import is_quiet
24
23
 
25
24
 
26
25
class TreeDelta(object):
27
26
    """Describes changes from one tree to another.
28
27
 
29
 
    Contains four lists:
 
28
    Contains seven lists:
30
29
 
31
30
    added
32
31
        (path, id, kind)
34
33
        (path, id, kind)
35
34
    renamed
36
35
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
36
    kind_changed
 
37
        (path, id, old_kind, new_kind)
37
38
    modified
38
39
        (path, id, kind, text_modified, meta_modified)
39
40
    unchanged
40
41
        (path, id, kind)
 
42
    unversioned
 
43
        (path, None, kind)
41
44
 
42
45
    Each id is listed only once.
43
46
 
44
47
    Files that are both modified and renamed are listed only in
45
48
    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
 
49
    applies either to the content of the file or the target of the
47
50
    symbolic link, depending of the kind of file.
48
51
 
49
52
    Files are only considered renamed if their name has changed or
59
62
        self.kind_changed = []
60
63
        self.modified = []
61
64
        self.unchanged = []
 
65
        self.unversioned = []
 
66
        self.missing = []
62
67
 
63
68
    def __eq__(self, other):
64
69
        if not isinstance(other, TreeDelta):
68
73
               and self.renamed == other.renamed \
69
74
               and self.modified == other.modified \
70
75
               and self.unchanged == other.unchanged \
71
 
               and self.kind_changed == other.kind_changed
 
76
               and self.kind_changed == other.kind_changed \
 
77
               and self.unversioned == other.unversioned
72
78
 
73
79
    def __ne__(self, other):
74
80
        return not (self == other)
75
81
 
76
82
    def __repr__(self):
77
83
        return "TreeDelta(added=%r, removed=%r, renamed=%r," \
78
 
            " kind_changed=%r, modified=%r, unchanged=%r)" % (self.added,
 
84
            " kind_changed=%r, modified=%r, unchanged=%r," \
 
85
            " unversioned=%r)" % (self.added,
79
86
            self.removed, self.renamed, self.kind_changed, self.modified,
80
 
            self.unchanged)
 
87
            self.unchanged, self.unversioned)
81
88
 
82
89
    def has_changed(self):
83
90
        return bool(self.modified
99
106
            if v[1] == file_id:
100
107
                return True
101
108
        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)
201
 
 
202
 
 
203
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids,
204
 
                   include_root):
 
109
 
 
110
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
 
111
                            short_status=False):
 
112
        import StringIO
 
113
        output = StringIO.StringIO()
 
114
        report_delta(output, self, short_status, show_ids, show_unchanged)
 
115
        return output.getvalue()
 
116
 
 
117
 
 
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."""
205
122
    delta = TreeDelta()
206
123
    # mutter('start compare_trees')
207
124
 
208
125
    for (file_id, path, content_change, versioned, parent_id, name, kind,
209
 
         executable) in new_tree._iter_changes(old_tree, want_unchanged, 
210
 
                                               specific_file_ids):
 
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]))
 
132
            continue
211
133
        if not include_root and (None, None) == parent_id:
212
134
            continue
213
135
        fully_present = tuple((versioned[x] and kind[x] is not None) for
214
136
                              x in range(2))
215
137
        if fully_present[0] != fully_present[1]:
216
138
            if fully_present[1] is True:
217
 
                delta.added.append((path, file_id, kind[1]))
 
139
                delta.added.append((path[1], file_id, kind[1]))
218
140
            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]))
 
141
                delta.removed.append((path[0], file_id, kind[0]))
222
142
        elif fully_present[0] is False:
223
 
            continue
 
143
            delta.missing.append((path[1], file_id, kind[1]))
224
144
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
225
145
            # If the name changes, or the parent_id changes, we have a rename
226
146
            # (if we move a parent, that doesn't count as a rename for the
227
147
            # file)
228
 
            old_path = old_tree.id2path(file_id)
229
 
            delta.renamed.append((old_path,
230
 
                                  path,
231
 
                                  file_id, 
 
148
            delta.renamed.append((path[0],
 
149
                                  path[1],
 
150
                                  file_id,
232
151
                                  kind[1],
233
 
                                  content_change, 
 
152
                                  content_change,
234
153
                                  (executable[0] != executable[1])))
235
154
        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, 
 
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],
 
158
                                   content_change,
240
159
                                   (executable[0] != executable[1])))
241
160
        else:
242
 
            delta.unchanged.append((path, file_id, kind[1]))
 
161
            delta.unchanged.append((path[1], file_id, kind[1]))
243
162
 
244
163
    delta.removed.sort()
245
164
    delta.added.sort()
246
165
    delta.renamed.sort()
 
166
    delta.missing.sort()
247
167
    # TODO: jam 20060529 These lists shouldn't need to be sorted
248
168
    #       since we added them in alphabetical order.
249
169
    delta.modified.sort()
252
172
    return delta
253
173
 
254
174
 
255
 
class ChangeReporter(object):
 
175
class _ChangeReporter(object):
256
176
    """Report changes between two trees"""
257
177
 
258
 
    def __init__(self, old_inventory, output=None, suppress_root_add=True,
259
 
                 output_file=None):
 
178
    def __init__(self, output=None, suppress_root_add=True,
 
179
                 output_file=None, unversioned_filter=None, view_info=None,
 
180
                 classify=True):
260
181
        """Constructor
261
182
 
262
 
        :param old_inventory: The inventory of the old tree
263
183
        :param output: a function with the signature of trace.note, i.e.
264
184
            accepts a format and parameters.
265
185
        :param supress_root_add: If true, adding the root will be ignored
266
186
            (i.e. when a tree has just been initted)
267
187
        :param output_file: If supplied, a file-like object to write to.
268
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
 
194
            no view filtering.
 
195
        :param classify: Add special symbols to indicate file kind.
269
196
        """
270
 
        self.old_inventory = old_inventory
271
197
        if output_file is not None:
272
198
            if output is not None:
273
199
                raise BzrError('Cannot specify both output and output_file')
278
204
            from bzrlib import trace
279
205
            self.output = trace.note
280
206
        self.suppress_root_add = suppress_root_add
 
207
        self.modified_map = {'kind changed': 'K',
 
208
                             'unchanged': ' ',
 
209
                             'created': 'N',
 
210
                             'modified': 'M',
 
211
                             'deleted': 'D',
 
212
                             'missing': '!',
 
213
                             }
 
214
        self.versioned_map = {'added': '+', # versioned target
 
215
                              'unchanged': ' ', # versioned in both
 
216
                              'removed': '-', # versioned in source
 
217
                              'unversioned': '?', # versioned in neither
 
218
                              }
 
219
        self.unversioned_filter = unversioned_filter
 
220
        if classify:
 
221
            self.kind_marker = osutils.kind_marker
 
222
        else:
 
223
            self.kind_marker = lambda kind: ''
 
224
        if view_info is None:
 
225
            self.view_name = None
 
226
            self.view_files = []
 
227
        else:
 
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,))
281
232
 
282
 
    def report(self, file_id, path, versioned, renamed, modified, exe_change,
 
233
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
283
234
               kind):
284
235
        """Report one change to a file
285
236
 
286
237
        :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'
 
238
        :param path: The old and new paths as generated by Tree.iter_changes.
 
239
        :param versioned: may be 'added', 'removed', 'unchanged', or
 
240
            'unversioned.
290
241
        :param renamed: may be True or False
291
242
        :param modified: may be 'created', 'deleted', 'kind changed',
292
243
            'modified' or 'unchanged'.
293
244
        :param exe_change: True if the execute bit has changed
294
 
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
 
245
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
295
246
            None indicates no file present.
296
247
        """
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 = ""
 
248
        if is_quiet():
 
249
            return
 
250
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
 
251
            return
 
252
        if self.view_files and not osutils.is_inside_any(self.view_files,
 
253
            paths[1]):
 
254
            return
 
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]):
 
259
                    return
 
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')):
 
268
            if renamed:
 
269
                # on a rename, we show old and new
 
270
                old_path, path = paths
 
271
            else:
 
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])
 
279
            old_path += " => "
 
280
        elif versioned == 'removed':
 
281
            # not present in target
 
282
            old_path = ""
 
283
            path = paths[0]
 
284
        else:
 
285
            old_path = ""
 
286
            path = paths[1]
308
287
        if renamed:
309
 
            old_path = self.old_inventory.id2path(file_id)
310
288
            rename = "R"
311
289
        else:
312
 
            rename = versioned_map[versioned]
313
 
        if modified == 'kind changed':
314
 
            if old_path == "":
315
 
                old_path = path
 
290
            rename = self.versioned_map[versioned]
 
291
        # we show the old kind on the new path when the content is deleted.
316
292
        if modified == 'deleted':
317
 
            path += osutils.kind_marker(kind[0])
 
293
            path += self.kind_marker(kind[0])
 
294
        # otherwise we always show the current kind when there is one
318
295
        elif kind[1] is not None:
319
 
            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 += " => "
 
296
            path += self.kind_marker(kind[1])
324
297
        if exe_change:
325
298
            exe = '*'
326
299
        else:
327
300
            exe = ' '
328
 
        self.output("%s%s%s %s%s", rename, modified_map[modified], exe,
 
301
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
329
302
                    old_path, path)
330
303
 
331
 
 
332
304
def report_changes(change_iterator, reporter):
333
305
    """Report the changes from a change iterator.
334
306
 
336
308
    Further processing may be required to produce a human-readable output.
337
309
    Unfortunately, some tree-changing operations are very complex
338
310
    :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.
 
311
        generated by Tree.iter_changes
 
312
    :param reporter: The _ChangeReporter that will report the changes.
341
313
    """
 
314
    versioned_change_map = {
 
315
        (True, True)  : 'unchanged',
 
316
        (True, False) : 'removed',
 
317
        (False, True) : 'added',
 
318
        (False, False): 'unversioned',
 
319
        }
342
320
    for (file_id, path, content_change, versioned, parent_id, name, kind,
343
321
         executable) in change_iterator:
344
322
        exe_change = False
359
337
        else:
360
338
            if content_change:
361
339
                modified = "modified"
 
340
            elif kind[0] is None:
 
341
                modified = "missing"
362
342
            else:
363
343
                modified = "unchanged"
364
344
            if kind[1] == "file":
365
345
                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"
 
346
        versioned_change = versioned_change_map[versioned]
373
347
        reporter.report(file_id, path, versioned_change, renamed, modified,
374
348
                        exe_change, kind)
 
349
 
 
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.
 
353
 
 
354
    :param to_file: A file-like object where the output is displayed.
 
355
 
 
356
    :param delta: A TreeDelta containing the changes to be displayed
 
357
 
 
358
    :param short_status: Single-line status if True.
 
359
 
 
360
    :param show_ids: Output the file ids if True.
 
361
 
 
362
    :param show_unchanged: Output the unchanged files if True.
 
363
 
 
364
    :param indent: Added at the beginning of all output lines (for merged
 
365
        revisions).
 
366
 
 
367
    :param filter: A callable receiving a path and a file id and
 
368
        returning True if the path should be displayed.
 
369
 
 
370
    :param classify: Add special symbols to indicate file kind.
 
371
    """
 
372
 
 
373
    def decorate_path(path, kind, meta_modified=None):
 
374
        if not classify:
 
375
            return path
 
376
        if kind == 'directory':
 
377
            path += '/'
 
378
        elif kind == 'symlink':
 
379
            path += '@'
 
380
        if meta_modified:
 
381
            path += '*'
 
382
        return path
 
383
 
 
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))
 
392
 
 
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))
 
396
 
 
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)
 
400
        if show_ids:
 
401
            to_file.write(with_file_id_format % dec_path)
 
402
        else:
 
403
            to_file.write(default_format % dec_path)
 
404
 
 
405
    def show_list(files, long_status_name, short_status_letter,
 
406
                  default_format='%s', with_file_id_format='%-30s',
 
407
                  show_more=None):
 
408
        if files:
 
409
            header_shown = False
 
410
            if short_status:
 
411
                prefix = short_status_letter
 
412
            else:
 
413
                prefix = ''
 
414
            prefix = indent + prefix + '  '
 
415
 
 
416
            for item in files:
 
417
                path, file_id, kind = item[:3]
 
418
                if (filter is not None and not filter(path, file_id)):
 
419
                    continue
 
420
                if not header_shown and not short_status:
 
421
                    to_file.write(indent + long_status_name + ':\n')
 
422
                    header_shown = True
 
423
                meta_modified = None
 
424
                if len(item) == 5:
 
425
                    meta_modified = item[4]
 
426
 
 
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:
 
431
                    show_more(item)
 
432
                if show_ids:
 
433
                    to_file.write(' %s' % file_id)
 
434
                to_file.write('\n')
 
435
 
 
436
    show_list(delta.removed, 'removed', 'D')
 
437
    show_list(delta.added, 'added', 'A')
 
438
    show_list(delta.missing, 'missing', '!')
 
439
    extra_modified = []
 
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')
 
451
    if show_unchanged:
 
452
        show_list(delta.unchanged, 'unchanged', 'S')
 
453
 
 
454
    show_list(delta.unversioned, 'unknown', ' ')
 
455