~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Alexander Belchenko
  • Date: 2007-01-24 19:42:26 UTC
  • mfrom: (2234.3.5 0.14)
  • mto: This revision was merged to the branch mainline in revision 2243.
  • Revision ID: bialix@ukr.net-20070124194226-rl1rlatr3jc5cvhh
merge latest fixes from bzr.0.14

Show diffs side-by-side

added added

removed removed

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