← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

Fix test_upgrade defects related to non local or absent working trees.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
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
17
from bzrlib import (
 
18
    errors,
18
19
    osutils,
19
20
    )
20
 
from bzrlib.trace import is_quiet
 
21
from bzrlib.inventory import InventoryEntry
 
22
from bzrlib.trace import mutter
 
23
from bzrlib.symbol_versioning import deprecated_function, zero_nine
21
24
 
22
25
 
23
26
class TreeDelta(object):
24
27
    """Describes changes from one tree to another.
25
28
 
26
 
    Contains seven lists:
 
29
    Contains four lists:
27
30
 
28
31
    added
29
32
        (path, id, kind)
31
34
        (path, id, kind)
32
35
    renamed
33
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
34
 
    kind_changed
35
 
        (path, id, old_kind, new_kind)
36
37
    modified
37
38
        (path, id, kind, text_modified, meta_modified)
38
39
    unchanged
39
40
        (path, id, kind)
40
41
    unversioned
41
 
        (path, None, kind)
 
42
        (path, kind)
42
43
 
43
44
    Each id is listed only once.
44
45
 
45
46
    Files that are both modified and renamed are listed only in
46
47
    renamed, with the text_modified flag true. The text_modified
47
 
    applies either to the content of the file or the target of the
 
48
    applies either to the the content of the file or the target of the
48
49
    symbolic link, depending of the kind of file.
49
50
 
50
51
    Files are only considered renamed if their name has changed or
61
62
        self.modified = []
62
63
        self.unchanged = []
63
64
        self.unversioned = []
64
 
        self.missing = []
65
65
 
66
66
    def __eq__(self, other):
67
67
        if not isinstance(other, TreeDelta):
104
104
            if v[1] == file_id:
105
105
                return True
106
106
        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()
 
107
            
 
108
 
 
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
110
             short_status=False):
 
111
        """output this delta in status-like form to to_file."""
 
112
        def show_list(files, short_status_letter=''):
 
113
            for item in files:
 
114
                path, fid, kind = item[:3]
 
115
 
 
116
                if kind == 'directory':
 
117
                    path += '/'
 
118
                elif kind == 'symlink':
 
119
                    path += '@'
 
120
 
 
121
                if len(item) == 5 and item[4]:
 
122
                    path += '*'
 
123
 
 
124
                if show_ids:
 
125
                    print >>to_file, '%s  %-30s %s' % (short_status_letter,
 
126
                        path, fid)
 
127
                else:
 
128
                    print >>to_file, '%s  %s' % (short_status_letter, path)
 
129
            
 
130
        if self.removed:
 
131
            if not short_status:
 
132
                print >>to_file, 'removed:'
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
 
136
                
 
137
        if self.added:
 
138
            if not short_status:
 
139
                print >>to_file, 'added:'
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
 
143
 
 
144
        extra_modified = []
 
145
 
 
146
        if self.renamed:
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                print >>to_file, 'renamed:'
 
150
                short_status_letter = ''
 
151
            for (oldpath, newpath, fid, kind,
 
152
                 text_modified, meta_modified) in self.renamed:
 
153
                if text_modified or meta_modified:
 
154
                    extra_modified.append((newpath, fid, kind,
 
155
                                           text_modified, meta_modified))
 
156
                if meta_modified:
 
157
                    newpath += '*'
 
158
                if show_ids:
 
159
                    print >>to_file, '%s  %s => %s %s' % (
 
160
                        short_status_letter, oldpath, newpath, fid)
 
161
                else:
 
162
                    print >>to_file, '%s  %s => %s' % (
 
163
                        short_status_letter, oldpath, newpath)
 
164
 
 
165
        if self.kind_changed:
 
166
            if short_status:
 
167
                short_status_letter = 'K'
 
168
            else:
 
169
                print >>to_file, 'kind changed:'
 
170
                short_status_letter = ''
 
171
            for (path, fid, old_kind, new_kind) in self.kind_changed:
 
172
                if show_ids:
 
173
                    suffix = ' '+fid
 
174
                else:
 
175
                    suffix = ''
 
176
                print >>to_file, '%s  %s (%s => %s)%s' % (
 
177
                    short_status_letter, path, old_kind, new_kind, suffix)
 
178
 
 
179
        if self.modified or extra_modified:
 
180
            short_status_letter = 'M'
 
181
            if not short_status:
 
182
                print >>to_file, 'modified:'
 
183
                short_status_letter = ''
 
184
            show_list(self.modified, short_status_letter)
 
185
            show_list(extra_modified, short_status_letter)
 
186
            
 
187
        if show_unchanged and self.unchanged:
 
188
            if not short_status:
 
189
                print >>to_file, 'unchanged:'
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            print >>to_file, 'unknown:'
 
196
            show_list(self.unversioned)
 
197
 
 
198
 
 
199
@deprecated_function(zero_nine)
 
200
def compare_trees(old_tree, new_tree, want_unchanged=False,
 
201
                  specific_files=None, extra_trees=None,
 
202
                  require_versioned=False):
 
203
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
 
204
    return new_tree.changes_from(old_tree,
 
205
        want_unchanged=want_unchanged,
 
206
        specific_files=specific_files,
 
207
        extra_trees=extra_trees,
 
208
        require_versioned=require_versioned,
 
209
        include_root=False)
114
210
 
115
211
 
116
212
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
117
213
                   include_root, extra_trees=None,
118
 
                   require_versioned=False, want_unversioned=False):
 
214
                   want_unversioned=False):
119
215
    """Worker function that implements Tree.changes_from."""
120
216
    delta = TreeDelta()
121
217
    # mutter('start compare_trees')
122
218
 
123
219
    for (file_id, path, content_change, versioned, parent_id, name, kind,
124
 
         executable) in new_tree.iter_changes(old_tree, want_unchanged,
 
220
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
125
221
            specific_files, extra_trees=extra_trees,
126
 
            require_versioned=require_versioned,
127
222
            want_unversioned=want_unversioned):
128
223
        if versioned == (False, False):
129
224
            delta.unversioned.append((path[1], None, kind[1]))
136
231
            if fully_present[1] is True:
137
232
                delta.added.append((path[1], file_id, kind[1]))
138
233
            else:
 
234
                assert fully_present[0] is True
139
235
                delta.removed.append((path[0], file_id, kind[0]))
140
236
        elif fully_present[0] is False:
141
 
            delta.missing.append((path[1], file_id, kind[1]))
 
237
            continue
142
238
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
143
239
            # If the name changes, or the parent_id changes, we have a rename
144
240
            # (if we move a parent, that doesn't count as a rename for the
151
247
                                  (executable[0] != executable[1])))
152
248
        elif kind[0] != kind[1]:
153
249
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
154
 
        elif content_change or executable[0] != executable[1]:
 
250
        elif content_change is True or executable[0] != executable[1]:
155
251
            delta.modified.append((path[1], file_id, kind[1],
156
252
                                   content_change,
157
253
                                   (executable[0] != executable[1])))
161
257
    delta.removed.sort()
162
258
    delta.added.sort()
163
259
    delta.renamed.sort()
164
 
    delta.missing.sort()
165
260
    # TODO: jam 20060529 These lists shouldn't need to be sorted
166
261
    #       since we added them in alphabetical order.
167
262
    delta.modified.sort()
170
265
    return delta
171
266
 
172
267
 
173
 
class _ChangeReporter(object):
 
268
class ChangeReporter(object):
174
269
    """Report changes between two trees"""
175
270
 
176
271
    def __init__(self, output=None, suppress_root_add=True,
177
 
                 output_file=None, unversioned_filter=None, view_info=None,
178
 
                 classify=True):
 
272
                 output_file=None, unversioned_filter=None):
179
273
        """Constructor
180
274
 
181
275
        :param output: a function with the signature of trace.note, i.e.
184
278
            (i.e. when a tree has just been initted)
185
279
        :param output_file: If supplied, a file-like object to write to.
186
280
            Only one of output and output_file may be supplied.
187
 
        :param unversioned_filter: A filter function to be called on
 
281
        :param unversioned_filter: A filter function to be called on 
188
282
            unversioned files. This should return True to ignore a path.
189
283
            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
284
        """
195
285
        if output_file is not None:
196
286
            if output is not None:
206
296
                             'unchanged': ' ',
207
297
                             'created': 'N',
208
298
                             'modified': 'M',
209
 
                             'deleted': 'D',
210
 
                             'missing': '!',
211
 
                             }
 
299
                             'deleted': 'D'}
212
300
        self.versioned_map = {'added': '+', # versioned target
213
301
                              'unchanged': ' ', # versioned in both
214
302
                              'removed': '-', # versioned in source
215
303
                              'unversioned': '?', # versioned in neither
216
304
                              }
217
305
        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
306
 
231
307
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
232
308
               kind):
233
309
        """Report one change to a file
234
310
 
235
311
        :param file_id: The file_id of the file
236
 
        :param path: The old and new paths as generated by Tree.iter_changes.
 
312
        :param path: The old and new paths as generated by Tree._iter_changes.
237
313
        :param versioned: may be 'added', 'removed', 'unchanged', or
238
314
            'unversioned.
239
315
        :param renamed: may be True or False
240
316
        :param modified: may be 'created', 'deleted', 'kind changed',
241
317
            'modified' or 'unchanged'.
242
318
        :param exe_change: True if the execute bit has changed
243
 
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
319
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
244
320
            None indicates no file present.
245
321
        """
246
 
        if is_quiet():
247
 
            return
248
322
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
249
323
            return
250
 
        if self.view_files and not osutils.is_inside_any(self.view_files,
251
 
            paths[1]):
252
 
            return
253
324
        if versioned == 'unversioned':
254
325
            # skip ignored unversioned files if needed.
255
326
            if self.unversioned_filter is not None:
267
338
                # on a rename, we show old and new
268
339
                old_path, path = paths
269
340
            else:
270
 
                # if it's not renamed, we're showing both for kind changes
 
341
                # if its not renamed, we're showing both for kind changes
271
342
                # so only show the new path
272
343
                old_path, path = paths[1], paths[1]
273
344
            # if the file is not missing in the source, we show its kind
274
345
            # when we show two paths.
275
346
            if kind[0] is not None:
276
 
                old_path += self.kind_marker(kind[0])
 
347
                old_path += osutils.kind_marker(kind[0])
277
348
            old_path += " => "
278
 
        elif versioned == 'removed':
279
 
            # not present in target
280
 
            old_path = ""
281
 
            path = paths[0]
282
349
        else:
283
350
            old_path = ""
284
351
            path = paths[1]
288
355
            rename = self.versioned_map[versioned]
289
356
        # we show the old kind on the new path when the content is deleted.
290
357
        if modified == 'deleted':
291
 
            path += self.kind_marker(kind[0])
 
358
            path += osutils.kind_marker(kind[0])
292
359
        # otherwise we always show the current kind when there is one
293
360
        elif kind[1] is not None:
294
 
            path += self.kind_marker(kind[1])
 
361
            path += osutils.kind_marker(kind[1])
295
362
        if exe_change:
296
363
            exe = '*'
297
364
        else:
299
366
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
300
367
                    old_path, path)
301
368
 
 
369
 
302
370
def report_changes(change_iterator, reporter):
303
371
    """Report the changes from a change iterator.
304
372
 
306
374
    Further processing may be required to produce a human-readable output.
307
375
    Unfortunately, some tree-changing operations are very complex
308
376
    :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.
 
377
        generated by Tree._iter_changes
 
378
    :param reporter: The ChangeReporter that will report the changes.
311
379
    """
312
380
    versioned_change_map = {
313
381
        (True, True)  : 'unchanged',
335
403
        else:
336
404
            if content_change:
337
405
                modified = "modified"
338
 
            elif kind[0] is None:
339
 
                modified = "missing"
340
406
            else:
341
407
                modified = "unchanged"
342
408
            if kind[1] == "file":
344
410
        versioned_change = versioned_change_map[versioned]
345
411
        reporter.report(file_id, path, versioned_change, renamed, modified,
346
412
                        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