← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-09-20 02:40:52 UTC
  • mfrom: (2835.1.1 ianc-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20070920024052-y2l7r5o00zrpnr73
No longer propagate index differences automatically (Robert Collins)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical
2
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
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
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
 
17
from bzrlib import (
 
18
    errors,
 
19
    osutils,
 
20
    )
17
21
from bzrlib.inventory import InventoryEntry
18
22
from bzrlib.trace import mutter
 
23
from bzrlib.symbol_versioning import deprecated_function
 
24
 
19
25
 
20
26
class TreeDelta(object):
21
27
    """Describes changes from one tree to another.
32
38
        (path, id, kind, text_modified, meta_modified)
33
39
    unchanged
34
40
        (path, id, kind)
 
41
    unversioned
 
42
        (path, kind)
35
43
 
36
44
    Each id is listed only once.
37
45
 
50
58
        self.added = []
51
59
        self.removed = []
52
60
        self.renamed = []
 
61
        self.kind_changed = []
53
62
        self.modified = []
54
63
        self.unchanged = []
 
64
        self.unversioned = []
55
65
 
56
66
    def __eq__(self, other):
57
67
        if not isinstance(other, TreeDelta):
60
70
               and self.removed == other.removed \
61
71
               and self.renamed == other.renamed \
62
72
               and self.modified == other.modified \
63
 
               and self.unchanged == other.unchanged
 
73
               and self.unchanged == other.unchanged \
 
74
               and self.kind_changed == other.kind_changed \
 
75
               and self.unversioned == other.unversioned
64
76
 
65
77
    def __ne__(self, other):
66
78
        return not (self == other)
67
79
 
68
80
    def __repr__(self):
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)
 
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
86
 
73
87
    def has_changed(self):
74
88
        return bool(self.modified
75
89
                    or self.added
76
90
                    or self.removed
77
 
                    or self.renamed)
 
91
                    or self.renamed
 
92
                    or self.kind_changed)
78
93
 
79
94
    def touches_file_id(self, file_id):
80
95
        """Return True if file_id is modified by this delta."""
85
100
        for v in self.renamed:
86
101
            if v[2] == file_id:
87
102
                return True
 
103
        for v in self.kind_changed:
 
104
            if v[1] == file_id:
 
105
                return True
88
106
        return False
89
107
            
90
108
 
91
 
    def show(self, to_file, show_ids=False, show_unchanged=False):
92
 
        def show_list(files):
 
109
    def show(self, to_file, show_ids=False, show_unchanged=False,
 
110
             short_status=False, indent=''):
 
111
        """output this delta in status-like form to to_file."""
 
112
        def show_list(files, short_status_letter=''):
93
113
            for item in files:
94
114
                path, fid, kind = item[:3]
95
115
 
102
122
                    path += '*'
103
123
 
104
124
                if show_ids:
105
 
                    print >>to_file, '  %-30s %s' % (path, fid)
 
125
                    print >>to_file, indent + '%s  %-30s %s' % (short_status_letter,
 
126
                        path, fid)
106
127
                else:
107
 
                    print >>to_file, ' ', path
 
128
                    print >>to_file, indent + '%s  %s' % (short_status_letter, path)
108
129
            
109
130
        if self.removed:
110
 
            print >>to_file, 'removed:'
111
 
            show_list(self.removed)
 
131
            if not short_status:
 
132
                print >>to_file, indent + 'removed:'
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
112
136
                
113
137
        if self.added:
114
 
            print >>to_file, 'added:'
115
 
            show_list(self.added)
 
138
            if not short_status:
 
139
                print >>to_file, indent + 'added:'
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
116
143
 
117
144
        extra_modified = []
118
145
 
119
146
        if self.renamed:
120
 
            print >>to_file, 'renamed:'
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                print >>to_file, indent + 'renamed:'
 
150
                short_status_letter = ''
121
151
            for (oldpath, newpath, fid, kind,
122
152
                 text_modified, meta_modified) in self.renamed:
123
153
                if text_modified or meta_modified:
126
156
                if meta_modified:
127
157
                    newpath += '*'
128
158
                if show_ids:
129
 
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
130
 
                else:
131
 
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
132
 
                    
 
159
                    print >>to_file, indent + '%s  %s => %s %s' % (
 
160
                        short_status_letter, oldpath, newpath, fid)
 
161
                else:
 
162
                    print >>to_file, indent + '%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, indent + '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, indent + '%s  %s (%s => %s)%s' % (
 
177
                    short_status_letter, path, old_kind, new_kind, suffix)
 
178
 
133
179
        if self.modified or extra_modified:
134
 
            print >>to_file, 'modified:'
135
 
            show_list(self.modified)
136
 
            show_list(extra_modified)
 
180
            short_status_letter = 'M'
 
181
            if not short_status:
 
182
                print >>to_file, indent + 'modified:'
 
183
                short_status_letter = ''
 
184
            show_list(self.modified, short_status_letter)
 
185
            show_list(extra_modified, short_status_letter)
137
186
            
138
187
        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.  Any unversioned files given have no effect
161
 
        (but this might change in the future).
162
 
    """
163
 
    # NB: show_status depends on being able to pass in non-versioned files and
164
 
    # report them as unknown
165
 
    old_tree.lock_read()
166
 
    try:
167
 
        new_tree.lock_read()
168
 
        try:
169
 
            return _compare_trees(old_tree, new_tree, want_unchanged,
170
 
                                  specific_files)
171
 
        finally:
172
 
            new_tree.unlock()
173
 
    finally:
174
 
        old_tree.unlock()
175
 
 
176
 
 
177
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
178
 
 
179
 
    from osutils import is_inside_any
180
 
    
181
 
    old_inv = old_tree.inventory
182
 
    new_inv = new_tree.inventory
 
188
            if not short_status:
 
189
                print >>to_file, indent + 'unchanged:'
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            print >>to_file, indent + 'unknown:'
 
196
            show_list(self.unversioned)
 
197
 
 
198
    def get_changes_as_text(self, show_ids=False, show_unchanged=False,
 
199
             short_status=False):
 
200
        import StringIO
 
201
        output = StringIO.StringIO()
 
202
        self.show(output, show_ids, show_unchanged, short_status)
 
203
        return output.getvalue()
 
204
 
 
205
 
 
206
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files,
 
207
                   include_root, extra_trees=None,
 
208
                   require_versioned=False, want_unversioned=False):
 
209
    """Worker function that implements Tree.changes_from."""
183
210
    delta = TreeDelta()
184
 
    mutter('start compare_trees')
185
 
 
186
 
    # TODO: Rather than iterating over the whole tree and then filtering, we
187
 
    # could diff just the specified files (if any) and their subtrees.  
188
 
    # Perhaps should take a list of file-ids instead?   Need to indicate any
189
 
    # ids or names which were not found in the trees.
190
 
 
191
 
    for file_id in old_tree:
192
 
        if file_id in new_tree:
193
 
            old_ie = old_inv[file_id]
194
 
            new_ie = new_inv[file_id]
195
 
 
196
 
            kind = old_ie.kind
197
 
            assert kind == new_ie.kind
198
 
            
199
 
            assert kind in InventoryEntry.known_kinds, \
200
 
                   'invalid file kind %r' % kind
201
 
 
202
 
            if kind == 'root_directory':
203
 
                continue
204
 
            
205
 
            if specific_files:
206
 
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
207
 
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
208
 
                    continue
209
 
 
210
 
            # temporary hack until all entries are populated before clients 
211
 
            # get them
212
 
            old_path = old_inv.id2path(file_id)
213
 
            new_path = new_inv.id2path(file_id)
214
 
            old_ie._read_tree_state(old_path, old_tree)
215
 
            new_ie._read_tree_state(new_path, new_tree)
216
 
            text_modified, meta_modified = new_ie.detect_changes(old_ie)
217
 
 
218
 
            # TODO: Can possibly avoid calculating path strings if the
219
 
            # two files are unchanged and their names and parents are
220
 
            # the same and the parents are unchanged all the way up.
221
 
            # May not be worthwhile.
222
 
            
223
 
            if (old_ie.name != new_ie.name
224
 
                or old_ie.parent_id != new_ie.parent_id):
225
 
                delta.renamed.append((old_path,
226
 
                                      new_path,
227
 
                                      file_id, kind,
228
 
                                      text_modified, meta_modified))
229
 
            elif text_modified or meta_modified:
230
 
                delta.modified.append((new_path, file_id, kind,
231
 
                                       text_modified, meta_modified))
232
 
            elif want_unchanged:
233
 
                delta.unchanged.append((new_path, file_id, kind))
 
211
    # mutter('start compare_trees')
 
212
 
 
213
    for (file_id, path, content_change, versioned, parent_id, name, kind,
 
214
         executable) in new_tree._iter_changes(old_tree, want_unchanged,
 
215
            specific_files, extra_trees=extra_trees,
 
216
            require_versioned=require_versioned,
 
217
            want_unversioned=want_unversioned):
 
218
        if versioned == (False, False):
 
219
            delta.unversioned.append((path[1], None, kind[1]))
 
220
            continue
 
221
        if not include_root and (None, None) == parent_id:
 
222
            continue
 
223
        fully_present = tuple((versioned[x] and kind[x] is not None) for
 
224
                              x in range(2))
 
225
        if fully_present[0] != fully_present[1]:
 
226
            if fully_present[1] is True:
 
227
                delta.added.append((path[1], file_id, kind[1]))
 
228
            else:
 
229
                assert fully_present[0] is True
 
230
                delta.removed.append((path[0], file_id, kind[0]))
 
231
        elif fully_present[0] is False:
 
232
            continue
 
233
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
 
234
            # If the name changes, or the parent_id changes, we have a rename
 
235
            # (if we move a parent, that doesn't count as a rename for the
 
236
            # file)
 
237
            delta.renamed.append((path[0],
 
238
                                  path[1],
 
239
                                  file_id,
 
240
                                  kind[1],
 
241
                                  content_change,
 
242
                                  (executable[0] != executable[1])))
 
243
        elif kind[0] != kind[1]:
 
244
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
 
245
        elif content_change is True or executable[0] != executable[1]:
 
246
            delta.modified.append((path[1], file_id, kind[1],
 
247
                                   content_change,
 
248
                                   (executable[0] != executable[1])))
234
249
        else:
235
 
            kind = old_inv.get_file_kind(file_id)
236
 
            if kind == 'root_directory':
237
 
                continue
238
 
            old_path = old_inv.id2path(file_id)
239
 
            if specific_files:
240
 
                if not is_inside_any(specific_files, old_path):
241
 
                    continue
242
 
            delta.removed.append((old_path, file_id, kind))
 
250
            delta.unchanged.append((path[1], file_id, kind[1]))
243
251
 
244
 
    mutter('start looking for new files')
245
 
    for file_id in new_inv:
246
 
        if file_id in old_inv or file_id not in new_tree:
247
 
            continue
248
 
        kind = new_inv.get_file_kind(file_id)
249
 
        if kind == 'root_directory':
250
 
            continue
251
 
        new_path = new_inv.id2path(file_id)
252
 
        if specific_files:
253
 
            if not is_inside_any(specific_files, new_path):
254
 
                continue
255
 
        delta.added.append((new_path, file_id, kind))
256
 
            
257
252
    delta.removed.sort()
258
253
    delta.added.sort()
259
254
    delta.renamed.sort()
 
255
    # TODO: jam 20060529 These lists shouldn't need to be sorted
 
256
    #       since we added them in alphabetical order.
260
257
    delta.modified.sort()
261
258
    delta.unchanged.sort()
262
259
 
263
260
    return delta
 
261
 
 
262
 
 
263
class _ChangeReporter(object):
 
264
    """Report changes between two trees"""
 
265
 
 
266
    def __init__(self, output=None, suppress_root_add=True,
 
267
                 output_file=None, unversioned_filter=None):
 
268
        """Constructor
 
269
 
 
270
        :param output: a function with the signature of trace.note, i.e.
 
271
            accepts a format and parameters.
 
272
        :param supress_root_add: If true, adding the root will be ignored
 
273
            (i.e. when a tree has just been initted)
 
274
        :param output_file: If supplied, a file-like object to write to.
 
275
            Only one of output and output_file may be supplied.
 
276
        :param unversioned_filter: A filter function to be called on 
 
277
            unversioned files. This should return True to ignore a path.
 
278
            By default, no filtering takes place.
 
279
        """
 
280
        if output_file is not None:
 
281
            if output is not None:
 
282
                raise BzrError('Cannot specify both output and output_file')
 
283
            def output(fmt, *args):
 
284
                output_file.write((fmt % args) + '\n')
 
285
        self.output = output
 
286
        if self.output is None:
 
287
            from bzrlib import trace
 
288
            self.output = trace.note
 
289
        self.suppress_root_add = suppress_root_add
 
290
        self.modified_map = {'kind changed': 'K',
 
291
                             'unchanged': ' ',
 
292
                             'created': 'N',
 
293
                             'modified': 'M',
 
294
                             'deleted': 'D'}
 
295
        self.versioned_map = {'added': '+', # versioned target
 
296
                              'unchanged': ' ', # versioned in both
 
297
                              'removed': '-', # versioned in source
 
298
                              'unversioned': '?', # versioned in neither
 
299
                              }
 
300
        self.unversioned_filter = unversioned_filter
 
301
 
 
302
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
 
303
               kind):
 
304
        """Report one change to a file
 
305
 
 
306
        :param file_id: The file_id of the file
 
307
        :param path: The old and new paths as generated by Tree._iter_changes.
 
308
        :param versioned: may be 'added', 'removed', 'unchanged', or
 
309
            'unversioned.
 
310
        :param renamed: may be True or False
 
311
        :param modified: may be 'created', 'deleted', 'kind changed',
 
312
            'modified' or 'unchanged'.
 
313
        :param exe_change: True if the execute bit has changed
 
314
        :param kind: A pair of file kinds, as generated by Tree._iter_changes.
 
315
            None indicates no file present.
 
316
        """
 
317
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
 
318
            return
 
319
        if versioned == 'unversioned':
 
320
            # skip ignored unversioned files if needed.
 
321
            if self.unversioned_filter is not None:
 
322
                if self.unversioned_filter(paths[1]):
 
323
                    return
 
324
            # dont show a content change in the output.
 
325
            modified = 'unchanged'
 
326
        # we show both paths in the following situations:
 
327
        # the file versioning is unchanged AND
 
328
        # ( the path is different OR
 
329
        #   the kind is different)
 
330
        if (versioned == 'unchanged' and
 
331
            (renamed or modified == 'kind changed')):
 
332
            if renamed:
 
333
                # on a rename, we show old and new
 
334
                old_path, path = paths
 
335
            else:
 
336
                # if its not renamed, we're showing both for kind changes
 
337
                # so only show the new path
 
338
                old_path, path = paths[1], paths[1]
 
339
            # if the file is not missing in the source, we show its kind
 
340
            # when we show two paths.
 
341
            if kind[0] is not None:
 
342
                old_path += osutils.kind_marker(kind[0])
 
343
            old_path += " => "
 
344
        elif versioned == 'removed':
 
345
            # not present in target
 
346
            old_path = ""
 
347
            path = paths[0]
 
348
        else:
 
349
            old_path = ""
 
350
            path = paths[1]
 
351
        if renamed:
 
352
            rename = "R"
 
353
        else:
 
354
            rename = self.versioned_map[versioned]
 
355
        # we show the old kind on the new path when the content is deleted.
 
356
        if modified == 'deleted':
 
357
            path += osutils.kind_marker(kind[0])
 
358
        # otherwise we always show the current kind when there is one
 
359
        elif kind[1] is not None:
 
360
            path += osutils.kind_marker(kind[1])
 
361
        if exe_change:
 
362
            exe = '*'
 
363
        else:
 
364
            exe = ' '
 
365
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
 
366
                    old_path, path)
 
367
 
 
368
 
 
369
def report_changes(change_iterator, reporter):
 
370
    """Report the changes from a change iterator.
 
371
 
 
372
    This is essentially a translation from low-level to medium-level changes.
 
373
    Further processing may be required to produce a human-readable output.
 
374
    Unfortunately, some tree-changing operations are very complex
 
375
    :change_iterator: an iterator or sequence of changes in the format
 
376
        generated by Tree._iter_changes
 
377
    :param reporter: The _ChangeReporter that will report the changes.
 
378
    """
 
379
    versioned_change_map = {
 
380
        (True, True)  : 'unchanged',
 
381
        (True, False) : 'removed',
 
382
        (False, True) : 'added',
 
383
        (False, False): 'unversioned',
 
384
        }
 
385
    for (file_id, path, content_change, versioned, parent_id, name, kind,
 
386
         executable) in change_iterator:
 
387
        exe_change = False
 
388
        # files are "renamed" if they are moved or if name changes, as long
 
389
        # as it had a value
 
390
        if None not in name and None not in parent_id and\
 
391
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
 
392
            renamed = True
 
393
        else:
 
394
            renamed = False
 
395
        if kind[0] != kind[1]:
 
396
            if kind[0] is None:
 
397
                modified = "created"
 
398
            elif kind[1] is None:
 
399
                modified = "deleted"
 
400
            else:
 
401
                modified = "kind changed"
 
402
        else:
 
403
            if content_change:
 
404
                modified = "modified"
 
405
            else:
 
406
                modified = "unchanged"
 
407
            if kind[1] == "file":
 
408
                exe_change = (executable[0] != executable[1])
 
409
        versioned_change = versioned_change_map[versioned]
 
410
        reporter.report(file_id, path, versioned_change, renamed, modified,
 
411
                        exe_change, kind)