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 java.time.YearMonth;

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

import fr.devinsy.catgenerator.core.BirdGenerator;
import fr.devinsy.statoolinfos.HtmlizerContext;
import fr.devinsy.statoolinfos.core.Metrics;
import fr.devinsy.statoolinfos.core.Service;
import fr.devinsy.statoolinfos.core.StatoolInfosException;
import fr.devinsy.statoolinfos.crawl.CrawlCache;
import fr.devinsy.statoolinfos.htmlize.ServiceMetricMenuView.MenuItem;
import fr.devinsy.statoolinfos.htmlize.charts.ChartColor;
import fr.devinsy.statoolinfos.htmlize.charts.MonthValues;
import fr.devinsy.xidyn.XidynException;
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);
        FileUtils.write(new File(htmlizeDirectory, service.getLocalFileBaseName() + ".xhtml"), page, StandardCharsets.UTF_8);

        //
        logger.info("Htmlize service generic metric page: {}.", service.getName());
        page = ServiceGenericMetricPage.htmlize(service);
        FileUtils.write(new File(htmlizeDirectory, service.getLocalFileBaseName() + "-metrics-generic.xhtml"), page, StandardCharsets.UTF_8);

        logger.info("Htmlize service web metric page: {}.", service.getName());
        page = ServiceWebMetricPage.htmlize(service);
        FileUtils.write(new File(htmlizeDirectory, service.getLocalFileBaseName() + "-metrics-web.xhtml"), page, StandardCharsets.UTF_8);

        logger.info("Htmlize service specific metric page: {}.", service.getName());
        page = ServiceSpecificMetricPage.htmlize(service);
        FileUtils.write(new File(htmlizeDirectory, service.getLocalFileBaseName() + "-metrics-specific.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 Service service) throws StatoolInfosException
    {
        String result;

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

            TagDataManager data = new TagDataManager();

            //
            data.setContent("headerView", ServiceHeaderView.htmlize(service));
            data.setContent("serviceMetricMenuView", ServiceMetricMenuView.htmlize(service, MenuItem.SUMMARY));

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

            // service.getPrefixes();

            String tagIds[] = { "fullChart", "lastChart", "2020Chart", "2021Chart" };
            YearMonth starts[] = { null, YearMonth.now().minusMonths(11), YearMonth.of(2020, 01), YearMonth.of(2021, 01) };
            YearMonth ends[] = { null, YearMonth.now(), YearMonth.of(2020, 12), YearMonth.of(2021, 12) };

            for (int index = 0; index < tagIds.length; index++)
            {
                String tagId = tagIds[index];
                YearMonth start = starts[index];
                YearMonth end = ends[index];

                int graphicIndex = 0;

                MonthValues metric = service.getMetricMonthValues("metrics.http.hits.visitors");
                data.setContent(tagId, graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(start, end, metric, ChartColor.GREEN));

                metric = service.getMetricMonthValues("metrics.http.ip.visitors");
                data.setContent(tagId, graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(start, end, metric, ChartColor.GREEN));

                metric = service.getMetricMonthValues("metrics.http.visits.visitors");
                data.setContent(tagId, graphicIndex++, ChartHtmlizer.htmlizeMetricsChart(start, end, metric, ChartColor.GREEN));
            }

            //
            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);
        }
    }
}