← 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-08-30 01:35:40 UTC
  • Revision ID: mbp@sourcefrog.net-20050830013540-34e8996a86ba25fb
- rename FunctionalTest to TestCaseInTempDir

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