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 trace import mutter
 
 
19
from errors import BzrError
 
 
22
# TODO: Rather than building a changeset object, we should probably
 
 
23
# invoke callbacks on an object.  That object can either accumulate a
 
 
24
# list, write them out directly, etc etc.
 
 
26
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
 
29
    # FIXME: difflib is wrong if there is no trailing newline.
 
 
30
    # The syntax used by patch seems to be "\ No newline at
 
 
31
    # end of file" following the last diff line from that
 
 
32
    # file.  This is not trivial to insert into the
 
 
33
    # unified_diff output and it might be better to just fix
 
 
34
    # or replace that function.
 
 
36
    # In the meantime we at least make sure the patch isn't
 
 
40
    # Special workaround for Python2.3, where difflib fails if
 
 
41
    # both sequences are empty.
 
 
42
    if not oldlines and not newlines:
 
 
45
    ud = difflib.unified_diff(oldlines, newlines,
 
 
46
                              fromfile=old_label, tofile=new_label)
 
 
48
    # work-around for difflib being too smart for its own good
 
 
49
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
 
52
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
 
55
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
 
59
        if not line.endswith('\n'):
 
 
60
            to_file.write("\n\\ No newline at end of file\n")
 
 
66
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
 
68
    """Display a diff by calling out to the external diff program."""
 
 
71
    if to_file != sys.stdout:
 
 
72
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
 
75
    # make sure our own output is properly ordered before the diff
 
 
78
    from tempfile import NamedTemporaryFile
 
 
81
    oldtmpf = NamedTemporaryFile()
 
 
82
    newtmpf = NamedTemporaryFile()
 
 
85
        # TODO: perhaps a special case for comparing to or from the empty
 
 
86
        # sequence; can just use /dev/null on Unix
 
 
88
        # TODO: if either of the files being compared already exists as a
 
 
89
        # regular named file (e.g. in the working directory) then we can
 
 
90
        # compare directly to that, rather than copying it.
 
 
92
        oldtmpf.writelines(oldlines)
 
 
93
        newtmpf.writelines(newlines)
 
 
101
                   '--label', old_label,
 
 
103
                   '--label', new_label,
 
 
106
        # diff only allows one style to be specified; they don't override.
 
 
107
        # note that some of these take optargs, and the optargs can be
 
 
108
        # directly appended to the options.
 
 
109
        # this is only an approximate parser; it doesn't properly understand
 
 
111
        for s in ['-c', '-u', '-C', '-U',
 
 
116
                  '-y', '--side-by-side',
 
 
128
            diffcmd.extend(diff_opts)
 
 
130
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
 
132
        if rc != 0 and rc != 1:
 
 
133
            # returns 1 if files differ; that's OK
 
 
135
                msg = 'signal %d' % (-rc)
 
 
137
                msg = 'exit code %d' % rc
 
 
139
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
 
141
        oldtmpf.close()                 # and delete
 
 
146
def show_diff(b, revision, specific_files, external_diff_options=None):
 
 
147
    """Shortcut for showing the diff to the working tree.
 
 
153
        None for each, or otherwise the old revision to compare against.
 
 
155
    The more general form is show_diff_trees(), where the caller
 
 
156
    supplies any two trees.
 
 
161
        old_tree = b.basis_tree()
 
 
163
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
165
    new_tree = b.working_tree()
 
 
167
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
 
168
                    external_diff_options)
 
 
172
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
173
                    external_diff_options=None):
 
 
174
    """Show in text form the changes from one tree to another.
 
 
177
        If set, include only changes to these files.
 
 
179
    external_diff_options
 
 
180
        If set, use an external GNU diff and pass these options.
 
 
183
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
187
    DEVNULL = '/dev/null'
 
 
188
    # Windows users, don't panic about this filename -- it is a
 
 
189
    # special signal to GNU patch that the file should be created or
 
 
190
    # deleted respectively.
 
 
192
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
193
    # be usefully made into a much faster special case.
 
 
195
    if external_diff_options:
 
 
196
        assert isinstance(external_diff_options, basestring)
 
 
197
        opts = external_diff_options.split()
 
 
198
        def diff_file(olab, olines, nlab, nlines, to_file):
 
 
199
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
201
        diff_file = internal_diff
 
 
204
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
 
205
                          specific_files=specific_files)
 
 
207
    for path, file_id, kind in delta.removed:
 
 
208
        print >>to_file, '*** removed %s %r' % (kind, path)
 
 
210
            diff_file(old_label + path,
 
 
211
                      old_tree.get_file(file_id).readlines(),
 
 
216
    for path, file_id, kind in delta.added:
 
 
217
        print >>to_file, '*** added %s %r' % (kind, path)
 
 
222
                      new_tree.get_file(file_id).readlines(),
 
 
225
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
 
226
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
 
228
            diff_file(old_label + old_path,
 
 
229
                      old_tree.get_file(file_id).readlines(),
 
 
230
                      new_label + new_path,
 
 
231
                      new_tree.get_file(file_id).readlines(),
 
 
234
    for path, file_id, kind in delta.modified:
 
 
235
        print >>to_file, '*** modified %s %r' % (kind, path)
 
 
237
            diff_file(old_label + path,
 
 
238
                      old_tree.get_file(file_id).readlines(),
 
 
240
                      new_tree.get_file(file_id).readlines(),
 
 
245
class TreeDelta(object):
 
 
246
    """Describes changes from one tree to another.
 
 
255
        (oldpath, newpath, id, kind, text_modified)
 
 
261
    Each id is listed only once.
 
 
263
    Files that are both modified and renamed are listed only in
 
 
264
    renamed, with the text_modified flag true.
 
 
266
    Files are only considered renamed if their name has changed or
 
 
267
    their parent directory has changed.  Renaming a directory
 
 
268
    does not count as renaming all its contents.
 
 
270
    The lists are normally sorted when the delta is created.
 
 
279
    def __eq__(self, other):
 
 
280
        if not isinstance(other, TreeDelta):
 
 
282
        return self.added == other.added \
 
 
283
               and self.removed == other.removed \
 
 
284
               and self.renamed == other.renamed \
 
 
285
               and self.modified == other.modified \
 
 
286
               and self.unchanged == other.unchanged
 
 
288
    def __ne__(self, other):
 
 
289
        return not (self == other)
 
 
292
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
 
293
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
 
294
            self.modified, self.unchanged)
 
 
296
    def has_changed(self):
 
 
297
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
 
298
        changes += len(self.modified) 
 
 
299
        return (changes != 0)
 
 
301
    def touches_file_id(self, file_id):
 
 
302
        """Return True if file_id is modified by this delta."""
 
 
303
        for l in self.added, self.removed, self.modified:
 
 
307
        for v in self.renamed:
 
 
313
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
314
        def show_list(files):
 
 
315
            for path, fid, kind in files:
 
 
316
                if kind == 'directory':
 
 
318
                elif kind == 'symlink':
 
 
322
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
324
                    print >>to_file, ' ', path
 
 
327
            print >>to_file, 'removed:'
 
 
328
            show_list(self.removed)
 
 
331
            print >>to_file, 'added:'
 
 
332
            show_list(self.added)
 
 
335
            print >>to_file, 'renamed:'
 
 
336
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
 
338
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
340
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
343
            print >>to_file, 'modified:'
 
 
344
            show_list(self.modified)
 
 
346
        if show_unchanged and self.unchanged:
 
 
347
            print >>to_file, 'unchanged:'
 
 
348
            show_list(self.unchanged)
 
 
352
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
 
353
    """Describe changes from one tree to another.
 
 
355
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
358
    The root entry is specifically exempt.
 
 
360
    This only considers versioned files.
 
 
363
        If true, also list files unchanged from one version to
 
 
367
        If true, only check for changes to specified names or
 
 
371
    from osutils import is_inside_any
 
 
373
    old_inv = old_tree.inventory
 
 
374
    new_inv = new_tree.inventory
 
 
376
    mutter('start compare_trees')
 
 
378
    # TODO: match for specific files can be rather smarter by finding
 
 
379
    # the IDs of those files up front and then considering only that.
 
 
381
    for file_id in old_tree:
 
 
382
        if file_id in new_tree:
 
 
383
            old_ie = old_inv[file_id]
 
 
384
            new_ie = new_inv[file_id]
 
 
387
            assert kind == new_ie.kind
 
 
389
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
 
390
                   'invalid file kind %r' % kind
 
 
392
            if kind == 'root_directory':
 
 
396
                if (not is_inside_any(specific_files, old_inv.id2path(file_id)) 
 
 
397
                    and not is_inside_any(specific_files, new_inv.id2path(file_id))):
 
 
401
                old_sha1 = old_tree.get_file_sha1(file_id)
 
 
402
                new_sha1 = new_tree.get_file_sha1(file_id)
 
 
403
                text_modified = (old_sha1 != new_sha1)
 
 
405
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
 
406
                text_modified = False
 
 
408
            # TODO: Can possibly avoid calculating path strings if the
 
 
409
            # two files are unchanged and their names and parents are
 
 
410
            # the same and the parents are unchanged all the way up.
 
 
411
            # May not be worthwhile.
 
 
413
            if (old_ie.name != new_ie.name
 
 
414
                or old_ie.parent_id != new_ie.parent_id):
 
 
415
                delta.renamed.append((old_inv.id2path(file_id),
 
 
416
                                      new_inv.id2path(file_id),
 
 
420
                delta.modified.append((new_inv.id2path(file_id), file_id, kind))
 
 
422
                delta.unchanged.append((new_inv.id2path(file_id), file_id, kind))
 
 
424
            kind = old_inv.get_file_kind(file_id)
 
 
425
            old_path = old_inv.id2path(file_id)
 
 
427
                if not is_inside_any(specific_files, old_path):
 
 
429
            delta.removed.append((old_path, file_id, kind))
 
 
431
    mutter('start looking for new files')
 
 
432
    for file_id in new_inv:
 
 
433
        if file_id in old_inv:
 
 
435
        new_path = new_inv.id2path(file_id)
 
 
437
            if not is_inside_any(specific_files, new_path):
 
 
439
        kind = new_inv.get_file_kind(file_id)
 
 
440
        delta.added.append((new_path, file_id, kind))
 
 
445
    delta.modified.sort()
 
 
446
    delta.unchanged.sort()