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
def internal_diff(old_label, oldlines, new_label, newlines, to_file):
 
 
25
    # FIXME: difflib is wrong if there is no trailing newline.
 
 
26
    # The syntax used by patch seems to be "\ No newline at
 
 
27
    # end of file" following the last diff line from that
 
 
28
    # file.  This is not trivial to insert into the
 
 
29
    # unified_diff output and it might be better to just fix
 
 
30
    # or replace that function.
 
 
32
    # In the meantime we at least make sure the patch isn't
 
 
36
    # Special workaround for Python2.3, where difflib fails if
 
 
37
    # both sequences are empty.
 
 
38
    if not oldlines and not newlines:
 
 
43
    if oldlines and (oldlines[-1][-1] != '\n'):
 
 
46
    if newlines and (newlines[-1][-1] != '\n'):
 
 
50
    ud = difflib.unified_diff(oldlines, newlines,
 
 
51
                              fromfile=old_label, tofile=new_label)
 
 
53
    # work-around for difflib being too smart for its own good
 
 
54
    # if /dev/null is "1,0", patch won't recognize it as /dev/null
 
 
57
        ud[2] = ud[2].replace('-1,0', '-0,0')
 
 
60
        ud[2] = ud[2].replace('+1,0', '+0,0')
 
 
62
    to_file.writelines(ud)
 
 
64
        print >>to_file, "\\ No newline at end of file"
 
 
70
def external_diff(old_label, oldlines, new_label, newlines, to_file,
 
 
72
    """Display a diff by calling out to the external diff program."""
 
 
75
    if to_file != sys.stdout:
 
 
76
        raise NotImplementedError("sorry, can't send external diff other than to stdout yet",
 
 
79
    # make sure our own output is properly ordered before the diff
 
 
82
    from tempfile import NamedTemporaryFile
 
 
85
    oldtmpf = NamedTemporaryFile()
 
 
86
    newtmpf = NamedTemporaryFile()
 
 
89
        # TODO: perhaps a special case for comparing to or from the empty
 
 
90
        # sequence; can just use /dev/null on Unix
 
 
92
        # TODO: if either of the files being compared already exists as a
 
 
93
        # regular named file (e.g. in the working directory) then we can
 
 
94
        # compare directly to that, rather than copying it.
 
 
96
        oldtmpf.writelines(oldlines)
 
 
97
        newtmpf.writelines(newlines)
 
 
105
                   '--label', old_label,
 
 
107
                   '--label', new_label,
 
 
110
        # diff only allows one style to be specified; they don't override.
 
 
111
        # note that some of these take optargs, and the optargs can be
 
 
112
        # directly appended to the options.
 
 
113
        # this is only an approximate parser; it doesn't properly understand
 
 
115
        for s in ['-c', '-u', '-C', '-U',
 
 
120
                  '-y', '--side-by-side',
 
 
132
            diffcmd.extend(diff_opts)
 
 
134
        rc = os.spawnvp(os.P_WAIT, 'diff', diffcmd)
 
 
136
        if rc != 0 and rc != 1:
 
 
137
            # returns 1 if files differ; that's OK
 
 
139
                msg = 'signal %d' % (-rc)
 
 
141
                msg = 'exit code %d' % rc
 
 
143
            raise BzrError('external diff failed with %s; command: %r' % (rc, diffcmd))
 
 
145
        oldtmpf.close()                 # and delete
 
 
150
def show_diff(b, revision, specific_files, external_diff_options=None):
 
 
151
    """Shortcut for showing the diff to the working tree.
 
 
157
        None for each, or otherwise the old revision to compare against.
 
 
159
    The more general form is show_diff_trees(), where the caller
 
 
160
    supplies any two trees.
 
 
165
        old_tree = b.basis_tree()
 
 
167
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
169
    new_tree = b.working_tree()
 
 
171
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
 
172
                    external_diff_options)
 
 
176
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
177
                    external_diff_options=None):
 
 
178
    """Show in text form the changes from one tree to another.
 
 
181
        If set, include only changes to these files.
 
 
183
    external_diff_options
 
 
184
        If set, use an external GNU diff and pass these options.
 
 
187
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
191
    DEVNULL = '/dev/null'
 
 
192
    # Windows users, don't panic about this filename -- it is a
 
 
193
    # special signal to GNU patch that the file should be created or
 
 
194
    # deleted respectively.
 
 
196
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
197
    # be usefully made into a much faster special case.
 
 
199
    if external_diff_options:
 
 
200
        assert isinstance(external_diff_options, basestring)
 
 
201
        opts = external_diff_options.split()
 
 
202
        def diff_file(olab, olines, nlab, nlines, to_file):
 
 
203
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
205
        diff_file = internal_diff
 
 
208
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
 
209
                          specific_files=specific_files)
 
 
211
    for path, file_id, kind in delta.removed:
 
 
212
        print '*** removed %s %r' % (kind, path)
 
 
214
            diff_file(old_label + path,
 
 
215
                      old_tree.get_file(file_id).readlines(),
 
 
220
    for path, file_id, kind in delta.added:
 
 
221
        print '*** added %s %r' % (kind, path)
 
 
226
                      new_tree.get_file(file_id).readlines(),
 
 
229
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
 
230
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
 
232
            diff_file(old_label + old_path,
 
 
233
                      old_tree.get_file(file_id).readlines(),
 
 
234
                      new_label + new_path,
 
 
235
                      new_tree.get_file(file_id).readlines(),
 
 
238
    for path, file_id, kind in delta.modified:
 
 
239
        print '*** modified %s %r' % (kind, path)
 
 
241
            diff_file(old_label + path,
 
 
242
                      old_tree.get_file(file_id).readlines(),
 
 
244
                      new_tree.get_file(file_id).readlines(),
 
 
249
class TreeDelta(object):
 
 
250
    """Describes changes from one tree to another.
 
 
259
        (oldpath, newpath, id, kind, text_modified)
 
 
265
    Each id is listed only once.
 
 
267
    Files that are both modified and renamed are listed only in
 
 
268
    renamed, with the text_modified flag true.
 
 
270
    The lists are normally sorted when the delta is created.
 
 
279
    def has_changed(self):
 
 
280
        changes = len(self.added) + len(self.removed) + len(self.renamed)
 
 
281
        changes += len(self.modified) 
 
 
282
        return (changes != 0)
 
 
284
    def touches_file_id(self, file_id):
 
 
285
        """Return True if file_id is modified by this delta."""
 
 
286
        for l in self.added, self.removed, self.modified:
 
 
290
        for v in self.renamed:
 
 
296
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
297
        def show_list(files):
 
 
298
            for path, fid, kind in files:
 
 
299
                if kind == 'directory':
 
 
301
                elif kind == 'symlink':
 
 
305
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
307
                    print >>to_file, ' ', path
 
 
310
            print >>to_file, 'removed:'
 
 
311
            show_list(self.removed)
 
 
314
            print >>to_file, 'added:'
 
 
315
            show_list(self.added)
 
 
318
            print >>to_file, 'renamed:'
 
 
319
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
 
321
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
323
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
326
            print >>to_file, 'modified:'
 
 
327
            show_list(self.modified)
 
 
329
        if show_unchanged and self.unchanged:
 
 
330
            print >>to_file, 'unchanged:'
 
 
331
            show_list(self.unchanged)
 
 
335
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
 
336
    """Describe changes from one tree to another.
 
 
338
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
341
    The root entry is specifically exempt.
 
 
343
    This only considers versioned files.
 
 
346
        If true, also list files unchanged from one version to
 
 
350
        If true, only check for changes to specified names or
 
 
354
    from osutils import is_inside_any
 
 
356
    old_inv = old_tree.inventory
 
 
357
    new_inv = new_tree.inventory
 
 
359
    mutter('start compare_trees')
 
 
361
    # TODO: match for specific files can be rather smarter by finding
 
 
362
    # the IDs of those files up front and then considering only that.
 
 
364
    for file_id in old_tree:
 
 
365
        if file_id in new_tree:
 
 
366
            kind = old_inv.get_file_kind(file_id)
 
 
367
            assert kind == new_inv.get_file_kind(file_id)
 
 
369
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
 
370
                   'invalid file kind %r' % kind
 
 
372
            if kind == 'root_directory':
 
 
375
            old_path = old_inv.id2path(file_id)
 
 
376
            new_path = new_inv.id2path(file_id)
 
 
379
                if (not is_inside_any(specific_files, old_path) 
 
 
380
                    and not is_inside_any(specific_files, new_path)):
 
 
384
                old_sha1 = old_tree.get_file_sha1(file_id)
 
 
385
                new_sha1 = new_tree.get_file_sha1(file_id)
 
 
386
                text_modified = (old_sha1 != new_sha1)
 
 
388
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
 
389
                text_modified = False
 
 
391
            # TODO: Can possibly avoid calculating path strings if the
 
 
392
            # two files are unchanged and their names and parents are
 
 
393
            # the same and the parents are unchanged all the way up.
 
 
394
            # May not be worthwhile.
 
 
396
            if old_path != new_path:
 
 
397
                delta.renamed.append((old_path, new_path, file_id, kind,
 
 
400
                delta.modified.append((new_path, file_id, kind))
 
 
402
                delta.unchanged.append((new_path, file_id, kind))
 
 
404
            kind = old_inv.get_file_kind(file_id)
 
 
405
            old_path = old_inv.id2path(file_id)
 
 
407
                if not is_inside_any(specific_files, old_path):
 
 
409
            delta.removed.append((old_path, file_id, kind))
 
 
411
    mutter('start looking for new files')
 
 
412
    for file_id in new_inv:
 
 
413
        if file_id in old_inv:
 
 
415
        new_path = new_inv.id2path(file_id)
 
 
417
            if not is_inside_any(specific_files, new_path):
 
 
419
        kind = new_inv.get_file_kind(file_id)
 
 
420
        delta.added.append((new_path, file_id, kind))
 
 
425
    delta.modified.sort()
 
 
426
    delta.unchanged.sort()