1
# Copyright (C) 2005, 2006 Canonical
 
 
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)
 
 
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))
 
 
129
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
131
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
133
        if self.modified or extra_modified:
 
 
134
            print >>to_file, 'modified:'
 
 
135
            show_list(self.modified)
 
 
136
            show_list(extra_modified)
 
 
138
        if show_unchanged and self.unchanged:
 
 
139
            print >>to_file, 'unchanged:'
 
 
140
            show_list(self.unchanged)
 
 
144
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
 
145
    """Describe changes from one tree to another.
 
 
147
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
150
    The root entry is specifically exempt.
 
 
152
    This only considers versioned files.
 
 
155
        If true, also list files unchanged from one version to
 
 
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).
 
 
163
    # NB: show_status depends on being able to pass in non-versioned files and
 
 
164
    # report them as unknown
 
 
169
            return _compare_trees(old_tree, new_tree, want_unchanged,
 
 
177
def _compare_trees(old_tree, new_tree, want_unchanged, specific_files):
 
 
179
    from osutils import is_inside_any
 
 
181
    old_inv = old_tree.inventory
 
 
182
    new_inv = new_tree.inventory
 
 
184
    mutter('start compare_trees')
 
 
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.
 
 
191
    for file_id in old_tree:
 
 
192
        if file_id in new_tree:
 
 
193
            old_ie = old_inv[file_id]
 
 
194
            new_ie = new_inv[file_id]
 
 
197
            assert kind == new_ie.kind
 
 
199
            assert kind in InventoryEntry.known_kinds, \
 
 
200
                   'invalid file kind %r' % kind
 
 
202
            if kind == 'root_directory':
 
 
206
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
 
207
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
 
210
            # temporary hack until all entries are populated before clients 
 
 
212
            old_path = old_inv.id2path(file_id)
 
 
213
            new_path = new_inv.id2path(file_id)
 
 
214
            old_ie._read_tree_state(old_path, old_tree)
 
 
215
            new_ie._read_tree_state(new_path, new_tree)
 
 
216
            text_modified, meta_modified = new_ie.detect_changes(old_ie)
 
 
218
            # TODO: Can possibly avoid calculating path strings if the
 
 
219
            # two files are unchanged and their names and parents are
 
 
220
            # the same and the parents are unchanged all the way up.
 
 
221
            # May not be worthwhile.
 
 
223
            if (old_ie.name != new_ie.name
 
 
224
                or old_ie.parent_id != new_ie.parent_id):
 
 
225
                delta.renamed.append((old_path,
 
 
228
                                      text_modified, meta_modified))
 
 
229
            elif text_modified or meta_modified:
 
 
230
                delta.modified.append((new_path, file_id, kind,
 
 
231
                                       text_modified, meta_modified))
 
 
233
                delta.unchanged.append((new_path, file_id, kind))
 
 
235
            kind = old_inv.get_file_kind(file_id)
 
 
236
            if kind == 'root_directory':
 
 
238
            old_path = old_inv.id2path(file_id)
 
 
240
                if not is_inside_any(specific_files, old_path):
 
 
242
            delta.removed.append((old_path, file_id, kind))
 
 
244
    mutter('start looking for new files')
 
 
245
    for file_id in new_inv:
 
 
246
        if file_id in old_inv or file_id not in new_tree:
 
 
248
        kind = new_inv.get_file_kind(file_id)
 
 
249
        if kind == 'root_directory':
 
 
251
        new_path = new_inv.id2path(file_id)
 
 
253
            if not is_inside_any(specific_files, new_path):
 
 
255
        delta.added.append((new_path, file_id, kind))
 
 
260
    delta.modified.sort()
 
 
261
    delta.unchanged.sort()