/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/delta.py

  • Committer: Jelmer Vernooij
  • Date: 2010-04-30 11:03:59 UTC
  • mto: This revision was merged to the branch mainline in revision 5197.
  • Revision ID: jelmer@samba.org-20100430110359-ow3e3grh7sxy93pa
Remove more unused imports.

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