CheckExecDocs.py

# vim:sw=4:et
# ---------------------------------------------------------------
# Module          : rpmlint
# File            : CheckExecDocs.py
# Author          : Stephan Kulow, Dirk Mueller
# Purpose         : Check for executable files in %doc
# ---------------------------------------------------------------

import AbstractCheck
import Filter
import stat


def ignore_pkg(name):
    if name.startswith('bundle-') or '-devel' in name or '-doc' in name:
        return True
    return False


def lang_ignore_pkg(name):
    if ignore_pkg(name) or '-lang' in name or '-trans' in name:
        return True

    return False


class ExecDocsCheck(AbstractCheck.AbstractCheck):
    def __init__(self):
        self.map = []
        AbstractCheck.AbstractCheck.__init__(self, "CheckExecDocs")

    def check(self, pkg):

        if pkg.isSource():
            return

        files = pkg.files()
        complete_size = 0
        lang_size = 0
        for f, pkgfile in files.items():
            if stat.S_ISREG(pkgfile.mode):
                complete_size += pkgfile.size
                if pkgfile.lang != '':
                    lang_size += pkgfile.size

        doc_size = 0
        for f in pkg.docFiles():
            if stat.S_ISREG(files[f].mode):
                doc_size += files[f].size

        if doc_size * 2 >= complete_size and \
           doc_size > 100 * 1024 and \
           (complete_size - doc_size) * 20 > complete_size and \
           not ignore_pkg(pkg.name):
            Filter.printWarning(pkg, "package-with-huge-docs",
                                ("%3d%%" % (doc_size * 100 / complete_size)))

        if lang_size * 2 >= complete_size \
           and lang_size > 100 * 1024 and \
           (complete_size - lang_size) * 20 > complete_size and \
           not lang_ignore_pkg(pkg.name):
            Filter.printWarning(pkg, "package-with-huge-translation",
                                ("%3d%%" % (lang_size * 100 / complete_size)))

        for f in pkg.docFiles():
            mode = files[f].mode
            if not stat.S_ISREG(mode) or not mode & 0o111:
                continue
            for ext in ['txt', 'gif', 'jpg', 'html',
                        'pdf', 'ps', 'pdf.gz', 'ps.gz']:
                if f.endswith("." + ext):
                    Filter.printError(pkg, 'executable-docs', f)

            for name in ['README', 'NEWS', 'COPYING', 'AUTHORS']:
                if f.endswith("/" + name):
                    Filter.printError(pkg, 'executable-docs', f)


check = ExecDocsCheck()

Filter.addDetails(
'executable-docs',
"Documentation should not be executable.",
'package-with-huge-docs',
"""More than half the size of your package is documentation.
Consider splitting it into a -doc subpackage.""",
'package-with-huge-translation',
"""More than half the size of your package is language-specific.
Consider splitting it into a -lang subpackage."""
)