statoolinfosweb/src/fr/devinsy/statoolinfos/htmlize/ServicePage.java

/*
 * Copyright (C) 2020-2021 Christian Pierre MOMON <christian@momon.org>
 * 
 * This file is part of StatoolInfos, simple service statistics tool.
 * 
 * StatoolInfos is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * StatoolInfos is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with StatoolInfos.  If not, see <http://www.gnu.org/licenses/>.
 */
package fr.devinsy.statoolinfos.htmlize;

import java.io.File;
import java.io.IOException;
import java.nio.charset.StandardCharsets;

import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import fr.devinsy.catgenerator.core.BirdGenerator;
import fr.devinsy.statoolinfos.HtmlizerContext;
import fr.devinsy.statoolinfos.checker.PropertyChecks;
import fr.devinsy.statoolinfos.core.Metrics;
import fr.devinsy.statoolinfos.core.Organization;
import fr.devinsy.statoolinfos.core.Service;
import fr.devinsy.statoolinfos.core.StatoolInfosException;
import fr.devinsy.statoolinfos.crawl.CrawlCache;
import fr.devinsy.statoolinfos.htmlize.charts.ChartColor;
import fr.devinsy.statoolinfos.htmlize.charts.MonthValues;
import fr.devinsy.xidyn.XidynException;
import fr.devinsy.xidyn.data.DisplayMode;
import fr.devinsy.xidyn.data.TagDataManager;
import fr.devinsy.xidyn.presenters.PresenterUtils;

/**
 * The Class ServicePage.
 */
public class ServicePage
{
    private static Logger logger = LoggerFactory.getLogger(ServicePage.class);

    /**
     * Builds the view.
     * 
     * @throws IOException
     * @throws StatoolInfosException
     */
    public static void build(final Service service) throws IOException, StatoolInfosException
    {
        CrawlCache cache = HtmlizerContext.instance().getCache();
        File htmlizeDirectory = HtmlizerContext.instance().getHtmlizeDirectory();

        // Manage the logo file.
        logger.info("Htmlize service logo: {}.", service.getName());
        htmlizeServiceLogo(service, cache, htmlizeDirectory);

        //
        logger.info("Htmlize service properties file: {}.", service.getName());
        FileUtils.copyFile(service.getInputFile(),
                new File(htmlizeDirectory, service.getLocalFileBaseName() + ".properties"));

        //
        for (Metrics metrics : service.getMetrics())
        {
            FileUtils.copyFile(metrics.getInputFile(),
                    new File(htmlizeDirectory, metrics.getLocalFileBaseName() + ".properties"));
        }

        //
        logger.info("Htmlize service page: {}.", service.getName());
        String page = ServicePage.htmlize(service.getOrganization(), service);
        FileUtils.write(new File(htmlizeDirectory, service.getLocalFileBaseName() + ".xhtml"), page, StandardCharsets.UTF_8);
    }

    /**
     * Builds the all.
     *
     * @throws IOException
     *             Signals that an I/O exception has occurred.
     * @throws StatoolInfosException
     *             the statool infos exception
     */
    public static void buildAll() throws IOException, StatoolInfosException
    {
        for (Service service : HtmlizerContext.instance().getFederation().getAllServices())
        {
            build(service);
        }
    }

    /**
     * Builds the.
     *
     * @param service
     *            the service
     * @return the string
     * @throws StatoolInfosException
     *             the statool infos exception
     */
    public static String htmlize(final Organization organization, final Service service) throws StatoolInfosException
    {
        String result;

        try
        {
            logger.debug("Building service page {}…", service.get("service.name"));

            TagDataManager data = new TagDataManager();

            data.setAttribute("serviceLogo", "src", service.getLogoFileName());

            data.setEscapedContent("serviceName", service.getName());
            data.setEscapedAttribute("serviceName", "href", service.getWebsite());

            data.setEscapedContent("serviceURL", service.getWebsite());
            data.setEscapedAttribute("serviceURL", "href", service.getWebsite());

            data.setEscapedContent("serviceDescription", StringUtils.defaultIfBlank(service.getDescription(), "n/a"));

            data.setContent("serviceStartDate", StringUtils.defaultIfBlank(service.getStartDate(), "n/a"));
            data.setContent("serviceEndDate", StringUtils.defaultIfBlank(service.getEndDate(), "n/a"));
            data.setContent("serviceAge", StringUtils.defaultIfBlank(service.getAge(), "n/a"));
            if (StringUtils.isBlank(service.getEndDate()))
            {
                data.setAttribute("serviceEndDateData", "style", "display: none;");
            }
            else
            {
                data.setAttribute("serviceStartDateWord", "style", "display: none;");
            }

            data.setAttribute("serviceStatusImg", "src", "status-" + service.getStatus().toString().toLowerCase() + ".png");
            data.setAttribute("serviceStatusImg", "title", StringUtils.defaultIfBlank(service.getStatusDescription(), service.getStatus().toString()));

            data.setAttribute("rawLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + ".properties");
            data.setAttribute("rawCheckLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + "-check.xhtml");

            data.setAttribute("statsLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + ".xhtml");

            if (StringUtils.isNotBlank(service.getLegalWebsite()))
            {
                data.setEscapedAttribute("legalLink", "href", service.getLegalWebsite());
                data.setAttribute("legalLinkImg", "class", "");
                data.getIdData("legalLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getContactWebsite()))
            {
                data.setEscapedAttribute("contactLink", "href", service.getContactWebsite());
                data.setAttribute("contactLinkImg", "class", "");
                data.getIdData("contactLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getContactEmail()))
            {
                data.setEscapedAttribute("emailLink", "href", "mailto:" + service.getContactEmail());
                data.setAttribute("emailLinkImg", "class", "");
                data.getIdData("emailLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getUserDocWebsite()))
            {
                data.setEscapedAttribute("userDocLink", "href", service.getUserDocWebsite());
                data.setAttribute("userDocLinkImg", "class", "");
                data.getIdData("userDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getTechnicalDocWebsite()))
            {
                data.setEscapedAttribute("technicalDocLink", "href", service.getTechnicalDocWebsite());
                data.setAttribute("technicalDocLinkImg", "class", "");
                data.getIdData("technicalDocLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }

            //
            if (service.isRegistrationNone())
            {
                data.setAttribute("registrationNoneImg", "class", "");
                data.getIdData("registrationNoneImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (service.isRegistrationFree())
            {
                data.setAttribute("registrationFreeImg", "class", "");
                data.getIdData("registrationFreeImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (service.isRegistrationMember())
            {
                data.setAttribute("registrationMemberImg", "class", "");
                data.getIdData("registrationMemberImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (service.isRegistrationClient())
            {
                data.setAttribute("registrationClientImg", "class", "");
                data.getIdData("registrationClientImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (service.isRegistrationLoadFull())
            {
                data.setAttribute("registrationLoadImg", "class", "");
                data.getIdData("registrationLoadImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }

            //
            data.setEscapedContent("softwareName", StringUtils.defaultIfBlank(service.getSoftwareName(), "n/a"));
            data.setContent("softwareVersion", StringUtils.defaultIfBlank(service.getSoftwareVersion(), "n/a"));
            data.setEscapedContent("softwareLicenseName", StringUtils.defaultIfBlank(service.getSoftwareLicenseName(), "n/a"));
            if (StringUtils.isNotBlank(service.getSoftwareWebsite()))
            {
                data.setEscapedAttribute("softwareWebsiteLink", "href", service.getSoftwareWebsite());
                data.setAttribute("softwareWebsiteLinkImg", "class", "");
                data.getIdData("softwareWebsiteLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getSoftwareLicenseWebpage()))
            {
                data.setEscapedAttribute("softwareLicenseLink", "href", service.getSoftwareLicenseWebpage());
                data.setAttribute("softwareLicenseLinkImg", "class", "");
                data.getIdData("softwareLicenseLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }
            if (StringUtils.isNotBlank(service.getSoftwareSourceWebsite()))
            {
                data.setEscapedAttribute("softwareSourceLink", "href", service.getSoftwareSourceWebsite());
                data.setAttribute("softwareSourceLinkImg", "class", "");
                data.getIdData("softwareSourceLinkImg").getAttribute("class").setMode(DisplayMode.REPLACE);
            }

            data.setAttribute("crawlLink", "href", service.getOrganization().getTechnicalName() + "-" + service.getTechnicalName() + "-crawl.xhtml");
            if (service.getCrawlJournal().getErrors().isEmpty())
            {
                data.setAttribute("crawlLinkImg", "src", "circle-icons/download-mono.svg");
            }
            else
            {
                data.setAttribute("crawlLinkImg", "src", "circle-icons/download.svg");
            }

            {
                PropertyChecks checks = service.getInputChecksAll();
                data.setContent("errorCount", checks.getErrorCount());
                data.setContent("warningCount", checks.getWarningCount());
                data.setContent("voidCount", checks.getVoidCount());

                data.setAttribute("alertLink", "href", organization.getTechnicalName() + "-" + service.getTechnicalName() + "-check.xhtml#alerts");
            }

            //
            int graphicIndex = 0;
            // data.setContent("fooChart", graphicIndex++,
            // LineMonthsChartView.build());

            // service.getPrefixes();

            MonthValues metric = service.getMetricMonthValues("metrics.http.hits");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            MonthValues metric4 = service.getMetricMonthValues("metrics.http.hits.ipv4");
            MonthValues metric6 = service.getMetricMonthValues("metrics.http.hits.ipv6");
            data.setContent("fooChart", graphicIndex++,
                    ChartHtmlizer.htmlizeMetricsChart("http.hits (ipv4 + ipv6)", null, null, new ChartColor[] { ChartColor.YELLOW, ChartColor.GREEN }, metric4, metric6));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric4, ChartColor.YELLOW));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric6, ChartColor.GREEN));

            metric4 = service.getMetricMonthValues("metrics.http.hits.bots");
            metric6 = service.getMetricMonthValues("metrics.http.hits.visitors");
            data.setContent("fooChart", graphicIndex++,
                    ChartHtmlizer.htmlizeMetricsChart("http.hits (visitors + bots)", null, null, new ChartColor[] { ChartColor.GREEN, ChartColor.YELLOW }, metric6, metric4));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric4, ChartColor.YELLOW));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric6, ChartColor.GREEN));

            metric = service.getMetricMonthValues("metrics.http.errors");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.RED));

            metric = service.getMetricMonthValues("metrics.http.errors.php");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.RED));

            metric = service.getMetricMonthValues("metrics.http.files");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            metric = service.getMetricMonthValues("metrics.http.pages");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            metric = service.getMetricMonthValues("metrics.http.bytes");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            metric = service.getMetricMonthValues("metrics.http.ip");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            metric4 = service.getMetricMonthValues("metrics.http.ip.bots");
            metric6 = service.getMetricMonthValues("metrics.http.ip.visitors");
            data.setContent("fooChart", graphicIndex++,
                    ChartHtmlizer.htmlizeMetricsChart("http.ip (visitors + bots)", null, null, new ChartColor[] { ChartColor.GREEN, ChartColor.YELLOW }, metric6, metric4));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric6, ChartColor.GREEN));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric4, ChartColor.YELLOW));

            metric4 = service.getMetricMonthValues("metrics.http.ip.ipv4");
            metric6 = service.getMetricMonthValues("metrics.http.ip.ipv6");
            data.setContent("fooChart", graphicIndex++,
                    ChartHtmlizer.htmlizeMetricsChart("http.ip (ipv4 + ipv6)", null, null, new ChartColor[] { ChartColor.YELLOW, ChartColor.GREEN }, metric4, metric6));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric4, ChartColor.YELLOW));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric6, ChartColor.GREEN));

            metric = service.getMetricMonthValues("metrics.http.visits");
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric, ChartColor.BLUE));

            metric4 = service.getMetricMonthValues("metrics.http.visits.bots");
            metric6 = service.getMetricMonthValues("metrics.http.visits.visitors");
            data.setContent("fooChart", graphicIndex++,
                    ChartHtmlizer.htmlizeMetricsChart("http.visits (visitors + bots)", null, null, new ChartColor[] { ChartColor.GREEN, ChartColor.YELLOW }, metric6, metric4));

            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric6, ChartColor.GREEN));
            data.setContent("fooChart", graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(null, null, metric4, ChartColor.YELLOW));

            //
            String content = PresenterUtils.dynamize("/fr/devinsy/statoolinfos/htmlize/service.xhtml", data).toString();

            BreadcrumbTrail trail = new BreadcrumbTrail();
            trail.add(service.getOrganization().getName(), service.getOrganization().getTechnicalName() + ".xhtml");
            trail.add(service.getName(), service.getOrganization().getTechnicalName() + "-" + service.getTechnicalName() + ".xhtml");
            result = WebCharterView.build(content, trail);
        }
        catch (XidynException exception)
        {
            throw new StatoolInfosException("Error building service page: " + exception.getMessage(), exception);
        }

        //
        return result;
    }

    /**
     * @param service
     * @param cache
     * @param htmlizeDirectory
     * @throws IOException
     */
    private static void htmlizeServiceLogo(final Service service, final CrawlCache cache, final File htmlizeDirectory) throws IOException
    {
        logger.info("Htmlize organization logo.");

        File target = new File(htmlizeDirectory, service.getLogoFileName());

        File logoFile = cache.restoreFile(service.getLogoURL());
        if (logoFile == null)
        {
            logger.info("BirdGeneratoring cat avatar: {}", target.getAbsoluteFile());
            BirdGenerator.buildAvatarTo(service.getTechnicalName(), target);
        }
        else
        {
            FileUtils.copyFile(logoFile, target);
        }
    }
}