path: root/bin/reproducible_html_packages.py

#!/usr/bin/python3
# -*- coding: utf-8 -*-
#
# Copyright © 2015 Mattia Rizzolo <mattia@mapreri.org>
# Based on reproducible_html_packages.sh © 2014 Holger Levsen <holger@layer-acht.org>
# Licensed under GPL-2
#
# Depends: python3
#
# Build rb-pkg pages (the pages that describe the package status)

from reproducible_common import *

html_package_page = Template((tab*2).join(("""
<table class="head">
    <tr>
        <td>
            <span class="avoidwrap">
                <span style="font-size:1.2em;">$package</span> $suite: $version
$status
                <span style="font-size:0.9em;">$build_time:</span>
            </span>
            <span class="avoidwrap">
$links
                <a href="https://tracker.debian.org/$package" target="main">PTS</a>
                <a href="https://bugs.debian.org/src:$package" target="main">BTS</a>
                <a href="https://sources.debian.net/src/$package/$version/" target="main">sources</a>
                <a href="https://sources.debian.net/src/$package/$version/debian/" target="main">debian</a>/<!--
                -->{<a href="https://sources.debian.net/src/$package/$version/debian/changelog" target="main">changelog</a>,<!--
                --><a href="https://sources.debian.net/src/$package/$version/debian/control" target="main">control</a>,<!--
                --><a href="https://sources.debian.net/src/$package/$version/debian/rules" target="main">rules</a>}
            </span>
        </td>
        <td>
${suites_links}
        </td>
        <td style="text-align:right; font-size:0.9em;">
            <span class="red" style="font-size:1.5em;" title="Notifications for this packages are enabled. Every status change reproducibly-wise will be emailed to the maintainer">
                <a href="/index_notify.html" target="_parent">$notify_maintainer</a>
            </span>
            <a href="%s" target="_parent">
                reproducible builds
            </a>
        </td>
    </tr>
</table>
<iframe id="main" name="main" src="${default_view}">
    <p>
        Your browser does not support iframes.
        Use a different one or follow the links above.
    </p>
</iframe>""" % REPRODUCIBLE_URL ).splitlines(True)))


def sizeof_fmt(num):
    for unit in ['B','KB','MB','GB']:
        if abs(num) < 1024.0:
            if unit == 'GB':
                log.error('The size of this file is bigger than 1 GB!')
                log.error('Please check')
            return str(int(round(float("%3f" % num), 0))) + "%s" % (unit)
        num /= 1024.0
    return str(int(round(float("%f" % num), 0))) + "%s" % ('Yi')

def check_package_status(package, suite, nocheck=False):
    """
    This returns a tuple containing status, version and build_date of the last
    version of the package built by jenkins CI
    """
    try:
        query = ('SELECT r.status, r.version, r.build_date, s.notify_maintainer ' +
                 'FROM results AS r JOIN sources AS s ON r.package_id=s.id ' +
                 'WHERE s.name="{pkg}" ' +
                 'AND s.suite="{suite}"').format(pkg=package, suite=suite)
        result = query_db(query)[0]
    except IndexError:
        query = 'SELECT version, notify_maintainer ' + \
                'FROM sources WHERE name="{pkg}" AND suite="{suite}"'
        query = query.format(pkg=package, suite=suite)
        try:
            result = query_db(query)[0]
            if result:
                result = ('untested', str(result[0]), False, result[1])
        except IndexError:
            if nocheck:
                return False
            print_critical_message('This query produces no results: ' + query +
                    '\nThis means there is no available package with the name '
                    + package + '.')
            raise
    status = str(result[0])
    version = str(result[1])
    notify_maint = '⚑' if int(result[3]) == 1 else ''
    if result[2]:
        build_date = 'at ' + str(result[2]) + ' UTC'
    else:
        build_date = '<span style="color:red;font-weight:bold;">UNTESTED</span>'
    return (status, version, build_date, notify_maint)


def gen_status_link_icon(status, icon, suite, arch):
    html = ''
    if status != 'untested':
        html += tab*6 + '<a href="/{suite}/{arch}/index_{status}.html"' + \
                ' target="_parent" title="{status}">\n'
    html += tab*9 + '<img src="/static/{icon}" alt="{status}" />\n'
    if status != 'untested':
        html += tab*8 + '</a>\n'
    return html.format(status=status, icon=icon, suite=suite, arch=arch)


def link_buildlogs(package, eversion, suite, arch):
    html = ''
    path = suite + '/' + arch + '/' + package + '_' + eversion + '.build{}.log.gz'
    log = LOGS_PATH + '/' + path
    uri = LOGS_URI + '/' + path
    if os.access(log.format('1'), os.R_OK):
        html += '<a href="' + uri.format('1') + '" target="main">log1</a>\n'
    if os.access(log.format('2'), os.R_OK):
        html += '<a href="' + uri.format('2') + '" target="main">2</a>\n'
    return html


def gen_extra_links(package, version, suite, arch, status):
    eversion = strip_epoch(version)
    notes = NOTES_PATH + '/' + package + '_note.html'
    buildinfo = BUILDINFO_PATH + '/' + suite + '/' + arch + '/' + package + \
                '_' + eversion + '_amd64.buildinfo'
    dbd = DBD_PATH + '/' + suite + '/' + arch + '/' + package + '_' + \
          eversion + '.debbindiff.html'

    links = ''
    default_view = ''
    # check whether there are notes available for this package
    if os.access(notes, os.R_OK):
        url = NOTES_URI + '/' + package + '_note.html'
        links += '<a href="' + url + '" target="main">notes</a>\n'
        default_view = url
    else:
        log.debug('notes not detected at ' + notes)
    if os.access(dbd, os.R_OK):
        url = DBD_URI + '/' + suite + '/' + arch + '/' +  package + '_' + \
              eversion + '.debbindiff.html'
        links += '<a href="' + url + '" target="main">debbindiff</a>\n'
        if not default_view:
            default_view = url
    else:
        log.debug('debbindiff not detetected at ' + dbd)
        if status == 'unreproducible':
            log.critical(REPRODUCIBLE_URL + '/' + suite + '/' + arch + '/' + package +
                         ' is unreproducible, but without debbindiff output.')
    if pkg_has_buildinfo(package, version, suite):
        url = BUILDINFO_URI + '/' + suite + '/' + arch + '/' + package + \
              '_' + eversion + '_amd64.buildinfo'
        links += '<a href="' + url + '" target="main">buildinfo</a>\n'
        if not default_view:
            default_view = url
    else:
        log.debug('buildinfo not detected at ' + buildinfo)
    rbuild = pkg_has_rbuild(package, version, suite, arch)
    if rbuild:  # being a tuple (rbuild path, size), empty if non existant
        url = RBUILD_URI + '/' + suite + '/' + arch + '/' + package + '_' + \
              eversion + '.rbuild.log'  # apache ignores the trailing .gz
        links +='<a href="' + url + '" target="main">rbuild (' + \
                sizeof_fmt(rbuild[1]) + ')</a>\n'
        if not default_view:
            default_view = url
    elif status not in ('untested', 'blacklisted'):
        log.critical(REPRODUCIBLE_URL  + '/' + suite + '/' + arch + '/' + package +
                     ' didn\'t produce a buildlog, even though it has been built.')
    links += link_buildlogs(package, eversion, suite, arch)
    default_view = '/untested.html' if not default_view else default_view
    return (links, default_view)


def gen_suites_links(package, suite):
    html = ''
    query = 'SELECT s.suite, s.architecture, s.version, r.version, r.status ' + \
            'FROM sources AS s LEFT JOIN results AS r ON r.package_id=s.id ' + \
            'WHERE s.name="{pkg}"'.format(pkg=package)
    results = query_db(query)
    if len(results) < 1:
        print_critical_message('This query produces 0 results:\n' + query)
        raise ValueError
    if len(results) == 1:
        return html
    for i in results:
        # i[0]: suite, i[1]: arch, i[2]: avail version, i[3]: tested version,
        # i[4]: status (i[2] and i[3] will be NULL if untested)
        if i[0] == suite:  # don't link the current suite
            continue
        status = 'untested' if not i[4] else i[4]
        version = i[3] if i[3] else i[2]
        if status == 'unreproducible':
            status = 'FTBR'
        elif status == 'not for us':
            status = 'not_for_us'
        html += '<span class="avoidwrap">\n' + tab
        if status != 'untested':
            prefix = ' <a href="/' + i[0] + '/' + i[1] + '/index_' + status + '.html">'
            suffix = '</a>\n'
        else:
            prefix = ' '
            suffix = '\n'
        icon = prefix + '<img src="/static/{icon}" alt="{status}" title="{status}"/>' + suffix
        html += icon.format(icon=join_status_icon(status)[1], status=status)
        html += tab + ' <a href="' + RB_PKG_URI + '/' + i[0] + '/' + i[1] + \
                '/' + str(package) + '.html" target="_parent">' + i[0] + \
                ':' + version + '</a>\n'
        html += '</span>\n'
    return tab*5 + (tab*7).join(html.splitlines(True))


def gen_packages_html(packages, suite=None, arch=None, no_clean=False, nocheck=False):
    """
    generate the /rb-pkg/package.html page
    packages should be a list
    If suite and/or arch is not passed, then build that packages for all suites
    nocheck is for internal use
    """
    total = len(packages)
    log.debug('Generating the pages of ' + str(total) + ' package(s)')
    if not nocheck and (not suite or not arch):
        nocheck = True
    if nocheck and (not suite or not arch):
        for lsuite in SUITES:
            for larch in ARCHES:
                gen_packages_html(packages, lsuite, larch, no_clean, True)
        return
    for pkg in sorted(packages):
        pkg = str(pkg)
        try:
            pkgstatus = check_package_status(pkg, suite, nocheck)
            status, version, build_date, notify_maint = pkgstatus
        except TypeError:  # the package is not in the checked suite
            continue
        log.debug('Generating the page of ' + pkg + '/' + suite + '@' + version +
                 ' built at ' + build_date)

        links, default_view = gen_extra_links(pkg, version, suite, arch, status)
        suites_links = gen_suites_links(pkg, suite)
        status, icon = join_status_icon(status, pkg, version)
        status = gen_status_link_icon(status, icon, suite, arch)

        html = html_package_page.substitute(package=pkg,
                                            suite=suite,
                                            status=status,
                                            version=version,
                                            build_time=build_date,
                                            links=links,
                                            notify_maintainer=notify_maint,
                                            suites_links=suites_links,
                                            default_view=default_view)
        destfile = RB_PKG_PATH + '/' + suite + '/' + arch + '/' + pkg + '.html'
        desturl = REPRODUCIBLE_URL + RB_PKG_URI + '/' + suite + '/' + \
                  arch + '/' + pkg + '.html'
        title = pkg + ' - reproducible build results'
        write_html_page(title=title, body=html, destfile=destfile, suite=suite,
                        noheader=True, noendpage=True)
        log.debug("Package page generated at " + desturl)
    if not no_clean:
        purge_old_pages() # housekeep is always good

def gen_all_rb_pkg_pages(suite='unstable', arch='amd64', no_clean=False):
    query = 'SELECT name FROM sources WHERE suite="%s" AND architecture="%s"' % (suite, arch)
    rows = query_db(query)
    pkgs = [str(i[0]) for i in rows]
    log.info('Processing all ' + str(len(pkgs)) + ' package pages for ' + suite + '/' + arch +'.')
    gen_packages_html(pkgs, suite=suite, arch=arch, no_clean=no_clean)

def purge_old_pages():
    for suite in SUITES:
        for arch in ARCHES:
            log.info('Removing old pages from ' + suite + '/' + arch + '.')
            try:
                presents = sorted(os.listdir(RB_PKG_PATH + '/' + suite + '/' +
                                  arch))
            except OSError as e:
                if e.errno != errno.ENOENT:  # that's 'No such file or
                    raise                    # directory' error (errno 17)
                presents = []
            log.debug('page presents: ' + str(presents))
            for page in presents:
                pkg = page.rsplit('.', 1)[0]
                query = 'SELECT s.name ' + \
                    'FROM sources AS s ' + \
                    'WHERE s.name="{name}" ' + \
                    'AND s.suite="{suite}" AND s.architecture="{arch}"'
                query = query.format(name=pkg, suite=suite, arch=arch)
                result = query_db(query)
                if not result: # actually, the query produces no results
                    log.info('There is no package named ' + pkg + ' from ' +
                             suite + '/' + arch + ' in the database. ' +
                             'Removing old page.')
                    os.remove(RB_PKG_PATH + '/' + suite + '/' + arch + '/' +
                              page)