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):
 
 
154
        old_tree = b.basis_tree()
 
 
156
        old_tree = b.revision_tree(b.lookup_revision(revision))
 
 
158
    new_tree = b.working_tree()
 
 
160
    show_diff_trees(old_tree, new_tree, sys.stdout, specific_files,
 
 
161
                    external_diff_options)
 
 
165
def show_diff_trees(old_tree, new_tree, to_file, specific_files=None,
 
 
166
                    external_diff_options=None):
 
 
167
    """Show in text form the changes from one tree to another.
 
 
170
        If set, include only changes to these files.
 
 
172
    external_diff_options
 
 
173
        If set, use an external GNU diff and pass these options.
 
 
176
    # TODO: Options to control putting on a prefix or suffix, perhaps as a format string
 
 
180
    DEVNULL = '/dev/null'
 
 
181
    # Windows users, don't panic about this filename -- it is a
 
 
182
    # special signal to GNU patch that the file should be created or
 
 
183
    # deleted respectively.
 
 
185
    # TODO: Generation of pseudo-diffs for added/deleted files could
 
 
186
    # be usefully made into a much faster special case.
 
 
188
    if external_diff_options:
 
 
189
        assert isinstance(external_diff_options, basestring)
 
 
190
        opts = external_diff_options.split()
 
 
191
        def diff_file(olab, olines, nlab, nlines, to_file):
 
 
192
            external_diff(olab, olines, nlab, nlines, to_file, opts)
 
 
194
        diff_file = internal_diff
 
 
197
    delta = compare_trees(old_tree, new_tree, want_unchanged=False,
 
 
198
                          specific_files=specific_files)
 
 
200
    for path, file_id, kind in delta.removed:
 
 
201
        print '*** removed %s %r' % (kind, path)
 
 
203
            diff_file(old_label + path,
 
 
204
                      old_tree.get_file(file_id).readlines(),
 
 
209
    for path, file_id, kind in delta.added:
 
 
210
        print '*** added %s %r' % (kind, path)
 
 
215
                      new_tree.get_file(file_id).readlines(),
 
 
218
    for old_path, new_path, file_id, kind, text_modified in delta.renamed:
 
 
219
        print '*** renamed %s %r => %r' % (kind, old_path, new_path)
 
 
221
            diff_file(old_label + old_path,
 
 
222
                      old_tree.get_file(file_id).readlines(),
 
 
223
                      new_label + new_path,
 
 
224
                      new_tree.get_file(file_id).readlines(),
 
 
227
    for path, file_id, kind in delta.modified:
 
 
228
        print '*** modified %s %r' % (kind, path)
 
 
230
            diff_file(old_label + path,
 
 
231
                      old_tree.get_file(file_id).readlines(),
 
 
233
                      new_tree.get_file(file_id).readlines(),
 
 
238
class TreeDelta(object):
 
 
239
    """Describes changes from one tree to another.
 
 
248
        (oldpath, newpath, id, kind, text_modified)
 
 
254
    Each id is listed only once.
 
 
256
    Files that are both modified and renamed are listed only in
 
 
257
    renamed, with the text_modified flag true.
 
 
259
    The lists are normally sorted when the delta is created.
 
 
269
    def touches_file_id(self, file_id):
 
 
270
        """Return True if file_id is modified by this delta."""
 
 
271
        for l in self.added, self.removed, self.modified:
 
 
275
        for v in self.renamed:
 
 
281
    def show(self, to_file, show_ids=False, show_unchanged=False):
 
 
282
        def show_list(files):
 
 
283
            for path, fid, kind in files:
 
 
284
                if kind == 'directory':
 
 
286
                elif kind == 'symlink':
 
 
290
                    print >>to_file, '  %-30s %s' % (path, fid)
 
 
292
                    print >>to_file, ' ', path
 
 
295
            print >>to_file, 'removed:'
 
 
296
            show_list(self.removed)
 
 
299
            print >>to_file, 'added:'
 
 
300
            show_list(self.added)
 
 
303
            print >>to_file, 'renamed:'
 
 
304
            for oldpath, newpath, fid, kind, text_modified in self.renamed:
 
 
306
                    print >>to_file, '  %s => %s %s' % (oldpath, newpath, fid)
 
 
308
                    print >>to_file, '  %s => %s' % (oldpath, newpath)
 
 
311
            print >>to_file, 'modified:'
 
 
312
            show_list(self.modified)
 
 
314
        if show_unchanged and self.unchanged:
 
 
315
            print >>to_file, 'unchanged:'
 
 
316
            show_list(self.unchanged)
 
 
320
def compare_trees(old_tree, new_tree, want_unchanged, specific_files=None):
 
 
321
    """Describe changes from one tree to another.
 
 
323
    Returns a TreeDelta with details of added, modified, renamed, and
 
 
326
    The root entry is specifically exempt.
 
 
328
    This only considers versioned files.
 
 
331
        If true, also list files unchanged from one version to
 
 
335
        If true, only check for changes to specified names or
 
 
339
    from osutils import is_inside_any
 
 
341
    old_inv = old_tree.inventory
 
 
342
    new_inv = new_tree.inventory
 
 
344
    mutter('start compare_trees')
 
 
346
    # TODO: match for specific files can be rather smarter by finding
 
 
347
    # the IDs of those files up front and then considering only that.
 
 
349
    for file_id in old_tree:
 
 
350
        if file_id in new_tree:
 
 
351
            kind = old_inv.get_file_kind(file_id)
 
 
352
            assert kind == new_inv.get_file_kind(file_id)
 
 
354
            assert kind in ('file', 'directory', 'symlink', 'root_directory'), \
 
 
355
                   'invalid file kind %r' % kind
 
 
357
            if kind == 'root_directory':
 
 
360
            old_path = old_inv.id2path(file_id)
 
 
361
            new_path = new_inv.id2path(file_id)
 
 
364
                if (not is_inside_any(specific_files, old_path) 
 
 
365
                    and not is_inside_any(specific_files, new_path)):
 
 
369
                old_sha1 = old_tree.get_file_sha1(file_id)
 
 
370
                new_sha1 = new_tree.get_file_sha1(file_id)
 
 
371
                text_modified = (old_sha1 != new_sha1)
 
 
373
                ## mutter("no text to check for %r %r" % (file_id, kind))
 
 
374
                text_modified = False
 
 
376
            # TODO: Can possibly avoid calculating path strings if the
 
 
377
            # two files are unchanged and their names and parents are
 
 
378
            # the same and the parents are unchanged all the way up.
 
 
379
            # May not be worthwhile.
 
 
381
            if old_path != new_path:
 
 
382
                delta.renamed.append((old_path, new_path, file_id, kind,
 
 
385
                delta.modified.append((new_path, file_id, kind))
 
 
387
                delta.unchanged.append((new_path, file_id, kind))
 
 
389
            kind = old_inv.get_file_kind(file_id)
 
 
390
            old_path = old_inv.id2path(file_id)
 
 
392
                if not is_inside_any(specific_files, old_path):
 
 
394
            delta.removed.append((old_path, file_id, kind))
 
 
396
    mutter('start looking for new files')
 
 
397
    for file_id in new_inv:
 
 
398
        if file_id in old_inv:
 
 
400
        new_path = new_inv.id2path(file_id)
 
 
402
            if not is_inside_any(specific_files, new_path):
 
 
404
        kind = new_inv.get_file_kind(file_id)
 
 
405
        delta.added.append((new_path, file_id, kind))
 
 
410
    delta.modified.sort()
 
 
411
    delta.unchanged.sort()