2
# -*- coding: UTF-8 -*-
 
 
4
# This program is free software; you can redistribute it and/or modify
 
 
5
# it under the terms of the GNU General Public License as published by
 
 
6
# the Free Software Foundation; either version 2 of the License, or
 
 
7
# (at your option) any later version.
 
 
9
# This program is distributed in the hope that it will be useful,
 
 
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
 
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
 
12
# GNU General Public License for more details.
 
 
14
# You should have received a copy of the GNU General Public License
 
 
15
# along with this program; if not, write to the Free Software
 
 
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
 
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)
 
 
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.
 
 
41
    Files are only considered renamed if their name has changed or
 
 
42
    their parent directory has changed.  Renaming a directory
 
 
43
    does not count as renaming all its contents.
 
 
45
    The lists are normally sorted when the delta is created.
 
 
54
    def __eq__(self, other):
 
 
55
        if not isinstance(other, TreeDelta):
 
 
57
        return self.added == other.added \
 
 
58
               and self.removed == other.removed \
 
 
59
               and self.renamed == other.renamed \
 
 
60
               and self.modified == other.modified \
 
 
61
               and self.unchanged == other.unchanged
 
 
63
    def __ne__(self, other):
 
 
64
        return not (self == other)
 
 
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)
 
 
71
    def has_changed(self):
 
 
72
        return bool(self.modified
 
 
77
    def touches_file_id(self, file_id):
 
 
78
        """Return True if file_id is modified by this delta."""
 
 
79
        for l in self.added, self.removed, self.modified:
 
 
83
        for v in self.renamed:
 
 
89
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
91
            for path, fid, kind in files:
 
 
92
                if kind == 'directory':
 
 
94
                elif kind == 'symlink':
 
 
98
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
100
                    print >>to_file, ' ', path
 
 
103
            print >>to_file, 'removed:'
 
 
104
            show_list(self.removed)
 
 
107
            print >>to_file, 'added:'
 
 
108
            show_list(self.added)
 
 
111
            print >>to_file, 'renamed:'
 
 
112
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
 
114
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
116
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
119
            print >>to_file, 'modified:'
 
 
120
            show_list(self.modified)
 
 
122
        if show_unchanged and self.unchanged:
 
 
123
            print >>to_file, 'unchanged:'
 
 
124
            show_list(self.unchanged)
 
 
128
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
 
129
    """Describe changes from one tree to another.
 
 
131
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
134
    The root entry is specifically exempt.
 
 
136
    This only considers versioned files.
 
 
139
        If true, also list files unchanged from one version to
 
 
143
        If true, only check for changes to specified names or
 
 
147
    from osutils import is_inside_any
 
 
149
    old_inv = old_tree.inventory
 
 
150
    new_inv = new_tree.inventory
 
 
152
    mutter('start compare_trees')
 
 
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.
 
 
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]
 
 
163
            assert kind == new_ie.kind
 
 
165
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
 
166
                   'invalid file kind %r' % kind
 
 
168
            if kind == 'root_directory':
 
 
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))):
 
 
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)
 
 
181
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
 
182
                text_modified = False
 
 
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.
 
 
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),
 
 
196
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
 
198
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
 
 
200
            kind = old_inv.get_file_kind(file_id)
 
 
201
            if kind == 'root_directory':
 
 
203
            old_path = old_inv.id2path(file_id)
 
 
205
                if not is_inside_any(specific_files, old_path):
 
 
207
            delta.removed.append((old_path, file_id, kind))
 
 
209
    mutter('start looking for new files')
 
 
210
    for file_id in new_inv:
 
 
211
        if file_id in old_inv:
 
 
213
        kind = new_inv.get_file_kind(file_id)
 
 
214
        if kind == 'root_directory':
 
 
216
        new_path = new_inv.id2path(file_id)
 
 
218
            if not is_inside_any(specific_files, new_path):
 
 
220
        delta.added.append((new_path, file_id, kind))
 
 
225
    delta.modified.sort()
 
 
226
    delta.unchanged.sort()