← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Aaron Bentley
  • Date: 2008-12-03 05:31:27 UTC
  • mto: This revision was merged to the branch mainline in revision 3893.
  • Revision ID: aaron@aaronbentley.com-20081203053127-vozu5rmsixaadw0v
Change ls-shelf to shelve --list

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
#! /usr/bin/env python
2
 
# -*- coding: UTF-8 -*-
3
 
 
 
1
# Copyright (C) 2005, 2006 Canonical Ltd
 
2
#
4
3
# This program is free software; you can redistribute it and/or modify
5
4
# it under the terms of the GNU General Public License as published by
6
5
# the Free Software Foundation; either version 2 of the License, or
7
6
# (at your option) any later version.
8
 
 
 
7
#
9
8
# This program is distributed in the hope that it will be useful,
10
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
11
# GNU General Public License for more details.
13
 
 
 
12
#
14
13
# You should have received a copy of the GNU General Public License
15
14
# along with this program; if not, write to the Free Software
16
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17
16
 
18
 
from bzrlib.trace import mutter
 
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
 
19
25
 
20
26
class TreeDelta(object):
21
27
    """Describes changes from one tree to another.
27
33
    removed
28
34
        (path, id, kind)
29
35
    renamed
30
 
        (oldpath, newpath, id, kind, text_modified)
 
36
        (oldpath, newpath, id, kind, text_modified, meta_modified)
31
37
    modified
32
 
        (path, id, kind)
 
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
 
38
46
    Files that are both modified and renamed are listed only in
39
 
    renamed, with the text_modified flag true.
 
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.
40
50
 
41
51
    Files are only considered renamed if their name has changed or
42
52
    their parent directory has changed.  Renaming a directory
48
58
        self.added = []
49
59
        self.removed = []
50
60
        self.renamed = []
 
61
        self.kind_changed = []
51
62
        self.modified = []
52
63
        self.unchanged = []
 
64
        self.unversioned = []
53
65
 
54
66
    def __eq__(self, other):
55
67
        if not isinstance(other, TreeDelta):
58
70
               and self.removed == other.removed \
59
71
               and self.renamed == other.renamed \
60
72
               and self.modified == other.modified \
61
 
               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
62
76
 
63
77
    def __ne__(self, other):
64
78
        return not (self == other)
65
79
 
66
80
    def __repr__(self):
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)
 
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)
70
86
 
71
87
    def has_changed(self):
72
 
        changes = len(self.added) + len(self.removed) + len(self.renamed)
73
 
        changes += len(self.modified) 
74
 
        return (changes != 0)
 
88
        return bool(self.modified
 
89
                    or self.added
 
90
                    or self.removed
 
91
                    or self.renamed
 
92
                    or self.kind_changed)
75
93
 
76
94
    def touches_file_id(self, file_id):
77
95
        """Return True if file_id is modified by this delta."""
82
100
        for v in self.renamed:
83
101
            if v[2] == file_id:
84
102
                return True
 
103
        for v in self.kind_changed:
 
104
            if v[1] == file_id:
 
105
                return True
85
106
        return False
86
107
            
87
108
 
88
 
    def show(self, to_file, show_ids=False, show_unchanged=False):
89
 
        def show_list(files):
90
 
            for path, fid, kind in 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=''):
 
113
            for item in files:
 
114
                path, fid, kind = item[:3]
 
115
 
91
116
                if kind == 'directory':
92
117
                    path += '/'
93
118
                elif kind == 'symlink':
94
119
                    path += '@'
95
 
                    
 
120
 
 
121
                if len(item) == 5 and item[4]:
 
122
                    path += '*'
 
123
 
96
124
                if show_ids:
97
 
                    print >>to_file, '  %-30s %s' % (path, fid)
 
125
                    to_file.write(indent + '%s  %-30s %s\n' % (short_status_letter,
 
126
                        path, fid))
98
127
                else:
99
 
                    print >>to_file, ' ', path
 
128
                    to_file.write(indent + '%s  %s\n' % (short_status_letter, path))
100
129
            
101
130
        if self.removed:
102
 
            print >>to_file, 'removed:'
103
 
            show_list(self.removed)
 
131
            if not short_status:
 
132
                to_file.write(indent + 'removed:\n')
 
133
                show_list(self.removed)
 
134
            else:
 
135
                show_list(self.removed, 'D')
104
136
                
105
137
        if self.added:
106
 
            print >>to_file, 'added:'
107
 
            show_list(self.added)
 
138
            if not short_status:
 
139
                to_file.write(indent + 'added:\n')
 
140
                show_list(self.added)
 
141
            else:
 
142
                show_list(self.added, 'A')
 
143
 
 
144
        extra_modified = []
108
145
 
109
146
        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)
 
147
            short_status_letter = 'R'
 
148
            if not short_status:
 
149
                to_file.write(indent + 'renamed:\n')
 
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
                    to_file.write(indent + '%s  %s => %s %s\n' % (
 
160
                        short_status_letter, oldpath, newpath, fid))
 
161
                else:
 
162
                    to_file.write(indent + '%s  %s => %s\n' % (
 
163
                        short_status_letter, oldpath, newpath))
 
164
 
 
165
        if self.kind_changed:
 
166
            if short_status:
 
167
                short_status_letter = 'K'
 
168
            else:
 
169
                to_file.write(indent + 'kind changed:\n')
 
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
                to_file.write(indent + '%s  %s (%s => %s)%s\n' % (
 
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
                to_file.write(indent + 'modified:\n')
 
183
                short_status_letter = ''
 
184
            show_list(self.modified, short_status_letter)
 
185
            show_list(extra_modified, short_status_letter)
120
186
            
121
187
        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
 
188
            if not short_status:
 
189
                to_file.write(indent + 'unchanged:\n')
 
190
                show_list(self.unchanged)
 
191
            else:
 
192
                show_list(self.unchanged, 'S')
 
193
 
 
194
        if self.unversioned:
 
195
            to_file.write(indent + 'unknown:\n')
 
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."""
150
210
    delta = TreeDelta()
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)
 
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]))
179
228
            else:
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))
 
229
                delta.removed.append((path[0], file_id, kind[0]))
 
230
        elif fully_present[0] is False:
 
231
            continue
 
232
        elif name[0] != name[1] or parent_id[0] != parent_id[1]:
 
233
            # If the name changes, or the parent_id changes, we have a rename
 
234
            # (if we move a parent, that doesn't count as a rename for the
 
235
            # file)
 
236
            delta.renamed.append((path[0],
 
237
                                  path[1],
 
238
                                  file_id,
 
239
                                  kind[1],
 
240
                                  content_change,
 
241
                                  (executable[0] != executable[1])))
 
242
        elif kind[0] != kind[1]:
 
243
            delta.kind_changed.append((path[1], file_id, kind[0], kind[1]))
 
244
        elif content_change or executable[0] != executable[1]:
 
245
            delta.modified.append((path[1], file_id, kind[1],
 
246
                                   content_change,
 
247
                                   (executable[0] != executable[1])))
198
248
        else:
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))
 
249
            delta.unchanged.append((path[1], file_id, kind[1]))
207
250
 
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
 
            
221
251
    delta.removed.sort()
222
252
    delta.added.sort()
223
253
    delta.renamed.sort()
 
254
    # TODO: jam 20060529 These lists shouldn't need to be sorted
 
255
    #       since we added them in alphabetical order.
224
256
    delta.modified.sort()
225
257
    delta.unchanged.sort()
226
258
 
227
259
    return delta
 
260
 
 
261
 
 
262
class _ChangeReporter(object):
 
263
    """Report changes between two trees"""
 
264
 
 
265
    def __init__(self, output=None, suppress_root_add=True,
 
266
                 output_file=None, unversioned_filter=None):
 
267
        """Constructor
 
268
 
 
269
        :param output: a function with the signature of trace.note, i.e.
 
270
            accepts a format and parameters.
 
271
        :param supress_root_add: If true, adding the root will be ignored
 
272
            (i.e. when a tree has just been initted)
 
273
        :param output_file: If supplied, a file-like object to write to.
 
274
            Only one of output and output_file may be supplied.
 
275
        :param unversioned_filter: A filter function to be called on 
 
276
            unversioned files. This should return True to ignore a path.
 
277
            By default, no filtering takes place.
 
278
        """
 
279
        if output_file is not None:
 
280
            if output is not None:
 
281
                raise BzrError('Cannot specify both output and output_file')
 
282
            def output(fmt, *args):
 
283
                output_file.write((fmt % args) + '\n')
 
284
        self.output = output
 
285
        if self.output is None:
 
286
            from bzrlib import trace
 
287
            self.output = trace.note
 
288
        self.suppress_root_add = suppress_root_add
 
289
        self.modified_map = {'kind changed': 'K',
 
290
                             'unchanged': ' ',
 
291
                             'created': 'N',
 
292
                             'modified': 'M',
 
293
                             'deleted': 'D'}
 
294
        self.versioned_map = {'added': '+', # versioned target
 
295
                              'unchanged': ' ', # versioned in both
 
296
                              'removed': '-', # versioned in source
 
297
                              'unversioned': '?', # versioned in neither
 
298
                              }
 
299
        self.unversioned_filter = unversioned_filter
 
300
 
 
301
    def report(self, file_id, paths, versioned, renamed, modified, exe_change,
 
302
               kind):
 
303
        """Report one change to a file
 
304
 
 
305
        :param file_id: The file_id of the file
 
306
        :param path: The old and new paths as generated by Tree.iter_changes.
 
307
        :param versioned: may be 'added', 'removed', 'unchanged', or
 
308
            'unversioned.
 
309
        :param renamed: may be True or False
 
310
        :param modified: may be 'created', 'deleted', 'kind changed',
 
311
            'modified' or 'unchanged'.
 
312
        :param exe_change: True if the execute bit has changed
 
313
        :param kind: A pair of file kinds, as generated by Tree.iter_changes.
 
314
            None indicates no file present.
 
315
        """
 
316
        if is_quiet():
 
317
            return
 
318
        if paths[1] == '' and versioned == 'added' and self.suppress_root_add:
 
319
            return
 
320
        if versioned == 'unversioned':
 
321
            # skip ignored unversioned files if needed.
 
322
            if self.unversioned_filter is not None:
 
323
                if self.unversioned_filter(paths[1]):
 
324
                    return
 
325
            # dont show a content change in the output.
 
326
            modified = 'unchanged'
 
327
        # we show both paths in the following situations:
 
328
        # the file versioning is unchanged AND
 
329
        # ( the path is different OR
 
330
        #   the kind is different)
 
331
        if (versioned == 'unchanged' and
 
332
            (renamed or modified == 'kind changed')):
 
333
            if renamed:
 
334
                # on a rename, we show old and new
 
335
                old_path, path = paths
 
336
            else:
 
337
                # if it's not renamed, we're showing both for kind changes
 
338
                # so only show the new path
 
339
                old_path, path = paths[1], paths[1]
 
340
            # if the file is not missing in the source, we show its kind
 
341
            # when we show two paths.
 
342
            if kind[0] is not None:
 
343
                old_path += osutils.kind_marker(kind[0])
 
344
            old_path += " => "
 
345
        elif versioned == 'removed':
 
346
            # not present in target
 
347
            old_path = ""
 
348
            path = paths[0]
 
349
        else:
 
350
            old_path = ""
 
351
            path = paths[1]
 
352
        if renamed:
 
353
            rename = "R"
 
354
        else:
 
355
            rename = self.versioned_map[versioned]
 
356
        # we show the old kind on the new path when the content is deleted.
 
357
        if modified == 'deleted':
 
358
            path += osutils.kind_marker(kind[0])
 
359
        # otherwise we always show the current kind when there is one
 
360
        elif kind[1] is not None:
 
361
            path += osutils.kind_marker(kind[1])
 
362
        if exe_change:
 
363
            exe = '*'
 
364
        else:
 
365
            exe = ' '
 
366
        self.output("%s%s%s %s%s", rename, self.modified_map[modified], exe,
 
367
                    old_path, path)
 
368
 
 
369
 
 
370
def report_changes(change_iterator, reporter):
 
371
    """Report the changes from a change iterator.
 
372
 
 
373
    This is essentially a translation from low-level to medium-level changes.
 
374
    Further processing may be required to produce a human-readable output.
 
375
    Unfortunately, some tree-changing operations are very complex
 
376
    :change_iterator: an iterator or sequence of changes in the format
 
377
        generated by Tree.iter_changes
 
378
    :param reporter: The _ChangeReporter that will report the changes.
 
379
    """
 
380
    versioned_change_map = {
 
381
        (True, True)  : 'unchanged',
 
382
        (True, False) : 'removed',
 
383
        (False, True) : 'added',
 
384
        (False, False): 'unversioned',
 
385
        }
 
386
    for (file_id, path, content_change, versioned, parent_id, name, kind,
 
387
         executable) in change_iterator:
 
388
        exe_change = False
 
389
        # files are "renamed" if they are moved or if name changes, as long
 
390
        # as it had a value
 
391
        if None not in name and None not in parent_id and\
 
392
            (name[0] != name[1] or parent_id[0] != parent_id[1]):
 
393
            renamed = True
 
394
        else:
 
395
            renamed = False
 
396
        if kind[0] != kind[1]:
 
397
            if kind[0] is None:
 
398
                modified = "created"
 
399
            elif kind[1] is None:
 
400
                modified = "deleted"
 
401
            else:
 
402
                modified = "kind changed"
 
403
        else:
 
404
            if content_change:
 
405
                modified = "modified"
 
406
            else:
 
407
                modified = "unchanged"
 
408
            if kind[1] == "file":
 
409
                exe_change = (executable[0] != executable[1])
 
410
        versioned_change = versioned_change_map[versioned]
 
411
        reporter.report(file_id, path, versioned_change, renamed, modified,
 
412
                        exe_change, kind)