~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Robert Collins
  • Date: 2005-12-02 03:23:47 UTC
  • Revision ID: robertc@robertcollins.net-20051202032347-ba08123207a945a0
Test for Jeff Bailey.

Show diffs side-by-side

added added

removed removed

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