← 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-16 07:03:16 UTC
  • Revision ID: mbp@sourcefrog.net-20050916070316-29f4b33b6f86fdc3
- cElementTree is typically not installed in util

  this was probably causing it to not be imported in many cases

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
1
 
# Copyright (C) 2005, 2006 Canonical
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.inventory import InventoryEntry
18
18
from bzrlib.trace import mutter
19
 
from bzrlib.symbol_versioning import deprecated_function, zero_nine
20
 
 
21
19
 
22
20
class TreeDelta(object):
23
21
    """Describes changes from one tree to another.
29
27
    removed
30
28
        (path, id, kind)
31
29
    renamed
32
 
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
30
        (oldpath, newpath, id, kind, text_modified)
33
31
    modified
34
 
        (path, id, kind, text_modified, meta_modified)
 
32
        (path, id, kind)
35
33
    unchanged
36
34
        (path, id, kind)
37
35
 
38
36
    Each id is listed only once.
39
37
 
40
38
    Files that are both modified and renamed are listed only in
41
 
    renamed, with the text_modified flag true. The text_modified
42
 
    applies either to the the content of the file or the target of the
43
 
    symbolic link, depending of the kind of file.
 
39
    renamed, with the text_modified flag true.
44
40
 
45
41
    Files are only considered renamed if their name has changed or
46
42
    their parent directory has changed.  Renaming a directory
91
87
            
92
88
 
93
89
    def show(self, to_file, show_ids=False, show_unchanged=False):
94
 
        """output this delta in status-like form to to_file."""
95
90
        def show_list(files):
96
 
            for item in files:
97
 
                path, fid, kind = item[:3]
98
 
 
 
91
            for path, fid, kind in files:
99
92
                if kind == 'directory':
100
93
                    path += '/'
101
94
                elif kind == 'symlink':
102
95
                    path += '@'
103
 
 
104
 
                if len(item) == 5 and item[4]:
105
 
                    path += '*'
106
 
 
 
96
                    
107
97
                if show_ids:
108
98
                    print >>to_file, '  %-30s %s' % (path, fid)
109
99
                else:
117
107
            print >>to_file, 'added:'
118
108
            show_list(self.added)
119
109
 
120
 
        extra_modified = []
121
 
 
122
110
        if self.renamed:
123
111
            print >>to_file, 'renamed:'
124
 
            for (oldpath, newpath, fid, kind,
125
 
                 text_modified, meta_modified) in self.renamed:
126
 
                if text_modified or meta_modified:
127
 
                    extra_modified.append((newpath, fid, kind,
128
 
                                           text_modified, meta_modified))
129
 
                if meta_modified:
130
 
                    newpath += '*'
 
112
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
131
113
                if show_ids:
132
114
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
133
115
                else:
134
116
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
135
117
                    
136
 
        if self.modified or extra_modified:
 
118
        if self.modified:
137
119
            print >>to_file, 'modified:'
138
120
            show_list(self.modified)
139
 
            show_list(extra_modified)
140
121
            
141
122
        if show_unchanged and self.unchanged:
142
123
            print >>to_file, 'unchanged:'
143
124
            show_list(self.unchanged)
144
125
 
145
126
 
146
 
@deprecated_function(zero_nine)
147
 
def compare_trees(old_tree, new_tree, want_unchanged=False,
148
 
                  specific_files=None, extra_trees=None,
149
 
                  require_versioned=False):
150
 
    """compare_trees was deprecated in 0.10. Please see Tree.changes_from."""
151
 
    return new_tree.changes_from(old_tree,
152
 
        want_unchanged=want_unchanged,
153
 
        specific_files=specific_files,
154
 
        extra_trees=extra_trees,
155
 
        require_versioned=require_versioned)
156
 
 
157
 
 
158
 
def _compare_trees(old_tree, new_tree, want_unchanged, specific_file_ids):
 
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
    """
159
146
 
160
147
    from osutils import is_inside_any
161
148
    
164
151
    delta = TreeDelta()
165
152
    mutter('start compare_trees')
166
153
 
167
 
    # TODO: Rather than iterating over the whole tree and then filtering, we
168
 
    # could diff just the specified files (if any) and their subtrees.  
169
 
 
170
 
    old_files = old_tree.list_files()
171
 
    new_files = new_tree.list_files()
172
 
 
173
 
    more_old = True
174
 
    more_new = True
175
 
 
176
 
    added = {}
177
 
    removed = {}
178
 
 
179
 
    def get_next(iter):
180
 
        try:
181
 
            return iter.next()
182
 
        except StopIteration:
183
 
            return None, None, None, None, None
184
 
    old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
185
 
    new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
186
 
 
187
 
 
188
 
    def check_matching(old_path, old_entry, new_path, new_entry):
189
 
        """We have matched up 2 file_ids, check for changes."""
190
 
        assert old_entry.kind == new_entry.kind
191
 
 
192
 
        if specific_file_ids:
193
 
            if (old_entry.file_id not in specific_file_ids and 
194
 
                new_entry.file_id not in specific_file_ids):
195
 
                return
196
 
 
197
 
        # temporary hack until all entries are populated before clients 
198
 
        # get them
199
 
        old_entry._read_tree_state(old_path, old_tree)
200
 
        new_entry._read_tree_state(new_path, new_tree)
201
 
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
202
 
        
203
 
        # If the name changes, or the parent_id changes, we have a rename
204
 
        # (if we move a parent, that doesn't count as a rename for the file)
205
 
        if (old_entry.name != new_entry.name 
206
 
            or old_entry.parent_id != new_entry.parent_id):
207
 
            delta.renamed.append((old_path,
208
 
                                  new_path,
209
 
                                  old_entry.file_id, old_entry.kind,
210
 
                                  text_modified, meta_modified))
211
 
        elif text_modified or meta_modified:
212
 
            delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
213
 
                                   text_modified, meta_modified))
214
 
        elif want_unchanged:
215
 
            delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
216
 
 
217
 
 
218
 
    def handle_old(path, entry):
219
 
        """old entry without a new entry match
220
 
 
221
 
        Check to see if a matching new entry was already seen as an
222
 
        added file, and switch the pair into being a rename.
223
 
        Otherwise just mark the old entry being removed.
224
 
        """
225
 
        if entry.file_id in added:
226
 
            # Actually this is a rename, we found a new file_id earlier
227
 
            # at a different location, so it is no-longer added
228
 
            x_new_path, x_new_entry = added.pop(entry.file_id)
229
 
            check_matching(path, entry, x_new_path, x_new_entry)
230
 
        else:
231
 
            # We have an old_file_id which doesn't line up with a new_file_id
232
 
            # So this file looks to be removed
233
 
            assert entry.file_id not in removed
234
 
            removed[entry.file_id] = path, entry
235
 
 
236
 
    def handle_new(path, entry):
237
 
        """new entry without an old entry match
238
 
        
239
 
        Check to see if a matching old entry was already seen as a
240
 
        removal, and change the pair into a rename.
241
 
        Otherwise just mark the new entry as an added file.
242
 
        """
243
 
        if entry.file_id in removed:
244
 
            # We saw this file_id earlier at an old different location
245
 
            # it is no longer removed, just renamed
246
 
            x_old_path, x_old_entry = removed.pop(entry.file_id)
247
 
            check_matching(x_old_path, x_old_entry, path, entry)
248
 
        else:
249
 
            # We have a new file which does not match an old file
250
 
            # mark it as added
251
 
            assert entry.file_id not in added
252
 
            added[entry.file_id] = path, entry
253
 
 
254
 
    while old_path or new_path:
255
 
        # list_files() returns files in alphabetical path sorted order
256
 
        if old_path == new_path:
257
 
            if old_file_id == new_file_id:
258
 
                # This is the common case, the files are in the same place
259
 
                # check if there were any content changes
260
 
 
261
 
                if old_file_id is None:
262
 
                    # We have 2 unversioned files, no deltas possible???
263
 
                    pass
264
 
                else:
265
 
                    check_matching(old_path, old_entry, new_path, new_entry)
 
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)
266
180
            else:
267
 
                # The ids don't match, so we have to handle them both
268
 
                # separately.
269
 
                if old_file_id is not None:
270
 
                    handle_old(old_path, old_entry)
271
 
 
272
 
                if new_file_id is not None:
273
 
                    handle_new(new_path, new_entry)
274
 
 
275
 
            # The two entries were at the same path, so increment both sides
276
 
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
277
 
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
278
 
        elif new_path is None or (old_path is not None and old_path < new_path):
279
 
            # Assume we don't match, only process old_path
280
 
            if old_file_id is not None:
281
 
                handle_old(old_path, old_entry)
282
 
            # old_path came first, so increment it, trying to match up
283
 
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
284
 
        elif new_path is not None:
285
 
            # new_path came first, so increment it, trying to match up
286
 
            if new_file_id is not None:
287
 
                handle_new(new_path, new_entry)
288
 
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
289
 
 
290
 
    # Now we have a set of added and removed files, mark them all
291
 
    for old_path, old_entry in removed.itervalues():
292
 
        if specific_file_ids:
293
 
            if not old_entry.file_id in specific_file_ids:
294
 
                continue
295
 
        delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
296
 
    for new_path, new_entry in added.itervalues():
297
 
        if specific_file_ids:
298
 
            if not new_entry.file_id in specific_file_ids:
299
 
                continue
300
 
        delta.added.append((new_path, new_entry.file_id, new_entry.kind))
301
 
 
 
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))
 
199
        else:
 
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))
 
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
            
302
222
    delta.removed.sort()
303
223
    delta.added.sort()
304
224
    delta.renamed.sort()
305
 
    # TODO: jam 20060529 These lists shouldn't need to be sorted
306
 
    #       since we added them in alphabetical order.
307
225
    delta.modified.sort()
308
226
    delta.unchanged.sort()
309
227