1
# -*- coding: UTF-8 -*-
 
 
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.
 
 
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.
 
 
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
 
 
17
from bzrlib.inventory import InventoryEntry
 
 
18
from bzrlib.trace import mutter
 
 
20
class TreeDelta(object):
 
 
21
    """Describes changes from one tree to another.
 
 
30
        (oldpath, newpath, id, kind, text_modified, meta_modified)
 
 
32
        (path, id, kind, text_modified, meta_modified)
 
 
36
    Each id is listed only once.
 
 
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.
 
 
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.
 
 
47
    The lists are normally sorted when the delta is created.
 
 
56
    def __eq__(self, other):
 
 
57
        if not isinstance(other, TreeDelta):
 
 
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
 
 
65
    def __ne__(self, other):
 
 
66
        return not (self == other)
 
 
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)
 
 
73
    def has_changed(self):
 
 
74
        return bool(self.modified
 
 
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:
 
 
85
        for v in self.renamed:
 
 
91
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
94
                path, fid, kind = item[:3]
 
 
96
                if kind == 'directory':
 
 
98
                elif kind == 'symlink':
 
 
101
                if len(item) == 5 and item[4]:
 
 
105
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
107
                    print >>to_file, ' ', path
 
 
110
            print >>to_file, 'removed:'
 
 
111
            show_list(self.removed)
 
 
114
            print >>to_file, 'added:'
 
 
115
            show_list(self.added)
 
 
118
            print >>to_file, 'renamed:'
 
 
119
            for (oldpath, newpath, fid, kind,
 
 
120
                 text_modified, meta_modified) in self.renamed:
 
 
124
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
126
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
129
            print >>to_file, 'modified:'
 
 
130
            show_list(self.modified)
 
 
132
        if show_unchanged and self.unchanged:
 
 
133
            print >>to_file, 'unchanged:'
 
 
134
            show_list(self.unchanged)
 
 
138
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
 
139
    """Describe changes from one tree to another.
 
 
141
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
144
    The root entry is specifically exempt.
 
 
146
    This only considers versioned files.
 
 
149
        If true, also list files unchanged from one version to
 
 
153
        If true, only check for changes to specified names or
 
 
157
    from osutils import is_inside_any
 
 
159
    old_inv = old_tree.inventory
 
 
160
    new_inv = new_tree.inventory
 
 
162
    mutter('start compare_trees')
 
 
164
    # TODO: match for specific files can be rather smarter by finding
 
 
165
    # the IDs of those files up front and then considering only that.
 
 
167
    for file_id in old_tree:
 
 
168
        if file_id in new_tree:
 
 
169
            old_ie = old_inv[file_id]
 
 
170
            new_ie = new_inv[file_id]
 
 
173
            assert kind == new_ie.kind
 
 
175
            assert kind in InventoryEntry.known_kinds, \
 
 
176
                   'invalid file kind %r' % kind
 
 
178
            if kind == 'root_directory':
 
 
182
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
 
183
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
 
186
            # temporary hack until all entries are populated before clients 
 
 
188
            old_path = old_inv.id2path(file_id)
 
 
189
            new_path = new_inv.id2path(file_id)
 
 
190
            old_ie._read_tree_state(old_tree)
 
 
191
            new_ie._read_tree_state(new_tree)
 
 
192
            text_modified, meta_modified = new_ie.detect_changes(old_ie)
 
 
194
            # TODO: Can possibly avoid calculating path strings if the
 
 
195
            # two files are unchanged and their names and parents are
 
 
196
            # the same and the parents are unchanged all the way up.
 
 
197
            # May not be worthwhile.
 
 
199
            if (old_ie.name != new_ie.name
 
 
200
                or old_ie.parent_id != new_ie.parent_id):
 
 
201
                delta.renamed.append((old_path,
 
 
204
                                      text_modified, meta_modified))
 
 
205
            elif text_modified or meta_modified:
 
 
206
                delta.modified.append((new_path, file_id, kind,
 
 
207
                                       text_modified, meta_modified))
 
 
209
                delta.unchanged.append((new_path, file_id, kind))
 
 
211
            kind = old_inv.get_file_kind(file_id)
 
 
212
            if kind == 'root_directory':
 
 
214
            old_path = old_inv.id2path(file_id)
 
 
216
                if not is_inside_any(specific_files, old_path):
 
 
218
            delta.removed.append((old_path, file_id, kind))
 
 
220
    mutter('start looking for new files')
 
 
221
    for file_id in new_inv:
 
 
222
        if file_id in old_inv:
 
 
224
        kind = new_inv.get_file_kind(file_id)
 
 
225
        if kind == 'root_directory':
 
 
227
        new_path = new_inv.id2path(file_id)
 
 
229
            if not is_inside_any(specific_files, new_path):
 
 
231
        delta.added.append((new_path, file_id, kind))
 
 
236
    delta.modified.sort()
 
 
237
    delta.unchanged.sort()