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:
 
 
47
    if oldlines and (oldlines[-1][-1] != '\n'):
 
 
50
    if newlines and (newlines[-1][-1] != '\n'):
 
 
54
    ud = difflib.unified_diff(oldlines, newlines,
 
 
55
                              fromfile=old_label, tofile=new_label)
 
 
57
    # work-around for difflib being too smart for its own good
 
 
58
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
 
61
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
 
64
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
 
66
    to_file.writelines(ud)
 
 
68
        print >>to_file, "\\ No newline at end of file"
 
 
74
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
 
76
    """Display a diff by calling out to the external diff program."""
 
 
79
    if to_file != sys.stdout:
 
 
80
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
 
83
    # make sure our own output is properly ordered before the diff
 
 
86
    from tempfile import NamedTemporaryFile
 
 
89
    oldtmpf = NamedTemporaryFile()
 
 
90
    newtmpf = NamedTemporaryFile()
 
 
93
        # TODO: perhaps a special case for comparing to or from the empty
 
 
94
        # sequence; can just use /dev/null on Unix
 
 
96
        # TODO: if either of the files being compared already exists as a
 
 
97
        # regular named file (e.g. in the working directory) then we can
 
 
98
        # compare directly to that, rather than copying it.
 
 
100
        oldtmpf.writelines(oldlines)
 
 
101
        newtmpf.writelines(newlines)
 
 
109
                   '--label', old_label,
 
 
111
                   '--label', new_label,
 
 
114
        # diff only allows one style to be specified; they don't override.
 
 
115
        # note that some of these take optargs, and the optargs can be
 
 
116
        # directly appended to the options.
 
 
117
        # this is only an approximate parser; it doesn't properly understand
 
 
119
        for s in ['-c', '-u', '-C', '-U',
 
 
124
                  '-y', '--side-by-side',
 
 
136
            diffcmd.extend(diff_opts)
 
 
138
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
 
140
        if rc != 0 and rc != 1:
 
 
141
            # returns 1 if files differ; that's OK
 
 
143
                msg = 'signal %d' % (-rc)
 
 
145
                msg = 'exit code %d' % rc
 
 
147
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
 
149
        oldtmpf.close()                 # and delete
 
 
154
def show_diff(b, revision, specific_files, external_diff_options=None):
 
 
155
    """Shortcut for showing the diff to the working tree.
 
 
161
        None for each, or otherwise the old revision to compare against.
 
 
163
    The more general form is show_diff_trees(), where the caller
 
 
164
    supplies any two trees.
 
 
169
        old_tree = b.basis_tree()
 
 
171
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
173
    new_tree = b.working_tree()
 
 
175
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
 
176
                    external_diff_options)
 
 
180
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
181
                    external_diff_options=None):
 
 
182
    """Show in text form the changes from one tree to another.
 
 
185
        If set, include only changes to these files.
 
 
187
    external_diff_options
 
 
188
        If set, use an external GNU diff and pass these options.
 
 
191
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
195
    DEVNULL = '/dev/null'
 
 
196
    # Windows users, don't panic about this filename -- it is a
 
 
197
    # special signal to GNU patch that the file should be created or
 
 
198
    # deleted respectively.
 
 
200
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
201
    # be usefully made into a much faster special case.
 
 
203
    if external_diff_options:
 
 
204
        assert isinstance(external_diff_options, basestring)
 
 
205
        opts = external_diff_options.split()
 
 
206
        def diff_file(olab, olines, nlab, nlines, to_file):
 
 
207
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
209
        diff_file = internal_diff
 
 
212
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
 
213
                          specific_files=specific_files)
 
 
215
    for path, file_id, kind in delta.removed:
 
 
216
        print >>to_file, '*** removed %s %r' % (kind, path)
 
 
218
            diff_file(old_label + path,
 
 
219
                      old_tree.get_file(file_id).readlines(),
 
 
224
    for path, file_id, kind in delta.added:
 
 
225
        print >>to_file, '*** added %s %r' % (kind, path)
 
 
230
                      new_tree.get_file(file_id).readlines(),
 
 
233
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
 
234
        print >>to_file, '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
 
236
            diff_file(old_label + old_path,
 
 
237
                      old_tree.get_file(file_id).readlines(),
 
 
238
                      new_label + new_path,
 
 
239
                      new_tree.get_file(file_id).readlines(),
 
 
242
    for path, file_id, kind in delta.modified:
 
 
243
        print >>to_file, '*** modified %s %r' % (kind, path)
 
 
245
            diff_file(old_label + path,
 
 
246
                      old_tree.get_file(file_id).readlines(),
 
 
248
                      new_tree.get_file(file_id).readlines(),
 
 
253
class TreeDelta(object):
 
 
254
    """Describes changes from one tree to another.
 
 
263
        (oldpath, newpath, id, kind, text_modified)
 
 
269
    Each id is listed only once.
 
 
271
    Files that are both modified and renamed are listed only in
 
 
272
    renamed, with the text_modified flag true.
 
 
274
    Files are only considered renamed if their name has changed or
 
 
275
    their parent directory has changed.  Renaming a directory
 
 
276
    does not count as renaming all its contents.
 
 
278
    The lists are normally sorted when the delta is created.
 
 
287
    def __eq__(self, other):
 
 
288
        if not isinstance(other, TreeDelta):
 
 
290
        return self.added == other.added \
 
 
291
               and self.removed == other.removed \
 
 
292
               and self.renamed == other.renamed \
 
 
293
               and self.modified == other.modified \
 
 
294
               and self.unchanged == other.unchanged
 
 
296
    def __ne__(self, other):
 
 
297
        return not (self == other)
 
 
300
        return "TreeDelta(added=%r, removed=%r, renamed=%r, modified=%r," \
 
 
301
            " unchanged=%r)" % (self.added, self.removed, self.renamed,
 
 
302
            self.modified, self.unchanged)
 
 
304
    def has_changed(self):
 
 
305
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
 
306
        changes += len(self.modified) 
 
 
307
        return (changes != 0)
 
 
309
    def touches_file_id(self, file_id):
 
 
310
        """Return True if file_id is modified by this delta."""
 
 
311
        for l in self.added, self.removed, self.modified:
 
 
315
        for v in self.renamed:
 
 
321
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
322
        def show_list(files):
 
 
323
            for path, fid, kind in files:
 
 
324
                if kind == 'directory':
 
 
326
                elif kind == 'symlink':
 
 
330
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
332
                    print >>to_file, ' ', path
 
 
335
            print >>to_file, 'removed:'
 
 
336
            show_list(self.removed)
 
 
339
            print >>to_file, 'added:'
 
 
340
            show_list(self.added)
 
 
343
            print >>to_file, 'renamed:'
 
 
344
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
 
346
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
348
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
351
            print >>to_file, 'modified:'
 
 
352
            show_list(self.modified)
 
 
354
        if show_unchanged and self.unchanged:
 
 
355
            print >>to_file, 'unchanged:'
 
 
356
            show_list(self.unchanged)
 
 
360
def compare_trees(old_tree, new_tree, want_unchanged=False, specific_files=None):
 
 
361
    """Describe changes from one tree to another.
 
 
363
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
366
    The root entry is specifically exempt.
 
 
368
    This only considers versioned files.
 
 
371
        If true, also list files unchanged from one version to
 
 
375
        If true, only check for changes to specified names or
 
 
379
    from osutils import is_inside_any
 
 
381
    old_inv = old_tree.inventory
 
 
382
    new_inv = new_tree.inventory
 
 
384
    mutter('start compare_trees')
 
 
386
    # TODO: match for specific files can be rather smarter by finding
 
 
387
    # the IDs of those files up front and then considering only that.
 
 
389
    for file_id in old_tree:
 
 
390
        if file_id in new_tree:
 
 
391
            kind = old_inv.get_file_kind(file_id)
 
 
392
            assert kind == new_inv.get_file_kind(file_id)
 
 
394
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
 
395
                   'invalid file kind %r' % kind
 
 
397
            if kind == 'root_directory':
 
 
400
            old_path = old_inv.id2path(file_id)
 
 
401
            new_path = new_inv.id2path(file_id)
 
 
403
            old_ie = old_inv[file_id]
 
 
404
            new_ie = new_inv[file_id]
 
 
407
                if (not is_inside_any(specific_files, old_path) 
 
 
408
                    and not is_inside_any(specific_files, new_path)):
 
 
412
                old_sha1 = old_tree.get_file_sha1(file_id)
 
 
413
                new_sha1 = new_tree.get_file_sha1(file_id)
 
 
414
                text_modified = (old_sha1 != new_sha1)
 
 
416
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
 
417
                text_modified = False
 
 
419
            # TODO: Can possibly avoid calculating path strings if the
 
 
420
            # two files are unchanged and their names and parents are
 
 
421
            # the same and the parents are unchanged all the way up.
 
 
422
            # May not be worthwhile.
 
 
424
            if (old_ie.name != new_ie.name
 
 
425
                or old_ie.parent_id != new_ie.parent_id):
 
 
426
                delta.renamed.append((old_path, new_path, file_id, kind,
 
 
429
                delta.modified.append((new_path, file_id, kind))
 
 
431
                delta.unchanged.append((new_path, file_id, kind))
 
 
433
            kind = old_inv.get_file_kind(file_id)
 
 
434
            old_path = old_inv.id2path(file_id)
 
 
436
                if not is_inside_any(specific_files, old_path):
 
 
438
            delta.removed.append((old_path, file_id, kind))
 
 
440
    mutter('start looking for new files')
 
 
441
    for file_id in new_inv:
 
 
442
        if file_id in old_inv:
 
 
444
        new_path = new_inv.id2path(file_id)
 
 
446
            if not is_inside_any(specific_files, new_path):
 
 
448
        kind = new_inv.get_file_kind(file_id)
 
 
449
        delta.added.append((new_path, file_id, kind))
 
 
454
    delta.modified.sort()
 
 
455
    delta.unchanged.sort()