← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Martin Pool
  • Date: 2005-09-13 23:08:19 UTC
  • Revision ID: mbp@sourcefrog.net-20050913230819-6ceae96050d32faa
ignore .bzr-shelf

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical Ltd
2
 
#
 
1
#! /usr/bin/env python
 
2
# -*- coding: UTF-8 -*-
 
3
 
3
4
# This program is free software; you can redistribute it and/or modify
4
5
# it under the terms of the GNU General Public License as published by
5
6
# the Free Software Foundation; either version 2 of the License, or
6
7
# (at your option) any later version.
7
 
#
 
8
 
8
9
# This program is distributed in the hope that it will be useful,
9
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
12
# GNU General Public License for more details.
12
 
#
 
13
 
13
14
# You should have received a copy of the GNU General Public License
14
15
# along with this program; if not, write to the Free Software
15
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
17
 
17
 
from bzrlib import (
18
 
    errors,
19
 
    osutils,
20
 
    )
21
 
from bzrlib.inventory import InventoryEntry
22
18
from bzrlib.trace import mutter
23
 
from bzrlib.symbol_versioning import deprecated_function
24
 
 
25
19
 
26
20
class TreeDelta(object):
27
21
    """Describes changes from one tree to another.
33
27
    removed
34
28
        (path, id, kind)
35
29
    renamed
36
 
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
30
        (oldpath, newpath, id, kind, text_modified)
37
31
    modified
38
 
        (path, id, kind, text_modified, meta_modified)
 
32
        (path, id, kind)
39
33
    unchanged
40
34
        (path, id, kind)
41
 
    unversioned
42
 
        (path, kind)
43
35
 
44
36
    Each id is listed only once.
45
37
 
46
38
    Files that are both modified and renamed are listed only in
47
 
    renamed, with the text_modified flag true. The text_modified
48
 
    applies either to the the content of the file or the target of the
49
 
    symbolic link, depending of the kind of file.
 
39
    renamed, with the text_modified flag true.
50
40
 
51
41
    Files are only considered renamed if their name has changed or
52
42
    their parent directory has changed.  Renaming a directory
58
48
        self.added = []
59
49
        self.removed = []
60
50
        self.renamed = []
61
 
        self.kind_changed = []
62
51
        self.modified = []
63
52
        self.unchanged = []
64
 
        self.unversioned = []
65
53
 
66
54
    def __eq__(self, other):
67
55
        if not isinstance(other, TreeDelta):
70
58
               and self.removed == other.removed \
71
59
               and self.renamed == other.renamed \
72
60
               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
 
61
               and self.unchanged == other.unchanged
76
62
 
77
63
    def __ne__(self, other):
78
64
        return not (self == other)
79
65
 
80
66
    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)
 
67
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
68
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
69
            self.modified, self.unchanged)
86
70
 
87
71
    def has_changed(self):
88
72
        return bool(self.modified
89
73
                    or self.added
90
74
                    or self.removed
91
 
                    or self.renamed
92
 
                    or self.kind_changed)
 
75
                    or self.renamed)
93
76
 
94
77
    def touches_file_id(self, file_id):
95
78
        """Return True if file_id is modified by this delta."""
100
83
        for v in self.renamed:
101
84
            if v[2] == file_id:
102
85
                return True
103
 
        for v in self.kind_changed:
104
 
            if v[1] == file_id:
105
 
                return True
106
86
        return False
107
87
            
108
88
 
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=''):
113
 
            for item in files:
114
 
                path, fid, kind = item[:3]
115
 
 
 
89
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
90
        def show_list(files):
 
91
            for path, fid, kind in files:
116
92
                if kind == 'directory':
117
93
                    path += '/'
118
94
                elif kind == 'symlink':
119
95
                    path += '@'
120
 
 
121
 
                if len(item) == 5 and item[4]:
122
 
                    path += '*'
123
 
 
 
96
                    
124
97
                if show_ids:
125
 
                    print >>to_file, indent + '%s  %-30s %s' % (short_status_letter,
126
 
                        path, fid)
 
98
                    print >>to_file, '  %-30s %s' % (path, fid)
127
99
                else:
128
 
                    print >>to_file, indent + '%s  %s' % (short_status_letter, path)
 
100
                    print >>to_file, ' ', path
129
101
            
130
102
        if 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')
 
103
            print >>to_file, 'removed:'
 
104
            show_list(self.removed)
136
105
                
137
106
        if 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')
143
 
 
144
 
        extra_modified = []
 
107
            print >>to_file, 'added:'
 
108
            show_list(self.added)
145
109
 
146
110
        if self.renamed:
147
 
            short_status_letter = 'R'
148
 
            if not short_status:
149
 
                print >>to_file, indent + '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, 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
 
 
179
 
        if self.modified or 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)
 
111
            print >>to_file, 'renamed:'
 
112
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
113
                if show_ids:
 
114
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
115
                else:
 
116
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
117
                    
 
118
        if self.modified:
 
119
            print >>to_file, 'modified:'
 
120
            show_list(self.modified)
186
121
            
187
122
        if show_unchanged and self.unchanged:
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."""
 
123
            print >>to_file, 'unchanged:'
 
124
            show_list(self.unchanged)
 
125
 
 
126
 
 
127
 
 
128
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
129
    """Describe changes from one tree to another.
 
130
 
 
131
    Returns a TreeDelta with details of added, modified, renamed, and
 
132
    deleted entries.
 
133
 
 
134
    The root entry is specifically exempt.
 
135
 
 
136
    This only considers versioned files.
 
137
 
 
138
    want_unchanged
 
139
        If true, also list files unchanged from one version to
 
140
        the next.
 
141
 
 
142
    specific_files
 
143
        If true, only check for changes to specified names or
 
144
        files within them.
 
145
    """
 
146
 
 
147
    from osutils import is_inside_any
 
148
    
 
149
    old_inv = old_tree.inventory
 
150
    new_inv = new_tree.inventory
210
151
    delta = TreeDelta()
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]))
 
152
    mutter('start compare_trees')
 
153
 
 
154
    # TODO: match for specific files can be rather smarter by finding
 
155
    # the IDs of those files up front and then considering only that.
 
156
 
 
157
    for file_id in old_tree:
 
158
        if file_id in new_tree:
 
159
            old_ie = old_inv[file_id]
 
160
            new_ie = new_inv[file_id]
 
161
 
 
162
            kind = old_ie.kind
 
163
            assert kind == new_ie.kind
 
164
            
 
165
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
166
                   'invalid file kind %r' % kind
 
167
 
 
168
            if kind == 'root_directory':
 
169
                continue
 
170
            
 
171
            if specific_files:
 
172
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
173
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
174
                    continue
 
175
 
 
176
            if kind == 'file':
 
177
                old_sha1 = old_tree.get_file_sha1(file_id)
 
178
                new_sha1 = new_tree.get_file_sha1(file_id)
 
179
                text_modified = (old_sha1 != new_sha1)
228
180
            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])))
 
181
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
182
                text_modified = False
 
183
 
 
184
            # TODO: Can possibly avoid calculating path strings if the
 
185
            # two files are unchanged and their names and parents are
 
186
            # the same and the parents are unchanged all the way up.
 
187
            # May not be worthwhile.
 
188
            
 
189
            if (old_ie.name != new_ie.name
 
190
                or old_ie.parent_id != new_ie.parent_id):
 
191
                delta.renamed.append((old_inv.id2path(file_id),
 
192
                                      new_inv.id2path(file_id),
 
193
                                      file_id, kind,
 
194
                                      text_modified))
 
195
            elif text_modified:
 
196
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
197
            elif want_unchanged:
 
198
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
249
199
        else:
250
 
            delta.unchanged.append((path[1], file_id, kind[1]))
 
200
            kind = old_inv.get_file_kind(file_id)
 
201
            if kind == 'root_directory':
 
202
                continue
 
203
            old_path = old_inv.id2path(file_id)
 
204
            if specific_files:
 
205
                if not is_inside_any(specific_files, old_path):
 
206
                    continue
 
207
            delta.removed.append((old_path, file_id, kind))
251
208
 
 
209
    mutter('start looking for new files')
 
210
    for file_id in new_inv:
 
211
        if file_id in old_inv:
 
212
            continue
 
213
        kind = new_inv.get_file_kind(file_id)
 
214
        if kind == 'root_directory':
 
215
            continue
 
216
        new_path = new_inv.id2path(file_id)
 
217
        if specific_files:
 
218
            if not is_inside_any(specific_files, new_path):
 
219
                continue
 
220
        delta.added.append((new_path, file_id, kind))
 
221
            
252
222
    delta.removed.sort()
253
223
    delta.added.sort()
254
224
    delta.renamed.sort()
255
 
    # TODO: jam 20060529 These lists shouldn't need to be sorted
256
 
    #       since we added them in alphabetical order.
257
225
    delta.modified.sort()
258
226
    delta.unchanged.sort()
259
227
 
260
228
    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)