/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: John Arbash Meinel
  • Date: 2006-05-28 03:56:21 UTC
  • mto: (1711.2.26 jam-integration)
  • mto: This revision was merged to the branch mainline in revision 1734.
  • Revision ID: john@arbash-meinel.com-20060528035621-3460c764281b032f
Switch to using bzrlib.xml5.serializer_v5 so that a plugin can override it if we want

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/delta.py
 
1
# Copyright (C) 2005, 2006 Canonical
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
from bzrlib.inventory import InventoryEntry
 
18
from bzrlib.trace import mutter
 
19
 
 
20
class TreeDelta(object):
 
21
    """Describes changes from one tree to another.
 
22
 
 
23
    Contains four lists:
 
24
 
 
25
    added
 
26
        (path, id, kind)
 
27
    removed
 
28
        (path, id, kind)
 
29
    renamed
 
30
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
31
    modified
 
32
        (path, id, kind, text_modified, meta_modified)
 
33
    unchanged
 
34
        (path, id, kind)
 
35
 
 
36
    Each id is listed only once.
 
37
 
 
38
    Files that are both modified and renamed are listed only in
 
39
    renamed, with the text_modified flag true. The text_modified
 
40
    applies either to the the content of the file or the target of the
 
41
    symbolic link, depending of the kind of file.
 
42
 
 
43
    Files are only considered renamed if their name has changed or
 
44
    their parent directory has changed.  Renaming a directory
 
45
    does not count as renaming all its contents.
 
46
 
 
47
    The lists are normally sorted when the delta is created.
 
48
    """
 
49
    def __init__(self):
 
50
        self.added = []
 
51
        self.removed = []
 
52
        self.renamed = []
 
53
        self.modified = []
 
54
        self.unchanged = []
 
55
 
 
56
    def __eq__(self, other):
 
57
        if not isinstance(other, TreeDelta):
 
58
            return False
 
59
        return self.added == other.added \
 
60
               and self.removed == other.removed \
 
61
               and self.renamed == other.renamed \
 
62
               and self.modified == other.modified \
 
63
               and self.unchanged == other.unchanged
 
64
 
 
65
    def __ne__(self, other):
 
66
        return not (self == other)
 
67
 
 
68
    def __repr__(self):
 
69
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
70
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
71
            self.modified, self.unchanged)
 
72
 
 
73
    def has_changed(self):
 
74
        return bool(self.modified
 
75
                    or self.added
 
76
                    or self.removed
 
77
                    or self.renamed)
 
78
 
 
79
    def touches_file_id(self, file_id):
 
80
        """Return True if file_id is modified by this delta."""
 
81
        for l in self.added, self.removed, self.modified:
 
82
            for v in l:
 
83
                if v[1] == file_id:
 
84
                    return True
 
85
        for v in self.renamed:
 
86
            if v[2] == file_id:
 
87
                return True
 
88
        return False
 
89
            
 
90
 
 
91
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
92
        def show_list(files):
 
93
            for item in files:
 
94
                path, fid, kind = item[:3]
 
95
 
 
96
                if kind == 'directory':
 
97
                    path += '/'
 
98
                elif kind == 'symlink':
 
99
                    path += '@'
 
100
 
 
101
                if len(item) == 5 and item[4]:
 
102
                    path += '*'
 
103
 
 
104
                if show_ids:
 
105
                    print >>to_file, '  %-30s %s' % (path, fid)
 
106
                else:
 
107
                    print >>to_file, ' ', path
 
108
            
 
109
        if self.removed:
 
110
            print >>to_file, 'removed:'
 
111
            show_list(self.removed)
 
112
                
 
113
        if self.added:
 
114
            print >>to_file, 'added:'
 
115
            show_list(self.added)
 
116
 
 
117
        extra_modified = []
 
118
 
 
119
        if self.renamed:
 
120
            print >>to_file, 'renamed:'
 
121
            for (oldpath, newpath, fid, kind,
 
122
                 text_modified, meta_modified) in self.renamed:
 
123
                if text_modified or meta_modified:
 
124
                    extra_modified.append((newpath, fid, kind,
 
125
                                           text_modified, meta_modified))
 
126
                if meta_modified:
 
127
                    newpath += '*'
 
128
                if show_ids:
 
129
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
130
                else:
 
131
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
132
                    
 
133
        if self.modified or extra_modified:
 
134
            print >>to_file, 'modified:'
 
135
            show_list(self.modified)
 
136
            show_list(extra_modified)
 
137
            
 
138
        if show_unchanged and self.unchanged:
 
139
            print >>to_file, 'unchanged:'
 
140
            show_list(self.unchanged)
 
141
 
 
142
 
 
143
 
 
144
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
145
    """Describe changes from one tree to another.
 
146
 
 
147
    Returns a TreeDelta with details of added, modified, renamed, and
 
148
    deleted entries.
 
149
 
 
150
    The root entry is specifically exempt.
 
151
 
 
152
    This only considers versioned files.
 
153
 
 
154
    want_unchanged
 
155
        If true, also list files unchanged from one version to
 
156
        the next.
 
157
 
 
158
    specific_files
 
159
        If true, only check for changes to specified names or
 
160
        files within them.  Any unversioned files given have no effect
 
161
        (but this might change in the future).
 
162
    """
 
163
    # NB: show_status depends on being able to pass in non-versioned files and
 
164
    # report them as unknown
 
165
    old_tree.lock_read()
 
166
    try:
 
167
        new_tree.lock_read()
 
168
        try:
 
169
            return _compare_trees(old_tree, new_tree, want_unchanged,
 
170
                                  specific_files)
 
171
        finally:
 
172
            new_tree.unlock()
 
173
    finally:
 
174
        old_tree.unlock()
 
175
 
 
176
 
 
177
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
 
178
 
 
179
    from osutils import is_inside_any
 
180
    
 
181
    old_inv = old_tree.inventory
 
182
    new_inv = new_tree.inventory
 
183
    delta = TreeDelta()
 
184
    mutter('start compare_trees')
 
185
 
 
186
    # TODO: Rather than iterating over the whole tree and then filtering, we
 
187
    # could diff just the specified files (if any) and their subtrees.  
 
188
    # Perhaps should take a list of file-ids instead?   Need to indicate any
 
189
    # ids or names which were not found in the trees.
 
190
 
 
191
    old_files = old_tree.list_files()
 
192
    new_files = new_tree.list_files()
 
193
 
 
194
    more_old = True
 
195
    more_new = True
 
196
 
 
197
    added = {}
 
198
    removed = {}
 
199
 
 
200
    def get_next(iter):
 
201
        try:
 
202
            return iter.next()
 
203
        except StopIteration:
 
204
            return None, None, None, None, None
 
205
    old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
206
    new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
207
 
 
208
 
 
209
    def check_matching(old_path, old_entry, new_path, new_entry):
 
210
        """We have matched up 2 file_ids, check for changes."""
 
211
        assert old_entry.kind == new_entry.kind
 
212
 
 
213
        if old_entry.kind == 'root_directory':
 
214
            return
 
215
 
 
216
        if specific_files:
 
217
            if (not is_inside_any(specific_files, old_path)
 
218
                and not is_inside_any(specific_files, new_path)):
 
219
                return
 
220
 
 
221
        # temporary hack until all entries are populated before clients 
 
222
        # get them
 
223
        old_entry._read_tree_state(old_path, old_tree)
 
224
        new_entry._read_tree_state(new_path, new_tree)
 
225
        text_modified, meta_modified = new_entry.detect_changes(old_entry)
 
226
        
 
227
        # If the name changes, or the parent_id changes, we have a rename
 
228
        # (if we move a parent, that doesn't count as a rename for the file)
 
229
        if (old_entry.name != new_entry.name 
 
230
            or old_entry.parent_id != new_entry.parent_id):
 
231
            delta.renamed.append((old_path,
 
232
                                  new_path,
 
233
                                  old_entry.file_id, old_entry.kind,
 
234
                                  text_modified, meta_modified))
 
235
        elif text_modified or meta_modified:
 
236
            delta.modified.append((new_path, new_entry.file_id, new_entry.kind,
 
237
                                   text_modified, meta_modified))
 
238
        elif want_unchanged:
 
239
            delta.unchanged.append((new_path, new_entry.file_id, new_entry.kind))
 
240
 
 
241
 
 
242
    def handle_old(path, entry):
 
243
        """old entry without a new entry match"""
 
244
        if entry.file_id in added:
 
245
            # Actually this is a rename, we found a new file_id earlier
 
246
            # at a different location, so it is no-longer added
 
247
            x_new_path, x_new_entry = added.pop(entry.file_id)
 
248
            check_matching(path, entry, x_new_path, x_new_entry)
 
249
        else:
 
250
            # We have an old_file_id which doesn't line up with a new_file_id
 
251
            # So this file looks to be removed
 
252
            assert entry.file_id not in removed
 
253
            removed[entry.file_id] = path, entry
 
254
 
 
255
    def handle_new(path, entry):
 
256
        """new entry without an old entry match"""
 
257
        if entry.file_id in removed:
 
258
            # We saw this file_id earlier at an old different location
 
259
            # it is no longer removed, just renamed
 
260
            x_old_path, x_old_entry = removed.pop(entry.file_id)
 
261
            check_matching(x_old_path, x_old_entry, path, entry)
 
262
        else:
 
263
            # We have a new file which does not match an old file
 
264
            # mark it as added
 
265
            assert entry.file_id not in added
 
266
            added[entry.file_id] = path, entry
 
267
 
 
268
    while old_path or new_path:
 
269
        # list_files() returns files in alphabetical path sorted order
 
270
        if old_path == new_path:
 
271
            if old_file_id == new_file_id:
 
272
                # This is the common case, the files are in the same place
 
273
                # check if there were any content changes
 
274
 
 
275
                if old_file_id is None:
 
276
                    # We have 2 unversioned files, no deltas possible???
 
277
                    pass
 
278
                else:
 
279
                    check_matching(old_path, old_entry, new_path, new_entry)
 
280
            else:
 
281
                # The ids don't match, so we have to handle them both
 
282
                # separately.
 
283
                if old_file_id is not None:
 
284
                    handle_old(old_path, old_entry)
 
285
 
 
286
                if new_file_id is not None:
 
287
                    handle_new(new_path, new_entry)
 
288
 
 
289
            # The two entries were at the same path, so increment both sides
 
290
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
291
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
292
        elif new_path is None or (old_path is not None and old_path < new_path):
 
293
            # Assume we don't match, only process old_path
 
294
            if old_file_id is not None:
 
295
                handle_old(old_path, old_entry)
 
296
            # old_path came first, so increment it, trying to match up
 
297
            old_path, old_class, old_kind, old_file_id, old_entry = get_next(old_files)
 
298
        elif new_path is not None:
 
299
            # new_path came first, so increment it, trying to match up
 
300
            if new_file_id is not None:
 
301
                handle_new(new_path, new_entry)
 
302
            new_path, new_class, new_kind, new_file_id, new_entry = get_next(new_files)
 
303
 
 
304
    # Now we have a set of added and removed files, mark them all
 
305
    for old_path, old_entry in removed.itervalues():
 
306
        if specific_files:
 
307
            if not is_inside_any(specific_files, old_path):
 
308
                continue
 
309
        delta.removed.append((old_path, old_entry.file_id, old_entry.kind))
 
310
    for new_path, new_entry in added.itervalues():
 
311
        if specific_files:
 
312
            if not is_inside_any(specific_files, new_path):
 
313
                continue
 
314
        delta.added.append((new_path, new_entry.file_id, new_entry.kind))
 
315
 
 
316
    delta.removed.sort()
 
317
    delta.added.sort()
 
318
    delta.renamed.sort()
 
319
    delta.modified.sort()
 
320
    delta.unchanged.sort()
 
321
 
 
322
    return delta